US Dollars

Wholesale customers

Store Tax

The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Accept

addressId

The ID of the cart associated with this checkout. Identical to the checkout ID.

cartId

The ID of the subject checkout. Identical to the cart ID.

checkoutId

consignmentId

The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body.

Content-Type

couponCode

The code of the subject gift certificate.

giftCertificateCode

* `cart.lineItems.physicalItems.options` - physical options
* `cart.lineItems.digitalItems.options` - digital options
* `cart.lineItems.physicalItems.categoryNames` - physical categories
* `cart.lineItems.digitalItems.categoryNames` - digital categories
* `cart.lineItems.customItems.categoryNames` - custom categories
* `customer` - customer
* `customer.customerGroup` - customer group
* `payments` - payments
* `promotions` - promotions
* `consignments.availableShippingOptions` - shipping options
* `consignments.availablePickupOptions` - pickup options

include

itemId

The request cannot be processed due to a possible conflict. Please review the changes and try again.

The cart version that you expect to apply the updates. If the provided version doesn't match the current cart version, you will receive a conflict error. This field is optional; if not provided, optimistic concurrency control will not apply.

Billing address request

The discounted amount applied within a given context.

The coupon title based on different types provided in control panel section.

Cart Coupon

|Type `int`|Type Name|
|-|-|
|`0`|`per_item_discount`|
|`1`|`percentage_discount`|
|`2`|`per_total_discount`|
|`3`|`shipping_discount`|
|`4`|`free_shipping`|
|`5`|`promotion`|

Checkout Coupon

