List orders

Authorizations

Authorization

string

headerrequired

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

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".

string

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

Response

200 - application/json

data

object[]

required

data.id

string

required

The id of the order.

data.livemode

boolean

required

Wether the order is in live mode or test mode.

data.organizationId

string

required

The id of the organization.

data.amount

number

required

The total amount of the order in cents.

Required range: x > 0

data.amountCashback

number | null

required

The cashback amount of the order in cents.

Required range: x > 0

data.applicationFeeAmount

number | null

required

The fees due to Kohort for this order in cents.

Required range: x > 0

data.customerEmail

string

required

The email of the customer.

data.customerFirstName

string

required

The first name of the customer.

data.customerLastName

string

required

The last name of the customer.

data.customerPhoneNumber

string

required

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.

data.customerId

string

required

The ID of the customer.

data.currency

enum<string>

default: EURrequired

The currency of the order.

Available options:

EUR

data.locale

enum<string>

default: fr_FRrequired

The locale of the order.

Available options:

en_US,

fr_FR

data.status

enum<string>

required

The current status of the order.

Available options:

CREATED,

CASHBACK_AVAILABLE,

CASHBACK_PROCESSING,

CASHBACK_SENT

data.metadata

object

required

Additional metadata for the order.

data.paymentGroupId

string | null

required

The id of the associated group.

data.ambassadorId

string | null

required

The id of the associated ambassador.

data.clientReferenceId

string | null

required

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

data.riskLevel

enum<string>

required

The risk level of the order.

Available options:

LOW,

MEDIUM,

HIGH,

HIGHEST

data.createdAt

string

required

data.createdBy

string | null

required

The id of the user who created the customer.

data.updatedAt

string

required

data.updatedBy

string | null

required

The id of the user who last updated the customer.

count

number

required

Total count of orders

API Reference

Customers

Orders

Referral Groups

Authorizations

Query Parameters

Response