Skip to main content
GET
/
v1
/
orders
List Orders
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "object": "list",
  "data_ref": "orders",
  "orders": [
    {
      "id": "ord_v5vupdacgud1CwUSyKqSlHuk",
      "source_id": null,
      "created_at": "2022-09-09T07:44:41.594Z",
      "updated_at": "2022-09-09T07:44:42.331Z",
      "status": "PAID",
      "amount": 2700,
      "discount_amount": 1243,
      "items_discount_amount": 270,
      "total_discount_amount": 1513,
      "total_amount": 1187,
      "items": [
        {
          "object": "order_item",
          "source_id": "prod_5h1pp1ng",
          "related_object": "product",
          "quantity": 1,
          "amount": 700,
          "discount_amount": 70,
          "price": 700,
          "subtotal_amount": 630,
          "product": {
            "name": "Shipping"
          }
        },
        {
          "object": "order_item",
          "source_id": "roses_1",
          "related_object": "product",
          "quantity": 1,
          "amount": 500,
          "discount_amount": 50,
          "price": 500,
          "subtotal_amount": 450,
          "product": {
            "name": "Bouquet - Romantic Roses",
            "price": 500
          }
        },
        {
          "object": "order_item",
          "source_id": "vase_1",
          "related_object": "product",
          "quantity": 1,
          "amount": 1500,
          "discount_amount": 150,
          "price": 1500,
          "subtotal_amount": 1350,
          "product": {
            "name": "Vase - Boho Vintage",
            "price": 1500
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_tAED42tFhLM9v7GmZUaklJFd",
        "object": "customer"
      },
      "customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
      "referrer_id": null,
      "object": "order",
      "redemptions": {
        "r_0baa093537528ef645": {
          "date": "2022-09-09T07:44:41.695Z",
          "related_object_type": "redemption",
          "related_object_id": "r_0baa093537528ef645",
          "stacked": [
            "r_0baa093537528ef646",
            "r_0baa093537528ef647",
            "r_0baa093537528ef648"
          ]
        }
      }
    },
    {
      "id": "ord_3JkWC6jG0JgyRf5lO3r4IyU1",
      "source_id": null,
      "created_at": "2022-09-09T07:04:22.597Z",
      "updated_at": "2022-09-09T07:04:23.743Z",
      "status": "PAID",
      "amount": 73100,
      "items_discount_amount": 7310,
      "total_discount_amount": 7310,
      "total_amount": 65790,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0b7d7c4e814be5c502",
          "quantity": 1,
          "amount": 70000,
          "discount_amount": 7000,
          "price": 70000,
          "subtotal_amount": 63000,
          "product": {
            "name": "Apple iPhone 12",
            "price": 70000
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b7d7dfb05cbe5c616",
          "sku_id": "sku_0b7d7dfb090be5c619",
          "quantity": 1,
          "amount": 1600,
          "discount_amount": 160,
          "price": 1600,
          "subtotal_amount": 1440,
          "product": {
            "name": "Comic Books1",
            "price": 1600
          },
          "sku": {
            "sku": "Comics1",
            "price": 1600
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b72b0bd64d198e3ae",
          "quantity": 1,
          "amount": 1500,
          "discount_amount": 150,
          "price": 1500,
          "subtotal_amount": 1350,
          "product": {
            "name": "Vase - Boho Vintage",
            "price": 1500
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_tAED42tFhLM9v7GmZUaklJFd",
        "object": "customer"
      },
      "customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
      "referrer_id": null,
      "object": "order",
      "redemptions": {
        "r_0ba9fffae90e1b2495": {
          "date": "2022-09-09T07:04:22.692Z",
          "related_object_type": "voucher",
          "related_object_id": "v_24rljiUfdLNC9poBf0BPNmoh2txzFkLs"
        }
      }
    },
    {
      "id": "ord_HwdbziIPvUZJkIC7z74FKmPv",
      "source_id": null,
      "created_at": "2022-09-09T06:47:14.195Z",
      "updated_at": "2022-09-09T06:47:15.369Z",
      "status": "PAID",
      "amount": 71600,
      "discount_amount": 7160,
      "total_discount_amount": 7160,
      "total_amount": 64440,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0b7d7dfb05cbe5c616",
          "sku_id": "sku_0b7d7dfb090be5c619",
          "quantity": 1,
          "amount": 1600,
          "price": 1600,
          "subtotal_amount": 1600,
          "product": {
            "name": "Comic Books1",
            "price": 1600
          },
          "sku": {
            "sku": "Comics1",
            "price": 1600
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b7d7c4e814be5c502",
          "quantity": 1,
          "amount": 70000,
          "price": 70000,
          "subtotal_amount": 70000,
          "product": {
            "name": "Apple iPhone 12",
            "price": 70000
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_tAED42tFhLM9v7GmZUaklJFd",
        "object": "customer"
      },
      "customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
      "referrer_id": null,
      "object": "order",
      "redemptions": {
        "r_0ba9fc0eb00e1b2230": {
          "date": "2022-09-09T06:47:14.369Z",
          "related_object_type": "voucher",
          "related_object_id": "v_3vEprqa6tbzfhFtpjr4mDlkNchXepW7s"
        }
      }
    },
    {
      "id": "ord_HRluwFS2seoILUkXxWML0D7Z",
      "source_id": null,
      "created_at": "2022-09-09T06:44:27.383Z",
      "updated_at": "2022-09-09T06:44:28.252Z",
      "status": "PAID",
      "amount": 71600,
      "discount_amount": 100,
      "total_discount_amount": 100,
      "total_amount": 71500,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0b7d7dfb05cbe5c616",
          "sku_id": "sku_0b7d7dfb090be5c619",
          "quantity": 1,
          "amount": 1600,
          "price": 1600,
          "subtotal_amount": 1600,
          "product": {
            "name": "Comic Books1",
            "price": 1600
          },
          "sku": {
            "sku": "Comics1",
            "price": 1600
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b7d7c4e814be5c502",
          "quantity": 1,
          "amount": 70000,
          "price": 70000,
          "subtotal_amount": 70000,
          "product": {
            "name": "Apple iPhone 12",
            "price": 70000
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_tAED42tFhLM9v7GmZUaklJFd",
        "object": "customer"
      },
      "referrer": {
        "id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
        "object": "customer"
      },
      "customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
      "referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
      "object": "order",
      "redemptions": {
        "r_0ba9fb6bb7928ed9ec": {
          "date": "2022-09-09T06:44:27.486Z",
          "related_object_type": "voucher",
          "related_object_id": "v_vhHuiEmZSchWHtE0xKm0HM7PFCR9cNkA",
          "related_object_parent_id": "camp_rRsfatlwN7unSeUIJDCYedal"
        }
      }
    },
    {
      "id": "ord_Qg5utCohAZ3tafYvc1O4C80r",
      "source_id": null,
      "created_at": "2022-09-09T06:42:34.083Z",
      "updated_at": "2022-09-09T06:42:35.169Z",
      "status": "PAID",
      "amount": 70000,
      "discount_amount": 4000,
      "total_discount_amount": 4000,
      "total_amount": 66000,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0b7d7c4e814be5c502",
          "quantity": 1,
          "amount": 70000,
          "price": 70000,
          "subtotal_amount": 70000,
          "product": {
            "name": "Apple iPhone 12",
            "price": 70000
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_tAED42tFhLM9v7GmZUaklJFd",
        "object": "customer"
      },
      "customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
      "referrer_id": null,
      "object": "order",
      "redemptions": {
        "r_0ba9fafd11d28ed999": {
          "date": "2022-09-09T06:42:34.183Z",
          "related_object_type": "voucher",
          "related_object_id": "v_RaMaTT7F0Q47BetdGcFxsyqwo1aZGzJs",
          "related_object_parent_id": "camp_hg7ajfHh6DcE1xa18mw3SdF6"
        }
      }
    },
    {
      "id": "ord_G9LBb5SOPa36pHdwxUvzkw4P",
      "source_id": null,
      "created_at": "2022-09-09T06:38:17.984Z",
      "updated_at": "2022-09-09T06:38:19.064Z",
      "status": "PAID",
      "amount": 4600,
      "items_discount_amount": 300,
      "total_discount_amount": 300,
      "total_amount": 4300,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0b7d7dfb05cbe5c616",
          "sku_id": "sku_0b7d7dfb090be5c619",
          "quantity": 1,
          "amount": 1600,
          "price": 1600,
          "subtotal_amount": 1600,
          "product": {
            "name": "Comic Books1",
            "price": 1600
          },
          "sku": {
            "sku": "Comics1",
            "price": 1600
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0a65b3ff8592d7a5b5",
          "quantity": 1,
          "amount": 3000,
          "discount_amount": 300,
          "price": 3000,
          "subtotal_amount": 2700,
          "product": {
            "name": "Koffee Cup",
            "price": 3000
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_tAED42tFhLM9v7GmZUaklJFd",
        "object": "customer"
      },
      "customer_id": "cust_tAED42tFhLM9v7GmZUaklJFd",
      "referrer_id": null,
      "object": "order",
      "redemptions": {
        "r_0ba9fa02fcd28ed8f1": {
          "date": "2022-09-09T06:38:18.099Z",
          "related_object_type": "voucher",
          "related_object_id": "v_KqP2NOSb4dJb1D6UBhcq7ScPZXun0y40",
          "related_object_parent_id": "camp_hC2GdqYtOmTT45zfhib62cK1"
        }
      }
    },
    {
      "id": "ord_N3YBowDTZs0UH2hHoMZLbUDN",
      "source_id": null,
      "created_at": "2022-09-09T06:18:31.459Z",
      "updated_at": "2022-09-09T06:18:31.624Z",
      "status": "PAID",
      "amount": 71600,
      "discount_amount": 7160,
      "total_discount_amount": 7160,
      "total_amount": 64440,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0b7d7c4e814be5c502",
          "quantity": 1,
          "amount": 70000,
          "price": 70000,
          "subtotal_amount": 70000,
          "product": {
            "name": "Apple iPhone 12",
            "price": 70000
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b7d7dfb05cbe5c616",
          "sku_id": "sku_0b7d7dfb090be5c619",
          "quantity": 1,
          "amount": 1600,
          "price": 1600,
          "subtotal_amount": 1600,
          "product": {
            "name": "Comic Books1",
            "price": 1600
          },
          "sku": {
            "sku": "Comics1",
            "price": 1600
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
        "object": "customer"
      },
      "customer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
      "referrer_id": null,
      "object": "order",
      "redemptions": {
        "r_0ba9f57c37128ed639": {
          "date": "2022-09-09T06:18:31.516Z",
          "related_object_type": "promotion_tier",
          "related_object_id": "promo_CQonGnrsFAdEJfJQ3oKB3a8G",
          "related_object_parent_id": "camp_SGq39XXJ47vm7Xys3D0NLgQ0"
        }
      }
    },
    {
      "id": "ord_3R6vsxRZRkND8rpe0rAn9Agc",
      "source_id": null,
      "created_at": "2022-09-05T08:13:13.720Z",
      "updated_at": "2022-09-05T08:13:14.498Z",
      "status": "PAID",
      "amount": 74000,
      "items_discount_amount": 1500,
      "total_discount_amount": 1500,
      "total_amount": 72500,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0b7d7c4e814be5c502",
          "quantity": 1,
          "amount": 70000,
          "price": 70000,
          "subtotal_amount": 70000,
          "product": {
            "name": "Apple iPhone 12",
            "price": 70000
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b72b0bd64d198e3ae",
          "quantity": 2,
          "amount": 3000,
          "discount_amount": 500,
          "price": 1500,
          "subtotal_amount": 2500,
          "product": {
            "name": "Vase - Boho Vintage",
            "price": 1500
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b72b00ffed198e344",
          "quantity": 2,
          "amount": 1000,
          "discount_amount": 1000,
          "price": 500,
          "subtotal_amount": 0,
          "product": {
            "name": "Bouquet - Romantic Roses",
            "price": 500
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_CSnYd37MXmrbS19XCrghjBsv",
        "object": "customer"
      },
      "customer_id": "cust_CSnYd37MXmrbS19XCrghjBsv",
      "referrer_id": null,
      "object": "order",
      "redemptions": {
        "r_0ba4e961444579711a": {
          "date": "2022-09-05T08:13:13.873Z",
          "related_object_type": "voucher",
          "related_object_id": "v_hwySVBBk6YmMD4GzZHJzke1Fxo3QO7kP",
          "related_object_parent_id": "camp_Uji5a53s5wRSUHqznncTkhHh"
        }
      }
    },
    {
      "id": "ord_7bqlkoHyEJCQuxVZpKfZYNeA",
      "source_id": null,
      "created_at": "2022-09-02T17:12:13.213Z",
      "updated_at": "2022-09-02T17:12:13.969Z",
      "status": "PAID",
      "amount": 292400,
      "items_discount_amount": 900,
      "total_discount_amount": 900,
      "total_amount": 291500,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0b7d7dfb05cbe5c616",
          "sku_id": "sku_0b7d7dfb090be5c619",
          "quantity": 4,
          "amount": 6400,
          "price": 1600,
          "subtotal_amount": 6400,
          "product": {
            "name": "Comic Books1",
            "price": 1600
          },
          "sku": {
            "sku": "Comics1",
            "price": 1600
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b72b0bd64d198e3ae",
          "quantity": 4,
          "amount": 6000,
          "price": 1500,
          "subtotal_amount": 6000,
          "product": {
            "name": "Vase - Boho Vintage",
            "price": 1500
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b7d7c4e814be5c502",
          "quantity": 4,
          "amount": 280000,
          "discount_amount": 900,
          "price": 70000,
          "subtotal_amount": 279100,
          "product": {
            "name": "Apple iPhone 12",
            "price": 70000
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_CSnYd37MXmrbS19XCrghjBsv",
        "object": "customer"
      },
      "customer_id": "cust_CSnYd37MXmrbS19XCrghjBsv",
      "referrer_id": null,
      "object": "order",
      "redemptions": {
        "r_0ba187f9bb45792c13": {
          "date": "2022-09-02T17:12:13.293Z",
          "related_object_type": "voucher",
          "related_object_id": "v_pg6DhwhmeZASoSoJ15PdzMT9MhsPjYuc",
          "related_object_parent_id": "camp_W8DJVd8J0btqXT6FBwn7BSkC"
        }
      }
    },
    {
      "id": "ord_7HwbJiHmS07O7FsVAtjJcuRS",
      "source_id": null,
      "created_at": "2022-09-02T17:08:37.794Z",
      "updated_at": "2022-09-02T17:08:38.879Z",
      "status": "PAID",
      "amount": 223900,
      "items_discount_amount": 900,
      "total_discount_amount": 900,
      "total_amount": 223000,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0b7d7dfb05cbe5c616",
          "sku_id": "sku_0b7d7dfb090be5c619",
          "quantity": 4,
          "amount": 6400,
          "discount_amount": 300,
          "price": 1600,
          "subtotal_amount": 6100,
          "product": {
            "name": "Comic Books1",
            "price": 1600
          },
          "sku": {
            "sku": "Comics1",
            "price": 1600
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b7d7c4e814be5c502",
          "quantity": 3,
          "amount": 210000,
          "discount_amount": 300,
          "price": 70000,
          "subtotal_amount": 209700,
          "product": {
            "name": "Apple iPhone 12",
            "price": 70000
          }
        },
        {
          "object": "order_item",
          "product_id": "prod_0b72b0bd64d198e3ae",
          "quantity": 5,
          "amount": 7500,
          "discount_amount": 300,
          "price": 1500,
          "subtotal_amount": 7200,
          "product": {
            "name": "Vase - Boho Vintage",
            "price": 1500
          }
        }
      ],
      "metadata": {},
      "customer": {
        "id": "cust_CSnYd37MXmrbS19XCrghjBsv",
        "object": "customer"
      },
      "customer_id": "cust_CSnYd37MXmrbS19XCrghjBsv",
      "referrer_id": null,
      "object": "order",
      "redemptions": {
        "r_0ba1872762c5792b73": {
          "date": "2022-09-02T17:08:37.899Z",
          "related_object_type": "voucher",
          "related_object_id": "v_yQydppWWJpSUuGNEWJ4I2upFGY2Ma4IY",
          "related_object_parent_id": "camp_A5L21BD4cJii28882owYBqTV"
        }
      }
    }
  ],
  "total": 441
}

Authorizations

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

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
limit
integer

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

Required range: 1 <= x <= 100
​
page
integer

Which page of results to return. The lowest value is 1.

Required range: 1 <= x <= 100
​
order
enum<string>

This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Available options:
created_at,
-created_at,
updated_at,
-updated_at

Response

200 - application/json

Returns a dictionary with order objects. The orders are returned sorted by creation date by default, with the most recent orders appearing last, unless you specify another sequence using the order query parameter.

Response body schema representing GET v1/orders.

​
object
enum<string>
default:list
required

The type of the object represented by JSON. This object stores information about orders in a dictionary.

Available options:
list
​
data_ref
enum<string>
default:orders
required

Identifies the name of the attribute that contains the array of order objects.

Available options:
orders
​
orders
Order Calculated No Customer Data · object[]
required

Contains array of order objects.

​
total
integer
required

Total number of orders.

⌘I