Split Order — Orders
You can use SplitOrder api to split one order into multiple orders. Each “child” order can be assigned separate queue an warehouse. The original “parent” order will be marked with payment status ‘Split’ and will no longer display in open orders. You cannot purchase label on the original parent order either.
When you split an order, at least one child order should be available to ship. Teapplix will copy the queue id, warehouse id etc from the parent order to all the child orders.
children.
Once you ship all the child orders, Teapplix will mark the original parent order shipped and upload tracking info to the original marketplace. For some marketplace, Teapplix will mark items shipped in a child order immediately as shipped after the child order is shipped in Teapplix.
Child orders on “Hold”
Section titled “Child orders on “Hold””When you split order, you can also optionally designate one child or several orders as “Hold”, by adding “Hold”:true or “QueueId”:1.
Hold orders means shipping for these items will be delayed. If you have multiple items on hold, and it is not predictable if they will ship at same time or not, you have 2 strategies here:
- If you already know how the rest of the items will be shipped separately, create multiple hold orders. you can ship them separately when the items become available by taking the orders from Hold queue to other queues, or using SplitOrderCont to clear the Hold flag.
- If you do not know how the rest of the items will be shipped, create a single Hold child order. You can use SplitOrderCont API to further split the Hold order later on as items become available to ship.
To split any order, use POST method.
To revert the split of an order, use DELETE method, notice the child orders must not have been shipped. In the case of Teapplix postage, once any postage purchase happens, even if refunded afterwards, split order cannot be removed. Reverting a split order will cause all the child orders to be totally removed from Teapplix database and the original order restored to ‘Completed’ payment status.
SplitOrder uses “POST” or “DELETE” REST method at the following URL:
POST Request
Order Split Request
'APIToken' header should be included in each request
| Property | Type | Description | Constraints |
|---|---|---|---|
TxnId |
string | Order Id for the parent order that will be split. Notice that each order can only be split once. | RequiredMax-Length: 40Pattern: [\s\S] |
Orders |
Order To Split[] | Array of 2 or more child Orders to create. |
Order To Split
| Property | Type | Description | Constraints |
|---|---|---|---|
TxnId |
string | Order Id for the sub order, must be unique | RequiredMax-Length: 40Pattern: [\s\S] |
OrderDetails |
OrderDetails | Order details including queue, warehouse, tags, memo, and custom fields | Required |
OrderItems |
Order Item To Split[] | Items assigned to the sub order. SplitOrder API enforces that sum of all sub order's items matches the items of parent order. | Required |
ShippingDetails |
OrderShipment[] | Information related to the order’s ship method, weight and dimensions. Optional and for split order we do not support extra packages, so specify only one Order Shipment here. | |
Hold |
boolean | Hold for now |
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 Item To Split
Order item
| Property | Type | Description | Constraints |
|---|---|---|---|
Name |
string | Child item's name. Each item in a child order must uniquely link back to a line in parent order. By default, Name is used to lookup that line in parent, unless Parent Line Number or Parent Item Name is specified. | Max-Length: 255 |
LineNumber |
integer | Line Number | |
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 | |
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 |
ParentLineNumber |
integer | Line Number in Parent. One of ParentLineNumber, ParentItemName or Name is used to find the Item in the Order being split. | |
ParentItemName |
string | Item Name in Parent. Use Parent Item Name only if it is unique, otherwise use Parent Line Number. | Max-Length: 255 |
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. |
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 |
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 |
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 |
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 |
DELETE Request
Order Split Revert
'APIToken' header should be included in each request
| Property | Type | Description | Constraints |
|---|---|---|---|
TxnId |
string | Order Id for the parent order that was split. Please note: all child orders will be removed | RequiredMax-Length: 40Pattern: [\s\S] |
DELETE 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 |
DELETE 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 |
DELETE 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 |
DELETE 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 |