ISO 3166-1 alpha-2 country code. (See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

Indicates whether we should add this address to the customer address book.

Address Properties

Consignment Line Item

Create Consignment Request

Whether the shopper is a guest or a logged-in customer.

The amount of store credit a customer has.

Delete Consignment Request

Delete Coupon Request

Gift Certificate Request

One or more of these three fields is mandatory. You can update address and line items in one request. You have to update shipping option ID or pickup option ID in a separate request since changing the address or line items can invalidate the previously available shipping options.

Update Consignment Request

An option that represents a location where customers can pick up items.

Pickup Option

SpamProtectionRequest

address_Base

address_Full

Message shown to recipient, as provided by sender.

cartLineItemGiftCertificate_Put

if passing null, it will remove the current gift wrapping for the item

Details for the gift wrapping option selected. This can be specified for each line item or together based on wrapTogether value.
If wrapTogether is false, each element in the wrapDetails array determines each item's specific wrapping. 
(e.g if this line item has 6 quantity, you can pass at maximum 6 elements for the array to spefified each one's wrapping)  
If wrapTogether is true, we will only use 1st element in the wrapDetails array to determine what to be wrapped

Boolean value that specifies whether items whether items should be wrapped together or wrapped individually.

Gift Wrapping Request Data

cartLineItemPut

cart_Put

A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.

Cost of cart’s contents, before applying discounts.

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

The currency in which prices are displayed; the store default currency.

ISO-4217 currency code. (See: https://www.iso.org/iso-4217-currency-codes.html.)

The number of decimal places for the currency. For example, the USD currency has two decimal places.

Currency

ID of the customer to which the cart belongs.

Order-based discounted amount only - Excludes coupon discounts and product-based discounts.

Applied Discount

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

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

Boolean representing whether tax information is included.

Line Items

checkoutCart

Applied gift certificate (as a payment method).

checkoutGiftCertificates

checkoutTax

Shopperʼs message provided as details for the order to be created from this cart

Gift wrapping cost for all items, including or excluding tax.

The total payable amount, before applying any store credit or gift certificate.

Handling cost for all consignments including or excluding tax.

`true` value indicates StoreCredit has been applied.


`grandTotal` subtract the store-credit amount


The shipping cost before discounts are applied.

Shipping cost before any discounts are applied.

Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.

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

checkout_Full

checkout_Put

consignmentAvailableShippingOptions

Specifies the type of shipping option; for example, flat rate, UPS, etc.

consignmentShippingOption_Base

This allows us to have multiple shipping addresses. Where there is only one shipping address, this array will contain only one value, with all the items.

This is available only when "include=consignments.availableShippingOptions" is present in the URL.

List of consignment discounts applied through coupons.

Consignment Coupon Discount

List of consignment discounts applied through cart level discounts.

Consignment Discount

The handling cost of shipping for this consignment.

Read only. Field used for Shipping Provider API.

Selected Shipping Option

consignment_Full

contactEntity

When doing a PUT or POST to the `fieldValue` with a pick list, the input must be a number. The response will be a string.

This can also be an array for fields that need to support list of values; for example, a set of checkboxes. When doing a PUT or POST to the `fieldValue` with a pick list, the input must be a number. The response will be a string.

customFields

If the item was added automatically by a promotion, such as a coupon or buy one, get one.

The total value of all coupons applied to this item.

The total value of all discounts applied to this item (excluding coupon).

A list of discounts applied to this item, as an array of AppliedDiscount objects.

The itemʼs comparison price multiplied by the quantity.

The itemʼs list price multiplied by the quantity.

The itemʼs sale price multiplied by the quantity.

Gift Wrapping

A publicly-accessible URL for an image of this item.

Whether this item requires shipping to a physical address.

The net item price before discounts and coupons. BigCommerce derives an item's list price from the product default price or, if applicable, the sale price configured in the admin panel.

The item’s original price is the same as the product’s default price.

The product is part of a bundle such as a product pick list, then the parentId or the main product ID will populate.

The itemʼs price after all discounts are applied. The final price before tax calculation.

BigCommerce

Manage checkout operations and data on BigCommerce-hosted storefronts. To work with headless storefronts, use the [GraphQL Storefront API](/graphql-storefront/reference).

The REST Storefront API uses [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) headers for authentication, and therefore has no required scopes. You do not need to send any BigCommerce-specific tokens with your requests to these endpoints.
    
For info about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#same-origin-cors-authentication).

Storefront Checkouts

Returns a *Checkout*.

The cart ID and checkout ID are the same.

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

When a problem arises, returns a generic response.

Updates *Checkout* customer messages.

**Limits**

* 2000 character limit

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Adds a billing address to an existing *Checkout*.

**Required Fields**
* country_code


> #### Note
> * The `email` property is only required if the customer is a guest shopper. Otherwise, it is set automatically.
> * Sending `email` property as a payload in POST request triggers the abandoned cart notification process.
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

The email trying to be set for the guest is associated with an account. The customer must sign in.

Unable to determine if provided email is associated with an account. The customer must sign in.

Updates an existing billing address on *Checkout*.

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint. 
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Deletes a *Line Item* from the *Cart*.

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

NOTE: Discounted line items are re-evaluated on cart actions and may be automatically added back to your cart with a new line item ID to satisfy promotional requirements.

Updates a *Checkout Line Item*. Updates an existing, single line item in the cart.

If a variant needs to be changed or updated, the product will need to be removed and re-added to the cart with the correct variants using the [Add Cart Line Items](/docs/rest-storefront/carts/cart-items#add-cart-line-items) endpoint or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront).

> #### Notes
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.  
> * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Adds a new *Consignment* to *Checkout*.

Perform the following two steps to define the fulfillment of the items in the cart.
### For **shipping** consignments:
  1. Add a new Consignment to Checkout.
      * Send a `POST` request to `/consignments` with each shipping address, line item IDs, and quantities. Each address can have its own line item IDs.
      * Provide a full valid customer address before placing the order. If provided, the order placement will succeed. 
      * As part of the request URL make sure to add `include=consignments.availableShippingOptions` to return the available shipping options based on the items, the address, and the shipping location. This will return `availableShippingOptions` in the response.

      * Required Fields:
        * `shipping_address` (deprecated) or `address`
        * `lineItems`
      
  2. Update the Consignment with Shipping Options using the [REST Storefront API](/docs/rest-storefront/checkouts/checkout-consignments#update-a-consignment), the [REST Management API](/docs/rest-management/checkouts/checkout-consignments#update-checkout-consignment) or the [GraphQL Storefront API](/docs/storefront/cart-checkout/guide/graphql-storefront).
        
### For **pickup** consignments:
  1. Create a new consignment object. 
      - Send a `POST` request to `/consignments` with line item IDs and quantities.
      - Provide a `pickupMethodId`. This is the `id` of the Pickup Method provided in the response body of the Storefront Pickup Options API.
      - Required Fields:
          * `pickupOption`
          * `lineItems`

To learn more about creating a Checkout Consignment, see the [Carts and Checkouts Tutorial](/docs/storefront/cart-checkout/guide/rest-storefront).

> #### Notes
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.  
> * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.


Removes an existing *Consignment* from *Checkout*.

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Updates an existing consignment. An update is either one of the following:

1. Updates the consignment address and/or line items.
2. Selects a specific fulfillment option.

### Update the consignment address and line items
For this type of update, the payload is the same as when creating a new consignment.         Update each *Consignment* `shippingOptionId` (shipping address and line items) with the `availableShippingOption > id` from the POST `/consignment` response. 

**Note:**
Updating a consignment could invalidate the value for `selectedShippingOption` and `selectedPickupOption`.

### Select a specific fulfillment option
Before placing an order, each consignment must have a `selectedShippingOption` or a `selectedPickupOption`.

If the consignment already has a pick-up option selected and a shipping option is provided, the pick-up option will be deselected and the shipping option will be selected instead (and vice versa). The `PUT` request will fail if it contains a shipping option ID and a pickup option ID.

Required Fields:
* `shippingOptionId` or `pickupOptionId`
* `lineItems`

To learn more about creating a Checkout Consignment see [Checkout Consignment API](/docs/storefront/cart-checkout/guide/consignments).

> #### Notes
> * You cannot pass both an `address` and a `shippingOptionId` because the shipping option may not be available for the new address 
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.  
> * Please note that this API endpoint is not concurrent safe, meaning multiple simultaneous requests could result in unexpected and inconsistent results.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Adds a *Coupon Code* to *Checkout*.

**Required Fields**
* couponCode

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Coupon Code Request

Deletes a *Coupon Code* from *Checkout*.

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.


Adds a *Gift Certificate Code* to *Checkout*.

> #### Note
> * *Gift Certificates* are treated as a payment methods.
> * You are not able to purchase a gift certificate with a gift certificate.
> * The rate limit is 20/hour (only for unique gift-certificate codes).
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint. 
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Deletes an existing *Gift Certificate*.

This removes the *Gift Certificate* payment method.

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.  

Verifies if checkout is created by human.

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Removes store credit from a checkout.

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

Applies any available store credit to a checkout. As on the storefront, all available store credit will be used (up to the value of the order) and no amount need be specified.

> #### Note
> * Substitute your storefront domain for `yourstore.example.com`. 
> * The Send a Test Request feature is not currently supported for this endpoint.
> * This endpoint requires using Stencil CLI, a local session, and a csrf token to work.

The [URL authority](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Web_mechanics/What_is_a_URL#authority) of the storefront.

Checkout Consignments

Create a Consignment

Update a Consignment

Delete a Consignment