Ecommerce API

Orders

Products

Customers

Stores

Create differentiated commerce experiences on the industry’s most versatile enterprise ecommerce solution. about BigCommerce.

BigCommerce

The date and time when the object was created.

Created at (timestamp)

When custom mappings are configured on the resource, the result is included here.

Product Description

Product Images

Inventory Quantity

The name of the product as it should be displayed to customers.

Product Name

Product Options

Product Price

Product SKU

The current status of the product (active or archived).

Product Status

The date and time when the object was last updated.

Updated at (timestamp)

Product Weight

The unit of measurement for the weight of the product.

Weight Unit

critical

Addresses

Company Name

Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).

Currency

UNKNOWN_CURRENCY

An array of email addresses for the customer.

Email Addresses

First Name

Last Name

Full Name

LinkedEcommerceOrder

An array of phone numbers for the customer.

Phone Numbers

Customer status

An object representing a shipping or billing address.

City

Country

Address line 1

Address line 2

Postal code

State

Ecommerce Address

Coupon discount

The ID of the customer this entity is linked to.

Customer ID

LinkedEcommerceCustomer

An object representing a discount applied to an ecommerce order or product.

Ecommerce Discount

Fulfillment status

A single line item of an ecommerce order, representing a product or variant with associated options, quantity, and pricing information.

Ecommerce Order Line Item

Note

Order number

Payment method

Payment status

Refunded amount

Ecommerce Order Refund

Shipping cost

Order Status

Sub-total amount

Total amount

Total discount

Total tax

Represents the tracking information associated with an ecommerce order.

Ecommerce Order Tracking Item

Store Admin URL

Store name

Store URL

The `line_items[].discounts[]` array includes every `applied_discounts[]` entry BigCommerce
returns for the line — both `target: "order"` (cart-level) and `target: "product"`
(product-specific) allocations are returned together, with no field that reliably
distinguishes the original discount source. This is the same class of behavior as the
documented Shopify `discountAllocations` limitation.


On the list endpoint, the product-level `options` array is not returned. BigCommerce caps results to 10 per
page whenever product `options` are requested, which would force slow multi-page fetches. To keep full-page
pagination (up to 200 per page), `options` are omitted from the list response. Each variant still includes its
concrete selections under `variants[].options`. To retrieve the full product-level `options` array, fetch the
product individually via the get-by-id endpoint.


BigCommerce

Details