Update Order

put https://{cluster}.voucherify.io/v1/orders/{orderId}

Updates the specified order by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.

Path Params

orderId

string

required

Unique Voucherify order ID or order source ID.

Body Params

Specify the parameters of the order that are to be updated.

source_id

string | null

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

status

string

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.

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.

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).

items

array of objects

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

items

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.

created_at

date-time

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

referrer_id

string | null

Unique referrer ID.

customer

object

referrer

object

Response

Response body

object

string

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

source_id

string | null

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

status

string

The order status.

CREATED PAID CANCELED FULFILLED

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).

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).

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).

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).

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).

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).

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).

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)

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

metadata

object

Has additional fields

object

string

Defaults to order

The type of the object represented by JSON.

order

created_at

date-time

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

updated_at

date-time | null

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

customer_id

string | null

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

referrer_id

string | null

Unique referrer ID.

customer

object

string

required

A unique identifier of an existing customer.

object

string

required

Defaults to customer

The type of the object represented by JSON.

customer

referrer

object

string

required

A unique identifier of an existing customer.

object

string

required

Defaults to customer

The type of the object represented by JSON.

customer

redemptions

object

items

array of objects

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

items

object

string

Unique identifier of the order line item.

sku_id

string

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

product_id

string

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

related_object

string

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

product sku

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.

quantity

integer

The quantity of the particular item in the cart.

discount_quantity

integer

Number of dicounted 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.

amount

integer

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

discount_amount

integer

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

applied_discount_amount

integer

This field shows the order-level discount applied.

applied_discount_quantity

integer

Number of the discounted items applied in the transaction.

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.

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.

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.

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.

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

product

object

An object containing details of the related product.

sku

object

An object containing details of the related SKU.

object

string

required

Defaults to order_item

The type of the object represented by JSON.

order_item

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.

Has additional fields

Language

Credentials

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.voucherify.io/v1/orders/orderId \
3
     --header 'X-Voucherify-Channel: Voucherify Documentation' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the order object if the update succeeded.