The shipping plugin provides a HTTP API that exposes the various layouts used to generate PDF badges.
The shipping address resource contains the following public fields:
rest-resource-table
| Field | Type | Description |
|---|---|---|
| company | string | Customer company name |
| name | string | Customer name |
| street | string | Customer street |
| zipcode | string | Customer ZIP code |
| city | string | Customer city |
| country | string | Customer country code |
state |
string |
Customer state (ISO 3166-2 code). Only supported in AU, BR, CA, CN, MY, MX, and US. |
| gift | boolean | Request by customer to not disclose prices in the shipping |
The shipping status resource contains the following public fields:
rest-resource-table
| Field | Type | Description |
|---|---|---|
| method | integer | Internal ID of shipping method |
| status | string | Status, one of "new" or "shipped" |
| method_type | string | Method type, one of "ship", "online", or "collect" |
The print job resource contains the following public fields:
rest-resource-table
| Field | Type | Description |
|---|---|---|
| code | string | Order code of the ticket order |
| event | string | Event slug |
| status | string | Status, one of "new" or "shipped" |
| method | string | Method type, one of "ship", "online", or "collect" |