NAV
Subscribe to developer updates

BigCommerce Storefront Checkout/Orders API

Storefront Checkout/Orders API (Early Access)

The Storefront Checkout API allows applications to programmatically present a checkout UI, modify cart contents within the checkout step, retrieve shipping and payment options, update the shopper’s shipping and billing addresses, and complete checkout.

This API exposes many of the same resources and operations that are provided in BigCommerce’s v3 Server-to-Server Cart API. However, to maintain stores’ security, some operations are not provided here. The limitations basically correspond to BigCommerce’s restrictions on the actions a shopper would be allowed to take on a BigCommerce storefront.

Terms of service

Base URL: https://{{store_url}}

Checkout

The Storefront Checkout exposes the endpoints listed below.

GET /checkouts

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('{{store_url}}/api/storefront/checkouts', headers=headers)

print r.json()

Retrieves a collection of Checkout Objects.

Example responses:

{
  "data": [
    {
      "id": "string",
      "cart": {
        "id": "string",
        "currency": {
          "name": "string",
          "code": "string",
          "symbol": "string"
        },
        "isTaxIncluded": true,
        "baseAmount": 0,
        "discountAmount": 0,
        "taxAmount": 0,
        "cartAmount": 0,
        "coupons": [
          {
            "id": "string",
            "code": "string",
            "name": "string",
            "slug": "string",
            "couponType": "string",
            "discountedAmount": 0
          }
        ],
        "discounts": [
          {
            "name": "string",
            "discountedAmount": 0
          }
        ],
        "lineItems": [
          {
            "physicalItems": [
              {
                "id": "string",
                "name": "string",
                "description": "string",
                "url": "http://example.com",
                "quantity": 0,
                "isTaxable": true,
                "imageUrl": "http://example.com",
                "baseAmount": 0,
                "discountAmount": 0,
                "couponAmount": 0,
                "finalAmount": 0,
                "coupons": [
                  {
                    "id": "string",
                    "code": "string",
                    "name": "string",
                    "slug": "string",
                    "couponType": "string",
                    "discountedAmount": 0
                  }
                ],
                "discounts": [
                  {
                    "name": "string",
                    "discountedAmount": 0
                  }
                ],
                "itemTaxTotal": 0,
                "itemTotal": 0,
                "variant": {
                  "id": 0,
                  "productId": 0,
                  "price": 0,
                  "salePrice": 0,
                  "listPrice": 0,
                  "skuId": 0,
                  "sku": "string",
                  "options": [
                    {
                      "id": 0,
                      "name": "string",
                      "valueId": 0,
                      "valueLabel": "string"
                    }
                  ]
                },
                "modifiers": [
                  [
                    {
                      "id": 0,
                      "name": "string",
                      "valueId": 0,
                      "valueLabel": "string",
                      "shopperInput": "string"
                    }
                  ]
                ],
                "isShippingRequired": true,
                "giftWrapping": {
                  "name": "string",
                  "message": "string",
                  "amount": 0
                }
              }
            ],
            "digitalItems": [
              {
                "id": "string",
                "name": "string",
                "description": "string",
                "url": "http://example.com",
                "quantity": 0,
                "isTaxable": true,
                "imageUrl": "http://example.com",
                "baseAmount": 0,
                "discountAmount": 0,
                "couponAmount": 0,
                "finalAmount": 0,
                "coupons": [
                  {
                    "id": "string",
                    "code": "string",
                    "name": "string",
                    "slug": "string",
                    "couponType": "string",
                    "discountedAmount": 0
                  }
                ],
                "discounts": [
                  {
                    "name": "string",
                    "discountedAmount": 0
                  }
                ],
                "itemTaxTotal": 0,
                "itemTotal": 0,
                "downloadFileUrls": [
                  "string"
                ],
                "downloadPageUrl": "string",
                "downloadSize": "string"
              }
            ],
            "giftCertificate": [
              {
                "id": "string",
                "theme": "string",
                "amount": 0,
                "isTaxable": true,
                "sender": {
                  "name": "string",
                  "email": "user@example.com"
                },
                "recipient": {
                  "name": "string",
                  "email": "user@example.com"
                },
                "message": "string"
              }
            ]
          }
        ],
        "createdTime": "string",
        "updatedTime": "string",
        "links": [
          {
            "rel": "string",
            "href": "string"
          }
        ]
      },
      "shopper": {
        "customerId": "string",
        "customerGroupId": "string",
        "storeCredit": "string"
      },
      "billingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "email": "user@example.com",
        "region": "string",
        "country": "string",
        "postalCode": "string",
        "street1": "string",
        "street2": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "shippingAddresses": [
        {
          "id": "string",
          "firstName": "string",
          "lastName": "string",
          "phone": "string",
          "email": "user@example.com",
          "region": "string",
          "country": "string",
          "postalCode": "string",
          "street1": "string",
          "street2": "string",
          "customFields": [
            {
              "fieldId": "string",
              "fieldValue": "string"
            }
          ]
        }
      ],
      "consignments": [
        {
          "id": "string",
          "shippingAddressId": "string",
          "shippingMethodId": "string",
          "shippingCost": 0,
          "lineItemIds": [
            0
          ]
        }
      ],
      "taxes": [
        {
          "itemId": "string",
          "name": "string",
          "amount": 0,
          "percentage": 0
        }
      ],
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "coupons": [
        {
          "id": "string",
          "code": "string",
          "name": "string",
          "slug": "string",
          "couponType": "string",
          "discountedAmount": 0
        }
      ],
      "orderId": "string",
      "shippingCostTotal": 0,
      "taxTotal": 0,
      "grandTotal": 0,
      "storeCredit": 0,
      "giftCertificates": [
        {
          "balance": 0,
          "code": "string",
          "purchaseDate": "2017-09-27"
        }
      ],
      "balanceDue": 0,
      "createdTime": "string",
      "updatedTime": "string"
    }
  ],
  "meta": {
    "geoCountryCode": "string",
    "sessionHash": "string",
    "deviceSessionId": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Returns a collection of Checkout Objects. Inline

Response Schema

Status Code 200

Name Type Required Description
meta Meta false A BigCommerce Meta object.
data Cart false A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.

GET /checkouts/{checkoutId}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('{{store_url}}/api/storefront/checkouts/{checkoutId}', headers=headers)

print r.json()

Returns information about a given Checkout, specified by its ID.

A checkout is an aggregation of multiple entities – Cart, Addresses, Shipping Options, and more.

Parameters

Parameter Type Required Description
checkoutId string true The ID of this Checkout.

Example responses:

{
  "data": {
    "id": "string",
    "cart": {
      "id": "string",
      "currency": {
        "name": "string",
        "code": "string",
        "symbol": "string"
      },
      "isTaxIncluded": true,
      "baseAmount": 0,
      "discountAmount": 0,
      "taxAmount": 0,
      "cartAmount": 0,
      "coupons": [
        {
          "id": "string",
          "code": "string",
          "name": "string",
          "slug": "string",
          "couponType": "string",
          "discountedAmount": 0
        }
      ],
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "lineItems": [
        {
          "physicalItems": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "baseAmount": 0,
              "discountAmount": 0,
              "couponAmount": 0,
              "finalAmount": 0,
              "coupons": [
                {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "slug": "string",
                  "couponType": "string",
                  "discountedAmount": 0
                }
              ],
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "itemTaxTotal": 0,
              "itemTotal": 0,
              "variant": {
                "id": 0,
                "productId": 0,
                "price": 0,
                "salePrice": 0,
                "listPrice": 0,
                "skuId": 0,
                "sku": "string",
                "options": [
                  {
                    "id": 0,
                    "name": "string",
                    "valueId": 0,
                    "valueLabel": "string"
                  }
                ]
              },
              "modifiers": [
                [
                  {
                    "id": 0,
                    "name": "string",
                    "valueId": 0,
                    "valueLabel": "string",
                    "shopperInput": "string"
                  }
                ]
              ],
              "isShippingRequired": true,
              "giftWrapping": {
                "name": "string",
                "message": "string",
                "amount": 0
              }
            }
          ],
          "digitalItems": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "baseAmount": 0,
              "discountAmount": 0,
              "couponAmount": 0,
              "finalAmount": 0,
              "coupons": [
                {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "slug": "string",
                  "couponType": "string",
                  "discountedAmount": 0
                }
              ],
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "itemTaxTotal": 0,
              "itemTotal": 0,
              "downloadFileUrls": [
                "string"
              ],
              "downloadPageUrl": "string",
              "downloadSize": "string"
            }
          ],
          "giftCertificate": [
            {
              "id": "string",
              "theme": "string",
              "amount": 0,
              "isTaxable": true,
              "sender": {
                "name": "string",
                "email": "user@example.com"
              },
              "recipient": {
                "name": "string",
                "email": "user@example.com"
              },
              "message": "string"
            }
          ]
        }
      ],
      "createdTime": "string",
      "updatedTime": "string",
      "links": [
        {
          "rel": "string",
          "href": "string"
        }
      ]
    },
    "shopper": {
      "customerId": "string",
      "customerGroupId": "string",
      "storeCredit": "string"
    },
    "billingAddress": {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    },
    "shippingAddresses": [
      {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "email": "user@example.com",
        "region": "string",
        "country": "string",
        "postalCode": "string",
        "street1": "string",
        "street2": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      }
    ],
    "consignments": [
      {
        "id": "string",
        "shippingAddressId": "string",
        "shippingMethodId": "string",
        "shippingCost": 0,
        "lineItemIds": [
          0
        ]
      }
    ],
    "taxes": [
      {
        "itemId": "string",
        "name": "string",
        "amount": 0,
        "percentage": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "orderId": "string",
    "shippingCostTotal": 0,
    "taxTotal": 0,
    "grandTotal": 0,
    "storeCredit": 0,
    "giftCertificates": [
      {
        "balance": 0,
        "code": "string",
        "purchaseDate": "2017-09-27"
      }
    ],
    "balanceDue": 0,
    "createdTime": "string",
    "updatedTime": "string"
  },
  "meta": {
    "geoCountryCode": "string",
    "sessionHash": "string",
    "deviceSessionId": "string"
  }
}

