Skip to content

Inventory API

Jump to bottom
milhowz edited this page Feb 20, 2013 · 21 revisions

##Object: TicketBlock

Field Type Description
ticket_id string your unique ID for this ticket
event_id string ScoreBig event ID
section string
row string
quantity string
start_seat string
end_seat string
odd_even bool indicates odd/even seating (e.g. "1,3,5" or "2,4,6")
electronic bool indicates whether or not eTickets are available for this TicketBlock
ga bool indicates whether or not the tickets are general admission
splits string indicates valid splits for this TicketBlock (up to 8)
face_value decimal face value of the ticket
price decimal your price for the ticket
notes string
in_hand_date date indicates when tickets will be available for delivery
expiration_datetime string indicates when tickets will be taken off ScoreBig

##Method: Get Inventory

This function returns a TicketBlock object for a specific ticket_id.

###URI

HTTP Method URI Description
GET /{:version}/tickets/{:ticket_id} returns TicketBlock identified by ticket_id
GET /{:version}/tickets?ticket_id={:ticket_id} returns TicketBlock identified by ticket_id
GET /{:version}/tickets?event_={:event_id} returns listing of TicketBlocks for specific Event

###Input Parameters

Parameter Type Occurrence Description
api_key guid required
ticket_id string conditional your unique ID for this ticket. required if event_id is not provided.
event_id guid conditional the ScoreBig ID for an event. required if ticket_id is not provided.

###Example #1 (single TicketBlock)

#####Sample Request

GET http://developer.api.scorebig.com/1/tickets/12345?api_key=abcde

GET http://developer.api.scorebig.com/1/tickets?api_key=abcde&ticket_id=12345

note: both URLs represent the same resource: a Ticket with ID '12345'

#####Sample Response

{
    "type": "TicketBlock",
    "count": 1,
    "results": [
        {
            "ticket_id": "777",
            "event_id": "00000000-0000-0000-0000-000000000001",
            "section": "MEZ",
            "row": "A",
            "quantity": 4,
            "start_seat": "20",
            "end_seat": "23",
            "odd_even": false,
            "ga": false,
            "electronic": false,
            "splits": "1,2,3,4",
            "price": 21,
            "notes": null,
            "in_hand_date": null,
            "expiration_datetime": "1/1/2020 12:00:00 AM"
        }
    ]
}

###Example #2 (all TicketBlocks for an Event)

#####Sample Request

GET http://developer.api.scorebig.com/1/tickets?api_key=abcde&event_id=2234533

#####Sample Response

{
    "type": "TicketBlock",
    "count": 3,
    "results": [
        {
            "ticket_id": "777",
            "event_id": "00000000-0000-0000-0000-000000000001",
            "section": "MEZ",
            "row": "A",
            "quantity": 4,
            "start_seat": "20",
            "end_seat": "23",
            "odd_even": false,
            "ga": false,
            "electronic": false,
            "splits": "1,2,3,4",
            "price": 21,
            "notes": null,
            "in_hand_date": null,
            "expiration_datetime": "1/1/2020 12:00:00 AM"
        },
        {
            "ticket_id": "888",
            "event_id": "00000000-0000-0000-0000-000000000001",
            "section": "MEZ",
            "row": "B",
            "quantity": 6,
            "start_seat": "20",
            "end_seat": "25",
            "odd_even": false,
            "ga": false,
            "electronic": false,
            "splits": "1,2,3,4,5,6",
            "price": 21,
            "notes": null,
            "in_hand_date": null,
            "expiration_datetime": "1/1/2020 12:00:00 AM"
        },
        {
            "ticket_id": "999",
            "event_id": "00000000-0000-0000-0000-000000000001",
            "section": "MEZ",
            "row": "C",
            "quantity": 8,
            "start_seat": "20",
            "end_seat": "27",
            "odd_even": false,
            "ga": false,
            "electronic": false,
            "splits": "1,2,3,4,5,6,7,8",
            "price": 21,
            "notes": null,
            "in_hand_date": null,
            "expiration_datetime": "1/1/2020 12:00:00 AM"
        }
    ]
}

##Method: Insert/Update Inventory

This method takes in a listing of your TicketBlocks and imports them into our system. If event ids are provided, it will quickly find the appropriate events and save the blocks to them. Otherwise, the system will attempt to heuristically match TicketBlocks to their corresponding event in our system. This is not a differencing system, so new blocks will be added and existing blocks will be updated. If you delete a block on your side, please make sure to call the Delete Inventory method to remove it from our system so we don't sell it. Merely excluding it from a future import will not remove it from our system.

