Create Cart | BigCommerce Developer Center

curl -X POST https://your_store.example.com/api/storefront/carts \
     -H "Content-Type: application/json" \
     -d '{
  "lineItems": [
    {
      "productId": 230,
      "optionSelections": [
        {
          "optionId": 10,
          "optionValue": "Some Text Value"
        }
      ],
      "quantity": 2
    }
  ],
  "locale": "en"
}'

{
  "id": "string",
  "customerId": 0,
  "email": "string",
  "currency": {
    "code": "string",
    "decimalPlaces": 2,
    "name": "US Dollar",
    "symbol": "$"
  },
  "isTaxIncluded": true,
  "baseAmount": 0,
  "discountAmount": 0,
  "cartAmount": 0,
  "coupons": [
    {
      "code": "string",
      "couponType": 0,
      "discountedAmount": 0,
      "displayName": "$1.00 off total order",
      "id": "string"
    }
  ],
  "discounts": [
    {
      "discountedAmount": 0,
      "id": "string"
    }
  ],
  "lineItems": {
    "customItems": [],
    "digitalItems": [
      {
        "quantity": 0,
        "brand": "string",
        "couponAmount": 0,
        "discountAmount": 0,
        "discounts": [
          {
            "discountedAmount": 0,
            "id": 0
          }
        ],
        "extendedListPrice": 0,
        "extendedSalePrice": 0,
        "id": "4",
        "imageUrl": "http://example.com",
        "isMutable": true,
        "isTaxable": true,
        "listPrice": 0,
        "name": "string",
        "options": [
          {
            "name": "string",
            "nameId": 0,
            "value": "string",
            "valueId": 0
          }
        ],
        "originalPrice": 0,
        "parentId": "6",
        "productId": 0,
        "salePrice": 0,
        "sku": "string",
        "type": "digital",
        "url": "http://example.com",
        "variantId": 7
      }
    ],
    "giftCertificates": [
      {
        "amount": 0,
        "recipient": {
          "email": "user@example.com",
          "name": "string"
        },
        "sender": {
          "email": "user@example.com",
          "name": "string"
        },
        "theme": "string",
        "id": "string",
        "taxable": true,
        "message": "string",
        "name": "string",
        "type": "giftCertificate"
      }
    ],
    "physicalItems": [
      {
        "quantity": 0,
        "brand": "string",
        "couponAmount": 0,
        "discountAmount": 0,
        "discounts": [
          {
            "discountedAmount": 0,
            "id": "string"
          }
        ],
        "extendedListPrice": 0,
        "extendedSalePrice": 0,
        "giftWrapping": {
          "amount": 0,
          "message": "string",
          "name": "string"
        },
        "id": "4",
        "imageUrl": "http://example.com",
        "isMutable": true,
        "isShippingRequired": true,
        "isTaxable": true,
        "listPrice": 0,
        "name": "string",
        "options": [
          {
            "name": "string",
            "nameId": 0,
            "value": "string",
            "valueId": 0
          }
        ],
        "originalPrice": 0,
        "parentId": 6,
        "productId": 0,
        "salePrice": 0,
        "sku": "string",
        "type": "physical",
        "url": "http://example.com",
        "variantId": 7
      }
    ]
  },
  "createdTime": "string",
  "updatedTime": "string",
  "locale": "string"
}

Creates a Cart.

Note

Substitute your storefront domain for yourstore.example.com.

The Send a Test Request feature is not currently supported for this endpoint.

Creates a *Cart*. > #### Note > * Substitute your storefront domain for `yourstore.example.com`. > * The Send a Test Request feature is not currently supported for this endpoint.

Request

This endpoint expects an object.

objectRequired

Response

Post Carts Response

idstringformat: "UUID"

Cart ID, provided after creating a cart with a POST.

customerIdinteger

ID of the customer to which the cart belongs.

emailstring

The cart's email. This is the same email that is used in the billing address

currencyobject

This will always be the same between cart and checkout.

isTaxIncludedboolean

Whether this item is taxable.

baseAmountdouble

Cost of cart’s contents, before applying discounts.

discountAmountdouble

Order based discounted amount only - Coupon discounts and product based discounts are excluded.

cartAmountdouble

Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).

couponslist of objects

discountslist of objects

lineItemsobject

createdTimestringformat: "ISO-8601"

Time when the cart was created.

updatedTimestringformat: "ISO-8601"

Time when the cart was last updated.

localestring

Locale of the cart.

versioninteger

The current version of the cart increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.

1	{
2	"id": "string",
3	"customerId": 0,
4	"email": "string",
5	"currency": {
6	"code": "string",
7	"decimalPlaces": 2,
8	"name": "US Dollar",
9	"symbol": "$"
10	},
11	"isTaxIncluded": true,
12	"baseAmount": 0,
13	"discountAmount": 0,
14	"cartAmount": 0,
15	"coupons": [
16	{
17	"code": "string",
18	"couponType": 0,
19	"discountedAmount": 0,
20	"displayName": "$1.00 off total order",
21	"id": "string"
22	}
23	],
24	"discounts": [
25	{
26	"discountedAmount": 0,
27	"id": "string"
28	}
29	],
30	"lineItems": {
31	"customItems": [],
32	"digitalItems": [
33	{
34	"quantity": 0,
35	"brand": "string",
36	"couponAmount": 0,
37	"discountAmount": 0,
38	"discounts": [
39	{
40	"discountedAmount": 0,
41	"id": 0
42	}
43	],
44	"extendedListPrice": 0,
45	"extendedSalePrice": 0,
46	"id": "4",
47	"imageUrl": "http://example.com",
48	"isMutable": true,
49	"isTaxable": true,
50	"listPrice": 0,
51	"name": "string",
52	"options": [
53	{
54	"name": "string",
55	"nameId": 0,
56	"value": "string",
57	"valueId": 0
58	}
59	],
60	"originalPrice": 0,
61	"parentId": "6",
62	"productId": 0,
63	"salePrice": 0,
64	"sku": "string",
65	"type": "digital",
66	"url": "http://example.com",
67	"variantId": 7
68	}
69	],
70	"giftCertificates": [
71	{
72	"amount": 0,
73	"recipient": {
74	"email": "user@example.com",
75	"name": "string"
76	},
77	"sender": {
78	"email": "user@example.com",
79	"name": "string"
80	},
81	"theme": "string",
82	"id": "string",
83	"taxable": true,
84	"message": "string",
85	"name": "string",
86	"type": "giftCertificate"
87	}
88	],
89	"physicalItems": [
90	{
91	"quantity": 0,
92	"brand": "string",
93	"couponAmount": 0,
94	"discountAmount": 0,
95	"discounts": [
96	{
97	"discountedAmount": 0,
98	"id": "string"
99	}
100	],
101	"extendedListPrice": 0,
102	"extendedSalePrice": 0,
103	"giftWrapping": {
104	"amount": 0,
105	"message": "string",
106	"name": "string"
107	},
108	"id": "4",
109	"imageUrl": "http://example.com",
110	"isMutable": true,
111	"isShippingRequired": true,
112	"isTaxable": true,
113	"listPrice": 0,
114	"name": "string",
115	"options": [
116	{
117	"name": "string",
118	"nameId": 0,
119	"value": "string",
120	"valueId": 0
121	}
122	],
123	"originalPrice": 0,
124	"parentId": 6,
125	"productId": 0,
126	"salePrice": 0,
127	"sku": "string",
128	"type": "physical",
129	"url": "http://example.com",
130	"variantId": 7
131	}
132	]
133	},
134	"createdTime": "string",
135	"updatedTime": "string",
136	"locale": "string"
137	}