v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Items

Gets the current list of item availability entities for a particular site

Licenses Required

  • Vista.Ocapi
get/ocapi/v1/sites/{siteId}/item-availability

Path parameters

siteIdstring required

The unique identifier of the site

Headers

Connect-Region-Codestring

Region Code

Response

Success

siteIdstring required

Gets the unique identifier of the site

Example response

{
  "relatedData": {
    "site": {
      "contactDetails": {
        "address": {
          "line1": "60 Khyber Pass Road",
          "line2": "Grafton",
          "city": "Auckland 1023"
        }
      },
      "ianaTimeZoneName": "America/New_York",
      "name": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    }
  }
}