| Code | Description |
|---|---|
| 401 | Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource. |
| 403 | Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource. |
| 404 | Not Found. The requested resource could not be found. |
| 422 | Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors. |
| 500 | Internal Server Error. An unexpected condition was encountered. |
Response:
{
"page": 1,
"per_page": 50,
"total_pages": 1,
"total_entries": 1,
"entries": [
{
"id": 1,
"street_line_1": "41 Rawson Street",
"street_line_2": "",
"city": "Epping",
"state_or_region": "NSW",
"country_code": "AU",
"post_code": "2121",
"timezone": "",
"latitude": null,
"longitude": null,
"name": "Location 1",
"support_pickup": false,
"ship_from_store": false,
"code": "location_1",
"external_code":"external_location_1"
"phone": "+61280266800",
"pickup_instructions": "",
"website_url": "",
"utc_offset": null,
"discontinued": false,
"business_hours": [
{
"id": 1,
"day": "monday",
"day_name": "Monday",
"business_hour_type": "normal",
"special_date": null,
"closed": null,
"day_value": 1,
"open": "09:00:00",
"close": "17:00:00"
},
{
"id": 2,
"day": "tuesday",
"day_name": "Tuesday",
"business_hour_type": "normal",
"special_date": null,
"closed": null,
"day_value": 2,
"open": "09:00:00",
"close": "17:00:00"
},
{
"id": 3,
"day": "wednesday",
"day_name": "Wednesday",
"business_hour_type": "normal",
"special_date": null,
"closed": null,
"day_value": 3,
"open": "09:00:00",
"close": "17:00:00"
},
{
"id": 4,
"day": "thursday",
"day_name": "Thursday",
"business_hour_type": "normal",
"special_date": null,
"closed": null,
"day_value": 4,
"open": "09:00:00",
"close": "17:00:00"
},
{
"id": 5,
"day": "friday",
"day_name": "Friday",
"business_hour_type": "normal",
"special_date": null,
"closed": null,
"day_value": 5,
"open": "09:00:00",
"close": "17:00:00"
},
{
"id": 6,
"day": "saturday",
"day_name": "Saturday",
"business_hour_type": "normal",
"special_date": null,
"closed": null,
"day_value": 6,
"open": "00:00:00",
"close": "00:00:00"
},
{
"id": 7,
"day": "sunday",
"day_name": "Sunday",
"business_hour_type": "normal",
"special_date": null,
"closed": null,
"day_value": 7,
"open": "00:00:00",
"close": "00:00:00"
},
{
"id": 8,
"day": null,
"day_name": "Christmas Day",
"business_hour_type": "special",
"special_date": "2018-12-25T00:00:00.000+11:00",
"closed": true,
"day_value": null,
"open": "00:00:00",
"close": "00:00:00"
}
],
"inventory_sources": [
{
"id": 1,
"name": "MOTUL"
}
]
}
]
}
| Param name | Description |
|---|---|
|
per_page optional |
Number of objects in one response. Default is 50 Validations:
|
|
page optional |
Page number. Default is 1 Validations:
|
|
created_time_from optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
created_time_to optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
updated_time_from optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
updated_time_to optional |
ISO_8601 format 2016-05-30T05:13:26Z Validations:
|
|
id optional |
Entity ID Validations:
|
|
identifier_name optional |
Extra identifier name added via EntityIdentifier endpoint Validations:
|
|
entity_key optional |
Extra entity identifier key added via EntityIdentifier endpoint Validations:
|
|
lang optional |
Language code for translated value Validations:
|