Skip to main content
GET
Order

Authorizations

Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

id
string
required
Required string length: 20 - 37
Examples:

"ord_1FAN3S3WV1S0B842"

"ord_1DBVRQDHBSBXWBWP"

Response

Successful Response

buyer_organisation
Organisation · object
required
credits_delivered
CreditQuantity · object
required
credits_ordered
CreditQuantity · object
required
effective_contract_date
string<date>
required
fulfilled_at
string<date-time> | null
required
id
string
required
Required string length: 20 - 37
Examples:

"ord_1FAN3S3WV1S0B842"

"ord_1DBVRQDHBSBXWBWP"

status
enum<string>
required
Available options:
placed,
in_progress,
completed
supplier
Supplier · object
required