Download Orders

Order download is a query you sent to Teapplix, which will return a list of "Order" JSON data to be returned from the body.

Method and Endpoint

Order download uses "GET" REST method, and the URL is the same as inbound "OrderNotification":

https://api.teapplix.com/api2/OrderNotification

Parameters

Parameters to limit which orders to download from Teapplix are passed in the query string part of the URL.

  • PaymentDateStart: 2012/01/01 => for orders with payment date >= 2012/01/01 (inclusive)
  • PaymentDateEnd: 2012/01/31 => for orders with payment date <= 2012/01/31 (note that since 2012/01/31 02:55:12 is greater than 2012/01/31, all orders placed on 01/31 is excluded)
  • ShipDateStart: 2012/01/20 => for shipped orders with ship date >= 2012/01/20
  • ShipDateEnd: 2012/01/31 => for shipped orders with ship date <= 2012/01/31
  • SeqStart: for txn_seq >= 12345, txn_seq is a unique number assigned to each order per Teapplix account. Based on the sequence that the order is created or pulled into Teapplix. You can remember the previous maximum number you have received, and use this to incrementally download large number of orders.
  • SeqEnd: 12346 => for txn_seq <= 12346. Use this to control which set of orders to download.
  • QueueId: (integer, optional) 0 => for orders with Normal queue; 3 => for orders with queue_id == 3
  • NotShipped: (optional, 1 or 0) ==> if set to 1, only obtain orders not shipped
  • Combine: "combine|original|all", depending on value, the following orders are included or excluded
    • combine: we will provide all "non cancelled" orders. If 2 orders are combined into 1, the combined result order will be in the result, the original order will not
    • original: we will provide all "non cancelled" orders. If 2 orders are combined into 1, the original order will be in the result, the combined result will not be.
    • all: all orders, including combined results, cancelled orders, etc, will be in the result.

Miminum list of parameters: you must specify one of: PaymentDateStart, ShipDateStart, SeqStart, NotShipped

Response Schema

The reply from Teapplix is described by the following Schema: