Ordexs API v1 Get an API key

Customers

Update a customer

PATCHhttps://api.ordexs.com/v1/customers/{customer_id}

Name, status, tags and note. A customer's phone and email identify them and can't be changed.

Path parameters

  • customer_idstringRequired

    starts with cus_

Body

  • namestring

    1–80 characters

  • statusstring

    do_not_contact blocks the customer, like the Customers page's Block.

    One of active, needs_followup, do_not_contact

  • tagsarray of strings

    up to 50 items

  • notestring or null

    up to 2000 characters

  • whatsapp_opt_inboolean

    Whether the customer agreed to WhatsApp messages. Only set it to true with their consent.

Returns

200 OK · The updated customer. Customer

  • idstring

    starts with cus_

  • objectstring

    always "customer"

  • namestring or null
  • phonestring or null

    E.164.

  • emailstring or null
  • statusstring

    do_not_contact: blocked by the merchant.

    One of active, needs_followup, do_not_contact

  • reliabilityobject

    The delivery score: how likely this customer is to accept a COD parcel, from their delivered, returned and cancelled orders here and (at half weight) at other Ordexs stores.

    2 child fields
    • scoreinteger or null

      Percentage, null with no delivered, returned or cancelled order yet.

      0–100

    • tierstring

      reliable: 75 and up. uncertain: 50-74. risky: under 50. new: no finished orders.

      One of new, reliable, uncertain, risky

  • whatsapp_opt_inboolean
  • whatsapp_opt_in_atstring or null

    ISO 8601 date-time, UTC

  • tagsarray of strings
  • notestring or null
  • orders_countinteger
  • delivered_countinteger
  • returned_countinteger
  • cancelled_countinteger
  • total_spentMoney

    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
  • first_order_atstring or null

    ISO 8601 date-time, UTC

  • last_order_atstring or null

    ISO 8601 date-time, UTC

  • livemodeboolean
  • created_atstring

    ISO 8601 date-time, UTC

  • updated_atstring

    ISO 8601 date-time, UTC

Errors

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