NAnavipartner
channelManager > Orders

Create Order

Changed on

Create a new OTA 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 (and, where configured, coupons), while a non-package item is a single ticket.

The endpoint is asynchronous: it accepts the order, persists it with status = Submitted, and returns immediately. The order is then processed in the background, transitioning through Scheduled → Processing → Issued | Draft | Error. Subscribe to the ota_cm_order_processed webhook to be notified when the order reaches a terminal state, or poll getOrder until status is one of Issued, Draft, or Error.

post/{tenant}/{environment}/{company}/channelManager

Request

  • Base URL
    https://api.npretail.app
  • Auth
    API key in header x-np-api-key

Path parameters

tenantstring required

Your Entra Tenant ID. More details.

environmentstring required

Your Business Central Environment. More details.

companystring required

Your Business Central Company. More details.

Query parameters

syncboolean

When true (or 1), opt out of async processing and run ticket issuance synchronously inside the request. The response then carries the final order state (Issued, Draft, or Error) instead of Submitted.

Default behavior — and the recommended mode — is asynchronous. In async mode the order is processed in the background; subscribe to the ota_cm_order_processed webhook for completion notifications, or poll getOrder until the status reaches a terminal value.

Headers

x-api-versionstring date

Used for API versioning. More details.

Request body

partnerIdstring uuid required

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.

sellToOrderReferencestring required

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

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 OTA 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. Used to localize the description fields on items and assets via Item Translation. 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 50 characters.

Response

Response with status 201

orderIdstring uuid required

Globally unique identifier of an OTA Channel Manager order, assigned when the order is accepted.

status'Submitted' | 'Scheduled' | 'Processing' | 'Draft' | 'Issued' | 'Cancelled' | 'Error' required
statusMessagestring required

Human-readable detail about the current status, set by the OTA Channel Manager. Populated for Error; empty otherwise.

partnerIdstring uuid required

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.

sellToOrderReferencestring required

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

buyFromOrderReferencestring required

The OTA Channel Manager's own document number for the order, used as a stable identifier for partner-side reconciliation. Maximum 20 characters.

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 OTA 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. Used to localize the description fields on items and assets via Item Translation. 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 50 characters.

receivedAtstring date-time required

UTC timestamp recorded when the OTA Channel Manager accepted the order. ISO 8601.

jobIdstring

Background job identifier assigned by the OTA Channel Manager when ticket issuance has been performed for an order. Empty until issuance has begun.

manifestUrlstring

URL of the printable wallet manifest, populated once asset issuance has completed.

Changes

  • 48cacf22ffcdRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      for the query request parameter sync, the type changed from no type to boolean

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter x-np-api-key

    • info

      the endpoint scheme security NPApiKeyAuthScheme was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 407697660280Revision changes
    • info

      api operation id create-order removed and replaced with channelManager_serviceOrder_createOrder