Delivery Service Objects

A delivery service is a type of delivery that is offered by a carrier, such as international or standard overnight. You defined the delivery service options available through your app in Delivery Service Definition files.

Properties

This table lists the properties of a delivery service object and identifies those properties that are required. The nullable column indicates which properties may be null when the object is provided as an argument to one of your methods, and the required column indicates which properties are required when the object is returned from one of your methods.

Name	Type	Required?	Nullable?	Description
`id`	UUID	✔		UUID that uniquely identifies the delivery service. This is the UUID you used in the Delivery Service Definition file for this delivery service.
`identifiers`	identifiers object			Your own identifiers for this delivery service.
`code`	string			Optional code used to map to what the carrier uses to identify the delivery service.
`name`	string	✔		The user-friendly service name (e.g. "Priority Overnight", "2-Day Air").
`description`	string			A short, user-friendly description of the service.
`fulfillmentService`	string		✔	A well-known fulfillment service that's used to fulfill this delivery service, such as "fedex_ground".
`serviceArea`	string		✔	The service area this delivery service covers. Valid values include the following: `regional` - Delivery based on the shipment's distance to its destination. Rates typically vary by zone. `domestic` - Delivery with an origin address and a destination address within the same country. `international` - Delivery to a from address in at least one other country. `global` - Delivery to a from address anywhere in the world.
`isConsolidatedService`	boolean			Indicates whether this delivery service is a consolidation of multiple carrier services.
`allowsMultiplePackages`	boolean			Indicates whether the delivery service allows multiple packages in a single shipment.
`isInsurable`	boolean			Indicates whether shippers can purchase insurance from the carrier for this delivery service.
`isTrackable`	boolean			Indicates whether tracking numbers are provided by this delivery service.
`supportsReturns`	boolean			Indicates whether the carrier supports return shipments. Defaults to `false` if not specified.
`labelFormats`	string[]			The list of label formats that are offered for this delivery service. Valid values include the following: `pdf` - Potable Document Format (PDF) `zpl` - Zebra Printer Label (ZPL) `png` - Portable Graphics Format (PNG)
`labelSizes`	string[]			The list of label sizes that are offered for this delivery service. Valid values include the following: `A4` - A4 sized paper. 8.27 inches x 11.69 inches. `letter` - Letter sized paper. 8.5 inches by 11 inches. `4x6` - Paper sized 4 inches by 6 inches. `4x8` - Paper sized 4 inches by 8 inches.
`availableCountries`	country code[]			The list of ISO 3166-1 alpha-2 for the countries that can be shipped from using this delivery service.
`countries`	country code[]			All countries that this service ships to or from. This list includes all unique origin and destination countries. This list must contain ISO 3166-1 alpha-2.
`requiresWeight`	boolean	✔		Indicates whether the weight may be required when using this service. This property is `true` if any of the service's packaging requires weight.
`requiresDimensions`	boolean	✔		Indicates whether the dimensions may be required when using this service. This property is `true` if any of the service's packaging requires dimensions.
`packaging`	object[]			The types of packaging that are provided or allowed for this delivery service. This array will contain at least one value.
`packaging[].id`	UUID			A UUID that uniquely identifies the packaging. This is the UUID you used in the Packaging Definition file for this packaging.
`packaging[].identifiers`	string[]			Your own identifiers for this packaging.
`packaging[].name`	string			The user-friendly name for this packaging (e.g. "Flat-Rate Box", "Large Padded Envelope"). This string must not contain newline characters.
`packaging[].description`	string			A short, user-friendly description of the packaging. This string must not contain newline characters.
`packaging[] .requiresWeight`	boolean			Indicates whether the weight must be specified when using this packaging.
`packaging[] .requiresDimensions`	boolean			Indicates whether the dimensions must be specified when using this packaging.
`deliveryConfirmations`	object[]			The types of package delivery confirmations offered for this service.
`deliveryConfirmations[] .id`	UUID			A UUID that uniquely identifies this delivery confirmation. This is the UUID you used in the Delivery Confirmation Definition file for this delivery confirmation.
`deliveryConfirmations[] .identifiers`	object			Your own identifiers for this delivery confirmation.
`deliveryConfirmations[] .name`	string			The user-friendly name for this delivery confirmation (e.g. "Adult Signature", "Authority to Leave"). This string must not contain newline characters.
`deliveryConfirmations[] .description`	string			A short, user-friendly description of the delivery confirmation type. This string must not contain newline characters.
`deliveryConfirmations[] .type`	string	✔		The type of confirmation for this delivery confirmation. Valid values include the following: `delivery` - Package is dropped off at the destination address. `signature` - A person at the destination address signs for the package. `adult_signer` - A person over 18 at the destination address signs for the package. `direct_signature` - The person named as the recipient signs for the package. This array will contain at least one value.
`manifestType`	string		✔	Indicates whether the service supports digital or physical manifests. Valid values include the following: `Physical` - This service will require physical documents even if the carrier default is digital transmission. `Digital` - This service will not require physical documents even if the carrier default is for physical documents.