EDI Order Pickup Routing
此内容尚不支持你的语言。
For certain EDI orders, you must request your buyer to send Pickup Routing request so some pre-arranged carriers can come to your warehouse. The following API call conducts this on a single (often wholesale) order:
POST Request
Request Pickup For Order
'APIToken' header should be included in each request
| Property | Type | Description | Constraints |
|---|---|---|---|
TxnId |
string | Order TxnId to be pickuped up | RequiredMax-Length: 40 |
PickupDateTime |
string | Requested pickup date time. e.g. 2026-01-12T09:00:00-08:00 or 2026-01-12 09:00:00. | Required |
Weight |
Weight | Weight of a package or an item. | Required |
Volume |
Volume entity | Total volume | Required |
Pallet |
Pallet entity | Pallet information | Required |
Weight
Weight of a package or an item.
| Property | Type | Description | Constraints |
|---|---|---|---|
Value |
number | Absolute weight value | Required |
Unit |
string | Unit | RequiredOne of: OZ, LB, GR, KG |
Volume entity
Total volume
| Property | Type | Description | Constraints |
|---|---|---|---|
Value |
number | Absolute value | Required |
Pallet entity
Pallet information
| Property | Type | Description | Constraints |
|---|---|---|---|
Position |
number | Position value | Required |
POST Response - 200
PickupForOrderResult
Result of submitting a pickup-for-order request
| 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: 'Submitted' on success. | RequiredOne of: Submitted |
Message |
string | Human-readable result message. | |
Description |
string[] | Detailed description |
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 |