Skip to main content
POST
/
v1
/
orders
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "amount": 20000,
  "customer": {
    "source_id": "sample_customer"
  },
  "status": "PAID",
  "items": [
    {
      "quantity": 1,
      "price": 20000,
      "source_id": "sample product1",
      "related_object": "product",
      "product": {
        "metadata": {
          "key": "value"
        }
      }
    }
  ]
}'
{
  "id": "ord_cRKOEXiBOj0EZKF7g9n6l0eH",
  "source_id": "new",
  "created_at": "2022-09-09T09:20:01.660Z",
  "updated_at": "2022-09-09T09:24:43.604Z",
  "status": "FULFILLED",
  "amount": 121700,
  "total_amount": 121700,
  "items": [
    {
      "object": "order_item",
      "source_id": "prod_1",
      "related_object": "product",
      "quantity": 2,
      "amount": 120000,
      "price": 60000,
      "subtotal_amount": 120000,
      "product": {
        "id": "prod_0b7d7c4e814be5c502",
        "source_id": "prod_1",
        "name": "Apple iPhone 12",
        "metadata": {
          "color": [
            "purple"
          ],
          "vendor": "mall"
        },
        "price": 60000
      }
    },
    {
      "object": "order_item",
      "source_id": "ComicBook_1",
      "related_object": "sku",
      "product_id": "prod_0b7d7dfb05cbe5c616",
      "quantity": 1,
      "amount": 1700,
      "price": 1700,
      "subtotal_amount": 1700,
      "product": {
        "id": "prod_0b7d7dfb05cbe5c616",
        "source_id": "Books",
        "name": "Comic Books1",
        "metadata": {
          "color": [
            "silver"
          ],
          "vendor": "Bookstore1"
        },
        "price": 2100
      },
      "sku": {
        "id": "sku_0b7d7dfb090be5c619",
        "source_id": "ComicBook_1",
        "sku": "Comics1",
        "metadata": {
          "color": [
            "golden"
          ],
          "vendor": "islands"
        },
        "price": 1700
      }
    }
  ],
  "metadata": {
    "location_id": [
      "L1",
      "L2"
    ],
    "payment_mean": [
      "paypal",
      "credit-card"
    ]
  },
  "customer": {
    "id": "cust_H0nXrItO1DNV3UiPIl54HA5o",
    "object": "customer"
  },
  "referrer": {
    "id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
    "object": "customer"
  },
  "customer_id": "cust_H0nXrItO1DNV3UiPIl54HA5o",
  "referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
  "object": "order"
}

Authorizations

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

Body

application/json
​
created_at
string<date-time>
Example:
​
referrer_id
string | null
Example:
​
customer
object
​
referrer
object
​
id
string
​
source_id
string | null
​
status
enum<string>
Available options:
CREATED,
PAID,
CANCELED,
FULFILLED
​
amount
integer
​
initial_amount
integer
​
discount_amount
integer
​
items
Order Item · object[]
​
metadata
object

Response

200 - application/json
​
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[]