Cart

A body field fails validation. currency_code is not a currency the shop sells in. referral_id is not an integer. coupon_code is sent while the shop turns off coupon discounts, or the coupon is unknown or not valid ('The coupon code is invalid.'). For a signed- in customer, coupon_code also fails when the customer already used a one-per-customer coupon ('You have already used this coupon.'), the coupon is for other customers ('This coupon is designated for personal use only.'), or the coupon is for subscribers only ('To use this coupon, you must be a subscribed member.'). gift_card_code is sent while the shop turns off gift card discounts, is not a UUID, is unknown or not purchasable ('The gift card is not valid.'), or has expired ('The gift card has already expired.'). expand is not an array.

The signed-in customer does not own the cart (unauthorized_customer), or the cart is not active (it is completed or expired) or belongs to another shop (bad_request).

The expand query parameter is not an array.

Subscription start date (Y-m-d). Prohibited together with gift_info.

Format: date.

Applicable only after authentication. Required with shipping_method_id

Applicable only after authentication. Required with shipping_address_id

Browser and ad-click identifiers captured by the storefront and forwarded to server-side conversion APIs. Merged into the cart per key: a non-empty value overwrites the stored one, a missing or empty key keeps it. Keys outside the list below are ignored, so a client may send identifiers before the API uses them. Values are never hashed and never rejected (a non-string value is ignored): a value longer than its limit is truncated to it, and fbc / fbp that are not in fb.<subdomainIndex>.<creationMs>.<id> form are dropped.

The signed-in customer does not own the cart (unauthorized_customer), the cart is not active (it is completed or expired) or belongs to another shop (bad_request), or the postal code region lookup service fails for a shipping_address or billing_address sent with a zip but no region (region_lookup).

A body field fails validation. Typical cases: currency_code is not a shop currency. gift_info and starts_at are sent together, or the date is not an available start date ('The starts at is invalid.'). gift_info.recipient_email is missing while the shop collects it. coupon_code fails the coupon checks ('The coupon code is invalid.', 'You have already used this coupon.', 'This coupon is designated for personal use only.', 'To use this coupon, you must be a subscribed member.', 'Coupon conditions are not passed.'). gift_card_code is not valid ('The gift card is not valid.', 'The gift card has already expired.'). payment_method_id is sent without an attached, signed-in customer, or its gateway does not support the cart currency. customer is sent while a customer is attached or signed in. shipping_address_id or billing_address_id is not an address of the signed-in customer ('The shipping address id is prohibited. The customer must be attached to a cart.'). shipping_address, shipping_address_id and pickup_info conflict, or the cart holds only digital items ('The shipping address is prohibited for digital products.', 'The pickup info should be empty when digital products.'). shipping_method_id does not fit the address ('The shipping method id is not valid for the provided address.', 'The shipping method id is required when a shipping address or pickup info has been provided.'). shipping_carrier_id or shipping_carrier_service is missing for a dynamic method or not offered ('The selected carrier is not available for this shipping method.', 'The selected service is not available for this carrier.'). An address or pickup field is missing or invalid ('The phone number is invalid'). metadata holds unknown attributes or invalid values. expand is not an array.

The cart has expired or belongs to another shop (bad_request), or the postal code region lookup service fails when zip is sent without region_id for a country with regions (region_lookup).

A query parameter fails validation. country_id is missing or unknown. region_id is missing for a country with regions, sent for a country without regions, or not a region of that country. zip is missing. first_name or last_name is not 1 to 50 characters. phone is not a valid number ('The phone number is invalid'). address_one, address_two or city is not a string. expand is not an array.

The cart has a customer and the signed-in customer is not that customer (unauthorized_customer); the cart is not active (it is completed or expired) or belongs to another shop (bad_request); the cart has no available items (cart_empty); a bundle item carries invalid preferences (bundle_preferences_not_valid) or invalid products (bundle_items_not_valid); or a subscription item carries invalid survey answers (invalid_survey).

The cart is not ready for purchase. Each failed check adds an error under its field: customer_id ('The customer is not attached to the cart.', 'The TOS consent is required.'), coupon_id ('The coupon does not exists.', 'The coupon was already used by the customer.', 'The coupon rules are not passed for the customer.', 'To use this coupon, you must be a subscribed member.'), gift_card_id ('The gift voucher does not exists.', 'The gift voucher status should be in "issued" or "partially used".'), shipping_address_id ('The shipping address is required.', 'The shipping address does not exist.'), billing_address_id ('The billing address is required.', 'The billing address does not exist.'), shipping_method_id ('The shipping method is required.', 'The shipping method does not exist.', 'The shipping method is not valid.'), payment_method_id ('The payment method is required.', 'The payment method was not found.', 'The payment method is not valid.'), currency_code ('The currency code is not valid.'), gift_info.starts_at ('The selected gift start date is no longer available. Please choose a new date.') and starts_at ('The selected start date is no longer available. Please choose a new date.').

The cart already has a customer (customer_attached), or the cart is not active (it is completed or expired) or belongs to another shop (bad_request).