Page Properties | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
Name | Description | Value Type | Required | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ID of an existing Client address to use for the recipient | Integer | Use one or the other, but not both. Required when | ||||||||||||||||||||||||||||||||
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 ProvidedAirvill. | String | Required for certain types | ||||||||||||||||||||||||||||||||
or
| 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 | Use one or the other, but not both. Neither is required. | ||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||
or
| 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 | Use one or the other, but not both. Neither is required. | ||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||
or
| ID of an existing Client phone number for the recipient | Integer | Use one or the other, but not both. Required when | ||||||||||||||||||||||||||||||||
A Phone Number object containing the phone number information. | Object | ||||||||||||||||||||||||||||||||||
or
| ID of an existing Client email address for the recipient | Integer | Use one or the other, but not both. Required when | ||||||||||||||||||||||||||||||||
An Email Address object containing the email address information. | Object | type | Type of the shipment. You must enable the ones you wish to allow for each office and API Credential in Settings under Checkout→Shipping.
| ||||||||||||||||||||||||||||||||
Type | Notes | FedEx |
Info |
---|
Shipments with a |
tracking_number
eliminates this requirement.ship_to_name
Requires one of: phone_number_id,
phone_number_attributes,
tracking_number
service_type
type
s listed in Settings are not currently supported.UPS
- Creation of UPS airbills is not currently supported
Eticket
format
is Eticket.
email_address_id
or email_address_attributes
Email
Requires email_address_id
or email_address_attributes
Courier
ship_to_name
WillCall
Requires ship_to_name
PickupAtOffice
Requires ship_to_name
LocalPickup
Requires ship_to_name
Custom
Requires ship_to_name
TMMobile
Paperless
FlashSeats
ProvidedAirbill
TBD
TMMobileLink
Use TMMobileLink
if you have a TicketMaster Mobile Link that you can attach to the Shipment
order_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.
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.
Although you are free to specify a specific Service Type we recommend that you always use LEAST_EXPENSIVE
if you are using our system to generate the FedEx airbill. When LEAST_EXPENSIVE
is used we will use FedEx’s API and our own algorithm to determine the least expensive Service Type will have the package delivered to your customer with a (roughly) four hour buffer before the event begins. For example, if FedEx says that STANDARD_OVERNIGHT
will be delivered by 6:30pm and the event begins at 8:00pm then the airbill would likely be created using PRIORITY_OVERNIGHT
so that the delivery would happen by 10:30am.
Service Type | Other |
---|---|
LEAST_EXPENSIVE | Recommended |
INTERNATIONAL_FIRST | |
INTERNATIONAL_PRIORITY_SATURDAY_DELIVERY | |
INTERNATIONAL_PRIORITY | |
INTERNATIONAL_ECONOMY | |
FIRST_OVERNIGHT | |
PRIORITY_OVERNIGHT_SATURDAY_DELIVERY | |
FEDEX_2_DAY_SATURDAY_DELIVERY | |
PRIORITY_OVERNIGHT | |
STANDARD_OVERNIGHT | |
FEDEX_2_DAY | |
FEDEX_EXPRESS_SAVER | |
INTERNATIONAL_GROUND | Currently not supported |
GROUND_HOME_DELIVERY | Currently not supported |
FEDEX_GROUND | Currently not supported |
See the FedEx Service guide for details and delivery times.
type
is FedEx
ship_to_name
tracking_number
order_id
signature_type
Type of signature required for delivery.
Signature Type | Definition | Other |
---|---|---|
INDIRECT | FedEx obtains a signature from someone at the delivery address (a neighbor, building manager or someone at a neighboring address), or the recipient can leave a FedEx Door Tag authorizing release of the package without anyone present. This option is available only if you checked This is a residential address in the To section; it is not available for shipments to nonresidential addresses. | Requires that residential be set to true |
DIRECT | FedEx obtains a signature from someone at the delivery address. If no one is at the address, they reattempt delivery. | |
ADULT | FedEx obtains a signature from someone at least 21 years old (and possessing the required government-issued photo ID) at the delivery address. If no eligible recipient is at the address, we reattempt delivery. | |
NO_SIGNATURE_REQUIRED | Indicates that FedEx should nor attempt to get a signature and that the package may be left at the delivery address. | Requires that residential be set to true |
See the FedEx Service guide for additional details.
residential
signature_type
s INDIRECT
and NO_SIGNATURE_REQUIRED
. Has no effect on other delivery types.replace_existing
true
to replace the existing shipment for the specified item(s).Shipment Types
|
Examples
Request | Response | |||||||
---|---|---|---|---|---|---|---|---|
| See Shipments / Index. |
...