/v23.1/ReturnRequests
  • 05 Jun 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/ReturnRequests

  • Dark
    Light
  • PDF

Article summary

Get
/v23.1/ReturnRequests
Security
HTTP
Type Bearer

Please enter a valid token

Query parameters
StoreId
integer (int32)
Number
integer (int32)
Status
string
Valid values[ "NotSpecified", "New", "Final", "Closed" ]
CustomerReturnTypeId
integer (int32)
SaleOrderId
integer (int32)
CustomerId
integer (int32)
EmailAddressId
integer (int32)
PhoneNumberId
integer (int32)
ReturnPayment
string
Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
Iban
string
IbanName
string
ReturnAddressId
integer (int32)
ApprovedOnly
string
Valid values[ "All", "Yes", "No" ]
RejectedOnly
string
Valid values[ "All", "Yes", "No" ]
CancelledOnly
string
Valid values[ "All", "Yes", "No" ]
OpenOnly
string
Valid values[ "All", "Yes", "No" ]
ReturnRowsToInvoiceOnly
string
Valid values[ "All", "Yes", "No" ]
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)
status
string
Valid values[ "NotSpecified", "New", "Final", "Closed" ]
freeInfo
string
adHoc
boolean
Default"False"
customerReturnTypeId
integer (int32)
saleOrderId
integer (int32)
customerId
integer (int32)
emailAddressId
integer (int32)
phoneNumberId
integer (int32)
expectedReturnDateTime
string (date-time)
utmostReturnDateTime
string (date-time)
ignoreUtmostReturnDateTime
boolean
Default"False"
returnCosts
number (double)
settledReturnCosts
number (double)
returnPayment
string
Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
iban
string
ibanName
string
carrierLabelPrintAmount
integer (int32)
returnAddressId
integer (int32)
approved
boolean
Default"False"
rejected
boolean
Default"False"
cancelled
boolean
Default"False"
notifiedCustomerDateTime
string (date-time)
customerName
string
customerNumber
integer (int64)
email
string
phoneNumber
string
address
string
addressDescription
string
zipCode
string
county
string
city
string
countryDescription
string
addressAttentionOf
string
customerReturnTypeDescription
string
customerReturnTypeCode
string
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)
status
string
Valid values[ "NotSpecified", "New", "Final", "Closed" ]
freeInfo
string
adHoc
boolean
Default"False"
customerReturnTypeId
integer (int32)
saleOrderId
integer (int32)
customerId
integer (int32)
emailAddressId
integer (int32)
phoneNumberId
integer (int32)
expectedReturnDateTime
string (date-time)
utmostReturnDateTime
string (date-time)
ignoreUtmostReturnDateTime
boolean
Default"False"
returnCosts
number (double)
settledReturnCosts
number (double)
returnPayment
string
Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
iban
string
ibanName
string
carrierLabelPrintAmount
integer (int32)
returnAddressId
integer (int32)
approved
boolean
Default"False"
rejected
boolean
Default"False"
cancelled
boolean
Default"False"
notifiedCustomerDateTime
string (date-time)
customerName
string
customerNumber
integer (int64)
email
string
phoneNumber
string
address
string
addressDescription
string
zipCode
string
county
string
city
string
countryDescription
string
addressAttentionOf
string
customerReturnTypeDescription
string
customerReturnTypeCode
string
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)
status
string
Valid values[ "NotSpecified", "New", "Final", "Closed" ]
freeInfo
string
adHoc
boolean
Default"False"
customerReturnTypeId
integer (int32)
saleOrderId
integer (int32)
customerId
integer (int32)
emailAddressId
integer (int32)
phoneNumberId
integer (int32)
expectedReturnDateTime
string (date-time)
utmostReturnDateTime
string (date-time)
ignoreUtmostReturnDateTime
boolean
Default"False"
returnCosts
number (double)
settledReturnCosts
number (double)
returnPayment
string
Valid values[ "NotSpecified", "GiftCard", "OriginalPayment", "Bank" ]
iban
string
ibanName
string
carrierLabelPrintAmount
integer (int32)
returnAddressId
integer (int32)
approved
boolean
Default"False"
rejected
boolean
Default"False"
cancelled
boolean
Default"False"
notifiedCustomerDateTime
string (date-time)
customerName
string
customerNumber
integer (int64)
email
string
phoneNumber
string
address
string
addressDescription
string
zipCode
string
county
string
city
string
countryDescription
string
addressAttentionOf
string
customerReturnTypeDescription
string
customerReturnTypeCode
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
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?

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.