Ordexs API v1 Get an API key

Shipping

List shipments

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

Every parcel the store sent to a courier, newest first, including failed attempts. With updated_since, oldest change first: the way to follow courier progress without webhooks. A shipment's status and stage come from the courier's tracking, read on a schedule by Ordexs.

Query parameters

  • limitinteger

    How many objects to return, 1–100. Default 25.

    1–100

  • cursorstring

    The next_cursor from the previous page. Repeat the same filters with it.

    up to 512 characters

  • updated_sincestring

    Only objects changed at or after this moment (ISO-8601). Switches the order to oldest change first, so you can store the last updated_at you saw and resume from it. Objects changed in the same second may be returned again — de-duplicate by id.

    ISO 8601 date-time, UTC

  • created_sincestring

    Only objects created at or after this moment (ISO-8601).

    ISO 8601 date-time, UTC

  • order_idstring

    Only this order's shipments.

    starts with ord_

  • statusShipmentStatus

    pending (registered with the courier, not picked up yet), in_transit, delivered, returned, cancelled, or failed (the courier refused it). New values may be added.

    One of pending, in_transit, delivered, returned, cancelled, failed

Returns

200 OK · A page of shipments. ShipmentList

  • objectstringRequired

    always "list"

  • has_morebooleanRequired
  • next_cursorstring or nullRequired

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

  • dataarray of ShipmentsRequired
    21 child fields
    • idstringRequired

      starts with shp_

    • objectstringRequired

      always "shipment"

    • order_idstringRequired

      starts with ord_

    • courierobjectRequired
      3 child fields
      • idstring or null

        The store's courier account. null for a test shipment.

      • brandstring

        The courier company, e.g. "zrexpress", "yalidine". "test" for a test shipment.

      • account_namestring or null

        The name the merchant gave the account.

    • tracking_codestring or nullRequired

      The courier's tracking number. null when the send failed.

    • statusShipmentStatusRequired

      pending (registered with the courier, not picked up yet), in_transit, delivered, returned, cancelled, or failed (the courier refused it). New values may be added.

      One of pending, in_transit, delivered, returned, cancelled, failed

    • stageShipmentStage or null
    • stage_changed_atstring or null

      ISO 8601 date-time, UTC

    • status_detailstring or null

      The courier's own words for its last report, in the courier's language.

    • codobject

      The cash on delivery, as the courier reports it.

      2 child fields
      • statusstring or null

        delivered_unpaid: delivered, the courier has not collected yet. cash_collected: the courier holds the cash. paid: the courier paid the merchant. null when the courier does not report it.

        One of delivered_unpaid, cash_collected, paid, archived

      • settled_atstring or null

        ISO 8601 date-time, UTC

    • return_statusstring or null

      suspended: on hold at the courier. return_ready: coming back, waiting for the merchant to collect it. returned_in: handed back.

      One of suspended, return_ready, returned_in

    • driverobject or null
      2 child fields
      • namestring or null
      • phonestring or null

        E.164 when it could be read.

    • eventsarray of objects

      The courier's history of the parcel, oldest first (the last 50).

      3 child fields
      • atstring or null

        The courier's own timestamp, as it sends it.

      • labelstring
      • kindstring or null
    • failure_messagestring or null

      Why the courier refused the parcel

    • validated_atstring or null

      When the parcel was validated with the courier.

      ISO 8601 date-time, UTC

    • packed_atstring or null

      When the parcel was marked packed.

      ISO 8601 date-time, UTC

    • last_checked_atstring or null

      When Ordexs last asked the courier about it.

      ISO 8601 date-time, UTC

    • sent_atstring

      ISO 8601 date-time, UTC

    • livemodebooleanRequired
    • created_atstringRequired

      ISO 8601 date-time, UTC

    • updated_atstringRequired

      ISO 8601 date-time, UTC

Errors

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