Page Comparison

address_id
or
address_attributes

ID of an existing Client address to use for the recipient

Integer

Required

Use one or the other, but not both.

An Address object containing the address information.

Object

available

Indicates whether the airbill is currently available.

boolean

Required when type is ProvidedAirbill

carrier

The carrier for the ProvidedAirbill.

String

Required for certain types

email_address_id

or

email_address_attributes

ID of an existing Client email address for the recipient

Integer

Required

Use one or the other, but not both.

An Email Address object containing the email address information.

Object

order_id

The order ID to which the shipment will belong

integer

Optional

order_items

or

items

Array of items to be placed in this shipment.

When creating/replacing a shipment for an existing order each array element should be an object with a single property – id – with that value being the same as the order_item_id from the corresponding object within the items array of the order containing the ticket groups to be included in this shipment. e.g.: "order_items": [{"id": 26117}]

When creating a shipment at the time of order creation via shipped_items each array element should be an object containing the information defining that item. See Items Parameters under Orders / Create for details.

Array

Required

phone_number_id

or

phone_number_attributes

ID of an existing Client phone number for the recipient

Integer

Required

Use one or the other, but not both.

A Phone Number object containing the phone number information.

Object

replace_existing

Set to true to replace the existing shipment for the specified item(s).

Boolean

Optional

residential

Mark FedEx deliveries as residential. Required for signature_types INDIRECT and NO_SIGNATURE_REQUIRED. Has no effect on other delivery types.

boolean

Optional

service_type

The Service Type to use when the Shipment type is FedEx. You must enable the ones you wish to allow for each office and API Credential in Settings under Checkout→Shipping.

See service_type Options below for more information.

string

Required when type is FedEx

ship_from_address_id

or

ship_from_address_attributes

ID of an existing Address to use as the sender. This is usually not necessary when shipping as an office, and is used to override the default.

Integer

Optional

Use one or the other,

An Address object containing the address information. This is usually not necessary when shipping as an office, and is used to override the default.

Object

ship_from_phone_number_id

or

ship_from_phone_number_attributes

ID of a phone number to use as the sender. This is usually not necessary when shipping as an office, and is used to override the default.

Integer

Optional

Use one or the other, but not both.

A Phone Number object containing the phone number information. This is usually not necessary when shipping as an office, and is used to override the default.

Object

type

See Recommended Shipment type Options below.

string

Required

ship_to_name

Name of recipient

string

Required

signature_type

Type of signature required for delivery.

See signature_type Options below.See the FedEx Service guide for additional details.

string

Optional

tracking_number

The tracking number of the airbill.

string

Optional

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

• 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_types 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