The GetItemInventoryObjectsResponse JSON object will be returned as the response to an API call to retrieve ItemInventory objects when the returnType is objects.
- isodate fields use one of these ISO 8601 formats: 2014-01-01T10:30:00.000+01:00, 2014-01-01T10:30:00.000+0100, 2014-01-01T10:30:00.000Z
- Dsco reserves the right to add new attributes at any time so Partners should ensure their validators won't break should this happen
Attributes
Name | Req | Type | Description |
---|---|---|---|
results | ✓ |
ItemInventory[] |
The list of ItemInventory objects being returned from the API call |
requestId | ✓ |
string | A unique ID representing this request |
pageId | string | If present, there may be more pages of results so call the API in question again, passing this pageId in to get the next page of results | |
highWaterMark | string | This value will only be returned when the API query was pageId is not provided, meaning on the first page of results, subsequent pages will not include this attribute Pass this value in the next time you call the API to get all objects that have changed since the previous API call was made |
Example
{ "results": [<ItemInventoryObj>, ...], "pageId": "1720c730-c141-4729-b319-00d5ac990864" }
Comments
Please sign in to leave a comment.