Create items and bundles

Creates multiple items or bundles along with their attributes. In addition, this endpoint supports data validation to ensure accuracy and consistency.
Note:
1) As a prerequisite category and attributes must be created beforehand.
2) To add an item variant, parentSku must be additionally specified.
3) An item is assigned to only one category but it can be fetched from Alternate categories.
4) Up to 50 items or bundles can be added.

POST /api-product/v1/product/bulk/insert

Create items and bundles

cURL

curl --request POST \
  --url https://live.copilot.fabric.inc/api-product/v1/product/bulk/insert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
[
  {
    "sku": "sku_abc",
    "type": "ITEM",
    "nodeName": "PRIMARY->electronics",
    "parentSku": "sku123",
    "attributeValues": [
      {
        "name": "Mobile",
        "value": "AMD X570 mobo"
      }
    ],
    "inheritedAttributes": [
      {
        "name": "color",
        "action": "SET"
      }
    ],
    "bundleItems": [
      {
        "sku": "sku123",
        "quantity": 6
      }
    ]
  }
]
'

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

Maximum array length: 50

sku · string · required

Stock Keeping Unit (SKU) of item

Example:

"sku_abc"

type · enum<string> · required

Item type

Available options: ITEM, BUNDLE

Example:

"ITEM"

nodeName · string · required

Category name (along with parent category names) for which item is being created.

Example:

"PRIMARY->electronics"

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:

"sku123"

attributeValues · object[]

Attribute details

Option 1

Option 2

Show child attributes

inheritedAttributes · object[]

Category item attributes to be inherited from parent item to children items

Show child attributes

bundleItems · object[]

Items to be added to a bundle. Includes SKU and item quantity.

Show child attributes

Response

200

application/json

OK

success · object[]

Show child attributes

failed · object[]

Show child attributes

itemIds · string[]

Item IDs

Example:

[
  "611686da50fb7e0c5df78c2e",
  "711686da50fb7e0c5df78c22"
]