curl --request GET \
--url http://{defaultHost}/api/v2/platform/shipments \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "28",
"type": "shipment",
"attributes": {
"tracking": "U10000",
"number": "H74819281258",
"cost": "100.0",
"shipped_at": null,
"state": "pending",
"created_at": "2022-11-08T19:35:09.196Z",
"updated_at": "2022-11-08T19:35:09.199Z",
"adjustment_total": "0.0",
"additional_tax_total": "0.0",
"promo_total": "0.0",
"included_tax_total": "0.0",
"pre_tax_amount": "0.0",
"taxable_adjustment_total": "0.0",
"non_taxable_adjustment_total": "0.0",
"public_metadata": {},
"private_metadata": {},
"display_discounted_cost": "$100.00",
"display_item_cost": "$0.00",
"display_amount": "$100.00",
"display_final_price": "$100.00",
"display_cost": "$100.00",
"tracking_url": null
},
"relationships": {
"order": {
"data": {
"id": "78",
"type": "order"
}
},
"address": {
"data": null
},
"stock_location": {
"data": {
"id": "106",
"type": "stock_location"
}
},
"adjustments": {
"data": []
},
"inventory_units": {
"data": []
},
"shipping_rates": {
"data": [
{
"id": "30",
"type": "shipping_rate"
}
]
},
"state_changes": {
"data": []
},
"selected_shipping_rate": {
"data": {
"id": "30",
"type": "shipping_rate"
}
}
}
},
{
"id": "29",
"type": "shipment",
"attributes": {
"tracking": "U10000",
"number": "H45064150244",
"cost": "100.0",
"shipped_at": null,
"state": "pending",
"created_at": "2022-11-08T19:35:09.230Z",
"updated_at": "2022-11-08T19:35:09.233Z",
"adjustment_total": "0.0",
"additional_tax_total": "0.0",
"promo_total": "0.0",
"included_tax_total": "0.0",
"pre_tax_amount": "0.0",
"taxable_adjustment_total": "0.0",
"non_taxable_adjustment_total": "0.0",
"public_metadata": {},
"private_metadata": {},
"display_discounted_cost": "$100.00",
"display_item_cost": "$0.00",
"display_amount": "$100.00",
"display_final_price": "$100.00",
"display_cost": "$100.00",
"tracking_url": null
},
"relationships": {
"order": {
"data": {
"id": "79",
"type": "order"
}
},
"address": {
"data": null
},
"stock_location": {
"data": {
"id": "107",
"type": "stock_location"
}
},
"adjustments": {
"data": []
},
"inventory_units": {
"data": []
},
"shipping_rates": {
"data": [
{
"id": "31",
"type": "shipping_rate"
}
]
},
"state_changes": {
"data": []
},
"selected_shipping_rate": {
"data": {
"id": "31",
"type": "shipping_rate"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/shipments?page=1&per_page=&include=&filter[state_eq]=",
"next": "http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page="
}
}
Returns a list of Shipments
curl --request GET \
--url http://{defaultHost}/api/v2/platform/shipments \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "28",
"type": "shipment",
"attributes": {
"tracking": "U10000",
"number": "H74819281258",
"cost": "100.0",
"shipped_at": null,
"state": "pending",
"created_at": "2022-11-08T19:35:09.196Z",
"updated_at": "2022-11-08T19:35:09.199Z",
"adjustment_total": "0.0",
"additional_tax_total": "0.0",
"promo_total": "0.0",
"included_tax_total": "0.0",
"pre_tax_amount": "0.0",
"taxable_adjustment_total": "0.0",
"non_taxable_adjustment_total": "0.0",
"public_metadata": {},
"private_metadata": {},
"display_discounted_cost": "$100.00",
"display_item_cost": "$0.00",
"display_amount": "$100.00",
"display_final_price": "$100.00",
"display_cost": "$100.00",
"tracking_url": null
},
"relationships": {
"order": {
"data": {
"id": "78",
"type": "order"
}
},
"address": {
"data": null
},
"stock_location": {
"data": {
"id": "106",
"type": "stock_location"
}
},
"adjustments": {
"data": []
},
"inventory_units": {
"data": []
},
"shipping_rates": {
"data": [
{
"id": "30",
"type": "shipping_rate"
}
]
},
"state_changes": {
"data": []
},
"selected_shipping_rate": {
"data": {
"id": "30",
"type": "shipping_rate"
}
}
}
},
{
"id": "29",
"type": "shipment",
"attributes": {
"tracking": "U10000",
"number": "H45064150244",
"cost": "100.0",
"shipped_at": null,
"state": "pending",
"created_at": "2022-11-08T19:35:09.230Z",
"updated_at": "2022-11-08T19:35:09.233Z",
"adjustment_total": "0.0",
"additional_tax_total": "0.0",
"promo_total": "0.0",
"included_tax_total": "0.0",
"pre_tax_amount": "0.0",
"taxable_adjustment_total": "0.0",
"non_taxable_adjustment_total": "0.0",
"public_metadata": {},
"private_metadata": {},
"display_discounted_cost": "$100.00",
"display_item_cost": "$0.00",
"display_amount": "$100.00",
"display_final_price": "$100.00",
"display_cost": "$100.00",
"tracking_url": null
},
"relationships": {
"order": {
"data": {
"id": "79",
"type": "order"
}
},
"address": {
"data": null
},
"stock_location": {
"data": {
"id": "107",
"type": "stock_location"
}
},
"adjustments": {
"data": []
},
"inventory_units": {
"data": []
},
"shipping_rates": {
"data": [
{
"id": "31",
"type": "shipping_rate"
}
]
},
"state_changes": {
"data": []
},
"selected_shipping_rate": {
"data": {
"id": "31",
"type": "shipping_rate"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/shipments?page=1&per_page=&include=&filter[state_eq]=",
"next": "http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/shipments?filter%5Bstate_eq%5D=&include=&page=1&per_page="
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Records returned
The response is of type object
.
Was this page helpful?