Page Comparison

...

Page Properties

label	api_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

Long Description

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

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.

Parameters

Name	Description	Value Type	Required
shipments	Array of shipments to be posted	Array	Required

Shipments Parameters

Name	Description

Value

Type	Presence

RequiredRequired for certain types

Other
`address_id` or `address_attributes`	ID of an existing Client address to use for the recipient

integer

Integer	Required	Use one or the other, but not both.
An Address object containing the address information.	Required	Use one or the other, but not both.	Object
`available`	Indicates whether the airbill is currently available.	boolean	Required when type is `ProvidedAirbill`

address_attributesAttributes of a new address to create and use for the recipient. A new Client Address will be created and could result in duplicate entries. Not recommended.HashRequired for certain types


`carrier`	The carrier for the

ProvidedAirvill

ProvidedAirbill.

String

Required for certain types

ship_fromship_from

email_address_id

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

or

email_address_attributes

Attributes of a new ship-from address to use for the sender. Not recommended.Hash

Optionalship_from_phone_number_id

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.integerOptionalship_from_phone_number_attributesAttributes of a new ship-from phone number to use for the sender. Not recommended.HashOptionalphone_number_idID of a phone number for the recipientintegerRequired for certain typesphone_number_attributesAttributes of a phone number to use for the recipient. A new Client Phone Number will be created and could result in duplicate entries. Not recommended. HashRequired for certain typesemail_address_idID of an

an existing Client email address for the recipient

integer

Integer

Required

for certain typesemail_address_attributesAttributes of a new email address to create and use for the recipient. A new Client Email Address will be created and could result in duplicate entries. Not recommended. HashRequired for certain typestype

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.

TypeNotesFedEx

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 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_types listed in Settings are not currently supported.

UPS

- Creation of UPS airbills is not currently supported

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
Email

Requires email_address_id or email_address_attributes

CourierRequires ship_to_nameWillCall

Requires ship_to_name

PickupAtOffice

Requires ship_to_name

LocalPickup

Requires ship_to_name

Custom

Requires ship_to_name

TMMobileGuestListPaperlessFlashSeatsProvidedAirbillSet 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

stringRequiredorder_

	Use one or the other, but not both.
	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.
`phone_number_id` or `phone_number_attributes`	A Phone Number object containing the phone number information.	Object	Required	Use one or the other, but not both.
`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_type`s `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.

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,
`ship_from_address_id` or `ship_from_address_attributes`	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	Optional	Use one or the other,
`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	Optional	Use one or the other, but not both.
`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.	string	Optional
`tracking_number`	The tracking number of the airbill.	string	Optional

Recommended Shipment `type` options

The following shipment_type options should be used.

Include Page

	Recommended Shipment Types
	Recommended Shipment Types
isMissingRequiredParameters	true

Internal Use Only Shipment `type` Options

Include Page

	Internal Use Only Shipment type Options
	Internal Use Only Shipment type Options
isMissingRequiredParameters	true

service_type Options

Info

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.

...

See the FedEx Service guide for details and delivery times.

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

`signature_type` Options

See the FedEx Service guide

...

Type of signature required for delivery.

...

for additional details.

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.

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

DIRECTADULT

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.

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

NO_SIGNATURE_REQUIRED

Indicates that FedEx should

nor

not 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.

stringOptionalresidentialMark FedEx deliveries as residential. Required for signature_types INDIRECT and NO_SIGNATURE_REQUIRED. Has no effect on other delivery types.booleanOptionalreplace_existingSet to true to replace the existing shipment for the specified item(s).BooleanOptional

Examples

Request

Response

Code Block

language

rubythemeConfluence

json

{
  "shipments": [
    {
      "address_id": 8172,
      "cost": "15.0",
      "order_items": [
        {
          "id": 26117
        }
      ],
      "order_id": 75106,
      "phone_number_id": 33432,
      "replace_existing": true,
      "service_type": "

STANDARD

LEAST_

OVERNIGHT

EXPENSIVE",
      "ship_to_company_name": "",
      "ship_to_name": "Wallstreet Entertainment - Main Office",
      "signature_type": "INDIRECT",
      "residential": true,
      "type": "FedEx"
    }
  ]
}

See Shipments / Index.

Versions Compared

Old Version 36

New Version Current

Key

Long Description

Parameters

Shipments Parameters

Recommended Shipment `type` options

Internal Use Only Shipment `type` Options

service_type Options

`signature_type` Options

Examples

Page Comparison

Versions Compared

Old Version 36

New Version Current

Key

Long Description

Parameters

Shipments Parameters

Recommended Shipment type options

Internal Use Only Shipment type Options

service_type Options

signature_type Options

Examples

Recommended Shipment `type` options

Internal Use Only Shipment `type` Options

`signature_type` Options