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
}

GET

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.

Show child attributes

orders.id

string

Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.

orders.source_id

string | null

Unique source ID of an existing order that will be linked to the redemption of this request.

orders.status

enum<string>

The order status.

Available options:

CREATED,

PAID,

CANCELED,

FULFILLED

orders.amount

integer

This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

orders.initial_amount

integer

This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

orders.discount_amount

integer

Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

orders.items_discount_amount

integer

Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

orders.total_discount_amount

integer

Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

orders.total_amount

integer

Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

orders.applied_discount_amount

integer

This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

orders.items_applied_discount_amount

integer

Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
sum(items, i => i.applied_discount_amount)

orders.total_applied_discount_amount

integer

Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount

orders.metadata

object

A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.

orders.object

enum<string>

default:order

The type of the object represented by JSON.

Available options:

order

orders.created_at

string<date-time>

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

Example:

"2021-12-22T10:13:06.487Z"

orders.updated_at

string<date-time> | null

Timestamp representing the date and time when the order was last updated in ISO 8601 format.

Example:

"2021-12-22T10:14:45.316Z"

orders.customer_id

string | null

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.

Example:

"cust_7iUa6ICKyU6gH40dBU25kQU1"

orders.referrer_id

string | null

Unique referrer ID.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

orders.customer

Customer Id · object

Show child attributes

orders.customer.id

string

required

A unique identifier of an existing customer.

orders.customer.object

enum<string>

default:customer

required

The type of the object represented by JSON.

Available options:

customer

orders.referrer

Referrer Id · object

Show child attributes

orders.referrer.id

string

required

A unique identifier of an existing customer.

orders.referrer.object

enum<string>

default:customer

required

The type of the object represented by JSON.

Available options:

customer

orders.redemptions

object

Show child attributes

orders.redemptions.{key}

Order Redemptions · object

Show child attributes

orders.redemptions.{key}.date

string<date-time>

Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format.

Example:

"2022-09-02T17:06:56.649Z"

orders.redemptions.{key}.rollback_id

string

Unique ID of the redemption rollback.

Example:

"rr_0c63c84eb78ee0a6c0"

orders.redemptions.{key}.rollback_date

string<date-time>

Timestamp representing the date and time when the redemption rollback was created. The value is shown in the ISO 8601 format.

Example:

"2023-01-31T14:18:37.150Z"

The source of the incentive.

Unique ID of the parent redemption.

Example:

"r_0ba186c4824e4881e1"

Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign.

orders.redemptions.{key}.stacked

string[]

Contains a list of unique IDs of child redemptions, which belong to the stacked incentives.

orders.redemptions.{key}.rollback_stacked

string[]

Lists the rollback redemption IDs of the particular child redemptions.

orders.items

Order Item Calculated · object[]

Array of items applied to the order. It can include up to 500 items.

Show child attributes

orders.items.object

enum<string>

default:order_item

required

The type of the object represented by JSON.

Available options:

order_item

orders.items.id

string

Unique identifier of the order line item.

orders.items.sku_id

string

Unique identifier of the SKU. It is assigned by Voucherify.

orders.items.product_id

string

Unique identifier of the product. It is assigned by Voucherify.

Used along with the source_id property, can be set to either sku or product.

Available options:

product,

sku

orders.items.source_id

string

The merchant's product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.

orders.items.quantity

integer

The quantity of the particular item in the cart.

orders.items.discount_quantity

integer

Number of dicounted items.

orders.items.initial_quantity

integer

A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity.

orders.items.amount

integer

The total amount of the order item (price * quantity).

orders.items.discount_amount

integer

Sum of all order-item-level discounts applied to the order.

orders.items.applied_discount_amount

integer

This field shows the order-level discount applied.

orders.items.applied_discount_quantity

integer

Number of the discounted items applied in the transaction.

orders.items.applied_quantity

integer

Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.

orders.items.applied_quantity_amount

integer

Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.

orders.items.initial_amount

integer

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.

orders.items.price

integer

Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

orders.items.subtotal_amount

integer

Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the amount.
subtotal_amount=amount-applied_discount_amount

orders.items.product

object

An object containing details of the related product.

Show child attributes

orders.items.product.id

string

A unique identifier that represents the product and is assigned by Voucherify.

orders.items.product.source_id

string

The merchant's product ID (if it is different than Voucherify's product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service.

orders.items.product.override

boolean

The override set to true is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system.

orders.items.product.name

string

Product name.

orders.items.product.metadata

object

A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.

orders.items.product.price

number

Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).

orders.items.sku

object

An object containing details of the related SKU.

Show child attributes

orders.items.sku.id

string

A unique identifier that represents the SKU and is assigned by Voucherify.

orders.items.sku.source_id

string

The merchant's SKU ID (if it is different than Voucherify's SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service.

orders.items.sku.override

boolean

orders.items.sku.sku

string

The SKU name.

orders.items.sku.price

number

SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).

orders.items.sku.metadata

object

A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.

orders.items.metadata

object

A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas.

total

integer

required

Total number of orders.

Order Calculated Object Get Order

⌘I

Introduction

Endpoints

Events

List Orders

Authorizations

Query Parameters

Response