All Service Options

Service options are value added services supported by couriers. Find the full list here.


service_options is used to get different courier's value added services. For example, when users input cod in label request, Postmen will send these service_options to the courier. All these service_options can be sent like shown below.

NameTypeDescription
type *stringAccepts: alcohol.
recipient_type *stringAccepts: consumer,licensee.
NameTypeDescription
type *stringAccepts: cod.
cod_value *moneymoney object
cod_recipientaddressAddress object
NameTypeDescription
type *stringAccepts: dangerous_goods.
un_numberstringUN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry).
technical_namestringThe technical name for the goods.
classstringThe class for the goods.
subsidiary_classstringThe subsidiary class for the goods.
packing_groupstringDangerous goods are assigned into 3 packing groups (also known as UN Packing Group) in accordance with the degree of danger they present: Packing Group I: high danger, Packing Group II: medium danger, Packing Group III: low danger. Accepts: I,II,III.
packing_instructionstringThe packing instruction of the goods, e.g. PI965, PI966
packing_typestringThe packing type of these dangerous goods, as specified by the IATA packing instructions. For example, cartons, steel cylinders, fiberboard boxes, plastic jerricans and steel drums.
packing_quantityintegerThe number of packing of the goods. Minimum: 1 (set to 1 if not provided)
NameTypeDescription
type *stringAccepts: signature,adult_signature,indirect_signature.
enabled *booleanAccepts: true,false.
NameTypeDescription
type *stringAccepts: dry_ice.
weight *weightweight object
NameTypeDescription
type *stringService Option General Type Accepts: saturday_delivery,paperless_invoice
,rural_delivery,sameday_evening_delivery,overnight_evening_delivery.
enabled *booleanAccepts: true,false.
NameTypeDescription
type *stringAccepts: hold_for_pickup.
enabled *booleanAccepts: true,false.
NameTypeDescription
type *stringAccepts: appointment,date_certain,evening.
enabled *booleanAccepts: true,false.
NameTypeDescription
type *stringAccepts: insurance.
insured_value *moneymoney object
NameTypeDescription
type *stringAccepts: ppod.
enabled *booleanAccepts: true,false.
NameTypeDescription
type *stringAccepts: pickup.
start_time *stringPreferred start time for pickup in HH:MM:SS
end_timestringPreferred end time for pickup in HH:MM:SS
NameTypeDescription
type *stringAccepts: print_return_label.
enabled *booleanAccepts: true,false.