LocationResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LocationResponse",
  "title": "LocationResponse",
  "type": "object",
  "properties": {
    "href": {
      "type": "string",
      "description": "The URI of the current page of results from the result set."
    },
    "limit": {
      "type": "integer",
      "description": "The number of items returned on a single page from the result set.",
      "format": "int32"
    },
    "next": {
      "type": "string",
      "description": "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. <br><br><b>Max length</b>: 2048"
    },
    "offset": {
      "type": "integer",
      "description": "The number of results skipped in the result set before listing the first returned result. This value is set in the request with the <b>offset</b> query parameter. <p class=\"tablenote\"><strong>Note: </strong>The items in a paginated result set use a zero-based list where the first item in the list has an offset of <code>0</code>.</p>",
      "format": "int32"
    },
    "prev": {
      "type": "string",
      "description": "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. <br><br><b>Max length</b>: 2048"
    },
    "total": {
      "type": "integer",
      "description": "The total number of items retrieved in the result set.  <br><br>If no items are found, this field is returned with a value of <code>0</code>.",
      "format": "int32"
    },
    "locations": {
      "type": "array",
      "description": "An array of one or more of the merchant's inventory locations.",
      "items": {
        "$ref": "#/components/schemas/InventoryLocationResponse"
      }
    }
  },
  "description": "This type is used by the base response payload for the <strong>getInventoryLocations</strong> call."
}