Error response:

{
  "errors": [
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "detail": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Inline
400 Bad Request When a problem arises, returns (for now) a generic response. CheckoutError

Response Schema

Status Code 200

Name Type Required Description
data [Checkout] false Response data container.
meta Meta false A BigCommerce Meta object.

PUT /checkouts/{checkoutId}/carts/{cartId}/items/{itemId}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.put('{{store_url}}/api/storefront/checkouts/{checkoutId}/carts/{cartId}/items/{itemId}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Partial updates of cart sub-resource, via checkout endpoint.

Body parameter:

{
  "lineItem": {
    "quantity": 0,
    "productId": 0,
    "variantId": 0
  },
  "giftCertificate": {
    "theme": "string",
    "amount": 1,
    "sender": {
      "name": "string",
      "email": "user@example.com"
    },
    "recipient": {
      "name": "string",
      "email": "user@example.com"
    },
    "message": "string",
    "quantity": 0
  }
}

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
cartId string(UUID) true ID of the cart.
itemId string true ID of the item to update.
body CartUpdateRequest true A BigCommerce CartUpdateRequest object.

Example responses:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

DELETE /checkouts/{checkoutId}/carts/{cartId}/items/{itemId}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.delete('{{store_url}}/api/storefront/checkouts/{checkoutId}/carts/{cartId}/items/{itemId}', headers=headers)

print r.json()

Removes a line item from the cart.

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
cartId string(UUID) true ID of the cart.
itemId string true ID of the item to delete.

Example responses:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Cart Entity Object. Checkout

POST /checkouts/{checkoutId}/billing-address

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('{{store_url}}/api/storefront/checkouts/{checkoutId}/billing-address', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Adds customer’s billing address to checkout.

Body parameter:

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "phone": "string",
  "email": "user@example.com",
  "region": "string",
  "country": "string",
  "postalCode": "string",
  "street1": "string",
  "street2": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
body Address true A BigCommerce Address object.

Example response:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

PUT /checkouts/{checkoutId}/billing-address/{addressId}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.put('{{store_url}}/api/storefront/checkouts/{checkoutId}/billing-address/{addressId}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Updates customer’s billing address in checkout.

Body parameter:

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "phone": "string",
  "email": "user@example.com",
  "region": "string",
  "country": "string",
  "postalCode": "string",
  "street1": "string",
  "street2": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
addressId number true ID of this address.
body Address true A BigCommerce Address object.

Example responses:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

POST /checkouts/{checkoutId}/shipping-addresses

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('{{store_url}}/api/storefront/checkouts/{checkoutId}/shipping-addresses', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Adds customer’s shipping address to checkout.

Body parameter:

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "phone": "string",
  "email": "user@example.com",
  "region": "string",
  "country": "string",
  "postalCode": "string",
  "street1": "string",
  "street2": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
body Address true A BigCommerce Address object.

Example responses:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

PUT /checkouts/{checkoutId}/shipping-addresses/{addressId}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.put('{{store_url}}/api/storefront/checkouts/{checkoutId}/shipping-addresses/{addressId}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Updates customer’s shipping address in checkout.

Body parameter:

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "phone": "string",
  "email": "user@example.com",
  "region": "string",
  "country": "string",
  "postalCode": "string",
  "street1": "string",
  "street2": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
addressId number true ID of this address.
body Address true A BigCommerce Address object.

Example responses:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

GET /checkouts/{checkoutId}/payments

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('{{store_url}}/api/storefront/checkouts/{checkoutId}/payments', headers=headers)

print r.json()

Retrieves a list of available payment methods.

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.

Example responses:

{
  "meta": {},
  "data": {
    "paymentMethods": [
      {
        "id": "string",
        "logoUrl": "string",
        "method": "string",
        "supportedCards": [
          "string"
        ],
        "type": "PAYMENT_TYPE_OFFLINE",
        "nonce": "string",
        "clientToken": "string"
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK Returns list of payment methods. ResponsePaymentsData

POST /checkouts/{checkoutId}/giftcertificate

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('{{store_url}}/api/storefront/checkouts/{checkoutId}/giftcertificate', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Adds gift certificate code to checkout.

Body parameter:

{
  "giftCertificateCode": "string"
}

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
body GiftCertificateRequest true A BigCommerce GiftCertificateRequest object.

Example response:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object Checkout

DELETE /checkouts/{checkoutId}/giftcertificate/{giftCertificateCode}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.delete('{{store_url}}/api/storefront/checkouts/{checkoutId}/giftcertificate/{giftCertificateCode}', headers=headers)

print r.json()

Removes an existing gift certificate from checkout.

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
giftCertificateCode string true Code of the gift-certificate to delete.

Example responses:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

POST /checkouts/{checkoutId}/coupon

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('{{store_url}}/api/storefront/checkouts/{checkoutId}/coupon', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Adds a coupon code to checkout.

Body parameter:

{
  "couponCode": "string"
}

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
body CouponCodeRequest true A BigCommerce CouponCodeRequest object.

Example responses:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

DELETE /checkouts/{checkoutId}/coupon/{couponCode}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.delete('{{store_url}}/api/storefront/checkouts/{checkoutId}/coupon/{couponCode}', headers=headers)

print r.json()

Removes an existing coupon from checkout.

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
couponCode string true Code of the coupon to delete.

Example responses:

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Checkout Object. Checkout

GET /checkouts/{checkoutId}/shipping-addresses/{shippingAddressId}/options

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('{{store_url}}/api/storefront/checkouts/{checkoutId}/shipping-addresses/{shippingAddressId}/options', headers=headers)

print r.json()

Retrieves a list of available shipping options.

Parameters

Parameter Type Required Description
checkoutId string true The ID of this Checkout.
shippingAddressId string true The ID of this shipping address.

Example responses:

{
  "meta": {
    "geoCountryCode": "string",
    "sessionHash": "string",
    "deviceSessionId": "string"
  },
  "data": {
    "shippingOptions": {
      "addressId": [
        {
          "description": "string",
          "formattedPrice": 0,
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "selected": true,
          "transitTime": "string"
        }
      ]
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Returns list of shipping options, or an empty array. ResponseShippingOptions

POST /checkouts/{checkoutId}/order

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('{{store_url}}/api/storefront/checkouts/{checkoutId}/order', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Creates an order.

Body parameter:

{
  "customerMessage": "string",
  "payment": {
    "name": "string"
  }
}

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
body RequestOrderData true A data collection that the order endpoint consumes when creating an order with different payment methods/payment providers.

Example responses:

{
  "meta": {},
  "data": {
    "order": {
      "id": "string",
      "currency": {
        "name": "string",
        "code": "string",
        "symbol": "string"
      },
      "isTaxIncluded": true,
      "baseAmount": 0,
      "discountAmount": 0,
      "taxAmount": 0,
      "cartAmount": 0,
      "coupons": [
        {
          "id": "string",
          "code": "string",
          "name": "string",
          "slug": "string",
          "couponType": "string",
          "discountedAmount": 0
        }
      ],
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "lineItems": [
        {
          "physicalItems": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "baseAmount": 0,
              "discountAmount": 0,
              "couponAmount": 0,
              "finalAmount": 0,
              "coupons": [
                {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "slug": "string",
                  "couponType": "string",
                  "discountedAmount": 0
                }
              ],
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "itemTaxTotal": 0,
              "itemTotal": 0,
              "variant": {
                "id": 0,
                "productId": 0,
                "price": 0,
                "salePrice": 0,
                "listPrice": 0,
                "skuId": 0,
                "sku": "string",
                "options": [
                  {
                    "id": 0,
                    "name": "string",
                    "valueId": 0,
                    "valueLabel": "string"
                  }
                ]
              },
              "modifiers": [
                [
                  {
                    "id": 0,
                    "name": "string",
                    "valueId": 0,
                    "valueLabel": "string",
                    "shopperInput": "string"
                  }
                ]
              ],
              "isShippingRequired": true,
              "giftWrapping": {
                "name": "string",
                "message": "string",
                "amount": 0
              }
            }
          ],
          "digitalItems": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "baseAmount": 0,
              "discountAmount": 0,
              "couponAmount": 0,
              "finalAmount": 0,
              "coupons": [
                {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "slug": "string",
                  "couponType": "string",
                  "discountedAmount": 0
                }
              ],
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "itemTaxTotal": 0,
              "itemTotal": 0,
              "downloadFileUrls": [
                "string"
              ],
              "downloadPageUrl": "string",
              "downloadSize": "string"
            }
          ],
          "giftCertificate": [
            {
              "id": "string",
              "theme": "string",
              "amount": 0,
              "isTaxable": true,
              "sender": {
                "name": "string",
                "email": "user@example.com"
              },
              "recipient": {
                "name": "string",
                "email": "user@example.com"
              },
              "message": "string"
            }
          ]
        }
      ],
      "createdTime": "string",
      "updatedTime": "string",
      "links": [
        {
          "rel": "string",
          "href": "string"
        }
      ],
      "orderId": 0,
      "customerId": "string",
      "token": "string",
      "billingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "email": "user@example.com",
        "region": "string",
        "country": "string",
        "postalCode": "string",
        "street1": "string",
        "street2": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "payment": {
        "id": "string",
        "redirectUrl": "string",
        "returnUrl": "string",
        "status": "PAYMENT_STATUS_INITIALIZE",
        "helpText": "string"
      },
      "socialData": [
        {
          "name": "string",
          "description": "string",
          "image": "string",
          "url": "string",
          "shareText": "string",
          "sharingLink": "string"
        }
      ],
      "status": "ORDER_STATUS_INCOMPLETE",
      "customerCreated": true,
      "hasDigitalItems": true,
      "isDownloadable": true,
      "isComplete": true,
      "callbackUrl": "string"
    }
  }
}

Responses

Status Meaning Description Schema
201 Created Returns a subset of Order Object. ResponseOrderData

PUT /checkouts/{checkoutId}/shipping-addresses/{shippingAddressId}/options/{shippingOptionId}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.put('{{store_url}}/api/storefront/checkouts/{checkoutId}/shipping-addresses/{shippingAddressId}/options/{shippingOptionId}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Updates shopper’s selected shipping option.

Parameters

Parameter Type Required Description
checkoutId string true ID of this Checkout.
shippingAddressId string true ID of this shipping address.
shippingOptionId string true ID of this shipping option.

Example responses:

{
  "meta": {
    "geoCountryCode": "string",
    "sessionHash": "string",
    "deviceSessionId": "string"
  },
  "data": {
    "shippingOptions": {
      "addressId": [
        {
          "description": "string",
          "formattedPrice": 0,
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "selected": true,
          "transitTime": "string"
        }
      ]
    }
  }
}

Responses

Status Meaning Description Schema
200 OK ok ResponseShippingOptions

Orders

The Storefront Orders endpoints provide order details to display in the order confirmation page.

GET /orders/{orderId}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('{{store_url}}/api/storefront/orders/{orderId}', headers=headers)

print r.json()

Retrieves order data.

Parameters

Parameter Type Required Description
orderId integer true ID of an Order.

Example responses:

{
  "meta": {},
  "data": {
    "order": {
      "id": "string",
      "currency": {
        "name": "string",
        "code": "string",
        "symbol": "string"
      },
      "isTaxIncluded": true,
      "baseAmount": 0,
      "discountAmount": 0,
      "taxAmount": 0,
      "cartAmount": 0,
      "coupons": [
        {
          "id": "string",
          "code": "string",
          "name": "string",
          "slug": "string",
          "couponType": "string",
          "discountedAmount": 0
        }
      ],
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "lineItems": [
        {
          "physicalItems": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "baseAmount": 0,
              "discountAmount": 0,
              "couponAmount": 0,
              "finalAmount": 0,
              "coupons": [
                {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "slug": "string",
                  "couponType": "string",
                  "discountedAmount": 0
                }
              ],
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "itemTaxTotal": 0,
              "itemTotal": 0,
              "variant": {
                "id": 0,
                "productId": 0,
                "price": 0,
                "salePrice": 0,
                "listPrice": 0,
                "skuId": 0,
                "sku": "string",
                "options": [
                  {
                    "id": 0,
                    "name": "string",
                    "valueId": 0,
                    "valueLabel": "string"
                  }
                ]
              },
              "modifiers": [
                [
                  {
                    "id": 0,
                    "name": "string",
                    "valueId": 0,
                    "valueLabel": "string",
                    "shopperInput": "string"
                  }
                ]
              ],
              "isShippingRequired": true,
              "giftWrapping": {
                "name": "string",
                "message": "string",
                "amount": 0
              }
            }
          ],
          "digitalItems": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "baseAmount": 0,
              "discountAmount": 0,
              "couponAmount": 0,
              "finalAmount": 0,
              "coupons": [
                {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "slug": "string",
                  "couponType": "string",
                  "discountedAmount": 0
                }
              ],
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "itemTaxTotal": 0,
              "itemTotal": 0,
              "downloadFileUrls": [
                "string"
              ],
              "downloadPageUrl": "string",
              "downloadSize": "string"
            }
          ],
          "giftCertificate": [
            {
              "id": "string",
              "theme": "string",
              "amount": 0,
              "isTaxable": true,
              "sender": {
                "name": "string",
                "email": "user@example.com"
              },
              "recipient": {
                "name": "string",
                "email": "user@example.com"
              },
              "message": "string"
            }
          ]
        }
      ],
      "createdTime": "string",
      "updatedTime": "string",
      "links": [
        {
          "rel": "string",
          "href": "string"
        }
      ],
      "orderId": 0,
      "customerId": "string",
      "token": "string",
      "billingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "email": "user@example.com",
        "region": "string",
        "country": "string",
        "postalCode": "string",
        "street1": "string",
        "street2": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "payment": {
        "id": "string",
        "redirectUrl": "string",
        "returnUrl": "string",
        "status": "PAYMENT_STATUS_INITIALIZE",
        "helpText": "string"
      },
      "socialData": [
        {
          "name": "string",
          "description": "string",
          "image": "string",
          "url": "string",
          "shareText": "string",
          "sharingLink": "string"
        }
      ],
      "status": "ORDER_STATUS_INCOMPLETE",
      "customerCreated": true,
      "hasDigitalItems": true,
      "isDownloadable": true,
      "isComplete": true,
      "callbackUrl": "string"
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Returns a subset of Order Object. ResponseOrderData

PUT /orders/{orderId}

Code samples:

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.put('{{store_url}}/api/storefront/orders/{orderId}', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

Finalizes the order - applicable only to hosted payments.

Parameters

Parameter Type Required Description
orderId integer true ID of this Order.

Example responses:

{
  "id": "string",
  "currency": {
    "name": "string",
    "code": "string",
    "symbol": "string"
  },
  "isTaxIncluded": true,
  "baseAmount": 0,
  "discountAmount": 0,
  "taxAmount": 0,
  "cartAmount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "lineItems": [
    {
      "physicalItems": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "baseAmount": 0,
          "discountAmount": 0,
          "couponAmount": 0,
          "finalAmount": 0,
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "couponType": "string",
              "discountedAmount": 0
            }
          ],
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "itemTaxTotal": 0,
          "itemTotal": 0,
          "variant": {
            "id": 0,
            "productId": 0,
            "price": 0,
            "salePrice": 0,
            "listPrice": 0,
            "skuId": 0,
            "sku": "string",
            "options": [
              {
                "id": 0,
                "name": "string",
                "valueId": 0,
                "valueLabel": "string"
              }
            ]
          },
          "modifiers": [
            [
              {
                "id": 0,
                "name": "string",
                "valueId": 0,
                "valueLabel": "string",
                "shopperInput": "string"
              }
            ]
          ],
          "isShippingRequired": true,
          "giftWrapping": {
            "name": "string",
            "message": "string",
            "amount": 0
          }
        }
      ],
      "digitalItems": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "baseAmount": 0,
          "discountAmount": 0,
          "couponAmount": 0,
          "finalAmount": 0,
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "couponType": "string",
              "discountedAmount": 0
            }
          ],
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "itemTaxTotal": 0,
          "itemTotal": 0,
          "downloadFileUrls": [
            "string"
          ],
          "downloadPageUrl": "string",
          "downloadSize": "string"
        }
      ],
      "giftCertificate": [
        {
          "id": "string",
          "theme": "string",
          "amount": 0,
          "isTaxable": true,
          "sender": {
            "name": "string",
            "email": "user@example.com"
          },
          "recipient": {
            "name": "string",
            "email": "user@example.com"
          },
          "message": "string"
        }
      ]
    }
  ],
  "createdTime": "string",
  "updatedTime": "string",
  "links": [
    {
      "rel": "string",
      "href": "string"
    }
  ],
  "orderId": 0,
  "customerId": "string",
  "token": "string",
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "payment": {
    "id": "string",
    "redirectUrl": "string",
    "returnUrl": "string",
    "status": "PAYMENT_STATUS_INITIALIZE",
    "helpText": "string"
  },
  "socialData": [
    {
      "name": "string",
      "description": "string",
      "image": "string",
      "url": "string",
      "shareText": "string",
      "sharingLink": "string"
    }
  ],
  "status": "ORDER_STATUS_INCOMPLETE",
  "customerCreated": true,
  "hasDigitalItems": true,
  "isDownloadable": true,
  "isComplete": true,
  "callbackUrl": "string"
}

Responses

Status Meaning Description Schema
200 OK Returns Order Object Order

Schemas/Object Models

The following objects support the Storefront API endpoints listed above.

Address

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "phone": "string",
  "email": "user@example.com",
  "region": "string",
  "country": "string",
  "postalCode": "string",
  "street1": "string",
  "street2": "string",
  "customFields": [
    {
      "fieldId": "string",
      "fieldValue": "string"
    }
  ]
}

Properties

Name Type Required Description
id string true ID for this address.
firstName string false Addressee’s first name.
lastName string false Addressee’s last name.
phone string(E.164) false Telephone number, as a string in E.164 format.
email string(email) false This is required for some payment gateways, e.g., CyberSource.
region string false Region (above the country level).
country string true The country.
postalCode string false Postal or ZIP code.
street1 string false Street address (first line).
street2 string false Street address (second line).
customFields [object] false Object containing one or more custom fields.
– fieldId string false ID for this custom field.
– fieldValue string false This can also be an array, for fields that need to support a list of values (e.g., a set of check boxes.)

AppliedCoupon

{
  "id": "string",
  "code": "string",
  "name": "string",
  "slug": "string",
  "couponType": "string",
  "discountedAmount": 0
}

Properties

Name Type Required Description
id string false The coupon ID.
code string true The coupon code.
name string false The coupon name, as specified by the merchant.
~~slug~~ ~~string~~ ~~false~~ ~~Automatically-generated description for the discount.~~
couponType string false Key name to identify the type of coupon.
discountedAmount number (float) false The discounted amount applied within a given context.

AppliedDiscount

{
  "id": 0,
  "discountedAmount": 0
}

Properties

Name Type Required Description
id number false ID of the applied discount.
discountedAmount number (float) false The discounted amount applied within a given context.

BaseItem


{
  "id": "string",
  "variantId": 0,
  "productId": 0,
  "name": "string",
  "url": "http://example.com",
  "quantity": 0,
  "isTaxable": true,
  "imageUrl": "http://example.com",
  "discounts": [
    {
      "id": 0,
      "discountedAmount": 0
    }
  ],
  "discountAmount": 0,
  "couponAmount": 0,
  "listPrice": 0,
  "salePrice": 0,
  "extendedListPrice": 0,
  "extendedSalePrice": 0
}

Properties

Name Type Required Description
id string false The line-item ID.
name string false The item’s product name.
description string false The item’s product description, which can include HTML.
url string(uri) false The product URL.
quantity number true Quantity of this item.
isTaxable boolean false Whether the item is taxable.
imageUrl string(uri) false URL of an image of this item, accessible on the internet.
baseAmount number false Price, from the variant level – after price adjustment rules, but before discounts or coupons.
discountAmount number (float) false The total value of all discounts applied to this item.
couponAmount number (float) false The sum of all coupons applied to this item.
listPrice number (float) false Item’s list price, as quoted by the manufacturer/distributor.
salePrice number (float) false Item’s price after all discounts are applied. (The final price before tax calculation.)
extendedListPrice number (float) false Item’s list price multiplied by the quantity.
extendedSalePrice number (float) false Item’s sale price multiplied by the quantity.
coupons AppliedCoupon array false Array of AppliedCoupon objects.
discounts AppliedDiscount array false List of discounts applied to this line item, as an array of AppliedDiscount objects.

Cart

{
  "id": "string",
  "currency": {
    "name": "string",
    "code": "string",
    "symbol": "string"
  },
  "isTaxIncluded": true,
  "baseAmount": 0,
  "discountAmount": 0,
  "taxAmount": 0,
  "cartAmount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "lineItems": [
    {
      "physicalItems": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "baseAmount": 0,
          "discountAmount": 0,
          "couponAmount": 0,
          "finalAmount": 0,
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "couponType": "string",
              "discountedAmount": 0
            }
          ],
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "itemTaxTotal": 0,
          "itemTotal": 0,
          "variant": {
            "id": 0,
            "productId": 0,
            "price": 0,
            "salePrice": 0,
            "listPrice": 0,
            "skuId": 0,
            "sku": "string",
            "options": [
              {
                "id": 0,
                "name": "string",
                "valueId": 0,
                "valueLabel": "string"
              }
            ]
          },
          "modifiers": [
            [
              {
                "id": 0,
                "name": "string",
                "valueId": 0,
                "valueLabel": "string",
                "shopperInput": "string"
              }
            ]
          ],
          "isShippingRequired": true,
          "giftWrapping": {
            "name": "string",
            "message": "string",
            "amount": 0
          }
        }
      ],
      "digitalItems": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "baseAmount": 0,
          "discountAmount": 0,
          "couponAmount": 0,
          "finalAmount": 0,
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "couponType": "string",
              "discountedAmount": 0
            }
          ],
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "itemTaxTotal": 0,
          "itemTotal": 0,
          "downloadFileUrls": [
            "string"
          ],
          "downloadPageUrl": "string",
          "downloadSize": "string"
        }
      ],
      "giftCertificate": [
        {
          "id": "string",
          "theme": "string",
          "amount": 0,
          "isTaxable": true,
          "sender": {
            "name": "string",
            "email": "user@example.com"
          },
          "recipient": {
            "name": "string",
            "email": "user@example.com"
          },
          "message": "string"
        }
      ]
    }
  ],
  "createdTime": "string",
  "updatedTime": "string",
  "links": [
    {
      "rel": "string",
      "href": "string"
    }
  ]
}

