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

The response is of type object.