Order Notification

Order Notification is a “POST” request, that can go 2 directions:

• From external systems to Teapplix
• From Teapplix To external systems

Inbound to Teapplix You can “push” orders to Teapplix by POSTing order notifcations at a fixed URL: https://api.teapplix.com/api2/OrderNotification The body of the POST will be defined by the schema below. Orders are uniquely identified in each Teapplix account by TxnID. Outbound from Teapplix You can also setup Teapplix to POST OrderNotification to any URL of your choice. This can be triggered using the following way:

• Manually, using the “DropShip” button on open orders
• Automatically, by adding “Filters” that automatically submit orders for dropship

When Teapplix POST to your URL, the body of the post is the “Request” JSON structure. You are expected to return HTTP code and the Response structure back to Teapplix.

GET POST PUT

https://api.teapplix.com/api2/OrderNotification Test Request Explorer

Request Response - 200 Response - 400 Response - 401 Response - 500

GET Request

Query parameters

Property	Type	Description	Constraints
TxnId	string	TxnId of order. Use this parameter to download only one order.
StoreType	string	Store Type.
StoreKey	string	Store Key.
SellerId	string	Seller ID.
SeqStart	string	Starting Unique Id for order sequence, SeqStart=12345 => for TxnSequence >= 12345, TxnSequence is a unique number assigned to each order per Teapplix account. Based on the sequence that the order is created or pulled into Teapplix. You can remember the previous maximum number you have received, and use this to incrementally download large number of orders.
SeqEnd	string	Ending Unique Id for order sequence (inclusive)
Invoice	string	Invoice number (reference number, marketplace order number)
PaymentDateStart	string	Starting payment date to filter, e.g. PaymentDateStart=2012/01/01 => for orders with payment date >= 2012/01/01 (inclusive)
PaymentDateEnd	string	Ending payment date to filter, e.g. PaymentDateEnd=2012/01/31 => for orders with payment date <= 2012/01/31 (note that since 2012/01/31 02:55:12 is greater than 2012/01/31, all orders placed on 01/31 is excluded)
UpdateDateStart	string	Starting update date to filter, e.g. UpdateDateStart=2019/01/01 => for orders with update date >= 2019/01/01
UpdateDateEnd	string	Ending update date to filter, e.g. UpdateDateEnd=2019/01/31 => for orders with update date <= 2019/01/31
ShipDateStart	string	Ship Date Start (inclusive)
ShipDateEnd	string	Ship Date End (inclusive)
PaymentStatus	string	Payment Status to filter if passed, do not filter otherwise. Possible values: Completed, Cancelled, Combined, Refunded, RMA. Please note: this option can overlap other filters.
Shipped	integer	Shipped flag (0|1), if you pass this flag, we will only give 'shipped' orders for 1 and only 'open' orders for 0
NotShipped	integer	Deprecated, use 'Shipped' instead. If you pass this flag, we will only give 'open' orders for 1 and 'shipped' order for 0
QueueId	integer	Queue Id, QueueId=0 => for orders with Normal queue; QueueId=3 => for orders with QueueId == 3 (integer; optional)
WarehouseId	string	Warehouse Id
Combine	string	Combine option (default = combine). The orders selected under these 3 modes are different: <br /><strong>combine</strong>: we will provide all 'non cancelled' orders. If 2 orders are combined into 1, the combined result order will be in the report, the original order will not <br /><strong>original</strong>: we will provide all 'non cancelled' orders. If 2 orders are combined into 1, the original order will be in the report, the combined result will not be. <br /><strong>all</strong>: all orders, including combined results, cancelled orders, etc, will be in the result.
VSAccountID	string	Virtual Seller AccountID.
DetailLevel	string	Detail Level. Used to control display data. Possible values: none, shipping, inventory, dropship, marketplace. Combine allowed, e.g. shipping|inventory. Default (if not provided) none
PageSize	string	Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate
PageNumber	string	Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed
Tag	string	Filter by order tag name. Comma-separate multiple tag names to match orders that have any of the given tags.

GET Response - 200

Order Query Notifications

Property	Type	Description	Constraints
Orders	Order Query Result[]		Required
Pagination	Pagination	Declares pagination data

Pagination

Declares pagination data

Property	Type	Description	Constraints
PageSize	integer	Current Page Size
PageNumber	integer	Current Page Number. Increase it to get next set of data until you get empty items list.
TotalPages	integer	Total Pages
Warning	string	Warning message

Order Query Result

