Skip to navigation

List Orders by Partner

List orders that belong to a specific partner. Filters are AND-combined and applied as exact matches except where noted:

  • status — comma-separated list of OrderStatus values; matches any of them. Useful for tracking in-flight orders with status=Submitted,Scheduled,Processing.
  • sellToOrderReference — exact match on the partner’s order reference.
  • receivedAtFrom / receivedAtTo — inclusive ISO 8601 bounds. Either bound may be supplied independently.

Results are paginated according to the standard pagination conventions; see Pagination for details. The returned objects are the compact OrderSummary shape — to inspect issued wallets, follow up with getOrder.

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

partnerIdUUIDRequired

Globally unique identifier of the OTA Channel Manager partner that originated the order. The partner must exist and be active in the OTA Channel Manager Partner Setup; otherwise the order is rejected.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

statusstringOptional

Filter listOrdersByPartner by one or more status values. Multiple statuses are comma-separated (e.g. Submitted,Scheduled,Processing).

sellToOrderReferencestringOptional

The partner’s own reference for the order. Unique per partner; combined with partnerId it identifies the order end-to-end. Maximum 50 characters.

receivedAtFromdatetimeOptional

Inclusive lower bound for filtering listOrdersByPartner by receivedAt. ISO 8601.

receivedAtTodatetimeOptional

Inclusive upper bound for filtering listOrdersByPartner by receivedAt. ISO 8601.

pageSizeintegerOptional
pageKeystringOptional

Response

This endpoint returns an object.
morePagesboolean
nextPageKeystring
nextPageURLstring
datalist of objects