The Rest API is deprecated and will be removed in the future. We recommend using the GraphQL API instead. Some endpoints may not be available anymore.
Create return request
POST
https://api.pack.cloud/v1/organizations/{organizationId}/return-requests
Request
Path parameters
organizationIdstring
returnRequestIdstring
Payload
brand_idstringrequired
ID of the brand
customer_idstring
ID of the customer
referencestring
Reference of the return request
Example:R-ORD100123
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
currencystringrequired
ISO 4217 code of the currency
Example:EUR
valuestringrequired
Money amount
Example:9.95
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
statusstring
Status of the return request
Allowed values:draftpendingacceptedrejected
quantity_expectedintegerrequired
Quantity that is expected
order_line_idstringrequired
ID of the order line
return_reason_idstringnull
ID of the return reason
sub_return_reason_idstringnull
ID of the return reason
Orders orders to be linked to this request
idstring
ID of the order
The sender address information
customer_idstringnull
ID of the related customer
company_namestring
Company name (required when no name provided)
Example:Large Company Ltd
namestring
Contact person name (required when no company name provided)
Example:John Doe
addressstring
Street / first address line
Example:Straatweg
address_2stringnull
Second address line
Example:Second line
house_numberstring
House number and addition
Example:123A bus 2
postal_codestring
Postal code
Example:1234AB
citystring
City
Example:Amsterdam
state_codestring
State code
Example:NH
country_codestring
ISO code 3166 alpha 2
Example:NL
emailstring
Email address
phonestring
Phone number
eoristring
Economic Operators Registration and Identification number
ossstring
One-Stop Shop (OSS) number
vatstring
VAT identification number
Response
Created
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
Created
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
Created
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
Created
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
Created
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
Created
Body
idstring
ID of the return request
customer_idstringnull
ID of the customer whose return request is
referencestring
Reference
return_methodstring
Return method
Allowed values:storedrop_off_pointpickupown_carrier
Price of customer contribution for return shipment
return_shipping_service_method_idstringnull
ID of the shipping method used for return shipment
statusstring
Status
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
refund_typestring
Refund type
Allowed values:couponexchangegift_cardmoney
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource