CartPhysicalItems

Returns and manages the physical catalog items in a cart.

Table Specific Information

Select

CartPhysicalItems returns the physical catalog items in a cart. A value for CartId is required, since BigCommerce does not offer an endpoint to list physical items across all carts.

SELECT * FROM CartPhysicalItems WHERE CartId = '82676093-e069-4d1d-93a2-96c1d3169dfc'

Insert

To add a physical item to a cart, specify at least the CartId, ProductId, and Quantity.

INSERT INTO CartPhysicalItems (CartId, ProductId, Quantity) VALUES ('82676093-e069-4d1d-93a2-96c1d3169dfc', 126, 2)

Update

Only the Quantity and ListPrice columns can be updated on an existing physical item.

UPDATE CartPhysicalItems SET Quantity = 3 WHERE CartId = '82676093-e069-4d1d-93a2-96c1d3169dfc' AND Id = '66e3fa1e-49ff-483b-8302-1830dcf5c33e'

Delete

DELETE FROM CartPhysicalItems WHERE CartId = '82676093-e069-4d1d-93a2-96c1d3169dfc' AND Id = '66e3fa1e-49ff-483b-8302-1830dcf5c33e'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier of the line item.
CartId [KEY]	String	False	The Id of the cart this item belongs to.
ProductId	Integer	False	The Id of the product.
VariantId	Integer	False	The Id of the product variant. Required for products that have variants.
Quantity	Integer	False	The quantity of the item in the cart.
ListPrice	Decimal	False	The list price of the item. Can only be set on insert for custom-priced catalog items.
Sku	String	True	The SKU of the item.
Name	String	True	The name of the item.
Url	String	True	The URL of the item on the storefront.
ImageUrl	String	True	The URL of the item's image.
Taxable	Boolean	True	Whether the item is taxable.
IsRequireShipping	Boolean	True	Whether the item requires shipping.
IsMutable	Boolean	True	Whether the item can be modified, for example items added by a promotion cannot be changed.
IsCustomPrice	Boolean	True	Whether the item was added with a custom price override.
AddedByPromotion	Boolean	True	Whether the item was added automatically by a promotion.
OriginalPrice	Decimal	True	The original catalog price of the item, before discounts.
SalePrice	Decimal	True	The price of the item after discounts.
ExtendedListPrice	Decimal	True	The list price multiplied by the quantity.
ExtendedSalePrice	Decimal	True	The sale price multiplied by the quantity.
DiscountAmount	Decimal	True	The total discount amount applied to the item.
CouponAmount	Decimal	True	The total coupon amount applied to the item.
GiftWrappingName	String	True	The name of the gift-wrapping option applied to the item.
GiftWrappingMessage	String	True	The gift message associated with the item.
GiftWrappingAmount	Decimal	True	The cost of the gift-wrapping option.
Discounts	String	True	A JSON-formatted array of the discounts applied to the item.