Order Search
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}
/order-service/order-search
Refer to our documentation on URI syntax for more information on how to construct URIs.
Columns
Name | Required | Sortable | Filterable | Data type | Reference data | Description |
---|---|---|---|---|---|---|
orderId |
IDSET | None | The ID of the Order. Can be used to retrieve all order information using Order Get. | |||
orderTypeId |
IDSET |
|
The ID of the Order Type. See report reference data for description. | |||
contactId |
INTEGER | None | The ID of the Contact. Can be used to recover all information about a contact by issuing a Contact GET. | |||
orderStatusId |
INTEGER |
|
The ID of the Order status. Description can be found in the report reference data. | |||
orderStockStatusId |
INTEGER |
|
The ID of the Order stock status. Description can be found in the report reference data. | |||
createdOn |
PERIOD | None | The date the Order was created. | |||
createdById |
INTEGER | None | The ID of the Staff member who created this order. | |||
customerRef |
STRING | None | The customer reference for the order. | |||
orderPaymentStatusId |
INTEGER |
|
The payment status ID of the order | |||
updatedOn |
PERIOD | None | The date the Order was updated. | |||
parentOrderId |
IDSET | None | The ID of the order's parent. Orders have a parent when they are linked to another order, for example a sales credit linked to a sales order. | |||
orderShippingStatusId |
INTEGER |
|
The shipping status ID of the order | |||
externalRef |
STRING | None | The external reference for the order | |||
installedIntegrationInstanceId |
INTEGER | None | The integration instance this order is associated with | |||
warehouseId |
IDSET | None | The ID of the warehouse. Can be used to retrieve all orders for a given warehouse ID. | |||
staffOwnerContactId |
INTEGER | None | The ID of the staff member who is assigned to the order. | |||
taxDate |
PERIOD | None | The tax date of the order. | |||
departmentId |
INTEGER | None | The ID of the department the Order is associated with. | |||
deliveryDate |
PERIOD | None | The date the delivery is set for. |
Filters
Name | Sortable | Data type | Description |
---|---|---|---|
placedOn |
true | PERIOD | The date the order was placed. |
shippingMethodId |
true | INTEGER | The ID of the Shipping Method. |
projectId |
true | INTEGER | The ID of the project the Order is associated with. |
departmentId |
true | INTEGER | The ID of the department the Order is associated with. |
channelTypeId |
true | IDSET | The ID of the channel type. |
leadSourceId |
true | INTEGER | The ID of the lead source the Order is associated with. |
isClone |
false | BOOLEAN | Whether the order is a clone or not. |
externalRefs |
true | STRING_SET | The external reference for the order. This is the same as the externalRef column, except it allows you to search for multiple external references simultaneously. |
isClosed |
true | BOOLEAN | Whether the order is invoiced or not. |
externalRefSearchString |
true | SEARCH_STRING | The external reference for the order. This is the same as the externalRef column, except the data type is SEARCH_STRING, allowing you to match external references by case-insensitive substrings. |
stockAllocationId |
true | INTEGER | The stock allocation status ID of the order |
orderShippingStatusId |
true | INTEGER | The shipping status ID of the order |
orderState |
false | false | The state of an order status, for example an order status is linked to a state. |
idOrExternalReference |
STRING | Filter idOrExternalReference can be used to search for an order by its id or with a case insensitive value in the external reference field. | |
isHistoricalOrder |
true | BOOLEAN | Whether the order is a historical order or not. |
Sorting
Sorted by | Sort Direction |
---|---|
orderId |
ASC
|
More information
Instructions for working with resources can be found in Resource search design