Properties

Name Type Required Description
id string(UUID) false Cart ID, provided after creating a cart with a POST.
currency Currency false This will always be the same between cart and checkout.
baseAmount number false Cost of cart’s contents, before applying discounts.
discountAmount number (float) false Discounted amount.
taxAmount number false Tax amount – might apply only where there is a shipping address to identify the zone and country.
cartAmount number false Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).
createdTime string(ISO-8601) false Time when the cart was created.
updatedTime string(ISO-8601) false Time when the cart was last updated.
coupons AppliedCoupon array false Array of AppliedCoupon objects.
discounts AppliedDiscount array false Array of AppliedDiscount objects.
lineItems LineItem array false Array of LineItem objects.
links Link array false List of relevant links, as BigCommerce Link objects.

CartUpdateRequest

{
  "lineItem": {
    "quantity": 0,
    "productId": 0,
    "variantId": 0
  },
  "giftCertificate": {
    "theme": "string",
    "amount": 1,
    "sender": {
      "name": "string",
      "email": "user@example.com"
    },
    "recipient": {
      "name": "string",
      "email": "user@example.com"
    },
    "message": "string",
    "quantity": 0
  }
}

Properties

Name Type Required Description
lineItem [LineItemRequestData] false A BigCommerce LineItemRequestData object.
giftCertificate [LineItemGiftCertificateRequestData] false A BigCommerce LineItemGiftCertificateRequestData object.

