POST
/
api
/
gift-link
curl --request POST \
  --url https://api.elliephant.com/api/gift-link \
  --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>",
  "gift_of_choice": "<string>",
  "order_branding": "<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": 152,
    "order_number": "EO-00152"
  },
  "order_totals": {
    "currency": "AUD",
    "product_price": 110,
    "qty": 2,
    "shipping_cost": 22,
    "subtotal": 242,
    "order_fee": 9.68,
    "order_total": 251.68
  },
  "recipient_return": [
    {
      "suborder_id": 357,
      "suborder_number": "EO-00152-1",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "gift_url": "https://elliephantv2.com/redeem-your-gift/bfb7f903acf87bfea4c9698f3e2a6138"
    },
    {
      "suborder_id": 358,
      "suborder_number": "EO-00152-2",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "gift_url": "https://elliephantv2.com/redeem-your-gift/a5c7ba3d3d4c7250ccc3191a938030d5"
    }
  ]
}

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.

​
gift_of_choice
string

An option if you want your user to have an option to choose a different gift as a gift of choice. This is either a Y or N.

​
order_branding
string

The type of branding that you are want for your gift link. This is either elliephant or company. company can only be used if your company branding as been set in your company profile.

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

​
recipient_return
object[]

An array containing the recipient details.