POST
/
api
/
order

Authorizations

​
CLIENT-ID
string
header
required
​
API-KEY
string
header
required
​
API-PASSWORD
string
header
required

Body

application/json
​
base_location
string

The country code in ISO 3166-1 alpha-2 format. eg AU for Australia.

​
currency
string

The currency you would like to pay in. Sent in ISO 4217 format. eg Australian Dollar is AUD.

​
order_ref_id
string

ID generated from your system passed to ours that is the unique reference number for this order.

​
product_id
integer

This the product id of the product that you want to gift.

​
recipient_details
object[]

An array of information about the recipient.

​
variation_id
integer

The variation id of the product you would like to gift. Only needed if the product is a variable product.

Response

200 - application/json
​
order_data
object[]

An array containing the order values.

​
order_totals
object[]

An array containing the order totals.

​
status
integer

Detail on if the order was placed successfully. Will either be success or error

Retrieve a specific orderPlace a gifting order