Collect on Delivery
Collect on Delivery (C.O.D.) is an advanced option you can add to a shipment with certain supported carriers. This option allows the shipper to not pay the shipping cost, deferring it to the recipient who will pay the shipping cost upon receipt.
Requirements
- First check that the carrier that you're using supports the Collect on Delivery option. You can list carrier options to see if your carrier support this feature.
- When you create a shipment, label, or rate, use the
advanced_options.collect_on_delivery
property to specify the Collect On Delivery options.
C.O.D. Object Properties
Properties | Type | Description |
---|---|---|
payment_type | enumerated string | required Values: any , cash , cash_equivalent , none |
amount | decimal | required |
currency | enumerated string | required Values: usd , cad , aud , gbp , eur , nzd |
The cash_equivalent
payment_type
specified in the request can cover a wide range of payment methods depending on the carrier. For example, the recipient can pay with a cashier's check or a money order. Please check with your selected carrier if this will be relevant to you or your customer.
Here is an example of the advanced_options
object with the collect_on_delivery
property and related values.
Select Collect On Delivery
You can designate collect on delivery with the following methods and endpoints:
POST /v1/shipments
PUT /v1/shipments/{shipment_id}
POST /v1/labels
POST /v1/rates
Example Shipment Request & Response
Response
Example Label Request & Response
Response
The collect on delivery payment option is not shown in the create label response.
Cancel the C.O.D. Option
To cancel the collect on delivery option in a shipment, you must update the shipment. In the update request, set the payment type
to none
and the amount
to 0
.