Add item to cart

Add item to cart

POST /api-cart/cart/item

Try it

Add item to cart

cURL

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-cart/cart/item \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "cartId": "123456abcdef123456abcdef",
  "items": [
    {
      "itemId": 1000000012,
      "quantity": 2,
      "price": {
        "currency": "USD",
        "base": 15.99,
        "discount": {
          "price": 10.99,
          "discountAmount": 10.99,
          "promosApplied": [
            {
              "unit": "<string>",
              "value": 123,
              "ON": {
                "kind": "SKU",
                "value": ""
              },
              "id": "<string>",
              "promoId": "<string>",
              "promoCode": "<string>"
            }
          ]
        },
        "sale": 10.99
      },
      "group": [
        "5ddd1a156c5a5fed1e0d91fb"
      ],
      "priceListId": 100002,
      "isUnique": 123,
      "extra": {}
    }
  ],
  "userAuthToken": "JWT",
  "company": "Fabric Inc."
}
'

200

{
  "deleted": false,
  "allPromosApplied": [
    {
      "unit": "<string>",
      "value": 123,
      "ON": {
        "kind": "SKU",
        "value": ""
      },
      "id": "<string>",
      "promoId": "<string>",
      "promoCode": "<string>"
    }
  ],
  "items": [
    {
      "itemId": 1000000012,
      "quantity": 2,
      "price": {
        "currency": "USD",
        "base": 15.99,
        "discount": {
          "price": 10.99,
          "discountAmount": 10.99,
          "promosApplied": [
            {
              "unit": "<string>",
              "value": 123,
              "ON": {
                "kind": "SKU",
                "value": ""
              },
              "id": "<string>",
              "promoId": "<string>",
              "promoCode": "<string>"
            }
          ]
        },
        "sale": 10.99
      },
      "group": [
        "5ddd1a156c5a5fed1e0d91fb"
      ],
      "priceListId": 100002,
      "isUnique": 123,
      "discountedQuantity": 0,
      "lineItemId": 1,
      "totalPrice": {
        "currency": "USD",
        "amount": 200
      },
      "id": "5fee9d59f2f08a1b3cbdea08",
      "sample": false,
      "weightUnit": "kg",
      "isPickup": false,
      "sku": "blue",
      "taxCode": "PH0607",
      "title": "item title",
      "weight": 7,
      "attributeTotalPrice": 0,
      "attributes": [
        {
          "price": 10,
          "_id": "6146e98408e3700008b64611",
          "attributeId": "60a77de306f682000975c24c",
          "value": "true/false",
          "name": "Gift Message",
          "type": "<string>",
          "id": "6146e98408e3700008b64611",
          "shipTo": {
            "street1": "123 Main Street",
            "city": "Seattle",
            "state": "WA",
            "country": "United States of America",
            "zipCode": "10008-1234",
            "name": {
              "first": "John",
              "last": "Smith"
            },
            "email": "[e-mail]",
            "_id": "5fee9d59f2f08a1b3cbdea08",
            "createdAt": "2020-12-31T02:09:53.914Z",
            "updatedAt": "2020-12-31T02:09:53.914Z",
            "attention": "Leave at the back door.",
            "street2": "ABC Boulevard",
            "kind": "TBD",
            "phone": {
              "number": "123-456-7890",
              "kind": "Mobile"
            },
            "shipTo": {
              "shipMethod": {
                "shipMethodId": "1a2b3c4d5e6f7g8h9i0j",
                "shipmentCarrier": "Fedex",
                "shipmentMethod": "Next Day",
                "cost": {
                  "currency": "USD",
                  "amount": 5.99
                }
              }
            },
            "shipToId": 5269,
            "cartId": "61e03ff6a865fe00094f8620",
            "taxCode": "FR1000",
            "shipToType": "SHIP_TO_ADDRESS"
          }
        }
      ],
      "_id": "5fee9d59f2f08a1b3cbdea08",
      "createdAt": "2020-12-31T02:09:53.914Z",
      "updatedAt": "2020-12-31T02:09:53.914Z"
    }
  ],
  "registeredUser": false,
  "cartId": 4,
  "totalAmmount\"": {
    "currency": "USD",
    "amount": 200
  },
  "quantity": 2,
  "__v": 0,
  "attributes": [
    {
      "price": 10,
      "_id": "6146e98408e3700008b64611",
      "attributeId": "60a77de306f682000975c24c",
      "value": "true/false",
      "name": "Gift Message",
      "type": "<string>",
      "id": "6146e98408e3700008b64611"
    }
  ],
  "account": "<string>",
  "approver": "<string>",
  "po": "<string>",
  "company": "<string>",
  "status": "pending",
  "extra": {},
  "errors": {
    "inventory": "<array>",
    "price": "<array>",
    "promo": "<array>"
  },
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z"
}

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\"}"

