Shipments / Create
Name | Shipments Create |
---|---|
Description | Create a shipment for an existing order and assign items (ticket groups) to it. |
Type | POST |
URL | /v9/shipments |
API|User |
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 | 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 | 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 –
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 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.
Internal Use Only Shipment type
Options
service_type Options
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 |
---|---|
| Recommended |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Currently not supported |
| Currently not supported |
| Currently not supported |
signature_type
Options
See the FedEx Service guide 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 |
| Indicates that FedEx should not attempt to get a signature and that the package may be left at the delivery address. | Requires that |
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": "LEAST_EXPENSIVE",
"ship_to_company_name": "",
"ship_to_name": "Wallstreet Entertainment - Main Office",
"signature_type": "INDIRECT",
"residential": true,
"type": "FedEx"
}
]
} | See Shipments / Index. |