Ordexs API v1 Get an API key

Orders

List orders

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

Newest first. Pass updated_since to get every order changed since a moment, oldest change first.

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

  • statusarray of OrderStatuses

    One status, or several separated by commas.

    One of pending, confirmed, scheduled, attempt_1, attempt_2, attempt_3, double, waiting, cancelled, preparing, shipped, delivered, returned, deleted
    up to 15 items

  • numberstring

    The order number as the merchant sees it (ORD-00042), or just its digits (42).

  • phonestring

    The customer's phone, in E.164 (+213551234567) or national form.

    6–20 characters

  • archivedboolean
  • external_idstring

    Your own id, as sent when the order was created.

    1–255 characters

  • sourcestring

    Where the order came from.

    One of storefront, dashboard, api, import

  • customer_idstring

    Only this customer's orders (matched by phone, as on the Customers page).

    starts with cus_

  • needs_reviewboolean

    Only orders that wait for the merchant to confirm the address (true), or only those that don't (false).

Returns

200 OK · A page of orders. OrderList

  • objectstringRequired

    always "list"

  • has_morebooleanRequired
  • next_cursorstring or nullRequired

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

  • dataarray of OrdersRequired
    33 child fields
    • idstringRequired

      starts with ord_

    • objectstringRequired

      always "order"

    • numberstring or nullRequired

      The number the merchant uses, e.g. "ORD-00042".

    • statusstringRequired

      pending → confirmed → (with a courier) shipped → delivered or returned. scheduled, attempt_1…attempt_3, double, waiting and cancelled are set by the merchant's team; preparing, shipped, delivered, returned and deleted come from the courier. New values may be added — treat an unknown one like pending.

      One of pending, confirmed, scheduled, attempt_1, attempt_2, attempt_3, double, waiting, cancelled, preparing, shipped, delivered, returned, deleted

    • sourcestring

      Where the order came from: storefront, dashboard, api or import.

    • source_namestring or null

      The integration that created it, as it named itself in source_name.

    • external_idstring or null

      The id the integration gave this order.

    • needs_reviewstring or null

      Why the merchant must check this order before it can go to a courier. city_unmatched — the city was not recognised. null when nothing needs checking.

    • preorderboolean

      Marked as a pre-order (the goods are on their way to the merchant).

    • assigned_toobject or null

      The teammate working this order.

      2 child fields
      • idstring
      • namestring
    • typestring

      See OrderCreate.type. New values may be added.

      One of delivery, exchange, pickup, cash_collection

    • exchange_ofstring or null

      The delivered order this exchange replaces goods from.

    • collectobject or null

      What the courier takes back, for an exchange or a pickup.

      3 child fields
      • stagestring or null

        Where the collected goods are (pending until they come back).

      • summarystring or null

        The line the courier prints for the goods to collect.

      • linesarray of objects
        8 child fields
        • original_line_item_idstring or null
        • product_idstring or null
        • variant_idstring or null
        • titlestring
        • variant_titlestring or null
        • quantityinteger
        • restockedinteger

          Units put back into stock when they came back.

        • written_offinteger
    • metadataobject

      Your own key/value pairs, returned as you sent them.

    • customerobjectRequired
      5 child fields
      • idstring or null
      • namestring
      • phonestring or null

        E.164.

      • phone_2string or null
      • emailstring or null
    • shipping_addressAddressRequired
      4 child fields
      • countrystring
      • regionobject
        2 child fields
        • codestring
        • namestring
      • cityobject
        2 child fields
        • codestring or null
        • namestring
      • address1string or null
    • deliveryobject
      7 child fields
      • modestring or null

        One of home, pickup_point

      • labelstring or null
      • courierobject or null
        1 child field
        • namestring
      • pickup_pointobject or null
        2 child fields
        • idstring
        • namestring or null
      • tracking_codestring or null
      • tracking_urlstring or null

        The customer's tracking page for this order, on the store's address (https://<store>.myordexs.com/track/<code>). Send it to the customer: it shows every step of the delivery, in the store's language. Each order has its own private link, and it stays the same if the parcel is sent again. It stops working 3 days after the order is delivered or returned (the page then says the link has expired); a cancelled order has no tracking page. null in test mode.

        uri

      • shipped_atstring or null

        ISO 8601 date-time, UTC

    • line_itemsarray of objectsRequired
      10 child fields
      • idstring
      • product_idstring or null
      • variant_idstring or null
      • titlestring
      • variant_titlestring or null
      • skustring or null
      • quantityinteger
      • unit_priceMoney

        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
      • 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
      • image_urlstring or null
    • discount_codestring or null

      The code the shopper used; null when none

    • discount_namestring or null

      The name of the discount applied

    • offersarray of strings

      Names of the offers applied.

    • offer_idsarray of strings

      The offers applied

    • subtotalMoneyRequired

      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
    • shippingMoneyRequired

      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
    • discountMoney

      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
    • totalMoneyRequired

      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
    • paymentobjectRequired
      6 child fields
      • methodstring

        "cod" (cash on delivery), "card" (paid in full online by card) or "card_deposit" (a deposit paid online by card, the rest in cash on delivery). More methods may be added.

      • statusstring

        unpaid: nothing received yet. pending: the shopper chose card and has not finished paying. partially_paid: a card deposit was received, the rest is collected on delivery. paid: fully paid (online, or the cash was recorded).

        One of unpaid, pending, partially_paid, paid

      • paid_atstring or null

        ISO 8601 date-time, UTC

      • amount_paidMoney

        What the shopper already paid online toward the order.

        2 child fields
        • amountstringRequired
        • currencystringRequired
      • amount_to_collectMoney

        What the courier collects in cash at delivery: total minus amount_paid.

        2 child fields
        • amountstringRequired
        • currencystringRequired
      • card_discountMoney

        The store’s discount for paying by card, already included in discount and taken off total. Zero for cash on delivery.

        2 child fields
        • amountstringRequired
        • currencystringRequired
    • notestring or null

      The customer's note at checkout.

    • archivedboolean
    • scheduled_forstring or null

      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: