Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.67 KB

OrdersCreateRequestBody.md

File metadata and controls

36 lines (24 loc) · 1.67 KB

OrdersCreateRequestBody

Request body schema for POST /orders.

Properties

Name Type Description
id String Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
sourceId String Unique source ID of an existing order that will be linked to the redemption of this request.
status StatusEnum The order status.
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.
discountAmount Integer Sum of all order-level discounts applied to the order.
initialAmount 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.
items List<OrderItem> Array of items applied to the order.
customer Customer
customerId String Unique customer ID of the customer making the purchase.
referrer Referrer
referrerId String Unique referrer ID.
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.

Enum: StatusEnum

Name Value
CREATED "CREATED"
PAID "PAID"
CANCELED "CANCELED"
FULFILLED "FULFILLED"