Use this API to find orders and get their statuses in the Dropship Platform.

 First, go check out the Find Order Statuses API in the Dropship Interactive Playground if you haven't already to understand the specifics of calling this API.

 Input Params

The Find Order Statuses API documents the exact params that may be used as part of the search.  When searching, you must provide either poNumber or exactly one of the period-based filters (ordersUpdatedInLast, ordersUpdatedSince).  Below you will find additional detail on the input params.

  • pageNumber 
    Use this param to specify which page of results is desired.  Initially, call this API with the pageNumber set to 1.  The response will include the total number of pages of results as the pageCount field, allowing the developer to make additional calls to this API to retrieve all pages of results.  Please note that every call to this API returns the pageCount field in the returned object and the developer should verify that the pageCount does not change as he iterates through the pages.  The pageCount would only change if the number of items is changing in the Dropship database as a result of an integration or process importing new items.  If the pageCount does change the developer should do one of the following...
    1. Enter an error condition and schedule the process to execute again at some point in the future
    2. Wait a period of time, perhaps 30 minutes, and execute the process again without creating an error condition.
  • poNumber
    Find the order with this exact poNumber.
  • ordersUpdatedInLast
    Find orders where the order(s) were updated within the last xyz seconds.  The maximum value allowed is one year ago (31536000). This value is inclusive in that the search looks for objects greater than or equal to the time specified.
  • ordersUpdatedSince
    Find orders where the order(s) were updated since this ISO 8601 date (e.g. 2014-01-01T10:30:00+01:00). This value is inclusive in that the search looks for objects greater than or equal to the time specified.
  • until
    Find orders updated up until this ISO 8601 date (e.g. 2014-01-01T10:30:00+01:00). This param will be ignored unless one of the period-based params is included (ordersUpdatedInLast, ordersUpdatedSince). This value is exclusive in that the search looks for objects right up to but not including the very moment requested, e.g. searching until 10:30:00 finds objects up until 10:29:59.999)

 Output Object

The result of calling this API is a PagedOrderStatusResult JSON object with the following attributes...

  • pageNum
    The page number of this page of results that was passed in as pageNumber in the request.
  • pageSize
    The maximum number of objects that will be returned with each page of results.
  • pageCount
    The number of pages of results available given the current input search params.
  • orderStatuses
    The list of order status objects returned with this page of results where each order status object has the following attributes...
    • orderId
      The Dropship unique identifier for the order this object's status applies to.
    • poNumber
      The poNumber for the order this object's status applies to.
    • status
      The status of the order, one of the following values...
      • created
        The order has been created but has not been either shipped or cancelled yet.
      • shipped
        The order has shipped and tracking data should be available (where applicable).
      • cancelled
        This order has been cancelled by either the supplier fulfilling this order or the retailer who owns the order.
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.