Property	Type	Description	Constraints
TxnId	string	Unique id for each entry	RequiredMax-Length: 40Pattern: [\s\S]
ParentTxnId	string	For RMA and splilt orders, the parent orders txn id. On input only allowed on RMA and split orders.
OriginalTxnId	string	Original order id from the marketplace or shopping cart. This is before Teapplix added prefixes etc to make them unique. Ignored on input.
StoreType	string	Marketplace or shopping cart the order is from	One of: __ALL_STORE_TYPES__
StoreKey	string	Identify different stores for each store type:<br /> <strong>Amazon and FBA stores</strong><br /> Required for this store types. Identify country code of Amazon or FBA store. Accept 2 characted country code, uppercase. E.g. US, CA, etc. <br /> <strong>CommerceHub</strong> Required for this store type. Identify marketplace used to get orders via CommerceHub. Accept 2 to 5 characters code of marketplace<br /> Enum {sears, rus, hd, gg, wm, dsg, hdso, hdca, lws, khl, qvc, iqvc, jcp, cst, bbb, evn, macy, hdsi, lwsca, bls}<br /> Lowercase.<br /> <strong>Rest store types</strong> Identify different stores within specific store type. Accept 3 character code set up on Teapplix Marketplace & Carts config.<br /> Not required even if multiple-store config used. If not passed - interpreted as empty value key.	Pattern: (^$)|[a-zA-Z0-9]{2,5}
VSAccountID	string
SellerID	string	Merchant ID of store. Only applies to eBay Amazon FBA. For eBay this is the seller name, for Amazon or FBA, this is the Merchant Id
OrderSource	string	Some channel, like shopify and channeladvisor download foreign orders. This optional string gives indication where order downloaded from.
EbayBuyerID	string
PaymentStatus	string	Payment Status of the order. Normally this should be 'Completed'	One of: Completed, Cancelled, Refunded, PartialRefund
PaymentType	string	Payment type of the order (from pin.payment_type)
LastUpdateDate	string
To	ReturnAddress	Return address printed on labels
BillTo	ReturnAddress	Return address printed on labels
SkipAddressValidation	boolean	Normally the 'To' address is validated on 'POST' Order input. If SkipAddressValidation is set to true, this validation is skipped. Default false.
OrderTotals	OrderTotals	Order totals
OrderDetails	OrderDetails	Order details including queue, warehouse, tags, memo, and custom fields
OrderItems	Order Item[]	Information related to the order’s items
ShippingDetails	OrderShipment[]	Information related to the order’s packages. This tag is optional, but if specified array must have at least one OrderShipment to define the main package for the order. If you add more OrderShipment, those will represent extra packages for the order.
DropshipDetails	DrophipDetails
Options	Order Shipping Options	Shipment options
CustomsOptions	Customs options	Customs options
HandlingBy	string	Date before which the order is expected to be shipped out	Pattern: ^(\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
DeliverBy	string	Date by which the order is expected to arrive at the buyer	Pattern: ^(\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
SeqNumber	string	Unique integer assigned to each order as they are created. Increases
RMACode	string	Type of RMA
MarketplaceStatus	MarketplaceStatus	The external status of the order: being reviewed after shipping label generated, tracking upload to marketplace, and invoices etc.

ReturnAddress

Return address printed on labels

Property	Type	Description	Constraints
Name	string	Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 128
FirstName	string	First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
LastName	string	Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
Company	string	Company or organization name. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 127
Street	string	Street address, line 1 (building number and street name).	Max-Length: 255
Street2	string	Street address, line 2 (apartment, suite, unit, floor, etc.).	Max-Length: 255
City	string	City or town name.	Max-Length: 40Min-Length: 1
State	string	US state abbreviation (e.g. CA) or province/region name for international addresses.	Max-Length: 40
ZipCode	string	US ZIP code or international postal code.
CountryCode	string	ISO 3166-1 alpha-2 country code (e.g. US, CA, GB).	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}
Country	string	Full country name (e.g. United States, Canada). Defaults to United States
PhoneNumber	string	Phone number. Format may be normalized by the carrier.	Max-Length: 40
Email	string	Email address.

OrderTotals

Order totals

Property	Type	Description	Constraints
Shipping	number	Shipping cost
Handling	number	Handling
Discount	number	Discount amount
Tax	number	Tax amount
InsuranceType	string	Insurance Type. This tag is deprecated. Please use Options/IsuranceType tag instead.	One of: none, teapplix, carrier
Currency	string	Order currency	Pattern: [A-Z]{3}
PostageCurrency	string	Postage currency	Pattern: [A-Z]{3}
Fee	number	Fee amount
Total	number	Total amount

OrderDetails

Order details including queue, warehouse, tags, memo, and custom fields

Property	Type	Description	Constraints
Invoice	string	If the order matches an invoice, the unique id of the invoice.	Max-Length: 127
PaymentDate	string	Date of payment. Format Y-m-D H:i:s or Y-m-d. If not set - current date time will be used	Pattern: ^\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])( (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
Memo	string	This is memo from the buyer left when placing the order	Max-Length: 2048
PrivateMemo	string	This is memo that seller placed on the order to help with processing. This is not from the buyer	Max-Length: 2048
GiftMessage	string	Gift message	Max-Length: 2048
WarehouseId	integer	The id of the teapplix warehouse this order is assigned to
WarehouseName	string	The name of the teapplix warehouse this order is assigned to
QueueId	integer	The id of the teapplix order queue this order is assigned to.
TagList	string[]	Teapplix order can be assigned several tags, which can be used to filter the order. This is the current list of tags order is assigned to.
ShipClass	string	Ship class typically indicate the level of shipping speed the order should have
Custom	string	Custom	Max-Length: 255
Custom2	string	Custom2	Max-Length: 255
Custom3	string	Custom3	Max-Length: 255
Custom4	string	Custom4	Max-Length: 255

DrophipDetails

Property	Type	Description	Constraints
ProductPrice	number	Product Price
Markup	number	Markup
Handling	number	Handling
Packing	number	Packing

Order Shipping Options

Shipment options

Property	Type	Description	Constraints
InsuranceType	string	Insurance Type	One of: none, teapplix, carrier
InsuranceClosed	boolean	Insurance Closed flag. Ignored on input.
InsuranceClosedReason	string	Insurance Closed Reason message. Ignored on input.
Billed	DutyBilled	Duties and Taxes data
DutyBilled	DutyBilled	Duties and Taxes data
SplitDutyVAT	boolean	Split Duty VAT
Delivery	Delivery	Delivery
Service	Service
Cod	Cod	C.O.D. details
Ups	Ups	UPS specific options
Fedex	Fedex	FedEx specific options
DHL	DHL	DHLeC specific options
DHLE	DHLE	DHL Express specific options
ReasonForExport	string	DEPRECATED! Reason for export	Max-Length: 20

Customs options

Customs options

Property	Type	Description	Constraints
ReasonForExport	string		Max-Length: 20
IOSSNumber	string	The IOSS number of the seller. Sellers selling in the EU will be assigned a unique IOSS number that must be listed on all packages sent to the EU.
BrokerAddress	string	Broker Address

MarketplaceStatus

The external status of the order: being reviewed after shipping label generated, tracking upload to marketplace, and invoices etc.

Property	Type	Description	Constraints
Reviewed	MarkShipped	Mark Shipped Status
MarkShipped	MarkShipped	Mark Shipped Status

Order Item

Order item

Property	Type	Description	Constraints
Name	string	Item's name	Max-Length: 255
LineNumber	integer	Line Number
ItemId	string	Seller item Id. This typically maps to the listing id on catalogs	Max-Length: 127
ItemSKU	string	Mapped product name in Teapplix	Max-Length: 255
ItemLocation	string	Item Location. This is stored on the order line if you set it on inbound POST|PUT
Description	string	Item description	Max-Length: 255
Quantity	integer	The quantity of this item ordered
UnitOfMeasure	string	Unit of measure for this item (e.g. EA, CS). Accepted and provided only for store types that support unit of measure	Max-Length: 40
Amount	number	Subtotal for this order line
Shipping	number	Shipping cost
Tax	number	Handling amount
ItemCustom	string	Item Custom field. Accepted and provided only for store types that support this custom field	Max-Length: 255
ItemCustom2	string	Item Custom2 field. Accepted and provided only for store types that support this custom field	Max-Length: 255
ItemCustom3	string	Item Custom3 field. Accepted and provided only for store types that support this custom field	Max-Length: 255
ItemCustom4	string	Item Custom4 field. Accepted and provided only for store types that support this custom field	Max-Length: 255
Shipping Tax	number	Shipping tax amount

OrderShipment

Property	Type	Description	Constraints
Package	Shipment Package	Declares packages to be shipped
ShipDate	string	Date the order is shipped. Do not specify this for open orders. Note that if an order is shipped, all packages must have the same ship date.	Pattern: ^(\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
PostageAccount	string	Postage Account. Ignored on input.

DutyBilled

Duties and Taxes data

Property	Type	Description	Constraints
Role	string	Role	RequiredOne of: sender, recipient, third_party
AccountNumber	string	Account number
AccountPostalCode	string	Account Postal Code. Currently UPS only	Max-Length: 10
AccountCountryCode	string	Account Country Code. Currently UPS only	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}

Delivery

Delivery

Property	Type	Description	Constraints
Signature	string	Signature type	One of: NOT_REQUIRED, ANY_REQUIRED, ADULT_REQUIRED, DIRECT_REQUIRED, INDIRECT_REQUIRED, SERVICE_DEFAULT
Saturday	integer	Saturday delivery
Sunday	boolean	Sunday delivery
Holiday	boolean	Holiday delivery
Weekend	boolean	Weekend delivery
Am	boolean	AM delivery
Restricted	boolean	Restricted area delivery
Inside	boolean	Inside delivery
Residential	integer	Residential delivery
HomeDeliveryDate	string	Home delivery date	Format: date
Instructions	string	Delivery Instructions, including HomeDelivery Instructions
LiftGate	boolean	Lift gate
LimitedAccess	boolean
ConstructionSite	boolean	Construction site
CallBefore	boolean	Call before

Service

Property	Type	Description	Constraints
RegisteredMail	boolean	Registered mail
AdditionalHandling	boolean	Additional handling
ShipperRelease	boolean	Shipper Release
CarbonNeutral	boolean	Carbon neutral
DangerousGoods	boolean	Dangerous goods flag
HandlingCharge	boolean	Handling charge
ExtremeLength	boolean	Extreme length
ReturnsClearance	boolean	Returns clearance
Pickup	boolean	Pickup

Cod

C.O.D. details

Property	Type	Description	Constraints
Amount	Amount	Declares any amount value
Kind	string	Kind
CollectionType	string	Collection Type	One of: 1, 2, 3, 4, 5
Address	ReturnAddress	Return address printed on labels
ReferenceIndicator	string	Reference indicator
TransportationChargesDetail	string	Transportation Charges Detail	One of: ADD_ACCOUNT_COD_SURCHARGE, ADD_ACCOUNT_NET_CHARGE, ADD_ACCOUNT_NET_FREIGHT, ADD_ACCOUNT_TOTAL_CUSTOMER_CHARGE, ADD_LIST_COD_SURCHARGE, ADD_LIST_NET_CHARGE, ADD_LIST_NET_FREIGHT, ADD_LIST_TOTAL_CUSTOMER_CHARGE
RecipientAccountNumber	string	Recipient Account Number	Pattern: \d+
BillingOption	string	Billing Option	One of: Prepaid, Freight Collect

Ups

UPS specific options

Property	Type	Description	Constraints
SurepostNonMachineable	boolean	UPS Surepost Non Machineable
Qvn	Qvn
Freight	UPS Freight

Fedex

FedEx specific options

Property	Type	Description	Constraints
CustomsOption	string	Customs option
Coverage	string
ExportDetail	ExportDetail	Export detail
Recipient	Recipient	Recipient
HoldAtLocation	HoldAtLocation	Hold At Location
SmartPostEndiciaType	string
TotalPalletWeight	number
FreightGuaranteeDetailDate	string
Delivery	Delivery	Delivery
Instructions	Instructions	Instructions
Freight	FedEx Freight	Freight
BillAccount	string
CollectTermsType	string
BrokerType	string
SignatureReleaseNumber	string
HandlingUnits	string
ExpressFreightBookingConfirmationNumber	string
B13aFilling	string
ExportStatement	string
ImportOfRecordAccountNumber	string

DHL

DHLeC specific options

Property	Type	Description	Constraints
TermsOfTrade	string	Terms of Trade	One of: DDP, DAP
ConsigneeTaxIdType	string	Consignee Tax Id Type	One of: OTHER, GSTVAT, EORI, IOSS, TBD, PAN
ConsigneeTaxId	string	Consignee Tax Id
ConsigneeIdType	string	Consignee Id Type
ConsigneeId	string	Consignee Id

DHLE

DHL Express specific options

Property	Type	Description	Constraints
DeliveryType	string	Delivery Type: NONE DD (Door to Door) DA (Door to Airport) AA (Airport to Airport) DC (Door to Door non- Compliant)	One of: NONE, DD, DA, AA, DC

MarkShipped

Mark Shipped Status

Property	Type	Description	Constraints
Status	integer	Shipped status of the order.<br /> 1: Order successfully marked as shipped<br /> -1: Failed to mark order as shipped<br /> 0: Order not yet marked as shipped

Shipment Package

Declares packages to be shipped

Property	Type	Description	Constraints
Method	string	Shipping method used to print label. One of <br /><strong>USPS:</strong><br />'USPS_GROUND_ADVANTAGE', 'USPS_GROUND_ADVANTAGE_SOFTPACK', 'USPS_GROUND_ADVANTAGE_CUBIC', 'USPS_FIRST_ENVELOPE', 'USPS_FIRST_ENVELOPE_NON_MACHINABLE', 'USPS_FIRST_FLAT', 'USPS_FIRST_FLAT_NON_MACHINABLE', 'USPS_PARCELSELECT_LIGHTWEIGHT_PACKAGE', 'USPS_PARCELSELECT_PACKAGE', 'USPS_PRIORITY_PACKAGE', 'USPS_PRIORITY_CUBIC', 'USPS_PRIORITY_ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_PADDED', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_LEGAL', 'USPS_PRIORITY_FLAT_RATE_BOX_SMALL', 'USPS_PRIORITY_FLAT_RATE_BOX', 'USPS_PRIORITY_FLAT_RATE_BOX_LARGE', 'USPS_PRIORITY_REGIONALRATEBOXA', 'USPS_PRIORITY_REGIONALRATEBOXB', 'USPS_PRIORITY_REGIONALRATEBOXC', 'USPS_PRIORITY_FLATRATEBOXAPOFPO', 'USPS_PRIORITY_SOFTPACK', 'USPS_PRIORITY_EXPRESS_PACKAGE', 'USPS_PRIORITY_EXPRESS_PACKAGE_NON_MACHINABLE', 'USPS_PRIORITY_EXPRESS_ENVELOPE', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_LEGAL', 'USPS_EXPRESS_FLATRATEMEDIUMBOX', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_PADDED', 'USPS_MEDIAMAIL_RECTPARCEL', 'USPS_CRITICAL_ENVELOPE', 'USPS_CRITICAL_FLAT', 'CONSDOM/Standard', 'CONSDOM/Expedited'<br /><strong>USPS Intl:</strong><br />'USPS_FIRST_PACKAGE_INTERNATIONAL', 'USPS_FIRST_ENVELOPE_INTERNATIONAL', 'USPS_FIRST_ENVELOPE_NON_MACHINABLE_INTERNATIONAL', 'USPS_FIRST_FLAT_INTERNATIONAL', 'USPS_PRIORITY_PACKAGE_INTERNATIONAL', 'INTLPRIORITY/ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_PADDED_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_LEGAL_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_SMALL_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_LARGE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_PACKAGE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_LEGAL_INTERNATIONAL', 'INTLEXPRESS/FLATRATEMEDIUMBOX', 'USPS_PRIORITY_AIRMAIL_INTERNATIONAL', 'USPS_ISAL_RECTPARCEL', 'CONSINTL/RECTPARCEL', 'CONSINTL1/RECTPARCEL', 'CONSINTL2/RECTPARCEL', 'CONSINTL3/RECTPARCEL', 'CONSINTL4/RECTPARCEL', 'CONSINTL5/RECTPARCEL', 'CONSINTL6/RECTPARCEL', 'CONSINTL7/RECTPARCEL', 'CONSINTL8/RECTPARCEL', 'CONSINTL9/RECTPARCEL', 'CONSINTL10/RECTPARCEL', 'CONSINTL11/RECTPARCEL', 'CONSINTL12/RECTPARCEL', 'CONSINTL13/RECTPARCEL', 'CONSINTL14/RECTPARCEL', 'CONSINTL15/RECTPARCEL', 'CONSINTL16/RECTPARCEL', 'USPS_COMMERCIAL_EPACKET_INTERNATIONAL'<br /><strong>FedEx:</strong><br />'FEDEX_GROUND', 'FEDEX_HOME', 'FEDEX_FIRST_OVERNIGHT', 'FEDEX_PRIORITY_OVERNIGHT', 'FEDEX_STANDARD_OVERNIGHT', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_2DAY', 'FEDEX_2DAY_AM', 'FEDEX_EXPRESS_SAVER', 'FEDEX_SMART_POST', 'FEDEX_FIRST_OVERNIGHT_INTERNATIONAL', 'FEDEX_PRIORITY_OVERNIGHT_INTERNATIONAL', 'FEDEX_ECONOMY_INTERNATIONAL', 'FEDEX_GROUND_INTERNATIONAL', 'FEDEX_FREIGHT_1DAY', 'FEDEX_FREIGHT_2DAY', 'FEDEX_FREIGHT_3DAY', 'FEDEX_FREIGHT_FIRST', 'FEDEX_FREIGHT_ECONOMY', 'FEDEX_FREIGHT_PRIORITY', 'FEDEX_FREIGHT_PRIORITY_INTERNATIONAL', 'FEDEX_FREIGHT_ECONOMY_INTERNATIONAL', 'FEDEX_CONNECT_PLUS_INTERNATIONAL', 'FEDEX_PRIORITY_EXPRESS_INTERNATIONAL', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_PAK', 'FEDEX_2DAY_ONE_RATE_TUBE', 'FEDEX_2DAY_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_PAK', 'FEDEX_2DAY_AM_ONE_RATE_TUBE', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_AM_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_PAK', 'FEDEX_EXPRESS_SAVER_ONE_RATE_TUBE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_MEDIUM_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ENVELOPE', 'FEDEX_2DAY_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ENVELOPE', 'FEDEX_2DAYAM_ENVELOPE', 'FEDEX_INTLGROUNDCONSOLIDATION', 'FEDEX_STANDARDOVERNIGHT_ENVELOPE'<br /><strong>UPS:</strong><br />'UPS_GROUND', 'UPS_NEXT_DAY_AIR', 'UPS_NEXT_DAY_AIR_EARLY_AM', 'UPS_NEXT_DAY_AIR_SAVER', 'UPS_2DAY_AIR_AM', 'UPS_2DAY_AIR', 'UPS_3DAY_SELECT', 'UPS_STANDARD', 'UPS_EXPRESS_EARLY_AM', 'UPS_EXPRESS', 'UPS_EXPRESS_SAVER', 'UPS_EXPEDITED', 'UPS_WORLDWIDE_EXPRESS_PLUS', 'UPS_WORLDWIDE_EXPRESS', 'UPS_WORLDWIDE_SAVER', 'UPS_WORLDWIDE_EXPEDITED', 'UPS_STANDARD_TO_CANADA', 'UPS_GROUND_SAVER', 'UPS_SUREPOST_LESS1LB', 'UPS_SUREPOST_LESS1LB_IRREGULAR', 'UPS_SUREPOST_MORE1LB_IRREGULAR', 'UPS_SUREPOST_MEDIA_IRREGULAR', 'UPS_SUREPOST_BPM_IRREGULAR', 'UPS_SUREPOST_1LB_OR_GREATER_MACHINABLE', 'UPS_MAILINNOVATIONS_LESS1LB', 'UPS_MAILINNOVATIONS_PARCELPOST', 'UPS_MAILINNOVATIONS_MACHINABLE', 'UPS_MAILINNOVATIONS_STANDARD_FLAT', 'UPS_MAILINNOVATIONS_BPM_PARCEL', 'UPS_MAILINNOVATIONS_BPM_FLAT', 'UPS_MAILINNOVATIONS_MEDIA', 'UPS_MAILINNOVATIONS_FIRST', 'UPS_MAILINNOVATIONS_PRIORITY', 'UPS_MAILINNOVATIONS_PRIORITY_INTERNATIONAL', 'UPS_MAILINNOVATIONS_ECONOMY_INTERNATIONAL', 'UPS_FREIGHT', 'UPS_FREIGHT_GUARANTEED', 'UPS_FREIGHT_GUARANTEED_AM', 'UPS_FREIGHT_STANDARD', 'UPS_GROUND_SIMPLE_RATE_XS', 'UPS_GROUND_SIMPLE_RATE_S', 'UPS_GROUND_SIMPLE_RATE_M', 'UPS_GROUND_SIMPLE_RATE_L', 'UPS_GROUND_SIMPLE_RATE_XL', 'UPS_2DAY_AIR_SIMPLE_RATE_XS', 'UPS_2DAY_AIR_SIMPLE_RATE_S', 'UPS_2DAY_AIR_SIMPLE_RATE_M', 'UPS_2DAY_AIR_SIMPLE_RATE_L', 'UPS_2DAY_AIR_SIMPLE_RATE_XL', 'UPS_3DAY_SELECT_SIMPLE_RATE_XS', 'UPS_3DAY_SELECT_SIMPLE_RATE_S', 'UPS_3DAY_SELECT_SIMPLE_RATE_M', 'UPS_3DAY_SELECT_SIMPLE_RATE_L', 'UPS_3DAY_SELECT_SIMPLE_RATE_XL', 'UPS_ST_CA', 'UPS_WORLDWIDE_SAVER_ASIA', 'UPS_WORLDWIDE_EXPEDITED_ASIA', 'UPS_WORLDWIDE_EXPRESS_ASIA', 'UPS_WORLDWIDE_EXPRESS_PLUS_ASIA', 'UPS_WORLDWIDE_SAVER_CANADA', 'UPS_3DAY_SELECT_CANADA', 'UPS_WORLDWIDE_EXPEDITED_CANADA', 'UPS_WORLDWIDE_EXPRESS_PLUS_CANADA', 'UPS_WORLDWIDE_EXPRESS_CANADA'<br /><strong>DHL Express:</strong><br />'DHLE_EXPRESS_9AM', 'DHLE_ECONOMY_SELECT', 'DHLE_EXPRESS_1030AM', 'DHLE_DOMESTIC_EXPRESS', 'DHLE_EXPRESS_WORLDWIDE', 'DHLE_EUROPACK', 'DHLE_EXPRESS_1200AM', 'DHLE_EXPRESS_WORLDWIDE_DOC', 'DHLE_EXPRESS_1200AM_DOC', 'DHLE_EXPRESS_9AM_DOC', 'DHLE_EXPRESS_1030AM_DOC', 'DHLE_ECONOMYSELECT_A', 'DHLE_EXPRESS1030AM_A', 'DHLE_EXPRESS1200AM_A', 'DHLE_EXPRESS9AM_A', 'DHLE_EXPRESSENVELOPE', 'DHLE_EXPRESSENVELOPE_A', 'DHLE_EXPRESSWORLDWIDE_A'<br /><strong>DHL eCommerce:</strong><br />'DHLEC_PARCELS_GROUND', 'DHLEC_PARCELS_GROUND_IRREGULAR', 'DHLEC_PARCELS_PLUS_GROUND', 'DHLEC_PARCELS_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCEL_GROUND_IRREGULAR', 'DHLEC_PARCEL_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED', 'DHLEC_PARCELS_EXPEDITED_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED_MAX', 'DHLEC_PARCELS_PLUS_EXPEDITED', 'DHLEC_PARCELS_PLUS_EXPEDITED_MAX', 'DHLEC_PARCEL_EXPEDITED_MAX', 'DHLEC_PARCEL_PLUS_EXPEDITED_MAX', 'DHLEC_PRIORITY', 'DHLEC_FIRST_PARCEL', 'DHLEC_FIRST_PARCEL_IRREGULAR', 'DHLEC_MARKETING_PARCEL_GROUND', 'DHLEC_MARKETING_PARCEL_GROUND_IRREGULAR', 'DHLEC_MARKETING_PARCEL_EXPEDITED', 'DHLEC_MARKETING_PARCEL_EXPEDITED_IRREGULAR', 'DHLEC_BPM_GROUND', 'DHLEC_BPM_EXPEDITED', 'DHLEC_CATALOG_BPM_GROUND', 'DHLEC_CATALOG_BPM_EXPEDITED', 'DHLEC_PACKET_STANDARD', 'DHLEC_PACKET_PRIORITY', 'DHLEC_PACKET_PLUS', 'DHLEC_PACKET_IPA', 'DHLEC_PACKET_ISAL', 'DHLEC_PARCEL_STANDARD', 'DHLEC_PARCEL_PRIORITY', 'DHLEC_PARCEL_DIRECT', 'DHLEC_PARCEL_DIRECT_EXPRESS', 'DHLEC_BUSINESS_STANDARD', 'DHLEC_BUSINESS_PRIORITY', 'DHLEC_BUSINESS_IPA', 'DHLEC_BUSINESS_ISAL', 'DHLEC_EXPEDITED_FLAT', 'DHLEC_GROUND_FLAT', 'DHLEC_PARCEL_RETURN_PLUS', 'DHLEC_PARCEL_RETURN_GROUND', 'DHLEC_PARCEL_RETURN_LIGHT', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_FORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_FORMAL', 'DHLEC_PARCEL_DIRECT_INTL', 'DHLEC_PARCEL_DIRECT_STANDARD_CA', 'DHLEC_PARCEL_DIRECT_PRIORITY_CA', 'DHLEC_PARCEL_DIRECT_MAX_CA', 'DHLEC_PARCELDIRECTEXPEDITED_RECTPARCEL'<br /><strong>OnTrac:</strong><br />'ONTRAC_GROUND', 'ONTRAC_SUNRISE', 'ONTRAC_SUNRISE_GOLD'<br /><strong>Estes:</strong><br />'ESTES_GUARANTEED_STANDARD', 'ESTES_GUARANTEED_ECONOMY', 'ESTES_GUARANTEED_BASIC', 'ESTES_GUARANTEED_EXCLUSIVE', 'ESTES_GUARANTEED_5PM', 'ESTES_GUARANTEED_12PM', 'ESTES_GUARANTEED_10AM', 'ESTES_STANDARD'<br /><strong>Purolator:</strong><br />'PUROLATOR_GROUND', 'PUROLATOR_GROUND_9AM', 'PUROLATOR_GROUND_10:30AM', 'PUROLATOR_GROUND_EVENING', 'PUROLATOR_EXPRESS', 'PUROLATOR_EXPRESS_9AM', 'PUROLATOR_EXPRESS_10:30AM', 'PUROLATOR_EXPRESS_12PM', 'PUROLATOR_EXPRESS_EVENING', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE_9AM', 'PUROLATOR_EXPRESS_ENVELOPE_10:30AM', 'PUROLATOR_EXPRESS_ENVELOPE_12PM', 'PUROLATOR_EXPRESS_ENVELOPE_EVENING', 'PUROLATOR_EXPRESS_PACK', 'PUROLATOR_EXPRESS_PACK_9AM', 'PUROLATOR_EXPRESS_PACK_10:30AM', 'PUROLATOR_EXPRESS_PACK_12PM', 'PUROLATOR_EXPRESS_PACK_EVENING', 'PUROLATOR_EXPRESS_BOX', 'PUROLATOR_EXPRESS_BOX_9AM', 'PUROLATOR_EXPRESS_BOX_10:30AM', 'PUROLATOR_EXPRESS_BOX_12PM', 'PUROLATOR_EXPRESS_BOX_EVENING'<br /><strong>Amazon:</strong><br />'AMAZON_SHIPPING_GROUND'<br /><strong>GoFo Express:</strong><br />'GOFO_STANDARD', 'GOFO_GROUND'<br /><strong>UniUni:</strong><br />'UNIUNI_STANDARD', 'UNIUNI_EXPRESS'<br /><strong>Yanwen:</strong><br />'YW_STANDARD'<br /><strong>Canada Post:</strong><br />'CAPOST_CADOM_EP', 'CAPOST_CADOM_PC', 'CAPOST_CADOM_RP', 'CAPOST_CADOM_XP', 'CAPOST_CAINT_IP_AIR', 'CAPOST_CAINT_IP_SURF', 'CAPOST_CAINT_PW_ENV', 'CAPOST_CAINT_PW_PAK', 'CAPOST_CAINT_PW_PARCEL', 'CAPOST_CAINT_SP_AIR', 'CAPOST_CAINT_SP_SURF', 'CAPOST_CAINT_TP', 'CAPOST_CAINT_XP', 'CAPOST_CAUSA_EP', 'CAPOST_CAUSA_PW_ENV', 'CAPOST_CAUSA_PW_PAK', 'CAPOST_CAUSA_PW_PARCEL', 'CAPOST_CAUSA_SP_AIR', 'CAPOST_CAUSA_TP', 'CAPOST_CAUSA_XP'
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
Type	PackageType | CustomPackageName	Allows you to specify a built-in package type (integer) defined by the carrier, or a custom package you defined by name in your Teapplix account. You should specify one of 'Type' or 'Dimensions' in your input.
PackageItems	PackageItem[]	Items and their quantities inside the package. This information is required for certain marketplaces.
Reference	string	This value will be printed on label. BBCODE placeholders can be used.
InsuranceValue	number	Insurance Value.
InsuranceFee	number	Insurance Fee. This value is ignored for input.
Postage	number	Postage amount for shipped package. Do not fill this for normal open orders.
TrackingInfo	Tracking Info	Tracking info

Amount

Declares any amount value

Property	Type	Description	Constraints
Amount	number
Currency	string		Pattern: [A-Z]{3}

Qvn

Property	Type	Description	Constraints
Qvn	integer	Qvn
From	string	From
EmailOnFail	string	Email on fail
Subject	string	Subject
Memo	string	Memo
Recipients	Freight Notification Recipient[]	Qvn Recipients

UPS Freight

Property	Type	Description	Constraints
Class	number	Freight Class
PackageType	string	Freight Package Type
PackagesQuantity	integer	Packages Quantity
PayerName	string	Payer Name	Max-Length: 40
PayerAddress	string	Payer Address	Max-Length: 255
PayerCity	string	Payer City	Max-Length: 50
PayerState	string	Payer State	Max-Length: 50
SortingAndSegregating	boolean	Sorting And Segregating
SortingQuantity	string	Sorting Quantity
ExtremeLength	boolean	Extreme Length
FreezableProtection	boolean	Freezable Protection
Handling	Handling	Handling
DangerousGoods	DangerousGoods	UPS Dangerous Goods Data
Pickup	Pickup

ExportDetail

Export detail

Property	Type	Description	Constraints
Kind	string
ForeignZoneCode	string
EntryNumber	string
LicenseNumber	string
ExpirationDate	string		Format: date

Recipient

Recipient

Property	Type	Description	Constraints
TaxId	CustomsId
CustomsId	CustomsId

HoldAtLocation

Hold At Location

Property	Type	Description	Constraints
Applied	string
Address	string
AddressType	string

Instructions

Instructions

Property	Type	Description	Constraints
Handling	string
Delivery	string
HomeDelivery	string
Pickup	string

FedEx Freight

Freight

Property	Type	Description	Constraints
Class	string	Freight Class	One of: CLASS_050, CLASS_055, CLASS_060, CLASS_065, CLASS_070, CLASS_077_5, CLASS_085, CLASS_092_5, CLASS_100, CLASS_110, CLASS_125, CLASS_150, CLASS_175, CLASS_200, CLASS_250, CLASS_300, CLASS_400, CLASS_500
PackageType	string	Freight Package Type	One of: BAG, BARREL, BASKET, BOX, BUCKET, BUNDLE, CARTON, CASE, CONTAINER, CRATE, CYLINDER, DRUM, ENVELOPE, HAMPER, OTHER, PAIL, PALLET, PIECE, REEL, ROLL, SKID, TANK, TUBE
PrintedReferenceType	string	Printed Reference Type	One of: BILL_OF_LADING, CONSIGNEE_ID_NUMBER, SHIPPER_ID_NUMBER
PrintedReferenceValue	string	Printed Reference Value	Max-Length: 255
GuaranteeDetailType	string	Freight Guarantee Detail Type	One of: GUARANTEED_DATE, GUARANTEED_MORNING
GuaranteeDetailDate	string	Freight Guarantee Detail Date	Format: date
Note	string	Note	Max-Length: 255
FreightDirectType	string	Freight Direct Type	Max-Length: 255
FreightDirectTransportationType	string	Freight Direct Transportation Type	Max-Length: 255
FreightDirectEmail	string	Freight Direct Email	Max-Length: 255
FreightDirectPhoneType1	string	Freight Direct Phone Type 1	Max-Length: 255
FreightDirectPhoneNumber1	string	Freight Direct Phone Number 1	Max-Length: 255
FreightDirectPhoneType2	string	Freight Direct Phone Type 2	Max-Length: 255
FreightDirectPhoneNumber2	string	Freight Direct Phone Number 2	Max-Length: 255
FreightDirectPhoneType3	string	Freight Direct Phone Type 3	Max-Length: 255
FreightDirectPhoneNumber3	string	Freight Direct Phone Number 3	Max-Length: 255

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

Dimensions of package

If not set Teapplix will apply 6x6x4 by default

Property	Type	Description	Constraints
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

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

Handling

Handling

Property	Type	Description	Constraints
Charge	string	Handling Charge
ChargeType	string	Handling Charge Type
ChargeValue	string	Handling Charge Value
Instructions	string	Instructions

DangerousGoods

UPS Dangerous Goods Data

Property	Type	Description	Constraints
Type	integer
Name	string	Dangerous Goods Name	Max-Length: 40
PhoneNumber	string	Dangerous Goods Phone Number	Max-Length: 40
PhoneExtension	string	Dangerous Goods Phone Extension	Max-Length: 10

Pickup

Property	Type	Description	Constraints
Weekend	boolean	Weekend
Holiday	boolean	Holiday
Inside	boolean	Inside
Residential	boolean	Residential
LimitedAccess	boolean	Limited access
LiftGate	boolean	Lift Gate Pickup Required
Instructions	string	Instructions

CustomsId

Property	Type	Description	Constraints
Type	string
Number	string

PackageItem

Declares package item to be shipped

Property	Type	Description	Constraints
LineNumber	integer	One of Line Number or Item Name is required.
Name	string	Specify Name of Item only if it is unique in Order Items list, otherwise specify Line Number. One of Line Number or Name is required.
Quantity	integer	Quantity.	RequiredMinimum: 1

Freight Notification Recipient

Property	Type	Description	Constraints
CompanyOrName	string	Company or Name
ContactName	string	Contact Name
Email	string	Email
ShipNotify	boolean	Ship Notify
ExceptionNotify	boolean	Exception Notify
DeliveryNotify	boolean	Delivery Notify
BolNotify	boolean	Bol Notify
BolEmailSubject	string	Bol Email Subject
BolEmailText	string	Bol Email Text

GET 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

GET 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

GET 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

Request Response - 200 Response - 400 Response - 401 Response - 500

POST Request

Order Notifications

'APIToken' header should be included in each request

Property	Type	Description	Constraints
Operation	string	Requested operation	One of: Submit
Orders	Order To Create[]	Array of orders

Order To Create

Property	Type	Description	Constraints
TxnId	string	Unique id of an order in Teapplix. When we say teapplix order xxx, it often means TxnId=xxx	RequiredMax-Length: 40Pattern: [\s\S]
ParentTxnId	string	For RMA and splilt orders, the parent orders txn id. On input only allowed on RMA and split orders.
OriginalTxnId	string	Original order id from the marketplace or shopping cart. This is before Teapplix added prefixes etc to make them unique. Ignored on input.
StoreType	string	Marketplace or shopping cart the order is from	One of: 3dcart, 3plcentral, Manual, RMA, aafes, aafes2, academysports, acehardware, acenda, amazon, amzv, ashley, ashley2, barnesnoble, basspro, belk, belkb2b, bestbuy, bestbuy2bca, bigcommerce, bonanza, ca2, campwrld, chewy, commercehub, corecommerce, costco, costcoca, costcojp, cratejoy, creloaded, cscart, cymax, doitbest, dsco, ebay, essentialhub, etsy, fabfitfun, fleetfarm, generic, goflow, googlec, googleexpress, groupongoods, hdpro, hdsupply, hdsupplyso, homedepot, homedepot2b, homedepotca, homedepotso, homehardware, houzz, hsn, jcpenney, kohls, lampsplus, lowes, lowes2b, lowesca, lowesm, macys, magento, magento2, menards, michaels, mirakl, newegg, neweggApi, neweggb2b, nfm, northerntool, opencart, opensky, orgill, oscommerce, paypal, pcrs, petco, petsmart, pinnacle, prestashop, qbi, qbo, qbr, quill, qvc, rakuten, reverb, ruegilt, samsclub, sears, shein, shipstation, shopify, sparkpay, squarespace, staplesadvca, staplesca, staplesca2b, supplieroasis, target, target2b, temu, tiktok, tongtool, tophatter, tractorsupply, tractorsupply2b, volusion, walmart, walmartdsv, walmartpo, wayfair, wish, woocommerce, wsonoma, xcart, xcart5, yahoo, zencart, zoro
StoreKey	string	Identify different stores for each store type:<br /> <strong>Amazon and FBA stores</strong><br /> Required for this store types. Identify country code of Amazon or FBA store. Accept 2 characted country code, uppercase. E.g. US, CA, etc. <br /> <strong>CommerceHub</strong> Required for this store type. Identify marketplace used to get orders via CommerceHub. Accept 2 to 5 characters code of marketplace<br /> Enum {sears, rus, hd, gg, wm, dsg, hdso, hdca, lws, khl, qvc, iqvc, jcp, cst, bbb, evn, macy, hdsi, lwsca, bls}<br /> Lowercase.<br /> <strong>Rest store types</strong> Identify different stores within specific store type. Accept 3 character code set up on Teapplix Marketplace & Carts config.<br /> Not required even if multiple-store config used. If not passed - interpreted as empty value key.	Pattern: (^$)|[a-zA-Z0-9]{2,5}
VSAccountID	string
SellerID	string	Merchant ID of store. Only applies to eBay Amazon FBA. For eBay this is the seller name, for Amazon or FBA, this is the Merchant Id
OrderSource	string	Some channel, like shopify and channeladvisor download foreign orders. This optional string gives indication where order downloaded from.
EbayBuyerID	string
PaymentStatus	string	Payment Status of the order. Normally this should be 'Completed'	One of: Completed, Cancelled, Refunded, PartialRefund
PaymentType	string	Payment type of the order (from pin.payment_type)
LastUpdateDate	string
To	To	Recipient address	Required
BillTo	ReturnAddress	Return address printed on labels
SkipAddressValidation	boolean	Normally the 'To' address is validated on 'POST' Order input. If SkipAddressValidation is set to true, this validation is skipped. Default false.
OrderTotals	OrderTotals	Order totals	Required
OrderDetails	OrderDetails	Order details including queue, warehouse, tags, memo, and custom fields	Required
OrderItems	Order Item[]	Information related to the order’s items	Required
ShippingDetails	OrderShipment[]	Information related to the order’s packages. This tag is optional, but if specified array must have at least one OrderShipment to define the main package for the order. If you add more OrderShipment, those will represent extra packages for the order.
DropshipDetails	DrophipDetails
Options	Order Shipping Options	Shipment options
CustomsOptions	Customs options	Customs options
HandlingBy	string	Date before which the order is expected to be shipped out	Pattern: ^(\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
DeliverBy	string	Date by which the order is expected to arrive at the buyer	Pattern: ^(\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
SeqNumber	string
RMACode	string

To

Recipient address

Property	Type	Description	Constraints
Name	string	Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 128
FirstName	string	First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
LastName	string	Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
Company	string	Company or organization name. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 127
Street	string	Street address, line 1 (building number and street name).	Max-Length: 255
Street2	string	Street address, line 2 (apartment, suite, unit, floor, etc.).	Max-Length: 255
City	string	City or town name.	Max-Length: 40Min-Length: 1
State	string	US state abbreviation (e.g. CA) or province/region name for international addresses.	Max-Length: 40
ZipCode	string	US ZIP code or international postal code.
CountryCode	string	ISO 3166-1 alpha-2 country code (e.g. US, CA, GB).	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}
Country	string	Full country name (e.g. United States, Canada). Defaults to United States
PhoneNumber	string	Phone number. Format may be normalized by the carrier.	Max-Length: 40
Email	string	Email address.

ReturnAddress

Return address printed on labels

Property	Type	Description	Constraints
Name	string	Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 128
FirstName	string	First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
LastName	string	Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
Company	string	Company or organization name. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 127
Street	string	Street address, line 1 (building number and street name).	Max-Length: 255
Street2	string	Street address, line 2 (apartment, suite, unit, floor, etc.).	Max-Length: 255
City	string	City or town name.	Max-Length: 40Min-Length: 1
State	string	US state abbreviation (e.g. CA) or province/region name for international addresses.	Max-Length: 40
ZipCode	string	US ZIP code or international postal code.
CountryCode	string	ISO 3166-1 alpha-2 country code (e.g. US, CA, GB).	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}
Country	string	Full country name (e.g. United States, Canada). Defaults to United States
PhoneNumber	string	Phone number. Format may be normalized by the carrier.	Max-Length: 40
Email	string	Email address.

OrderTotals

Order totals

Property	Type	Description	Constraints
Shipping	number	Shipping cost
Handling	number	Handling
Discount	number	Discount amount
Tax	number	Tax amount
InsuranceType	string	Insurance Type. This tag is deprecated. Please use Options/IsuranceType tag instead.	One of: none, teapplix, carrier
Currency	string	Order currency	Pattern: [A-Z]{3}
PostageCurrency	string	Postage currency	Pattern: [A-Z]{3}
Fee	number	Fee amount
Total	number	Total amount

OrderDetails

Order details including queue, warehouse, tags, memo, and custom fields

Property	Type	Description	Constraints
Invoice	string	If the order matches an invoice, the unique id of the invoice.	Max-Length: 127
PaymentDate	string	Date of payment. Format Y-m-D H:i:s or Y-m-d. If not set - current date time will be used	Pattern: ^\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])( (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
Memo	string	This is memo from the buyer left when placing the order	Max-Length: 2048
PrivateMemo	string	This is memo that seller placed on the order to help with processing. This is not from the buyer	Max-Length: 2048
GiftMessage	string	Gift message	Max-Length: 2048
WarehouseId	integer	The id of the teapplix warehouse this order is assigned to
WarehouseName	string	The name of the teapplix warehouse this order is assigned to
QueueId	integer	The id of the teapplix order queue this order is assigned to.
TagList	string[]	Teapplix order can be assigned several tags, which can be used to filter the order. This is the current list of tags order is assigned to.
ShipClass	string	Ship class typically indicate the level of shipping speed the order should have
Custom	string	Custom	Max-Length: 255
Custom2	string	Custom2	Max-Length: 255
Custom3	string	Custom3	Max-Length: 255
Custom4	string	Custom4	Max-Length: 255

DrophipDetails

Property	Type	Description	Constraints
ProductPrice	number	Product Price
Markup	number	Markup
Handling	number	Handling
Packing	number	Packing

Order Shipping Options

Shipment options

Property	Type	Description	Constraints
InsuranceType	string	Insurance Type	One of: none, teapplix, carrier
InsuranceClosed	boolean	Insurance Closed flag. Ignored on input.
InsuranceClosedReason	string	Insurance Closed Reason message. Ignored on input.
Billed	DutyBilled	Duties and Taxes data
DutyBilled	DutyBilled	Duties and Taxes data
SplitDutyVAT	boolean	Split Duty VAT
Delivery	Delivery	Delivery
Service	Service
Cod	Cod	C.O.D. details
Ups	Ups	UPS specific options
Fedex	Fedex	FedEx specific options
DHL	DHL	DHLeC specific options
DHLE	DHLE	DHL Express specific options
ReasonForExport	string	DEPRECATED! Reason for export	Max-Length: 20

Customs options

Customs options

Property	Type	Description	Constraints
ReasonForExport	string		Max-Length: 20
IOSSNumber	string	The IOSS number of the seller. Sellers selling in the EU will be assigned a unique IOSS number that must be listed on all packages sent to the EU.
BrokerAddress	string	Broker Address

Order Item

Order item

Property	Type	Description	Constraints
Name	string	Item's name	Max-Length: 255
LineNumber	integer	Line Number
ItemId	string	Seller item Id. This typically maps to the listing id on catalogs	Max-Length: 127
ItemSKU	string	Mapped product name in Teapplix	Max-Length: 255
ItemLocation	string	Item Location. This is stored on the order line if you set it on inbound POST|PUT
Description	string	Item description	Max-Length: 255
Quantity	integer	The quantity of this item ordered
UnitOfMeasure	string	Unit of measure for this item (e.g. EA, CS). Accepted and provided only for store types that support unit of measure	Max-Length: 40
Amount	number	Subtotal for this order line
Shipping	number	Shipping cost
Tax	number	Handling amount
ItemCustom	string	Item Custom field. Accepted and provided only for store types that support this custom field	Max-Length: 255
ItemCustom2	string	Item Custom2 field. Accepted and provided only for store types that support this custom field	Max-Length: 255
ItemCustom3	string	Item Custom3 field. Accepted and provided only for store types that support this custom field	Max-Length: 255
ItemCustom4	string	Item Custom4 field. Accepted and provided only for store types that support this custom field	Max-Length: 255
Shipping Tax	number	Shipping tax amount

OrderShipment

Property	Type	Description	Constraints
Package	Shipment Package	Declares packages to be shipped
ShipDate	string	Date the order is shipped. Do not specify this for open orders. Note that if an order is shipped, all packages must have the same ship date.	Pattern: ^(\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
PostageAccount	string	Postage Account. Ignored on input.

DutyBilled

Duties and Taxes data

Property	Type	Description	Constraints
Role	string	Role	RequiredOne of: sender, recipient, third_party
AccountNumber	string	Account number
AccountPostalCode	string	Account Postal Code. Currently UPS only	Max-Length: 10
AccountCountryCode	string	Account Country Code. Currently UPS only	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}

Delivery

Delivery

Property	Type	Description	Constraints
Signature	string	Signature type	One of: NOT_REQUIRED, ANY_REQUIRED, ADULT_REQUIRED, DIRECT_REQUIRED, INDIRECT_REQUIRED, SERVICE_DEFAULT
Saturday	integer	Saturday delivery
Sunday	boolean	Sunday delivery
Holiday	boolean	Holiday delivery
Weekend	boolean	Weekend delivery
Am	boolean	AM delivery
Restricted	boolean	Restricted area delivery
Inside	boolean	Inside delivery
Residential	integer	Residential delivery
HomeDeliveryDate	string	Home delivery date	Format: date
Instructions	string	Delivery Instructions, including HomeDelivery Instructions
LiftGate	boolean	Lift gate
LimitedAccess	boolean
ConstructionSite	boolean	Construction site
CallBefore	boolean	Call before

Service

Property	Type	Description	Constraints
RegisteredMail	boolean	Registered mail
AdditionalHandling	boolean	Additional handling
ShipperRelease	boolean	Shipper Release
CarbonNeutral	boolean	Carbon neutral
DangerousGoods	boolean	Dangerous goods flag
HandlingCharge	boolean	Handling charge
ExtremeLength	boolean	Extreme length
ReturnsClearance	boolean	Returns clearance
Pickup	boolean	Pickup

Cod

C.O.D. details

Property	Type	Description	Constraints
Amount	Amount	Declares any amount value
Kind	string	Kind
CollectionType	string	Collection Type	One of: 1, 2, 3, 4, 5
Address	ReturnAddress	Return address printed on labels
ReferenceIndicator	string	Reference indicator
TransportationChargesDetail	string	Transportation Charges Detail	One of: ADD_ACCOUNT_COD_SURCHARGE, ADD_ACCOUNT_NET_CHARGE, ADD_ACCOUNT_NET_FREIGHT, ADD_ACCOUNT_TOTAL_CUSTOMER_CHARGE, ADD_LIST_COD_SURCHARGE, ADD_LIST_NET_CHARGE, ADD_LIST_NET_FREIGHT, ADD_LIST_TOTAL_CUSTOMER_CHARGE
RecipientAccountNumber	string	Recipient Account Number	Pattern: \d+
BillingOption	string	Billing Option	One of: Prepaid, Freight Collect

Ups

UPS specific options

Property	Type	Description	Constraints
SurepostNonMachineable	boolean	UPS Surepost Non Machineable
Qvn	Qvn
Freight	UPS Freight

Fedex

FedEx specific options

Property	Type	Description	Constraints
CustomsOption	string	Customs option
Coverage	string
ExportDetail	ExportDetail	Export detail
Recipient	Recipient	Recipient
HoldAtLocation	HoldAtLocation	Hold At Location
SmartPostEndiciaType	string
TotalPalletWeight	number
FreightGuaranteeDetailDate	string
Delivery	Delivery	Delivery
Instructions	Instructions	Instructions
Freight	FedEx Freight	Freight
BillAccount	string
CollectTermsType	string
BrokerType	string
SignatureReleaseNumber	string
HandlingUnits	string
ExpressFreightBookingConfirmationNumber	string
B13aFilling	string
ExportStatement	string
ImportOfRecordAccountNumber	string

DHL

DHLeC specific options

Property	Type	Description	Constraints
TermsOfTrade	string	Terms of Trade	One of: DDP, DAP
ConsigneeTaxIdType	string	Consignee Tax Id Type	One of: OTHER, GSTVAT, EORI, IOSS, TBD, PAN
ConsigneeTaxId	string	Consignee Tax Id
ConsigneeIdType	string	Consignee Id Type
ConsigneeId	string	Consignee Id

DHLE

DHL Express specific options

Property	Type	Description	Constraints
DeliveryType	string	Delivery Type: NONE DD (Door to Door) DA (Door to Airport) AA (Airport to Airport) DC (Door to Door non- Compliant)	One of: NONE, DD, DA, AA, DC

Shipment Package

Declares packages to be shipped

Property	Type	Description	Constraints
Method	string	Shipping method used to print label. One of <br /><strong>USPS:</strong><br />'USPS_GROUND_ADVANTAGE', 'USPS_GROUND_ADVANTAGE_SOFTPACK', 'USPS_GROUND_ADVANTAGE_CUBIC', 'USPS_FIRST_ENVELOPE', 'USPS_FIRST_ENVELOPE_NON_MACHINABLE', 'USPS_FIRST_FLAT', 'USPS_FIRST_FLAT_NON_MACHINABLE', 'USPS_PARCELSELECT_LIGHTWEIGHT_PACKAGE', 'USPS_PARCELSELECT_PACKAGE', 'USPS_PRIORITY_PACKAGE', 'USPS_PRIORITY_CUBIC', 'USPS_PRIORITY_ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_PADDED', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_LEGAL', 'USPS_PRIORITY_FLAT_RATE_BOX_SMALL', 'USPS_PRIORITY_FLAT_RATE_BOX', 'USPS_PRIORITY_FLAT_RATE_BOX_LARGE', 'USPS_PRIORITY_REGIONALRATEBOXA', 'USPS_PRIORITY_REGIONALRATEBOXB', 'USPS_PRIORITY_REGIONALRATEBOXC', 'USPS_PRIORITY_FLATRATEBOXAPOFPO', 'USPS_PRIORITY_SOFTPACK', 'USPS_PRIORITY_EXPRESS_PACKAGE', 'USPS_PRIORITY_EXPRESS_PACKAGE_NON_MACHINABLE', 'USPS_PRIORITY_EXPRESS_ENVELOPE', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_LEGAL', 'USPS_EXPRESS_FLATRATEMEDIUMBOX', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_PADDED', 'USPS_MEDIAMAIL_RECTPARCEL', 'USPS_CRITICAL_ENVELOPE', 'USPS_CRITICAL_FLAT', 'CONSDOM/Standard', 'CONSDOM/Expedited'<br /><strong>USPS Intl:</strong><br />'USPS_FIRST_PACKAGE_INTERNATIONAL', 'USPS_FIRST_ENVELOPE_INTERNATIONAL', 'USPS_FIRST_ENVELOPE_NON_MACHINABLE_INTERNATIONAL', 'USPS_FIRST_FLAT_INTERNATIONAL', 'USPS_PRIORITY_PACKAGE_INTERNATIONAL', 'INTLPRIORITY/ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_PADDED_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_LEGAL_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_SMALL_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_LARGE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_PACKAGE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_LEGAL_INTERNATIONAL', 'INTLEXPRESS/FLATRATEMEDIUMBOX', 'USPS_PRIORITY_AIRMAIL_INTERNATIONAL', 'USPS_ISAL_RECTPARCEL', 'CONSINTL/RECTPARCEL', 'CONSINTL1/RECTPARCEL', 'CONSINTL2/RECTPARCEL', 'CONSINTL3/RECTPARCEL', 'CONSINTL4/RECTPARCEL', 'CONSINTL5/RECTPARCEL', 'CONSINTL6/RECTPARCEL', 'CONSINTL7/RECTPARCEL', 'CONSINTL8/RECTPARCEL', 'CONSINTL9/RECTPARCEL', 'CONSINTL10/RECTPARCEL', 'CONSINTL11/RECTPARCEL', 'CONSINTL12/RECTPARCEL', 'CONSINTL13/RECTPARCEL', 'CONSINTL14/RECTPARCEL', 'CONSINTL15/RECTPARCEL', 'CONSINTL16/RECTPARCEL', 'USPS_COMMERCIAL_EPACKET_INTERNATIONAL'<br /><strong>FedEx:</strong><br />'FEDEX_GROUND', 'FEDEX_HOME', 'FEDEX_FIRST_OVERNIGHT', 'FEDEX_PRIORITY_OVERNIGHT', 'FEDEX_STANDARD_OVERNIGHT', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_2DAY', 'FEDEX_2DAY_AM', 'FEDEX_EXPRESS_SAVER', 'FEDEX_SMART_POST', 'FEDEX_FIRST_OVERNIGHT_INTERNATIONAL', 'FEDEX_PRIORITY_OVERNIGHT_INTERNATIONAL', 'FEDEX_ECONOMY_INTERNATIONAL', 'FEDEX_GROUND_INTERNATIONAL', 'FEDEX_FREIGHT_1DAY', 'FEDEX_FREIGHT_2DAY', 'FEDEX_FREIGHT_3DAY', 'FEDEX_FREIGHT_FIRST', 'FEDEX_FREIGHT_ECONOMY', 'FEDEX_FREIGHT_PRIORITY', 'FEDEX_FREIGHT_PRIORITY_INTERNATIONAL', 'FEDEX_FREIGHT_ECONOMY_INTERNATIONAL', 'FEDEX_CONNECT_PLUS_INTERNATIONAL', 'FEDEX_PRIORITY_EXPRESS_INTERNATIONAL', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_PAK', 'FEDEX_2DAY_ONE_RATE_TUBE', 'FEDEX_2DAY_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_PAK', 'FEDEX_2DAY_AM_ONE_RATE_TUBE', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_AM_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_PAK', 'FEDEX_EXPRESS_SAVER_ONE_RATE_TUBE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_MEDIUM_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ENVELOPE', 'FEDEX_2DAY_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ENVELOPE', 'FEDEX_2DAYAM_ENVELOPE', 'FEDEX_INTLGROUNDCONSOLIDATION', 'FEDEX_STANDARDOVERNIGHT_ENVELOPE'<br /><strong>UPS:</strong><br />'UPS_GROUND', 'UPS_NEXT_DAY_AIR', 'UPS_NEXT_DAY_AIR_EARLY_AM', 'UPS_NEXT_DAY_AIR_SAVER', 'UPS_2DAY_AIR_AM', 'UPS_2DAY_AIR', 'UPS_3DAY_SELECT', 'UPS_STANDARD', 'UPS_EXPRESS_EARLY_AM', 'UPS_EXPRESS', 'UPS_EXPRESS_SAVER', 'UPS_EXPEDITED', 'UPS_WORLDWIDE_EXPRESS_PLUS', 'UPS_WORLDWIDE_EXPRESS', 'UPS_WORLDWIDE_SAVER', 'UPS_WORLDWIDE_EXPEDITED', 'UPS_STANDARD_TO_CANADA', 'UPS_GROUND_SAVER', 'UPS_SUREPOST_LESS1LB', 'UPS_SUREPOST_LESS1LB_IRREGULAR', 'UPS_SUREPOST_MORE1LB_IRREGULAR', 'UPS_SUREPOST_MEDIA_IRREGULAR', 'UPS_SUREPOST_BPM_IRREGULAR', 'UPS_SUREPOST_1LB_OR_GREATER_MACHINABLE', 'UPS_MAILINNOVATIONS_LESS1LB', 'UPS_MAILINNOVATIONS_PARCELPOST', 'UPS_MAILINNOVATIONS_MACHINABLE', 'UPS_MAILINNOVATIONS_STANDARD_FLAT', 'UPS_MAILINNOVATIONS_BPM_PARCEL', 'UPS_MAILINNOVATIONS_BPM_FLAT', 'UPS_MAILINNOVATIONS_MEDIA', 'UPS_MAILINNOVATIONS_FIRST', 'UPS_MAILINNOVATIONS_PRIORITY', 'UPS_MAILINNOVATIONS_PRIORITY_INTERNATIONAL', 'UPS_MAILINNOVATIONS_ECONOMY_INTERNATIONAL', 'UPS_FREIGHT', 'UPS_FREIGHT_GUARANTEED', 'UPS_FREIGHT_GUARANTEED_AM', 'UPS_FREIGHT_STANDARD', 'UPS_GROUND_SIMPLE_RATE_XS', 'UPS_GROUND_SIMPLE_RATE_S', 'UPS_GROUND_SIMPLE_RATE_M', 'UPS_GROUND_SIMPLE_RATE_L', 'UPS_GROUND_SIMPLE_RATE_XL', 'UPS_2DAY_AIR_SIMPLE_RATE_XS', 'UPS_2DAY_AIR_SIMPLE_RATE_S', 'UPS_2DAY_AIR_SIMPLE_RATE_M', 'UPS_2DAY_AIR_SIMPLE_RATE_L', 'UPS_2DAY_AIR_SIMPLE_RATE_XL', 'UPS_3DAY_SELECT_SIMPLE_RATE_XS', 'UPS_3DAY_SELECT_SIMPLE_RATE_S', 'UPS_3DAY_SELECT_SIMPLE_RATE_M', 'UPS_3DAY_SELECT_SIMPLE_RATE_L', 'UPS_3DAY_SELECT_SIMPLE_RATE_XL', 'UPS_ST_CA', 'UPS_WORLDWIDE_SAVER_ASIA', 'UPS_WORLDWIDE_EXPEDITED_ASIA', 'UPS_WORLDWIDE_EXPRESS_ASIA', 'UPS_WORLDWIDE_EXPRESS_PLUS_ASIA', 'UPS_WORLDWIDE_SAVER_CANADA', 'UPS_3DAY_SELECT_CANADA', 'UPS_WORLDWIDE_EXPEDITED_CANADA', 'UPS_WORLDWIDE_EXPRESS_PLUS_CANADA', 'UPS_WORLDWIDE_EXPRESS_CANADA'<br /><strong>DHL Express:</strong><br />'DHLE_EXPRESS_9AM', 'DHLE_ECONOMY_SELECT', 'DHLE_EXPRESS_1030AM', 'DHLE_DOMESTIC_EXPRESS', 'DHLE_EXPRESS_WORLDWIDE', 'DHLE_EUROPACK', 'DHLE_EXPRESS_1200AM', 'DHLE_EXPRESS_WORLDWIDE_DOC', 'DHLE_EXPRESS_1200AM_DOC', 'DHLE_EXPRESS_9AM_DOC', 'DHLE_EXPRESS_1030AM_DOC', 'DHLE_ECONOMYSELECT_A', 'DHLE_EXPRESS1030AM_A', 'DHLE_EXPRESS1200AM_A', 'DHLE_EXPRESS9AM_A', 'DHLE_EXPRESSENVELOPE', 'DHLE_EXPRESSENVELOPE_A', 'DHLE_EXPRESSWORLDWIDE_A'<br /><strong>DHL eCommerce:</strong><br />'DHLEC_PARCELS_GROUND', 'DHLEC_PARCELS_GROUND_IRREGULAR', 'DHLEC_PARCELS_PLUS_GROUND', 'DHLEC_PARCELS_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCEL_GROUND_IRREGULAR', 'DHLEC_PARCEL_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED', 'DHLEC_PARCELS_EXPEDITED_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED_MAX', 'DHLEC_PARCELS_PLUS_EXPEDITED', 'DHLEC_PARCELS_PLUS_EXPEDITED_MAX', 'DHLEC_PARCEL_EXPEDITED_MAX', 'DHLEC_PARCEL_PLUS_EXPEDITED_MAX', 'DHLEC_PRIORITY', 'DHLEC_FIRST_PARCEL', 'DHLEC_FIRST_PARCEL_IRREGULAR', 'DHLEC_MARKETING_PARCEL_GROUND', 'DHLEC_MARKETING_PARCEL_GROUND_IRREGULAR', 'DHLEC_MARKETING_PARCEL_EXPEDITED', 'DHLEC_MARKETING_PARCEL_EXPEDITED_IRREGULAR', 'DHLEC_BPM_GROUND', 'DHLEC_BPM_EXPEDITED', 'DHLEC_CATALOG_BPM_GROUND', 'DHLEC_CATALOG_BPM_EXPEDITED', 'DHLEC_PACKET_STANDARD', 'DHLEC_PACKET_PRIORITY', 'DHLEC_PACKET_PLUS', 'DHLEC_PACKET_IPA', 'DHLEC_PACKET_ISAL', 'DHLEC_PARCEL_STANDARD', 'DHLEC_PARCEL_PRIORITY', 'DHLEC_PARCEL_DIRECT', 'DHLEC_PARCEL_DIRECT_EXPRESS', 'DHLEC_BUSINESS_STANDARD', 'DHLEC_BUSINESS_PRIORITY', 'DHLEC_BUSINESS_IPA', 'DHLEC_BUSINESS_ISAL', 'DHLEC_EXPEDITED_FLAT', 'DHLEC_GROUND_FLAT', 'DHLEC_PARCEL_RETURN_PLUS', 'DHLEC_PARCEL_RETURN_GROUND', 'DHLEC_PARCEL_RETURN_LIGHT', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_FORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_FORMAL', 'DHLEC_PARCEL_DIRECT_INTL', 'DHLEC_PARCEL_DIRECT_STANDARD_CA', 'DHLEC_PARCEL_DIRECT_PRIORITY_CA', 'DHLEC_PARCEL_DIRECT_MAX_CA', 'DHLEC_PARCELDIRECTEXPEDITED_RECTPARCEL'<br /><strong>OnTrac:</strong><br />'ONTRAC_GROUND', 'ONTRAC_SUNRISE', 'ONTRAC_SUNRISE_GOLD'<br /><strong>Estes:</strong><br />'ESTES_GUARANTEED_STANDARD', 'ESTES_GUARANTEED_ECONOMY', 'ESTES_GUARANTEED_BASIC', 'ESTES_GUARANTEED_EXCLUSIVE', 'ESTES_GUARANTEED_5PM', 'ESTES_GUARANTEED_12PM', 'ESTES_GUARANTEED_10AM', 'ESTES_STANDARD'<br /><strong>Purolator:</strong><br />'PUROLATOR_GROUND', 'PUROLATOR_GROUND_9AM', 'PUROLATOR_GROUND_10:30AM', 'PUROLATOR_GROUND_EVENING', 'PUROLATOR_EXPRESS', 'PUROLATOR_EXPRESS_9AM', 'PUROLATOR_EXPRESS_10:30AM', 'PUROLATOR_EXPRESS_12PM', 'PUROLATOR_EXPRESS_EVENING', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE_9AM', 'PUROLATOR_EXPRESS_ENVELOPE_10:30AM', 'PUROLATOR_EXPRESS_ENVELOPE_12PM', 'PUROLATOR_EXPRESS_ENVELOPE_EVENING', 'PUROLATOR_EXPRESS_PACK', 'PUROLATOR_EXPRESS_PACK_9AM', 'PUROLATOR_EXPRESS_PACK_10:30AM', 'PUROLATOR_EXPRESS_PACK_12PM', 'PUROLATOR_EXPRESS_PACK_EVENING', 'PUROLATOR_EXPRESS_BOX', 'PUROLATOR_EXPRESS_BOX_9AM', 'PUROLATOR_EXPRESS_BOX_10:30AM', 'PUROLATOR_EXPRESS_BOX_12PM', 'PUROLATOR_EXPRESS_BOX_EVENING'<br /><strong>Amazon:</strong><br />'AMAZON_SHIPPING_GROUND'<br /><strong>GoFo Express:</strong><br />'GOFO_STANDARD', 'GOFO_GROUND'<br /><strong>UniUni:</strong><br />'UNIUNI_STANDARD', 'UNIUNI_EXPRESS'<br /><strong>Yanwen:</strong><br />'YW_STANDARD'<br /><strong>Canada Post:</strong><br />'CAPOST_CADOM_EP', 'CAPOST_CADOM_PC', 'CAPOST_CADOM_RP', 'CAPOST_CADOM_XP', 'CAPOST_CAINT_IP_AIR', 'CAPOST_CAINT_IP_SURF', 'CAPOST_CAINT_PW_ENV', 'CAPOST_CAINT_PW_PAK', 'CAPOST_CAINT_PW_PARCEL', 'CAPOST_CAINT_SP_AIR', 'CAPOST_CAINT_SP_SURF', 'CAPOST_CAINT_TP', 'CAPOST_CAINT_XP', 'CAPOST_CAUSA_EP', 'CAPOST_CAUSA_PW_ENV', 'CAPOST_CAUSA_PW_PAK', 'CAPOST_CAUSA_PW_PARCEL', 'CAPOST_CAUSA_SP_AIR', 'CAPOST_CAUSA_TP', 'CAPOST_CAUSA_XP'
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
Type	PackageType | CustomPackageName	Allows you to specify a built-in package type (integer) defined by the carrier, or a custom package you defined by name in your Teapplix account. You should specify one of 'Type' or 'Dimensions' in your input.
PackageItems	PackageItem[]	Items and their quantities inside the package. This information is required for certain marketplaces.
Reference	string	This value will be printed on label. BBCODE placeholders can be used.
InsuranceValue	number	Insurance Value.
InsuranceFee	number	Insurance Fee. This value is ignored for input.
Postage	number	Postage amount for shipped package. Do not fill this for normal open orders.
TrackingInfo	Tracking Info	Tracking info

Amount

Declares any amount value

Property	Type	Description	Constraints
Amount	number
Currency	string		Pattern: [A-Z]{3}

Qvn

Property	Type	Description	Constraints
Qvn	integer	Qvn
From	string	From
EmailOnFail	string	Email on fail
Subject	string	Subject
Memo	string	Memo
Recipients	Freight Notification Recipient[]	Qvn Recipients

UPS Freight

Property	Type	Description	Constraints
Class	number	Freight Class
PackageType	string	Freight Package Type
PackagesQuantity	integer	Packages Quantity
PayerName	string	Payer Name	Max-Length: 40
PayerAddress	string	Payer Address	Max-Length: 255
PayerCity	string	Payer City	Max-Length: 50
PayerState	string	Payer State	Max-Length: 50
SortingAndSegregating	boolean	Sorting And Segregating
SortingQuantity	string	Sorting Quantity
ExtremeLength	boolean	Extreme Length
FreezableProtection	boolean	Freezable Protection
Handling	Handling	Handling
DangerousGoods	DangerousGoods	UPS Dangerous Goods Data
Pickup	Pickup

ExportDetail

Export detail

Property	Type	Description	Constraints
Kind	string
ForeignZoneCode	string
EntryNumber	string
LicenseNumber	string
ExpirationDate	string		Format: date

Recipient

Recipient

Property	Type	Description	Constraints
TaxId	CustomsId
CustomsId	CustomsId

HoldAtLocation

Hold At Location

Property	Type	Description	Constraints
Applied	string
Address	string
AddressType	string

Instructions

Instructions

Property	Type	Description	Constraints
Handling	string
Delivery	string
HomeDelivery	string
Pickup	string

FedEx Freight

Freight

Property	Type	Description	Constraints
Class	string	Freight Class	One of: CLASS_050, CLASS_055, CLASS_060, CLASS_065, CLASS_070, CLASS_077_5, CLASS_085, CLASS_092_5, CLASS_100, CLASS_110, CLASS_125, CLASS_150, CLASS_175, CLASS_200, CLASS_250, CLASS_300, CLASS_400, CLASS_500
PackageType	string	Freight Package Type	One of: BAG, BARREL, BASKET, BOX, BUCKET, BUNDLE, CARTON, CASE, CONTAINER, CRATE, CYLINDER, DRUM, ENVELOPE, HAMPER, OTHER, PAIL, PALLET, PIECE, REEL, ROLL, SKID, TANK, TUBE
PrintedReferenceType	string	Printed Reference Type	One of: BILL_OF_LADING, CONSIGNEE_ID_NUMBER, SHIPPER_ID_NUMBER
PrintedReferenceValue	string	Printed Reference Value	Max-Length: 255
GuaranteeDetailType	string	Freight Guarantee Detail Type	One of: GUARANTEED_DATE, GUARANTEED_MORNING
GuaranteeDetailDate	string	Freight Guarantee Detail Date	Format: date
Note	string	Note	Max-Length: 255
FreightDirectType	string	Freight Direct Type	Max-Length: 255
FreightDirectTransportationType	string	Freight Direct Transportation Type	Max-Length: 255
FreightDirectEmail	string	Freight Direct Email	Max-Length: 255
FreightDirectPhoneType1	string	Freight Direct Phone Type 1	Max-Length: 255
FreightDirectPhoneNumber1	string	Freight Direct Phone Number 1	Max-Length: 255
FreightDirectPhoneType2	string	Freight Direct Phone Type 2	Max-Length: 255
FreightDirectPhoneNumber2	string	Freight Direct Phone Number 2	Max-Length: 255
FreightDirectPhoneType3	string	Freight Direct Phone Type 3	Max-Length: 255
FreightDirectPhoneNumber3	string	Freight Direct Phone Number 3	Max-Length: 255

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

Dimensions of package

If not set Teapplix will apply 6x6x4 by default

Property	Type	Description	Constraints
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

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

Handling

Handling

Property	Type	Description	Constraints
Charge	string	Handling Charge
ChargeType	string	Handling Charge Type
ChargeValue	string	Handling Charge Value
Instructions	string	Instructions

DangerousGoods

UPS Dangerous Goods Data

Property	Type	Description	Constraints
Type	integer
Name	string	Dangerous Goods Name	Max-Length: 40
PhoneNumber	string	Dangerous Goods Phone Number	Max-Length: 40
PhoneExtension	string	Dangerous Goods Phone Extension	Max-Length: 10

Pickup

Property	Type	Description	Constraints
Weekend	boolean	Weekend
Holiday	boolean	Holiday
Inside	boolean	Inside
Residential	boolean	Residential
LimitedAccess	boolean	Limited access
LiftGate	boolean	Lift Gate Pickup Required
Instructions	string	Instructions

CustomsId

Property	Type	Description	Constraints
Type	string
Number	string

PackageItem

Declares package item to be shipped

Property	Type	Description	Constraints
LineNumber	integer	One of Line Number or Item Name is required.
Name	string	Specify Name of Item only if it is unique in Order Items list, otherwise specify Line Number. One of Line Number or Name is required.
Quantity	integer	Quantity.	RequiredMinimum: 1

Freight Notification Recipient

Property	Type	Description	Constraints
CompanyOrName	string	Company or Name
ContactName	string	Contact Name
Email	string	Email
ShipNotify	boolean	Ship Notify
ExceptionNotify	boolean	Exception Notify
DeliveryNotify	boolean	Delivery Notify
BolNotify	boolean	Bol Notify
BolEmailSubject	string	Bol Email Subject
BolEmailText	string	Bol Email Text

POST Response - 200

Order Split Result

Property	Type	Description	Constraints
OrdersResult	OrderResult[]		Required

OrderResult

Property	Type	Description	Constraints
TxnId	string	Unique id for each entry	RequiredMax-Length: 40
Success	boolean	DEPRECATED: use Code (0 = success, non-zero = error) and Status (Accepted/Declined/Exists/Processed) instead. This field will be removed in the next API major version.	Required
Status	string	Per-order submission status. This is the canonical per-item discriminator going forward (use it instead of Success): * 'Accepted' – order was accepted successfully * 'Declined' – order was declined * 'Exists' – order with specified TxnId already exists * 'Processed' - order was processed successfully	RequiredOne of: Accepted, Declined, Exists, Processed
Code	integer	DEPRECATED: under HTTP 200, the canonical per-order discriminator is Status (Accepted/Declined/Exists/Processed). For specific failure detail, read Message and Description. Code will be removed in the next API major version. The error envelope (HTTP 4xx/5xx Message) keeps Code as canonical — only this per-item Code is being phased out.
Message	string	Detailed message. Typically associated with errors	Max-Length: 255
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

Request Response - 200 Response - 400 Response - 401 Response - 500

PUT Request

Order Update Notifications

'APIToken' header should be included in each request

Property	Type	Description	Constraints
Orders	Order To Update[]	Array of orders to update

Order To Update

Property	Type	Description	Constraints
TxnId	string	TxnId for order being updated	RequiredMax-Length: 40Pattern: [\s\S]
PaymentStatus	string	If specified, we will modify order PaymentStatus. If you set PaymentStatus to Cancelled, you must also add a Memo.	One of: Completed, Cancelled, Refunded, PartialRefund
To	ReturnAddress	Return address printed on labels
OrderItems	Order Item[]	Order items, if specified the orders items will be replaced with what is specified here.
OrderDetails	OrderDetails	Order details including queue, warehouse, tags, memo, and custom fields
ShippingDetails	OrderShipment[]	Shipping packages for the order. If specified, the array must contain at least one OrderShipment defining the main package; additional entries represent extra packages.
Options	Order Shipping Options	Shipment options
AppendMode	boolean	If true, appends OrderDetails.Memo and OrderDetails.PrivateMemo to the existing memo values; if false (default), replaces them.
QueueId	integer	DEPRECATED: Use OrderDetails.QueueId instead.
TagList	string[]	DEPRECATED: Use OrderDetails.TagList instead.
WarehouseId	integer	DEPRECATED: Use OrderDetails.WarehouseId instead.
Memo	Memo
Custom	string	DEPRECATED: Use OrderDetails.Custom instead.	Max-Length: 255
Custom2	string	DEPRECATED: Use OrderDetails.Custom2 instead.	Max-Length: 255

ReturnAddress

Return address printed on labels

Property	Type	Description	Constraints
Name	string	Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 128
FirstName	string	First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
LastName	string	Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name.	Max-Length: 128
Company	string	Company or organization name. At least one of Name, FirstName + LastName, or Company is required.	Max-Length: 127
Street	string	Street address, line 1 (building number and street name).	Max-Length: 255
Street2	string	Street address, line 2 (apartment, suite, unit, floor, etc.).	Max-Length: 255
City	string	City or town name.	Max-Length: 40Min-Length: 1
State	string	US state abbreviation (e.g. CA) or province/region name for international addresses.	Max-Length: 40
ZipCode	string	US ZIP code or international postal code.
CountryCode	string	ISO 3166-1 alpha-2 country code (e.g. US, CA, GB).	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}
Country	string	Full country name (e.g. United States, Canada). Defaults to United States
PhoneNumber	string	Phone number. Format may be normalized by the carrier.	Max-Length: 40
Email	string	Email address.

OrderDetails

Order details including queue, warehouse, tags, memo, and custom fields

Property	Type	Description	Constraints
Invoice	string	If the order matches an invoice, the unique id of the invoice.	Max-Length: 127
PaymentDate	string	Date of payment. Format Y-m-D H:i:s or Y-m-d. If not set - current date time will be used	Pattern: ^\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])( (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
Memo	string	This is memo from the buyer left when placing the order	Max-Length: 2048
PrivateMemo	string	This is memo that seller placed on the order to help with processing. This is not from the buyer	Max-Length: 2048
GiftMessage	string	Gift message	Max-Length: 2048
WarehouseId	integer	The id of the teapplix warehouse this order is assigned to
WarehouseName	string	The name of the teapplix warehouse this order is assigned to
QueueId	integer	The id of the teapplix order queue this order is assigned to.
TagList	string[]	Teapplix order can be assigned several tags, which can be used to filter the order. This is the current list of tags order is assigned to.
ShipClass	string	Ship class typically indicate the level of shipping speed the order should have
Custom	string	Custom	Max-Length: 255
Custom2	string	Custom2	Max-Length: 255
Custom3	string	Custom3	Max-Length: 255
Custom4	string	Custom4	Max-Length: 255

Order Shipping Options

Shipment options

Property	Type	Description	Constraints
InsuranceType	string	Insurance Type	One of: none, teapplix, carrier
InsuranceClosed	boolean	Insurance Closed flag. Ignored on input.
InsuranceClosedReason	string	Insurance Closed Reason message. Ignored on input.
Billed	DutyBilled	Duties and Taxes data
DutyBilled	DutyBilled	Duties and Taxes data
SplitDutyVAT	boolean	Split Duty VAT
Delivery	Delivery	Delivery
Service	Service
Cod	Cod	C.O.D. details
Ups	Ups	UPS specific options
Fedex	Fedex	FedEx specific options
DHL	DHL	DHLeC specific options
DHLE	DHLE	DHL Express specific options
ReasonForExport	string	DEPRECATED! Reason for export	Max-Length: 20

Memo

Property	Type	Description	Constraints
Text	string	Memo text	RequiredMax-Length: 2048
AppendMode	boolean	If true - appends text to current order Memo. Default false.

Order Item

Order item

Property	Type	Description	Constraints
Name	string	Item's name	Max-Length: 255
LineNumber	integer	Line Number
ItemId	string	Seller item Id. This typically maps to the listing id on catalogs	Max-Length: 127
ItemSKU	string	Mapped product name in Teapplix	Max-Length: 255
ItemLocation	string	Item Location. This is stored on the order line if you set it on inbound POST|PUT
Description	string	Item description	Max-Length: 255
Quantity	integer	The quantity of this item ordered
UnitOfMeasure	string	Unit of measure for this item (e.g. EA, CS). Accepted and provided only for store types that support unit of measure	Max-Length: 40
Amount	number	Subtotal for this order line
Shipping	number	Shipping cost
Tax	number	Handling amount
ItemCustom	string	Item Custom field. Accepted and provided only for store types that support this custom field	Max-Length: 255
ItemCustom2	string	Item Custom2 field. Accepted and provided only for store types that support this custom field	Max-Length: 255
ItemCustom3	string	Item Custom3 field. Accepted and provided only for store types that support this custom field	Max-Length: 255
ItemCustom4	string	Item Custom4 field. Accepted and provided only for store types that support this custom field	Max-Length: 255
Shipping Tax	number	Shipping tax amount

OrderShipment

Property	Type	Description	Constraints
Package	Shipment Package	Declares packages to be shipped
ShipDate	string	Date the order is shipped. Do not specify this for open orders. Note that if an order is shipped, all packages must have the same ship date.	Pattern: ^(\d\d\d\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$
PostageAccount	string	Postage Account. Ignored on input.

DutyBilled

Duties and Taxes data

Property	Type	Description	Constraints
Role	string	Role	RequiredOne of: sender, recipient, third_party
AccountNumber	string	Account number
AccountPostalCode	string	Account Postal Code. Currently UPS only	Max-Length: 10
AccountCountryCode	string	Account Country Code. Currently UPS only	Max-Length: 2Min-Length: 2Pattern: [A-Z]{2}

Delivery

Delivery

Property	Type	Description	Constraints
Signature	string	Signature type	One of: NOT_REQUIRED, ANY_REQUIRED, ADULT_REQUIRED, DIRECT_REQUIRED, INDIRECT_REQUIRED, SERVICE_DEFAULT
Saturday	integer	Saturday delivery
Sunday	boolean	Sunday delivery
Holiday	boolean	Holiday delivery
Weekend	boolean	Weekend delivery
Am	boolean	AM delivery
Restricted	boolean	Restricted area delivery
Inside	boolean	Inside delivery
Residential	integer	Residential delivery
HomeDeliveryDate	string	Home delivery date	Format: date
Instructions	string	Delivery Instructions, including HomeDelivery Instructions
LiftGate	boolean	Lift gate
LimitedAccess	boolean
ConstructionSite	boolean	Construction site
CallBefore	boolean	Call before

Service

Property	Type	Description	Constraints
RegisteredMail	boolean	Registered mail
AdditionalHandling	boolean	Additional handling
ShipperRelease	boolean	Shipper Release
CarbonNeutral	boolean	Carbon neutral
DangerousGoods	boolean	Dangerous goods flag
HandlingCharge	boolean	Handling charge
ExtremeLength	boolean	Extreme length
ReturnsClearance	boolean	Returns clearance
Pickup	boolean	Pickup

Cod

C.O.D. details

Property	Type	Description	Constraints
Amount	Amount	Declares any amount value
Kind	string	Kind
CollectionType	string	Collection Type	One of: 1, 2, 3, 4, 5
Address	ReturnAddress	Return address printed on labels
ReferenceIndicator	string	Reference indicator
TransportationChargesDetail	string	Transportation Charges Detail	One of: ADD_ACCOUNT_COD_SURCHARGE, ADD_ACCOUNT_NET_CHARGE, ADD_ACCOUNT_NET_FREIGHT, ADD_ACCOUNT_TOTAL_CUSTOMER_CHARGE, ADD_LIST_COD_SURCHARGE, ADD_LIST_NET_CHARGE, ADD_LIST_NET_FREIGHT, ADD_LIST_TOTAL_CUSTOMER_CHARGE
RecipientAccountNumber	string	Recipient Account Number	Pattern: \d+
BillingOption	string	Billing Option	One of: Prepaid, Freight Collect

Ups

UPS specific options

Property	Type	Description	Constraints
SurepostNonMachineable	boolean	UPS Surepost Non Machineable
Qvn	Qvn
Freight	UPS Freight

Fedex

FedEx specific options

Property	Type	Description	Constraints
CustomsOption	string	Customs option
Coverage	string
ExportDetail	ExportDetail	Export detail
Recipient	Recipient	Recipient
HoldAtLocation	HoldAtLocation	Hold At Location
SmartPostEndiciaType	string
TotalPalletWeight	number
FreightGuaranteeDetailDate	string
Delivery	Delivery	Delivery
Instructions	Instructions	Instructions
Freight	FedEx Freight	Freight
BillAccount	string
CollectTermsType	string
BrokerType	string
SignatureReleaseNumber	string
HandlingUnits	string
ExpressFreightBookingConfirmationNumber	string
B13aFilling	string
ExportStatement	string
ImportOfRecordAccountNumber	string

DHL

DHLeC specific options

Property	Type	Description	Constraints
TermsOfTrade	string	Terms of Trade	One of: DDP, DAP
ConsigneeTaxIdType	string	Consignee Tax Id Type	One of: OTHER, GSTVAT, EORI, IOSS, TBD, PAN
ConsigneeTaxId	string	Consignee Tax Id
ConsigneeIdType	string	Consignee Id Type
ConsigneeId	string	Consignee Id

DHLE

DHL Express specific options

Property	Type	Description	Constraints
DeliveryType	string	Delivery Type: NONE DD (Door to Door) DA (Door to Airport) AA (Airport to Airport) DC (Door to Door non- Compliant)	One of: NONE, DD, DA, AA, DC

Shipment Package

Declares packages to be shipped

Property	Type	Description	Constraints
Method	string	Shipping method used to print label. One of <br /><strong>USPS:</strong><br />'USPS_GROUND_ADVANTAGE', 'USPS_GROUND_ADVANTAGE_SOFTPACK', 'USPS_GROUND_ADVANTAGE_CUBIC', 'USPS_FIRST_ENVELOPE', 'USPS_FIRST_ENVELOPE_NON_MACHINABLE', 'USPS_FIRST_FLAT', 'USPS_FIRST_FLAT_NON_MACHINABLE', 'USPS_PARCELSELECT_LIGHTWEIGHT_PACKAGE', 'USPS_PARCELSELECT_PACKAGE', 'USPS_PRIORITY_PACKAGE', 'USPS_PRIORITY_CUBIC', 'USPS_PRIORITY_ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_PADDED', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_LEGAL', 'USPS_PRIORITY_FLAT_RATE_BOX_SMALL', 'USPS_PRIORITY_FLAT_RATE_BOX', 'USPS_PRIORITY_FLAT_RATE_BOX_LARGE', 'USPS_PRIORITY_REGIONALRATEBOXA', 'USPS_PRIORITY_REGIONALRATEBOXB', 'USPS_PRIORITY_REGIONALRATEBOXC', 'USPS_PRIORITY_FLATRATEBOXAPOFPO', 'USPS_PRIORITY_SOFTPACK', 'USPS_PRIORITY_EXPRESS_PACKAGE', 'USPS_PRIORITY_EXPRESS_PACKAGE_NON_MACHINABLE', 'USPS_PRIORITY_EXPRESS_ENVELOPE', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_LEGAL', 'USPS_EXPRESS_FLATRATEMEDIUMBOX', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_PADDED', 'USPS_MEDIAMAIL_RECTPARCEL', 'USPS_CRITICAL_ENVELOPE', 'USPS_CRITICAL_FLAT', 'CONSDOM/Standard', 'CONSDOM/Expedited'<br /><strong>USPS Intl:</strong><br />'USPS_FIRST_PACKAGE_INTERNATIONAL', 'USPS_FIRST_ENVELOPE_INTERNATIONAL', 'USPS_FIRST_ENVELOPE_NON_MACHINABLE_INTERNATIONAL', 'USPS_FIRST_FLAT_INTERNATIONAL', 'USPS_PRIORITY_PACKAGE_INTERNATIONAL', 'INTLPRIORITY/ENVELOPE', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_PADDED_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_ENVELOPE_LEGAL_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_SMALL_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_INTERNATIONAL', 'USPS_PRIORITY_FLAT_RATE_BOX_LARGE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_PACKAGE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_INTERNATIONAL', 'USPS_PRIORITY_EXPRESS_FLAT_RATE_ENVELOPE_LEGAL_INTERNATIONAL', 'INTLEXPRESS/FLATRATEMEDIUMBOX', 'USPS_PRIORITY_AIRMAIL_INTERNATIONAL', 'USPS_ISAL_RECTPARCEL', 'CONSINTL/RECTPARCEL', 'CONSINTL1/RECTPARCEL', 'CONSINTL2/RECTPARCEL', 'CONSINTL3/RECTPARCEL', 'CONSINTL4/RECTPARCEL', 'CONSINTL5/RECTPARCEL', 'CONSINTL6/RECTPARCEL', 'CONSINTL7/RECTPARCEL', 'CONSINTL8/RECTPARCEL', 'CONSINTL9/RECTPARCEL', 'CONSINTL10/RECTPARCEL', 'CONSINTL11/RECTPARCEL', 'CONSINTL12/RECTPARCEL', 'CONSINTL13/RECTPARCEL', 'CONSINTL14/RECTPARCEL', 'CONSINTL15/RECTPARCEL', 'CONSINTL16/RECTPARCEL', 'USPS_COMMERCIAL_EPACKET_INTERNATIONAL'<br /><strong>FedEx:</strong><br />'FEDEX_GROUND', 'FEDEX_HOME', 'FEDEX_FIRST_OVERNIGHT', 'FEDEX_PRIORITY_OVERNIGHT', 'FEDEX_STANDARD_OVERNIGHT', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_2DAY', 'FEDEX_2DAY_AM', 'FEDEX_EXPRESS_SAVER', 'FEDEX_SMART_POST', 'FEDEX_FIRST_OVERNIGHT_INTERNATIONAL', 'FEDEX_PRIORITY_OVERNIGHT_INTERNATIONAL', 'FEDEX_ECONOMY_INTERNATIONAL', 'FEDEX_GROUND_INTERNATIONAL', 'FEDEX_FREIGHT_1DAY', 'FEDEX_FREIGHT_2DAY', 'FEDEX_FREIGHT_3DAY', 'FEDEX_FREIGHT_FIRST', 'FEDEX_FREIGHT_ECONOMY', 'FEDEX_FREIGHT_PRIORITY', 'FEDEX_FREIGHT_PRIORITY_INTERNATIONAL', 'FEDEX_FREIGHT_ECONOMY_INTERNATIONAL', 'FEDEX_CONNECT_PLUS_INTERNATIONAL', 'FEDEX_PRIORITY_EXPRESS_INTERNATIONAL', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_PAK', 'FEDEX_2DAY_ONE_RATE_TUBE', 'FEDEX_2DAY_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_PAK', 'FEDEX_2DAY_AM_ONE_RATE_TUBE', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_AM_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_PAK', 'FEDEX_EXPRESS_SAVER_ONE_RATE_TUBE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_MEDIUM_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ENVELOPE', 'FEDEX_2DAY_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ENVELOPE', 'FEDEX_2DAYAM_ENVELOPE', 'FEDEX_INTLGROUNDCONSOLIDATION', 'FEDEX_STANDARDOVERNIGHT_ENVELOPE'<br /><strong>UPS:</strong><br />'UPS_GROUND', 'UPS_NEXT_DAY_AIR', 'UPS_NEXT_DAY_AIR_EARLY_AM', 'UPS_NEXT_DAY_AIR_SAVER', 'UPS_2DAY_AIR_AM', 'UPS_2DAY_AIR', 'UPS_3DAY_SELECT', 'UPS_STANDARD', 'UPS_EXPRESS_EARLY_AM', 'UPS_EXPRESS', 'UPS_EXPRESS_SAVER', 'UPS_EXPEDITED', 'UPS_WORLDWIDE_EXPRESS_PLUS', 'UPS_WORLDWIDE_EXPRESS', 'UPS_WORLDWIDE_SAVER', 'UPS_WORLDWIDE_EXPEDITED', 'UPS_STANDARD_TO_CANADA', 'UPS_GROUND_SAVER', 'UPS_SUREPOST_LESS1LB', 'UPS_SUREPOST_LESS1LB_IRREGULAR', 'UPS_SUREPOST_MORE1LB_IRREGULAR', 'UPS_SUREPOST_MEDIA_IRREGULAR', 'UPS_SUREPOST_BPM_IRREGULAR', 'UPS_SUREPOST_1LB_OR_GREATER_MACHINABLE', 'UPS_MAILINNOVATIONS_LESS1LB', 'UPS_MAILINNOVATIONS_PARCELPOST', 'UPS_MAILINNOVATIONS_MACHINABLE', 'UPS_MAILINNOVATIONS_STANDARD_FLAT', 'UPS_MAILINNOVATIONS_BPM_PARCEL', 'UPS_MAILINNOVATIONS_BPM_FLAT', 'UPS_MAILINNOVATIONS_MEDIA', 'UPS_MAILINNOVATIONS_FIRST', 'UPS_MAILINNOVATIONS_PRIORITY', 'UPS_MAILINNOVATIONS_PRIORITY_INTERNATIONAL', 'UPS_MAILINNOVATIONS_ECONOMY_INTERNATIONAL', 'UPS_FREIGHT', 'UPS_FREIGHT_GUARANTEED', 'UPS_FREIGHT_GUARANTEED_AM', 'UPS_FREIGHT_STANDARD', 'UPS_GROUND_SIMPLE_RATE_XS', 'UPS_GROUND_SIMPLE_RATE_S', 'UPS_GROUND_SIMPLE_RATE_M', 'UPS_GROUND_SIMPLE_RATE_L', 'UPS_GROUND_SIMPLE_RATE_XL', 'UPS_2DAY_AIR_SIMPLE_RATE_XS', 'UPS_2DAY_AIR_SIMPLE_RATE_S', 'UPS_2DAY_AIR_SIMPLE_RATE_M', 'UPS_2DAY_AIR_SIMPLE_RATE_L', 'UPS_2DAY_AIR_SIMPLE_RATE_XL', 'UPS_3DAY_SELECT_SIMPLE_RATE_XS', 'UPS_3DAY_SELECT_SIMPLE_RATE_S', 'UPS_3DAY_SELECT_SIMPLE_RATE_M', 'UPS_3DAY_SELECT_SIMPLE_RATE_L', 'UPS_3DAY_SELECT_SIMPLE_RATE_XL', 'UPS_ST_CA', 'UPS_WORLDWIDE_SAVER_ASIA', 'UPS_WORLDWIDE_EXPEDITED_ASIA', 'UPS_WORLDWIDE_EXPRESS_ASIA', 'UPS_WORLDWIDE_EXPRESS_PLUS_ASIA', 'UPS_WORLDWIDE_SAVER_CANADA', 'UPS_3DAY_SELECT_CANADA', 'UPS_WORLDWIDE_EXPEDITED_CANADA', 'UPS_WORLDWIDE_EXPRESS_PLUS_CANADA', 'UPS_WORLDWIDE_EXPRESS_CANADA'<br /><strong>DHL Express:</strong><br />'DHLE_EXPRESS_9AM', 'DHLE_ECONOMY_SELECT', 'DHLE_EXPRESS_1030AM', 'DHLE_DOMESTIC_EXPRESS', 'DHLE_EXPRESS_WORLDWIDE', 'DHLE_EUROPACK', 'DHLE_EXPRESS_1200AM', 'DHLE_EXPRESS_WORLDWIDE_DOC', 'DHLE_EXPRESS_1200AM_DOC', 'DHLE_EXPRESS_9AM_DOC', 'DHLE_EXPRESS_1030AM_DOC', 'DHLE_ECONOMYSELECT_A', 'DHLE_EXPRESS1030AM_A', 'DHLE_EXPRESS1200AM_A', 'DHLE_EXPRESS9AM_A', 'DHLE_EXPRESSENVELOPE', 'DHLE_EXPRESSENVELOPE_A', 'DHLE_EXPRESSWORLDWIDE_A'<br /><strong>DHL eCommerce:</strong><br />'DHLEC_PARCELS_GROUND', 'DHLEC_PARCELS_GROUND_IRREGULAR', 'DHLEC_PARCELS_PLUS_GROUND', 'DHLEC_PARCELS_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCEL_GROUND_IRREGULAR', 'DHLEC_PARCEL_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED', 'DHLEC_PARCELS_EXPEDITED_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED_MAX', 'DHLEC_PARCELS_PLUS_EXPEDITED', 'DHLEC_PARCELS_PLUS_EXPEDITED_MAX', 'DHLEC_PARCEL_EXPEDITED_MAX', 'DHLEC_PARCEL_PLUS_EXPEDITED_MAX', 'DHLEC_PRIORITY', 'DHLEC_FIRST_PARCEL', 'DHLEC_FIRST_PARCEL_IRREGULAR', 'DHLEC_MARKETING_PARCEL_GROUND', 'DHLEC_MARKETING_PARCEL_GROUND_IRREGULAR', 'DHLEC_MARKETING_PARCEL_EXPEDITED', 'DHLEC_MARKETING_PARCEL_EXPEDITED_IRREGULAR', 'DHLEC_BPM_GROUND', 'DHLEC_BPM_EXPEDITED', 'DHLEC_CATALOG_BPM_GROUND', 'DHLEC_CATALOG_BPM_EXPEDITED', 'DHLEC_PACKET_STANDARD', 'DHLEC_PACKET_PRIORITY', 'DHLEC_PACKET_PLUS', 'DHLEC_PACKET_IPA', 'DHLEC_PACKET_ISAL', 'DHLEC_PARCEL_STANDARD', 'DHLEC_PARCEL_PRIORITY', 'DHLEC_PARCEL_DIRECT', 'DHLEC_PARCEL_DIRECT_EXPRESS', 'DHLEC_BUSINESS_STANDARD', 'DHLEC_BUSINESS_PRIORITY', 'DHLEC_BUSINESS_IPA', 'DHLEC_BUSINESS_ISAL', 'DHLEC_EXPEDITED_FLAT', 'DHLEC_GROUND_FLAT', 'DHLEC_PARCEL_RETURN_PLUS', 'DHLEC_PARCEL_RETURN_GROUND', 'DHLEC_PARCEL_RETURN_LIGHT', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_FORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_FORMAL', 'DHLEC_PARCEL_DIRECT_INTL', 'DHLEC_PARCEL_DIRECT_STANDARD_CA', 'DHLEC_PARCEL_DIRECT_PRIORITY_CA', 'DHLEC_PARCEL_DIRECT_MAX_CA', 'DHLEC_PARCELDIRECTEXPEDITED_RECTPARCEL'<br /><strong>OnTrac:</strong><br />'ONTRAC_GROUND', 'ONTRAC_SUNRISE', 'ONTRAC_SUNRISE_GOLD'<br /><strong>Estes:</strong><br />'ESTES_GUARANTEED_STANDARD', 'ESTES_GUARANTEED_ECONOMY', 'ESTES_GUARANTEED_BASIC', 'ESTES_GUARANTEED_EXCLUSIVE', 'ESTES_GUARANTEED_5PM', 'ESTES_GUARANTEED_12PM', 'ESTES_GUARANTEED_10AM', 'ESTES_STANDARD'<br /><strong>Purolator:</strong><br />'PUROLATOR_GROUND', 'PUROLATOR_GROUND_9AM', 'PUROLATOR_GROUND_10:30AM', 'PUROLATOR_GROUND_EVENING', 'PUROLATOR_EXPRESS', 'PUROLATOR_EXPRESS_9AM', 'PUROLATOR_EXPRESS_10:30AM', 'PUROLATOR_EXPRESS_12PM', 'PUROLATOR_EXPRESS_EVENING', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE_9AM', 'PUROLATOR_EXPRESS_ENVELOPE_10:30AM', 'PUROLATOR_EXPRESS_ENVELOPE_12PM', 'PUROLATOR_EXPRESS_ENVELOPE_EVENING', 'PUROLATOR_EXPRESS_PACK', 'PUROLATOR_EXPRESS_PACK_9AM', 'PUROLATOR_EXPRESS_PACK_10:30AM', 'PUROLATOR_EXPRESS_PACK_12PM', 'PUROLATOR_EXPRESS_PACK_EVENING', 'PUROLATOR_EXPRESS_BOX', 'PUROLATOR_EXPRESS_BOX_9AM', 'PUROLATOR_EXPRESS_BOX_10:30AM', 'PUROLATOR_EXPRESS_BOX_12PM', 'PUROLATOR_EXPRESS_BOX_EVENING'<br /><strong>Amazon:</strong><br />'AMAZON_SHIPPING_GROUND'<br /><strong>GoFo Express:</strong><br />'GOFO_STANDARD', 'GOFO_GROUND'<br /><strong>UniUni:</strong><br />'UNIUNI_STANDARD', 'UNIUNI_EXPRESS'<br /><strong>Yanwen:</strong><br />'YW_STANDARD'<br /><strong>Canada Post:</strong><br />'CAPOST_CADOM_EP', 'CAPOST_CADOM_PC', 'CAPOST_CADOM_RP', 'CAPOST_CADOM_XP', 'CAPOST_CAINT_IP_AIR', 'CAPOST_CAINT_IP_SURF', 'CAPOST_CAINT_PW_ENV', 'CAPOST_CAINT_PW_PAK', 'CAPOST_CAINT_PW_PARCEL', 'CAPOST_CAINT_SP_AIR', 'CAPOST_CAINT_SP_SURF', 'CAPOST_CAINT_TP', 'CAPOST_CAINT_XP', 'CAPOST_CAUSA_EP', 'CAPOST_CAUSA_PW_ENV', 'CAPOST_CAUSA_PW_PAK', 'CAPOST_CAUSA_PW_PARCEL', 'CAPOST_CAUSA_SP_AIR', 'CAPOST_CAUSA_TP', 'CAPOST_CAUSA_XP'
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
Type	PackageType | CustomPackageName	Allows you to specify a built-in package type (integer) defined by the carrier, or a custom package you defined by name in your Teapplix account. You should specify one of 'Type' or 'Dimensions' in your input.
PackageItems	PackageItem[]	Items and their quantities inside the package. This information is required for certain marketplaces.
Reference	string	This value will be printed on label. BBCODE placeholders can be used.
InsuranceValue	number	Insurance Value.
InsuranceFee	number	Insurance Fee. This value is ignored for input.
Postage	number	Postage amount for shipped package. Do not fill this for normal open orders.
TrackingInfo	Tracking Info	Tracking info

Amount

Declares any amount value

Property	Type	Description	Constraints
Amount	number
Currency	string		Pattern: [A-Z]{3}

Qvn

Property	Type	Description	Constraints
Qvn	integer	Qvn
From	string	From
EmailOnFail	string	Email on fail
Subject	string	Subject
Memo	string	Memo
Recipients	Freight Notification Recipient[]	Qvn Recipients

UPS Freight

Property	Type	Description	Constraints
Class	number	Freight Class
PackageType	string	Freight Package Type
PackagesQuantity	integer	Packages Quantity
PayerName	string	Payer Name	Max-Length: 40
PayerAddress	string	Payer Address	Max-Length: 255
PayerCity	string	Payer City	Max-Length: 50
PayerState	string	Payer State	Max-Length: 50
SortingAndSegregating	boolean	Sorting And Segregating
SortingQuantity	string	Sorting Quantity
ExtremeLength	boolean	Extreme Length
FreezableProtection	boolean	Freezable Protection
Handling	Handling	Handling
DangerousGoods	DangerousGoods	UPS Dangerous Goods Data
Pickup	Pickup

ExportDetail

Export detail

Property	Type	Description	Constraints
Kind	string
ForeignZoneCode	string
EntryNumber	string
LicenseNumber	string
ExpirationDate	string		Format: date

Recipient

Recipient

Property	Type	Description	Constraints
TaxId	CustomsId
CustomsId	CustomsId

HoldAtLocation

Hold At Location

Property	Type	Description	Constraints
Applied	string
Address	string
AddressType	string

Instructions

Instructions

Property	Type	Description	Constraints
Handling	string
Delivery	string
HomeDelivery	string
Pickup	string

FedEx Freight

Freight

Property	Type	Description	Constraints
Class	string	Freight Class	One of: CLASS_050, CLASS_055, CLASS_060, CLASS_065, CLASS_070, CLASS_077_5, CLASS_085, CLASS_092_5, CLASS_100, CLASS_110, CLASS_125, CLASS_150, CLASS_175, CLASS_200, CLASS_250, CLASS_300, CLASS_400, CLASS_500
PackageType	string	Freight Package Type	One of: BAG, BARREL, BASKET, BOX, BUCKET, BUNDLE, CARTON, CASE, CONTAINER, CRATE, CYLINDER, DRUM, ENVELOPE, HAMPER, OTHER, PAIL, PALLET, PIECE, REEL, ROLL, SKID, TANK, TUBE
PrintedReferenceType	string	Printed Reference Type	One of: BILL_OF_LADING, CONSIGNEE_ID_NUMBER, SHIPPER_ID_NUMBER
PrintedReferenceValue	string	Printed Reference Value	Max-Length: 255
GuaranteeDetailType	string	Freight Guarantee Detail Type	One of: GUARANTEED_DATE, GUARANTEED_MORNING
GuaranteeDetailDate	string	Freight Guarantee Detail Date	Format: date
Note	string	Note	Max-Length: 255
FreightDirectType	string	Freight Direct Type	Max-Length: 255
FreightDirectTransportationType	string	Freight Direct Transportation Type	Max-Length: 255
FreightDirectEmail	string	Freight Direct Email	Max-Length: 255
FreightDirectPhoneType1	string	Freight Direct Phone Type 1	Max-Length: 255
FreightDirectPhoneNumber1	string	Freight Direct Phone Number 1	Max-Length: 255
FreightDirectPhoneType2	string	Freight Direct Phone Type 2	Max-Length: 255
FreightDirectPhoneNumber2	string	Freight Direct Phone Number 2	Max-Length: 255
FreightDirectPhoneType3	string	Freight Direct Phone Type 3	Max-Length: 255
FreightDirectPhoneNumber3	string	Freight Direct Phone Number 3	Max-Length: 255

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

Dimensions of package

If not set Teapplix will apply 6x6x4 by default

Property	Type	Description	Constraints
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

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

Handling

Handling

Property	Type	Description	Constraints
Charge	string	Handling Charge
ChargeType	string	Handling Charge Type
ChargeValue	string	Handling Charge Value
Instructions	string	Instructions

DangerousGoods

UPS Dangerous Goods Data

Property	Type	Description	Constraints
Type	integer
Name	string	Dangerous Goods Name	Max-Length: 40
PhoneNumber	string	Dangerous Goods Phone Number	Max-Length: 40
PhoneExtension	string	Dangerous Goods Phone Extension	Max-Length: 10

Pickup

Property	Type	Description	Constraints
Weekend	boolean	Weekend
Holiday	boolean	Holiday
Inside	boolean	Inside
Residential	boolean	Residential
LimitedAccess	boolean	Limited access
LiftGate	boolean	Lift Gate Pickup Required
Instructions	string	Instructions

CustomsId

Property	Type	Description	Constraints
Type	string
Number	string

PackageItem

Declares package item to be shipped

Property	Type	Description	Constraints
LineNumber	integer	One of Line Number or Item Name is required.
Name	string	Specify Name of Item only if it is unique in Order Items list, otherwise specify Line Number. One of Line Number or Name is required.
Quantity	integer	Quantity.	RequiredMinimum: 1

Freight Notification Recipient

Property	Type	Description	Constraints
CompanyOrName	string	Company or Name
ContactName	string	Contact Name
Email	string	Email
ShipNotify	boolean	Ship Notify
ExceptionNotify	boolean	Exception Notify
DeliveryNotify	boolean	Delivery Notify
BolNotify	boolean	Bol Notify
BolEmailSubject	string	Bol Email Subject
BolEmailText	string	Bol Email Text

PUT Response - 200

Order Split Result

Property	Type	Description	Constraints
OrdersResult	OrderResult[]		Required

OrderResult

Property	Type	Description	Constraints
TxnId	string	Unique id for each entry	RequiredMax-Length: 40
Success	boolean	DEPRECATED: use Code (0 = success, non-zero = error) and Status (Accepted/Declined/Exists/Processed) instead. This field will be removed in the next API major version.	Required
Status	string	Per-order submission status. This is the canonical per-item discriminator going forward (use it instead of Success): * 'Accepted' – order was accepted successfully * 'Declined' – order was declined * 'Exists' – order with specified TxnId already exists * 'Processed' - order was processed successfully	RequiredOne of: Accepted, Declined, Exists, Processed
Code	integer	DEPRECATED: under HTTP 200, the canonical per-order discriminator is Status (Accepted/Declined/Exists/Processed). For specific failure detail, read Message and Description. Code will be removed in the next API major version. The error envelope (HTTP 4xx/5xx Message) keeps Code as canonical — only this per-item Code is being phased out.
Message	string	Detailed message. Typically associated with errors	Max-Length: 255
Description	string[]	Detailed description

PUT 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

PUT 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

PUT 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

Test Request Close

URL APIToken Body

Send