POST
/
orders

Authorizations

Authorization
string
headerrequired

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

Body

application/json
amount
number
required

The total amount of the order in cents.

Required range: x > 0
customerEmail
string

The email of the customer.

Maximum length: 255
customerPhoneNumber
string

The phone number of the customer.

customerFirstName
string

The first name of the customer.

Maximum length: 100
customerLastName
string

The last name of the customer.

Maximum length: 100
customerId
string

The ID of the customer.

Maximum length: 50
metadata
object

Additional metadata for the order.

locale
enum<string>
default: fr_FR

The locale of the order

Available options:
en_US,
fr_FR
clientReferenceId
string

Unique string of your choice to reconcile with your internal system

Maximum length: 50
paymentGroupShareId
string | null

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

Maximum length: 50

Response

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

Required range: x > 0
amountCashback
number | null
required

The cashback amount of the order in cents.

Required range: x > 0
applicationFeeAmount
number | null
required

The fees due to Kohort for this order in cents.

Required range: x > 0
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.

List ordersGet an order