Manifest
이 콘텐츠는 아직 번역되지 않았습니다.
The “Manifest” operation applies to certain carriers and service providers. Typically, at the end of your shipping day, before you tender a collection of packages to your service provider, you are required to upload a “manifest” file, and print out a sheet of paper to give the driver.
The Manifest API perform this action given a list of orders. You are expected to provide specific TxnIds or TrackingNumbers that will be included in the manifest. Upon success, Teapplix will return a PDF document that you can print out to be included with the packages:
Please note that the value of Provider parameter:
These two providers should be PBOWESPS
- USPS_PARCELSELECT_PACKAGE_PRESORT
- USPS_PARCELSELECT_LIGHTWEIGHT_PACKAGE_PRESORT
These providers should be FIRSTCLASSPS
- USPS_FIRST_PACKAGE_PRESORT
For all other normal USPS ship methods, Provider should be “Teapplix”.
For all DHL ship methods, Provider should be “DHL”.
POST Request
Manifest request
'APIToken' header should be included in each request
| Property | Type | Description | Constraints |
|---|---|---|---|
AirwayBillId |
string | ||
TxnIds |
string[] | List of TxnId to be included in manifest | Required |
Force |
boolean | Force submit Txns that were already manifested. Default false. Affects PBOWESPS only. | |
Provider |
string | Provider if specified will force usage of label from MARKETPLACE vs NATIVE carrier accounts linked in Teapplix. | One of: NATIVE, MARKETPLACE, TEAPPLIX, DHL, DHL_EXPRESS, FEDEX, UPS, ONTRAC, AMAZON_BUY_SHIPPING, ENDICIA, RATESHOP |
POST Response - 200
Manifest result
Result of submitting a shipping manifest. HTTP 200 always — domain-level failures (carrier/upstream rejected the manifest) surface as Status='Failure' with detail in the inherited Message/Description fields. 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 manifest was generated and the SCAN form returned; 'Failure' if the upstream rejected the request (see Message / Description). | RequiredOne of: Success, Failure |
Message |
string | Human-readable result message. | |
Description |
string[] | Detailed description | |
Warnings |
Warning[] | DEPRECATED: per-warning detail will be folded into the inherited Message and Description fields in the next API major version. Continue to read it for now if you need structured warnings; new clients should rely on Message/Description instead. | |
PickupDocument |
string | Base64 encoded Pickup Document |
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 |