B2B Edition
B2B Edition APIs
Server to Server Management APIs
Order

Order

Order information manage.

Get Orders

GET /orders

Request

Get all orders

Authentication

  • authToken in header

Parameters

  • companyId in query - integer
    Company ID field
  • limit in query with default of 10 - integer
    Pagination limit
    Example: 15
  • offset in query - integer
    Pagination offset
    Example: 5
  • orderBy in query with default of DESC - string
    Order by
    Example: ASC

    Allowed: DESC | ASC

  • sortBy in query with default of updatedAt - string
    The response sorted by which field
    Example: updatedAt

    Allowed: createdAt | updatedAt

  • minModified in query - number
    Minimum modified timestamp
  • maxModified in query - number
    Maximum modified timestamp
  • minCreated in query - number
    Minimum created timestamp
  • maxCreated in query - number
    Maximum created timestamp
  • showExtra in query - boolean
    Show extra field in response
  • bcOrderId in query - integer
    Unique order ID in BigCommerce store
    Example: 1
  • channelIds in query - array
    BigCommerce channel IDs
    Type: array[number]

example

Response

OK

Body

object | application/json

  • code    integer

  • meta    object

  • data    array[object]

without-extra-fields

with-extra-fields

Create an Order

POST /orders

Request

Create an order

Authentication

  • authToken in header

Body

object | application/json
Extra Field Values

  • bcOrderId    integer
    required

    Order ID in Bigcommerce

  • customerId    integer
    required

    Customer ID of order creator

  • poNumber    string

    PO payment method message.

  • extraFields    array[object]

example-1

Response

OK

Body

object | application/json
Successful created

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    object

    Order entity

example-1

Get an Order

GET /orders/{bcOrderId}

Request

Get an order detail info

Authentication

  • authToken in header

Parameters

  • bcOrderId in path - integer
    required
    Unique order ID in BigCommerce Store

example

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    object

    Order entity
    Example: {"extraFields":[{"fieldName":"string","fieldValue":"string"}]}

example-1

Update an Order

PUT /orders/{bcOrderId}

Request

Update an order. Update order's poNumnber and extraFields. You should send at least one field.

Authentication

  • authToken in header

Parameters

  • bcOrderId in path - integer
    required
    Unique order ID in BigCommerce Store

Body

object | application/json
Extra Field Values

  • bcOrderId    integer
    required

    Order ID in Bigcommerce

  • customerId    integer
    required

    Customer ID of order creator

  • poNumber    string

    PO payment method message.

  • extraFields    array[object]

example-1

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    object

    Order entity

example-1

Update Orders Company Attribute

PUT /customers/{customerId}/orders/company

Request

Update the orders belonging to a B3 company to another B3 company. Convert orders from the user's former BigCommerce group into the user's present BigCommerce group.

Authentication

  • authToken in header

Parameters

  • customerId in path - integer
    required
    BigCommerce customer ID.

Body

object | application/json

  • bcGroupId    integer
    required

    User's former group ID in Bigcommerce.

example

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    object

example-1

Get Order Products

GET /orders/{bcOrderId}/products

Request

Get order's product detail.

Authentication

  • authToken in header

Parameters

  • bcOrderId in path - integer
    required
    Unique order ID in BigCommerce Store

example

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    array[object]

example-1

Update Customer BigCommerce Orders

PUT /customers/{customerId}/orders/b2b

Request

Add Company identifier for BigCommerce Customer Individual Orders, which can be used to convert BigCommerce Customer Individual Orders to Company-level Orders.

Authentication

  • authToken in header

Parameters

  • customerId in path - integer
    required
    BigCommerce customer ID.

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    object

example-1

Get Order Extra Field Configs

GET /orders/extra-fields

Request

Get order extra field configs

Authentication

  • authToken in header

Parameters

  • offset in query - integer
    Pagination offset default: 0
  • limit in query with default of 10 - integer
    Pagination limit default: 10

example

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

    Used to response pagination information
    Example: {"pagination":{"limit":10,"offset":0,"totalCount":1}}

  • data    array[object]

example

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Delete a receipt lineGet Orders