curl --request GET \
--url http://{defaultHost}/api/v2/platform/stock_locations \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "175",
"type": "stock_location",
"attributes": {
"name": "Jonnie Pollich",
"created_at": "2022-11-08T19:35:30.989Z",
"updated_at": "2022-11-08T19:35:30.989Z",
"default": false,
"address1": "1600 Pennsylvania Ave NW",
"address2": null,
"city": "Washington",
"state_name": null,
"zipcode": "20500",
"phone": "(202) 456-1111",
"active": true,
"backorderable_default": true,
"propagate_all_variants": false,
"admin_name": null
},
"relationships": {
"country": {
"data": {
"id": "413",
"type": "country"
}
}
}
},
{
"id": "176",
"type": "stock_location",
"attributes": {
"name": "Lidia Hamill",
"created_at": "2022-11-08T19:35:30.991Z",
"updated_at": "2022-11-08T19:35:30.991Z",
"default": false,
"address1": "1600 Pennsylvania Ave NW",
"address2": null,
"city": "Washington",
"state_name": null,
"zipcode": "20500",
"phone": "(202) 456-1111",
"active": true,
"backorderable_default": true,
"propagate_all_variants": false,
"admin_name": null
},
"relationships": {
"country": {
"data": {
"id": "413",
"type": "country"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/stock_locations?page=1&per_page=&include=",
"next": "http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page="
}
}
Returns a list of Stock Locations
curl --request GET \
--url http://{defaultHost}/api/v2/platform/stock_locations \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "175",
"type": "stock_location",
"attributes": {
"name": "Jonnie Pollich",
"created_at": "2022-11-08T19:35:30.989Z",
"updated_at": "2022-11-08T19:35:30.989Z",
"default": false,
"address1": "1600 Pennsylvania Ave NW",
"address2": null,
"city": "Washington",
"state_name": null,
"zipcode": "20500",
"phone": "(202) 456-1111",
"active": true,
"backorderable_default": true,
"propagate_all_variants": false,
"admin_name": null
},
"relationships": {
"country": {
"data": {
"id": "413",
"type": "country"
}
}
}
},
{
"id": "176",
"type": "stock_location",
"attributes": {
"name": "Lidia Hamill",
"created_at": "2022-11-08T19:35:30.991Z",
"updated_at": "2022-11-08T19:35:30.991Z",
"default": false,
"address1": "1600 Pennsylvania Ave NW",
"address2": null,
"city": "Washington",
"state_name": null,
"zipcode": "20500",
"phone": "(202) 456-1111",
"active": true,
"backorderable_default": true,
"propagate_all_variants": false,
"admin_name": null
},
"relationships": {
"country": {
"data": {
"id": "413",
"type": "country"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/stock_locations?page=1&per_page=&include=",
"next": "http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/stock_locations?include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/stock_locations?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?