POST
/
api
/
order
curl --request POST \
  --url https://api.elliephant.com/api/order \
  --header 'API-KEY: <api-key>' \
  --header 'API-PASSWORD: <api-key>' \
  --header 'CLIENT-ID: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "order_ref_id": "<string>",
  "product_id": 123,
  "variation_id": 123,
  "currency": "<string>",
  "base_location": "<string>",
  "recipient_details": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone_number": "<string>",
      "delivery_address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "suburb": "<string>",
        "state": "<string>",
        "postcode_zipcode": "<string>",
        "country": "<string>"
      }
    }
  ]
}'
{
  "status": "success",
  "order_data": {
    "order_id": 145,
    "order_number": "EO-00145"
  },
  "order_totals": {
    "currency": "AUD",
    "product_price": 110,
    "qty": 2,
    "subtotal": 242,
    "shipping_cost": 22,
    "order_fee": 9.68,
    "order_total": 251.68
  }
}

Authorizations

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

Body

application/json
​
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.

​
variation_id
integer

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

​
currency
string

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

​
base_location
string

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

​
recipient_details
object[]

An array of information about the recipient.

Response

200 - application/json
Successful response
​
status
integer

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

​
order_data
object[]

An array containing the order values.

​
order_totals
object[]

An array containing the order totals.