Inventory / Update

Inventory / Update

Name

Inventory / Update

Description

Update an Inventory Ticket Listing

Type

PATCH

URL

/v9/inventory/:id

Credential Type

APICredential|UserCredential

Long Description:

Update a listing that represents a change to inventory available for sale. All parameters are optional unless otherwise specified. Any optional parameters that are provided with a blank value (e.g. ”” ) will result in a validation error.

Request Parameters:

Inventory Object

Attribute Name

Type

Required

Notes

Attribute Name

Type

Required

Notes

account_email

String

No

Email format

cost

Float

No

 

discount

Float

No

Acceptable values between 0.00 and 100.00

eticket

Boolean

No

 

external_notes

String

No

 

face_value

Decimal

No

 

format

String (Enum)

No

Acceptable Values:

  • Eticket

  • Flash_seats

  • Guest_list

  • Paperless

  • Physical

  • TM_mobile

in_hand

Boolean

No

 

in_hand_on

String (Date)

Conditional

Required when in_hand is false or not provided

instant_delivery

Boolean

No

 

internal_notes

String

No

 

price

Decimal

No

Maximum value is 1,000,000

quantity

Integer

No

  • Minimum value is 1

  • Must match Seats Array elements if seats are provided

  • If this value is different from the existing quantity, the associated tickets will be recreated (whether or not the seats array is explicitly provided)

remote_id

Integer

No

Must be greater than 0

row

String

No

 

seats

Array of Seat Object(s)

No

If provided, minimum value is 1

section

String

No

 

speculative

Boolean

No

 

split_type

String (Enum)

No

Acceptable Values:

  • DEFAULT

  • ANY

  • NEVERLEAVEONE

  • NONE

  • CUSTOM

split_override

Array of Integers

Conditional

Required if split_type is CUSTOM

taxed_cost

Float

No

 

type

String (Enum)

No

Acceptable Values:

  • EVENT

  • PARKING

view_type

String (Enum)

No

Acceptable Values:

  • Full

  • Obstructed

  • Possibly Obstructed

  • Partially Obstructed

wheelchair_accessible

Boolean

No

 

Seat Object

Attribute Name

Attribute Name

Attribute Name

Notes

Attribute Name

Attribute Name

Attribute Name

Notes

seat

Integer

Yes

Values must be unique

barcode

String

No

 

primary_ticket_id

String

No

 

verification_id

String

No

 

Responses

HTTP Code

Meaning

Description

HTTP Code

Meaning

Description

200

OK

Inventory was successfully updated. Response body contains the updated inventory.

400

Bad Request

Validation error. Check input fields and formats. A detailed error message is included in the response body.

401

Unauthorized

Authentication failed or missing credentials.

404

Not Found

Resource not found for the provided identifiers.

500

Internal Server Error

An unexpected error occurred on the server.

Examples

Request

Response

Request

Response

PATCH /v9/inventory/123456

{ "inventory": { "account_email": "foo@bar.com", "cost": "123.45", "discount": "40.71", "eticket": false, "external_notes": "These are some notes...", "face_value": "123.45", "format": "ETICKET", "id": "12345678", "in_hand": false, "in_hand_on": "2021-06-08", "instant_delivery": false, "locked": false, "price": "123.45", "quantity": 4, "remote_id": "12345678", "row": "AA", "seats": [ { "seat": 14, "barcode": "ABCD1234", "primary_ticket_id": "12345678", "verification_id": "12345678" } ], "section": "100", "speculative": false, "split_type": "DEFAULT", "split_override": [ 2, 5, 10 ], "taxed_cost": "123.45", "type": "EVENT", "view_type": "FULL", "wheelchair_accessible": false } }

 Success

{ "inventory": { "account_email": "foo@bar.com", "cost": "123.45", "discount": "40.71", "eticket": false, "external_notes": "These are some notes...", "face_value": "123.45", "format": "ETICKET", "id": "12345678", "in_hand": false, "in_hand_on": "2021-06-08", "instant_delivery": false, "locked": false, "price": "123.45", "quantity": 4, "remote_id": "12345678", "row": "AA", "seats": [ { "seat": 14, "barcode": "ABCD1234", "primary_ticket_id": "12345678", "verification_id": "12345678" } ], "section": "100", "speculative": false, "split_type": "DEFAULT", "split_override": [ 2, 5, 10 ], "taxed_cost": "123.45", "type": "EVENT", "view_type": "FULL", "wheelchair_accessible": false } }

Bad Request Example

{ "inventory": { ..., "account_email": "invalid email" } }

Error

{ "errors": [ { "code": "invalid_params", "message": "inventory[account_email] is in invalid format" } ] }