Authorization · string

Example:

"JWT token"

Body

application/json

cartId · string · required

Example:

"123456abcdef123456abcdef"

items · object[] · required

Minimum array length: 1

Show child attributes

items. itemId · number · required

Example:

1000000012

items. quantity · number · default: 1 · required

Required range: x >= 1

Example:

2

items. price · object · required

Show child attributes

items.price. currency · string · required

Required string length: 3

Example:

"USD"

items.price. base · number · required

Example:

15.99

items.price. discount · object · required

Show child attributes

items.price.discount. price · number · default: 0 · required

Example:

10.99

items.price.discount. discountAmount · number · default: 0

Example:

10.99

items.price.discount. promosApplied · object[]

Show child attributes

items.price.discount.promosApplied. unit · string

items.price.discount.promosApplied. value · integer<int32>

items.price.discount.promosApplied. ON · ON · object

Show child attributes

items.price.discount.promosApplied.ON. kind · string · required

items.price.discount.promosApplied.ON. value · string | null · required

Example:

{ "kind": "SKU", "value": "" }

items.price.discount.promosApplied. id · string

items.price.discount.promosApplied. promoId · string

items.price.discount.promosApplied. promoCode · string

items.price. sale · number

Example:

10.99

items. group · string[] · required

Minimum array length: 1

Required string length: 24

items. priceListId · number

Example:

100002

items. isUnique · string

Example:

123

items. extra · object

userAuthToken · string

Example:

"JWT"

company · string

Example:

"Fabric Inc."

Response

200

application/json

Item added to cart

deleted · boolean

Example:

false

allPromosApplied · object[]

Show child attributes

allPromosApplied. unit · string

allPromosApplied. value · integer<int32>

allPromosApplied. ON · ON · object

Show child attributes

allPromosApplied.ON. kind · string · required

allPromosApplied.ON. value · string | null · required

Example:

{ "kind": "SKU", "value": "" }

allPromosApplied. id · string

allPromosApplied. promoId · string

allPromosApplied. promoCode · string

items · object[]

Show child attributes

items. itemId · number · required

Example:

1000000012

items. quantity · number · default: 1 · required

Required range: x >= 1

Example:

2

items. price · object · required

Show child attributes

items.price. currency · string · required

Required string length: 3

Example:

"USD"

items.price. base · number · required

Example:

15.99

items.price. discount · object · required

Show child attributes

items.price.discount. price · number · default: 0 · required

Example:

10.99

items.price.discount. discountAmount · number · default: 0

Example:

10.99

items.price.discount. promosApplied · object[]

Show child attributes

items.price.discount.promosApplied. unit · string

items.price.discount.promosApplied. value · integer<int32>

items.price.discount.promosApplied. ON · ON · object

Show child attributes

items.price.discount.promosApplied.ON. kind · string · required

items.price.discount.promosApplied.ON. value · string | null · required

Example:

{ "kind": "SKU", "value": "" }

items.price.discount.promosApplied. id · string

items.price.discount.promosApplied. promoId · string

items.price.discount.promosApplied. promoCode · string

items.price. sale · number

Example:

10.99

items. group · string[] · required

Minimum array length: 1

Required string length: 24

items. priceListId · number

Example:

100002

items. isUnique · string

Example:

123

items. discountedQuantity · number

Example:

0

items. lineItemId · number

Example:

1

items. totalPrice · object

Show child attributes

items.totalPrice. currency · string

Example:

"USD"

items.totalPrice. amount · number

Example:

200

items. id · string

Example:

"5fee9d59f2f08a1b3cbdea08"

items. sample · boolean

Example:

false

items. weightUnit · string

Example:

"kg"

items. isPickup · boolean

Example:

false

items. sku · string

Example:

"blue"

items. taxCode · string

Example:

"PH0607"

items. title · string

Example:

"item title"

items. weight · number

Example:

7

items. attributeTotalPrice · number

Example:

0

items. attributes · object[]

Show child attributes

items.attributes. price · number

Example:

10

items.attributes. _id · string

Example:

"6146e98408e3700008b64611"

items.attributes. attributeId · string

Example:

"60a77de306f682000975c24c"

items.attributes. value · string

Example:

