SlotStatus Endpoint
Warning: You are viewing an old version of the DRS docs. To access the new APIs, see Dash Replenishment Overview.
When the contents of a slot are consumed, the device must call DRS using the SlotStatus endpoint to report on the current state of the slot.
- Path
- HTTP Method
- Header Parameters
- Versioning
- Request Body Parameters
- Response Example
- Error Responses
Path
/slotStatus/{SLOT_ID}
HTTP Method
POST
Header Parameters
Authorization: Bearer (ACCESS_TOKEN)
x-amzn-accept-type: com.amazon.dash.replenishment.DrsSlotStatusResult@1.0
x-amzn-type-version: com.amazon.dash.replenishment.DrsSlotStatusInput@1.0
Versioning
Versioning is used to incrementally update API functionality without directly impacting customers. x-amzn-type-version and x-amzn-accept-type headers must be sent with each call. The following are supported by the SlotStatus Endpoint:
x-amzn-type-version: com.amazon.dash.replenishment.DrsSlotStatusInput@1.0
x-amzn-accept-type: com.amazon.dash.replenishment.DrsSlotStatusResult@1.0
Request Body Parameters
The following data must be passed in the request body:
| Parameter | Description | Type |
|---|---|---|
expectedReplenishmentDate |
The expected product replenishment date in ISO 8601 format. | String |
remainingQuantityInUnit |
Remaining quantity of the container (in the unit of measurement agreed with your Amazon point of contact). | Integer |
originalQuantityInUnit |
Total quantity of product the container had when it was full (in the unit of measurement agreed with your Amazon point of contact). | Integer |
totalQuantityOnHand |
Total quantity of product on hand, but not loaded into the device (if known). | Integer |
lastUseDate |
The last time that product was consumed from a given slot in ISO 8601 format. | String |
Sample Request Body
{
"expectedReplenishmentDate" : "2015-12-28T10:00:00Z",
"remainingQuantityInUnit" : 3.5,
"originalQuantityInUnit" : 10,
"totalQuantityOnHand" : 20,
"lastUseDate" : "2015-12-21T10:00:00Z"
}
Response Example
HTTP/1.1 200 OK
x-amzn-type-version: com.amazon.dash.replenishment.DrsSlotStatusResult@1.0
Error Responses
| Error | Description |
|---|---|
| HTTP/1.1 500 Internal Server Error | Indicates that an error occurred internally to the server. |
| HTTP/1.1 400 Bad Request | Client Error: An error occurred due to data passed in by the client (e.g. bad token). Amazon will make a best effort to provide feedback on the nature of the failure in the response body. |
Last updated: Aug 07, 2018