###URI

HTTP Method URI Description
PUT /{:version}/tickets/{:ticket_id} inserts or updates a TicketBlock identified by ticket_id
POST /{:version}/tickets bulk inserts or updates multiple TicketBlocks

###Input Parameters

Parameter Type Occurrence Description
api_key guid required
ticket_id string required your unique ID for this ticket.
event_id guid optional the ScoreBig ID for an event. use this for improved performance.
event_date_time string required Local event date time, in the format of MM-dd-yyyy hh:mm zz
venue string required Venue name. Please use current name of the venue
venue_address string optional Can improve event matching if provided
venue_city string optional Can improve event matching if provided
venue_state string optional Can improve event matching if provided
section string required
row string required
quantity int required
start_seat string required
end_seat string required
odd_even bool optional Specifies if seats are odd/even (e.g. 1,3,5 or 2,4,6). default is FALSE
splits string optional Comma-separated list of valid splits, i.e. 2,3,4,6,8. Max split is 8.
price decimal required Your price for the ticket
electronic bool optional Whether or not e-tickets are available. default is FALSE
in_hand_date string optional The date the listing can be shipped
notes string optional Any notes or comments associated with this ticket

###Example 1 - Insert Single TicketBlock

####Sample Request

PUT http://developer.api.scorebig.com/1/tickets/222

{
    "ticket_id": "222",
    "event_id": "00000000-0000-0000-0000-000000000001",
    "section": "MEZ",
    "row": "B",
    "quantity": 4,
    "start_seat": "20",
    "end_seat": "23",
    "odd_even": false,
    "price": "21"
}

###Sample Response

{
    "type" : "TicketResult",
    "count" : 1,
    "results" : [{
            "ticket_id" : "222",
            "result" : "Success"
        }
    ]
}

###Example 2 - Bulk Insert Multiple TicketBlocks

####Sample Request

POST http://developer.api.scorebig.com/1/tickets

{
    "tickets": [
        {
            "ticket_id": "777",
            "event_id": "00000000-0000-0000-0000-000000000001",
            "section": "MEZ",
            "row": "A",
            "quantity": 4,
            "start_seat": "20",
            "end_seat": "23",
            "is_ga": false,
            "odd_even": false,
            "price": "21"
        },
        {
            "ticket_id": "666",
            "event_id": "00000000-0000-0000-0000-000000000001",
            "section": "MEZ",
            "row": "B",
            "quantity": 6,
            "start_seat": "20",
            "end_seat": "25",
            "is_ga": false,
            "odd_even": false,
            "price": "21"
        },
        {
            "ticket_id": "777",
            "event_id": "00000000-0000-0000-0000-000000000001",
            "section": "MEZ",
            "row": "C",
            "quantity": 8,
            "start_seat": "20",
            "end_seat": "27",
            "is_ga": false,
            "odd_even": false,
            "price": "21"
        }
    ]
}

####Sample Response

The response will be a list results, one for each TicketBlock, that details what happened to each block.

{
    "type" : "TicketResult",
    "count" : 3,
    "results" : [
        {
            "ticket_id" : "777",
            "result" : "Success"
        }, 
        {
            "ticket_id" : "666",
            "result" : "Success"
        }, 
        {
            "ticket_id" : "555",
            "result" : "More than one event was detected.  Try using an explicit Event ID in your request."
        }
    ]
}

##Resource: Delete Inventory

This function will take a list of ticketblock ids and remove them from our system immediately.

###URI

HTTP Method URI Description
DELETE /{:version}/tickets/{:ticket_id} deletes TicketBlock identified by ticket_id
POST /{:version}/tickets/delete deletes all TicketBlocks identified by list of ticket_id

###Input Parameters

Parameter Type Occurrence Description
api_key guid required
ticket_id string required list of ticket_ids to be deleted.

###Example 1 - Delete Single Ticket

####Sample Request

DELETE http://developer.api.scorebig.com/1/tickets/222

####Sample Response

{
    "type" : "Result",
    "count" : 1,
    "results" : ["Successfully deleted 1 of 1 ticket block(s)."]
}

###Example 2 - Bulk Delete Tickets

####Sample Request

POST http://developer.api.scorebig.com/1/tickets/delete

{
    "ticket_id": [
        "777",
        "888"
    ]
}

####Sample Response

The response will be a list of results, one for each ticketblock, that details what happened while deletion. Common results will be success or not found.

{
    "type" : "Result",
    "count" : 1,
    "results" : ["Successfully deleted 2 of 2 ticket block(s)."]
}

Clone this wiki locally