GET
/
orders
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique order ID

Query Parameters

expand
string[]

Fields to expand related entities. For example, ["organization"].

take
number

Maximum number of items to retrieve. Default is 25.

skip
number

Number of items to skip before starting to collect the result set.

orderBy
string

Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".

search
string

Search term to filter the results. Supports multiple terms with "~" for partial matches.

Response

200 - application/json
id
string
required

The id of the order.

livemode
boolean
required

Wether the order is in live mode or test mode.

organizationId
string
required

The id of the organization.

amount
number
required

The total amount of the order in cents.

amountCashback
number | null
required

The cashback amount of the order in cents.

applicationFeeAmount
number | null
required

The fees due to Kohort for this order in cents.

customerEmail
string
required

The email of the customer.

customerFirstName
string
required

The first name of the customer.

customerLastName
string
required

The last name of the customer.

customerPhoneNumber
string
required

The phone number of the customer.

paymentGroupShareId
string | null
required

The shared identifier of the group. If null, it will create a group. If not null, it will join the group.

customerId
string
required

The ID of the customer.

currency
enum<string>
default: EURrequired

The currency of the order.

Available options:
EUR
locale
enum<string>
default: fr_FRrequired

The locale of the order.

Available options:
en_US,
fr_FR
status
enum<string>
required

The current status of the order.

Available options:
CREATED,
CASHBACK_AVAILABLE,
CASHBACK_PROCESSING,
CASHBACK_SENT
metadata
object
required

Additional metadata for the order.

paymentGroupId
string | null
required

The id of the associated group.

ambassadorId
string | null
required

The id of the associated ambassador.

clientReferenceId
string | null
required

The reference id of the client. Use this field to renconcile with your system.

riskLevel
enum<string>
required

The risk level of the order.

Available options:
LOW,
MEDIUM,
HIGH,
HIGHEST
createdAt
string
required
createdBy
string | null
required

The id of the user who created the customer.

updatedAt
string
required
updatedBy
string | null
required

The id of the user who last updated the customer.

Create an orderList groups