Channel ManagerOrders

Create Order

Create a new channel manager order. The combination of `partnerId` and `sellToOrderReference` must be unique; resubmitting the same pair returns `400 Bad Request`. Each `items` entry must reference an existing item — a package item expands into multiple component admissions, while a non-package item is a single ticket. Ticket issuance runs synchronously inside the request, so the response carries the final order state. With `paymentReference` supplied the order is returned as `Issued`, including every wallet, ticket number, and the `manifestUrl`. Without `paymentReference` it is returned as `Draft`. If issuance fails, the call returns an error response and the order is left as `Error` with a populated `statusMessage`.

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.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
partnerIdUUIDRequired

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

sellToOrderReferencestringRequired

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

itemslist of objectsRequired
sellToEmailstringOptional

Email address of the customer the order is sold to. Stored on the order and on each issued wallet for the partner’s own use; the Channel Manager does not send anything to this address. Maximum 100 characters. Can be overridden per item.

sellToNamestringOptional
Name of the customer the order is sold to. Maximum 100 characters. Can be overridden per item.
sellToLanguagestringOptional

Language code (uppercased) for the customer the order is sold to. Stored on the order and on each issued wallet for the partner’s own use; the Channel Manager does not act on it. Must be a valid Business Central language code. Maximum 10 characters. Can be overridden per item.

paymentReferencestringOptional

Reference to the partner-side payment transaction. May be supplied at order creation, or later via confirmOrder. Required to move an order from Draft to Issued. Maximum 20 characters.

Response

This endpoint returns an object.
orderIdUUID
Globally unique identifier of a channel manager order, assigned by the Channel Manager when the order is accepted.
statusenum

Lifecycle state of a channel manager order:

  • Draft — order is held pending payment confirmation. Call confirmOrder to release it.
  • Issued — tickets have been issued and the manifest is available.
  • Cancelled — order has been cancelled (deleteOrder on a non-deletable status).
  • Error — ticket issuance failed. Inspect statusMessage for details. The order can be replaced or deleted.
  • Processing — transient internal state committed while ticket issuance runs.
Allowed values:
partnerIdUUID

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

sellToOrderReferencestring

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

receivedAtdatetime
UTC timestamp recorded when the Channel Manager accepted the order. ISO 8601.
itemslist of objects
sellToEmailstring

Email address of the customer the order is sold to. Stored on the order and on each issued wallet for the partner’s own use; the Channel Manager does not send anything to this address. Maximum 100 characters. Can be overridden per item.

sellToNamestring
Name of the customer the order is sold to. Maximum 100 characters. Can be overridden per item.
sellToLanguagestring

Language code (uppercased) for the customer the order is sold to. Stored on the order and on each issued wallet for the partner’s own use; the Channel Manager does not act on it. Must be a valid Business Central language code. Maximum 10 characters. Can be overridden per item.

paymentReferencestring

Reference to the partner-side payment transaction. May be supplied at order creation, or later via confirmOrder. Required to move an order from Draft to Issued. Maximum 20 characters.

jobIdstring
Background job identifier assigned by the Channel Manager when ticket issuance is queued for an order. Empty until issuance has been scheduled.
manifestUrlstring
URL of the printable wallet manifest, populated once ticket issuance has completed.