2 augustus 2024
Get return requests
GET
https://api.pack.cloud/v1/organizations/{organizationId}/return-requests
Request
Path parameters
organizationIdstring
Query parameters
filter[brand_id]string
filter[customer_id]string
filter[sender_address.country_code]string
filter[orders.id]string
filter[status]array
Allowed values:canceleddraftpendingacceptedrejectedexpiredreceivedrefundcompleted
sortstring
Allowed values:created_at-created_at
Response
OK
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
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
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25