Checkout

{
  "id": "string",
  "cart": {
    "id": "string",
    "currency": {
      "name": "string",
      "code": "string",
      "symbol": "string"
    },
    "isTaxIncluded": true,
    "baseAmount": 0,
    "discountAmount": 0,
    "taxAmount": 0,
    "cartAmount": 0,
    "coupons": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "slug": "string",
        "couponType": "string",
        "discountedAmount": 0
      }
    ],
    "discounts": [
      {
        "name": "string",
        "discountedAmount": 0
      }
    ],
    "lineItems": [
      {
        "physicalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "variant": {
              "id": 0,
              "productId": 0,
              "price": 0,
              "salePrice": 0,
              "listPrice": 0,
              "skuId": 0,
              "sku": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string"
                }
              ]
            },
            "modifiers": [
              [
                {
                  "id": 0,
                  "name": "string",
                  "valueId": 0,
                  "valueLabel": "string",
                  "shopperInput": "string"
                }
              ]
            ],
            "isShippingRequired": true,
            "giftWrapping": {
              "name": "string",
              "message": "string",
              "amount": 0
            }
          }
        ],
        "digitalItems": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "url": "http://example.com",
            "quantity": 0,
            "isTaxable": true,
            "imageUrl": "http://example.com",
            "baseAmount": 0,
            "discountAmount": 0,
            "couponAmount": 0,
            "finalAmount": 0,
            "coupons": [
              {
                "id": "string",
                "code": "string",
                "name": "string",
                "slug": "string",
                "couponType": "string",
                "discountedAmount": 0
              }
            ],
            "discounts": [
              {
                "name": "string",
                "discountedAmount": 0
              }
            ],
            "itemTaxTotal": 0,
            "itemTotal": 0,
            "downloadFileUrls": [
              "string"
            ],
            "downloadPageUrl": "string",
            "downloadSize": "string"
          }
        ],
        "giftCertificate": [
          {
            "id": "string",
            "theme": "string",
            "amount": 0,
            "isTaxable": true,
            "sender": {
              "name": "string",
              "email": "user@example.com"
            },
            "recipient": {
              "name": "string",
              "email": "user@example.com"
            },
            "message": "string"
          }
        ]
      }
    ],
    "createdTime": "string",
    "updatedTime": "string",
    "links": [
      {
        "rel": "string",
        "href": "string"
      }
    ]
  },
  "shopper": {
    "customerId": "string",
    "customerGroupId": "string",
    "storeCredit": "string"
  },
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "shippingAddresses": [
    {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "user@example.com",
      "region": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string",
      "street2": "string",
      "customFields": [
        {
          "fieldId": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "consignments": [
    {
      "id": "string",
      "shippingAddressId": "string",
      "shippingMethodId": "string",
      "shippingCost": 0,
      "lineItemIds": [
        0
      ]
    }
  ],
  "taxes": [
    {
      "itemId": "string",
      "name": "string",
      "amount": 0,
      "percentage": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "orderId": "string",
  "shippingCostTotal": 0,
  "taxTotal": 0,
  "grandTotal": 0,
  "storeCredit": 0,
  "giftCertificates": [
    {
      "balance": 0,
      "code": "string",
      "purchaseDate": "2017-09-27"
    }
  ],
  "balanceDue": 0,
  "createdTime": "string",
  "updatedTime": "string"
}

Properties

Name Type Required Description
id string(UUID) false ID of this checkout.
cart [Cart] false A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data.
shopper Shopper false A BigCommerce Shopper object represents either an existing customer, or someone checking out as a guest.
billingAddress [Address] false A BigCommerce Address object, representing the billing address.
orderId string false ID for this order.
shippingCostTotal number false Shipping cost before any discounts are applied.
taxTotal number false Total tax applicable to this order.
grandTotal number false The total payable amount, before applying any store credit or gift certificate.
storeCredit number false Applied store credit.
balanceDue number false The total payable amount due, after applying any store credit or gift certificate.
createdTime string(ISO-8601) false Time when the cart was created.
updatedTime string(ISO-8601) false Time when the cart was last updated.
consignments Consignment array false Array of Consignment objects. 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.
taxes Tax array false Array of Tax objects.
giftCertificates GiftCertificate array false Array of GiftCertificate objects.

CheckoutError

{
  "errors": [
    {
      "status": 0,
      "title": "string",
      "type": "string",
      "detail": "string"
    }
  ]
}

Properties

Name Type Required Description
errors ErrorInner array false Array of ErrorInner objects.

Consignment

{
  "id": "string",
  "shippingAddressId": "string",
  "shippingMethodId": "string",
  "shippingCost": 0,
  "lineItemIds": [
    0
  ]
}

Properties

Name Type Required Description
id string false ID of this consignment
shippingAddressId string false One of the shipping addresses included in the checkout.
shippingMethodId string false The ID of the selected shipping method/option for a given consignment.
shippingCost integer false The cost of shipping for this consignment.
lineItemIds integer array false Array of LineItem IDs.

ContactEntity

{
  "name": "string",
  "email": "user@example.com"
}

Properties

Name Type Required Description
name string false Contact’s name.
email string(email) false Contact’s email address.

CouponCodeRequest

{
  "couponCode": "string"
}

Properties

Name Type Required Description
couponCode string false The coupon code.

CreditCardExpiryDate

{
  "month": 0,
  "year": 0
}

Properties

Name Type Required Description
month number(string) true Month in which the credit card expires.
year number(string) true Year in which the credit card expires.

Currency

{
  "name": "string",
  "code": "string",
  "symbol": "string"
}

Properties

Name Type Required Description
name string false The currency name.
code string false ISO-4217 currency code. (See: http://en.wikipedia.org/wiki/ISO_4217.)
symbol string false The currency symbol.

ErrorInner

{
  "status": 0,
  "title": "string",
  "type": "string",
  "detail": "string"
}

Properties

Name Type Required Description
status integer false The HTTP status code.
title string false The error title describing the particular error.
type string false The type of error.
detail string false Detailed error description.

GiftCertificate

{
  "balance": 0,
  "code": "string",
  "purchaseDate": "2017-09-27"
}

Properties

Name Type Required Description
balance number false Balance on the gift certificate.
code string false Gift-certificate code.
purchaseDate string(date) false Date on which the gift certificate was purchased.

GiftCertificateRequest

{
  "giftCertificateCode": "string"
}

Properties

Name Type Required Description
giftCertificateCode string false The gift-certificate code.

GiftWrapping

{
  "name": "string",
  "amount": 0
}

Properties

Name Type Required Description
name string false Name of the gift-wrapping option.
~~message~~ ~~string~~ ~~false~~ ~~Message to accompany the gift-wrapping option.~~
amount number (float) false Gift-wrapping price per product.

ItemDigital

{
  "id": "string",
  "name": "string",
  "description": "string",
  "url": "http://example.com",
  "quantity": 0,
  "isTaxable": true,
  "imageUrl": "http://example.com",
  "baseAmount": 0,
  "discountAmount": 0,
  "couponAmount": 0,
  "finalAmount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "itemTaxTotal": 0,
  "itemTotal": 0,
  "downloadFileUrls": [
    "string"
  ],
  "downloadPageUrl": "string",
  "downloadSize": "string"
}

Properties

Name Type Required Description
id string false The line-item ID.
name string false The item’s product name.
description string false The item’s product description, which can include HTML.Total amount for this item, including tax.
url string(uri) false The product URL.
quantity number true Quantity of this item.
isTaxable boolean false Whether this item is taxable.
imageUrl string(uri) false URL of an image of this item, accessible on the internet.
baseAmount number false Price, from the variant level – after price adjustment rules, but before discounts or coupons.
discountAmount number (float) false The total value of all discounts applied to this item.
couponAmount number (float) false The sum of all coupons applied to this item.
finalAmount number false Final cost of this item after discounts and coupons, excluding tax.
itemTaxTotal number false The total tax amount applied to this item.
itemTotal number false Total amount for this item, including tax.
downloadPageUrl string(url) false The URL for the combined downloads page.
downloadSize string false Combined download size, in human-readable style. E.g.: 30MB.
coupons AppliedCoupon array false Array of AppliedCoupon objects.

ItemGiftCertificate

{
  "id": "string",
  "theme": "string",
  "amount": 0,
  "isTaxable": true,
  "sender": {
    "name": "string",
    "email": "user@example.com"
  },
  "recipient": {
    "name": "string",
    "email": "user@example.com"
  },
  "message": "string"
}

Properties

Name Type Required Description
id string false ID of this gift certificate.
name string false GiftCertificate-provided name that will appear in the control panel.
theme string true Currently supports Birthday, Boy, Celebration, Christmas, General, and Girl.
amount number true Value must be between $1.00 and $1,000.00.
isTaxable boolean false Whether or not the gift certificate is taxable.
sender ContactEntity true A BigCommerce ContactEntity object, representing the gift certificate’s sender.
recipient ContactEntity true A BigCommerce ContactEntity object, representing the gift certificate’s recipient. BigCommerce ContactEntity object.
message string false Message that will be sent to the gift certificate’s recipient. Limited to 200 characters.

ItemPhysical

{
  "id": "string",
  "variantId": 0,
  "productId": 0,
  "name": "string",
  "url": "http://example.com",
  "quantity": 0,
  "isTaxable": true,
  "imageUrl": "http://example.com",
  "discounts": [
    {
      "id": 0,
      "discountedAmount": 0
    }
  ],
  "discountAmount": 0,
  "couponAmount": 0,
  "listPrice": 0,
  "salePrice": 0,
  "extendedListPrice": 0,
  "extendedSalePrice": 0,
  "isShippingRequired": true,
  "giftWrapping": {
    "name": "string",
    "amount": 0
  }
} 

Properties

Name Type Required Description
id string false The line-item ID.
variantId number false No description
productId number false No description
name string false The item’s product name.
~~description~~ ~~string~~ ~~false~~ ~~The item’s product description, which can include HTML.~~
url string(uri) false The product URL.
quantity number true Quantity of this item.
isTaxable boolean false Whether this item is taxable.
imageUrl string(uri) false URL of an image of this item, accessible on the internet.
baseAmount number false Price, from the variant level – after price adjustment rules, but before discounts or coupons.
discountAmount number (float) false The total value of all discounts applied to this item.
couponAmount number (float) false The total value of all coupons applied to this item.
listPrice number false Item’s list price, as quoted by the manufacturer/distributor.
salePrice number false Item’s price after all discounts are applied. (The final price before tax calculation.)
extendedListPrice number false Item’s list price multiplied by the quantity.
extendedSalePrice number false Item’s sale price multiplied by the quantity.
~~finalAmount~~ ~~number~~ ~~false~~ ~~Final cost of this item after discounts and coupons, excluding tax.~~
~~itemTaxTotal~~ ~~number~~ ~~false~~ ~~The total tax amount applied to this item.~~
~~itemTotal~~ ~~number~~ ~~false~~ ~~Total amount for this item, including tax.~~
~~variant~~ ~~ItemVariant~~ ~~false~~ ~~A BigCommerce ItemVariant object.~~
isShippingRequired boolean false Whether this item requires shipping to a physical address.
giftWrapping GiftWrapping false A BigCommerce GiftWrapping object.
~~coupons~~ ~~AppliedCoupon array~~ ~~false~~ ~~Array of AppliedCoupon objects.~~
discounts AppliedDiscount array false Array of AppliedDiscount objects.

ItemVariant

{
  "id": 0,
  "productId": 0,
  "price": 0,
  "salePrice": 0,
  "listPrice": 0,
  "skuId": 0,
  "sku": "string",
  "options": [
    {
      "id": 0,
      "name": "string",
      "valueId": 0,
      "valueLabel": "string"
    }
  ]
}

Properties

Name Type Required Description
id integer true The variant ID.
productId integer false The product ID.
price number false The variant’s price.
salePrice number (float) false Discounted price for the variant; typically applies temporarily.
listPrice number (float) false The variant’s list price, also known as MSRP (manufacturer’s suggested retail price).
skuId number false The legacy SKU ID.
sku string false User-defined product code/stock keeping unit (SKU).
options [object] false Object containing options for this variant.
– id integer false Option’s ID.
– name string false Option’s name.
– valueId integer false Option value’s ID.
– valueLabel string false Option value’s label.

LineItem

{
  "physicalItems": [
    {
      "id": "string",
      "variantId": 0,
      "productId": 0,
      "name": "string",
      "url": "http://example.com",
      "quantity": 0,
      "isTaxable": true,
      "imageUrl": "http://example.com",
      "discounts": [
        {
          "id": 0,
          "discountedAmount": 0
        }
      ],
      "discountAmount": 0,
      "couponAmount": 0,
      "listPrice": 0,
      "salePrice": 0,
      "extendedListPrice": 0,
      "extendedSalePrice": 0,
      "isShippingRequired": true,
      "giftWrapping": {
        "name": "string",
        "amount": 0
      }
    }
  ],
  "digitalItems": [
    {
      "id": "string",
      "variantId": 0,
      "productId": 0,
      "name": "string",
      "url": "http://example.com",
      "quantity": 0,
      "isTaxable": true,
      "imageUrl": "http://example.com",
      "discounts": [
        {
          "id": 0,
          "discountedAmount": 0
        }
      ],
      "discountAmount": 0,
      "couponAmount": 0,
      "listPrice": 0,
      "salePrice": 0,
      "extendedListPrice": 0,
      "extendedSalePrice": 0
    }
  ],
  "giftCertificates": [
    {
      "id": "string",
      "name": "string",
      "theme": "string",
      "amount": 0,
      "isTaxable": true,
      "sender": {
        "name": "string",
        "email": "user@example.com"
      },
      "recipient": {
        "name": "string",
        "email": "user@example.com"
      },
      "message": "string"
    }
  ]
} 

Properties

Name Type Required Description
physicalItems ItemPhysical array true Array of ItemPhysical objects.
digitalItems ItemDigital array true Array of ItemDigital objects.
giftCertificates ItemGiftCertificate array true Array of ItemGiftCertificate objects.

LineItemGiftCertificateRequestData

{
  "theme": "string",
  "amount": 1,
  "sender": {
    "name": "string",
    "email": "user@example.com"
  },
  "recipient": {
    "name": "string",
    "email": "user@example.com"
  },
  "message": "string",
  "quantity": 0
}

Properties

Name Type Required Description
name string false Name assigned to this gift-certificate line item.
theme string true Currently supports Birthday, Boy, Celebration, Christmas, General, and Girl.
amount number true Gift-certificate amount.
sender ContactEntity true A BigCommerce ContactEntity object, representing the gift certificate’s sender/purchaser.
recipient ContactEntity true A BigCommerce ContactEntity object, representing the gift certificate’s recipient.
message string false Message shown to recipient, as provided by sender.
quantity number true Quantity of this item.

LineItemModifiers

[
  {
    "id": 0,
    "name": "string",
    "valueId": 0,
    "valueLabel": "string",
    "shopperInput": "string"
  }
]

Properties

Name Type Required Description
anonymous [object] false Array of modifier objects.
– id integer false Modifier’s ID.
– name string false Modifier’s name.
– valueId integer false Modifier value’s ID.
– valueLabel string false Modifier value’s label.
– shopperInput string false Shopper-supplied text. E.g., text the shopper wants printed on a T-shirt they are ordering.

LineItemRequestData

{
  "quantity": 0,
  "productId": 0,
  "variantId": 0
}

Properties

Name Type Required Description
quantity number false Quantity of this item.
productId number false ID of the product.
variantId number false ID of the variant.
listPrice number (float) false The product’s list price, also known as MSRP (manufacturer’s suggested retail price).

LineItemsRequest

{
  "lineItems": [
    {
      "quantity": 0,
      "productId": 0,
      "variantId": 0
    }
  ],
  "giftCertificates": [
    {
      "theme": "string",
      "amount": 1,
      "sender": {
        "name": "string",
        "email": "user@example.com"
      },
      "recipient": {
        "name": "string",
        "email": "user@example.com"
      },
      "message": "string",
      "quantity": 0
    }
  ]
}

Properties

Name Type Required Description
lineItems LineItemRequestData array false Array of LineItemRequestData objects.
giftCertificates LineItemGiftCertificateRequestData array false Array of LineItemGiftCertificateRequestData objects.

{
  "rel": "string",
  "href": "string"
}

Properties

Name Type Required Description
rel string false The relevant resource name, or self.
href string(url) false The URL.

Meta

{
  "geoCountryCode": "string",
  "sessionHash": "string",
  "deviceSessionId": "string"
}

Properties

Name Type Required Description
geoCountryCode string false Shopper’s country code, derived from the request IP.
sessionHash string false Hash of the Session ID associated with the current user and session. To be sent to payment gateways, to detect fraud activity.
deviceSessionId string false Unique ID assigned by the payment provider for the current shopper. This should be used along with the Payment Nonce, to authenticate that the transaction belongs to the same shopper who requested the nonce.

Order

{
  "id": "string",
  "currency": {
    "name": "string",
    "code": "string",
    "symbol": "string"
  },
  "isTaxIncluded": true,
  "baseAmount": 0,
  "discountAmount": 0,
  "taxAmount": 0,
  "cartAmount": 0,
  "coupons": [
    {
      "id": "string",
      "code": "string",
      "name": "string",
      "slug": "string",
      "couponType": "string",
      "discountedAmount": 0
    }
  ],
  "discounts": [
    {
      "name": "string",
      "discountedAmount": 0
    }
  ],
  "lineItems": [
    {
      "physicalItems": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "baseAmount": 0,
          "discountAmount": 0,
          "couponAmount": 0,
          "finalAmount": 0,
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "couponType": "string",
              "discountedAmount": 0
            }
          ],
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "itemTaxTotal": 0,
          "itemTotal": 0,
          "variant": {
            "id": 0,
            "productId": 0,
            "price": 0,
            "salePrice": 0,
            "listPrice": 0,
            "skuId": 0,
            "sku": "string",
            "options": [
              {
                "id": 0,
                "name": "string",
                "valueId": 0,
                "valueLabel": "string"
              }
            ]
          },
          "modifiers": [
            [
              {
                "id": 0,
                "name": "string",
                "valueId": 0,
                "valueLabel": "string",
                "shopperInput": "string"
              }
            ]
          ],
          "isShippingRequired": true,
          "giftWrapping": {
            "name": "string",
            "message": "string",
            "amount": 0
          }
        }
      ],
      "digitalItems": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "url": "http://example.com",
          "quantity": 0,
          "isTaxable": true,
          "imageUrl": "http://example.com",
          "baseAmount": 0,
          "discountAmount": 0,
          "couponAmount": 0,
          "finalAmount": 0,
          "coupons": [
            {
              "id": "string",
              "code": "string",
              "name": "string",
              "slug": "string",
              "couponType": "string",
              "discountedAmount": 0
            }
          ],
          "discounts": [
            {
              "name": "string",
              "discountedAmount": 0
            }
          ],
          "itemTaxTotal": 0,
          "itemTotal": 0,
          "downloadFileUrls": [
            "string"
          ],
          "downloadPageUrl": "string",
          "downloadSize": "string"
        }
      ],
      "giftCertificate": [
        {
          "id": "string",
          "theme": "string",
          "amount": 0,
          "isTaxable": true,
          "sender": {
            "name": "string",
            "email": "user@example.com"
          },
          "recipient": {
            "name": "string",
            "email": "user@example.com"
          },
          "message": "string"
        }
      ]
    }
  ],
  "createdTime": "string",
  "updatedTime": "string",
  "links": [
    {
      "rel": "string",
      "href": "string"
    }
  ],
  "orderId": 0,
  "customerId": "string",
  "token": "string",
  "billingAddress": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com",
    "region": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string",
    "street2": "string",
    "customFields": [
      {
        "fieldId": "string",
        "fieldValue": "string"
      }
    ]
  },
  "payment": {
    "id": "string",
    "redirectUrl": "string",
    "returnUrl": "string",
    "status": "PAYMENT_STATUS_INITIALIZE",
    "helpText": "string"
  },
  "socialData": [
    {
      "name": "string",
      "description": "string",
      "image": "string",
      "url": "string",
      "shareText": "string",
      "sharingLink": "string"
    }
  ],
  "status": "ORDER_STATUS_INCOMPLETE",
  "customerCreated": true,
  "hasDigitalItems": true,
  "isDownloadable": true,
  "isComplete": true,
  "callbackUrl": "string"
}

Properties

Name Type Required Description
id string(UUID) false Cart ID, provided after creating a cart with a POST.
currency Currency false This will always be the same between cart and checkout.
isTaxIncluded boolean false Boolean representing whether price includes tax.
baseAmount number false Cost of cart’s contents, before applying discounts.
discountAmount number (float) false Discounted amount.
taxAmount number false Tax amount – might apply only where there is a shipping address to identify the zone and country.
cartAmount number false Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).
createdTime string(ISO-8601) false Time when the cart was created.
updatedTime string(ISO-8601) false Time when the cart was last updated.
orderId number false ID of the order.
customerId string false ID of the customer.
token string false Payment token.
billingAddress [Address] false A BigCommerce Address object.
payment OrderPayment false A BigCommerce OrderPayment object.
status string false Order status.
customerCreated boolean false For guest checkouts, this flag will identify whether a new customer account was created for this order, or whether the billing email already existed on the store.
hasDigitalItems boolean false Specifies whether this order has at least one digital item.
isDownloadable boolean false Specifies whether this order is fully paid, so that digital items can be downloaded.
isComplete boolean false Specifies whether this order is complete and ready to be taken to the order confirmation page.
callbackUrl string(URL) false The URL that the payments service should call after the payment is complete.
coupons AppliedCoupon array false Array of AppliedCoupon objects.
discounts AppliedDiscount array false Array of AppliedDiscount objects.
lineItems LineItem array false Array of LineItem objects.
socialData [object] false A BigCommerce SocialData object.
Enumerated Values
Property Value
status PAYMENT_STATUS_INITIALIZE
status PAYMENT_STATUS_ACKNOWLEDGE
status PAYMENT_STATUS_FINALIZE
status ORDER_STATUS_INCOMPLETE
status ORDER_STATUS_PENDING
status ORDER_STATUS_SHIPPED
status ORDER_STATUS_PARTIALLY_SHIPPED
status ORDER_STATUS_REFUNDED
status ORDER_STATUS_CANCELLED
status ORDER_STATUS_DECLINED
status ORDER_STATUS_AWAITING_PAYMENT
status ORDER_STATUS_AWAITING_PICKUP
status ORDER_STATUS_AWAITING_SHIPMENT
status ORDER_STATUS_COMPLETED
status ORDER_STATUS_AWAITING_FULFILLMENT
status ORDER_STATUS_HELD_REVIEW
status ORDER_STATUS_DISPUTED

OrderPayment

{
  "id": "string",
  "redirectUrl": "string",
  "returnUrl": "string",
  "status": "PAYMENT_STATUS_INITIALIZE",
  "helpText": "string"
}

Properties

Name Type Required Description
id string false The name of the payment module in the BC app.
redirectUrl string false The URL used to redirect to the hosted payment provider’s website.
returnUrl string false The URL used to return from the hosted payment provider’s website.
status string false Possible statuses that the hosted payment can have.
helpText string false Any message that must be shown to the user on the confirmation page for offline payments.
Enumerated Values
Property Value
status PAYMENT_STATUS_INITIALIZE
status PAYMENT_STATUS_ACKNOWLEDGE
status PAYMENT_STATUS_FINALIZE

PaymentMethod

{
  "id": "string",
  "logoUrl": "string",
  "method": "string",
  "supportedCards": [
    "string"
  ],
  "type": "PAYMENT_TYPE_OFFLINE",
  "nonce": "string",
  "clientToken": "string"
}

Properties

Name Type Required Description
id string true Name of the payment module in the BC app.
logoUrl string false URL of this payment provider’s logo.
type string false The type of payment provider. This should be used to determine whether payment should be made via BigPay or BC App.
nonce string false Payment Nonce obtained from the payment provider (e.g., PayPal) after the shopper submits credit-card details in the payment provider’s site. Used to complete the payment with BigPay.
clientToken string false Client token that a payment provider can use to initialize their JavaScript library. (Used, for example, for Braintree.js.)
Enumerated Values
Property Value
type PAYMENT_TYPE_OFFLINE
type PAYMENT_TYPE_HOSTED
type PAYMENT_TYPE_API

