Create an order or reservation

post

https://sbx-api.vaultn.com/api/v4/order/Create

Creates an order with the details provided in the request and returns the order details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Please also check Order Status Definitions and possible Error Codes during the integration process.

For response body only, kindly refer here.

Body Params

sku

string

required

VaultN Sku that defines the product, platform and region. (e.g., "DEMO-GA-STE-DEMOPRODUC-STA-ROWDP")

ipAddress

string

required

The end consumer's IPv4 address, used for determining the country.

currencyCode

string

required

Defines the currency (ISO 4217) in which the order is made. (e.g., "USD", "EUR")

salesPriceGross

double

required

Sales price to end customer incl VAT. (e.g., 24.99)

salesPriceNet

double

Sales price to end customer excluding VAT. (e.g., 19.99)

appliedDiscountPercentage

double

Defaults to 0

Applied discount in percentage (in double) applied by the retailer.

appliedDiscountAmount

double

Defaults to 0

The amount of the discount applied to the order.

clientOrderReference

string

Defaults to ""

Retailer's unique reference for the order.

clientCustomerReference

string

Defaults to ""

Retailer's anonymized unique reference to the end customer.

agreementGUID

string

Defines the agreement under which the order is made. Made optional with v4, recommended not to be used. (e.g., for Default(Network) -> "A8E06965-0A11-468E-BBD6-C4578993D1E8")

priceListGuid

string

Optional reference to a specific price list shared by the connected vault. Currently only a single price list can be assigned to a connected vault. Included for future multi-price support. (e.g., "71ED8B8F-6F7B-4F1B-963D-6B8F5AE8C674")

immediateFulfilment

boolean

Defaults to false

When set to true, every order completion immediately decrypts and exposes the key, or the activation link, and sets the order status to fulfilled. When false, completed orders do not expose the key, or the activation link, until explicitly requested so. When not specified in a request the default value is false.

mustFulfil

boolean

Defaults to false

When set true, the Sku must have inventory available to be completed. If the requested Sku is out of stock or unavailable for any reason, the order is then canceled. If provided as false, orders are allowed to proceed to backOrder status to be completed later when inventory is made available. When not specified in a request the default value is false.

salesCountryCode

string

Alpha-2 code for the reported country of sales. Used for addressing VPN related difficulties resolving provided ipAddress. It is strongly advisable to provide this parameter. (e.g., "BE", "NL", "US")

orderType

int32

required

Defaults to 1

An enumeration that defines if the request is an order or a reservation. 1 for order, 5 for reservation.

keylessSuccessEndPoint

string

This parameter is related to Keyless orders. It defines the redirectUrl required for successful auth attempts made to the asset

keylessFailureEndPoint

string

This parameter is related to Keyless orders. It defines the redirectUrl required for unsuccessful auth attempts made to the asset

Headers

Bearer

string

required

Auth token