Get an order
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique order ID
Query Parameters
Fields to expand related entities. For example, ["organization"].
Maximum number of items to retrieve. Default is 25.
Number of items to skip before starting to collect the result set.
Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".
Search term to filter the results. Supports multiple terms with "~" for partial matches.
Response
The id of the order.
Wether the order is in live mode or test mode.
The id of the organization.
The total amount of the order in cents.
x > 0
The cashback amount of the order in cents.
x > 0
The fees due to Kohort for this order in cents.
x > 0
The email of the customer.
The first name of the customer.
The last name of the customer.
The phone number of the customer.
The shared identifier of the group. If null, it will create a group. If not null, it will join the group.
The ID of the customer.
The currency of the order.
EUR
The locale of the order.
en_US
, fr_FR
The current status of the order.
CREATED
, CASHBACK_AVAILABLE
, CASHBACK_PROCESSING
, CASHBACK_SENT
Additional metadata for the order.
The id of the associated group.
The id of the associated ambassador.
The reference id of the client. Use this field to renconcile with your system.
The risk level of the order.
LOW
, MEDIUM
, HIGH
, HIGHEST
The id of the user who created the customer.
The id of the user who last updated the customer.