Locations
Retrieves all locations for a specified site.
Required scopes
availability.availability_view
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
testtenant
Site code, defined when the site is created.
shop1
The request was successful. A list of locations is returned.
The request was syntactically incorrect. Details are provided in the response.
The authorization token is invalid or has expired. Details are provided in the response.
Provided authorization scopes are not sufficient and do not match scopes required by the endpoint.
The requested resource was not found.
Some server-side error occurred. Details are provided in the response.
GET /availability/{tenant}/locations/{site} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "shop1:1234",
"site": "shop1",
"rack": "1234",
"rackName": "Tools",
"order": 1
}
]
Adds a new location to a specified site.
Required scopes
availability.availability_manage
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
testtenant
Site code, defined when the site is created.
shop1
Physical location of the product.
Unique identifier of the location.
Note: The value should be provided in the site
:rack
format.
shop1:1234
Site code, defined when the site is created. The value should match the site
query/path parameter value.
shop1
Rack number.
1234
Name of the rack.
Tools
Order of the location, expressed as a number.
1
The request was successful. The location has been added to the site.
The request was syntactically incorrect. Details are provided in the response.
The authorization token is invalid or has expired. Details are provided in the response.
Provided authorization scopes are not sufficient and do not match scopes required by the endpoint.
Resource already exists.
Some server-side error occurred. Details are provided in the response.
POST /availability/{tenant}/locations/{site} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"id": "shop1:1234",
"site": "shop1",
"rack": "1234",
"rackName": "Tools",
"order": 1
}
{
"message": "Successfully created location with id: shop1:1234",
"code": 201
}
Updates locations for a specified site.
Required scopes
availability.availability_manage
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
testtenant
Site code, defined when the site is created.
shop1
Unique identifier of the location.
shop1:1234
Order of the location, expressed as a number.
1
The request was successful. The locations have been updated.
The request was syntactically incorrect. Details are provided in the response.
The authorization token is invalid or has expired. Details are provided in the response.
Provided authorization scopes are not sufficient and do not match scopes required by the endpoint.
Some server-side error occurred. Details are provided in the response.
PUT /availability/{tenant}/locations/{site} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66
[
{
"id": "shop1:1234",
"order": 1
},
{
"id": "secondary:4321",
"order": 10
}
]
{
"message": "Successfully modified 5 location(s)",
"code": 200
}
Deletes a specified location.
Required scopes
availability.availability_manage
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
testtenant
Location's unique identifier.
shop1:1234
The request was successful. The location has been deleted.
The authorization token is invalid or has expired. Details are provided in the response.
Provided authorization scopes are not sufficient and do not match scopes required by the endpoint.
Some server-side error occurred. Details are provided in the response.
DELETE /availability/{tenant}/locations/{location} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"message": "Successfully deleted 5 location(s)",
"code": 200
}
Retrieves locations of specified products.
Required scopes
availability.availability_view
Your Emporix tenant's name.
Note: The tenant name should always be provided in lowercase.
testtenant
Site code, defined when the site is created.
shop1
List of product IDs. A product IDs is generated when the product is created through the Product Service.
["5f7c996173fc281cdd412345","5f7c996173fc281cdd412345"]
The request was successful. A list of locations is returned.
The request was syntactically incorrect. Details are provided in the response.
The authorization token is invalid or has expired. Details are provided in the response.
Provided authorization scopes are not sufficient and do not match scopes required by the endpoint.
The requested resource was not found.
Some server-side error occurred. Details are provided in the response.
POST /availability/{tenant}/search/locations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85
{
"site": "shop1",
"productIds": [
"5f7c996173fc281cdd412345",
"5f7c996173fc281cdd412345"
]
}
[
{
"productId": "5f7c996173fc281cdd412345",
"locations": [
{
"site": "shop1",
"zone": "zone1",
"rack": "1",
"rackName": "Tools",
"shelf": "shelf1",
"section": "section1",
"bin": "bin1",
"order": 1
}
]
}
]
Was this helpful?