API Reference

Get shipments list

Get list of shipments using searchCritera to filter output.
Sample Curl for getting list of shipments created since a last date
curl --location --globoff 'https://mygatewayurl.com/V1/admin/shipments/list?searchCriteria[filterGroups][0][filters][0][conditionType]=gt&searchCriteria[filterGroups][0][filters][0][field]=created_at&searchCriteria[filterGroups][0][filters][0][value]=2023-03-17%2004%3A07%3A10&searchCriteria[currentPage]=1&searchCriteria[filterGroups][1][filters][0][field]=status&searchCriteria[filterGroups][1][filters][0][value]=pending&searchCriteria[filterGroups][1][filters][0][conditionType]=eq' --header 'Authorization: Bearer token'
Sample Curl for getting shipment for a particular shipment id
curl --location --globoff 'https://mygatewayurl.com/V1/admin/shipments/list?searchCriteria[filterGroups][0][filters][0][conditionType]=eq&searchCriteria[filterGroups][0][filters][0][field]=entity_id&searchCriteria[filterGroups][0][filters][0][value]=123&searchCriteria[currentPage]=1&searchCriteria[filterGroups][1][filters][0][field]=status&searchCriteria[filterGroups][1][filters][0][value]=pending&searchCriteria[filterGroups][1][filters][0][conditionType]=eq' --header 'Authorization: Bearer token'
Sample Curl for getting shipment for a particular order id
curl --location --globoff 'https://mygatewayurl.com/V1/admin/shipments/list?searchCriteria[filterGroups][0][filters][0][conditionType]=eq&searchCriteria[filterGroups][0][filters][0][field]=order_id&searchCriteria[filterGroups][0][filters][0][value]=123&searchCriteria[currentPage]=1&searchCriteria[filterGroups][1][filters][0][field]=status&searchCriteria[filterGroups][1][filters][0][value]=pending&searchCriteria[filterGroups][1][filters][0][conditionType]=eq' --header 'Authorization: Bearer token'

Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!