GET
/
api
/
order
curl --request GET \
  --url https://api.elliephant.com/api/order \
  --header 'API-KEY: <api-key>' \
  --header 'API-PASSWORD: <api-key>' \
  --header 'CLIENT-ID: <api-key>'
{
  "order_id": "133",
  "order_number": "EO-00133",
  "order_date": "2024-05-08 11:50am",
  "order_status": "paid",
  "gift_order_method": "email",
  "gift_of_choice": "N",
  "branding_selected": "elliephant",
  "branding_options": {
    "branding_logo": "/assets/logos/email-logo.png",
    "branding_claim_logo": "/assets/logos/primary-logo-white.svg",
    "primary_color": "#FF0054",
    "secondary_color": "#9E0059"
  },
  "product_offered": {
    "product_id": "5737",
    "variation_id": null
  },
  "order_totals": {
    "currency": "USD",
    "product_price": "12.77",
    "qty": "3",
    "subtotal": "38.30",
    "shipping_cost": "19.01",
    "order_fee": "2.29",
    "order_total": "59.60"
  },
  "email_template": "celebration",
  "recipients": [
    {
      "suborder_id": 327,
      "suborder_number": "EO-00133-1",
      "recipient_details": {
        "name": "Johnny Tester",
        "email": "[email protected]",
        "email_message": "Thanks for the hard work",
        "delivery_address": {
          "address_line_1": null,
          "address_line_2": null,
          "suburb": null,
          "state": null,
          "postcode_zipcode": null,
          "country": null
        },
        "phone_number": "NA",
        "delivery_notes": null
      },
      "redemption_status": null,
      "product_selected": {
        "product_id": "5737",
        "variation_id": null
      }
    },
    {
      "suborder_id": 328,
      "suborder_number": "EO-00133-2",
      "recipient_details": {
        "name": "Joshua Smith",
        "email": "[email protected]",
        "email_message": "Thanks for the hard work",
        "delivery_address": {
          "address_line_1": "123 Example Street",
          "address_line_2": null,
          "suburb": "Example Town",
          "state": "Victoria",
          "postcode_zipcode": "9876",
          "country": "Australia"
        },
        "phone_number": "0412345678",
        "delivery_notes": null
      },
      "redemption_status": null,
      "product_selected": {
        "product_id": "5737",
        "variation_id": null
      }
    },
    {
      "suborder_id": 329,
      "suborder_number": "EO-00133-3",
      "recipient_details": {
        "name": "Jane Doe",
        "email": "[email protected]",
        "email_message": "Thanks for the hard work",
        "delivery_address": {
          "address_line_1": "123 Sample Street",
          "address_line_2": null,
          "suburb": "Sample Town",
          "state": "Victoria",
          "postcode_zipcode": "1234",
          "country": "Australia"
        },
        "phone_number": "NA",
        "delivery_notes": null
      },
      "redemption_status": null,
      "product_selected": {
        "product_id": "5737",
        "variation_id": null
      }
    }
  ]
}

Authorizations

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

Query Parameters

​
order_id
integer
required

Response

200 - application/json
Successful response
​
order_id
integer

The ID of the order in our system, this is the ID used to get the order details later.

​
order_number
string

The order number that is used for reference, this will be in the format EO-00000.

​
order_date
string

The date of the order placed in the format YYYY-MM-DD HH:MM.

​
order_status
string

The status of the order. This will be either failed, created, paid or cancieled.

​
gift_order_method
string

The method that order is placed or gifted. This will be either email, direct, link, api-purchase or api-giftlink.

​
link_how_many_times
string

Only sent if gift_order_method == link. The number of how many times the link can be redeemed

​
link_url
string

Only sent if gift_order_method == link. The URL used to redeem the gift.

​
link_message
string

Only sent if gift_order_method == link. The message included on the link redemption page

​
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

​
branding_selected
string

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

​
branding_options
object[]

An array containing the branding values.

​
product_offered
string

The original product offered. This will be an array containing product_id and variation_id. This connects to the product id and variation id retreved in the GET/api/product/:id method.

​
order_totals
object[]

An array containing the order totals.

​
email_template
string

The template used for the emails sent. This could be either celebration, generic, sympathy or christmas. This can only be set if placed on the store.

​
recipients
object[]

An array containing the recipient details.