Retrieve an outgoing parcel

GET {{baseUrl}}/brand/:brand_domain/return-portal/outgoing?postal_code=<string>&identifier=<string>&omit_service_points=false

This endpoint returns all the necessary data from the outgoing parcel. It takes two mandatory query parameters: either the tracking number or the order number, and the postal code. On a successful lookup, along with the parcel data, you will receive two JWT tokens: one for the incoming parcel creation, and one for service points lookup.

Request Params

• service_point
• labelless_service_point
• shop_distances |

HEADERS

RESPONSES

status: OK

{"data":{"parcel":{"id":"\u003cnull,integer-int64\u003e","address":"\u003cstring\u003e","address_2":"\u003cstring\u003e","address_divided":{"street":"\u003cstring\u003e","house_number":"\u003cstring\u003e"},"house_number":"\u003cstring\u003e","city":"\u003cstring\u003e","company_name":"\u003cstring\u003e","country":{"iso_2":"\u003cstring\u003e","iso_3":"\u003cstring\u003e","name":"\u003cstring\u003e"},"email":"\u003cstring\u003e","name":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","telephone":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","order_number":"\u003cstring\u003e","to_coordinates":{"latitude":"\u003cfloat\u003e","longitude":"\u003cfloat\u003e"},"collo_count":"\u003cnull,integer\u003e","weight":"\u003cstring\u003e","carrier":{"code":"\u003cstring\u003e"},"to_state":"\u003cnull,string\u003e"},"products":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","price":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","returnable":"\u003cboolean\u003e","image_url":"\u003curi\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","price":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","returnable":"\u003cboolean\u003e","image_url":"\u003curi\u003e"}],"carriers":[{"code":"\u003cstring\u003e","name":"\u003cstring\u003e","logo":{"full":"\u003curi-reference\u003e","icon":"\u003curi-reference\u003e"}}],"national_carrier_contact":"\u003curi\u003e","national_carrier":{"name":"\u003cstring\u003e","drop_off_finder":"\u003cstring\u003e","logo":{"full":"\u003curi\u003e","icon":"\u003curi\u003e"},"code":"\u003cstring\u003e"},"carrier_drop_off_finder":{},"shipping_products":[{"name":"\u003cstring\u003e","carrier":"\u003cstring\u003e","service_points_carrier":"\u003cstring\u003e","functionalities":{"age_check":"\u003cinteger\u003e","b2b":"\u003cboolean\u003e","b2c":"\u003cboolean\u003e","boxable":"\u003cboolean\u003e","bulky_goods":"\u003cboolean\u003e","carrier_billing_type":"zonal","cash_on_delivery":"\u003cboolean\u003e","dangerous_goods":"\u003cboolean\u003e","delivery_attempts":"\u003cinteger\u003e","delivery_before":"\u003cstring\u003e","delivery_deadline":"sameday","direct_contract_only":"\u003cboolean\u003e","eco_delivery":"\u003cboolean\u003e","ers":"\u003cboolean\u003e","first_mile":"pickup_dropoff","flex_delivery":"\u003cboolean\u003e","form_factor":"long","fragile_goods":"\u003cboolean\u003e","fresh_goods":"\u003cboolean\u003e","harmonized_label":"\u003cboolean\u003e","id_check":"\u003cboolean\u003e","incoterm":"ddu","insurance":"\u003cinteger\u003e","labelless":"\u003cboolean\u003e","last_mile":"home_delivery","manually":"\u003cboolean\u003e","multicollo":"\u003cboolean\u003e","neighbor_delivery":"\u003cboolean\u003e","non_conveyable":"\u003cboolean\u003e","personalized_delivery":"\u003cboolean\u003e","premium":"\u003cboolean\u003e","priority":"standard","registered_delivery":"\u003cboolean\u003e","returns":"\u003cboolean\u003e","segment":"d","service_area":"domestic","signature":"\u003cboolean\u003e","size":"xxl","sorted":"\u003cboolean\u003e","surcharge":"\u003cboolean\u003e","tracked":"\u003cboolean\u003e","tyres":"\u003cboolean\u003e","weekend_delivery":"sunday"},"methods":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","functionalities":{"age_check":"\u003cinteger\u003e","b2b":"\u003cboolean\u003e","b2c":"\u003cboolean\u003e","boxable":"\u003cboolean\u003e","bulky_goods":"\u003cboolean\u003e","carrier_billing_type":null,"cash_on_delivery":"\u003cboolean\u003e","dangerous_goods":"\u003cboolean\u003e","delivery_attempts":"\u003cinteger\u003e","delivery_before":"\u003cstring\u003e","delivery_deadline":"best_effort","direct_contract_only":"\u003cboolean\u003e","eco_delivery":"\u003cboolean\u003e","ers":"\u003cboolean\u003e","first_mile":"pickup","flex_delivery":"\u003cboolean\u003e","form_factor":"parcel","fragile_goods":"\u003cboolean\u003e","fresh_goods":"\u003cboolean\u003e","harmonized_label":"\u003cboolean\u003e","id_check":"\u003cboolean\u003e","incoterm":"dap_dp","insurance":"\u003cinteger\u003e","labelless":"\u003cboolean\u003e","last_mile":"mailbox","manually":"\u003cboolean\u003e","multicollo":"\u003cboolean\u003e","neighbor_delivery":"\u003cboolean\u003e","non_conveyable":"\u003cboolean\u003e","personalized_delivery":"\u003cboolean\u003e","premium":"\u003cboolean\u003e","priority":"economical","registered_delivery":"\u003cboolean\u003e","returns":"\u003cboolean\u003e","segment":"a","service_area":"international","signature":"\u003cboolean\u003e","size":"xs","sorted":"\u003cboolean\u003e","surcharge":"\u003cboolean\u003e","tracked":"\u003cboolean\u003e","tyres":"\u003cboolean\u003e","weekend_delivery":"saturday"},"complete_functionalities":{"age_check":"\u003cinteger\u003e","b2b":"\u003cboolean\u003e","b2c":"\u003cboolean\u003e","boxable":"\u003cboolean\u003e","bulky_goods":"\u003cboolean\u003e","carrier_billing_type":"country","cash_on_delivery":"\u003cboolean\u003e","dangerous_goods":"\u003cboolean\u003e","delivery_attempts":"\u003cinteger\u003e","delivery_before":"\u003cstring\u003e","delivery_deadline":"best_effort","direct_contract_only":"\u003cboolean\u003e","eco_delivery":"\u003cboolean\u003e","ers":"\u003cboolean\u003e","first_mile":"dropoff","flex_delivery":"\u003cboolean\u003e","form_factor":"long","fragile_goods":"\u003cboolean\u003e","fresh_goods":"\u003cboolean\u003e","harmonized_label":"\u003cboolean\u003e","id_check":"\u003cboolean\u003e","incoterm":"dap_dp","insurance":"\u003cinteger\u003e","labelless":"\u003cboolean\u003e","last_mile":"home_delivery","manually":"\u003cboolean\u003e","multicollo":"\u003cboolean\u003e","neighbor_delivery":"\u003cboolean\u003e","non_conveyable":"\u003cboolean\u003e","personalized_delivery":"\u003cboolean\u003e","premium":"\u003cboolean\u003e","priority":"express","registered_delivery":"\u003cboolean\u003e","returns":"\u003cboolean\u003e","segment":"d","service_area":"domestic_remote","signature":"\u003cboolean\u003e","size":"xl","sorted":"\u003cboolean\u003e","surcharge":"\u003cboolean\u003e","tracked":"\u003cboolean\u003e","tyres":"\u003cboolean\u003e","weekend_delivery":"saturday"},"shipping_product_code":"\u003cstring\u003e","properties":{"min_weight":"\u003cinteger\u003e","max_weight":"\u003cinteger\u003e","max_dimensions":{"length":"\u003cinteger\u003e","width":"\u003cinteger\u003e","height":"\u003cinteger\u003e","unit":"\u003cstring\u003e"}},"pickup_date":"\u003cstring,null\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","functionalities":{"age_check":"\u003cinteger\u003e","b2b":"\u003cboolean\u003e","b2c":"\u003cboolean\u003e","boxable":"\u003cboolean\u003e","bulky_goods":"\u003cboolean\u003e","carrier_billing_type":"country","cash_on_delivery":"\u003cboolean\u003e","dangerous_goods":"\u003cboolean\u003e","delivery_attempts":"\u003cinteger\u003e","delivery_before":"\u003cstring\u003e","delivery_deadline":"within_72h","direct_contract_only":"\u003cboolean\u003e","eco_delivery":"\u003cboolean\u003e","ers":"\u003cboolean\u003e","first_mile":"dropoff","flex_delivery":"\u003cboolean\u003e","form_factor":"mailbox","fragile_goods":"\u003cboolean\u003e","fresh_goods":"\u003cboolean\u003e","harmonized_label":"\u003cboolean\u003e","id_check":"\u003cboolean\u003e","incoterm":"dap_np","insurance":"\u003cinteger\u003e","labelless":"\u003cboolean\u003e","last_mile":"service_point","manually":"\u003cboolean\u003e","multicollo":"\u003cboolean\u003e","neighbor_delivery":"\u003cboolean\u003e","non_conveyable":"\u003cboolean\u003e","personalized_delivery":"\u003cboolean\u003e","premium":"\u003cboolean\u003e","priority":"express","registered_delivery":"\u003cboolean\u003e","returns":"\u003cboolean\u003e","segment":"d","service_area":"domestic","signature":"\u003cboolean\u003e","size":"m","sorted":"\u003cboolean\u003e","surcharge":"\u003cboolean\u003e","tracked":"\u003cboolean\u003e","tyres":"\u003cboolean\u003e","weekend_delivery":"weekends"},"complete_functionalities":{"age_check":"\u003cinteger\u003e","b2b":"\u003cboolean\u003e","b2c":"\u003cboolean\u003e","boxable":"\u003cboolean\u003e","bulky_goods":"\u003cboolean\u003e","carrier_billing_type":"zonal","cash_on_delivery":"\u003cboolean\u003e","dangerous_goods":"\u003cboolean\u003e","delivery_attempts":"\u003cinteger\u003e","delivery_before":"\u003cstring\u003e","delivery_deadline":"best_effort","direct_contract_only":"\u003cboolean\u003e","eco_delivery":"\u003cboolean\u003e","ers":"\u003cboolean\u003e","first_mile":"dropoff","flex_delivery":"\u003cboolean\u003e","form_factor":"letter","fragile_goods":"\u003cboolean\u003e","fresh_goods":"\u003cboolean\u003e","harmonized_label":"\u003cboolean\u003e","id_check":"\u003cboolean\u003e","incoterm":"dap","insurance":"\u003cinteger\u003e","labelless":"\u003cboolean\u003e","last_mile":"pobox","manually":"\u003cboolean\u003e","multicollo":"\u003cboolean\u003e","neighbor_delivery":"\u003cboolean\u003e","non_conveyable":"\u003cboolean\u003e","personalized_delivery":"\u003cboolean\u003e","premium":"\u003cboolean\u003e","priority":"economical","registered_delivery":"\u003cboolean\u003e","returns":"\u003cboolean\u003e","segment":"b","service_area":"international","signature":"\u003cboolean\u003e","size":"xxl","sorted":"\u003cboolean\u003e","surcharge":"\u003cboolean\u003e","tracked":"\u003cboolean\u003e","tyres":"\u003cboolean\u003e","weekend_delivery":"sunday"},"shipping_product_code":"\u003cstring\u003e","properties":{"min_weight":"\u003cinteger\u003e","max_weight":"\u003cinteger\u003e","max_dimensions":{"length":"\u003cinteger\u003e","width":"\u003cinteger\u003e","height":"\u003cinteger\u003e","unit":"\u003cstring\u003e"}},"pickup_date":"\u003cstring,null\u003e"}],"code":"\u003cstring\u003e"}],"service_point":{"id":"\u003cinteger\u003e","code":"\u003cstring\u003e","is_active":"\u003cboolean\u003e","extra_data":{},"name":"\u003cstring\u003e","street":"\u003cstring\u003e","house_number":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","city":"\u003cstring\u003e","latitude":"\u003cstring\u003e","longitude":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","homepage":"\u003cstring\u003e","carrier":"\u003cstring\u003e","country":"\u003cstring\u003e","formatted_opening_times":{"0":["\u003cstring\u003e","\u003cstring\u003e"],"1":["\u003cstring\u003e","\u003cstring\u003e"],"2":["\u003cstring\u003e","\u003cstring\u003e"],"3":["\u003cstring\u003e","\u003cstring\u003e"],"4":["\u003cstring\u003e","\u003cstring\u003e"],"5":["\u003cstring\u003e","\u003cstring\u003e"],"6":["\u003cstring\u003e","\u003cstring\u003e"]},"open_tomorrow":"\u003cboolean\u003e","open_upcoming_week":"\u003cboolean\u003e","distance":"\u003cnumber\u003e","shop_type":"\u003cstring\u003e"},"shop_distances":[{"id":"\u003cnumber\u003e","distance":"\u003cnumber\u003e"},{"id":"\u003cnumber\u003e","distance":"\u003cnumber\u003e"}],"labelless_service_point":{"id":"\u003cinteger\u003e","code":"\u003cstring\u003e","is_active":"\u003cboolean\u003e","extra_data":{},"name":"\u003cstring\u003e","street":"\u003cstring\u003e","house_number":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","city":"\u003cstring\u003e","latitude":"\u003cstring\u003e","longitude":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","homepage":"\u003cstring\u003e","carrier":"\u003cstring\u003e","country":"\u003cstring\u003e","formatted_opening_times":{"0":["\u003cstring\u003e","\u003cstring\u003e"],"1":["\u003cstring\u003e","\u003cstring\u003e"],"2":["\u003cstring\u003e","\u003cstring\u003e"],"3":["\u003cstring\u003e","\u003cstring\u003e"],"4":["\u003cstring\u003e","\u003cstring\u003e"],"5":["\u003cstring\u003e","\u003cstring\u003e"],"6":["\u003cstring\u003e","\u003cstring\u003e"]},"open_tomorrow":"\u003cboolean\u003e","open_upcoming_week":"\u003cboolean\u003e","distance":"\u003cnumber\u003e","shop_type":"\u003cstring\u003e"},"applicable_actions":[{"field":"ship_with","id":"change_return_fee","name":"\u003cstring\u003e","value":"\u003cstring\u003e","condition":{"any":[{"id":"item_name","operator":"ne","value":"\u003cstring\u003e"},{"id":"item_name","operator":"ends_with","value":"\u003cstring\u003e"}]},"priority":"\u003cinteger\u003e"},{"field":"return_fee","id":"ship_with","name":"\u003cstring\u003e","value":"\u003cstring\u003e","condition":{"any":[{"id":"from_country","operator":"pattern_match","value":"\u003cstring\u003e"},{"id":"from_country","operator":"eq","value":"\u003cstring\u003e"}]},"priority":"\u003cinteger\u003e"}]},"service_points_token":"\u003cstring\u003e","access_token":"\u003cstring\u003e"}