Inventory / Index

Name	Inventory Index
Description	Returns information for all of the inventory an Office has sent to TEvo
Type	`GET`
URL	`/v9/inventory`
Credential Type	`APICredential\|UserCredential`
Supports Pagination	Cursor Pagination

Long Description

Returns information for all of the inventory an Office has sent to TEvo.

Parameters

Name	Description	Value Type	Required

Name

Description

Value Type

Required

office_id

ID of the Office for which you would like to get inventory

Integer

Required

state

Indicates if you want to retrieve inventory that has been mapped (available for sale on a specific event) or is unmapped (waiting to be mapped to an event). One of

ALL
MAPPED
UNMAPPED

String

Optional.

Default: ALL.

Pagination Parameters

Note: When paginating, you must include the state parameter as either MAPPED or UNMAPPED

Name	Description	Value Type	Required

Name

Description

Value Type

Required

page[cursor]

Remote ID to start paginating from, ascending. This is the ID on your system or record.

Integer

Optional.

Default: 1

page[items]

Number of items to return. You will receive the first <items> inventory,MAPPED or UNMAPPED, depending on the state value passed, starting with <cursor> and counting up.

Integer

Optional.

Default: 10000

When you receive a response, to get the next page available, take the last remote_id of the page response, add 1 to it, then make a second call with this new remote_id + 1 as the cursor. Stop when there are no items returned.

Response Properties

Name	Description	Value Type	Notes

Name	Description	Value Type	Notes
`id`	TEvo’s ID for the ticket group	Integer\|`NULL`	`NULL` if the inventory is not yet mapped.
`remote_id`	This is the ID of the ticket group in your POS that was provided when the tickets were sent to TEvo.	Integer
`event_id`	The ID of the TEvo Event where these tickets are available for sale.	Integer\|`NULL`	`NULL` if the inventory is not yet mapped.

Examples

Request	Response

Request

Response

GET /v9/inventory?office_id=1234

or

GET /v9/inventory?office_id=1234&state=ALL

[
  {
    "id": 1939203215,
    "remote_id": 605696419,
    "event_id": 2306558
  },
  {
    "id": null,
    "remote_id": 79253586,
    "event_id": null
  },
  {
    "id": null,
    "remote_id": 79253588,
    "event_id": null
  },
  {
    "id": 1952306134,
    "remote_id": 600809252,
    "event_id": 2236152
  }
]

GET /v9/inventory?office_id=1234&state=MAPPED

[
  {
    "id": 1939203215,
    "remote_id": 605696419,
    "event_id": 2306558
  },
  {
    "id": 1952306134,
    "remote_id": 600809252,
    "event_id": 2236152
  }
]

GET /v9/inventory?office_id=1234&state=UNMAPPED

[
  {
    "id": null,
    "remote_id": 79253586,
    "event_id": null
  },
  {
    "id": null,
    "remote_id": 79253588,
    "event_id": null
  }
]