PUT
/
products
/
{id}
{
  "id": "5g7329dfd5288b00113323p7",
  "sku": "QWERTTY56DDFFVVV",
  "type": "ITEM",
  "isActive": true,
  "hasDraft": true,
  "hasLive": true,
  "status": "LIVE",
  "attributes": [
    {
      "id": "227329dfd5288b0011332315",
      "name": "Color",
      "type": "string",
      "isDeleted": false,
      "value": "blue",
      "isInherited": true
    }
  ],
  "localizedProperties": {
    "en-US": {
      "attributes": [
        {
          "id": "637329dfd5288b0011332354",
          "name": "Color",
          "type": "string",
          "isDeleted": false,
          "value": "blue",
          "isInherited": true
        }
      ]
    },
    "en-IN": {
      "attributes": [
        {
          "id": "8f7329dfd5288b0011332334",
          "name": "Colour",
          "type": "string",
          "isDeleted": false,
          "value": "blue",
          "isInherited": true
        }
      ]
    }
  },
  "variants": [
    {
      "id": "967329dfd5288b0011332356"
    }
  ],
  "categoryId": "7f7329dfd5288b0011332378",
  "createdAt": "2021-09-14T22:10:30.618Z",
  "updatedAt": "2021-09-14T22:10:30.618Z"
}

Authorizations

Authorization
string
headerrequired

S2S access token (JWT) from fabric Identity service (during Login)

Headers

x-fabric-tenant-id
string

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.

x-fabric-request-id
string

Unique request ID

Path Parameters

id
string
required

24-character system-generated product ID

Query Parameters

locales
string

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.

status
enum<string>
default: LIVE

Determines the version of the product applicable for this operation (endpoint action). If the status is DRAFT, only the Draft version of the product, if it exists, is considered for the operation.

Available options:
DRAFT,
LIVE

Body

application/json

Request body for creating Items, Variants and Bundles

sku
string
required

Unique product ID that maps to fabric's standard attribute called SKU. <br /> <b>Note:</b> sku shouldn't include ; or =

categoryId
string
required

24-character system-generated category ID

isActive
boolean
deprecated

Determines if the Product is published or unpublished. Status parameter takes precedence

type
enum<string>
required

Supported product types

Available options:
ITEM,
VARIANT,
BUNDLE
attributes
object[]

Array of product attributes

parentProduct
object

ID or SKU of parent product

bundleProducts

Bundle ID or SKU

variants

Product variants by ID

localizedProperties
object

Response

200 - application/json

Details of Item by ID

id
string

Product ID

sku
string

Unique product ID that maps to fabric's standard attribute called SKU. <br /> <b>Note:</b> sku shouldn't include ; or =

type
enum<string>

Supported product types

Available options:
ITEM,
VARIANT,
BUNDLE
isActive
boolean

true: Product is active <br /> false: Product is inactive

hasDraft
boolean

true: Product has a Draft version <br /> false: Product doesn't have a Draft version

hasLive
boolean

true: Product has a Live version <br /> false: Product doesn't have a Live version

status
enum<string>

Represents the current status of product. This value takes precedence over isActive if both are sent in the request.

Available options:
DRAFT,
LIVE
attributes
object[]

Attributes of product

localizedProperties
object

Localized attribute names

parentProduct
object

Parent item ID of the Variant

variants
object[]

Product variants by ID

categoryId
string

24-character system-generated category ID of product

bundleProducts
object[]

Items or variants that are part of Bundle by ID

createdAt
string

Time of product creation (UTC)

updatedAt
string

Time of last update to product (UTC)

Was this page helpful?

Add productsUpdate product SKUs