Ordexs API v1 Get an API key

Delivery setup

Update delivery settings

PATCHhttps://api.ordexs.com/v1/delivery/settings

Like the Delivery page. strategy decides who prices and who ships:

  • flat: the store's own prices per region (/v1/delivery/prices); the routing rules, then the default courier, choose the courier;
  • customer_choice: live rates of courier_ids; the shopper picks the courier;
  • cheapest: live rates of courier_ids; the cheapest is shown and ships.

Courier rates need at least one courier in courier_ids.

Body

  • enabledboolean
  • strategystring

    One of flat, customer_choice, cheapest

  • modesobject
    2 child fields
    • homeboolean
    • pickup_pointboolean
  • labelsobject
    2 child fields
    • homestring

      1–40 characters

    • pickup_pointstring

      1–40 characters

  • courier_idsarray of strings

    up to 20 items

  • fallback_to_flat_pricesboolean
  • default_courier_idstring or null

    starts with cour_

Returns

200 OK · The settings. DeliverySettings

  • objectstring

    always "delivery_settings"

  • enabledboolean

    Whether checkout asks for a delivery option at all.

  • strategystring

    One of flat, customer_choice, cheapest

  • modesobject
    2 child fields
    • homeboolean
    • pickup_pointboolean
  • labelsobject
    2 child fields
    • homestring
    • pickup_pointstring
  • courier_idsarray of strings

    The couriers whose live rates are used (customer_choice and cheapest).

  • fallback_to_flat_pricesboolean

    Use the store's prices where a courier has no rate for a region.

  • default_courier_idstring or null

Errors

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