Set Order Shipping Options
teapplix_set_order_ship_optionsSet carrier-specific advanced shipping options (Service flags, COD) and CustomsOptions. For the common sparse options — InsuranceType and Delivery.Signature / Delivery.Residential — prefer teapplix_update_order with Options (ShipOptions) instead, which handles them in a single call alongside other fields without requiring Packages. Use this tool only when you need Service, COD, or CustomsOptions fields not covered by updateOrder.Options. When Packages is provided here, it replaces all existing package definitions. [DEMO]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| TxnId | Yes | Teapplix order ID to modify. | |
| Options | No | Advanced shipping options applied to all packages: InsuranceType, Delivery (Signature, Residential, etc.), Service, Cod, etc. | |
| Packages | No | Package definitions required when setting Options or CustomsOptions (to specify carrier method context). If provided, ALL existing package definitions for the order are replaced. First entry is the main package; additional entries are extra packages. To update ship method / weight / dimensions without advanced options, use teapplix.updateOrder with ShippingDetails (OrderShipment) instead. | |
| CustomsOptions | No | Customs options for international shipments (e.g. ReasonForExport). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| OrdersResult | No |