Get Order | BigCommerce Developer Center

import requests
url = "https://your_store.example.com/api/storefront/orders/1"
response = requests.get(url)
print(response.json())

{
  "orderId": 1.1,
  "cartId": "string",
  "currency": {
    "name": "string",
    "code": "string",
    "symbol": "string",
    "decimalPlaces": 1.1
  },
  "isTaxIncluded": true,
  "baseAmount": 1.1,
  "discountAmount": 1.1,
  "giftWrappingCostTotal": 1.1,
  "orderAmount": 1.1,
  "orderAmountAsInteger": 1.1,
  "coupons": [
    {
      "code": "string",
      "id": "string",
      "displayName": "string",
      "couponType": "string",
      "discountedAmount": 1.1
    }
  ],
  "lineItems": [
    {
      "physicalItems": [
        {
          "quantity": 1.1,
          "id": "string",
          "parentId": "string",
          "variantId": 1.1,
          "productId": 1.1,
          "sku": "string",
          "name": "string",
          "url": "string",
          "brand": "string",
          "isTaxable": true,
          "imageUrl": "string",
          "discounts": {},
          "discountAmount": 1.1,
          "couponAmount": 1.1,
          "listPrice": 1.1,
          "salePrice": 1.1,
          "extendedListPrice": 1.1,
          "extendedSalePrice": 1.1,
          "type": "string",
          "addedByPromotion": true,
          "isShippingRequired": true,
          "giftWrapping": {
            "name": "string",
            "message": "string",
            "amount": 1.1
          },
          "categories": [
            {}
          ]
        }
      ],
      "digitalItems": [
        {
          "quantity": 1.1,
          "id": "string",
          "parentId": "string",
          "variantId": 1.1,
          "productId": 1.1,
          "sku": "string",
          "name": "string",
          "url": "string",
          "brand": "string",
          "isTaxable": true,
          "imageUrl": "string",
          "discounts": [
            {
              "coupon": 8.28
            }
          ],
          "discountAmount": 1.1,
          "couponAmount": 1.1,
          "listPrice": 1.1,
          "salePrice": 1.1,
          "extendedListPrice": 1.1,
          "extendedSalePrice": 1.1,
          "type": "string",
          "downloadFileUrls": [
            "string"
          ],
          "downloadPageUrl": "string",
          "downloadSize": "string",
          "categories": [
            {}
          ]
        }
      ],
      "giftCertificate": [
        {
          "name": "string",
          "quantity": 1.1,
          "isTaxable": true,
          "amount": 1.1,
          "type": "string"
        }
      ]
    }
  ],
  "customerId": "string",
  "billingAddress": {
    "countryCode": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "company": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "stateOrProvince": "string",
    "stateOrProvinceCode": "string",
    "country": "string",
    "postalCode": "string",
    "phone": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "status": "INCOMPLETE",
  "hasDigitalItems": true,
  "isDownloadable": true,
  "isComplete": true,
  "customerMessage": "string",
  "shippingCostTotal": 1.1,
  "shippingCostBeforeDiscount": 1.1,
  "comparisonShippingCost": 1.1,
  "handlingCostTotal": 1.1,
  "customerCanBeCreated": true,
  "taxes": [
    {
      "name": "string",
      "amount": 1
    }
  ],
  "taxTotal": 1,
  "channelId": 1.1,
  "consignments": {
    "shipping": [
      {
        "lineItems": [
          {
            "id": 4
          }
        ],
        "shippingAddressId": 1,
        "firstName": "first1",
        "lastName": "last1",
        "company": "company1",
        "address1": "2802 Skyway Cir",
        "address2": "Balcony",
        "city": "Austin",
        "stateOrProvince": "Texas",
        "postalCode": "78704",
        "country": "United States",
        "countryCode": "US",
        "email": "first1@bigcommerce.com",
        "phone": "0410123452",
        "itemsTotal": 1,
        "itemsShipped": 0,
        "shippingMethod": "Flat Rate",
        "baseCost": 15.5,
        "costExTax": 15.5,
        "costIncTax": 16.7,
        "costTax": 1.2,
        "costTaxClassId": 2,
        "shippingCostBeforeDiscount": 1.1,
        "comparisonShippingCost": 1.1,
        "baseHandlingCost": 0,
        "handlingCostExTax": 0,
        "handlingCostIncTax": 0,
        "handlingCostTax": 0,
        "handlingCostTaxClassId": 2,
        "shippingZoneId": 1,
        "shippingZoneName": "United States",
        "customFields": [
          {
            "name": "special note",
            "value": "super rare"
          }
        ]
      }
    ]
  }
}

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.

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.

Path parameters

orderIdintegerRequired

ID of an Order.

Query parameters

includelist of enumsOptional

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

Response

orderIddouble>=1

cartIdstringformat: "uuid"

The ID of cart that was converted to order.

currencyobject

This will always be the same between cart and checkout.

isTaxIncludedboolean

Whether this item is taxable.

baseAmountdouble

Cost of cartʼs contents before applying discounts.

discountAmountdouble

Discounted amount.

giftWrappingCostTotaldouble

Gift wrapping for all items, including or excluding tax.

orderAmountdouble

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

orderAmountAsIntegerdouble

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

couponslist of objects

Array of AppliedCoupon objects applied to this cart.

lineItemslist of objects

Array of LineItem objects.

customerIdstring

billingAddressobject

statusenum

Order status.

hasDigitalItemsboolean

Specifies whether this order has at least one digital item.

isDownloadableboolean

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

isCompleteboolean

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

customerMessagestring

Shopperʼs provided message for the order.

shippingCostTotaldouble

shippingCostBeforeDiscountdouble

Estimated total shipping cost before any shipping discounts have been applied.

comparisonShippingCostdouble

The total shipping cost to be shown to shopper in the summary as struck-through.

If the entered-price and display-price have the same tax setting (e.g.: both are tax-inclusive), this field will be the estimated total shipping cost before any coupons applied (but after automatic promotions applied).
If the entered-price and display-price have different tax setting (e.g.: one is tax-inclusive, and one is tax-exclusive), this field will be the estimated total shipping cost before any discounts applied, similar to the shippingCostBeforeDiscount.

The total shipping cost to be shown to shopper in the summary as struck-through. - If the entered-price and display-price have the same tax setting (e.g.: both are tax-inclusive), this field will be the estimated total shipping cost before any coupons applied (but after automatic promotions applied). - If the entered-price and display-price have different tax setting (e.g.: one is tax-inclusive, and one is tax-exclusive), this field will be the estimated total shipping cost before any discounts applied, similar to the `shippingCostBeforeDiscount`.

handlingCostTotaldouble

customerCanBeCreatedboolean

taxeslist of objects

taxTotalinteger

channelIddouble

ID of the channel which the order belongs to.

consignmentsobject

All the consignments of the order.