Info |
---|
If you are an affiliate please see the Affiliate Documentation instead. |
...
Name | Description | Type | Required |
---|---|---|---|
| Array of orders to create. An array must be used even if creating just a single order. If you wish to create multiple orders at once it is recommended to you submit multiple POSTs instead of a larger | Array | Required |
| If you utilize our fraud prevention service (currently Riskified) and wish to skip the fraud check on this order only then pass in | Boolean | Optional |
...
Name | Description | Type | Presence | Other | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| The ID of a Client Address which should be recorded as their billing address for this order. | Integer | Optional | |||||||||||||||||||
| If you are creating a Buy (Purchase) Order the | Integer | Required for Buy Order (Purchase Order) | |||||||||||||||||||
| ID of the Client that is buying the tickets from your Office in a Buy/Sell order. | Integer | Required for Buy/Sell orders | |||||||||||||||||||
| IP address of the buyer. | String | Required if using Fraud Protection | |||||||||||||||||||
| Additional amount subtracted from the order to be labeled as Discount. (Positive value, but will have a negative effect on the order total.) | Decimal | Optional | Maximum 2 decimal places | ||||||||||||||||||
| Internal Notes will only be visible to the Office that created them. Using an Array of strings will create multiple Internal Notes. | String|Array | Optional | |||||||||||||||||||
| Array of Payments which will be applied to the order. An array must be used even if creating a single payment.
| Array | Required | |||||||||||||||||||
| The name of a promo code applied to an order. Does not automatically apply the discount, this is simply for your own logging purposes. | String | Optional | |||||||||||||||||||
| Reference will only be visible to the Office that created them and is recommended for storing something such as a PO or Invoice number from another system. You can search this in CORE Reference filters on your Orders Search Page. | String | Optional | |||||||||||||||||||
| If you are creating a Buy/Sell Order or a Sell Order the If you are creating a Buy Order (Purchase Order) or a the | Integer | ||||||||||||||||||||
| Additional amount added to the order to be labeled as a Service Fee | Decimal | Optional | Maximum 2 decimal places | ||||||||||||||||||
| Session ID of the buyer. This should be a unique session of the buyer. | String | Required if using Fraud Protection. | |||||||||||||||||||
| Array of Shipped Items | Array | Required | |||||||||||||||||||
| Additional amount added to the order to be labeled as Shipping Cost. Shipments / Suggestion will return the pricing you have configured for a shipment method. | Decimal | Optional | Maximum 2 decimal places | ||||||||||||||||||
| Additional amount added to the order to be labeled as Tax. If you are using Tax Quotes / Create to calculate the retail tax amount you can pass the retail tax amount here for record keeping. | Decimal | Optional | Maximum 2 decimal places | ||||||||||||||||||
| Unique identifier generated by Tax Quotes / Create to ensure consistency between your quote and your order. | UUID | Optional |
| Internal Notes will only be visible to the Office that created them. Using an Array of strings will create multiple Internal Notes. | String|Array | Optional |
| External Notes are visible to both the buyer and the seller and are considered a request. If you have specific requirements please reach out to the seller to ensure your requirements can be met. Using an Array of strings will create multiple External Notes. | String|Array | Optional |
| Instructions are visible to both the buyer and the seller and are considered a request. If you have specific requirements please reach out to the seller to ensure your requirements can be met. | String | Optional |
|
|
| Reference will only be visible to the Office that created them and is recommended for storing something such as a PO or Invoice number from another system. You can find this in through CORE Reference filters on your Orders Search Page in CORE. | String | Optional |
Shipped Items Parameters
...
Info |
---|
Even though Shipped Items is an array you can only have one item per order. If your site has a cart functionality allowing the purchase of multiple items, simply split them into multiple orders. The exception to this is that you may order multiple items only if all items are owned by the same Office as the one creating the order (the |
Items Parameters
Name | Description | Type | Presence | Other |
---|---|---|---|---|
| ID of the ticket group that was sold | Integer | Required for sales orders | |
| Price per ticket at which the ticket group was sold | Decimal | Required. Optional if using | Maximum 2 decimal places |
| Quantity sold from the ticket group | Integer | Required | |
| The | String | Required | |
| Lowest seat sold from the ticket group | Integer | Optional* | |
| "consecutive" or "odd_even" | String | Optional* | |
| ID of the ticket group that was sold | Integer | Required for sales orders | |
| For purchase orders, creates new inventory in the system. See /wiki/spaces/API/pages/9469980 or /wiki/spaces/API/pages/6455302. | Hash | Required for purchase orders | |
| The ID returned from a /wiki/spaces/API/pages/9469967 or /wiki/spaces/API/pages/9469976 call. If supplied, | Integer | Required only if the tickets are Held or Taken | |
| The When creating/replacing a shipment for an existing order each array element should be an object with a single property, | Integer | Required only when creating or updating a shipment for an existing order |
...