BObossinsights
Order

Retrieves the collection of Order resources.

Retrieves the collection of Order resources.

get/orders

Request

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Order collection

idstring

Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726"

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIDstring

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

namestring nullable

Order name e.g. "New order"

orderDatestring date-time nullable

Date and time the order is created e.g. "2019-08-25T02:17:40.080Z"

orderStatusstring nullable

Status of the order e.g. "activated"

descriptionstring nullable

Additional details about the order e.g. "Monthly bundle"

amountstring nullable

Amount of the order e.g. "1200"

quantityinteger nullable

The number of items included in the order e.g. 5

modifiedstring date-time nullable

When the order was last modified e.g. "2019-08-25T02:17:40.080Z"

customerIdstring nullable

Id of the customer the order is by e.g. "C005"

firstNamestring nullable

First name of the customer e.g. "Jane"

lastNamestring nullable

Last name of the customer e.g. "Doe"

currencystring nullable

The currency the order was made in e.g. "USD"

Example response

[
  {
    "id": "quickbooks-726",
    "integration": "quickbooks",
    "srcID": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
    "name": "New order",
    "orderDate": "2019-08-25T02:17:40.080Z",
    "orderStatus": "activated",
    "description": "Monthly bundle",
    "amount": "1200",
    "quantity": 5,
    "modified": "2019-08-25T02:17:40.080Z",
    "customerId": "C005",
    "firstName": "Jane",
    "lastName": "Doe",
    "currency": "USD"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.