Retrieve a list of returns

GET {{baseUrl}}/returns?cursor=<string>

Retrieve a paginated list of all the returns belonging to the authenticated user, sorted by the creation date.

Request Params

• o: Offset
• r: Reverse
• p: Position Combine into GET parameters. Example: r=1&p=300 Base 64 encoded it would become: cj0xJnA9MzAw GET parameter in url would be https://some.url.com/api/endpoint/?cursor=cj0xJnA9MzAw |

HEADERS

RESPONSES

status: OK

{"next":"\u003cstring\u003e","previous":"\u003cstring\u003e","returns":[{"id":"\u003cinteger\u003e","created_at":"\u003cdateTime\u003e","reason":"\u003cinteger\u003e","outgoing_parcel":"\u003cinteger\u003e","incoming_parcel":"\u003cinteger\u003e","message":"\u003cstring\u003e","refund":{"total_refund":"\u003cstring\u003e","refunded_at":"\u003cinteger\u003e","message":"\u003cstring\u003e","refund_type":{"code":"exchange","label":"\u003cstring\u003e","require_message":"\u003cboolean\u003e"}},"is_cancellable":"\u003cboolean\u003e","return_fee":"\u003cnumber\u003e","return_fee_currency":"\u003cstring\u003e","label_cost":"\u003cnumber\u003e","label_currency":"\u003cstring\u003e","items_cost":"\u003cnumber\u003e","delivered_at":"\u003cdateTime\u003e","delivery_option":"drop_off_labelless","store_location":"\u003cinteger\u003e","outgoing_parcel_data":{"tracking_url":"\u003curi\u003e","tracking_number":"\u003cstring\u003e","parcel_status":"\u003cinteger\u003e","global_status_slug":"\u003cstring\u003e","brand_name":"\u003cstring\u003e","order_number":"\u003cstring\u003e","from_email":"\u003cemail\u003e","deleted":"\u003cboolean\u003e","collo_count":"\u003cinteger\u003e","from_country":"\u003cstring\u003e","from_name":"\u003cstring\u003e","shipping_method":"\u003cinteger\u003e","extra_data":{},"rules":[{"modifications":[{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}},{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}}]},{"modifications":[{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}},{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}}]}]},"incoming_parcel_data":{"tracking_url":"\u003curi\u003e","tracking_number":"\u003cstring\u003e","parcel_status":"\u003cinteger\u003e","global_status_slug":"\u003cstring\u003e","brand_name":"\u003cstring\u003e","order_number":"\u003cstring\u003e","from_email":"\u003cemail\u003e","deleted":"\u003cboolean\u003e","collo_count":"\u003cinteger\u003e","from_country":"\u003cstring\u003e","from_name":"\u003cstring\u003e","shipping_method":"\u003cinteger\u003e","extra_data":{},"rules":[{"modifications":[{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}},{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}}]},{"modifications":[{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}},{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}}]}],"customs_information":{"customs_invoice_nr":"\u003cstring\u003e","customs_shipment_type":"\u003cinteger\u003e","export_type":"private","invoice_date":"\u003cdate\u003e","discount_granted":"\u003cstring\u003e","freight_costs":"\u003cstring\u003e","insurance_costs":"\u003cstring\u003e","other_costs":"\u003cstring\u003e","general_notes":"\u003cstring\u003e","additional_declaration_statements":["\u003cstring\u003e","\u003cstring\u003e"],"importer_of_record":{"name":"\u003cstring\u003e","address_1":"\u003cstring\u003e","city":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","company_name":"\u003cstring\u003e","address_2":"\u003cstring\u003e","house_number":"\u003cstring\u003e","country_state":"\u003cstring\u003e","telephone":"\u003cstring\u003e","email":"\u003cstring\u003e"},"tax_numbers":{"sender":[{"name":"DTF","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"GST","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"receiver":[{"name":"DUN","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"DAN","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"importer_of_record":[{"name":"GST","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"EIN","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}]},"return_data":{"return_postal_code":"\u003cstring\u003e","outbound_tracking_number":"\u003cstring\u003e","outbound_shipment_date":"\u003cdate\u003e","outbound_carrier_name":"\u003cstring\u003e"}}},"incoming_parcel_status":{"id":"\u003cinteger\u003e","message":"\u003cstring\u003e","global_status_slug":"\u003cstring\u003e"},"images":[{"path":"\u003curi\u003e","product_id":"\u003cstring\u003e","description":"\u003cstring\u003e"},{"path":"\u003curi\u003e","product_id":"\u003cstring\u003e","description":"\u003cstring\u003e"}],"rule_modifications":[{"rule_name":"\u003cstring\u003e","field":"\u003cstring\u003e","value":{"description":"New value of the field based on this rule. The type depends on the field type."},"action":"\u003cstring\u003e","friendly_name":"\u003cstring\u003e","priority":"\u003cinteger\u003e","item_id":"\u003cstring\u003e"},{"rule_name":"\u003cstring\u003e","field":"\u003cstring\u003e","value":{"description":"New value of the field based on this rule. The type depends on the field type."},"action":"\u003cstring\u003e","friendly_name":"\u003cstring\u003e","priority":"\u003cinteger\u003e","item_id":"\u003cstring\u003e"}]},{"id":"\u003cinteger\u003e","created_at":"\u003cdateTime\u003e","reason":"\u003cinteger\u003e","outgoing_parcel":"\u003cinteger\u003e","incoming_parcel":"\u003cinteger\u003e","message":"\u003cstring\u003e","refund":{"total_refund":"\u003cstring\u003e","refunded_at":"\u003cinteger\u003e","message":"\u003cstring\u003e","refund_type":{"code":"money","label":"\u003cstring\u003e","require_message":"\u003cboolean\u003e"}},"is_cancellable":"\u003cboolean\u003e","return_fee":"\u003cnumber\u003e","return_fee_currency":"\u003cstring\u003e","label_cost":"\u003cnumber\u003e","label_currency":"\u003cstring\u003e","items_cost":"\u003cnumber\u003e","delivered_at":"\u003cdateTime\u003e","delivery_option":"in_store","store_location":"\u003cinteger\u003e","outgoing_parcel_data":{"tracking_url":"\u003curi\u003e","tracking_number":"\u003cstring\u003e","parcel_status":"\u003cinteger\u003e","global_status_slug":"\u003cstring\u003e","brand_name":"\u003cstring\u003e","order_number":"\u003cstring\u003e","from_email":"\u003cemail\u003e","deleted":"\u003cboolean\u003e","collo_count":"\u003cinteger\u003e","from_country":"\u003cstring\u003e","from_name":"\u003cstring\u003e","shipping_method":"\u003cinteger\u003e","extra_data":{},"rules":[{"modifications":[{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}},{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}}]},{"modifications":[{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}},{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}}]}]},"incoming_parcel_data":{"tracking_url":"\u003curi\u003e","tracking_number":"\u003cstring\u003e","parcel_status":"\u003cinteger\u003e","global_status_slug":"\u003cstring\u003e","brand_name":"\u003cstring\u003e","order_number":"\u003cstring\u003e","from_email":"\u003cemail\u003e","deleted":"\u003cboolean\u003e","collo_count":"\u003cinteger\u003e","from_country":"\u003cstring\u003e","from_name":"\u003cstring\u003e","shipping_method":"\u003cinteger\u003e","extra_data":{},"rules":[{"modifications":[{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}},{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}}]},{"modifications":[{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}},{"field":"\u003cstring\u003e","value":{"description":"The value the field was changed to. The type depends on the field type"}}]}],"customs_information":{"customs_invoice_nr":"\u003cstring\u003e","customs_shipment_type":"\u003cinteger\u003e","export_type":"commercial_b2b","invoice_date":"\u003cdate\u003e","discount_granted":"\u003cstring\u003e","freight_costs":"\u003cstring\u003e","insurance_costs":"\u003cstring\u003e","other_costs":"\u003cstring\u003e","general_notes":"\u003cstring\u003e","additional_declaration_statements":["\u003cstring\u003e","\u003cstring\u003e"],"importer_of_record":{"name":"\u003cstring\u003e","address_1":"\u003cstring\u003e","city":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","company_name":"\u003cstring\u003e","address_2":"\u003cstring\u003e","house_number":"\u003cstring\u003e","country_state":"\u003cstring\u003e","telephone":"\u003cstring\u003e","email":"\u003cstring\u003e"},"tax_numbers":{"sender":[{"name":"DTF","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"STA","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"receiver":[{"name":"FED","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"DUN","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"importer_of_record":[{"name":"DUN","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"RGP","country_code":"\u003cstring\u003e","value":"\u003cstring\u003e"}]},"return_data":{"return_postal_code":"\u003cstring\u003e","outbound_tracking_number":"\u003cstring\u003e","outbound_shipment_date":"\u003cdate\u003e","outbound_carrier_name":"\u003cstring\u003e"}}},"incoming_parcel_status":{"id":"\u003cinteger\u003e","message":"\u003cstring\u003e","global_status_slug":"\u003cstring\u003e"},"images":[{"path":"\u003curi\u003e","product_id":"\u003cstring\u003e","description":"\u003cstring\u003e"},{"path":"\u003curi\u003e","product_id":"\u003cstring\u003e","description":"\u003cstring\u003e"}],"rule_modifications":[{"rule_name":"\u003cstring\u003e","field":"\u003cstring\u003e","value":{"description":"New value of the field based on this rule. The type depends on the field type."},"action":"\u003cstring\u003e","friendly_name":"\u003cstring\u003e","priority":"\u003cinteger\u003e","item_id":"\u003cstring\u003e"},{"rule_name":"\u003cstring\u003e","field":"\u003cstring\u003e","value":{"description":"New value of the field based on this rule. The type depends on the field type."},"action":"\u003cstring\u003e","friendly_name":"\u003cstring\u003e","priority":"\u003cinteger\u003e","item_id":"\u003cstring\u003e"}]}]}