Get product by ID
With this endpoint, you can get details of a product (item, bundle, or variant) by ID. The response includes the product’s attributes and its variants. You can optionally specify locales
to get products for specific regions. Note: If you don’t have product ID, use the corresponding SKU-based endpoint - GET /products/sku/{sku}
Authorizations
S2S access token (JWT) from fabric Identity service (during Login)
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
"517fa9dfd42d8b00g1o3k312"
Unique request ID
"263e731c-45c8-11ed-b878-0242ac120002"
Path Parameters
24-character system-generated product ID
Query Parameters
Comma-separated locale codes of product. The service throws a 400 error if the locale isn't supported. Standard locales can be found at https://www.rfc-editor.org/rfc/rfc5646. <br /> Note: The recommended way to get the locale is by invoking multi-channel service.
"fr-CA%2Cen-US"
Comma-separated statuses indicating the preferred order of the product versions considered for this operation (endpoint action). For example, <br />1. When the status is DRAFT
, this operations will only apply to the Draft version of product, if it exists <br />2. When the status is LIVE
, this operation will only apply to the Live version of the product, if it exists <br />3 When the status is LIVE,DRAFT
, this operation will prioritize Live version first, if it exists. Otherwise, the Draft version is considered. <br />4 When the status is DRAFT,LIVE
this operation will prioritize the Draft version first, if it exists. Otherwise, the Live version is considered.
"DRAFT"
Response
Details of Item by ID
Product ID
"AASSBCC12334FCD12334V"
Unique product ID that maps to fabric's standard attribute called SKU
. <br /> <b>Note:</b> sku
shouldn't include ;
or =
"XP-123345"
Supported product types
ITEM
, VARIANT
, BUNDLE
"ITEM"
true: Product is active <br /> false: Product is inactive
true
true: Product has a Draft version <br /> false: Product doesn't have a Draft version
true
true: Product has a Live version <br /> false: Product doesn't have a Live version
true
Represents the current status of product. This value takes precedence over isActive
if both are sent in the request.
DRAFT
, LIVE
"LIVE"
Attributes of product
Details of product attributes
Localized attribute names
{
"en-US": {
"attributes": [
{
"id": "4e7329dfd5288b0011332366",
"name": "Color",
"type": "string",
"isDeleted": false,
"value": "blue",
"isInherited": true
}
]
}
}
Parent item ID of the Variant
Product variants by ID
24-character system-generated category ID of product
"6h7329dfd5288b001133231d"
Items or variants that are part of Bundle by ID
Time of product creation (UTC)
"2021-09-14T22:10:30.618Z"
Time of last update to product (UTC)
"2021-09-14T22:10:30.618Z"
Was this page helpful?