Ordexs API v1 Get an API key

Returns

List returns

GEThttps://api.ordexs.com/v1/returns

The Returns queue: parcels on their way back (in_transit; ready once the courier has it waiting to be picked up) and parcels back in hand (received), the items an exchange collected included. Checked-in returns leave the list. At most 200 of each kind, newest first.

Query parameters

  • stagestring

    One of in_transit, received

  • kindstring

    One of return, exchange

Returns

200 OK · The queue. ReturnList

  • objectstringRequired

    always "list"

  • has_morebooleanRequired
  • next_cursorstring or nullRequired

    Pass as cursor to get the next page. null on the last page.

  • dataarray of ReturnsRequired
    17 child fields
    • objectstring

      always "return"

    • order_idstring
    • order_numberstring or null
    • kindstring

      exchange: the items an exchange order collected from the customer.

      One of return, exchange

    • stagestring

      One of in_transit, received

    • readyboolean

      The courier has the parcel waiting to be picked up.

    • ready_atstring or null

      ISO 8601 date-time, UTC

    • returned_atstring or null

      ISO 8601 date-time, UTC

    • received_atstring or null

      ISO 8601 date-time, UTC

    • original_order_idstring or null

      For an exchange

    • customerobject
      2 child fields
      • namestring or null
      • phonestring or null
    • courierstring or null
    • tracking_codestring or null
    • courier_statusstring or null

      The courier's own words for the parcel's state.

    • totalMoney

      An amount of money. amount is a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.

      2 child fields
      • amountstringRequired
      • currencystringRequired
    • itemsarray of objects
      9 child fields
      • idstring

        li_… for a return, xli_… for an exchange. Pass it to check_in.

      • product_idstring or null
      • variant_idstring or null
      • titlestring
      • variant_titlestring or null
      • quantityinteger
      • image_urlstring or null
      • tracks_stockboolean

        false when the variant doesn't track stock (restocking it moves nothing).

      • checked_inboolean
    • livemodeboolean
  • countsobject

    As the Returns badge counts them.

    2 child fields
    • receivedinteger

      Back in hand or ready to pick up.

    • in_transitinteger

Errors

Every error has the same shape. This endpoint can answer with: