SSCC Label
The SSCC Label operation corresponds to the “Print S2S Label” menu in Teapplix, and generates SSCC label for orders that require such labels.
You will either get the label returned inline in base64 encoded format, or get a url with a DownloadLabel link.
POST Request
SSCC Label For Order
'APIToken' header should be included in each request
| Property | Type | Description | Constraints |
|---|---|---|---|
ProfileId |
integer | Id of shipping profile, saved in Teapplix Setup | RequiredMinimum: 1 |
TxnIds |
string[] | List of order ids to generate SSCC label for | Required |
ForceRegen |
boolean | Force re-generate SSCC label |
POST Response - 200
Document
Document details
| Property | Type | Description | Constraints |
|---|---|---|---|
Type |
string | One of: URL, INLINE | |
ContentType |
string | One of: PDF, ZIP, PNG, HTML, CSV | |
Content |
string | RequiredMin-Length: 1 |
POST Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Response - 500
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |