Skip to navigation
RESTStorefrontCheckoutsConsignments

Create Consignment

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, the REST Management API or the GraphQL Storefront API.

For pickup consignments:

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.

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 runs in the context of an active storefront session and works on any live BigCommerce-hosted storefront, not only in a local environment. It uses same-origin CORS authentication, and write requests require a CSRF token. Stencil CLI can provide a session and CSRF token for local theme development.

Path parameters

checkoutIdstringRequiredformat: "uuid"
The ID of the subject checkout. Identical to the cart ID.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Query parameters

includelist of enumsOptionalDefaults to ["consignments.availableShippingOptions"]
  • 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
  • cart.lineItems.physicalItems.stockPosition - backorder and stock availability for physical items
  • cart.lineItems.digitalItems.stockPosition - backorder and stock availability for digital items (backorder values are always zero since digital products cannot be backordered)
  • customer - customer
  • customer.customerGroup - customer group
  • payments - payments
  • promotions - promotions
  • consignments.availableShippingOptions - shipping options
  • consignments.availablePickupOptions - pickup options

Request

This endpoint expects a list of objects.
shippingAddressobjectOptional
addressobjectOptional
lineItemslist of objectsOptional
shippingOptionIdstringOptional
pickupOptionobjectOptional
versionintegerOptional

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.

Response

OK
billingAddressobjectOptional
cartobjectOptional

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

channelIdintegerOptional
Channel ID.
consignmentslist of objectsOptional
couponslist of objectsOptional
Coupons applied at the checkout level.
feeslist of objectsOptional
Fees applied at the checkout level.
createdTimestringOptional
Time when the cart was created.
customerobjectOptional
Customer details.
customerMessagestringOptional

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

giftCertificateslist of objectsOptional

Applied gift certificate (as a payment method).

giftWrappingCostTotaldoubleOptional
Gift wrapping cost for all items, including or excluding tax.
grandTotalfloatOptional
The total payable amount, before applying any store credit or gift certificate.
handlingCostTotalfloatOptional
Handling cost for all consignments including or excluding tax.
idstringOptionalformat: "uuid"
isStoreCreditAppliedbooleanOptional

true value indicates StoreCredit has been applied.

orderIdstring or nullOptional
outstandingBalancedoubleOptional

grandTotal subtract the store-credit amount

paymentslist of objectsOptional
promotionslist of objectsOptional
shippingCostBeforeDiscountfloatOptional
Total shipping cost for the checkout before discounts are applied.
comparisonShippingCostfloatOptional
Total shipping cost for the checkout after automatic promotions are applied.
shippingCostTotalfloatOptional
Shipping cost before any discounts are applied.
shouldExecuteSpamCheckbooleanOptional
subtotalfloatOptional

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

taxeslist of objectsOptional
taxTotalfloatOptional
updatedTimestringOptional
Time when the cart was last updated.
versionintegerOptional
The current version of the checkout increments with each successful update. You can use it to enable optimistic concurrency control for subsequent updates.

Errors

409
Conflict Error