Skip to main content
GET
Get Product Profile by code

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

code
string
required

Stable Product Profile code.

Maximum string length: 64
Pattern: ^[A-Za-z0-9_]+$
Example:

"lightweight_parcel"

Query Parameters

fields
enum<string>[]

Select fields of the ProductProfile object. See the selecting fields page for more information. Specify fields of the ProductProfile object to include in the response.

Available options:
all,
name,
code,
conditions,
conditions_readable,
matched_count,
classification,
created_at,
updated_at

Response

The requested Product Profile.

resource
ProductProfile · object

A reusable Product classification whose conditions may match many Products. Classification is asynchronous: after a create or condition update, poll the resource until classification.status is up_to_date. This status confirms that the Profile's current conditions were classified. Product changes flow through a separate asynchronous changelog and may not appear immediately in materialized membership.

Example: