Purchase Label for Order
teapplix_purchase_label_for_orderPurchase a shipping label for an existing Teapplix order. Requires TxnId, From (ship-from address or profile), and a Packages array (each package must include Method; Weight and Dimensions default to the order's stored values if omitted). [DEMO]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| From | Yes | Ship-from address OR a saved shipping profile — supply exactly one shape. | |
| TxnId | Yes | Teapplix order ID to purchase label for. | |
| Options | No | Advanced, rarely used. Omit unless the user explicitly requests features such as signature confirmation, insurance type, COD, etc. | |
| Packages | Yes | One or more packages. The first entry is the main package; additional entries are extra packages. Each package must include Method; Weight and Dimensions default to the order's stored values if omitted. All packages must use the same carrier. | |
| ShipDate | No | Ship date (YYYY-MM-DD). Defaults to today. Interpreted as Pacific timezone. | |
| CustomsDeclaration | No | International shipments only. Omit unless shipping outside the domestic country. Fields: ReasonForExport, IOssNumber, Items: [{Description, Quantity, Value, Weight, HSTariffNumber, CountryOfOrigin}]. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Status | No | ||
| LabelData | No | Label bytes; one entry per package. Content is base64-encoded. | |
| TrackingInfo | No | ||
| DocumentsData | No | Additional documents (customs forms, return slips, etc.). | |
| PostageAmount | No | ||
| ClientRequestId | No |