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

      /v23.1/DeliveryOrders

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

      Get
      /v23.1/DeliveryOrders
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      StoreId
      integer (int32)
      Number
      integer (int32)
      CustomerId
      integer (int32)
      DeliveryAddressId
      integer (int32)
      ReservationId
      integer (int32)
      InvoiceId
      integer (int32)
      DeliveryOrderTypeId
      integer (int32)
      GeneralStatus
      string
      Valid values[ "NotSpecified", "New", "EnryCompleted", "Final", "Closed" ]
      LogisticsStatus
      string
      Valid values[ "NotSpecified", "DeliveryNotAllowed", "DeliveryAllowedWithRestrictions", "DeliveryAllowed" ]
      LogisticsStatusReason
      string
      Valid values[ "NotSpecified", "ReservationHandoutNotAllowed", "DeliveryOrderCostsNotPaid", "DeliveryOrderCancelled", "DeliveryOrderNotFinal", "RequiredInvoicesNotAllPaid", "SaleOrderReservationsIncomplete", "PartialDeliveryNotAllowed", "ExceptionOccurred" ]
      ParcelServiceId
      integer (int32)
      ParcelServiceCarrierId
      integer (int32)
      CreatedDateFrom
      string (date-time)
      CreatedDateTo
      string (date-time)
      RequestedDeliveryDateFrom
      string (date-time)
      RequestedDeliveryDateTo
      string (date-time)
      CashOnDeliveryDepositedOnlyCashSaleId
      integer (int32)
      CashOnDeliveryPaidOnly
      string
      Valid values[ "All", "Yes", "No" ]
      CashOnDeliveryDepositedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      PaidCostsCashSaleId
      integer (int32)
      PaidCostsInvoiceId
      integer (int32)
      HandoutDateTimeFrom
      string (date-time)
      HandoutDateTimeTo
      string (date-time)
      CustomsInvoiceNumber
      string
      CustomsShipmentType
      string
      Valid values[ "NotSpecified", "Gift", "Documents", "CommercialGoods", "CommercialSample", "ReturnedGoods" ]
      ScheduledOnly
      string
      Valid values[ "All", "Yes", "No" ]
      FailedButAvailableForDeliveryOnly
      string
      Valid values[ "All", "Yes", "No" ]
      CancelledOnly
      string
      Valid values[ "All", "Yes", "No" ]
      OpenOnly
      string
      Valid values[ "All", "Yes", "No" ]
      ExportedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      ToDeliveryProviderOnly
      string
      Valid values[ "All", "Yes", "No" ]
      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)
      number
      integer (int32)
      euShipment
      boolean
      Default"False"
      customerId
      integer (int32)
      deliveryAddressId
      integer (int32)
      deliveryMinutes
      integer (int32)
      reservationId
      integer (int32)
      deliveryOrderTypeId
      integer (int32)
      generalStatus
      string
      Valid values[ "NotSpecified", "New", "EnryCompleted", "Final", "Closed" ]
      logisticsStatus
      string
      Valid values[ "NotSpecified", "DeliveryNotAllowed", "DeliveryAllowedWithRestrictions", "DeliveryAllowed" ]
      logisticsStatusReason
      string
      Valid values[ "NotSpecified", "ReservationHandoutNotAllowed", "DeliveryOrderCostsNotPaid", "DeliveryOrderCancelled", "DeliveryOrderNotFinal", "RequiredInvoicesNotAllPaid", "SaleOrderReservationsIncomplete", "PartialDeliveryNotAllowed", "ExceptionOccurred" ]
      parcelServiceId
      integer (int32)
      parcelServiceCarrierId
      integer (int32)
      requestedDeliveryDate
      string (date-time)
      exportDateTime
      string (date-time)
      cashOnDeliveryValue
      number (double)
      cashOnDeliveryPaid
      boolean
      Default"False"
      cashOnDeliveryDeposited
      boolean
      Default"False"
      cashOnDeliveryDepositedCashSaleId
      integer (int32)
      totalCosts
      number (double)
      paidCosts
      number (double)
      paidCostsCashSaleId
      integer (int32)
      paidCostsInvoiceSaleId
      integer (int32)
      recipientSignature
      string (byte)
      recipientName
      string
      handoutDateTime
      string (date-time)
      cancelled
      boolean
      Default"False"
      customsInvoiceNumber
      string
      customsShipmentType
      string
      Valid values[ "NotSpecified", "Gift", "Documents", "CommercialGoods", "CommercialSample", "ReturnedGoods" ]
      shipperFreeText
      string
      internalFreeText
      string
      storeNumber
      integer (int32)
      storeDescription
      string
      customerGeneralName
      string
      customerPhoneNumber
      string
      deliveryAddress
      string
      deliveryAddressStreet
      string
      deliveryAddressCity
      string
      deliveryAddressNumberPart1
      integer (int32)
      deliveryAddressNumberPart2
      string
      deliveryAddressCounty
      string
      deliveryAddressDescription
      string
      deliveryAddressZipCode
      string
      deliveryAddressCountryDescription
      string
      deliveryAddressIsoCountryCode
      string
      deliveryAddressIsoCountryDescription
      string
      reservationNumber
      integer (int32)
      deliveryOrderTypeDescription
      string
      parcelServiceDescription
      string
      parcelServiceCarrierDescription
      string
      parcelsCount
      integer (int32)
      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)
      number
      integer (int32)
      euShipment
      boolean
      Default"False"
      customerId
      integer (int32)
      deliveryAddressId
      integer (int32)
      deliveryMinutes
      integer (int32)
      reservationId
      integer (int32)
      deliveryOrderTypeId
      integer (int32)
      generalStatus
      string
      Valid values[ "NotSpecified", "New", "EnryCompleted", "Final", "Closed" ]
      logisticsStatus
      string
      Valid values[ "NotSpecified", "DeliveryNotAllowed", "DeliveryAllowedWithRestrictions", "DeliveryAllowed" ]
      logisticsStatusReason
      string
      Valid values[ "NotSpecified", "ReservationHandoutNotAllowed", "DeliveryOrderCostsNotPaid", "DeliveryOrderCancelled", "DeliveryOrderNotFinal", "RequiredInvoicesNotAllPaid", "SaleOrderReservationsIncomplete", "PartialDeliveryNotAllowed", "ExceptionOccurred" ]
      parcelServiceId
      integer (int32)
      parcelServiceCarrierId
      integer (int32)
      requestedDeliveryDate
      string (date-time)
      exportDateTime
      string (date-time)
      cashOnDeliveryValue
      number (double)
      cashOnDeliveryPaid
      boolean
      Default"False"
      cashOnDeliveryDeposited
      boolean
      Default"False"
      cashOnDeliveryDepositedCashSaleId
      integer (int32)
      totalCosts
      number (double)
      paidCosts
      number (double)
      paidCostsCashSaleId
      integer (int32)
      paidCostsInvoiceSaleId
      integer (int32)
      recipientSignature
      string (byte)
      recipientName
      string
      handoutDateTime
      string (date-time)
      cancelled
      boolean
      Default"False"
      customsInvoiceNumber
      string
      customsShipmentType
      string
      Valid values[ "NotSpecified", "Gift", "Documents", "CommercialGoods", "CommercialSample", "ReturnedGoods" ]
      shipperFreeText
      string
      internalFreeText
      string
      storeNumber
      integer (int32)
      storeDescription
      string
      customerGeneralName
      string
      customerPhoneNumber
      string
      deliveryAddress
      string
      deliveryAddressStreet
      string
      deliveryAddressCity
      string
      deliveryAddressNumberPart1
      integer (int32)
      deliveryAddressNumberPart2
      string
      deliveryAddressCounty
      string
      deliveryAddressDescription
      string
      deliveryAddressZipCode
      string
      deliveryAddressCountryDescription
      string
      deliveryAddressIsoCountryCode
      string
      deliveryAddressIsoCountryDescription
      string
      reservationNumber
      integer (int32)
      deliveryOrderTypeDescription
      string
      parcelServiceDescription
      string
      parcelServiceCarrierDescription
      string
      parcelsCount
      integer (int32)
      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)
      number
      integer (int32)
      euShipment
      boolean
      Default"False"
      customerId
      integer (int32)
      deliveryAddressId
      integer (int32)
      deliveryMinutes
      integer (int32)
      reservationId
      integer (int32)
      deliveryOrderTypeId
      integer (int32)
      generalStatus
      string
      Valid values[ "NotSpecified", "New", "EnryCompleted", "Final", "Closed" ]
      logisticsStatus
      string
      Valid values[ "NotSpecified", "DeliveryNotAllowed", "DeliveryAllowedWithRestrictions", "DeliveryAllowed" ]
      logisticsStatusReason
      string
      Valid values[ "NotSpecified", "ReservationHandoutNotAllowed", "DeliveryOrderCostsNotPaid", "DeliveryOrderCancelled", "DeliveryOrderNotFinal", "RequiredInvoicesNotAllPaid", "SaleOrderReservationsIncomplete", "PartialDeliveryNotAllowed", "ExceptionOccurred" ]
      parcelServiceId
      integer (int32)
      parcelServiceCarrierId
      integer (int32)
      requestedDeliveryDate
      string (date-time)
      exportDateTime
      string (date-time)
      cashOnDeliveryValue
      number (double)
      cashOnDeliveryPaid
      boolean
      Default"False"
      cashOnDeliveryDeposited
      boolean
      Default"False"
      cashOnDeliveryDepositedCashSaleId
      integer (int32)
      totalCosts
      number (double)
      paidCosts
      number (double)
      paidCostsCashSaleId
      integer (int32)
      paidCostsInvoiceSaleId
      integer (int32)
      recipientSignature
      string (byte)
      recipientName
      string
      handoutDateTime
      string (date-time)
      cancelled
      boolean
      Default"False"
      customsInvoiceNumber
      string
      customsShipmentType
      string
      Valid values[ "NotSpecified", "Gift", "Documents", "CommercialGoods", "CommercialSample", "ReturnedGoods" ]
      shipperFreeText
      string
      internalFreeText
      string
      storeNumber
      integer (int32)
      storeDescription
      string
      customerGeneralName
      string
      customerPhoneNumber
      string
      deliveryAddress
      string
      deliveryAddressStreet
      string
      deliveryAddressCity
      string
      deliveryAddressNumberPart1
      integer (int32)
      deliveryAddressNumberPart2
      string
      deliveryAddressCounty
      string
      deliveryAddressDescription
      string
      deliveryAddressZipCode
      string
      deliveryAddressCountryDescription
      string
      deliveryAddressIsoCountryCode
      string
      deliveryAddressIsoCountryDescription
      string
      reservationNumber
      integer (int32)
      deliveryOrderTypeDescription
      string
      parcelServiceDescription
      string
      parcelServiceCarrierDescription
      string
      parcelsCount
      integer (int32)
      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