Delivery Confirmation Object
A delivery confirmation is a way of ensuring that the shipment reaches its final destination, such as obtaining a signature upon delivery. You defined the delivery confirmation options available through your app in Delivery Confirmation Definition files.
Properties
This table lists the properties of a delivery confirmation 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 that uniquely identifies the delivery confirmation. This ID should never change. | ||
identifiers | ✔ | Your own identifiers for this delivery confirmation. | ||
code | string | ✔ | Optional code used to map to what the carrier uses to identify the delivery confirmation. | |
name | string | ✔ | The user-friendly name for this delivery confirmation (e.g. "Adult Signature", "Authority to Leave"). | |
description | string | ✔ | A short, user-friendly description of this delivery confirmation type. | |
type | string | ✔ | The type of the delivery confirmation. Valid values include the following:
|