/v23.1/Reservations
  • 05 Jun 2024
  • 3 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/Reservations

  • Dark
    Light
  • PDF

Article summary

Post
/v23.1/Reservations
Security
HTTP
Type Bearer

Please enter a valid token

Body parameters
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
taskId
integer (int32)
source
string
Valid values[ "NotSpecified", "ReceivedProducts" ]
receivedProductHeaderId
integer (int32)
inboundFileId
integer (int32)
customerId
integer (int32)
debtorId
integer (int32)
customerReference
string
saleOrderId
integer (int32)
departmentId
integer (int32)
pickupLocationId
integer (int32)
autoFulfilment
boolean
Default"False"
transportTypeId
integer (int32)
parcelLog
string
plannedDeliveryDate
string (date-time)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
status
string
Valid values[ "NotSpecified", "Open", "Printed", "ClosedByCashSale", "ClosedByInvoiceSale", "OrderPickingComplete", "OrderPickingInProgress", "OrderPickingVerified" ]
logisticsStatus
string
Valid values[ "NotSpecified", "New", "WaitingForPicking", "PickingInProgress", "PickingComplete", "ReadyForDelivery", "Delivered" ]
pickingVerified
boolean
Default"False"
deliveryVerified
boolean
Default"False"
deliveryVerificationNote
string
reservationNumber
integer (int32)
note
string
layawayLocation
string
printedDateTime
string (date-time)
closedDateTime
string (date-time)
notification1SentDateTime
string (date-time)
notification2SentDateTime
string (date-time)
notification3SentDateTime
string (date-time)
totalGrossPrice
number (double)
totalNetPrice
number (double)
cashOnDeliveryValue
number (double)
cashOnDeliveryPaidByCustomer
boolean
Default"False"
cashOnDeliveryDeposited
boolean
Default"False"
signatureImage
string (byte)
signatureDateTime
string (date-time)
signatureName
string
autoInvoiceSaleFailed
boolean
Default"False"
isCancelled
boolean
Default"False"
conversionId
integer (int64)
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
taskId
integer (int32)
source
string
Valid values[ "NotSpecified", "ReceivedProducts" ]
receivedProductHeaderId
integer (int32)
inboundFileId
integer (int32)
customerId
integer (int32)
debtorId
integer (int32)
customerReference
string
saleOrderId
integer (int32)
departmentId
integer (int32)
pickupLocationId
integer (int32)
autoFulfilment
boolean
Default"False"
transportTypeId
integer (int32)
parcelLog
string
plannedDeliveryDate
string (date-time)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
status
string
Valid values[ "NotSpecified", "Open", "Printed", "ClosedByCashSale", "ClosedByInvoiceSale", "OrderPickingComplete", "OrderPickingInProgress", "OrderPickingVerified" ]
logisticsStatus
string
Valid values[ "NotSpecified", "New", "WaitingForPicking", "PickingInProgress", "PickingComplete", "ReadyForDelivery", "Delivered" ]
pickingVerified
boolean
Default"False"
deliveryVerified
boolean
Default"False"
deliveryVerificationNote
string
reservationNumber
integer (int32)
note
string
layawayLocation
string
printedDateTime
string (date-time)
closedDateTime
string (date-time)
notification1SentDateTime
string (date-time)
notification2SentDateTime
string (date-time)
notification3SentDateTime
string (date-time)
totalGrossPrice
number (double)
totalNetPrice
number (double)
cashOnDeliveryValue
number (double)
cashOnDeliveryPaidByCustomer
boolean
Default"False"
cashOnDeliveryDeposited
boolean
Default"False"
signatureImage
string (byte)
signatureDateTime
string (date-time)
signatureName
string
autoInvoiceSaleFailed
boolean
Default"False"
isCancelled
boolean
Default"False"
conversionId
integer (int64)
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
taskId
integer (int32)
source
string
Valid values[ "NotSpecified", "ReceivedProducts" ]
receivedProductHeaderId
integer (int32)
inboundFileId
integer (int32)
customerId
integer (int32)
debtorId
integer (int32)
customerReference
string
saleOrderId
integer (int32)
departmentId
integer (int32)
pickupLocationId
integer (int32)
autoFulfilment
boolean
Default"False"
transportTypeId
integer (int32)
parcelLog
string
plannedDeliveryDate
string (date-time)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
status
string
Valid values[ "NotSpecified", "Open", "Printed", "ClosedByCashSale", "ClosedByInvoiceSale", "OrderPickingComplete", "OrderPickingInProgress", "OrderPickingVerified" ]
logisticsStatus
string
Valid values[ "NotSpecified", "New", "WaitingForPicking", "PickingInProgress", "PickingComplete", "ReadyForDelivery", "Delivered" ]
pickingVerified
boolean
Default"False"
deliveryVerified
boolean
Default"False"
deliveryVerificationNote
string
reservationNumber
integer (int32)
note
string
layawayLocation
string
printedDateTime
string (date-time)
closedDateTime
string (date-time)
notification1SentDateTime
string (date-time)
notification2SentDateTime
string (date-time)
notification3SentDateTime
string (date-time)
totalGrossPrice
number (double)
totalNetPrice
number (double)
cashOnDeliveryValue
number (double)
cashOnDeliveryPaidByCustomer
boolean
Default"False"
cashOnDeliveryDeposited
boolean
Default"False"
signatureImage
string (byte)
signatureDateTime
string (date-time)
signatureName
string
autoInvoiceSaleFailed
boolean
Default"False"
isCancelled
boolean
Default"False"
conversionId
integer (int64)
Responses
200

