Skip to main content
GET
/
v1
/
orders
/
{orderId}
Get Order
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/orders/{orderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "<string>",
  "source_id": "<string>",
  "status": "CREATED",
  "amount": 123,
  "initial_amount": 123,
  "discount_amount": 123,
  "items_discount_amount": 123,
  "total_discount_amount": 123,
  "total_amount": 123,
  "applied_discount_amount": 123,
  "items_applied_discount_amount": 123,
  "total_applied_discount_amount": 123,
  "metadata": {},
  "object": "order",
  "created_at": "2021-12-22T10:13:06.487Z",
  "updated_at": "2021-12-22T10:14:45.316Z",
  "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
  "referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
  "customer": {
    "id": "<string>",
    "object": "customer"
  },
  "referrer": {
    "id": "<string>",
    "object": "customer"
  },
  "redemptions": {},
  "items": [
    {
      "id": "<string>",
      "sku_id": "<string>",
      "product_id": "<string>",
      "related_object": "product",
      "source_id": "<string>",
      "quantity": 123,
      "discount_quantity": 123,
      "initial_quantity": 123,
      "amount": 123,
      "discount_amount": 123,
      "applied_discount_amount": 123,
      "applied_discount_quantity": 123,
      "applied_quantity": 123,
      "applied_quantity_amount": 123,
      "initial_amount": 123,
      "price": 123,
      "subtotal_amount": 123,
      "product": {
        "id": "<string>",
        "source_id": "<string>",
        "override": true,
        "name": "<string>",
        "metadata": {},
        "price": 123
      },
      "sku": {
        "id": "<string>",
        "source_id": "<string>",
        "override": true,
        "sku": "<string>",
        "price": 123,
        "metadata": {}
      },
      "object": "order_item",
      "metadata": {}
    }
  ]
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

orderId
string
required
Example:

Response

id
string
source_id
string | null
status
enum<string>
Available options:
CREATED,
PAID,
CANCELED,
FULFILLED
amount
integer
initial_amount
integer
discount_amount
integer
items_discount_amount
integer
total_discount_amount
integer
total_amount
integer
applied_discount_amount
integer
items_applied_discount_amount
integer
total_applied_discount_amount
integer
metadata
object
object
enum<string>
default:order
Available options:
order
created_at
string<date-time>
Example:
updated_at
string<date-time> | null
Example:
customer_id
string | null
Example:
referrer_id
string | null
Example:
customer
object
referrer
object
redemptions
object
items
Order Item Calculated · object[]