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

      /v23.1/ReturnScenarios

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

      Post
      /v23.1/ReturnScenarios
      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)
      code
      string
      description
      string
      printCarrierLabel
      boolean
      Default"False"
      returnCosts
      number (double)
      calculateShippingCosts
      boolean
      Default"False"
      shippingCosts
      number (double)
      carrierSupport
      boolean
      Default"False"
      receivedProductSupport
      boolean
      Default"False"
      skipProductApproval
      boolean
      Default"False"
      preferredPostAction
      string
      Valid values[ "NotSpecified", "ReplaceProduct", "ReturnPayment", "Compensation", "FreeSaleOrder" ]
      suggestedReturnPayment
      string
      Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
      sendReturnLabels
      boolean
      Default"False"
      autoApproval
      boolean
      Default"False"
      invoiceSaleStatus
      integer (int32)
      invoiceSaleDebtorId
      integer (int32)
      newSaleOrderTransportTypeId
      integer (int32)
      newSaleOrderClassId
      integer (int32)
      defaultReturnAllocatedStockTypeId
      integer (int32)
      defaultReturnLocationId
      integer (int32)
      newReturnRowSuggestProductState
      boolean
      Default"False"
      cancelled
      boolean
      Default"False"
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      code
      string
      description
      string
      printCarrierLabel
      boolean
      Default"False"
      returnCosts
      number (double)
      calculateShippingCosts
      boolean
      Default"False"
      shippingCosts
      number (double)
      carrierSupport
      boolean
      Default"False"
      receivedProductSupport
      boolean
      Default"False"
      skipProductApproval
      boolean
      Default"False"
      preferredPostAction
      string
      Valid values[ "NotSpecified", "ReplaceProduct", "ReturnPayment", "Compensation", "FreeSaleOrder" ]
      suggestedReturnPayment
      string
      Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
      sendReturnLabels
      boolean
      Default"False"
      autoApproval
      boolean
      Default"False"
      invoiceSaleStatus
      integer (int32)
      invoiceSaleDebtorId
      integer (int32)
      newSaleOrderTransportTypeId
      integer (int32)
      newSaleOrderClassId
      integer (int32)
      defaultReturnAllocatedStockTypeId
      integer (int32)
      defaultReturnLocationId
      integer (int32)
      newReturnRowSuggestProductState
      boolean
      Default"False"
      cancelled
      boolean
      Default"False"
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      code
      string
      description
      string
      printCarrierLabel
      boolean
      Default"False"
      returnCosts
      number (double)
      calculateShippingCosts
      boolean
      Default"False"
      shippingCosts
      number (double)
      carrierSupport
      boolean
      Default"False"
      receivedProductSupport
      boolean
      Default"False"
      skipProductApproval
      boolean
      Default"False"
      preferredPostAction
      string
      Valid values[ "NotSpecified", "ReplaceProduct", "ReturnPayment", "Compensation", "FreeSaleOrder" ]
      suggestedReturnPayment
      string
      Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
      sendReturnLabels
      boolean
      Default"False"
      autoApproval
      boolean
      Default"False"
      invoiceSaleStatus
      integer (int32)
      invoiceSaleDebtorId
      integer (int32)
      newSaleOrderTransportTypeId
      integer (int32)
      newSaleOrderClassId
      integer (int32)
      defaultReturnAllocatedStockTypeId
      integer (int32)
      defaultReturnLocationId
      integer (int32)
      newReturnRowSuggestProductState
      boolean
      Default"False"
      cancelled
      boolean
      Default"False"
      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)
      code
      string
      description
      string
      printCarrierLabel
      boolean
      Default"False"
      returnCosts
      number (double)
      calculateShippingCosts
      boolean
      Default"False"
      shippingCosts
      number (double)
      carrierSupport
      boolean
      Default"False"
      receivedProductSupport
      boolean
      Default"False"
      skipProductApproval
      boolean
      Default"False"
      preferredPostAction
      string
      Valid values[ "NotSpecified", "ReplaceProduct", "ReturnPayment", "Compensation", "FreeSaleOrder" ]
      suggestedReturnPayment
      string
      Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
      sendReturnLabels
      boolean
      Default"False"
      autoApproval
      boolean
      Default"False"
      invoiceSaleStatus
      integer (int32)
      invoiceSaleDebtorId
      integer (int32)
      newSaleOrderTransportTypeId
      integer (int32)
      newSaleOrderClassId
      integer (int32)
      defaultReturnAllocatedStockTypeId
      integer (int32)
      defaultReturnLocationId
      integer (int32)
      newReturnRowSuggestProductState
      boolean
      Default"False"
      cancelled
      boolean
      Default"False"
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      code
      string
      description
      string
      printCarrierLabel
      boolean
      Default"False"
      returnCosts
      number (double)
      calculateShippingCosts
      boolean
      Default"False"
      shippingCosts
      number (double)
      carrierSupport
      boolean
      Default"False"
      receivedProductSupport
      boolean
      Default"False"
      skipProductApproval
      boolean
      Default"False"
      preferredPostAction
      string
      Valid values[ "NotSpecified", "ReplaceProduct", "ReturnPayment", "Compensation", "FreeSaleOrder" ]
      suggestedReturnPayment
      string
      Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
      sendReturnLabels
      boolean
      Default"False"
      autoApproval
      boolean
      Default"False"
      invoiceSaleStatus
      integer (int32)
      invoiceSaleDebtorId
      integer (int32)
      newSaleOrderTransportTypeId
      integer (int32)
      newSaleOrderClassId
      integer (int32)
      defaultReturnAllocatedStockTypeId
      integer (int32)
      defaultReturnLocationId
      integer (int32)
      newReturnRowSuggestProductState
      boolean
      Default"False"
      cancelled
      boolean
      Default"False"
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      storeId
      integer (int32)
      code
      string
      description
      string
      printCarrierLabel
      boolean
      Default"False"
      returnCosts
      number (double)
      calculateShippingCosts
      boolean
      Default"False"
      shippingCosts
      number (double)
      carrierSupport
      boolean
      Default"False"
      receivedProductSupport
      boolean
      Default"False"
      skipProductApproval
      boolean
      Default"False"
      preferredPostAction
      string
      Valid values[ "NotSpecified", "ReplaceProduct", "ReturnPayment", "Compensation", "FreeSaleOrder" ]
      suggestedReturnPayment
      string
      Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
      sendReturnLabels
      boolean
      Default"False"
      autoApproval
      boolean
      Default"False"
      invoiceSaleStatus
      integer (int32)
      invoiceSaleDebtorId
      integer (int32)
      newSaleOrderTransportTypeId
      integer (int32)
      newSaleOrderClassId
      integer (int32)
      defaultReturnAllocatedStockTypeId
      integer (int32)
      defaultReturnLocationId
      integer (int32)
      newReturnRowSuggestProductState
      boolean
      Default"False"
      cancelled
      boolean
      Default"False"
      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