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
Credential Type	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

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

Shipments Parameters

Name	Description	Type	Presence	Other

Name	Description	Type	Presence	Other
`address_id` or `address_attributes`	ID of an existing Client address to use for the recipient	Integer	Required	Use one or the other, but not both.
`address_id` or `address_attributes`	An Address object containing the address information.	Object	Required	Use one or the other, but not both.
`available`	Indicates whether the airbill is currently available.	boolean	Required when type is `ProvidedAirbill`
`carrier`	The carrier for the `ProvidedAirbill`.	String	Required for certain types
`email_address_id` or `email_address_attributes`	ID of an existing Client email address for the recipient	Integer	Required	Use one or the other, but not both.
`email_address_id` or `email_address_attributes`	An Email Address object containing the email address information.	Object	Required	Use one or the other, but not both.
`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. 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.

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

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 for additional details.

signature_type	Definition	Other

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`

Examples

Request	Response

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.