"true/false"

items.attributes. name · string

Example:

"Gift Message"

items.attributes. type · string

items.attributes. id · string

Example:

"6146e98408e3700008b64611"

items.attributes. shipTo · object

Show child attributes

items.attributes.shipTo. street1 · string · required

Maximum string length: 140

Example:

"123 Main Street"

items.attributes.shipTo. city · string · required

Maximum string length: 140

Example:

"Seattle"

items.attributes.shipTo. state · string · required

Maximum string length: 25

Example:

"WA"

items.attributes.shipTo. country · string · required

Maximum string length: 140

Example:

"United States of America"

items.attributes.shipTo. zipCode · string · required

Required string length: 3 - 25

Example:

"10008-1234"

items.attributes.shipTo. name · object · required

Show child attributes

items.attributes.shipTo.name. first · string

Required string length: 2 - 50

Example:

"John"

items.attributes.shipTo.name. last · string

Required string length: 2 - 50

Example:

"Smith"

items.attributes.shipTo. email · string<email> · required

Required string length: 5 - 100

Example:

"[e-mail]"

items.attributes.shipTo. _id · string

Example:

"5fee9d59f2f08a1b3cbdea08"

items.attributes.shipTo. createdAt · string

Example:

"2020-12-31T02:09:53.914Z"

items.attributes.shipTo. updatedAt · string

Example:

"2020-12-31T02:09:53.914Z"

items.attributes.shipTo. attention · string

Maximum string length: 140

Example:

"Leave at the back door."

items.attributes.shipTo. street2 · string

Maximum string length: 240

Example:

"ABC Boulevard"

items.attributes.shipTo. kind · string

Maximum string length: 24

Example:

"TBD"

items.attributes.shipTo. phone · object

Show child attributes

items.attributes.shipTo.phone. number · string · required

Required string length: 5 - 25

Example:

"123-456-7890"

items.attributes.shipTo.phone. kind · string · required

Required string length: 3 - 25

Example:

"Mobile"

items.attributes.shipTo. shipTo · object

Show child attributes

items.attributes.shipTo.shipTo. shipMethod · object

Show child attributes

items.attributes.shipTo.shipTo.shipMethod. shipMethodId · string

Minimum string length: 3

Example:

"1a2b3c4d5e6f7g8h9i0j"

items.attributes.shipTo.shipTo.shipMethod. shipmentCarrier · string

Example:

"Fedex"

items.attributes.shipTo.shipTo.shipMethod. shipmentMethod · string

Example:

"Next Day"

items.attributes.shipTo.shipTo.shipMethod. cost · object

Show child attributes

items.attributes.shipTo.shipTo.shipMethod.cost. currency · string · required

Minimum string length: 3

Example:

"USD"

items.attributes.shipTo.shipTo.shipMethod.cost. amount · number · required

Required range: x >= 0

Example:

5.99

items.attributes.shipTo. shipToId · string

Example:

5269

items.attributes.shipTo. cartId · object

Example:

"61e03ff6a865fe00094f8620"

items.attributes.shipTo. taxCode · string

Example:

"FR1000"

items.attributes.shipTo. shipToType · string

Example:

"SHIP_TO_ADDRESS"

items. _id · string

Example:

"5fee9d59f2f08a1b3cbdea08"

items. createdAt · string

Example:

"2020-12-31T02:09:53.914Z"

items. updatedAt · string

Example:

"2020-12-31T02:09:53.914Z"

registeredUser · boolean

Example:

false

cartId · number

Example:

4

totalAmmount" · object

Show child attributes

totalAmmount". currency · string

Example:

"USD"

totalAmmount". amount · number

Example:

200

quantity · number

Example:

2

__v · number

Example:

0

attributes · object[]

Show child attributes

attributes. price · number

Example:

10

attributes. _id · string

Example:

"6146e98408e3700008b64611"

attributes. attributeId · string

Example:

"60a77de306f682000975c24c"

attributes. value · string

Example:

"true/false"

attributes. name · string

Example:

"Gift Message"

attributes. type · string

attributes. id · string

Example:

"6146e98408e3700008b64611"

account · string

approver · string

po · string

company · string

status · string

Example:

"pending"

extra · object

errors · object

Show child attributes

errors. inventory · array

errors. price · array

errors. promo · array

_id · string

Example:

"5fee9d59f2f08a1b3cbdea08"

createdAt · string

Example:

"2020-12-31T02:09:53.914Z"

updatedAt · string

Example:

"2020-12-31T02:09:53.914Z"