跳转到内容
TeapplixTeapplixTeapplix Help

Upload Shipment

此内容尚不支持你的语言。

You can “POST” /Shipment data to to upload tracking number and other information to Teapplix. You do this for orders that are shipped outside of Teapplix.

In addition, for EVS shipments where the label is generated in Teapplix, you can use this POST method to update weight / dimension data in Teapplix in preparation for final ESM submit.

Mark Order Shipped
You can use this method to mark an open order in Teapplix as shipped. Teapplix will then confirm the order shipped back to the channel that the order is originally from.

Notice that when you confirm order as shipped in Teapplix, you should pass “ShipCarrier” value and optionally “ShipMethod” value back to Teapplix. For some channels, proper carrier values are very important. ShipMethod are also important sometimes, for example, the same carrier “UPS”, if the ship method is UPS Mail Innovations, it is important to pass it to Teapplix as external marketplaces often treat Mail Innovations as a UPS + USPS mix carrier.

To find out what value to use for ShipCarrier and ShipMethod, use the following documents as a guide

Force Flag and Restrictions
Normally, you want to mark an order shipped in Teapplix that has not already been marked as shipped. However, you can use a “Force” flag, that will overwrite the shipping information on an order already shipped in Teapplix. This Force flag will only apply to an order that is ‘marked as shipped’ via API or UI previously. For any order that the label is printed inside Teapplix, Teapplix will reject such “Mark as Shipped” operation, even if you specify the “Force” flag.

EVS Label Special Process

For USPS labels printed using EVS, Teapplix allows you to print the label with an estimated weight + dimension, and update such weight + dimension before the shipment is submitted to USPS via EVS Manifest.

You can use POST /Shipment to update only the weight + dimension of your shipment, based on TxnId as key. Anything else you pass will be ignored.

The request and response format are specified below:

https://api.teapplix.com/api2/Shipment Explorer

GET Request

Query parameters

PropertyTypeDescriptionConstraints
TxnId string Find shipment info for a specific order
ShipCarrier string Obtain shipment information with matching carrier
TrackingNumber string Obtain shipment infromation with matching tracking number
ShipDateStart string inclusive - limit to all orders shipped starting this date, format YYYY-MM-DD, YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00
ShipDateEnd string inclusive - limit to all orders shipped until this date, format YYYY-MM-DD, YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00
QueueId integer Limit orders placed in a specific queue id
StoreType string Store Type. Limit to orders from specific channel
StoreKey string Store Key. This must be specified together with StoreType, limit to orders from specific channel + account
ReturnLabel integer Return Label Flag (0|1). If you set this parameter, return will contain PDF of order label base64 encoded

GET Response - 200

Shipment Query Result

Shipment details

PropertyTypeDescriptionConstraints
Items Shipment Data[] Shipments details of orders Required

Shipment Data

PropertyTypeDescriptionConstraints
TxnId string Unique transaction id Required
PackageNo integer Number of package. Starting from 0. Currently support only PackageNo=0
ShipMethod string Ship Method. Will accept both API Enum or Teapplix native value on POST. Will atttempt to always return API Enum on GET.
Weight Weight Weight of a package or an item.
Dimensions Dimensions of package If not set Teapplix will apply 6x6x4 by default
IdenticalPackageCount integer Count of identical packages. Currently supported only for FedEx/UPS Minimum: 1
WarehouseId integer Warehouse Id the order is shipped from. Affects where inventory is deducted from.
ShipDate string Ship date, format YYYY-MM-DD. On input also supported YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00. If you provide ShipDate in request the order will be marked as shipped. If not you can update ShipMethod, Weight, Dimensions, IdenticalPackageCount and WarehouseId for open orders.
TrackingInfo Tracking Info Tracking info
LabelData Document Document details
ProfileId integer Profile Id used to print the label. If label is not printed in Teapplix, returns 1. On input only used with Ship Date + LabelData, all Shipments from same POST must have same Profile Id
PostageAmount Amount Declares any amount value
PostageAccount string Postage Account.

Weight

Weight of a package or an item.

PropertyTypeDescriptionConstraints
Value number Absolute weight value Required
Unit string Unit RequiredOne of: OZ, LB, GR, KG

Dimensions of package

If not set Teapplix will apply 6x6x4 by default

PropertyTypeDescriptionConstraints
Length number Length Required
Width number Width Required
Depth number Depth Required
Unit string Unit of measurement RequiredOne of: IN, CM

Tracking Info

Tracking info

PropertyTypeDescriptionConstraints
TrackingNumber string Tracking number of shipment Max-Length: 50
CarrierName string Carrier name which is assigned with tracking
SSCC string Serial Shipping Container Code

Document

Document details

PropertyTypeDescriptionConstraints
Type string One of: URL, INLINE
ContentType string One of: PDF, ZIP, PNG, HTML, CSV
Content string RequiredMin-Length: 1

Amount

Declares any amount value

PropertyTypeDescriptionConstraints
Amount number
Currency string Pattern: [A-Z]{3}

GET Response - 400

Message

PropertyTypeDescriptionConstraints
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

GET Response - 401

Message

PropertyTypeDescriptionConstraints
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

GET Response - 500

Message

PropertyTypeDescriptionConstraints
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
Test Request