PaymentMethodConfig

{
  "merchantId": "string"
}

Properties

Name Type Required Description
merchantId string false This is required for PayPalExpress in context.

RequestOrderData

{
  "customerMessage": "string",
  "payment": {
    "name": "string"
  }
}

Properties

Name Type Required Description
customerMessage string false An optional message the customer can associate with this order.
payment object false Payment details that payment providers require in order to finalize the payment.
– name string true Name of the payment provider.

ResponseOrderData

{
  "meta": {},
  "data": {
    "order": {
      "id": "string",
      "currency": {
        "name": "string",
        "code": "string",
        "symbol": "string"
      },
      "isTaxIncluded": true,
      "baseAmount": 0,
      "discountAmount": 0,
      "taxAmount": 0,
      "cartAmount": 0,
      "coupons": [
        {
          "id": "string",
          "code": "string",
          "name": "string",
          "slug": "string",
          "couponType": "string",
          "discountedAmount": 0
        }
      ],
      "discounts": [
        {
          "name": "string",
          "discountedAmount": 0
        }
      ],
      "lineItems": [
        {
          "physicalItems": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "baseAmount": 0,
              "discountAmount": 0,
              "couponAmount": 0,
              "finalAmount": 0,
              "coupons": [
                {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "slug": "string",
                  "couponType": "string",
                  "discountedAmount": 0
                }
              ],
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "itemTaxTotal": 0,
              "itemTotal": 0,
              "variant": {
                "id": 0,
                "productId": 0,
                "price": 0,
                "salePrice": 0,
                "listPrice": 0,
                "skuId": 0,
                "sku": "string",
                "options": [
                  {
                    "id": 0,
                    "name": "string",
                    "valueId": 0,
                    "valueLabel": "string"
                  }
                ]
              },
              "modifiers": [
                [
                  {
                    "id": 0,
                    "name": "string",
                    "valueId": 0,
                    "valueLabel": "string",
                    "shopperInput": "string"
                  }
                ]
              ],
              "isShippingRequired": true,
              "giftWrapping": {
                "name": "string",
                "message": "string",
                "amount": 0
              }
            }
          ],
          "digitalItems": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "url": "http://example.com",
              "quantity": 0,
              "isTaxable": true,
              "imageUrl": "http://example.com",
              "baseAmount": 0,
              "discountAmount": 0,
              "couponAmount": 0,
              "finalAmount": 0,
              "coupons": [
                {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "slug": "string",
                  "couponType": "string",
                  "discountedAmount": 0
                }
              ],
              "discounts": [
                {
                  "name": "string",
                  "discountedAmount": 0
                }
              ],
              "itemTaxTotal": 0,
              "itemTotal": 0,
              "downloadFileUrls": [
                "string"
              ],
              "downloadPageUrl": "string",
              "downloadSize": "string"
            }
          ],
          "giftCertificate": [
            {
              "id": "string",
              "theme": "string",
              "amount": 0,
              "isTaxable": true,
              "sender": {
                "name": "string",
                "email": "user@example.com"
              },
              "recipient": {
                "name": "string",
                "email": "user@example.com"
              },
              "message": "string"
            }
          ]
        }
      ],
      "createdTime": "string",
      "updatedTime": "string",
      "links": [
        {
          "rel": "string",
          "href": "string"
        }
      ],
      "orderId": 0,
      "customerId": "string",
      "token": "string",
      "billingAddress": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "email": "user@example.com",
        "region": "string",
        "country": "string",
        "postalCode": "string",
        "street1": "string",
        "street2": "string",
        "customFields": [
          {
            "fieldId": "string",
            "fieldValue": "string"
          }
        ]
      },
      "payment": {
        "id": "string",
        "redirectUrl": "string",
        "returnUrl": "string",
        "status": "PAYMENT_STATUS_INITIALIZE",
        "helpText": "string"
      },
      "socialData": [
        {
          "name": "string",
          "description": "string",
          "image": "string",
          "url": "string",
          "shareText": "string",
          "sharingLink": "string"
        }
      ],
      "status": "ORDER_STATUS_INCOMPLETE",
      "customerCreated": true,
      "hasDigitalItems": true,
      "isDownloadable": true,
      "isComplete": true,
      "callbackUrl": "string"
    }
  }
}

