Parameters
JSON body
Request body
application/jsonwarehouseIdnumberRequiredlocationIdnumber | nullOptionalOne of 2:
Variant 1
number
Variant 2
null
productCodestring | nullOptionalHuman-readable product code (mutually exclusive with virtualItemSku).
One of 2:
Variant 1
string
Length: 0–64
Variant 2
null
productVariantCodestring | nullOptionalVariant code, requires productCode.
One of 2:
Variant 1
string
Length: 0–64
Variant 2
null
virtualItemSkustring | nullOptionalFree-form virtual SKU for non-catalogue items.
One of 2:
Variant 1
string
Length: 0–100
Variant 2
null
quantitynumberRequiredRange: 1–∞
mode"soft" | "hard"OptionalorderIdnumber | nullOptionalOne of 2:
Variant 1
number
Variant 2
null
orderItemIdnumber | nullOptionalOne of 2:
Variant 1
number
Variant 2
null
externalKeystring | nullOptionalOne of 2:
Variant 1
string
Length: 0–120
Variant 2
null
expiresAtstring | nullOptionalOne of 2:
Variant 1
string
ISO datetime; required for soft reservations to be auto-released.
Variant 2
null
idempotencyKeystring | nullOptionalOne of 2:
Variant 1
string
Length: 0–80
Variant 2
null
notestring | nullOptionalOne of 2:
Variant 1
string
Variant 2
null
performedByMemberIdnumber | nullOptionalOne of 2:
Variant 1
number
Variant 2
null