Ordexs API v1 Get an API key

Money

Record a payout

POSThttps://api.ordexs.com/v1/payouts

Like Record payout on the Overview. The payout covers order_ids, or, without them, every delivered order of that courier not paid for yet. expected is their total; difference is what the courier kept or added.

Body

  • courierstring or null

    The courier that paid

    up to 40 characters

  • amount_receivedstringRequired

    An amount as a decimal string in the store's currency, with no more decimals than the currency has ("3500.00" in DZD, "12.500" in TND).

  • payout_datestring

    Default today.

    date

  • referencestring

    The courier's payment reference.

    up to 120 characters

  • notesstring

    up to 1000 characters

  • order_idsarray of strings

    up to 1000 items · at least 1 item

Returns

201 Created · The payout. Payout

  • idstring

    starts with pay_

  • objectstring

    always "payout"

  • courierstring or null
  • referencestring or null
  • payout_datestring

    date

  • amount_receivedMoney

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

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

    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
  • orders_countinteger
  • notesstring or null
  • created_atstring

    ISO 8601 date-time, UTC

  • livemodeboolean

Errors

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