This API specification is available for download as an Open API 3.0 YAML file:
Authentication
Basic Authentication
Please configure your clients to use this authentication method to submit user name and password.
Authorization
The permission 'ATP REST service' is required.
API Specification
/atp/{shopId}/{id}
GET:
Description
Get the currently available quantity of a product.
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | shopId | integer int64 | | 1000 | Required | The id of the shop. |
in path | id | array | | 12345,67890,13579,24680 | Required | One or more product ids which are separated by comma. |
in query | resvId | integer int64 | | 15280 | The id of a reservation if desired. |
Response
200 - OK
HttpResponseListAtp application/json
400 - Bad Request
401 - Unauthorized Authentication information is missing or invalid
403 - Forbidden
415 - Unsupported Media Type
500 - Internal Server Error An unexpected error occured
HttpResponseListAtp application/json
{"data":
array
An array of Atp
objects. The list of Atp-objects.
[
Atp
:
The ATP-object that contains information about the availablity of a product.{
"id":
string
Id of the product. | Min Length: 0
| Max Length: 30
| Example: 12345677890
"location":
string
Name of the supplier as used by the shop. | Min Length: 0
| Max Length: 50
| Example: Supplier X
"stock":
integer
The current stock level. | Format: int32
| Example: 1500
"reserved":
integer
The reserved stock - quantity that was reserved. | Format: int32
| Example: 100
"blocked":
integer
The blocked stock - quantity that was already sold. | Format: int32
| Example: 473
"atp":
integer
The available quantity (stock-level - blocked stock - reserved stock). | Format: int32
| Example: 927
"modificationDate":
string
Last update of the availablity. | Format: date-time
"state":
string
Status of the general availability [sold out, temporarily not available, available] | Example: available
}
]
"statusCode":
integer
The status code of the response. | Format: int32
"errors":
array
An array of FieldError
objects. Errors at parameters.
[
FieldError
:
Errors at parameters.{
}
]
"exceptions":
array
An array of CodedException
objects. Exceptions.
[
CodedException
:
Exceptions.{
}
]
}The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.