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

Licenses Required

Vista.Ocapi

Request

path Parameters

siteId

required

string

The unique identifier of the site

header Parameters

Connect-Region-Code

string

Region Code

Responses

200

Success

404

Site does not exist.

get/ocapi/v1/sites/{siteId}/item-availability

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"itemAvailabilities": [{"itemId": "string",
"status": "Available"
}
],
"siteId": "string",
"relatedData": {"site": {"location": {"latitude": 0.1,
"longitude": 0.1
},
"contactDetails": {"phoneNumbers": [{"type": "Home",
"number": "string"
}
],
"email": "string",
"address": {"line1": "60 Khyber Pass Road",
"line2": "Grafton",
"city": "Auckland 1023"
}
},
"ianaTimeZoneName": "America/New_York",
"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"hasSellableItems": true,
"allowedItemDeliveryMethods": ["CounterPickup"
]
}
}
}