Vendor Scan
VendorScan is a POST method to upload USPS custom tracking event for certain orders:
POST Request
Vendor Scan request
'APIToken' header should be included in each request
| Property | Type | Description | Constraints |
|---|---|---|---|
EventId |
string | One of: 80, 81, 82 | |
TxnIds |
string[] | List of TxnId to upload Vendor Scan for | Required |
POST Response - 200
Vendor Scan result
Result of submitting vendor scan events to the upstream job runner. HTTP 200 always — domain-level failures (upstream EOD job declined the event) surface as Status='Failure' with detail in Warnings; transport / validation errors arrive as the error envelope (Message) with a 4xx/5xx status.
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version. | |
Status |
string | Operation status: 'Success' if the upstream job accepted the scan event; 'Failure' if the job ran but reported an error (see Warnings). | RequiredOne of: Success, Failure |
Message |
string | Human-readable result message. | |
Description |
string[] | Detailed description | |
Warnings |
Warning[] | Structured warnings returned by the upstream EOD job (richer than the inherited string Description). |
Warning
| Property | Type | Description | Constraints |
|---|---|---|---|
Code |
string | Warning code (if applicable) | |
Message |
string | Warning message | Required |
ShipMethod |
string | The shipping method | |
Carrier |
string | The carrirer name | |
Provider |
string | The provider name if applicable |
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 - 401
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 |
POST Response - 501
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 |