OrderByStatusListGet_API

Syntax

ListResult BM::OrderByStatusListGet_API(

  Int VendorAccountID;

  Str OrderTypeID;

  Str OrderStatusID;

  Int SortNo.

  )

returns

  Int OrderID - order ID;

  Str OrderNumber - order number;

  Int CustomerID - customer account ID;

  Str CustomerName - customer account name;

  Str OrderStatus - requested order status;

  Str OrderType - requested order type;

  Int CreationTime - order creation time in Unix format;

  Int OrderDate - order creation date in Unix format;

  Double Total - order total sum, without taxes and discounts;

  Double TaxTotal - total of taxes;

  Double DiscountTotal - total of discount applied to the order;

  Double MerchTotal - order total, including taxes and discount amount;

  Int ExpirationDate - order expiration date in Unix format;

  Str PromoCode - promotion code applied to the order;

  Int SalesBranchID - sales branch ID;

  Str SalesBranchName - sales branch name;

  Int SalesPersonID - sales person ID;

  Str SalesPersonName - sales person name;

  Str Comments - free form comments to the order.

Special Notes

• Int VendorAccountID - vendor account ID (provider or reseller);
• Str OrderTypeID - two-letter order type ID. The list of order types can be accessed from the Configuration Director > Order Processing > Order Types submenu of the Navigation tree;
• Str OrderStatusID - two-letter order status ID. The list of order statuses can be accessed from the Statuses tab of any order type;
• Int SortNo - defines how output data is sorted: 1 - the output is sorted by first column in ascending order, 1 - the output is sorted by second column in ascending order, etc. Negative value makes output sorted in descending order, for example: -1 - the output is sorted by first column (OrderID) in descending order.

Please send us your feedback on this help page