Add item to cart

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Dropship API
Shipments
Products
Invoices
Connections
Inventory
Developer Guide
Returns
Orders

Cart API

Cart
Order Draft
Attribute
Adjustments
Shipping
Cart

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

POST

api-cart

cart

item

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",
  "userAuthToken": "JWT",
  "company": "Fabric Inc.",
  "items": [
    {
      "itemId": 1000000012,
      "priceListId": 100002,
      "isUnique": 123,
      "quantity": 2,
      "price": {
        "currency": "USD",
        "base": 15.99,
        "sale": 10.99,
        "discount": {
          "price": 10.99,
          "discountAmount": 10.99,
          "promosApplied": [
            {
              "unit": "<string>",
              "value": 123,
              "ON": {
                "kind": "SKU",
                "value": ""
              },
              "id": "<string>",
              "promoId": "<string>",
              "promoCode": "<string>"
            }
          ]
        }
      },
      "group": [
        "5ddd1a156c5a5fed1e0d91fb"
      ],
      "extra": {}
    }
  ]
}'

{
  "deleted": false,
  "allPromosApplied": [
    {
      "unit": "<string>",
      "value": 123,
      "ON": {
        "kind": "SKU",
        "value": ""
      },
      "id": "<string>",
      "promoId": "<string>",
      "promoCode": "<string>"
    }
  ],
  "items": [
    {
      "itemId": 1000000012,
      "priceListId": 100002,
      "isUnique": 123,
      "quantity": 2,
      "price": {
        "currency": "USD",
        "base": 15.99,
        "sale": 10.99,
        "discount": {
          "price": 10.99,
          "discountAmount": 10.99,
          "promosApplied": [
            {
              "unit": "<string>",
              "value": 123,
              "ON": {
                "kind": "SKU",
                "value": ""
              },
              "id": "<string>",
              "promoId": "<string>",
              "promoCode": "<string>"
            }
          ]
        }
      },
      "group": [
        "5ddd1a156c5a5fed1e0d91fb"
      ],
      "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": {
            "_id": "5fee9d59f2f08a1b3cbdea08",
            "createdAt": "2020-12-31T02:09:53.914Z",
            "updatedAt": "2020-12-31T02:09:53.914Z",
            "attention": "Leave at the back door.",
            "street1": "123 Main Street",
            "street2": "ABC Boulevard",
            "city": "Seattle",
            "state": "WA",
            "country": "United States of America",
            "zipCode": "10008-1234",
            "kind": "TBD",
            "name": {
              "first": "John",
              "last": "Smith"
            },
            "phone": {
              "number": "123-456-7890",
              "kind": "Mobile"
            },
            "email": "johnsmith@fabric.inc",
            "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": [
      "<any>"
    ],
    "price": [
      "<any>"
    ],
    "promo": [
      "<any>"
    ]
  },
  "_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

items.itemId

number

required

Example:

1000000012

items.quantity

number

default:1

required

Required range: x >= 1

Example:

2

items.price

object

required

items.price.currency

string

required

Required string length: 3

Example:

"USD"

items.price.base

number

required

Example:

15.99

items.price.discount

object

required

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[]

items.price.discount.promosApplied.unit

string

items.price.discount.promosApplied.value

integer

items.price.discount.promosApplied.ON

object

Example:

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

items.price.discount.promosApplied.id

string

items.price.sale

number

Example:

10.99

items.group

string[]

required

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[]

allPromosApplied.unit

string

allPromosApplied.value

integer

allPromosApplied.ON

object

Example:

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

allPromosApplied.id

string

items

object[]

items.itemId

number

required

Example:

1000000012

items.quantity

number

default:1

required

Required range: x >= 1

Example:

2

items.price

object

required

items.price.currency

string

required

Required string length: 3

Example:

"USD"

items.price.base

number

required

Example:

15.99

items.price.discount

object

required

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[]

items.price.discount.promosApplied.unit

string

items.price.discount.promosApplied.value

integer

items.price.discount.promosApplied.ON

object

Example:

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

items.price.discount.promosApplied.id

string

items.price.sale

number

Example:

10.99

items.group

string[]

required

items.priceListId

number

Example:

100002

items.isUnique

string

Example:

123

items.discountedQuantity

number

Example:

0

items.lineItemId

number

Example:

1

items.totalPrice

object

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[]

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

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

quantity

number

Example:

2

__v

number

Example:

0

attributes

object[]

account

string

approver

string

company

string

status

string

Example:

"pending"

extra

object

errors

object

_id

string

Example:

"5fee9d59f2f08a1b3cbdea08"

createdAt

string

Example:

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

updatedAt

string

Example:

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

Was this page helpful?

Empty cart for the given cart ID Remove item from cart by line item ID

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",
  "userAuthToken": "JWT",
  "company": "Fabric Inc.",
  "items": [
    {
      "itemId": 1000000012,
      "priceListId": 100002,
      "isUnique": 123,
      "quantity": 2,
      "price": {
        "currency": "USD",
        "base": 15.99,
        "sale": 10.99,
        "discount": {
          "price": 10.99,
          "discountAmount": 10.99,
          "promosApplied": [
            {
              "unit": "<string>",
              "value": 123,
              "ON": {
                "kind": "SKU",
                "value": ""
              },
              "id": "<string>",
              "promoId": "<string>",
              "promoCode": "<string>"
            }
          ]
        }
      },
      "group": [
        "5ddd1a156c5a5fed1e0d91fb"
      ],
      "extra": {}
    }
  ]
}'

{
  "deleted": false,
  "allPromosApplied": [
    {
      "unit": "<string>",
      "value": 123,
      "ON": {
        "kind": "SKU",
        "value": ""
      },
      "id": "<string>",
      "promoId": "<string>",
      "promoCode": "<string>"
    }
  ],
  "items": [
    {
      "itemId": 1000000012,
      "priceListId": 100002,
      "isUnique": 123,
      "quantity": 2,
      "price": {
        "currency": "USD",
        "base": 15.99,
        "sale": 10.99,
        "discount": {
          "price": 10.99,
          "discountAmount": 10.99,
          "promosApplied": [
            {
              "unit": "<string>",
              "value": 123,
              "ON": {
                "kind": "SKU",
                "value": ""
              },
              "id": "<string>",
              "promoId": "<string>",
              "promoCode": "<string>"
            }
          ]
        }
      },
      "group": [
        "5ddd1a156c5a5fed1e0d91fb"
      ],
      "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": {
            "_id": "5fee9d59f2f08a1b3cbdea08",
            "createdAt": "2020-12-31T02:09:53.914Z",
            "updatedAt": "2020-12-31T02:09:53.914Z",
            "attention": "Leave at the back door.",
            "street1": "123 Main Street",
            "street2": "ABC Boulevard",
            "city": "Seattle",
            "state": "WA",
            "country": "United States of America",
            "zipCode": "10008-1234",
            "kind": "TBD",
            "name": {
              "first": "John",
              "last": "Smith"
            },
            "phone": {
              "number": "123-456-7890",
              "kind": "Mobile"
            },
            "email": "johnsmith@fabric.inc",
            "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": [
      "<any>"
    ],
    "price": [
      "<any>"
    ],
    "promo": [
      "<any>"
    ]
  },
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z"
}