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 /wiki/spaces/API/pages/25001992 | 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 /wiki/spaces/API/pages/25001992 | |
| 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/649766 | { "additional_expense": "0.0", "balance": "0.0", "order_type": "direct", "billing_address": { "country_code": "US", "extended_address": "Suite M", "id": "501545", "label": "Moe’s Tavern", "latitude": null, "locality": "Springfield", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85262", "primary": false, "region": "MG", "street_address": "555 Tire Fire Way" }, "buyer": { "addresses": [ { "country_code": "US", "extended_address": "Suite M", "id": "501545", "label": "Moe’s Tavern", "latitude": null, "locality": "Springfield", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85262", "primary": false, "region": "MG", "street_address": "555 Tire Fire Way" }, { "country_code": "US", "extended_address": "Suite 202-B", "id": "501546", "label": "Tempe Home", "latitude": null, "locality": "Tempe", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85281", "primary": true, "region": "AZ", "street_address": "777 Springfield Lane" } ], "company": { "id": "8052", "name": "Moe’s Tavern" }, "email_addresses": [ { "url": null, "address": "moe@moestavern.com", "label": "Work", "updated_at": "2014-08-04T18:51:23Z", "id": 145997 }, { "url": null, "address": "moe.szyslak@gmail.com", "label": "Home", "updated_at": "2014-08-04T18:51:23Z", "id": 145996 } ], "id": 109402, "name": "Moe Szyslak", "office": null, "phone_numbers": [ { "country_code": "+1", "extension": null, "id": "229515", "label": "Home", "number": "(480) 555-1313", "updated_at": "2014-08-04T19:11:22Z", "url": "/clients/109402/phone_numbers/229515" }, { "country_code": "+1", "extension": "102", "id": "229514", "label": "Work", "number": "(480) 555-1212", "updated_at": "2014-08-04T19:11:22Z", "url": "/clients/109402/phone_numbers/229514" } ], "primary_credit_card": { "address": { "country_code": "US", "extended_address": "Suite 202-B", "id": "501546", "label": "Tempe Home", "latitude": null, "locality": "Tempe", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85281", "primary": true, "region": "AZ", "street_address": "777 Springfield Lane" }, "card_company": "Visa", "expiration_month": 12, "expiration_year": 2016, "id": 15019, "last_digits": "1111", "name": "Moe Szyslak", "phone_number": null, "url": "/clients/109402/credit_cards/15019" }, "primary_shipping_address": { "country_code": "US", "extended_address": "Suite 202-B", "id": "501546", "label": "Tempe Home", "latitude": null, "locality": "Tempe", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85281", "primary": true, "region": "AZ", "street_address": "777 Springfield Lane" }, "tags": [ "vip", "Married", "HasKids" ], "type": "Client", "updated_at": "2014-08-04T19:11:22Z", "url": "/clients/109402" }, "buyer_cancellation_notes": null, "buyer_cancellation_reason": null, "buyer_state": "completed", "child_orders": [ ], "client": { "addresses": [ { "country_code": "US", "extended_address": "Suite M", "id": "501545", "label": "Moe’s Tavern", "latitude": null, "locality": "Springfield", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85262", "primary": false, "region": "MG", "street_address": "555 Tire Fire Way" }, { "country_code": "US", "extended_address": "Suite 202-B", "id": "501546", "label": "Tempe Home", "latitude": null, "locality": "Tempe", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85281", "primary": true, "region": "AZ", "street_address": "777 Springfield Lane" } ], "company": { "id": "8052", "name": "Moe’s Tavern" }, "email_addresses": [ { "url": null, "address": "moe@moestavern.com", "label": "Work", "updated_at": "2014-08-04T18:51:23Z", "id": 145997 }, { "url": null, "address": "moe.szyslak@gmail.com", "label": "Home", "updated_at": "2014-08-04T18:51:23Z", "id": 145996 } ], "id": 109402, "name": "Moe Szyslak", "office": null, "phone_numbers": [ { "country_code": "+1", "extension": null, "id": "229515", "label": "Home", "number": "(480) 555-1313", "updated_at": "2014-08-04T19:11:22Z", "url": "/clients/109402/phone_numbers/229515" }, { "country_code": "+1", "extension": "102", "id": "229514", "label": "Work", "number": "(480) 555-1212", "updated_at": "2014-08-04T19:11:22Z", "url": "/clients/109402/phone_numbers/229514" } ], "primary_credit_card": { "address": { "country_code": "US", "extended_address": "Suite 202-B", "id": "501546", "label": "Tempe Home", "latitude": null, "locality": "Tempe", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85281", "primary": true, "region": "AZ", "street_address": "777 Springfield Lane" }, "card_company": "Visa", "expiration_month": 12, "expiration_year": 2016, "id": 15019, "last_digits": "1111", "name": "Moe Szyslak", "phone_number": null, "url": "/clients/109402/credit_cards/15019" }, "primary_shipping_address": { "country_code": "US", "extended_address": "Suite 202-B", "id": "501546", "label": "Tempe Home", "latitude": null, "locality": "Tempe", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85281", "primary": true, "region": "AZ", "street_address": "777 Springfield Lane" }, "tags": [ "vip", "Married", "HasKids" ], "type": "Client", "updated_at": "2014-08-04T19:11:22Z", "url": "/clients/109402" }, "completed_non_refund_payments_total": "299.0", "consignment": false, "created_at": "2014-08-04T19:11:33Z", "created_by_ip_address": "74.90.205.22", "discount": "0.0", "fee": "0.0", "id": 649766, "instructions": null, "isPO": false, "items": [ { "eticket_updated_at": "2014-08-05T03:00:13Z", "eticket_finalized": true, "eticket_pdf_pages": 2, "eticket_downloaded_at": null, "eticket_delivery": true, "has_spec_tickets": false, "needs_eticket": false, "ticket_group": { "event": { "venue": { "address": { "region": "NJ", "locality": "East Rutherford" }, "name": "MetLife Stadium", "id": "7074" }, "occurs_at": "2014-09-28T13:00:00Z", "url": "/events/598750", "name": "Detroit Lions at New York Jets", "id": "598750" }, "section": "101", "office_name": "Main Office", "retail_price": "147.0", "tickets": [ { "seat": null, "purchase_order_id": null }, { "seat": null, "purchase_order_id": null } ], "remote_id": "980391", "quantity": 2, "url": "/ticket_groups/50", "format": null, "in_hand": "true", "external_notes": null, "brokerage_id": "352", "brokerage_name": "Dreamtix.com", "in_hand_on": "2014-06-12", "wholesale_price": "147.0", "seats": [ ], "row": "6", "office_id": "50" }, "eticket_file_size": 460421, "quantity": 2, "cost": "294.0", "created_at": "2014-08-04T19:11:33Z", "needs_sub": false, "order_item_id": 462942, "eticket_thumbnails": [ { "page": 1, "url": "https://…" }, { "page": 2, "url": "https://…" } ], "eticket_downloaded_by": null, "price": "147.0", "eticket_finalized_at": "2014-08-05T03:00:35Z", "eticket_available": true, "updated_at": "2014-08-05T03:00:36Z", "id": 723149 } ], "kount_notifications": [ { … }, { … }, { … } ], "kount_score": "44", "kount_status": "A", "kount_transactions": [ { … }, { … } ], "minfraud_response": null, "notes": [ ], "oid": "287871-649766", "partner": false, "patron_type": "Client", "payments": [ { "credit_memo_id": null, "refundable_amount": "299.0", "type": "credit_card", "avs_response": null, "refunded_from_id": null, "avs_postal_code_response_code": "M", "amount": "299.0", "url": "/payments/504536", "created_at": "2014-08-04T19:11:33Z", "payment_for_credit_memo_id": null, "avs_response_code": null, "state": "captured", "avs_street_address_response_code": "M", "avs_street_address_response": "Match.", "credit_card": { "expiration_year": 2016, "phone_number": null, "url": "/clients/109402/credit_cards/15019", "last_digits": "1111", "address": { "country_code": "US", "extended_address": "Suite 202-B", "id": "501546", "label": "Tempe Home", "latitude": null, "locality": "Tempe", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85281", "region": "AZ", "street_address": "777 Springfield Lane" }, "name": "Moe Szyslak", "expiration_month": 12, "id": 15019, "card_company": "Visa" }, "order_link_id": 649766, "cvv_response_code": "M", "is_refund": false, "avs_postal_code_response": "Match.", "updated_at": "2014-08-04T19:11:33Z", "id": 504536, "cvv_response": "Match." } ], "penalties_total": 0, "pending_balance": "0.0", "pending_non_refund_payments_total": 0, "placer": null, "reference": null, "refunded": "0.0", "returns_total": 0, "seller": { "address": { "country_code": "US", "extended_address": null, "id": 7778, "label": null, "latitude": null, "locality": "Alexandria", "longitude": null, "po_box": false, "postal_code": "22302", "primary": false, "region": "VA", "street_address": "4224 King Street" }, "brokerage": { "abbreviation": "Dream VA", "created_at": "2010-09-10T15:43:09Z", "email": "dreamtix@gmail.com", "id": 352, "master": false, "name": "Dreamtix.com", "natb_member": true, "updated_at": "2014-08-08T23:39:00Z", "url": "/brokerages/352" }, "email_address": "dreamtix@gmail.com", "evopay": true, "id": 50, "name": "Main Office", "phone": "703-931-0916", "type": "Office", "url": "/offices/50" }, "seller_cancellation_notes": null, "seller_cancellation_reason": null, "seller_is_pos": false, "seller_state": "completed", "service_fee": "0.0", "shipment_snapshot": [ { "type": "Eticket", "email_address": null, "extended_address": "Suite 202-B", "phone_number": "(480) 555-1212", "region": "AZ", "po_box": "false", "country_code": "US", "locality": "Tempe", "label": "Tempe Home", "company": null, "postal_code": "85281", "name": "Moe Szyslak", "id": 501546, "street_address": "777 Springfield Lane" } ], "shipments": [ { "tracking_number": null, "type": "Eticket", "phone_number": { "phone_number": { "country_code": null, "deleted_at": null, "imported_filename": null, "number": "631-682-6228", "updated_at": "2014-08-04T19:11:33Z", "imported_at": null, "legacy_id": null, "callable_type": "Delivery", "id": 414291, "label": null, "callable_id": 369800, "created_at": "2014-08-04T19:11:33Z", "extension": null } }, "service_type": null, "url": "/shipments/369800", "ship_to_name": "paul alter", "service_type_display": null, "state": "delivered", "name": "Moe Szyslak", "items": [ { "eticket_downloaded_at": "", "eticket_delivery": true, "ticket_group": { "section": "101", "event": { "venue": { "address": { "region": "NJ", "locality": "East Rutherford" }, "name": "MetLife Stadium", "id": "7074" }, "occurs_at": "2014-09-28T13:00:00Z", "name": "Detroit Lions at New York Jets", "id": "598750" }, "retail_price": "147.0", "quantity": 2, "remote_id": "980391", "external_notes": null, "wholesale_price": "147.0", "id": "140112358", "row": "6", "office_id": "50", "seats": null }, "quantity": 2, "price": "147.0", "eticket_downloaded_by": null, "updated_at": "2014-08-05T03:00:36Z", "eticket_available": true, "id": 462942 } ], "airbill": "/airbills/original/missing.png", "updated_at": "2014-08-05T03:00:36Z", "ship_to_company_name": null, "id": 369800 } ], "shipping": "5.0", "shipping_address": { "country_code": "US", "extended_address": "Suite 202-B", "id": "501546", "label": "Tempe Home", "latitude": null, "locality": "Tempe", "longitude": null, "name": "Moe Szyslak", "po_box": false, "postal_code": "85281", "region": "AZ", "street_address": "777 Springfield Lane" }, "spec": false, "spec_fulfilled": false, "state": "completed", "substitute_order_link_id": null, "substitutions": [ ], "subtotal": "294.0", "tax": "0.0", "total": "299.0", "updated_at": "2014-08-05T03:00:37Z", "url": "/orders/649766" } |