Orders / Show
Name | Orders / Show |
---|---|
Description | Display details for a specific Order |
Type | GET |
URL | /v9/orders/:order_id |
API|User |
Long Description
Displays details of an order.
Order number
Ticket Evolution uses order numbers that are actually in the format order_group
-order_id
. The order_id
in the URL is only right-side portion. e.g.: To show the order details for 199401-473339 use /v9/orders/473339
as your URL
Parameters
Name | Description | Type | Presence | Location |
---|---|---|---|---|
| The ID of the specific Order | Integer | Required | URI |
Properties
Name | Description | Type |
---|---|---|
| An amount defined as an additional expense at the time of order placement | Decimal |
| The remaining amount owed on the order | Decimal |
| An Address designated as the billing address for this order | Object |
| The entity considered to be the buyer in this Order. Either a Client or a Brokerage | Object |
| Cancellation notes created by the buyer | String|null |
| Cancellation reason created by the buyer | String|null |
| Indicates the status of the order from either the buyer’s or seller’s perspective.
| String |
| ||
| If the buyer is a Client this will be the Client’s information | Object |
| The amount of money paid buy the buyer including any refunds | Decimal |
| If the order contains ticket groups that are labeled as consignment this will be | Boolean |
| Timestamp of when the order was created | Date (ISO_8601) |
| The IP address from which the order was created. If this is a website order it is the Client’s IP address | String |
| Any discount applied to the order such as from a Promotion Code | Decimal |
| Decimal | |
fraud_check_status | Response back from fraud check provider. Values are approved, declined, or null if no check was done. | String |
| The unique ID of this Order | Integer |
| Specific instructions provided by the buyer at the time of order | String|null |
| An amount of external insurance paid at the time of order placement | Decimal |
| If | Boolean |
| The Items purchased/sold in this order | Array |
| Information from Kount for this order | Array |
| The score currently assigned to this order via Kount | String |
| The current status of this order assigned by Kount
| String |
| Changes to the Kount status of the order | Array |
| Deprecated property | NULL |
| Any notes made regarding the order that are viewable to you | Array |
| The compound ID of the order consisting of | String |
| If | Boolean |
| Defines if the | String |
| One or more Payments that have been applied to this Order | Array |
| Decimal | |
| The amount still currently owed on this Order | Decimal |
| Decimal | |
| |null | |
| String|null | |
| Amount that has been refunded to the buyer | Decimal |
| Decimal | |
| The entity considered to be the seller in this Order. Either a Client or a Brokerage | |
| Cancellation notes created by the seller | String|null |
| Cancellation reason created by the seller | String|null |
| If the seller is a user of Core this will be | Boolean |
| See | String |
| Service Fee charged to the buyer | Decimal |
| Array | |
| One or more Shipments for this order | Array |
| The amount charged to the buyer for shipping | Decimal |
| An Address that was designated as the shipping address for this order. Not necessarily related to the address assigned to the individual | Object |
| If any of the | Boolean |
| If the speculation items have been fulfilled this will be | Boolean |
| The state of the order from your perspective. Will be the same as either | String |
| String|null | |
| Array | |
| Decimal | |
| Any amount charged to the buyer that has been designated as tax. | Decimal |
| Decimal | |
| Timestamp of when this order was last updated. This includes updates to any | Date (ISO_8601) |
| The unique URL of this order | String |
Examples
Request | Response |
---|---|
GET /v9/orders/406755 | {
"additional_expense": "0.0",
"balance": "0.0",
"billing_address": {
"country_code": null,
"cross_street": null,
"extended_address": "",
"id": 7397310,
"label": null,
"latitude": null,
"locality": "",
"longitude": null,
"name": null,
"po_box": false,
"postal_code": "",
"primary": false,
"region": "",
"street_address": ""
},
"buyer": {
"address": {
"country_code": null,
"cross_street": null,
"extended_address": "",
"id": 7397310,
"label": null,
"latitude": null,
"locality": "",
"longitude": null,
"name": null,
"po_box": false,
"postal_code": "",
"primary": false,
"region": "",
"street_address": ""
},
"brokerage": {
"abbreviation": "Test Broker",
"created_at": "2019-03-25T20:49:55Z",
"email": "demo+testbroker@ticketevolution.com",
"id": 2259,
"master": false,
"name": "Test Purchases - Broker",
"natb_member": false,
"updated_at": "2023-07-20T17:03:13Z",
"url": "/brokerages/2259"
},
"email_address": "demo+office-3500@ticketevolution.com",
"evopay": true,
"id": 3500,
"name": "Test Purchases - Broker POS",
"pcc_code": "",
"phone": "480-535-5811",
"type": "Office",
"url": "/offices/3500"
},
"buyer_cancellation_notes": null,
"buyer_cancellation_reason": null,
"buyer_rejection_notes": null,
"buyer_rejection_reason": null,
"buyer_state": "completed",
"child_orders": [
406754
],
"client": null,
"completed_non_refund_payments_total": "27.45",
"consignment": false,
"created_at": "2024-09-11T17:44:30Z",
"created_by": {
"affiliate_id": null,
"affiliate_store_id": null,
"brokerage_id": 2259,
"label": null,
"office_id": 3500,
"type": "UserCredential"
},
"created_by_ip_address": null,
"discount": "0.0",
"fee": "0.0",
"fraud_check_status": null,
"id": 406755,
"instructions": null,
"insurance": "0.0",
"isPO": true,
"is_new_inventory": null,
"items": [
{
"cost": "25.3",
"created_at": "2024-09-11T17:44:30Z",
"eticket_available": false,
"eticket_delivery": false,
"eticket_downloaded_at": null,
"eticket_downloaded_by": null,
"eticket_file_size": null,
"eticket_finalized": null,
"eticket_finalized_at": null,
"eticket_pdf_pages": null,
"eticket_thumbnails": [],
"eticket_updated_at": null,
"has_spec_tickets": false,
"id": 386472,
"needs_eticket": false,
"needs_sub": false,
"order_id": 406755,
"order_item_id": 311368,
"order_item_link_id": 386472,
"price": "12.65",
"quantity": 2,
"seats": [
121,
122
],
"ticket_group": {
"brokerage_id": 1700,
"brokerage_name": "Auto-Purchase",
"event": {
"id": 2707230,
"name": "Steel Panther",
"occurs_at": "2024-09-13T20:00:00Z",
"url": "/events/2707230",
"venue": {
"address": {
"locality": "Augusta",
"region": "GA"
},
"id": 33958,
"name": "Miller Theater - GA"
}
},
"external_notes": "Orders for these tickets will be accepted and fulfilled. Scan your tickets from your mobile phone for this event.",
"face_value": "12.65",
"format": "TM_mobile",
"id": "857113226",
"in_hand": "true",
"in_hand_on": "2024-09-11",
"instant_delivery": false,
"office_id": 1692,
"office_name": "Auto-Purchase",
"quantity": 2,
"remote_id": "367558560",
"retail_price": "12.65",
"row": "20",
"seats": [
"121",
"122"
],
"section": "22",
"seller_email": null,
"tickets": [
{
"purchase_order_id": null,
"seat": "121"
},
{
"purchase_order_id": null,
"seat": "122"
}
],
"url": "/ticket_groups/857113226",
"wholesale_price": "12.65"
},
"updated_at": "2024-09-11T17:44:42Z"
}
],
"minfraud_response": null,
"notes": [
{
"category": "external",
"content": "AUTOPEND DURING SELL",
"created_at": "2024-09-11T17:44:34Z",
"id": 45499,
"office_id": 3500,
"order_id": null,
"order_link_id": 406755,
"properties": {},
"updated_at": "2024-09-11T17:44:34Z",
"user_id": 3441,
"user_name": "Test Purchases - Broker POS"
}
],
"oid": "232918-406755",
"order_type": "direct",
"oth_created": false,
"partner": false,
"patron_type": "Office",
"payments": [
{
"amount": "27.45",
"avs_postal_code_response": "",
"avs_postal_code_response_code": "",
"avs_response": "",
"avs_response_code": "",
"avs_street_address_response": "",
"avs_street_address_response_code": "",
"check_number": null,
"created_at": "2024-09-11T17:44:33Z",
"credit_card": null,
"credit_memo_id": null,
"cvv_response": "",
"cvv_response_code": "",
"id": 298014,
"is_refund": false,
"order_link_id": 406755,
"payment_for_credit_memo_id": null,
"performed_by": null,
"refunded_from_id": null,
"state": "completed",
"type": "evopay",
"updated_at": "2024-09-11T17:44:33Z",
"url": "/payments/298014"
}
],
"penalties_total": 0,
"pending_balance": "0.0",
"pending_non_refund_payments_total": 0,
"placer": {
"brokerage": {
"abbreviation": "Test Broker",
"created_at": "2019-03-25T20:49:55Z",
"email": "j@ticketevolution.com",
"id": 2259,
"master": false,
"name": "Test Purchases - Broker",
"natb_member": false,
"updated_at": "2023-07-20T17:03:13Z",
"url": "/brokerages/2259"
},
"created_at": "2019-03-26T21:46:39Z",
"email": "j+3441@ticketevolution.com",
"id": 3441,
"name": "Test Purchases - Broker POS",
"office": {
"address": {
"country_code": null,
"cross_street": null,
"extended_address": "",
"id": 7397310,
"label": null,
"latitude": null,
"locality": "",
"longitude": null,
"name": null,
"po_box": false,
"postal_code": "",
"primary": false,
"region": "",
"street_address": ""
},
"brokerage": {
"abbreviation": "Test Broker",
"created_at": "2019-03-25T20:49:55Z",
"email": "j@ticketevolution.com",
"id": 2259,
"master": false,
"name": "Test Purchases - Broker",
"natb_member": false,
"updated_at": "2023-07-20T17:03:13Z",
"url": "/brokerages/2259"
},
"email_address": "demo+office-3500@ticketevolution.com",
"evopay": true,
"id": 3500,
"name": "Test Purchases - Broker POS",
"pcc_code": "",
"phone": "480-535-5811",
"type": "Office",
"url": "/offices/3500"
},
"phone": {
"extension": "",
"number": ""
},
"updated_at": "2024-09-11T17:46:58Z",
"url": "/users/3441"
},
"reference": null,
"refunded": "0.0",
"returns_total": 0,
"seller": {
"address": {
"country_code": null,
"cross_street": null,
"extended_address": "",
"id": 7366875,
"label": null,
"latitude": null,
"locality": "",
"longitude": null,
"name": null,
"po_box": false,
"postal_code": "",
"primary": false,
"region": "",
"street_address": ""
},
"brokerage": {
"abbreviation": "Ticket Evolution",
"created_at": "2010-07-28T12:02:16Z",
"email": "sellersupport@ticketevolution.com",
"id": 61,
"master": true,
"name": "Ticket Evolution",
"natb_member": true,
"updated_at": "2021-12-15T00:40:31Z",
"url": "/brokerages/61"
},
"email_address": "orders@ticketevolution.com",
"evopay": true,
"id": 6,
"name": "Main Office",
"pcc_code": null,
"phone": "201-499-0833",
"type": "Office",
"url": "/offices/6"
},
"seller_cancellation_notes": null,
"seller_cancellation_reason": null,
"seller_is_pos": true,
"seller_rejection_notes": null,
"seller_rejection_reason": null,
"seller_state": "completed",
"service_fee": "0.0",
"shipment_snapshot": [
{
"available": null,
"carrier": null,
"company": null,
"country_code": null,
"cross_street": null,
"email_address": "mistadobalina@example.com",
"extended_address": null,
"id": 251042,
"label": null,
"locality": null,
"name": null,
"phone_number": "4805551212",
"po_box": null,
"postal_code": null,
"region": null,
"street_address": null,
"type": "TMMobileLink"
}
],
"shipments": [
{
"airbill": "/airbills/original/missing.png",
"available": false,
"buyer_edit_count": 0,
"carrier": null,
"cost": "0.0",
"courier_company": null,
"email_address": {
"address": "mistadobalina@example.com",
"id": 439248,
"label": null,
"updated_at": "2024-09-11T17:44:30Z",
"url": null
},
"id": 251042,
"items": [
{
"eticket_available": true,
"eticket_delivery": false,
"eticket_downloaded_at": "",
"eticket_downloaded_by": null,
"id": 311368,
"price": "12.65",
"quantity": 2,
"ticket_group": {
"event": {
"id": "2707230",
"name": "Steel Panther",
"occurs_at": "2024-09-13T20:00:00Z",
"venue": {
"address": {},
"id": "33958",
"name": "Miller Theater - GA"
}
},
"external_notes": "Orders for these tickets will be accepted and fulfilled. Scan your tickets from your mobile phone for this event.",
"id": "857113226",
"office_id": "3868",
"quantity": 2,
"remote_id": "367558560",
"retail_price": "12.65",
"row": "20",
"seats": [
"121",
"122"
],
"section": "22",
"wholesale_price": "12.65"
},
"updated_at": "2024-09-11T17:44:42Z"
}
],
"name": null,
"notes": null,
"phone_number": {
"country_code": "1",
"extension": null,
"id": 410578,
"label": null,
"number": "4805551212",
"updated_at": "2024-09-11T17:44:26Z",
"url": "/clients/307538/phone_numbers/410578"
},
"pickup_instructions": null,
"pickup_time_range": null,
"seller_edit_count": 0,
"service_type": "LEAST_EXPENSIVE",
"service_type_display": null,
"ship_from_address": null,
"ship_from_name": null,
"ship_from_phone_number": null,
"ship_to_company_name": null,
"ship_to_name": "Bob Dobalina",
"shipment_snapshot": {
"available": null,
"carrier": null,
"company": null,
"country_code": null,
"cross_street": null,
"email_address": "mistadobalina@example.com",
"extended_address": null,
"id": 251042,
"label": null,
"locality": null,
"name": null,
"phone_number": "4805551212",
"po_box": null,
"postal_code": null,
"region": null,
"street_address": null,
"type": "TMMobileLink"
},
"signature_type": "",
"state": "delivered",
"tm_mobile_link": "https://example.com/where/the/tickets/were/transferred,https://example.com/another/url/where/the/tickets/were/transferred",
"tracking_number": null,
"tracking_url": null,
"transfer_source": null,
"type": "TMMobileLink",
"updated_at": "2024-09-11T17:46:37Z",
"url": "/shipments/251042"
}
],
"shipping": "0.0",
"shipping_address": null,
"spec": false,
"spec_fulfilled": false,
"state": "completed",
"substitute_order_link_id": null,
"substitutions": [],
"subtotal": "25.3",
"tax": "2.15",
"total": "27.45",
"updated_at": "2024-09-11T17:46:37Z",
"url": "/orders/406755",
"was_auto_accepted": null,
"was_auto_canceled": null,
"was_auto_pended": null
} |