Page Properties | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
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.
See the FedEx Service guide for details and delivery times. | 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. See the FedEx Service guide for additional details. | string | Optional | |||
| The tracking number of the airbill. | string | Optional |
...
The following shipment_type
options should be used.
Name | Description |
| Requires ||
---|---|---|---|---|
| Requires | |||
| Requires | |||
|
| |||
|
| |||
| ||||
| Requires |
|
| Use this for |
| 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. | |||
| This is an internally-used option that indicates the ticket is mobile delivery but the seller has not yet indicated | |||
| Despite the name, this is used for all Mobile Transfer tickets. | |||
| Use | |||
| Creation of UPS airbills is not currently supported |
| Requires
Internal Use Only Shipment type
Options
Include Page | ||||||
---|---|---|---|---|---|---|
|
service_type Options
Service Type | Other |
---|---|
| Recommended |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| Currently not supported |
| Currently not supported |
| Currently not supported |
...
Signature Type | Definition | Other |
---|---|---|
| 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 |
| FedEx obtains a signature from someone at the delivery address. If no one is at the address, they reattempt delivery. | |
| 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 nor attempt to get a signature and that the package may be left at the delivery address. | Requires that |
...