Properties

Name Type Required Description
meta object false Response data container.
data object false Response data container for Order endpoints (POST /orders and POST /orders/{orderId}).
– order [Order] false A BigCommerce Order object.
Enumerated Values
Property Value
status PAYMENT_STATUS_INITIALIZE
status PAYMENT_STATUS_ACKNOWLEDGE
status PAYMENT_STATUS_FINALIZE
status ORDER_STATUS_INCOMPLETE
status ORDER_STATUS_PENDING
status ORDER_STATUS_SHIPPED
status ORDER_STATUS_PARTIALLY_SHIPPED
status ORDER_STATUS_REFUNDED
status ORDER_STATUS_CANCELLED
status ORDER_STATUS_DECLINED
status ORDER_STATUS_AWAITING_PAYMENT
status ORDER_STATUS_AWAITING_PICKUP
status ORDER_STATUS_AWAITING_SHIPMENT
status ORDER_STATUS_COMPLETED
status ORDER_STATUS_AWAITING_FULFILLMENT
status ORDER_STATUS_HELD_REVIEW
status ORDER_STATUS_DISPUTED

ResponsePaymentsData

{
  "meta": {},
  "data": {
    "paymentMethods": [
      {
        "id": "string",
        "logoUrl": "string",
        "method": "string",
        "supportedCards": [
          "string"
        ],
        "type": "PAYMENT_TYPE_OFFLINE",
        "nonce": "string",
        "clientToken": "string"
      }
    ]
  }
}

Properties

Name Type Required Description
meta object false Response data container.
data object false Response data container for existing payment-providers endpoint (GET /payments).
– paymentMethods PaymentMethod array false Array of PaymentMethod objects.
Enumerated Values
Property Value
type PAYMENT_TYPE_OFFLINE
type PAYMENT_TYPE_HOSTED
type PAYMENT_TYPE_API

ResponseShippingOptions

{
  "meta": {
    "geoCountryCode": "string",
    "sessionHash": "string",
    "deviceSessionId": "string"
  },
  "data": {
    "shippingOptions": {
      "addressId": [
        {
          "description": "string",
          "formattedPrice": 0,
          "id": "string",
          "imageUrl": "string",
          "price": 0,
          "selected": true,
          "transitTime": "string"
        }
      ]
    }
  }
}

Properties

Name Type Required Description
meta Meta false A BigCommerce Meta object.
data object false Response data container.
– shippingOptions object false A document with a combination of an Address ID and the collection of shipping options for that address.
– – addressId ShippingOptionEntity array false Array of ShippingOptionEntity objects.

ShippingOptionEntity

{
  "description": "string",
  "formattedPrice": 0,
  "id": "string",
  "imageUrl": "string",
  "price": 0,
  "selected": true,
  "transitTime": "string"
}

Properties

Name Type Required Description
description string false Description of this shipping option.
formattedPrice number(string) false Price of this shipping option, as a numeric string.
id string false ID of this shipping option.
imageUrl string false URL of an image of this option, accessible on the internet.
price number false Price of this shipping option, in numeric format.
selected boolean false Whether this shipping option is selected.
transitTime string false An estimate of the arrival time.

Shopper

{
  "customerId": "string",
  "customerGroupId": "string",
  "storeCredit": "string"
}

Properties

Name Type Required Description
customerId string false The customer’s ID.
customerGroupId string false The ID of the applicable customer group.
storeCredit string false Remaining balance of shopper’s store credit.

SocialData

[
  {
    "name": "string",
    "description": "string",
    "image": "string",
    "url": "string",
    "shareText": "string",
    "sharingLink": "string"
  }
]

Properties

Name Type Required Description
anonymous [object] false Response data container.
– name string false Name of the social network.
– description string false Description of this social network.
– image string false [Description to follow.]
– url string false URL to point to. Set by merchant in control panel. E.g., https://www.facebook.com/BigCommerce.
– shareText string false Text of call-to-action to share the order over this social network.
– sharingLink string false Link to share the order over this social network.

Tax

{
  "itemId": "string",
  "name": "string",
  "amount": 0,
  "percentage": 0
}

Properties

Name Type Required Description
itemId string false ID of this item.
name string false Name of the tax.
amount number false Tax amount.
percentage number false Tax percentage.