Retrieve parcels
GET {{baseUrl}}/parcels?parcel_status=<integer>&tracking_number=<string>&order_number=<string>&updated_after=<string>&announced_after=<string>&ids=<string>&cursor=<string>&errors=verbose-carrier
This endpoint allows you to retrieve a list of all the parcels which you have created or imported into your Sendcloud account under your API credentials. You can filter the results based on the query parameters provided below, in order to retrieve a specific parcel or list of parcels which match the defined criteria.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
parcel_status | string | Returns parcels that have the requested status. For a list of possible statuses, see the Parcel statuses endpoint | |
tracking_number | string | Returns parcels that match a specified tracking number | |
order_number | string | Returns an order that matches a specific order_number property from your parcels | |
updated_after | string | Returns all orders which have been updated in our system after a given time. You can use the value of ISO 8601 DateTime string like this | |
announced_after | string | Returns all orders which have been announced to the carrier after the given time. You can use the value of ISO 8601 DateTime string like this | |
ids | string | Filter results using a list of Parcel IDs. This is a comma separated list of IDs, it may not contain more then 100 IDs. | |
cursor | string | Next and previous token that is used to paginate. The token is included in the response. | |
errors | string | If you are using this API for development purposes, you might want to use the errors query string in the URL. This allows you to visualize errors from the carrier. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"parcels":[{"id":"\u003cinteger\u003e","address":"\u003cstring\u003e","address_2":"\u003cstring\u003e","address_divided":{"house_number":"\u003cstring\u003e","street":"\u003cstring\u003e"},"carrier":{"code":"fadello"},"city":"\u003cstring\u003e","company_name":"\u003cstring\u003e","contract":"\u003cinteger\u003e","country":{"iso_2":"\u003cstring\u003e","iso_3":"\u003cstring\u003e","name":"\u003cstring\u003e"},"customs_invoice_nr":"\u003cstring\u003e","customs_shipment_type":4,"data":{},"date_created":"\u003cstring\u003e","date_updated":"\u003cstring\u003e","date_announced":"\u003cstring\u003e","email":"\u003cstring\u003e","insured_value":"\u003cinteger\u003e","label":{"label_printer":"\u003cstring\u003e","normal_printer":["\u003cstring\u003e","\u003cstring\u003e"]},"name":"\u003cstring\u003e","order_number":"\u003cstring\u003e","shipment_uuid":"\u003cstring\u003e","parcel_items":[{"hs_code":"\u003cstring\u003e","weight":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","description":"\u003cstring\u003e","value":"\u003cnumber\u003e","origin_country":"\u003cstring\u003e","sku":"\u003cstring\u003e","product_id":"\u003cstring\u003e","properties":{},"item_id":"\u003cstring\u003e","return_reason":"\u003cinteger\u003e","return_message":"\u003cstring\u003e","mid_code":"\u003cstring\u003e","material_content":"\u003cstring\u003e","intended_use":"\u003cstring\u003e"},{"hs_code":"\u003cstring\u003e","weight":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","description":"\u003cstring\u003e","value":"\u003cnumber\u003e","origin_country":"\u003cstring\u003e","sku":"\u003cstring\u003e","product_id":"\u003cstring\u003e","properties":{},"item_id":"\u003cstring\u003e","return_reason":"\u003cinteger\u003e","return_message":"\u003cstring\u003e","mid_code":"\u003cstring\u003e","material_content":"\u003cstring\u003e","intended_use":"\u003cstring\u003e"}],"postal_code":"\u003cstring\u003e","external_reference":"\u003cstring\u003e","reference":"0","shipment":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"},"status":{"id":"\u003cinteger\u003e","message":"\u003cstring\u003e"},"documents":[{"type":"cp71","size":"\u003cstring\u003e","link":"\u003cstring\u003e"},{"type":"cn23","size":"\u003cstring\u003e","link":"\u003cstring\u003e"}],"telephone":"\u003cstring\u003e","to_service_point":"\u003cstring\u003e","to_state":"\u003cstring\u003e","total_insured_value":"\u003cinteger\u003e","total_order_value_currency":"\u003cstring\u003e","total_order_value":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","tracking_url":"\u003cstring\u003e","weight":"\u003cstring\u003e","type":"letter","colli_uuid":"\u003cstring\u003e","collo_nr":"\u003cinteger\u003e","collo_count":"\u003cinteger\u003e","is_return":"\u003cboolean\u003e","awb_tracking_number":"\u003cstring\u003e","box_number":"\u003cinteger\u003e","length":"\u003cstring\u003e","width":"\u003cstring\u003e","height":"\u003cstring\u003e","shipping_method_checkout_name":"\u003cstring\u003e","customs_declaration":{},"errors":{"non_field_errors":["\u003cstring\u003e","\u003cstring\u003e"]}}],"next":"\u003cinteger\u003e","previous":"\u003cinteger\u003e"}