Long Description
Create a shipment for an existing order and assign items (ticket groups) to it.
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 | Required | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
address_id | ID of an address to use for the recipient | integer | Required for certain types | ||||||||||||||||||||||||||||||||||
available | Indicates whether the airbill is currently available. | boolean | Required when type is ProvidedAirbill | ||||||||||||||||||||||||||||||||||
address_attributes | Attributes 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. | Hash | Required for certain types | ||||||||||||||||||||||||||||||||||
carrier | The carrier for the ProvidedAirvill. | String | Required for certain types | ||||||||||||||||||||||||||||||||||
ship_from_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. | integer | Optional | ||||||||||||||||||||||||||||||||||
ship_from_address_attributes | Attributes of a new ship-from address to use for the sender. Not recommended. | Hash | Optional | ||||||||||||||||||||||||||||||||||
ship_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. | integer | Optional | ||||||||||||||||||||||||||||||||||
ship_from_phone_number_attributes | Attributes of a new ship-from phone number to use for the sender. Not recommended. | Hash | Optional | ||||||||||||||||||||||||||||||||||
phone_number_id | ID of a phone number for the recipient | integer | Required for certain types | ||||||||||||||||||||||||||||||||||
phone_number_attributes | Attributes 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. | Hash | Required for certain types | ||||||||||||||||||||||||||||||||||
email_address_id | ID of an email address for the recipient | integer | Required for certain types | ||||||||||||||||||||||||||||||||||
email_address_attributes | Attributes 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. | Hash | Required for certain types | ||||||||||||||||||||||||||||||||||
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. 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.
| string | Required | ||||||||||||||||||||||||||||||||||
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,
When creating a shipment at the time of order creation via | Array | Required | ||||||||||||||||||||||||||||||||||
service_type | The Service Type to use when the Shipment
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. | string | Required when type is FedEx | ||||||||||||||||||||||||||||||||||
ship_to_name | Name of recipient | string | Required for certain types | ||||||||||||||||||||||||||||||||||
tracking_number | Input tracking number of shipment if you intend to ship the airbill yourself | string | Optional | ||||||||||||||||||||||||||||||||||
order_id | The order ID to which the shipment will belong | integer | Required | ||||||||||||||||||||||||||||||||||
signature_type | Type of signature required for delivery.
See the FedEx Service guide for additional details. | string | 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 | ||||||||||||||||||||||||||||||||||
replace_existing | Set to true to replace the existing shipment for the specified item(s). | Boolean | Optional |
Examples
Request | Response |
---|---|
{ "shipments": [ { "address_id": 8172, "cost": "15.0", "order_items": [ { "id": 26117 } ], "order_id": 75106, "phone_number_id": 33432, "replace_existing": true, "service_type": "STANDARD_OVERNIGHT", "ship_to_company_name": "", "ship_to_name": "Wallstreet Entertainment - Main Office", "signature_type": "INDIRECT", "residential": true, "type": "FedEx" } ] } |
See Shipments / Index. |