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, AfterShip Shipping will send these service_options to the courier. All these service_options can be sent like shown below.
| Name | Type | Description |
|---|
| type * | string | Accepts: alcohol. |
| recipient_type * | string | Accepts: consumer,licensee. |
| Name | Type | Description |
|---|
| type * | string | Accepts: cod. |
| cod_value * | money | money object |
| cod_recipient | address | Address object |
| Name | Type | Description |
|---|
| type * | string | Accepts: code_delivery. |
| code * | string | The code for delivery. |
| Name | Type | Description |
|---|
| type * | string | Accepts: dangerous_goods. |
| un_number | string | UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry). |
| technical_name | string | The technical name for the goods. |
| class | string | The class for the goods. |
| subsidiary_class | string | The subsidiary class for the goods. |
| packing_group | string | Dangerous 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_instruction | string | The packing instruction of the goods, e.g. PI965, PI966 |
| packing_type | string | The 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_quantity | integer | The number of packing of the goods. Minimum: 1 (set to 1 if not provided) |
| regulation_authority | string | Regulatory agency whose standards are being followed for the shipment, e.g. ADR, CFR, IATA, TDG. Only for UPS |
| transport_mean | string | The most critical leg of the journey required to deliver the goods, e.g. Highway, Ground, PAX, Passenger Aircraft, CAO |
| regulation_level | string | Reference to the amount of the substance being transported, used to trigger different levels of controls/restrictions, e.g. FR, LR, LQ |
| liquid_volume | volume | Volume object. Only applies to Amazon Shipping. |
| category_code | string | Dangerous goods content category code, Accepts: 01,02,03,04,05,06,08,09,40. Only applies to DHL eCommerce US. |
| Name | Type | Description |
|---|
| type * | string | Accepts: signature,adult_signature,indirect_signature, verification_code, pod, neighbour, leave_safe. |
| enabled * | boolean | Accepts: true,false. |
| Name | Type | Description |
|---|
| type * | string | Accepts: morning_delivery,noon_delivery,afternoon_delivery,evening_delivery. |
| Name | Type | Description |
|---|
| type * | string | Accepts: dry_ice. |
| weight * | weight | weight object |
| Name | Type | Description |
|---|
| type * | string | Service Option General Type Accepts: saturday_delivery,paperless_invoice
,rural_delivery,sameday_evening_delivery,overnight_evening_delivery
neutral_description_label,gogreen_plus. |
| enabled * | boolean | Accepts: true,false. |
| Name | Type | Description |
|---|
| type * | string | Accepts: hold_for_pickup. |
| enabled * | boolean | Accepts: true,false. |
| Name | Type | Description |
|---|
| type * | string | Accepts: hold_at_location. |
| customer_number | string | Customer Number |
| location_id | string | ID of location |
| address | address | Location Address |
| Name | Type | Description |
|---|
| type * | string | Accepts: appointment,date_certain,evening. |
| enabled * | boolean | Accepts: true,false. |
| Name | Type | Description |
|---|
| type * | string | Accepts: insurance. |
| insured_value * | money | money object |
| Name | Type | Description |
|---|
| type * | string | Accepts: ppod. |
| enabled * | boolean | Accepts: true,false. |
| Name | Type | Description |
|---|
| type * | string | Accepts: pickup. |
| start_time * | string | Preferred start time for pickup in HH:MM:SS |
| end_time | string | Preferred end time for pickup in HH:MM:SS |
| pickup_instructions | string | If you have any instructions for the pickup, they can be used as a note for some carriers |
Print Return Label Service Option object
| Name | Type | Description |
|---|
| type * | string | Accepts: print_return_label. |
| enabled * | boolean | Accepts: true,false. |
Shipping And Return Option Service Option object
| Name | Type | Description |
|---|
| type * | string | Accepts: shipping_and_return. |
| enabled * | boolean | Accepts: true,false. |
Notification Service Option object
| Name | Type | Description |
|---|
| type * | string | Accepts: notification. |
| notification_type * | string | Accepts: sms,email. |
| trigger_events * | string[] | Accepts: info_received,out_for_delivery. |