Get Company Orders | BigCommerce Developer Center

curl https://api-b2b.bigcommerce.com/api/v2/io/companies/companyId/orders \
     -H "authToken: <apiKey>"

{
  "code": 200,
  "data": {
    "list": [
      {
        "companyName": "fkkfcctest",
        "createdAt": "1572323610",
        "firstName": "james",
        "isInvoiceOrder": "0",
        "lastName": "liu",
        "orderId": "126",
        "totalIncTax": "100.0000",
        "updatedAt": "1572323610",
        "channelName": "test",
        "channelId": "1",
        "orderStatus": "Awaiting Payment"
      },
      {
        "companyName": "fkkfcctest",
        "createdAt": "1572323432",
        "firstName": "james",
        "isInvoiceOrder": "0",
        "lastName": "liu",
        "orderId": "124",
        "totalIncTax": "50.0000",
        "updatedAt": "1572323432",
        "channelName": "test",
        "channelId": "1",
        "orderStatus": "Awaiting Payment"
      },
      {
        "companyName": "fkkfcctest",
        "createdAt": "1572321777",
        "firstName": "james",
        "isInvoiceOrder": "0",
        "lastName": "liu",
        "orderId": "125",
        "totalIncTax": "50.0000",
        "updatedAt": "1572321777",
        "channelName": "test",
        "channelId": "1",
        "orderStatus": "Awaiting Payment"
      }
    ],
    "paginator": {
      "limit": 10,
      "offset": 0,
      "totalCount": 3
    }
  },
  "message": "SUCCESS"
}

Get company all orders, with pagination data

Authentication

authTokenstring

API Key authentication via header

Path parameters

companyIdstringRequired

Query parameters

offsetdoubleOptional

Pagination offset default: 0

limitdoubleOptional

Pagination limit default: 10

orderBystringOptional

in [‘bcOrderId’, ‘totalIncTax’, ‘createdAt’]

beginDateAtstringOptional

End date filter, in format ‘12/31/2019’

endDateAtstringOptional

End date filter, in format ‘12/31/2019’

includeExtrastringOptional

Switch show extra fields, allow: 0, 1

channelIddoubleOptional

BigCommerce channel id

Response

Response Success

codedouble

Response status code

dataobject

Response data

messagestring

Response message

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors