Create an order or reservation

post

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Details of the order

sku

string

required

VaultN SKU that defines the product, platform and region.

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.

salesPriceGross

double

required

Sales price to end customer including VAT.

salesPriceNet

double | null

Sales price to end customer excluding VAT.

appliedDiscountPercentage

double | null

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

appliedDiscountAmount

double | null

The amount of the discount applied to the order.

clientOrderReference

string | null

Retailer's unique reference for the order.

clientCustomerReference

string | null

Retailer's anonymized unique reference to the end customer.

agreementGUID

uuid | null

Defines the agreement under which the order is made. Made optional with v4, recommended not to be used.

priceListGuid

uuid | null

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.

immediateFulfilment

boolean

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

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 | null

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.

orderType

int32

enum

required

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

Allowed:

keylessSuccessEndPoint

string | null

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

keylessFailureEndPoint

string | null

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

Responses

200Order created

400Bad request

401Unauthorized - Authentication credentials are missing or invalid