Create a redemption

post

https://admin.sandbox.vouchery.app/api/v2.1/vouchers/{code}/redemptions

Create a redemption.

Recipes

🛒

Creating a Redemption

Open Recipe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

code

string

required

Voucher code

Body Params

Redemption object. One of TotalTransactionCost or ProductItems must be present. If customer ID is skipped for voucher assigned to a customer, voucher is redeemed for the customer.

additional_categories

object

required

confirmed

boolean

required

Only confirmed redemption are counted towards budget and total number of redemptions

customer_identifier

string

Nullable. A string uniquely identifying customer in your system. Please check customers API.

product_items

array of objects

required

product_items*

shipping_cost

double

Nullable. Shipping cost

total_transaction_cost

double

Nullable. Total cost excluding shipping

transaction_id

string

Nullable. Unique transaction ID which identifies underlying transaction in your system, e.g. order number, invoice number

user_agent

string

Nullable. String or null.

Responses

200Created object

400Bad Request error.

401Unauthorized error.

403Forbidden error.

422Unprocessable entity error. Validation failed.

500Internal server error. Try again in a few minutes or contact support.