Shipment Special Processing Properties

Overview

In certain cases, you may need special handling for a given shipment. In that case, there are several options you can specify as part of the Shipment entity, or when using the Carrier and Method Selection with Label single call.

Special processing and accessorial options

This table shows the optional special processing elements that can be included as part of the element:

Property

Property Contents

Description

"deliverySignatureOption"

string enumeration

Values are:
none (the default)
signature
resident_signature
adult_signature
adult_resident_signature

If you pass an optional deliverySignatureOption, its value is used to select only ship methods which support the specified delivery confirmation type.

Note: only FedEx and USPS support adult_resident_signature.

If you do not need a resident specifically, use adult_signature.

"saturdayDelivery"

boolean

If you pass saturdayDelivery, you can specify whether or not you want saturdayDelivery to be an option for this package.

Note: This does not guarantee a Saturday delivery.

"transportationType"

string enumeration

Values are:
any (the default)
air
ground

By passing a transportationType, you can limit the set of possible methods for this shipment.

Note: Specifying transportationType may increase the shipment cost. Use sparingly, if at all.

Customs information

For shipments which require customs information to be passed, callers must specify the additional fields below in the customsInfo object as a child of the shipmentParameters object.

Property

Property Contents

Description

"customsDescription"

string

A brief but detailed description of the items being shipped.
Example: "9 mm steel screws"

"totalCustomsValue"

decimal value

The total customs value of the package in totalCustomsValueCurrency units.
Example: 11.22

"totalCustomsValueCurrency"

valid ISO 4217 currency code

The currency to use for the package value in the totalCustomsValue field.
Example: "USD"

"customsItems"

array of customsItem objects

A listing of customs details for each of the items contained within the package.

Customs items

This table shows the customs information:

Property

Property Contents

Description

"commodityDescription"

string

Description of the product (freeform).

"countryOfManufacture"

valid ISO-3166 2-digit country code

The country of manufacture for this product.

"customsValue"

decimal value

The customs value of the product in customsValueCurrency units.

Example: 11.22

"customsValueCurrency"

valid ISO 4217 currency code

The currency to use for the product value in the customsValue field.

Example: "USD"

"customsWeight"

object (see elements below)

An object representing the weight of the product, containing both a weight and a weightUnit element.

"customsWeight.weight"

decimal value

The weight of the product in customsWeight.weightUnit units.

Example: 1.4

"customsWeight.weightUnit"

enumeration
One of:
"g"
"kg"
"lb"
"oz"

The unit of weight for the product's weight as represented by customsWeight.weight

Example: "kg"

Customs information example

The example below shows customs data passed as part of the customsInfo:

{
  "shipmentParameters": {
    "customsInfo": {
      "totalCustomsValue": 0,
      "totalCustomsValueCurrency": "string",  //valid ISO 4217 currency code
      "customsDescription": "string",
      "customsItems": [
        {
          "commodityDescription": "string",
          "countryOfManufacture": "string",  //ISO-3166 2 digit country code
          "customsValue": 0,
          "customsValueCurrency": "string",  //valid ISO 4217 currency code
          "customsWeight": {
            "weight": 0,
            "weightUnit": "string"  //"g" | "kg" | "lb" | "oz"
          },
          "productId": "string",  //optional
          "quantity": 0
        }
      ]
    }
  }
}

Did this page help you?