B2B Edition
B2B Edition APIs
Storefront APIs
Orders

Order

Company based order management.

Get Orders

GET /orders

Request

Get orders. Equivalent Storefront GraphQL API Query: allOrders. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • beginDateAt in query - string
    Begin query date
  • endDateAt in query - string
    End query date
  • orderBy in query with default of createdAt - string
    Order by
  • sortBy in query with default of DESC - string
    Sort order by desc or asc
  • offset in query with default of 0 - string
    Pagination offset
  • limit in query with default of 10 - string
    Pagination limit
  • isShowMy in query with default of 0 - string
    Is show my orders
  • includeExtra in query with default of 0 - string
    Include extra field
  • q in query - string
    Query string
  • companyName in query - string
    Company name
  • orderNumber in query - string
    Order number
  • poNumber in query - string
    PO number
  • status[] in query - string
    Order status

example

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    object
    required

example-1

Create an Order

POST /orders

Request

Create an order in the BigCommerce store. Equivalent Storefront GraphQL API Mutation: createOrder. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Body

object | application/json

  • orderId    string
    required

    Unique order ID in BigCommerce store

  • poNumber    string

    PO number

  • isSaveOrderComment    string

    If save order comment

  • extraFields    array[object]

example

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    object
    required

example-1

Get Order Images

GET /orders/images

Request

Get order images. Equivalent Storefront GraphQL API Query: orderImages. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • orderIds[] in query - string
    Unique order ID

example

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    array[object]
    required

example-1

Get Order Products

GET /orders/{orderId}/products

Request

Get order products by orderId. Equivalent Storefront GraphQL API Query: orderProducts. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • orderId in path - string
    required
    Unique order ID in BigCommerce store

example

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    array[object]
    required

example-1

Get Order Detail

GET /orders/{orderId}/details

Request

Get order detail by orderId. Please refer to BigCommerce API for detailed parameter introduction. Equivalent Storefront GraphQL API Query: order. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • orderId in path - string
    required
    Unique order ID in BigCommerce store

example

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    object
    required

example-1

Get Ordered Product List

GET /ordered-products

Request

Get ordered products. Equivalent Storefront GraphQL API Query: orderedProducts. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • offset in query - string
    Pagination offset
  • limit in query - string
    Pagination limit
  • beginDateAt in query - string
    Begin date
  • endDateAt in query - string
    End date
  • minOrderedTimes in query - string
    Minimum ordered times
  • maxOrderedTimes in query - string
    Maximum ordered times
  • productID in query - string
    Product ID
  • q in query - string
    Query string

example

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    object
    required

example-1

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Delete a UserGet Orders