Affiliate Orders / Create

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
Credential Type	Affiliate

Please review our information on placing Test Orders in our Sandbox environment.

Parameters

Name	Description	Type	Presence	Other
`order`	The order to create	Object	Required

Order Object Parameters

Name	Description	Type	Presence	Other
`client_id`	ID of the Client that is buying the tickets	Integer	Required
`delivery`	A Delivery object with details of the delivery information	Object	Required
`discount`	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
`payments`	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 `credit_card` will fail, even in Sandbox, if you have not yet signed up for the Braintree gateway. Note: The payment amount does not dictate the total amount of an order. If the payment type is `credit_card` the payment amount will dictate how much the Client will be charged regardless of the order amount. The total amount will be calculated as ((`price` * `quantity`) of each item) + `shipping` + `service_fee` + `additional_expense` + `tax` - `discount`	Array	Required
`promo_code`	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`	Recommended for storing something such as a PO or Invoice number from another system.	String	Optional
`service_fee`	Additional amount added to the order to be labeled as a Service Fee	Decimal	Optional	Maximum 2 decimal places
`session_id`	Session ID of the buyer. This should be a unique session of the buyer.	String	Required if using Fraud Protection.
`shipping`	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
`tax`	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
`tax_signature`	Unique identifier generated by Tax Quotes / Create to ensure consistency between your quote and your order.	UUID	Optional

Internal Use Only Order Parameters

Unable to render {include} The included page could not be found.

`delivery` Object Parameters

Name	Description	Type	Presence	Other
`address_id`	ID of the Client’s Address.
`cost`	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
`email_address_id`	ID of the Client’s Email Address.	Integer	Required
`phone_number_id`	ID of the Client’s Phone Number.
`type`	The shipment type to use

`payments` Object Parameters

Name	Description	Value Type	Required	Other
`address_id`	ID of a Client Address which is the billing address for the credit card being used.	Integer	Required
`amount`	The amount of the payment. Will be created for order total if omitted.	Decimal	Optional	Maximum 2 decimal places
`token`	The Stripe token representing the card.	String	Required
`type`	This will always be `credit_card`	String	Required

Recommended Shipment `type` options

The following shipment type options should be used.

Name	Description
`Eticket`	Use `Eticket` when the ticket group's `format` is `Eticket.` Requires `email_address_id` or `email_address_attributes` If Suppress eticket emails is not enabled in settings, an email will be sent to Client when tickets are ready to be downloaded
`FedEx`	Shipments with a `type` of `FedEx` cannot be created if the address is a PO Box as FedEx does not ship to PO Boxes. Creating airbills requires FedEx to be setup on your account by a TEvo Admin. Including an existing `tracking_number` eliminates this requirement. Requires `service_type` Requires `ship_to_name` Requires one of: `phone_number_id, phone_number_attributes, tracking_number` If Send client emails is enabled in settings, an email will be sent to Client when tickets ship The Ground `service_type`s listed in Settings are not currently supported.
`FlashSeats`
`LocalPickup`	Use this for `Physical` tickets only when it is too late to ship them. Requires `ship_to_name`
`ProvidedAirbill`	Set the available parameter to true if the airbill is already available. If the airbill is already available, the tracking number and carrier is required.
`TBD`	This is an internally-used option that indicates the ticket is mobile delivery but the seller has not yet indicated `TMMobile` or `TMMobileLink`
`TMMobile`	Despite the name, this is used for all Mobile Transfer tickets.
`TMMobileLink`	Use `TMMobileLink` if you have a URL which can be used to claim the tickets that you can attach to the Shipment
`UPS`	Creation of UPS airbills is not currently supported

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

POST /v10/orders

{
  "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": [
      {
        "type": "credit_card",
        "token": "tok_22hZsYJWAqThLElwgjGTNuyH",
        "amount": 305.96,
        "address_id": 6548987
      }
    ],
    "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