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

      /v23.1/DeliveryOrders/{itemId}

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

      Put
      /v23.1/DeliveryOrders/{itemId}
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Path parameters
      itemId
      integer (int32) Required
      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)
      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
      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
      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
      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)
      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
      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
      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
      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?
      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