Venue Inventory Overview

Permissions

For permissions to the Venue Inventory API, contact your account manager.

Security

Every request must contain an Authorization header, which contains a bearer token that represents the authority to access a particular company and/or site.

Endpoints

Every request must contain the X-Company-Id header, which contains a 12-byte object identifier representing the company the request is for.

Error Response

A sample error response is shown below:

{
    "id": "28c77381-152e-4695-84d7-fa56e7583204",
    "status": 401,
    "title": "Invalid token",
    "detail": "dispatch (mdw.js:15)",
    "meta": {
        "message": "Invalid token type",
        "code": "INVALID_TOKEN",
        "correlation_id": "5594e6c9-3c14-4a90-96e2-c1273d323f29"
        }
    }
}

The id is an error id which generated by uuid.

The title is error message title.

The detail is error stack.

The meta is error detail.

The status is a http status code.

Commonly used status codes are: 200、201、204、400、401、403、404、422、500、504.