Affiliate Orders / Create
- J Cobb
If you are not an affiliate please see the regular Orders / Create documentation instead.
Name | Affiliate Orders Create |
|---|---|
Description | Create an Affiliate Order |
Type | POST |
URL | /v10/orders |
Affiliate |
Please review our information on placing Test Orders in our Sandbox environment.
Parameters
Name | Description | Type | Presence | Other |
|---|---|---|---|---|
| The order to create | Object | Required |
|
Order Object Parameters
Name | Description | Type | Presence | Other |
|---|---|---|---|---|
| ID of the Client that is buying the tickets | Integer | Required |
|
| A Delivery object with details of the delivery information | Object | Required |
|
| 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 |
| Array of Payments which will be applied to the order. An array must be used even if creating a single payment. Note: Payments of type Note: The payment amount does not dictate the total amount of an order. If the payment type is The total amount will be calculated as (( | 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 |
|
| Recommended for storing something such as a PO or Invoice number from another system. | String | Optional |
|
| 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. |
|
| 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 Use Only Order Parameters
delivery Object Parameters
Name | Description | Type | Presence | Other |
|---|---|---|---|---|
| ID of the Client’s Address. |
|
|
|
| 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 | Required | Maximum 2 decimal places |
| ID of the Client’s Email Address. | Integer | Required |
|
| ID of the Client’s Phone Number. |
|
|
|
| The shipment type to use |
|
|
|
payments Object Parameters
Name | Description | Value Type | Required | Other |
|---|---|---|---|---|
| ID of a Client Address which is the billing address for the credit card being used. | Integer | Required |
|
| The amount of the payment. Will be created for order total if omitted. | Decimal | Optional | Maximum 2 decimal places |
| The Stripe token representing the card. | String | Required |
|
| This will always be | String | Required |
|
Recommended Shipment type options
The following shipment type options should be used.
Examples
In the examples below address_id, email_address_id, and phone_number_id may be replaced with their full corresponding objects as shown here.
"address_attributes": {
"street_address": "9060 E Via Linda",
"extended_address": "Suite 230",
"locality": "Scottsdale",
"region": "AZ",
"postal_code": "85258",
"country_code": "US",
"label": "Work",
"is_primary": true
}"email_address_attributes": {
"address": "nedflanders@example.com",
"label": "Home",
"is_primary": true
}"phone_number_attributes": {
"extension": "5",
"number": "972-468-9750",
"label": "iPhone",
"is_primary": true
}
Request | Response |
|---|---|
{
"order": {
"client_id": 1507094,
"created_by_ip_address": "66.49.214.206",
"delivery": {
"address_id": "123456",
"cost": 5,
"email_address_id": 1965046,
"phone_number_id": 9876542,
"type": "TMMobile"
},
"discount": 5,
"promo_code": "TAKE5",
"payments": [
{
"address_id": 6548987,
"amount": 305.96,
"method": "BraintreeApplePay"
"type": "credit_card",
"token": "tok_22hZsYJWAqThLElwgjGTNuyH"
}
],
"reference": "An optional reference field",
"service_fee": 10,
"session_id": "riskified_session_id_123",
"tax": 0,
"tax_signature": "9166e5ac-c663-4236-ae8b-76eb890a0468",
"ticket_group": {
"id": 324466901,
"price": 145.48,
"quantity": 2,
"wholesale_price": 126.32
}
}
} | See Orders / Index |