Get one of your orders

Requires orders:read. An id that belongs to another account answers 404, like an id that does not exist.

get/api/agent/v1/orders/{id}

Request

  • Base URL: https://essentras.com
  • URL: https://essentras.com/api/agent/v1/orders/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The order id returned by POST /orders or GET /orders.

Response

The order

object'order'
idstring

Order id for the API (the public id).

numberinteger nullable
statusstring
payment_statusstring
fulfillment'awaiting_payment' | 'awaiting_brief' | 'in_progress' | 'partially_published' | 'published' | 'cancelled' | 'refunded'
channel'api' | 'reseller_portal' | 'website'
created_atstring date-time
paid_atstring date-time nullable
currency'USD'
pricing_basis'list' | 'reseller'
subtotalnumber
discountnumber
discount_reasonstring nullable
totalnumber
paid_from_walletnumber
client_referencestring nullable
dashboard_urlstring uri

Changes

No recorded changes to this operation across all 1 revision of this API.