跳转到内容
TeapplixTeapplixTeapplix Help

Shipment Notifcation

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

You can obtain shipping information from Teapplix, after orders are shipped. There are 2 ways to obtain such information:

  • You can send a GET request to query and download Shipment data as JSON
  • Teapplix can POST Shipment JSON data to an external URL

Query Shipment Data

You can use “GET” method to obtain one or a list of “Shipment” JSON objects.

You can use the following link to find out what values Teapplix returns for ShipCarrier and ShipMethods.

Outbound Shipment Notification

Outbound Shipment Notification webhooks trigger POST to your URL every time an order is shipped.

The URL can be defined in Teapplix, and the condition of what type of order will trigger a Shipment Notification can also be defined in Teapplix:

  • For all orders from a specific channel, or specific account within a specific channel
  • For all orders from a specific queue in Teapplix
  • For all orders assigned to a specific warehouse in Teapplix
  • Other conditions that can be setup by Teapplix Support

To setup such an webhook, first define an API URL end point in Teapplix Setup => API. After that, create a filter that runs on Shipped Orders, and set the action to POST to your API end point. Once setup, Teapplix will POST to your URL the same JSON structure as the “Shipments” array in the schema below.

In both GET and POST cases, the returned JSON data format is described in the “Response” tab below. JSON Format:

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