Order

Order object structure

Parameter
Type / Description

RefNo

String The unique, system-generated identifier of a partner order.

Status

String Order status. Possible values: CANCELED, REFUND, TEST, REJECTED, COMPLETE, SUSPECT, AWAITING_PAYMENT, PENDING_APPROVAL, DELIVERY_NEEDS_INFO.

OrderLockReason

StringArray The reason why the order is blocked in a certain status. Can be NULL. For AWAITING_PAYMENT order status, the OrderLockReason can be:

  • UNPAID_PROFORMA

  • NOT_ENOUGH_CREDIT

For order status DELIVERY_NEEDS_INFO, the OrderLockReason can be:

  • REQUIRED_END_USER_INFORMATION

  • REQUIRED_RESELLER_INFORMATION

  • REQUIRED_VENDOR_DELIVERY_CONFIRMATION

ProformaNumber

String The unique number of the partner invoice associated with this order. Can be NULL.

TotalAmount

Double The total value of the order, including tax, but excluding partner margins and discounts.

Currency

String The order currency ISO code.

TotalSubbscriptionsNumber

Int The total number of subscriptions generated for the products included in the order. Can be NULL, if subscriptions have yet to be generated for an order.

Last updated

Was this helpful?