Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
labelapi_docs_shipments


Name

Shipments Create

Description

Create a shipment for an existing order and assign items (ticket groups) to it.

Type

POST

URL

/v9/shipments

Credential Type

API|User


...

The following shipment_type options should be used.

...

Include Page

...

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

...

Info

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_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

...

Recommended Shipment Types
Recommended Shipment Types
isMissingRequiredParameterstrue

Internal Use Only Shipment type Options

...

signature_type

Definition

Other

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, FedEx will reattempt delivery.

DIRECT

FedEx obtains a signature from someone at the delivery address. If no one is at the address, FedEx will reattempt delivery.


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.

Requires that residential be set to true

NO_SIGNATURE_REQUIRED

Indicates that FedEx should not attempt to get a signature and that the package may be left at the delivery address.

Requires that residential be set to true

...