Login
      Contents x
      /v23.1/Reservations
      • 05 Jun 2024
      • 4 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      /v23.1/Reservations

      • Updated on 05 Jun 2024
      • 4 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      Get
      /v23.1/Reservations
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      StoreId
      integer (int32)
      TaskId
      integer (int32)
      InboundFileId
      integer (int32)
      ReservationId
      integer (int32)
      CustomerId
      integer (int32)
      DebtorId
      integer (int32)
      SaleOrderId
      integer (int32)
      DepartmentId
      integer (int32)
      PickupLocationId
      integer (int32)
      LayawayLocation
      string
      TransportTypeId
      integer (int32)
      CashSaleId
      integer (int32)
      InvoiceSaleId
      integer (int32)
      ReservationNumber
      integer (int32)
      OrderPickingCarrierId
      integer (int32)
      Status
      array of string
      LogisticsStatus
      array of string
      PrintedDateTime
      string (date-time)
      ClosedDateTime
      string (date-time)
      IsDeliveredOnly
      string
      Valid values[ "All", "Yes", "No" ]
      SaleOrderExpectedDeliveryDateFrom
      string (date-time)
      SaleOrderExpectedDeliveryDateTo
      string (date-time)
      SaleOrderUtmostDeliveryDateFrom
      string (date-time)
      SaleOrderUtmostDeliveryDateTo
      string (date-time)
      SaleOrderReferenceCode
      string
      CreatedDateFrom
      string (date-time)
      CreatedDateTo
      string (date-time)
      PlannedDeliveryDateFrom
      string (date-time)
      PlannedDeliveryDateTo
      string (date-time)
      SignatureDateFrom
      string (date-time)
      SignatureDateTo
      string (date-time)
      SaleOrderClassId
      integer (int32)
      ParcelBarcode
      string
      OpenReservationsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      LogisticalOpenOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsIncludeEmptyExpectedDeliveryDate
      boolean
      IsIncludeEmptyUtmostDeliveryDate
      boolean
      ParcelServiceOnly
      string
      Valid values[ "All", "Yes", "No" ]
      ParcelAnnouncedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsCancelledOnly
      string
      Valid values[ "All", "Yes", "No" ]
      OnlyReservationsOfSaleOrdersWithDebtors
      string
      Valid values[ "All", "Yes", "No" ]
      PendingPrepaymentRequestsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      OnlyPaidInFull
      string
      Valid values[ "All", "Yes", "No" ]
      FullyNotified
      string
      Valid values[ "All", "Yes", "No" ]
      InOrderPickingProcess
      string
      Valid values[ "All", "Yes", "No" ]
      ExactOrderPicking
      string
      Valid values[ "All", "Yes", "No" ]
      DepartmentAssignedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      PickupLocationAssignedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      StoreLocationId
      integer (int32)
      CashOnDeliveryOnly
      string
      Valid values[ "All", "Yes", "No" ]
      CashOnDeliveryPaidOnly
      string
      Valid values[ "All", "Yes", "No" ]
      CashOnDeliveryDepositedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      PickingToVerifyOnly
      string
      Valid values[ "All", "Yes", "No" ]
      DeliveryToVerifyOnly
      string
      Valid values[ "All", "Yes", "No" ]
      WithPlannedDeliveryDateOnly
      string
      Valid values[ "All", "Yes", "No" ]
      DeliveryType
      string
      Valid values[ "NotSpecified", "Delivery", "Pickup" ]
      CreditSaleOrders
      string
      Valid values[ "All", "Yes", "No" ]
      AutoFulfilmentOnly
      string
      Valid values[ "All", "Yes", "No" ]
      AutoInvoiceSaleOnly
      string
      Valid values[ "All", "Yes", "No" ]
      AutoInvoiceSaleFailedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      ConversionId
      integer (int64)
      Offset
      integer (int32)
      RecordCount
      integer (int32)
      ItemId
      integer (int32)
      IncludeItemId
      integer (int32)
      ExcludeItemId
      integer (int32)
      ModifiedSinceDateTime
      string (date-time)
      Responses
      200

      Success

      Array of object
      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)
      customerName
      string
      customerNumber
      integer (int64)
      storeDescription
      string
      transportTypeDescription
      string
      transportTypeParcelServiceId
      integer (int32)
      transportTypeParcelServiceCarrierId
      integer (int32)
      transportType
      string
      Valid values[ "NotSpecified", "Delivery", "Pickup" ]
      transportProperties
      string
      saleOrderLeftOverNetPrice
      number (double)
      saleOrderDescription
      string
      saleOrderCancelled
      boolean
      Default"False"
      saleOrderExpectedDeliveryDate
      string (date-time)
      saleOrderUtmostDeliveryDate
      string (date-time)
      saleOrderNumber
      integer (int32)
      saleOrderReferenceCode
      string
      saleOrderLoyaltyCard
      string
      saleOrderType
      string
      Valid values[ "NotSpecified", "NormalSaleOrder", "BlanketOrder", "CreditOrder", "ResendOrder" ]
      parcelsCount
      integer (int32)
      debtorGeneralName
      string
      totalSaleOrderDeliveredReservationsValue
      number (double)
      totalSaleOrderWeightedNetPrice
      number (double)
      totalPrePaid
      number (double)
      totalPrePaidBalance
      number (double)
      saleOrderWebshopDescription
      string
      webshopFallbackDebtorId
      integer (int32)
      saleOrderClassDescription
      string
      dropshipmentFallbackDebtorId
      integer (int32)
      applyWholePrePayment
      boolean
      Default"False"
      webshopId
      integer (int32)
      autoCreateInvoiceSales
      boolean
      Default"False"
      departmentDescription
      string
      inboundFileNumber
      integer (int32)
      inboundFileName
      string
      cashOnDeliveryPossible
      boolean
      Default"False"
      cashOnDeliveryProductId
      integer (int32)
      pickupLocationDescription
      string
      transportDeclarationRequired
      boolean
      Default"False"
      Array of object
      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)
      customerName
      string
      customerNumber
      integer (int64)
      storeDescription
      string
      transportTypeDescription
      string
      transportTypeParcelServiceId
      integer (int32)
      transportTypeParcelServiceCarrierId
      integer (int32)
      transportType
      string
      Valid values[ "NotSpecified", "Delivery", "Pickup" ]
      transportProperties
      string
      saleOrderLeftOverNetPrice
      number (double)
      saleOrderDescription
      string
      saleOrderCancelled
      boolean
      Default"False"
      saleOrderExpectedDeliveryDate
      string (date-time)
      saleOrderUtmostDeliveryDate
      string (date-time)
      saleOrderNumber
      integer (int32)
      saleOrderReferenceCode
      string
      saleOrderLoyaltyCard
      string
      saleOrderType
      string
      Valid values[ "NotSpecified", "NormalSaleOrder", "BlanketOrder", "CreditOrder", "ResendOrder" ]
      parcelsCount
      integer (int32)
      debtorGeneralName
      string
      totalSaleOrderDeliveredReservationsValue
      number (double)
      totalSaleOrderWeightedNetPrice
      number (double)
      totalPrePaid
      number (double)
      totalPrePaidBalance
      number (double)
      saleOrderWebshopDescription
      string
      webshopFallbackDebtorId
      integer (int32)
      saleOrderClassDescription
      string
      dropshipmentFallbackDebtorId
      integer (int32)
      applyWholePrePayment
      boolean
      Default"False"
      webshopId
      integer (int32)
      autoCreateInvoiceSales
      boolean
      Default"False"
      departmentDescription
      string
      inboundFileNumber
      integer (int32)
      inboundFileName
      string
      cashOnDeliveryPossible
      boolean
      Default"False"
      cashOnDeliveryProductId
      integer (int32)
      pickupLocationDescription
      string
      transportDeclarationRequired
      boolean
      Default"False"
      Array of object
      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)
      customerName
      string
      customerNumber
      integer (int64)
      storeDescription
      string
      transportTypeDescription
      string
      transportTypeParcelServiceId
      integer (int32)
      transportTypeParcelServiceCarrierId
      integer (int32)
      transportType
      string
      Valid values[ "NotSpecified", "Delivery", "Pickup" ]
      transportProperties
      string
      saleOrderLeftOverNetPrice
      number (double)
      saleOrderDescription
      string
      saleOrderCancelled
      boolean
      Default"False"
      saleOrderExpectedDeliveryDate
      string (date-time)
      saleOrderUtmostDeliveryDate
      string (date-time)
      saleOrderNumber
      integer (int32)
      saleOrderReferenceCode
      string
      saleOrderLoyaltyCard
      string
      saleOrderType
      string
      Valid values[ "NotSpecified", "NormalSaleOrder", "BlanketOrder", "CreditOrder", "ResendOrder" ]
      parcelsCount
      integer (int32)
      debtorGeneralName
      string
      totalSaleOrderDeliveredReservationsValue
      number (double)
      totalSaleOrderWeightedNetPrice
      number (double)
      totalPrePaid
      number (double)
      totalPrePaidBalance
      number (double)
      saleOrderWebshopDescription
      string
      webshopFallbackDebtorId
      integer (int32)
      saleOrderClassDescription
      string
      dropshipmentFallbackDebtorId
      integer (int32)
      applyWholePrePayment
      boolean
      Default"False"
      webshopId
      integer (int32)
      autoCreateInvoiceSales
      boolean
      Default"False"
      departmentDescription
      string
      inboundFileNumber
      integer (int32)
      inboundFileName
      string
      cashOnDeliveryPossible
      boolean
      Default"False"
      cashOnDeliveryProductId
      integer (int32)
      pickupLocationDescription
      string
      transportDeclarationRequired
      boolean
      Default"False"
      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
      404

      Not Found

      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?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      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.
      Logout