Retrieve a list of shipments

GET {{baseUrl}}/integrations/:id/shipments?cursor=<string>&start_date=<date>&end_date=<date>&external_order_ids=<string>&external_order_ids=<string>&external_shipment_ids=<string>&external_shipment_ids=<string>&shipping_rules=<boolean>&order_number=<string>&sender_address=<integer>

Retrieving shipments from an integration

Via this endpoint, you can retrieve a list of orders that were imported from a specific webshop integration. Note that these orders are not affected by shipping rules at the time of retrieval, unless enabled explicitly. This endpoint is paginated, meaning that you can navigate through the results via the URLs provided within the next and previous fields.

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 | | start_date | string | | Displays orders from the given start_date, including the set date. It defaults to one year ago. | | end_date | string | | Displays orders up to the given end_date, including the set date. It defaults to the current date. | | external_order_ids | string | | Filters results to shipments where their external_order_id matches one of the user provided ones. | | external_order_ids | string | | Filters results to shipments where their external_order_id matches one of the user provided ones. | | external_shipment_ids | string | | Filters results to shipments where their external_shipments_id matches one of the user provided ones. | | external_shipment_ids | string | | Filters results to shipments where their external_shipments_id matches one of the user provided ones. | | shipping_rules | string | | Enable shipping rules when retrieving orders. This will have an impact on the allowed_shipping_methods. | | order_number | string | | Filters results to shipments on order_number. | | sender_address | string | | Allows to specify a sender address id to display proper allowed_shipping_methods. |

HEADERS

RESPONSES

status: OK

{"next":"\u003curi\u003e","previous":"\u003curi\u003e","results":[{"address":"\u003cstring\u003e","address_2":"\u003cstring\u003e","city":"\u003cstring\u003e","company_name":"\u003cstring\u003e","country":"MK","created_at":"\u003cdateTime\u003e","currency":"USD","customs_invoice_nr":"\u003cstring\u003e","customs_shipment_type":1,"email":"\u003cemail\u003e","external_order_id":"\u003cstring\u003e","external_shipment_id":"\u003cstring,null\u003e","house_number":"\u003cstring\u003e","name":"\u003cstring\u003e","order_number":"\u003cstring\u003e","order_status":null,"parcel_items":[{"description":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","value":"\u003cstring\u003e","hs_code":"\u003cstring\u003e","origin_country":"LU","product_id":"\u003cstring\u003e","properties":{"veniam_7":"\u003cstring,null\u003e","esse0":"\u003cstring,null\u003e"},"sku":"\u003cstring\u003e","weight":"\u003cstring,null\u003e","mid_code":"\u003cstring,null\u003e","material_content":"\u003cstring,null\u003e","intended_use":"\u003cstring,null\u003e"},{"description":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","value":"\u003cstring\u003e","hs_code":"\u003cstring\u003e","origin_country":"ES","product_id":"\u003cstring\u003e","properties":{"et5c":"\u003cstring,null\u003e","voluptate3":"\u003cstring,null\u003e"},"sku":"\u003cstring\u003e","weight":"\u003cstring,null\u003e","mid_code":"\u003cstring,null\u003e","material_content":"\u003cstring,null\u003e","intended_use":"\u003cstring,null\u003e"}],"payment_status":null,"postal_code":"\u003cstring\u003e","shipping_method_checkout_name":"\u003cstring\u003e","telephone":"\u003cstring\u003e","to_post_number":"\u003cstring\u003e","to_service_point":"\u003cinteger,null\u003e","to_state":"\u003cstring,null\u003e","updated_at":"\u003cdateTime\u003e","shipment_created_at":"\u003cdateTime\u003e","shipment_updated_at":"\u003cdateTime\u003e","allowed_shipping_methods":["\u003cinteger\u003e","\u003cinteger\u003e"],"barcode":"\u003cstring\u003e","integration":"\u003cinteger\u003e","sender_address":"\u003cinteger,null\u003e","shipment_uuid":"\u003cuuid\u003e","shipping_method":"\u003cinteger,null\u003e","total_order_value":"\u003cstring,null\u003e","weight":"\u003cstring,null\u003e","checkout_payload":{"sender_address_id":"\u003cinteger\u003e","shipping_product":{},"delivery_method_type":"\u003cstring\u003e","delivery_method_data":{"delivery_date":"\u003cdateTime\u003e","formatted_delivery_date":"\u003cstring\u003e","parcel_handover_date":"\u003cdateTime\u003e"}},"width":"\u003cstring,null\u003e","height":"\u003cstring,null\u003e","length":"\u003cstring,null\u003e","customs_details":{"discount_granted":{"value":"405.81749304775","currency":"\u003cstring,null\u003e"},"insurance_costs":{"value":"5531316290","currency":"\u003cstring,null\u003e"},"freight_costs":{"value":"875199","currency":"\u003cstring,null\u003e"},"other_costs":{"value":"6977772703","currency":"\u003cstring,null\u003e"},"tax_numbers":{"sender":[{"name":"\u003cstring,null\u003e","country_code":"\u003cstring,null\u003e","value":"\u003cstring,null\u003e"},{"name":"\u003cstring,null\u003e","country_code":"\u003cstring,null\u003e","value":"\u003cstring,null\u003e"}],"receiver":[{"name":"\u003cstring,null\u003e","country_code":"\u003cstring,null\u003e","value":"\u003cstring,null\u003e"},{"name":"\u003cstring,null\u003e","country_code":"\u003cstring,null\u003e","value":"\u003cstring,null\u003e"}],"importer_of_records":[{"name":"\u003cstring,null\u003e","country_code":"\u003cstring,null\u003e","value":"\u003cstring,null\u003e"},{"name":"\u003cstring,null\u003e","country_code":"\u003cstring,null\u003e","value":"\u003cstring,null\u003e"}]}}},{"address":"\u003cstring\u003e","address_2":"\u003cstring\u003e","city":"\u003cstring\u003e","company_name":"\u003cstring\u003e","country":"FO","created_at":"\u003cdateTime\u003e","currency":"EUR","customs_invoice_nr":"\u003cstring\u003e","customs_shipment_type":0,"email":"\u003cemail\u003e","external_order_id":"\u003cstring\u003e","external_shipment_id":"\u003cstring,null\u003e","house_number":"\u003cstring\u003e","name":"\u003cstring\u003e","order_number":"\u003cstring\u003e","order_status":null,"parcel_items":null,"payment_status":{"id":"\u003cstring\u003e","message":"\u003cstring\u003e"},"postal_code":"\u003cstring\u003e","shipping_method_checkout_name":"\u003cstring\u003e","telephone":"\u003cstring\u003e","to_post_number":"\u003cstring\u003e","to_service_point":"\u003cinteger,null\u003e","to_state":"\u003cstring,null\u003e","updated_at":"\u003cdateTime\u003e","shipment_created_at":"\u003cdateTime\u003e","shipment_updated_at":"\u003cdateTime\u003e","allowed_shipping_methods":["\u003cinteger\u003e","\u003cinteger\u003e"],"barcode":"\u003cstring\u003e","integration":"\u003cinteger\u003e","sender_address":"\u003cinteger,null\u003e","shipment_uuid":"\u003cuuid\u003e","shipping_method":"\u003cinteger,null\u003e","total_order_value":"\u003cstring,null\u003e","weight":"\u003cstring,null\u003e","checkout_payload":{"sender_address_id":"\u003cinteger\u003e","shipping_product":{},"delivery_method_type":"\u003cstring\u003e","delivery_method_data":{"delivery_date":"\u003cdateTime\u003e","formatted_delivery_date":"\u003cstring\u003e","parcel_handover_date":"\u003cdateTime\u003e"}},"width":"\u003cstring,null\u003e","height":"\u003cstring,null\u003e","length":"\u003cstring,null\u003e","customs_details":null}]}