...
...
...
...
...
...
...
Page Properties | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Long Description
Create a shipment for an existing order and assign items (ticket groups) to it.
Info |
---|
Shipments with a |
Parameters
Name | Description | Value Type | Required |
---|---|---|---|
shipments | Array of shipments to be posted | Array | Required |
Shipments Parameters
Name | Description |
---|
Type |
---|
Presence | Other |
---|---|
| 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 | ||
| Indicates whether the airbill is currently available. | boolean | Required when type is |
| The carrier for the |
| String | Required for certain types |
|
or
|
ID of |
an existing Client email address for the recipient |
Integer | Required |
Type of the shipment. You must enable the ones you wish to allow for each office and API Credential in Settings under Checkout→Shipping.
Info |
---|
As of 2016-03-15 the delivery type must correspond to the TicketGroup format for the following formats: Eticket, TMMobile, GuestList, Paperless, FlashSeats. Physical ticket groups must be shipped via FedEx or ProvidedAirbill unless the event occurs less than 18 hours from the order time. |
FedEx
Info |
---|
Shipments with a |
- Creating airbills requires FedEx to be setup on your account by a TEvo Admin. Including an existing
tracking_number
eliminates this requirement. - Requires
ship_to_name
Requires one of: phone_number_id,
phone_number_attributes,
tracking_number
- Requires
service_type
- 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.
- Creating airbills requires FedEx to be setup on your account by a TEvo Admin. Including an existing
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
Offline
Courier
ship_to_name
WillCall
Requires ship_to_name
PickupAtOffice
Requires ship_to_name
LocalPickup
Requires ship_to_name
Custom
Requires ship_to_name
Tbd
Use one or the other, but not both. | ||||
An Email Address object containing the email address information. | Object | |||
| The order ID to which the shipment will belong | integer | Optional | |
or
| 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 |
– |
– with that value being the same as the |
When creating a shipment at the time of order creation via | Array | Required | ||
or
| 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 | |||
| Set to | Boolean | Optional | |
| Mark FedEx deliveries as residential. Required for | boolean | Optional | |
| The Service Type to use when the Shipment |
Checkout→Shipping. See service_type Options below for more information. | string | Required when | ||
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 | 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 | |||
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 | 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 | |||
| See Recommended Shipment type Options below. | string | Required | |
| Name of recipient | string | Required | |
| Type of signature required for delivery. See signature_type Options below. | string | Optional | |
| The tracking number of the airbill. | string | Optional |
Recommended Shipment type
options
The following shipment_type
options should be used.
Include Page | ||||||
---|---|---|---|---|---|---|
|
Internal Use Only Shipment type
Options
Include Page | ||||||
---|---|---|---|---|---|---|
|
service_type Options
Info |
---|
Although you are free to specify a specific Service Type we recommend that you always use |
...
See the FedEx Service guide for details and delivery times.
service_type | Other |
---|---|
| Recommended |
|
|
|
|
|
|
|
|
|
|
|
| Currently not supported |
| Currently not supported |
| Currently not supported |
signature_type
Options
See the FedEx Service guide
...
Type of signature required for delivery.
...
for additional details.
signature_type | Definition | Other |
---|---|---|
| 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, FedEx will reattempt delivery. | |
| FedEx obtains a signature from someone at the delivery address. If no one is at the address, FedEx will reattempt delivery. | |
| 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. |
Requires that |
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.
| Indicates that FedEx should |
not attempt to get a signature and that the package may be left at the delivery address. | Requires that |
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).
Examples
Request | Response |
---|
|
|
|
|
|
See Shipments / Index. |
...