For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
      • Storefront
          • Authentication
          • Catalog
          • Company
          • Orders
            • GETList Orders
            • POSTCreate Order
            • GETList Order Images
            • GETList Order Products
            • GETGet Order Details
            • GETList Ordered Products
          • Request for Quote
          • Sales Rep
          • Shopping List
          • Store Settings
      • Management
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
On this page
  • Legacy Extra Fields
RESTB2BStorefront

Orders

Was this page helpful?
Previous

Delete User

Next

List Orders

Built with

The Orders Storefront REST and GraphQL APIs allow you to retrieve order details from Company accounts. By authenticating requests as a Company user, you can retrieve information on the orders visible in their Buyer Portal.

In order to return order information, you must generate a storefront authToken for a buyer with the following Company user permissions:

  • Get orders
  • Get order detail

The storefront experience of placing an order, for both B2B and B2C customers, relies on the BigCommerce checkout or use of the standard BigCommerce APIs. As a result, the B2B Orders API does not include endpoints for creating new orders or adding existing orders. Use the BigCommerce Orders V2 API to accomplish these tasks.

When specifying an order as a parameter of an endpoint, provide the BigCommerce order ID as the unique identifier. The B2B Edition Order ID, presented as the id value of certain B2B Orders API responses, is not a supported identifier for the bcOrderId field.

Legacy Extra Fields

The Get All Orders and Get Order Details endpoints include the following legacy Company extra fields used by older stores:

  • extraInt1
  • extraInt2
  • extraInt3
  • extraInt4
  • extraInt5
  • extraStr1
  • extraStr2
  • extraStr3
  • extraStr4
  • extraStr5
  • extraText

These fields return null values in newer stores. We recommend using the Get Company Extra Fields endpoint to retrieve Company extra field information.