Success

object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
taskId
integer (int32)
source
string
Valid values[ "NotSpecified", "ReceivedProducts" ]
receivedProductHeaderId
integer (int32)
inboundFileId
integer (int32)
customerId
integer (int32)
debtorId
integer (int32)
customerReference
string
saleOrderId
integer (int32)
departmentId
integer (int32)
pickupLocationId
integer (int32)
autoFulfilment
boolean
Default"False"
transportTypeId
integer (int32)
parcelLog
string
plannedDeliveryDate
string (date-time)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
status
string
Valid values[ "NotSpecified", "Open", "Printed", "ClosedByCashSale", "ClosedByInvoiceSale", "OrderPickingComplete", "OrderPickingInProgress", "OrderPickingVerified" ]
logisticsStatus
string
Valid values[ "NotSpecified", "New", "WaitingForPicking", "PickingInProgress", "PickingComplete", "ReadyForDelivery", "Delivered" ]
pickingVerified
boolean
Default"False"
deliveryVerified
boolean
Default"False"
deliveryVerificationNote
string
reservationNumber
integer (int32)
note
string
layawayLocation
string
printedDateTime
string (date-time)
closedDateTime
string (date-time)
notification1SentDateTime
string (date-time)
notification2SentDateTime
string (date-time)
notification3SentDateTime
string (date-time)
totalGrossPrice
number (double)
totalNetPrice
number (double)
cashOnDeliveryValue
number (double)
cashOnDeliveryPaidByCustomer
boolean
Default"False"
cashOnDeliveryDeposited
boolean
Default"False"
signatureImage
string (byte)
signatureDateTime
string (date-time)
signatureName
string
autoInvoiceSaleFailed
boolean
Default"False"
isCancelled
boolean
Default"False"
conversionId
integer (int64)
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
taskId
integer (int32)
source
string
Valid values[ "NotSpecified", "ReceivedProducts" ]
receivedProductHeaderId
integer (int32)
inboundFileId
integer (int32)
customerId
integer (int32)
debtorId
integer (int32)
customerReference
string
saleOrderId
integer (int32)
departmentId
integer (int32)
pickupLocationId
integer (int32)
autoFulfilment
boolean
Default"False"
transportTypeId
integer (int32)
parcelLog
string
plannedDeliveryDate
string (date-time)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
status
string
Valid values[ "NotSpecified", "Open", "Printed", "ClosedByCashSale", "ClosedByInvoiceSale", "OrderPickingComplete", "OrderPickingInProgress", "OrderPickingVerified" ]
logisticsStatus
string
Valid values[ "NotSpecified", "New", "WaitingForPicking", "PickingInProgress", "PickingComplete", "ReadyForDelivery", "Delivered" ]
pickingVerified
boolean
Default"False"
deliveryVerified
boolean
Default"False"
deliveryVerificationNote
string
reservationNumber
integer (int32)
note
string
layawayLocation
string
printedDateTime
string (date-time)
closedDateTime
string (date-time)
notification1SentDateTime
string (date-time)
notification2SentDateTime
string (date-time)
notification3SentDateTime
string (date-time)
totalGrossPrice
number (double)
totalNetPrice
number (double)
cashOnDeliveryValue
number (double)
cashOnDeliveryPaidByCustomer
boolean
Default"False"
cashOnDeliveryDeposited
boolean
Default"False"
signatureImage
string (byte)
signatureDateTime
string (date-time)
signatureName
string
autoInvoiceSaleFailed
boolean
Default"False"
isCancelled
boolean
Default"False"
conversionId
integer (int64)
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
taskId
integer (int32)
source
string
Valid values[ "NotSpecified", "ReceivedProducts" ]
receivedProductHeaderId
integer (int32)
inboundFileId
integer (int32)
customerId
integer (int32)
debtorId
integer (int32)
customerReference
string
saleOrderId
integer (int32)
departmentId
integer (int32)
pickupLocationId
integer (int32)
autoFulfilment
boolean
Default"False"
transportTypeId
integer (int32)
parcelLog
string
plannedDeliveryDate
string (date-time)
cashSaleId
integer (int32)
invoiceSaleId
integer (int32)
status
string
Valid values[ "NotSpecified", "Open", "Printed", "ClosedByCashSale", "ClosedByInvoiceSale", "OrderPickingComplete", "OrderPickingInProgress", "OrderPickingVerified" ]
logisticsStatus
string
Valid values[ "NotSpecified", "New", "WaitingForPicking", "PickingInProgress", "PickingComplete", "ReadyForDelivery", "Delivered" ]
pickingVerified
boolean
Default"False"
deliveryVerified
boolean
Default"False"
deliveryVerificationNote
string
reservationNumber
integer (int32)
note
string
layawayLocation
string
printedDateTime
string (date-time)
closedDateTime
string (date-time)
notification1SentDateTime
string (date-time)
notification2SentDateTime
string (date-time)
notification3SentDateTime
string (date-time)
totalGrossPrice
number (double)
totalNetPrice
number (double)
cashOnDeliveryValue
number (double)
cashOnDeliveryPaidByCustomer
boolean
Default"False"
cashOnDeliveryDeposited
boolean
Default"False"
signatureImage
string (byte)
signatureDateTime
string (date-time)
signatureName
string
autoInvoiceSaleFailed
boolean
Default"False"
isCancelled
boolean
Default"False"
conversionId
integer (int64)
400

Bad Request

Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
401

Unauthorized

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403

Forbidden

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.