Purchase Shipping Label
teapplix_purchase_labelPurchase a standalone shipping label. Does not require an existing Teapplix order. Label bytes are base64-encoded inside LabelData[]; additional carrier documents (customs forms, return slips) are in DocumentsData[]. [DEMO]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| To | Yes | Destination address: {Name, Company, Street, Street2, City, State, ZipCode, CountryCode, Phone}. | |
| From | Yes | Ship-from address OR a saved shipping profile — supply exactly one shape. | |
| Options | No | Advanced, rarely used. Omit unless the user explicitly requests features such as signature confirmation, insurance type, COD, etc. | |
| IsReturn | No | true = generate a return label. | |
| Packages | Yes | One or more packages to ship. The first entry is the main package; additional entries are extra packages. All packages must use the same carrier. | |
| ShipDate | No | Ship date (YYYY-MM-DD). Defaults to today. Interpreted as Pacific timezone. | |
| ImageFormat | No | Label image format override. | |
| ClientRequestId | Yes | Unique client-generated ID for idempotency. Re-sending with the same ID returns the existing label. | |
| 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 |