Carts

Creates, retrieves, updates, and deletes a BigCommerce server-side cart.

Table Specific Information

The provider uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

Id supports the = comparison. A value for Id is required to retrieve a cart, since BigCommerce does not offer an endpoint to list all carts.
CreatedTime and UpdatedTime support the =, <, >, <=, and >= comparisons.

For example, the following query is processed server-side:

SELECT * FROM Carts WHERE Id = '82676093-e069-4d1d-93a2-96c1d3169dfc'

To insert a cart, specify at least one of LineItems, CustomItems, or GiftCertificates, formatted as a JSON array.

INSERT INTO Carts (CustomerId, ChannelId, CurrencyCode, LineItems) VALUES (0, 1, 'USD', '[{"product_id":126,"quantity":2}]')

Only the CustomerId column can be updated on an existing cart.

UPDATE Carts SET CustomerId = 55 WHERE Id = '82676093-e069-4d1d-93a2-96c1d3169dfc'

DELETE FROM Carts WHERE Id = '82676093-e069-4d1d-93a2-96c1d3169dfc'


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier (UUID) of the cart.
CustomerId	Integer	False	The Id of the customer the cart belongs to. Defaults to 0 for a guest cart.
ChannelId	Integer	False	The Id of the channel for which the cart was created. Defaults to 1 if not specified.
Email	String	False	The billing email address associated with the cart.
Locale	String	False	The locale of the cart, in the format xx or xx-YY.
CurrencyCode	String	False	The 3-letter currency code (ISO-4217) of the cart, for example USD.
LineItems	String	False	A JSON-formatted array of physical or digital catalog items to add to the cart on creation. At least one of LineItems, CustomItems, or GiftCertificates is required to create a cart.
TaxIncluded	Boolean	True	Whether tax is included in the cart amounts.
BaseAmount	Decimal	True	The sum of the base cost of all line items in the cart, before discounts.
DiscountAmount	Decimal	True	The total order-level discount amount applied to the cart.
ManualDiscountAmount	Decimal	True	The manual order-level discount amount applied to the cart.
CartAmount	Decimal	True	The sum of the cart line-item amounts, minus cart-level discounts and coupons.
Version	Integer	True	A number that increments each time the cart is updated.
CreatedTime	Datetime	True	The date and time the cart was created.
UpdatedTime	Datetime	True	The date and time the cart was last modified.

Pseudo column fields are used to enable the user to INSERT Fields that are non-readable but required during creation of new records.


Name	Type	Description
CustomItems	String	A JSON-formatted array of custom, non-catalog items to add to the cart on creation. This column can only be used for INSERT operation.
GiftCertificates	String	A JSON-formatted array of gift certificate line items to add to the cart on creation. This column can only be used for INSERT operation.