Inventory / Create

Name	Inventory / Create
Description	Create an Inventory Ticket Listing
Type	`POST`
URL	`/v9/inventory`
Credential Type	`APICredential\|UserCredential`

Long Description

Create a listing that represents inventory available for sale. The ticket listing must include all required information necessary to make the inventory eligible for order creation. Note that office_id and remote_id together serve as the unique identifiers for the listing.

Request Parameters

Inventory Object

Attribute Name	Type	Required

Attribute Name	Type	Required
`event`	Event Object	Yes
`office`	Office Object	Yes
`ticket`	Ticket Object	Yes
`venue`	Venue Object	Yes

Event Object

Attribute Name	Type	Required

Attribute Name	Type	Required
`id`	Integer	Yes
`name`	String	No
`occurs_at_date`	String (Date)	No
`occurs_at_time`	String (Time)	No
`tbd`	Boolean	No
`type`	String (Enum)	Acceptable Values: `EVENT` `PARKING`

Office Object

Attribute Name	Type	Required	Notes

Attribute Name	Type	Required	Notes
`id`	Integer	Yes	If using a `UserCredential`, this needs to be the same office associated with the credential
`name`	String	No

Ticket Object

Attribute Name	Type	Required	Notes

Attribute Name	Type	Required	Notes
`account_email`	String	No
`cost`	Float	No
`discount`	Float	No	Acceptable values between 0.00 and 100.00
`eticket`	Boolean	No
`external_notes`	String	No
`face_value`	Float	No
`format`	String (Enum)	Yes	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	Yes	Maximum value is 1,000,000
`quantity`	Integer	Yes	Minimum value is 1 Must match Seats Array elements if seats are provided
`remote_id`	Integer	Yes	Must be greater than 0
`row`	String	Yes
`seats`	Array of Seat Object(s)	No	If provided, minimum value is 1
`section`	String	Yes
`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)	Yes	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	Required	Notes

Attribute Name	Attribute Name	Required	Notes
`seat`	Integer	Yes	Values must be unique
`barcode`	String	No
`primary_ticket_id`	String	No
`verification_id`	String	No

Venue Object

Attribute Name	Type	Required

Attribute Name	Type	Required
`id`	Integer	No
`name`	String	Yes

Responses

HTTP Code	Meaning	Description

HTTP Code	Meaning	Description
201	Created	Inventory was successfully created. Response body contains the new inventory with id.
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.
500	Internal Server Error	A generic internal service error message is returned.

Examples:

Request	Response

Request

Response

POST /v9/inventory

{
  "inventory": {
    "event": {
      "id": "12345678",
      "name": "Superbowl LIX",
      "occurs_at_date": "2021-06-08",
      "occurs_at_time": "18:19:20",
      "tbd": false,
      "type": "EVENT"
    },
    "office": {
      "id": "12345678",
      "name": "Foobar"
    },
    "ticket": {
      "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",
      "in_hand": false,
      "in_hand_on": "2021-06-08",
      "instant_delivery": false,
      "internal_notes": "These are some notes...",
      "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
    },
    "venue": {
      "id": "12345678",
      "name": "Foobar"
    }
  }
}

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": {
    ...,
    "ticket" :
      ...,
      "account_email": "invalid email"
  }
}

Error

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