inventory API1.14.0

LocationResponse

This type is used by the base response payload for the getInventoryLocations call.

Types that use LocationResponse

Not used by any types

Call that uses LocationResponse

Fields

Field
Type
Description
href
The URI of the current page of results from the result set.
limit
The number of items returned on a single page from the result set.
next
The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set.

Max length: 2048
offset
The number of results skipped in the result set before listing the first returned result. This value is set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

prev
The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set.

Max length: 2048
total
The total number of items retrieved in the result set.

If no items are found, this field is returned with a value of 0.
locations
An array of one or more of the merchant's inventory locations.