Docs
Storefront API
Orders

Storefront Orders

Get order data immediately after an order is placed on BigCommerce-hosted storefronts. To work with headless storefronts, use the GraphQL Storefront API.

The REST Storefront API uses CORS (opens in a new tab) 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.

Get Order

GET /orders/{orderId}

Request

Returns Order data. This will return order data immediately after an order is placed on the storefront.

Note

  • Substitute your storefront domain for yourstore.example.com.
  • The Send a Test Request feature is not currently supported for this endpoint.

Parameters

  • store_domain in path - string
  • orderId in path - integer
    required

    ID of an Order.

  • include in query - array

    Sub-resources to include in an Order, in a comma-separated list. The ID and the specified fields will be returned.

    Type: array[string]

    Allowed: lineItems | billingAddress | coupons | currency | taxes | payments | consignments

example

Response

Body

object | application/json
  • orderId
    number

    Min: 1
  • cartId
    string

    The ID of cart that was converted to order.

  • currency
    object

    This will always be the same between cart and checkout.

  • isTaxIncluded
    boolean

    Whether this item is taxable.

  • baseAmount
    number

    Cost of cartʼs contents before applying discounts.

  • discountAmount
    number

    Discounted amount.

  • giftWrappingCostTotal
    number

    Gift wrapping for all items, including or excluding tax.

  • orderAmount
    number

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

  • orderAmountAsInteger
    number

    Order amount represented in integer. Eg. 1234 for $12.34

  • coupons
    array[object]

    Array of AppliedCoupon objects applied to this cart.

  • lineItems
    array[object]

    Array of LineItem objects.

  • customerId
    string

  • billingAddress
    object

  • status
    string

    Order status.

    Allowed: INCOMPLETE | PENDING | SHIPPED | PARTIALLY_SHIPPED | REFUNDED | CANCELLED | DECLINED | AWAITING_PAYMENT | AWAITING_PICKUP | AWAITING_SHIPMENT | COMPLETED | AWAITING_FULFILLMENT | MANUAL_VERIFICATION_REQUIRED | DISPUTED | PARTIALLY_REFUNDED

    Example: INCOMPLETE

  • hasDigitalItems
    boolean

    Specifies whether this order has at least one digital item.

  • isDownloadable
    boolean

    Specifies whether this order is fully paid, so that digital items can be downloaded.

  • isComplete
    boolean

    Specifies whether this order is complete and ready to be taken to the order confirmation page.

  • customerMessage
    string

    Shopperʼs provided message for the order.

  • shippingCostTotal
    integer

  • shippingCostBeforeDiscount
    integer

  • handlingCostTotal
    integer

  • customerCanBeCreated
    boolean

  • taxes
    array[object]

  • taxTotal
    integer

  • channelId
    number

    ID of the channel which the order belongs to.

  • consignments
    object

    All the consignments of the order.

example

Did you find what you were looking for?