Submit Order

post

https://client/api/v1/orders

This API allows you to place an order for one or more gift cards. Gift cards will be activated in real-time and delivered back to you, or to your end-customer(s) based on your commercial agreement.

Body Params

clientOrderNumber

string

required

length ≥ 1

Unique order reference identifier you generate and supply

originalClientOrderNumber

string | null

Used to associate related orders. For example, linking a refund to the original order.

clientTransactionId

string | null

Client Transaction Id

invoiceNumber

string | null

Unique invoice number for the order

paymentInfo

object

customerInfo

object

clientConsumerReferenceId

string | null

Client consumer reference to distinguish client's customer types types

clientCartId

string | null

Cart identifier for the order

clientApplicationId

string | null

Client application identifier to distinguish between different channels within the same merchant

giftItemsInfo

array of objects

required

Gift items within the order

giftItemsInfo*

storeId

string | null

Store identifier where the order is initiated from

orderNote

object

billingInfo

object

Headers

X-Correlation-Id

string

required

Correlation Id

X-Idempotency-Key

string

required

Idempotency Key

Responses

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

202Accepted

400This response indicates that the request was invalid

401Unauthorized access

404This response indicates that the requested resource was not found

500This response indicates that an error was encountered when processing the request