Update items and bundles

With this endpoint, you can update multiple items or bundles, along with their attributes.
Note:
1) You can update up to 50 items or bundles.
2) By specifying the attribute value as NULL, a reserved keyword, you can remove the existing attribute value.

POST /api-product/v1/product/bulk/update

Try it

Update items and bundles

cURL

curl --request POST \
  --url https://live.copilot.fabric.inc/api-product/v1/product/bulk/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "skus": [
    "sku12",
    "sku13"
  ],
  "type": "ITEM",
  "action": "UPDATE",
  "parentSku": "sku234",
  "attributeValues": [
    {
      "name": "Mobile",
      "value": "AMD X570 mobo"
    }
  ],
  "inheritedAttributes": [
    {
      "name": "color",
      "action": "SET"
    }
  ]
}
'

200

{
  "success": [
    {
      "sku": "sku1",
      "itemId": "611686da50fb7e0c5df78c2e",
      "itemIdSeq": 12,
      "message": "SKU created successfully.",
      "errorAttributes": [
        {
          "name": "Inactive",
          "message": "Attribute value is invalid."
        }
      ],
      "errorBundles": [
        {
          "name": "<string>",
          "message": "<string>"
        }
      ]
    }
  ],
  "failed": [
    {
      "sku": "sku1",
      "message": "Failed because of validation"
    }
  ],
  "itemIds": [
    "611686da50fb7e0c5df78c2e",
    "711686da50fb7e0c5df78c22"
  ]
}

Authorizations

Authorization · string · header · required

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

Headers

x-site-context · string · required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json

skus · string[]

Stock Keeping Units (SKUs)

Maximum array length: 50

Example:

["sku12", "sku13"]

type · string

Item type - Bundle or Item

Example:

"ITEM"

action · string

Action type

Example:

"UPDATE"

parentSku · string | null

“Stock Keeping Unit (SKU) of the parent item.
Set the value as detach or null to disassociate the item from parent item.”

Example:

"sku234"

attributeValues · object[]

Option 1

Show child attributes

attributeValues. name · string

Attribute name

Example:

"Mobile"

attributeValues. value · string

Attribute value

Example:

"AMD X570 mobo"

inheritedAttributes · object[]

Category item attributes to inherit from parent item to children items

Show child attributes

inheritedAttributes. name · string · required

Name of the attribute that can be inherited

Example:

"color"

inheritedAttributes. action · enum<string> · required

Action to set or unset (remove) the inherited attribute

Available options: SET, UNSET

Example:

"SET"

Response

200

application/json

OK

success · object[]

Show child attributes

success. sku · string

Stock Keeping Unit (SKU) of item

Example:

"sku1"

success. itemId · string

Item ID

Example:

"611686da50fb7e0c5df78c2e"

success. itemIdSeq · number

Item ID, which increments sequentially

Example:

12

success. message · string

Success message

Example:

"SKU created successfully."

success. errorAttributes · object[]

Show child attributes

success.errorAttributes. name · string

Error reason

Example:

"Inactive"

success.errorAttributes. message · string

Human-readable error message

Example:

"Attribute value is invalid."

success. errorBundles · object[]

Show child attributes

success.errorBundles. name · string

Error reason

success.errorBundles. message · string

Human-readable error message

failed · object[]

Show child attributes

failed. sku · string

Stock Keeping Unit (SKU), a unique identifier of item

Example:

"sku1"

failed. message · string

Failure message

Example:

"Failed because of validation"

itemIds · string[]

Item IDs

Example:

[
  "611686da50fb7e0c5df78c2e",
  "711686da50fb7e0c5df78c22"
]