{
"swaggerVersion": "1.2",
"apiVersion": "1.0.0",
"basePath": "https://api.teapplix.com/api2//",
"apis": [
{
"path": "/AddressValidation",
"description": "Return a valid address or an error message",
"operations": [
{
"method": "POST",
"nickname": "postAddress validation",
"parameters": [
{
"paramType": "body",
"name": "body",
"required": true,
"type": "AddressValidation-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "AddressValidation-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "AddressValidation-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "AddressValidation-POST-500-response"
}
]
}
]
},
{
"path": "/CancelLabel",
"description": "Label can be cancelled either by transaction id, client request id or by tracking number",
"operations": [
{
"method": "POST",
"nickname": "postCancel purchased labels",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Label can be cancelled using one of transction id, client request id, or tracking info. If the label is pre-paid using Teapplix Postage Meter, it will be refunded according to our refund policy after cancel.",
"required": true,
"type": "CancelLabel-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "CancelLabel-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "CancelLabel-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "CancelLabel-POST-500-response"
}
]
}
]
},
{
"path": "/DeferredAction",
"description": "Get Deferred Action Status by session id",
"operations": [
{
"method": "GET",
"nickname": "getDeferred Action Operation Result",
"parameters": [
{
"paramType": "query",
"name": "DeferredActionID",
"description": "Deferred Action ID",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "DeferredAction-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "DeferredAction-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "DeferredAction-GET-401-response"
},
{
"code": 404,
"message": "404 response",
"responseModel": "DeferredAction-GET-404-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "DeferredAction-GET-500-response"
}
]
}
]
},
{
"path": "/DownloadLabel/*",
"description": "Hidden endpoint",
"operations": [
{
"method": "GET",
"nickname": "getFile Content",
"parameters": [],
"responseMessages": [
{
"code": 200,
"message": "Binary file streamed directly in the response body. Inspect the Content-Type header to determine the format and Content-Disposition for the suggested filename.",
"responseModel": "DownloadLabel_*-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "DownloadLabel_*-GET-400-response"
},
{
"code": 404,
"message": "404 response",
"responseModel": "DownloadLabel_*-GET-404-response"
}
]
}
]
},
{
"path": "/Listing",
"operations": [
{
"method": "GET",
"nickname": "getListings result",
"parameters": [
{
"paramType": "query",
"name": "StoreType",
"description": "Store Type",
"type": "string"
},
{
"paramType": "query",
"name": "SellerId",
"description": "Seller ID",
"type": "string"
},
{
"paramType": "query",
"name": "SellerSKU",
"description": "Seller SKU",
"type": "string"
},
{
"paramType": "query",
"name": "TeapplixSKU",
"description": "Teapplix SKU",
"type": "string"
},
{
"paramType": "query",
"name": "WarehouseId",
"description": "Warehouse ID",
"type": "integer"
},
{
"paramType": "query",
"name": "ListingType",
"description": "Listing Type only available if StoreType is 'amazon', possible values 'DEFAULT', 'AMAZON_NA'",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "Listing-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Listing-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Listing-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Listing-GET-500-response"
}
]
},
{
"method": "PUT",
"nickname": "putListing update request",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "Listing-PUT-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "Listing-PUT-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Listing-PUT-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Listing-PUT-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Listing-PUT-500-response"
}
]
}
]
},
{
"path": "/ListingPrice",
"description": "Notes:
\n 1. If you only want to bulk update the warehouse Id for the listings, you can\n just specify new warehouseId without new price value;
\n 2. Not all channels support price update, the currently supported channels are:\n eBay, Amazon (all countries), Buy.com.",
"operations": [
{
"method": "POST",
"nickname": "postUpdate listing",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Listing Price and/or Warehouse Id update",
"required": true,
"type": "ListingPrice-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "ListingPrice-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ListingPrice-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ListingPrice-POST-500-response"
}
]
}
]
},
{
"path": "/Manifest",
"operations": [
{
"method": "POST",
"nickname": "postManifest request",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "Manifest-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "Manifest-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Manifest-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Manifest-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Manifest-POST-500-response"
},
{
"code": 501,
"message": "501 response",
"responseModel": "Manifest-POST-501-response"
}
]
}
]
},
{
"path": "/MarkReview",
"description": "Mark Review",
"operations": [
{
"method": "POST",
"nickname": "postMark Review",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Mark Review",
"required": true,
"type": "MarkReview-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "MarkReview-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "MarkReview-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "MarkReview-POST-500-response"
}
]
}
]
},
{
"path": "/OrderDropShip",
"operations": [
{
"method": "POST",
"nickname": "postOrder Notifications",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "OrderDropShip-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "OrderDropShip-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "OrderDropShip-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "OrderDropShip-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "OrderDropShip-POST-500-response"
}
]
}
]
},
{
"path": "/OrderNotification",
"operations": [
{
"method": "GET",
"nickname": "getOrder Query Notifications",
"parameters": [
{
"paramType": "query",
"name": "TxnId",
"description": "TxnId of order. Use this parameter to download only one order.",
"type": "string"
},
{
"paramType": "query",
"name": "StoreType",
"description": "Store Type.",
"type": "string"
},
{
"paramType": "query",
"name": "StoreKey",
"description": "Store Key.",
"type": "string"
},
{
"paramType": "query",
"name": "SellerId",
"description": "Seller ID.",
"type": "string"
},
{
"paramType": "query",
"name": "SeqStart",
"description": "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.",
"type": "string"
},
{
"paramType": "query",
"name": "SeqEnd",
"description": "Ending Unique Id for order sequence (inclusive)",
"type": "string"
},
{
"paramType": "query",
"name": "Invoice",
"description": "Invoice number (reference number, marketplace order number)",
"type": "string"
},
{
"paramType": "query",
"name": "PaymentDateStart",
"description": "Starting payment date to filter, e.g. PaymentDateStart=2012/01/01 => for orders with payment date >= 2012/01/01 (inclusive)",
"type": "string"
},
{
"paramType": "query",
"name": "PaymentDateEnd",
"description": "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)",
"type": "string"
},
{
"paramType": "query",
"name": "UpdateDateStart",
"description": "Starting update date to filter, e.g. UpdateDateStart=2019/01/01 => for orders with update date >= 2019/01/01",
"type": "string"
},
{
"paramType": "query",
"name": "UpdateDateEnd",
"description": "Ending update date to filter, e.g. UpdateDateEnd=2019/01/31 => for orders with update date <= 2019/01/31",
"type": "string"
},
{
"paramType": "query",
"name": "ShipDateStart",
"description": "Ship Date Start (inclusive)",
"type": "string"
},
{
"paramType": "query",
"name": "ShipDateEnd",
"description": "Ship Date End (inclusive)",
"type": "string"
},
{
"paramType": "query",
"name": "PaymentStatus",
"description": "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.",
"type": "string"
},
{
"paramType": "query",
"name": "Shipped",
"description": "Shipped flag (0|1), if you pass this flag, we will only give 'shipped' orders for 1 and only 'open' orders for 0",
"type": "integer"
},
{
"paramType": "query",
"name": "NotShipped",
"description": "Deprecated, use 'Shipped' instead. If you pass this flag, we will only give 'open' orders for 1 and 'shipped' order for 0",
"type": "integer"
},
{
"paramType": "query",
"name": "QueueId",
"description": "Queue Id, QueueId=0 => for orders with Normal queue; QueueId=3 => for orders with QueueId == 3 (integer; optional)",
"type": "integer"
},
{
"paramType": "query",
"name": "WarehouseId",
"description": "Warehouse Id",
"type": "string"
},
{
"paramType": "query",
"name": "Combine",
"description": "Combine option (default = combine). The orders selected under these 3 modes are different:
combine: 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
original: 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.
all: all orders, including combined results, cancelled orders, etc, will be in the result.",
"type": "string"
},
{
"paramType": "query",
"name": "VSAccountID",
"description": "Virtual Seller AccountID.",
"type": "string"
},
{
"paramType": "query",
"name": "DetailLevel",
"description": "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",
"type": "string"
},
{
"paramType": "query",
"name": "PageSize",
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"type": "string"
},
{
"paramType": "query",
"name": "PageNumber",
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"type": "string"
},
{
"paramType": "query",
"name": "Tag",
"description": "Filter by order tag name. Comma-separate multiple tag names to match orders that have any of the given tags.",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "OrderNotification-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "OrderNotification-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "OrderNotification-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "OrderNotification-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postOrder Notifications",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "OrderNotification-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "OrderNotification-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "OrderNotification-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "OrderNotification-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "OrderNotification-POST-500-response"
}
]
},
{
"method": "PUT",
"nickname": "putOrder Notifications",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "OrderNotification-PUT-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "OrderNotification-PUT-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "OrderNotification-PUT-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "OrderNotification-PUT-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "OrderNotification-PUT-500-response"
}
]
}
]
},
{
"path": "/OrderShipOptions",
"description": "API call allows to get or set Shipping options for existing order",
"operations": [
{
"method": "POST",
"nickname": "postShippingOptions",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Used to set shipping options for order without printing",
"required": true,
"type": "OrderShipOptions-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "OrderShipOptions-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "OrderShipOptions-POST-400-response"
},
{
"code": 501,
"message": "501 response",
"responseModel": "OrderShipOptions-POST-501-response"
}
]
}
]
},
{
"path": "/Queue",
"description": "Manage order queues. Each queue groups orders for a specific Warehouse (WarehouseId, FK to /Warehouse) and ShippingProfile (ProfileId, FK to /ShippingProfile). Orders are routed to a queue based on marketplace channel rules, and labels are printed using the queue's ShippingProfile. Queues with QueueId 1-4 are built-in and cannot be deleted; queues with QueueId 1-2 also have immutable names. Use GET /Queue to look up QueueId values before referencing them in order routing rules.",
"operations": [
{
"method": "GET",
"nickname": "getQueue Get Response",
"parameters": [
{
"paramType": "query",
"name": "QueueId",
"description": "Filter by queue ID (exact match). Use to look up a specific queue by its numeric ID.",
"type": "integer"
},
{
"paramType": "query",
"name": "QueueName",
"description": "Case-insensitive substring search on queue name. Returns all queues whose name contains this string.",
"type": "string"
},
{
"paramType": "query",
"name": "WarehouseId",
"description": "Filter by warehouse ID (exact match). Returns all queues assigned to that warehouse (FK to /Warehouse).",
"type": "integer"
},
{
"paramType": "query",
"name": "WarehouseName",
"description": "Filter by warehouse name (exact match). Alternative to WarehouseId: returns all queues assigned to the warehouse with this name.",
"type": "string"
},
{
"paramType": "query",
"name": "ProfileId",
"description": "Filter by shipping profile ID (exact match). Returns all queues using that shipping profile (FK to /ShippingProfile).",
"type": "integer"
},
{
"paramType": "query",
"name": "ProfileName",
"description": "Filter by shipping profile name (exact match). Alternative to ProfileId: returns all queues using the profile with this name.",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "Response to GET /Queue. Contains a list of order queues matching the query filters, ordered by QueueSeq then QueueId.",
"responseModel": "Queue-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Queue-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Queue-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Queue-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postOrder Queue",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Order queue \u2014 groups orders by warehouse and shipping profile. Each queue has a WarehouseId (FK: warehouse.warehouse_id) and a ProfileId (FK: shipping_profile.id). The shipping table references queue_id.",
"required": true,
"type": "Queue-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Result of a single queue create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"responseModel": "Queue-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Queue-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Queue-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Queue-POST-500-response"
}
]
},
{
"method": "PUT",
"nickname": "putOrder Queue",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Order queue \u2014 groups orders by warehouse and shipping profile. Each queue has a WarehouseId (FK: warehouse.warehouse_id) and a ProfileId (FK: shipping_profile.id). The shipping table references queue_id.",
"required": true,
"type": "Queue-PUT-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Result of a single queue create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"responseModel": "Queue-PUT-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Queue-PUT-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Queue-PUT-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Queue-PUT-500-response"
}
]
},
{
"method": "DELETE",
"nickname": "deleteQueue Delete",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Request body for DELETE /Queue. Deletes a single order queue. Provide either QueueId or QueueName (not both). Deletion is blocked if the queue has active (unshipped) orders. Built-in queues (QueueId 1-4) cannot be deleted.",
"required": true,
"type": "Queue-DELETE-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Result of a single queue create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"responseModel": "Queue-DELETE-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Queue-DELETE-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Queue-DELETE-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Queue-DELETE-500-response"
}
]
}
]
},
{
"path": "/OrderTags",
"operations": [
{
"method": "GET",
"nickname": "getOrder Tags Query Notifications",
"parameters": [
{
"paramType": "query",
"name": "TxnId",
"description": "TxnId of order. Use this parameter to download only one order.",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "OrderTags-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "OrderTags-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "OrderTags-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "OrderTags-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postOrder Tags",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "OrderTags-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "OrderTags-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "OrderTags-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "OrderTags-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "OrderTags-POST-500-response"
}
]
},
{
"method": "DELETE",
"nickname": "deleteOrder Tags",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "OrderTags-DELETE-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "OrderTags-DELETE-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "OrderTags-DELETE-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "OrderTags-DELETE-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "OrderTags-DELETE-500-response"
}
]
}
]
},
{
"path": "/Tag",
"description": "Manage order tags. Tags are colored labels that can be applied to orders for visual grouping and filtering (see /OrderTags to apply tags to orders). Tags with TagId 1 (Ready To Ship) and 2 (Hold) are system tags and cannot be deleted. A tag cannot be deleted while it is assigned to any orders.",
"operations": [
{
"method": "GET",
"nickname": "getTag Get Response",
"parameters": [
{
"paramType": "query",
"name": "TagId",
"description": "Filter by tag ID (exact match). Use to look up a specific tag by its numeric ID.",
"type": "integer"
},
{
"paramType": "query",
"name": "TagName",
"description": "Case-insensitive substring search on tag name. Returns all tags whose name contains this string.",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "Response to GET /Tag. Contains a list of tags matching the query filters, ordered by TagId.",
"responseModel": "Tag-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Tag-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Tag-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Tag-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postTag",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Order tag entity. Tags are colored labels applied to orders for visual grouping and filtering. TagId 1 (Ready To Ship) and TagId 2 (Hold) are system tags and cannot be deleted. Use /OrderTags to apply or remove tags from orders.",
"required": true,
"type": "Tag-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"responseModel": "Tag-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Tag-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Tag-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Tag-POST-500-response"
}
]
},
{
"method": "PUT",
"nickname": "putTag",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Order tag entity. Tags are colored labels applied to orders for visual grouping and filtering. TagId 1 (Ready To Ship) and TagId 2 (Hold) are system tags and cannot be deleted. Use /OrderTags to apply or remove tags from orders.",
"required": true,
"type": "Tag-PUT-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"responseModel": "Tag-PUT-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Tag-PUT-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Tag-PUT-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Tag-PUT-500-response"
}
]
},
{
"method": "DELETE",
"nickname": "deleteTag Delete",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Request body for DELETE /Tag. Deletes a single tag. Provide either TagId or TagName (not both). Deletion is blocked if the tag is assigned to any orders. System tags (TagId 1 = Ready To Ship, TagId 2 = Hold) cannot be deleted.",
"required": true,
"type": "Tag-DELETE-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"responseModel": "Tag-DELETE-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Tag-DELETE-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Tag-DELETE-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Tag-DELETE-500-response"
}
]
}
]
},
{
"path": "/PackingListForOrder",
"operations": [
{
"method": "POST",
"nickname": "postPacking List For Order",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "PackingListForOrder-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Document details",
"responseModel": "PackingListForOrder-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "PackingListForOrder-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "PackingListForOrder-POST-500-response"
}
]
}
]
},
{
"path": "/PickupForOrder",
"description": "Request Pickup For Order",
"operations": [
{
"method": "POST",
"nickname": "postRequest Pickup For Order",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "PickupForOrder-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "PickupForOrder-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "PickupForOrder-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "PickupForOrder-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "PickupForOrder-POST-500-response"
}
]
}
]
},
{
"path": "/SSCCLabelForOrder",
"operations": [
{
"method": "POST",
"nickname": "postSSCC Label For Order",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "SSCCLabelForOrder-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Document details",
"responseModel": "SSCCLabelForOrder-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "SSCCLabelForOrder-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "SSCCLabelForOrder-POST-500-response"
}
]
}
]
},
{
"path": "/Product",
"operations": [
{
"method": "GET",
"nickname": "getProduct Get Response",
"parameters": [
{
"paramType": "query",
"name": "ItemName",
"description": "Item Name of product",
"type": "string"
},
{
"paramType": "query",
"name": "ItemType",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "VariationType",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "RootItemName",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Upc",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Location",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "ItemTitle",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Category",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "JetCategoryId",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "WalmartCategoryId",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "WalmartTaxCode",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Supplier",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Asin",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Xref3",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "DefaultPrice",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "DefaultPriceSign",
"description": "Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='",
"type": "string"
},
{
"paramType": "query",
"name": "Cost",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "CostSign",
"description": "Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='",
"type": "string"
},
{
"paramType": "query",
"name": "SalesRep",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "CommissionRate",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "DangerousGoodsType",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "CountryOfOrigin",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Brand",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Model",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Manufacturer",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "ManufacturerPartNumber",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Status",
"description": "Status of downloaded inventory products. Possible values: active, inactive, all. Default active",
"type": "string"
},
{
"paramType": "query",
"name": "PageSize",
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"type": "string"
},
{
"paramType": "query",
"name": "PageNumber",
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "Product-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Product-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Product-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Product-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postProducts",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Used to insert Inventory Products",
"required": true,
"type": "Product-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Operation result",
"responseModel": "Product-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Product-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Product-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Product-POST-500-response"
}
]
},
{
"method": "PUT",
"nickname": "putProducts",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Used to update Inventory Products",
"required": true,
"type": "Product-PUT-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Operation result",
"responseModel": "Product-PUT-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Product-PUT-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Product-PUT-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Product-PUT-500-response"
}
]
},
{
"method": "DELETE",
"nickname": "deleteProducts",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Used to delete Inventory Products",
"required": true,
"type": "Product-DELETE-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Operation result",
"responseModel": "Product-DELETE-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Product-DELETE-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Product-DELETE-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Product-DELETE-500-response"
}
]
}
]
},
{
"path": "/ProductCombo",
"operations": [
{
"method": "GET",
"nickname": "getCombo Product Get Response",
"parameters": [
{
"paramType": "query",
"name": "ParentItemName",
"description": "Item Name of parent product",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "ProductCombo-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ProductCombo-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ProductCombo-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ProductCombo-GET-500-response"
}
]
},
{
"method": "PUT",
"nickname": "putCombo Product data to update",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Used to update Inventory Combo Products",
"required": true,
"type": "ProductCombo-PUT-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Operation result",
"responseModel": "ProductCombo-PUT-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ProductCombo-PUT-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ProductCombo-PUT-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ProductCombo-PUT-500-response"
}
]
}
]
},
{
"path": "/ProductQuantity",
"operations": [
{
"method": "GET",
"nickname": "getProduct Operation result",
"parameters": [
{
"paramType": "query",
"name": "WarehouseId",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "ItemName",
"description": "",
"type": "string"
},
{
"paramType": "query",
"name": "Upc",
"description": "",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Operation result",
"responseModel": "ProductQuantity-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ProductQuantity-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ProductQuantity-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ProductQuantity-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postInventory Quantities",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Inventory Quantities",
"required": true,
"type": "ProductQuantity-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Operation result",
"responseModel": "ProductQuantity-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ProductQuantity-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ProductQuantity-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ProductQuantity-POST-500-response"
}
]
}
]
},
{
"path": "/ProductVariation",
"operations": [
{
"method": "GET",
"nickname": "getProduct Variation",
"parameters": [
{
"paramType": "query",
"name": "ParentItemName",
"description": "",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Variations for selected ParentItemName",
"responseModel": "ProductVariation-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ProductVariation-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ProductVariation-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ProductVariation-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postProduct Variation",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Used to insert Product Variations for ParentItemName",
"required": true,
"type": "ProductVariation-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Operation result",
"responseModel": "ProductVariation-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ProductVariation-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ProductVariation-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ProductVariation-POST-500-response"
}
]
}
]
},
{
"path": "/ProductXref",
"operations": [
{
"method": "GET",
"nickname": "getProduct Mapping Response",
"parameters": [
{
"paramType": "query",
"name": "TeapplixSKU",
"description": "Teapplix SKU",
"type": "string"
},
{
"paramType": "query",
"name": "SourceItemName",
"description": "Item Name of product",
"type": "string"
},
{
"paramType": "query",
"name": "PageSize",
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"type": "string"
},
{
"paramType": "query",
"name": "PageNumber",
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "ProductXref-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ProductXref-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ProductXref-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ProductXref-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postProducts Mapping",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Used to insert Products Mapping",
"required": true,
"type": "ProductXref-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Mapping Operation result",
"responseModel": "ProductXref-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ProductXref-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ProductXref-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ProductXref-POST-500-response"
}
]
},
{
"method": "DELETE",
"nickname": "deleteProducts Mapping Delete Request",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Used to delete Product Mapping",
"required": true,
"type": "ProductXref-DELETE-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Product Mapping Operation result",
"responseModel": "ProductXref-DELETE-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ProductXref-DELETE-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ProductXref-DELETE-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ProductXref-DELETE-500-response"
}
]
}
]
},
{
"path": "/PSObtainToken",
"description": "Create Access Token needed to launch UI for a specific paired client account",
"operations": [
{
"method": "GET",
"nickname": "getObtain access token result",
"parameters": [
{
"paramType": "query",
"name": "PSClientID",
"description": "ClientID known to partner systems. Must uniquely identify a partner account and not duplicate in the partner customer base",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "PSObtainToken-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "PSObtainToken-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "PSObtainToken-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "PSObtainToken-GET-500-response"
}
]
}
]
},
{
"path": "/PurchaseLabel",
"description": "Provides method to purchase label",
"operations": [
{
"method": "POST",
"nickname": "postPurchase Label",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Represents single label purchase request",
"required": true,
"type": "PurchaseLabel-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Represents purchase label result",
"responseModel": "PurchaseLabel-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "PurchaseLabel-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "PurchaseLabel-POST-500-response"
}
]
}
]
},
{
"path": "/PurchaseLabelForOrder",
"description": "Method used to purchase label for existing order",
"operations": [
{
"method": "POST",
"nickname": "postPurchase Label",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Represents single label purchase request",
"required": true,
"type": "PurchaseLabelForOrder-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Represents purchase label result",
"responseModel": "PurchaseLabelForOrder-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "PurchaseLabelForOrder-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "PurchaseLabelForOrder-POST-500-response"
}
]
}
]
},
{
"path": "/Rates",
"operations": [
{
"method": "POST",
"nickname": "postShipping rates request",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "Rates-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "Rates-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Rates-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Rates-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Rates-POST-500-response"
},
{
"code": 501,
"message": "501 response",
"responseModel": "Rates-POST-501-response"
}
]
}
]
},
{
"path": "/RatesForOrder",
"operations": [
{
"method": "POST",
"nickname": "postShipping rates request",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "RatesForOrder-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "RatesForOrder-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "RatesForOrder-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "RatesForOrder-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "RatesForOrder-POST-500-response"
}
]
}
]
},
{
"path": "/Shipment",
"description": "Used by external systems to inform Teapplix that certain orders are shipped outside of Teapplix, and the details around those shipments",
"operations": [
{
"method": "GET",
"nickname": "getShipment data",
"parameters": [
{
"paramType": "query",
"name": "TxnId",
"description": "Find shipment info for a specific order",
"type": "string"
},
{
"paramType": "query",
"name": "ShipCarrier",
"description": "Obtain shipment information with matching carrier",
"type": "string"
},
{
"paramType": "query",
"name": "TrackingNumber",
"description": "Obtain shipment infromation with matching tracking number",
"type": "string"
},
{
"paramType": "query",
"name": "ShipDateStart",
"description": "inclusive - limit to all orders shipped starting this date, format YYYY-MM-DD, YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00",
"type": "string"
},
{
"paramType": "query",
"name": "ShipDateEnd",
"description": "inclusive - limit to all orders shipped until this date, format YYYY-MM-DD, YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00",
"type": "string"
},
{
"paramType": "query",
"name": "QueueId",
"description": "Limit orders placed in a specific queue id",
"type": "integer"
},
{
"paramType": "query",
"name": "StoreType",
"description": "Store Type. Limit to orders from specific channel",
"type": "string"
},
{
"paramType": "query",
"name": "StoreKey",
"description": "Store Key. This must be specified together with StoreType, limit to orders from specific channel + account",
"type": "string"
},
{
"paramType": "query",
"name": "ReturnLabel",
"description": "Return Label Flag (0|1). If you set this parameter, return will contain PDF of order label base64 encoded",
"type": "integer"
}
],
"responseMessages": [
{
"code": 200,
"message": "Shipment details",
"responseModel": "Shipment-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Shipment-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Shipment-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Shipment-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postShipping confirmation",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Used to set shipping details for order shipped outside of Teapplix",
"required": true,
"type": "Shipment-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "Shipment-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Shipment-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Shipment-POST-500-response"
}
]
}
]
},
{
"path": "/ShippingProfile",
"description": "Listing of shipping profiles. A ShippingProfile defines a shipper identity (name, company, address, return address, phone) used when printing labels. Profiles are assigned to order queues (ProfileId in /Queue). ProfileId 1 is the default. Use GET /ShippingProfile to look up ProfileId values before creating or updating queues.",
"operations": [
{
"method": "GET",
"nickname": "getShipping Profile Get Response",
"parameters": [
{
"paramType": "query",
"name": "ProfileId",
"description": "Filter by profile ID (exact match). Use to look up a specific shipping profile by its numeric ID.",
"type": "integer"
},
{
"paramType": "query",
"name": "Active",
"description": "Filter by active flag: 1 = active only, 0 = inactive only. Omit to return all profiles.",
"type": "integer"
},
{
"paramType": "query",
"name": "Name",
"description": "Case-insensitive substring search on profile name. Returns all profiles whose name contains this string.",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "ShippingProfile-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "ShippingProfile-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "ShippingProfile-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "ShippingProfile-GET-500-response"
}
]
}
]
},
{
"path": "/SplitOrder",
"operations": [
{
"method": "POST",
"nickname": "postOrder Split",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "SplitOrder-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "SplitOrder-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "SplitOrder-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "SplitOrder-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "SplitOrder-POST-500-response"
}
]
},
{
"method": "DELETE",
"nickname": "deleteOrder Split Revert",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "SplitOrder-DELETE-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "SplitOrder-DELETE-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "SplitOrder-DELETE-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "SplitOrder-DELETE-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "SplitOrder-DELETE-500-response"
}
]
}
]
},
{
"path": "/SplitOrderCont",
"operations": [
{
"method": "POST",
"nickname": "postOrder Split",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "SplitOrderCont-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "SplitOrderCont-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "SplitOrderCont-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "SplitOrderCont-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "SplitOrderCont-POST-500-response"
}
]
}
]
},
{
"path": "/Track",
"description": "Track shipment",
"operations": [
{
"method": "GET",
"nickname": "getTrack",
"parameters": [
{
"paramType": "query",
"name": "Carrier",
"description": "Carrier name, possible values 'USPS', 'UPS', 'FEDEX', 'DHLE', 'DHL'",
"type": "string"
},
{
"paramType": "query",
"name": "TrackingNumber",
"description": "Shipment tracking #",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "Track-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Track-GET-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Track-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postRecord",
"parameters": [
{
"paramType": "body",
"name": "body",
"required": true,
"type": "Track-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "Track-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Track-POST-400-response"
},
{
"code": 501,
"message": "501 response",
"responseModel": "Track-POST-501-response"
}
]
}
]
},
{
"path": "/VendorScan",
"operations": [
{
"method": "POST",
"nickname": "postVendor Scan request",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "'APIToken' header should be included in each request",
"required": true,
"type": "VendorScan-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "VendorScan-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "VendorScan-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "VendorScan-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "VendorScan-POST-500-response"
},
{
"code": 501,
"message": "501 response",
"responseModel": "VendorScan-POST-501-response"
}
]
}
]
},
{
"path": "/Warehouse",
"description": "Manage warehouses. Each warehouse has a WarehouseType (sync_source) that controls how inventory is tracked. Native types (GENERIC, RECONCILE, DROPSHIP, QB) are fully configurable; 3PL and FBA warehouses are provisioned through external integrations. Warehouse 1 is the default and cannot be deleted. Warehouses are referenced by order queues (/Queue) and marketplace channel mappings.",
"operations": [
{
"method": "GET",
"nickname": "getWarehouse Get Response",
"parameters": [
{
"paramType": "query",
"name": "WarehouseId",
"description": "Filter by warehouse ID (exact match). Use this to look up a specific warehouse by its numeric ID.",
"type": "integer"
},
{
"paramType": "query",
"name": "WarehouseType",
"description": "Filter by warehouse type (WarehouseType enum). Example: GENERIC, FBA, DROPSHIP. Returns all warehouses of that type.",
"type": "string"
},
{
"paramType": "query",
"name": "WarehouseName",
"description": "Case-insensitive substring search on warehouse name. Returns all warehouses whose name contains this string.",
"type": "string"
}
],
"responseMessages": [
{
"code": 200,
"message": "Response to GET /Warehouse. Contains a list of warehouses matching the query filters.",
"responseModel": "Warehouse-GET-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Warehouse-GET-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Warehouse-GET-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Warehouse-GET-500-response"
}
]
},
{
"method": "POST",
"nickname": "postWarehouse",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Warehouse entity. WarehouseType controls inventory tracking: GENERIC/RECONCILE/DROPSHIP/QB are native Teapplix-managed types; FBA and 3PL types (e.g. ECCANGWMS) are provisioned via external integrations and have locked types. QuantityAlgorithm applies only to GENERIC, RECONCILE, DROPSHIP, and DROPSHIP-T types.",
"required": true,
"type": "Warehouse-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Result of a single warehouse create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"responseModel": "Warehouse-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Warehouse-POST-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Warehouse-POST-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Warehouse-POST-500-response"
}
]
},
{
"method": "PUT",
"nickname": "putWarehouse",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Warehouse entity. WarehouseType controls inventory tracking: GENERIC/RECONCILE/DROPSHIP/QB are native Teapplix-managed types; FBA and 3PL types (e.g. ECCANGWMS) are provisioned via external integrations and have locked types. QuantityAlgorithm applies only to GENERIC, RECONCILE, DROPSHIP, and DROPSHIP-T types.",
"required": true,
"type": "Warehouse-PUT-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Result of a single warehouse create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"responseModel": "Warehouse-PUT-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Warehouse-PUT-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Warehouse-PUT-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Warehouse-PUT-500-response"
}
]
},
{
"method": "DELETE",
"nickname": "deleteWarehouse Delete",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Request body for DELETE /Warehouse. Deletes a single warehouse. Provide either WarehouseId or WarehouseName (not both). Deletion is blocked if the warehouse is referenced by an order queue, a marketplace channel mapping, or a listing. WarehouseId 1 (default warehouse) cannot be deleted.",
"required": true,
"type": "Warehouse-DELETE-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "Result of a single warehouse create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"responseModel": "Warehouse-DELETE-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Warehouse-DELETE-400-response"
},
{
"code": 401,
"message": "401 response",
"responseModel": "Warehouse-DELETE-401-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Warehouse-DELETE-500-response"
}
]
}
]
},
{
"path": "/Zones",
"description": "API call allows to get provider's shipping zone (if available)",
"operations": [
{
"method": "POST",
"nickname": "postZones",
"parameters": [
{
"paramType": "body",
"name": "body",
"description": "Request to obtain shipping zone",
"required": true,
"type": "Zones-POST-request"
}
],
"responseMessages": [
{
"code": 200,
"message": "200 response",
"responseModel": "Zones-POST-200-response"
},
{
"code": 400,
"message": "400 response",
"responseModel": "Zones-POST-400-response"
},
{
"code": 500,
"message": "500 response",
"responseModel": "Zones-POST-500-response"
}
]
}
]
}
],
"models": {
"ref4a63ec29a1543c2454d887f9754e8e6c": {
"id": "ref4a63ec29a1543c2454d887f9754e8e6c",
"description": "Address structure",
"properties": {
"Street": {
"description": "Street address 1st line",
"type": "string",
"maximum": 255
},
"Street2": {
"description": "Street address 2nd line",
"type": "string",
"maximum": 255
},
"City": {
"description": "The city or town name.",
"type": "string",
"minimum": 1,
"maximum": 40
},
"State": {
"description": "State code or region name",
"type": "string",
"maximum": 40
},
"ZipCode": {
"description": "ZIP or Postal Code",
"type": "string"
},
"Country": {
"description": "Country name. Default United States",
"type": "string"
},
"CountryCode": {
"description": "2 letter ISO code. Default US",
"type": "string",
"minimum": 2,
"maximum": 2
}
}
},
"ref572d5faee00f39008814516e2659d55e": {
"id": "ref572d5faee00f39008814516e2659d55e",
"required": [
"Address",
"Provider"
],
"properties": {
"Address": {
"$ref": "ref4a63ec29a1543c2454d887f9754e8e6c"
},
"Provider": {
"description": "Provider which will be used for address validation",
"type": "string",
"enum": [
"TEAPPLIX",
"STAMPS_COM",
"ENDICIA",
"UPS",
"FEDEX"
]
}
}
},
"ref37f7fa74564bb6eda01299cd9a48feeb": {
"id": "ref37f7fa74564bb6eda01299cd9a48feeb",
"required": [
"Status",
"Address"
],
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Validated Changed",
"Validated Not Changed",
"Not Changed"
]
},
"Message": {
"description": "Status message. Available when status is 'Not Changed' that indicate error from AV Engine",
"type": "string"
},
"Address": {
"$ref": "ref4a63ec29a1543c2454d887f9754e8e6c"
},
"Residential": {
"description": "Address residential indicator, if available",
"type": "boolean"
},
"DeliveryPoint": {
"description": "The delivery point, if available",
"type": "string"
}
}
},
"ref184a5da824da41ba695c14dfe76601c9": {
"id": "ref184a5da824da41ba695c14dfe76601c9",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AddressValidation-POST-request": {
"id": "AddressValidation-POST-request",
"required": [
"Address",
"Provider"
],
"properties": {
"Address": {
"$ref": "ref4a63ec29a1543c2454d887f9754e8e6c"
},
"Provider": {
"description": "Provider which will be used for address validation",
"type": "string",
"enum": [
"TEAPPLIX",
"STAMPS_COM",
"ENDICIA",
"UPS",
"FEDEX"
]
}
}
},
"AddressValidation-POST-200-response": {
"id": "AddressValidation-POST-200-response",
"required": [
"Status",
"Address"
],
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Validated Changed",
"Validated Not Changed",
"Not Changed"
]
},
"Message": {
"description": "Status message. Available when status is 'Not Changed' that indicate error from AV Engine",
"type": "string"
},
"Address": {
"$ref": "ref4a63ec29a1543c2454d887f9754e8e6c"
},
"Residential": {
"description": "Address residential indicator, if available",
"type": "boolean"
},
"DeliveryPoint": {
"description": "The delivery point, if available",
"type": "string"
}
}
},
"AddressValidation-POST-400-response": {
"id": "AddressValidation-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AddressValidation-POST-500-response": {
"id": "AddressValidation-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refb397657fb92ce6ddbb0880c86ad7ac1a": {
"id": "refb397657fb92ce6ddbb0880c86ad7ac1a",
"description": "Tracking info",
"properties": {
"TrackingNumber": {
"description": "Tracking number of shipment",
"type": "string",
"maximum": 50
},
"CarrierName": {
"description": "Carrier name which is assigned with tracking",
"type": "string"
},
"SSCC": {
"description": "Serial Shipping Container Code",
"type": "string"
}
}
},
"refcd07535ce159f365a4164aae2b2e804f": {
"id": "refcd07535ce159f365a4164aae2b2e804f",
"description": "Label can be cancelled using one of transction id, client request id, or tracking info. If the label is pre-paid using Teapplix Postage Meter, it will be refunded according to our refund policy after cancel.",
"properties": {
"TxnId": {
"description": "TxnId (Order Id) to cancel label. If the order has extra packages, all packages will be cancelled.",
"type": "string"
},
"ClientRequestId": {
"description": "Cancel label by Client Request Id. This is used if you originally used PurchaseLabel API to generate a label without an Order",
"type": "string"
},
"TrackingInfo": {
"$ref": "refb397657fb92ce6ddbb0880c86ad7ac1a"
},
"Force": {
"description": "Mark order as unshipped in case of FedEx and UPS label cancel error",
"type": "boolean"
}
}
},
"CancelLabel-POST-request": {
"id": "CancelLabel-POST-request",
"description": "Label can be cancelled using one of transction id, client request id, or tracking info. If the label is pre-paid using Teapplix Postage Meter, it will be refunded according to our refund policy after cancel.",
"properties": {
"TxnId": {
"description": "TxnId (Order Id) to cancel label. If the order has extra packages, all packages will be cancelled.",
"type": "string"
},
"ClientRequestId": {
"description": "Cancel label by Client Request Id. This is used if you originally used PurchaseLabel API to generate a label without an Order",
"type": "string"
},
"TrackingInfo": {
"$ref": "refb397657fb92ce6ddbb0880c86ad7ac1a"
},
"Force": {
"description": "Mark order as unshipped in case of FedEx and UPS label cancel error",
"type": "boolean"
}
}
},
"CancelLabel-POST-200-response": {
"id": "CancelLabel-POST-200-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CancelLabel-POST-400-response": {
"id": "CancelLabel-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CancelLabel-POST-500-response": {
"id": "CancelLabel-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref1357c5a334be1080e56709b5a5c76909": {
"id": "ref1357c5a334be1080e56709b5a5c76909",
"properties": {
"DeferredActionID": {
"description": "Deferred Action ID",
"type": "string"
}
}
},
"ref452dacd5f7914681d3b4a66b09233c55": {
"id": "ref452dacd5f7914681d3b4a66b09233c55",
"description": "List of deferred action details",
"required": [
"ID",
"Name"
],
"properties": {
"ID": {
"description": "ID",
"type": "integer"
},
"Name": {
"description": "Action Name",
"type": "string"
},
"AddedTime": {
"description": "Timestamp when action was added",
"type": "string"
},
"StartedTime": {
"description": "Timestamp when action execution was started",
"type": "string"
},
"FinishedTime": {
"description": "Timestamp when action execution was finished",
"type": "string"
},
"Status": {
"description": "Status of the action",
"type": "string",
"enum": [
"new",
"queued",
"working",
"success",
"fail",
"stopped"
]
},
"Result": {
"description": "Result of the finished action",
"type": "boolean"
},
"Comment": {
"description": "Comments to the action result or any other text data",
"type": "boolean"
}
}
},
"ref83fc2a1474a3fa74e98567a6c3e31672": {
"id": "ref83fc2a1474a3fa74e98567a6c3e31672",
"required": [
"Status"
],
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Messages": {
"description": "Messages related to the this request",
"type": "array",
"items": {
"type": "string"
}
},
"DeferredAction": {
"$ref": "ref452dacd5f7914681d3b4a66b09233c55"
}
}
},
"DeferredAction-GET-query": {
"id": "DeferredAction-GET-query",
"properties": {
"DeferredActionID": {
"description": "Deferred Action ID",
"type": "string"
}
}
},
"DeferredAction-GET-200-response": {
"id": "DeferredAction-GET-200-response",
"required": [
"Status"
],
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Messages": {
"description": "Messages related to the this request",
"type": "array",
"items": {
"type": "string"
}
},
"DeferredAction": {
"$ref": "ref452dacd5f7914681d3b4a66b09233c55"
}
}
},
"DeferredAction-GET-400-response": {
"id": "DeferredAction-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"DeferredAction-GET-401-response": {
"id": "DeferredAction-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"DeferredAction-GET-404-response": {
"id": "DeferredAction-GET-404-response",
"required": [
"Status"
],
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Messages": {
"description": "Messages related to the this request",
"type": "array",
"items": {
"type": "string"
}
},
"DeferredAction": {
"$ref": "ref452dacd5f7914681d3b4a66b09233c55"
}
}
},
"DeferredAction-GET-500-response": {
"id": "DeferredAction-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref120aadd14c89335c615065c8fa4da621": {
"id": "ref120aadd14c89335c615065c8fa4da621",
"description": "Binary file streamed directly in the response body. Inspect the Content-Type header to determine the format and Content-Disposition for the suggested filename.",
"properties": {
"Content-Type": {
"description": "MIME type of the downloaded file",
"type": "string",
"enum": [
"application/pdf",
"image/png",
"image/gif",
"image/tiff",
"application/octet-stream"
]
}
}
},
"DownloadLabel_*-GET-200-response": {
"id": "DownloadLabel_*-GET-200-response",
"description": "Binary file streamed directly in the response body. Inspect the Content-Type header to determine the format and Content-Disposition for the suggested filename.",
"properties": {
"Content-Type": {
"description": "MIME type of the downloaded file",
"type": "string",
"enum": [
"application/pdf",
"image/png",
"image/gif",
"image/tiff",
"application/octet-stream"
]
}
}
},
"DownloadLabel_*-GET-400-response": {
"id": "DownloadLabel_*-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"DownloadLabel_*-GET-404-response": {
"id": "DownloadLabel_*-GET-404-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref8b182e8ca98342c34ecaa2f851e16556": {
"id": "ref8b182e8ca98342c34ecaa2f851e16556",
"properties": {
"StoreType": {
"description": "Store Type",
"type": "string"
},
"SellerId": {
"description": "Seller ID",
"type": "string"
},
"SellerSKU": {
"description": "Seller SKU",
"type": "string"
},
"TeapplixSKU": {
"description": "Teapplix SKU",
"type": "string"
},
"WarehouseId": {
"description": "Warehouse ID",
"type": "integer"
},
"ListingType": {
"description": "Listing Type only available if StoreType is 'amazon', possible values 'DEFAULT', 'AMAZON_NA'",
"type": "string"
}
}
},
"ref97a46eaf708135a4610560951bc7dac4": {
"id": "ref97a46eaf708135a4610560951bc7dac4",
"properties": {
"StoreType": {
"description": "Store Listing is From",
"type": "string",
"enum": [
"3dcart",
"3plcentral",
"Manual",
"RMA",
"aafes",
"academysports",
"acehardware",
"acenda",
"amazon",
"amzv",
"ashley",
"barnesnoble",
"basspro",
"belk",
"belkb2b",
"bestbuy",
"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",
"homedepot",
"homedepot2b",
"homedepotca",
"homedepotso",
"homehardware",
"houzz",
"hsn",
"jcpenney",
"kohls",
"lampsplus",
"lowes",
"lowes2b",
"lowesca",
"lowesm",
"macys",
"magento",
"magento2",
"menards",
"michaels",
"mirakl",
"newegg",
"neweggApi",
"neweggb2b",
"northerntool",
"opencart",
"opensky",
"orgill",
"oscommerce",
"paypal",
"petco",
"petsmart",
"pinnacle",
"prestashop",
"qbi",
"qbo",
"qbr",
"quill",
"qvc",
"rakuten",
"reverb",
"ruegilt",
"samsclub",
"sears",
"shein",
"shipstation",
"shopify",
"sparkpay",
"squarespace",
"staplesadvca",
"supplieroasis",
"target",
"target2b",
"temu",
"tiktok",
"tongtool",
"tophatter",
"tractorsupply",
"volusion",
"walmart",
"walmartdsv",
"walmartpo",
"wayfair",
"wish",
"woocommerce",
"wsonoma",
"xcart",
"xcart5",
"yahoo",
"zencart",
"zoro"
]
},
"StoreKey": {
"description": "Unique id for each store type, filled for StoreType other than ebay or amazon",
"type": "string"
},
"VSAccountID": {
"type": "string"
},
"SellerId": {
"description": "For StoreType ebay or amazon only",
"type": "string"
},
"ListingTitle": {
"description": "Listing Title",
"type": "string",
"maximum": 255
},
"TeapplixSKU": {
"description": "Teapplix SKU",
"type": "string"
},
"SellerSKU": {
"description": "Seller SKU",
"type": "string"
},
"ListingId": {
"description": "Listing Id",
"type": "string"
},
"ImageUrl": {
"description": "Image Url",
"type": "string"
},
"ListingType": {
"description": "Listing Type",
"type": "string"
},
"QtyOnMarketplace": {
"description": "Quantity On Marketplace",
"type": "integer"
},
"QtyAvailable": {
"description": "Quantity Available",
"type": "integer"
},
"ChannelWarehouseId": {
"description": "Channel Warehouse Id",
"type": "string"
},
"WarehouseId": {
"description": "Warehouse Id",
"type": "integer"
},
"altListingId": {
"description": "Alternative listing id",
"type": "string"
},
"UPC": {
"description": "UPC",
"type": "string"
},
"Open": {
"description": "Product Open flag",
"type": "integer"
},
"handlingTime": {
"description": "Handling Time",
"type": "string"
},
"brand": {
"description": "Brand",
"type": "string"
},
"manufacturer": {
"description": "Manufacturer",
"type": "string"
},
"asin": {
"description": "ASIN",
"type": "string"
}
}
},
"refff1b9629a1fc612bc37917bd8a3396fd": {
"id": "refff1b9629a1fc612bc37917bd8a3396fd",
"required": [
"Listings"
],
"properties": {
"Listings": {
"type": "array",
"items": {
"$ref": "ref97a46eaf708135a4610560951bc7dac4"
}
}
}
},
"refc0690d50d88e083859bed3912421e45e": {
"id": "refc0690d50d88e083859bed3912421e45e",
"required": [
"StoreType",
"SellerSKU",
"WarehouseId"
],
"properties": {
"StoreType": {
"description": "Order type. Formerly Channel in this API endpoint.",
"type": "string",
"enum": [
"3dcart",
"3plcentral",
"Manual",
"RMA",
"aafes",
"academysports",
"acehardware",
"acenda",
"amazon",
"amzv",
"ashley",
"barnesnoble",
"basspro",
"belk",
"belkb2b",
"bestbuy",
"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",
"homedepot",
"homedepot2b",
"homedepotca",
"homedepotso",
"homehardware",
"houzz",
"hsn",
"jcpenney",
"kohls",
"lampsplus",
"lowes",
"lowes2b",
"lowesca",
"lowesm",
"macys",
"magento",
"magento2",
"menards",
"michaels",
"mirakl",
"newegg",
"neweggApi",
"neweggb2b",
"northerntool",
"opencart",
"opensky",
"orgill",
"oscommerce",
"paypal",
"petco",
"petsmart",
"pinnacle",
"prestashop",
"qbi",
"qbo",
"qbr",
"quill",
"qvc",
"rakuten",
"reverb",
"ruegilt",
"samsclub",
"sears",
"shein",
"shipstation",
"shopify",
"sparkpay",
"squarespace",
"staplesadvca",
"supplieroasis",
"target",
"target2b",
"temu",
"tiktok",
"tongtool",
"tophatter",
"tractorsupply",
"volusion",
"walmart",
"walmartdsv",
"walmartpo",
"wayfair",
"wish",
"woocommerce",
"wsonoma",
"xcart",
"xcart5",
"yahoo",
"zencart",
"zoro"
]
},
"StoreKey": {
"description": "Unique id for each store type, filled for StoreType other than ebay or amazon",
"type": "string"
},
"SellerId": {
"type": "string"
},
"SellerSKU": {
"description": "Seller SKU",
"type": "string"
},
"ListingId": {
"description": "Listing Id",
"type": "string"
},
"WarehouseId": {
"description": "New Warehouse ID to set",
"type": "integer"
}
}
},
"refce112ab6848e3e10e178cab328fec489": {
"id": "refce112ab6848e3e10e178cab328fec489",
"description": "'APIToken' header should be included in each request",
"properties": {
"Listings": {
"type": "array",
"items": {
"$ref": "refc0690d50d88e083859bed3912421e45e"
}
}
}
},
"refcf05b459b14ce051880560963942e9c8": {
"id": "refcf05b459b14ce051880560963942e9c8",
"properties": {
"StoreType": {
"description": "Order type",
"type": "string",
"enum": [
"3dcart",
"3plcentral",
"Manual",
"RMA",
"aafes",
"academysports",
"acehardware",
"acenda",
"amazon",
"amzv",
"ashley",
"barnesnoble",
"basspro",
"belk",
"belkb2b",
"bestbuy",
"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",
"homedepot",
"homedepot2b",
"homedepotca",
"homedepotso",
"homehardware",
"houzz",
"hsn",
"jcpenney",
"kohls",
"lampsplus",
"lowes",
"lowes2b",
"lowesca",
"lowesm",
"macys",
"magento",
"magento2",
"menards",
"michaels",
"mirakl",
"newegg",
"neweggApi",
"neweggb2b",
"northerntool",
"opencart",
"opensky",
"orgill",
"oscommerce",
"paypal",
"petco",
"petsmart",
"pinnacle",
"prestashop",
"qbi",
"qbo",
"qbr",
"quill",
"qvc",
"rakuten",
"reverb",
"ruegilt",
"samsclub",
"sears",
"shein",
"shipstation",
"shopify",
"sparkpay",
"squarespace",
"staplesadvca",
"supplieroasis",
"target",
"target2b",
"temu",
"tiktok",
"tongtool",
"tophatter",
"tractorsupply",
"volusion",
"walmart",
"walmartdsv",
"walmartpo",
"wayfair",
"wish",
"woocommerce",
"wsonoma",
"xcart",
"xcart5",
"yahoo",
"zencart",
"zoro"
]
},
"StoreKey": {
"description": "Unique id for each store type, filled for StoreType other than ebay or amazon",
"type": "string"
},
"SellerSKU": {
"description": "Seller SKU",
"type": "string"
},
"SellerId": {
"type": "string"
},
"ListingId": {
"description": "Listing Id",
"type": "string"
},
"Status": {
"description": "Status",
"type": "string"
},
"StatusMessage": {
"description": "Status Message",
"type": "string"
}
}
},
"ref99b1b408f0292866312f2700c848b7e8": {
"id": "ref99b1b408f0292866312f2700c848b7e8",
"properties": {
"Listings": {
"description": "Listing Results",
"type": "array",
"items": {
"$ref": "refcf05b459b14ce051880560963942e9c8"
}
}
}
},
"Listing-GET-query": {
"id": "Listing-GET-query",
"properties": {
"StoreType": {
"description": "Store Type",
"type": "string"
},
"SellerId": {
"description": "Seller ID",
"type": "string"
},
"SellerSKU": {
"description": "Seller SKU",
"type": "string"
},
"TeapplixSKU": {
"description": "Teapplix SKU",
"type": "string"
},
"WarehouseId": {
"description": "Warehouse ID",
"type": "integer"
},
"ListingType": {
"description": "Listing Type only available if StoreType is 'amazon', possible values 'DEFAULT', 'AMAZON_NA'",
"type": "string"
}
}
},
"Listing-GET-200-response": {
"id": "Listing-GET-200-response",
"required": [
"Listings"
],
"properties": {
"Listings": {
"type": "array",
"items": {
"$ref": "ref97a46eaf708135a4610560951bc7dac4"
}
}
}
},
"Listing-GET-400-response": {
"id": "Listing-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Listing-GET-401-response": {
"id": "Listing-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Listing-GET-500-response": {
"id": "Listing-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Listing-PUT-request": {
"id": "Listing-PUT-request",
"description": "'APIToken' header should be included in each request",
"properties": {
"Listings": {
"type": "array",
"items": {
"$ref": "refc0690d50d88e083859bed3912421e45e"
}
}
}
},
"Listing-PUT-200-response": {
"id": "Listing-PUT-200-response",
"properties": {
"Listings": {
"description": "Listing Results",
"type": "array",
"items": {
"$ref": "refcf05b459b14ce051880560963942e9c8"
}
}
}
},
"Listing-PUT-400-response": {
"id": "Listing-PUT-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Listing-PUT-401-response": {
"id": "Listing-PUT-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Listing-PUT-500-response": {
"id": "Listing-PUT-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref9363d0ad3362299bf9e573650ac698bf": {
"id": "ref9363d0ad3362299bf9e573650ac698bf",
"description": "Declares any amount value",
"properties": {
"Amount": {
"type": "number"
},
"Currency": {
"type": "string"
}
}
},
"ref4fd2e67d2a1fdb6452c80fc3cdf1086e": {
"id": "ref4fd2e67d2a1fdb6452c80fc3cdf1086e",
"required": [
"Marketplace",
"SellerId",
"SellerSKU"
],
"properties": {
"Marketplace": {
"description": "Indicates which channel to update",
"type": "string",
"enum": [
"EBAY",
"AMAZON",
"BUY_COM",
"SUPPLIER_OASIS"
]
},
"SellerId": {
"description": "Seller account on the marketplace",
"type": "string"
},
"SellerSKU": {
"description": "Specific seller SKU on the marketplace listing",
"type": "string"
},
"ListingNumber": {
"description": "Listing number that uniquely identifies the listing, this parameter is optional",
"type": "string"
},
"NewPrice": {
"$ref": "ref9363d0ad3362299bf9e573650ac698bf"
},
"MapPrice": {
"$ref": "ref9363d0ad3362299bf9e573650ac698bf"
},
"MapType": {
"description": "Applies to Rakuten Buy.com only",
"type": "string"
},
"HandlingTime": {
"description": "If an Amazon listing has a non standard handling time,\n any price update must be accompanied by specifying the handling time,\n otherwise, Amazon will reset listing to default handling time",
"type": "integer"
},
"SalePrice": {
"$ref": "ref9363d0ad3362299bf9e573650ac698bf"
},
"StartDate": {
"description": "Start date of Amazon promotion",
"type": "string",
"format": "date"
},
"EndDate": {
"description": "End date of Amazon promotion",
"type": "string",
"format": "date"
},
"WarehouseId": {
"description": "If you turned on multiple warehouse, specifying a warehouse id will cause this listing to be assigned to that warehouse",
"type": "integer"
}
}
},
"ref8a3cd3c85dc79a17f190bb7068ccbfc7": {
"id": "ref8a3cd3c85dc79a17f190bb7068ccbfc7",
"description": "Listing Price and/or Warehouse Id update",
"required": [
"Items"
],
"properties": {
"Items": {
"description": "List of items to be updated",
"type": "array",
"items": {
"$ref": "ref4fd2e67d2a1fdb6452c80fc3cdf1086e"
}
}
}
},
"refaffa378017f198a1e98f01c0d99dc99b": {
"id": "refaffa378017f198a1e98f01c0d99dc99b",
"description": "Result of update operation",
"required": [
"Status"
],
"properties": {
"Status": {
"description": "Submission status for order:",
"type": "string",
"enum": [
"Success",
"NotFound",
"Failure"
]
},
"Message": {
"description": "Message",
"type": "string"
},
"ListingNumber": {
"description": "Listing Number or Id",
"type": "string"
},
"NewPrice": {
"description": "Value of new price applied to listing",
"type": "number"
},
"Marketplace": {
"description": "Marketplace Name",
"type": "string",
"enum": [
"EBAY",
"AMAZON",
"BUY_COM",
"SUPPLIER_OASIS"
]
}
}
},
"ref5b36e54e4bcc3e14b6bef22b49831239": {
"id": "ref5b36e54e4bcc3e14b6bef22b49831239",
"properties": {
"Items": {
"description": "List of results",
"type": "array",
"items": {
"$ref": "refaffa378017f198a1e98f01c0d99dc99b"
}
}
}
},
"ListingPrice-POST-request": {
"id": "ListingPrice-POST-request",
"description": "Listing Price and/or Warehouse Id update",
"required": [
"Items"
],
"properties": {
"Items": {
"description": "List of items to be updated",
"type": "array",
"items": {
"$ref": "ref4fd2e67d2a1fdb6452c80fc3cdf1086e"
}
}
}
},
"ListingPrice-POST-200-response": {
"id": "ListingPrice-POST-200-response",
"properties": {
"Items": {
"description": "List of results",
"type": "array",
"items": {
"$ref": "refaffa378017f198a1e98f01c0d99dc99b"
}
}
}
},
"ListingPrice-POST-400-response": {
"id": "ListingPrice-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ListingPrice-POST-500-response": {
"id": "ListingPrice-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref96362afa981f58900ff7aa165042eaad": {
"id": "ref96362afa981f58900ff7aa165042eaad",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnIds"
],
"properties": {
"AirwayBillId": {
"type": "string"
},
"TxnIds": {
"description": "List of TxnId to be included in manifest",
"type": "array",
"items": {
"type": "string"
}
},
"Force": {
"description": "Force submit Txns that were already manifested. Default false. Affects PBOWESPS only.",
"type": "boolean"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"ref16facdc1388da12ce6d4621e89c839eb": {
"id": "ref16facdc1388da12ce6d4621e89c839eb",
"required": [
"Message"
],
"properties": {
"Code": {
"description": "Warning code (if applicable)",
"type": "string"
},
"Message": {
"description": "Warning message",
"type": "string"
}
}
},
"ref61ae82c8f51c308a8134597850314650": {
"id": "ref61ae82c8f51c308a8134597850314650",
"required": [
"Status"
],
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Warnings": {
"description": "Warning related to the this request",
"type": "array",
"items": {
"$ref": "ref16facdc1388da12ce6d4621e89c839eb"
}
},
"PickupDocument": {
"description": "Base64 encoded Pickup Document",
"type": "string"
}
}
},
"Manifest-POST-request": {
"id": "Manifest-POST-request",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnIds"
],
"properties": {
"AirwayBillId": {
"type": "string"
},
"TxnIds": {
"description": "List of TxnId to be included in manifest",
"type": "array",
"items": {
"type": "string"
}
},
"Force": {
"description": "Force submit Txns that were already manifested. Default false. Affects PBOWESPS only.",
"type": "boolean"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"Manifest-POST-200-response": {
"id": "Manifest-POST-200-response",
"required": [
"Status"
],
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Warnings": {
"description": "Warning related to the this request",
"type": "array",
"items": {
"$ref": "ref16facdc1388da12ce6d4621e89c839eb"
}
},
"PickupDocument": {
"description": "Base64 encoded Pickup Document",
"type": "string"
}
}
},
"Manifest-POST-400-response": {
"id": "Manifest-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Manifest-POST-401-response": {
"id": "Manifest-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Manifest-POST-500-response": {
"id": "Manifest-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Manifest-POST-501-response": {
"id": "Manifest-POST-501-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref9702b0dd6c02a1f6fbbbb417f818008f": {
"id": "ref9702b0dd6c02a1f6fbbbb417f818008f",
"description": "Mark Review",
"properties": {
"TxnIds": {
"description": "Array of Txn Ids",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MarkReview-POST-request": {
"id": "MarkReview-POST-request",
"description": "Mark Review",
"properties": {
"TxnIds": {
"description": "Array of Txn Ids",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MarkReview-POST-200-response": {
"id": "MarkReview-POST-200-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MarkReview-POST-400-response": {
"id": "MarkReview-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MarkReview-POST-500-response": {
"id": "MarkReview-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref6ee81e82b13ed65ee13c36677c707bb1": {
"id": "ref6ee81e82b13ed65ee13c36677c707bb1",
"description": "Shipping Address structure",
"properties": {
"Name": {
"description": "Full person's name. Either Name or Company should be set",
"type": "string",
"maximum": 128
},
"Company": {
"description": "Company name. A valid address requires at least a Name or Company Name",
"type": "string",
"maximum": 127
},
"Street": {
"description": "Street address 1st line",
"type": "string",
"maximum": 255
},
"Street2": {
"description": "Street address 2nd line",
"type": "string",
"maximum": 255
},
"City": {
"description": "The city or town name.",
"type": "string",
"minimum": 1,
"maximum": 40
},
"State": {
"description": "State code or region name",
"type": "string",
"maximum": 40
},
"ZipCode": {
"description": "ZIP or Postal Code",
"type": "string"
},
"CountryCode": {
"description": "2 letter ISO code. Default US",
"type": "string",
"minimum": 2,
"maximum": 2
},
"FirstName": {
"description": "First Name. Do not specify both Name and First Name",
"type": "string",
"maximum": 128
},
"LastName": {
"description": "Last Name. Do not specify both Name and Last Name",
"type": "string",
"maximum": 128
},
"Country": {
"description": "Country name. Default United States",
"type": "string"
},
"PhoneNumber": {
"description": "Phone number in any format. Can be changed based on carrier",
"type": "string",
"maximum": 40
},
"Email": {
"description": "Email if known",
"type": "string"
}
}
},
"ref7aa882688649fbf5795c590e9f444faf": {
"id": "ref7aa882688649fbf5795c590e9f444faf",
"description": "Billing Address structure",
"properties": {
"Name": {
"description": "Full person's name. Either Name or Company should be set",
"type": "string",
"maximum": 128
},
"Company": {
"description": "Company name. A valid address requires at least a Name or Company Name",
"type": "string",
"maximum": 127
},
"Street": {
"description": "Street address 1st line",
"type": "string",
"maximum": 255
},
"Street2": {
"description": "Street address 2nd line",
"type": "string",
"maximum": 255
},
"City": {
"description": "The city or town name.",
"type": "string",
"minimum": 1,
"maximum": 40
},
"State": {
"description": "State code or region name",
"type": "string",
"maximum": 40
},
"ZipCode": {
"description": "ZIP or Postal Code",
"type": "string"
},
"CountryCode": {
"description": "2 letter ISO code. Default US",
"type": "string",
"minimum": 2,
"maximum": 2
}
}
},
"reff7ae7405b7fcacd6fea2f7ce1cb66f66": {
"id": "reff7ae7405b7fcacd6fea2f7ce1cb66f66",
"description": "Order totals",
"properties": {
"Shipping": {
"description": "Shipping cost",
"type": "number"
},
"Handling": {
"description": "Handling",
"type": "number"
},
"Discount": {
"description": "Discount amount",
"type": "number"
},
"Tax": {
"description": "Tax amount",
"type": "number"
},
"InsuranceType": {
"description": "Insurance Type. This tag is deprecated. Please use Options/IsuranceType tag instead.",
"type": "string",
"enum": [
"none",
"teapplix",
"carrier"
]
},
"Currency": {
"description": "Order currency",
"type": "string"
},
"PostageCurrency": {
"description": "Postage currency",
"type": "string"
},
"Fee": {
"description": "Fee amount",
"type": "number"
},
"Total": {
"description": "Total amount",
"type": "number"
}
}
},
"refd1fdb1529ea3a2d4feda9587a3440360": {
"id": "refd1fdb1529ea3a2d4feda9587a3440360",
"properties": {
"Invoice": {
"description": "If the order matches an invoice, the unique id of the invoice.",
"type": "string",
"maximum": 127
},
"PaymentDate": {
"description": "Date of payment. Format Y-m-D H:i:s or Y-m-d. If not set - current date time will be used",
"type": "string"
},
"Memo": {
"description": "This is memo from the buyer left when placing the order",
"type": "string",
"maximum": 2048
},
"PrivateMemo": {
"description": "This is memo that seller placed on the order to help with processing. This is not from the buyer",
"type": "string",
"maximum": 2048
},
"GiftMessage": {
"description": "Gift message",
"type": "string",
"maximum": 2048
},
"WarehouseId": {
"description": "The id of the teapplix warehouse this order is assigned to",
"type": "integer"
},
"WarehouseName": {
"description": "The name of the teapplix warehouse this order is assigned to",
"type": "string"
},
"QueueId": {
"description": "The id of the teapplix order queue this order is assigned to.",
"type": "integer"
},
"TagList": {
"description": "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.",
"type": "array",
"items": {
"type": "string"
}
},
"ShipClass": {
"description": "Ship class typically indicate the level of shipping speed the order should have",
"type": "string"
},
"Custom": {
"description": "Custom",
"type": "string",
"maximum": 255
},
"Custom2": {
"description": "Custom2",
"type": "string",
"maximum": 255
},
"Custom3": {
"description": "Custom3",
"type": "string",
"maximum": 255
},
"Custom4": {
"description": "Custom4",
"type": "string",
"maximum": 255
}
}
},
"ref45ed5d5f40993271a8ee973e25ac88b5": {
"id": "ref45ed5d5f40993271a8ee973e25ac88b5",
"description": "Order item",
"properties": {
"Name": {
"description": "Item's name",
"type": "string",
"maximum": 255
},
"LineNumber": {
"description": "Line Number",
"type": "integer"
},
"ItemId": {
"description": "Seller item Id. This typically maps to the listing id on catalogs",
"type": "string",
"maximum": 127
},
"ItemSKU": {
"description": "Mapped product name in Teapplix",
"type": "string",
"maximum": 255
},
"ItemLocation": {
"description": "Item Location. This is stored on the order line if you set it on inbound POST|PUT",
"type": "string"
},
"Description": {
"description": "Item description",
"type": "string",
"maximum": 255
},
"Quantity": {
"description": "The quantity of this item ordered",
"type": "integer"
},
"Amount": {
"description": "Subtotal for this order line",
"type": "number"
},
"Shipping": {
"description": "Shipping cost",
"type": "number"
},
"Tax": {
"description": "Handling amount",
"type": "number"
},
"ItemCustom": {
"description": "Item Custom field",
"type": "string",
"maximum": 255
},
"Shipping Tax": {
"description": "Shipping tax amount",
"type": "number"
}
}
},
"ref07f702756ae87a1ee2a7f8357ccd01da": {
"id": "ref07f702756ae87a1ee2a7f8357ccd01da",
"required": [
"Value",
"Unit"
],
"properties": {
"Value": {
"description": "Absolute weight value",
"type": "number"
},
"Unit": {
"description": "Unit",
"type": "string",
"enum": [
"OZ",
"LB",
"GR",
"KG"
]
}
}
},
"ref48ee594915301e37caddcaf617d21c51": {
"id": "ref48ee594915301e37caddcaf617d21c51",
"description": "If not set Teapplix will apply 6x6x4 by default",
"required": [
"Length",
"Width",
"Depth",
"Unit"
],
"properties": {
"Length": {
"description": "Length",
"type": "number"
},
"Width": {
"description": "Width",
"type": "number"
},
"Depth": {
"description": "Depth",
"type": "number"
},
"Unit": {
"description": "Unit of measurement",
"type": "string",
"enum": [
"IN",
"CM"
]
}
}
},
"ref9494289afd99bb78f58b00b6a87b3b62": {
"id": "ref9494289afd99bb78f58b00b6a87b3b62",
"description": "Declares type of a custom package saved in Teapplix Setup",
"required": [
"PackageType"
],
"properties": {
"PackageType": {
"description": "Type of custom package",
"type": "integer"
}
}
},
"ref72e687b746f3d7a775b1bf11f87738ed": {
"id": "ref72e687b746f3d7a775b1bf11f87738ed",
"description": "Declares name of a custom package",
"required": [
"CustomPackageName"
],
"properties": {
"CustomPackageName": {
"description": "Name of custom package type saved in Teapplix Setup",
"type": "string"
}
}
},
"ref67700ad872cc737e7b246385d084c0d7": {
"id": "ref67700ad872cc737e7b246385d084c0d7",
"description": "Declares package item to be shipped",
"required": [
"Quantity"
],
"properties": {
"LineNumber": {
"description": "One of Line Number or Item Name is required.",
"type": "integer"
},
"Name": {
"description": "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.",
"type": "string"
},
"Quantity": {
"description": "Quantity.",
"type": "integer",
"minimum": 1
}
}
},
"refa4431bfbb95206818b2ffcdb2dc48ae8": {
"id": "refa4431bfbb95206818b2ffcdb2dc48ae8",
"description": "Declares packages to be shipped",
"properties": {
"Method": {
"description": "Shipping method used to print label. One of \n
USPS:
'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'
USPS Intl:
'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'
USPS Presort:
'PB_PARCELSELECT_LIGHTWEIGHT_PACKAGE_PRESORT', 'PB_PARCELSELECT_PACKAGE_PRESORT', 'USPS_PARCELSELECT_LIGHTWEIGHT_PACKAGE_PRESORT', 'USPS_PARCELSELECT_PACKAGE_PRESORT'
FedEx:
'FEDEX_FREIGHT_1DAY', 'FEDEX_2DAY', 'FEDEX_2DAY_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_ONE_RATE_PAK', 'FEDEX_2DAY_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_TUBE', 'FEDEX_2DAY_AM', 'FEDEX_2DAYAM_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_AM_ONE_RATE_PAK', 'FEDEX_2DAY_AM_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_TUBE', 'FEDEX_FREIGHT_2DAY', 'FEDEX_FREIGHT_3DAY', 'Economy', 'FEDEX_FREIGHT_ECONOMY', 'FEDEX_EXPRESS_SAVER', 'FEDEX_EXPRESS_SAVER_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_MEDIUM_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_PAK', 'FEDEX_EXPRESS_SAVER_ONE_RATE_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_TUBE', 'FEDEX_FREIGHT_FIRST', 'FEDEX_FIRST_OVERNIGHT', 'FEDEX_FIRST_OVERNIGHT_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_GROUND', 'FEDEX_HOME', 'FEDEX_CONNECT_PLUS_INTERNATIONAL', 'FEDEX_ECONOMY_INTERNATIONAL', 'FEDEX_FREIGHT_ECONOMY_INTERNATIONAL', 'FEDEX_FIRST_OVERNIGHT_INTERNATIONAL', 'FEDEX_INTLGROUNDCONSOLIDATION', 'FEDEX_PRIORITY_EXPRESS_INTERNATIONAL', 'FEDEX_FREIGHT_PRIORITY_INTERNATIONAL', 'FEDEX_PRIORITY_OVERNIGHT_INTERNATIONAL', 'FEDEX_FREIGHT_PRIORITY', 'FEDEX_PRIORITY_OVERNIGHT', 'FEDEX_PRIORITY_OVERNIGHT_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_SMART_POST', 'FEDEX_STANDARD_OVERNIGHT', 'FEDEX_STANDARDOVERNIGHT_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_TUBE'
UPS:
'UPS_GROUND', 'UPS_3DAY_SELECT', 'UPS_2DAY_AIR', 'UPS_2DAY_AIR_AM', 'UPS_NEXT_DAY_AIR_SAVER', 'UPS_NEXT_DAY_AIR', 'UPS_NEXT_DAY_AIR_EARLY_AM', '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_SUREPOST_LESS1LB', 'UPS_SUREPOST_LESS1LB_IRREGULAR', 'UPS_SUREPOST_1LB_OR_GREATER_MACHINABLE', 'UPS_SUREPOST_MORE1LB_IRREGULAR', 'UPS_SUREPOST_BPM_IRREGULAR', 'UPS_SUREPOST_MEDIA_IRREGULAR', 'UPS_MAILINNOVATIONS_FIRST', 'UPS_MAILINNOVATIONS_PRIORITY', 'UPS_MAILINNOVATIONS_MACHINABLE', 'UPS_MAILINNOVATIONS_LESS1LB', 'UPS_MAILINNOVATIONS_PARCELPOST', 'UPS_MAILINNOVATIONS_BPM_PARCEL', 'UPS_MAILINNOVATIONS_MEDIA', 'UPS_MAILINNOVATIONS_BPM_FLAT', 'UPS_MAILINNOVATIONS_STANDARD_FLAT', 'UPS_ST_CA', 'UPS_EXPRESS_EARLY_AM', 'UPS_EXPRESS', 'UPS_EXPRESS_SAVER', 'UPS_EXPEDITED'
UPS Intl:
'UPS_STANDARD', 'UPS_WORLDWIDE_EXPEDITED', 'UPS_WORLDWIDE_SAVER', 'UPS_WORLDWIDE_EXPRESS', 'UPS_WORLDWIDE_EXPRESS_PLUS', 'UPS_WORLDWIDE_EXPEDITED_ASIA', 'UPS_WORLDWIDE_SAVER_ASIA', 'UPS_WORLDWIDE_EXPRESS_ASIA', 'UPS_WORLDWIDE_EXPRESS_PLUS_ASIA', 'UPS_MAILINNOVATIONS_PRIORITY_INTERNATIONAL', 'UPS_MAILINNOVATIONS_ECONOMY_INTERNATIONAL', 'MIP/FLATS', 'MIE/FLATS', 'MIE/Machinables', 'MIE/Irregulars', 'MIE/BPM Parcels', 'MIE/Media Mail', 'MIE/BPM Flats', 'MIE/Standard Flats', 'UPS_WORLDWIDE_EXPRESS_PLUS_CANADA', 'UPS_WORLDWIDE_SAVER_CANADA', 'UPS_3DAY_SELECT_CANADA', 'UPS_WORLDWIDE_EXPEDITED_CANADA', 'UPS_WORLDWIDE_EXPRESS_CANADA'
DHL eCommerce:
'DHLEC_PACKET_IPA', 'DHLEC_PARCEL_DIRECT_INTL', 'DHLEC_PARCEL_DIRECT_MAX_CA', 'DHLEC_PARCEL_DIRECT', 'DHLEC_PARCEL_DIRECT_STANDARD_CA', 'DHLEC_PARCEL_STANDARD', 'DHLEC_BPM_EXPEDITED', 'DHLEC_BPM_GROUND', 'DHLEC_PARCELS_EXPEDITED', 'DHLEC_PARCELS_GROUND', 'DHLEC_PARCELS_EXPEDITED_MAX'
DHL Express:
'DHLE_DOMESTIC_EXPRESS', 'DHLE_ECONOMY_SELECT', 'DHLE_ECONOMYSELECT_A', 'DHLE_EUROPACK', 'DHLE_EXPRESS_1030AM', 'DHLE_EXPRESS1030AM_A', 'DHLE_EXPRESS_1200AM', 'DHLE_EXPRESS1200AM_A', 'DHLE_EXPRESS_9AM', 'DHLE_EXPRESS9AM_A', 'DHLE_EXPRESSENVELOPE', 'DHLE_EXPRESSENVELOPE_A', 'DHLE_EXPRESS_WORLDWIDE', 'DHLE_EXPRESSWORLDWIDE_A'
OnTrac:
'ONTRAC_SUNRISE_GOLD', 'ONTRAC_GROUND', 'ONTRAC_SUNRISE'
Amazon:
'AMAZON_SHIPPING_GROUND'
Estes:
'ESTES_GUARANTEED_BASIC', 'ESTES_GUARANTEED_EXCLUSIVE', 'ESTES_GUARANTEED_10AM', 'ESTES_GUARANTEED_12PM', 'ESTES_GUARANTEED_5PM', 'ESTES_GUARANTEED_ECONOMY', 'ESTES_GUARANTEED_STANDARD', 'ESTES_STANDARD'
Canada Post:
'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'
Purolator:
'PUROLATOR_EXPRESS', 'PUROLATOR_EXPRESS_10:30AM', 'PUROLATOR_EXPRESS_12PM', 'PUROLATOR_EXPRESS_9AM', 'PUROLATOR_EXPRESS_EVENING', 'PUROLATOR_EXPRESS_BOX', 'PUROLATOR_EXPRESS_BOX_10:30AM', 'PUROLATOR_EXPRESS_BOX_12PM', 'PUROLATOR_EXPRESS_BOX_9AM', 'PUROLATOR_EXPRESS_BOX_EVENING', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE_10:30AM', 'PUROLATOR_EXPRESS_ENVELOPE_12PM', 'PUROLATOR_EXPRESS_ENVELOPE_9AM', 'PUROLATOR_EXPRESS_ENVELOPE_EVENING', 'PUROLATOR_EXPRESS_PACK', 'PUROLATOR_EXPRESS_PACK_10:30AM', 'PUROLATOR_EXPRESS_PACK_12PM', 'PUROLATOR_EXPRESS_PACK_9AM', 'PUROLATOR_EXPRESS_PACK_EVENING', 'PurolatorFreight', 'PUROLATOR_GROUND', 'PUROLATOR_GROUND_10:30AM', 'PUROLATOR_GROUND_9AM', 'PUROLATOR_GROUND_EVENING'
Australia Post:
'AUPOST_AUEPARCEL', 'AUPOST_AUEXPRESS', 'AUPOST_AULARGELETTER', 'AUPOST_AULARGELETTERR', 'AUPOST_AUPARCELPOST', 'AUPOST_AUPARCELPOSTR', 'AUPOST_AUSMALLLETTER', 'AUPOST_AUSMALLLETTERR'\n ",
"type": "string"
},
"Weight": {
"$ref": "ref07f702756ae87a1ee2a7f8357ccd01da"
},
"Dimensions": {
"$ref": "ref48ee594915301e37caddcaf617d21c51"
},
"IdenticalPackageCount": {
"description": "Count of identical packages. Currently supported only for FedEx/UPS",
"type": "integer",
"minimum": 1
},
"Type": {
"$ref": "ref8bd46ee36ce60f78eeca8ca459f495aa"
},
"PackageItems": {
"description": "Items and their quantities inside the package. This information is required for certain marketplaces.",
"type": "array",
"items": {
"$ref": "ref67700ad872cc737e7b246385d084c0d7"
}
},
"Reference": {
"description": "This value will be printed on label. BBCODE placeholders can be used.",
"type": "string"
},
"InsuranceValue": {
"description": "Insurance Value.",
"type": "number"
},
"InsuranceFee": {
"description": "Insurance Fee. This value is ignored for input.",
"type": "number"
},
"Postage": {
"description": "Postage amount for shipped package. Do not fill this for normal open orders.",
"type": "number"
},
"TrackingInfo": {
"$ref": "refb397657fb92ce6ddbb0880c86ad7ac1a"
}
}
},
"refaf6a999faae7bb71db317916ba8ac2ae": {
"id": "refaf6a999faae7bb71db317916ba8ac2ae",
"properties": {
"Package": {
"$ref": "refa4431bfbb95206818b2ffcdb2dc48ae8"
},
"ShipDate": {
"description": "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.",
"type": "string"
},
"PostageAccount": {
"description": "Postage Account. Ignored on input.",
"type": "string"
}
}
},
"ref982337d362ac0742d74df2a7da23583e": {
"id": "ref982337d362ac0742d74df2a7da23583e",
"properties": {
"ProductPrice": {
"description": "Product Price",
"type": "number"
},
"Markup": {
"description": "Markup",
"type": "number"
},
"Handling": {
"description": "Handling",
"type": "number"
},
"Packing": {
"description": "Packing",
"type": "number"
}
}
},
"refbab8aa72aadf8d50a5a82566945e1389": {
"id": "refbab8aa72aadf8d50a5a82566945e1389",
"description": "Duties and Taxes data",
"required": [
"Role"
],
"properties": {
"Role": {
"description": "Role",
"type": "string",
"enum": [
"sender",
"recipient",
"third_party"
]
},
"AccountNumber": {
"description": "Account number",
"type": "string"
},
"AccountPostalCode": {
"description": "Account Postal Code. Currently UPS only",
"type": "string",
"maximum": 10
},
"AccountCountryCode": {
"description": "Account Country Code. Currently UPS only",
"type": "string",
"minimum": 2,
"maximum": 2
}
}
},
"ref356f529bb01c4f5b5b5a9855790252e5": {
"id": "ref356f529bb01c4f5b5b5a9855790252e5",
"description": "Delivery",
"properties": {
"Signature": {
"description": "Signature type",
"type": "string",
"enum": [
"NOT_REQUIRED",
"ANY_REQUIRED",
"ADULT_REQUIRED",
"DIRECT_REQUIRED",
"INDIRECT_REQUIRED",
"SERVICE_DEFAULT"
]
},
"Saturday": {
"description": "Saturday delivery",
"type": "integer"
},
"Sunday": {
"description": "Sunday delivery",
"type": "boolean"
},
"Holiday": {
"description": "Holiday delivery",
"type": "boolean"
},
"Weekend": {
"description": "Weekend delivery",
"type": "boolean"
},
"Am": {
"description": "AM delivery",
"type": "boolean"
},
"Restricted": {
"description": "Restricted area delivery",
"type": "boolean"
},
"Inside": {
"description": "Inside delivery",
"type": "boolean"
},
"Residential": {
"description": "Residential delivery",
"type": "integer"
},
"HomeDeliveryDate": {
"description": "Home delivery date",
"type": "string",
"format": "date"
},
"Instructions": {
"description": "Delivery Instructions, including HomeDelivery Instructions",
"type": "string"
},
"LiftGate": {
"description": "Lift gate",
"type": "boolean"
},
"LimitedAccess": {
"type": "boolean"
},
"ConstructionSite": {
"description": "Construction site",
"type": "boolean"
},
"CallBefore": {
"description": "Call before",
"type": "boolean"
}
}
},
"ref955693c0d6ac00d2d4fd5c678f01d8ff": {
"id": "ref955693c0d6ac00d2d4fd5c678f01d8ff",
"properties": {
"RegisteredMail": {
"description": "Registered mail",
"type": "boolean"
},
"AdditionalHandling": {
"description": "Additional handling",
"type": "boolean"
},
"ShipperRelease": {
"description": "Shipper Release",
"type": "boolean"
},
"CarbonNeutral": {
"description": "Carbon neutral",
"type": "boolean"
},
"DangerousGoods": {
"description": "Dangerous goods flag",
"type": "boolean"
},
"HandlingCharge": {
"description": "Handling charge",
"type": "boolean"
},
"ExtremeLength": {
"description": "Extreme length",
"type": "boolean"
},
"ReturnsClearance": {
"description": "Returns clearance",
"type": "boolean"
},
"Pickup": {
"description": "Pickup",
"type": "boolean"
}
}
},
"reffdfa44562f676aedb7333bd0fb721e75": {
"id": "reffdfa44562f676aedb7333bd0fb721e75",
"description": "Shipping Address structure",
"properties": {
"Name": {
"description": "Full person's name. Either Name or Company should be set",
"type": "string",
"maximum": 128
},
"Company": {
"description": "Company name. A valid address requires at least a Name or Company Name",
"type": "string",
"maximum": 127
},
"Street": {
"description": "Street address 1st line",
"type": "string",
"maximum": 255
},
"Street2": {
"description": "Street address 2nd line",
"type": "string",
"maximum": 255
},
"City": {
"description": "The city or town name.",
"type": "string",
"minimum": 1,
"maximum": 40
},
"State": {
"description": "State code or region name",
"type": "string",
"maximum": 40
},
"ZipCode": {
"description": "ZIP or Postal Code",
"type": "string"
},
"CountryCode": {
"description": "2 letter ISO code. Default US",
"type": "string",
"minimum": 2,
"maximum": 2
},
"FirstName": {
"description": "First Name. Do not specify both Name and First Name",
"type": "string",
"maximum": 128
},
"LastName": {
"description": "Last Name. Do not specify both Name and Last Name",
"type": "string",
"maximum": 128
},
"Country": {
"description": "Country name. Default United States",
"type": "string"
},
"PhoneNumber": {
"description": "Phone number in any format. Can be changed based on carrier",
"type": "string",
"maximum": 40
},
"Email": {
"description": "Email if known",
"type": "string"
}
}
},
"ref08ff9511f4a5e7c367a145fb56573e24": {
"id": "ref08ff9511f4a5e7c367a145fb56573e24",
"description": "C.O.D. details",
"properties": {
"Amount": {
"$ref": "ref9363d0ad3362299bf9e573650ac698bf"
},
"Kind": {
"description": "Kind",
"type": "string"
},
"CollectionType": {
"description": "Collection Type",
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
]
},
"Address": {
"$ref": "reffdfa44562f676aedb7333bd0fb721e75"
},
"ReferenceIndicator": {
"description": "Reference indicator",
"type": "string"
},
"TransportationChargesDetail": {
"description": "Transportation Charges Detail",
"type": "string",
"enum": [
"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": {
"description": "Recipient Account Number",
"type": "string"
},
"BillingOption": {
"description": "Billing Option",
"type": "string",
"enum": [
"Prepaid",
"Freight Collect"
]
}
}
},
"ref6155cec334db021c945bfa4edb40b999": {
"id": "ref6155cec334db021c945bfa4edb40b999",
"properties": {
"CompanyOrName": {
"description": "Company or Name",
"type": "string"
},
"ContactName": {
"description": "Contact Name",
"type": "string"
},
"Email": {
"description": "Email",
"type": "string"
},
"ShipNotify": {
"description": "Ship Notify",
"type": "boolean"
},
"ExceptionNotify": {
"description": "Exception Notify",
"type": "boolean"
},
"DeliveryNotify": {
"description": "Delivery Notify",
"type": "boolean"
},
"BolNotify": {
"description": "Bol Notify",
"type": "boolean"
},
"BolEmailSubject": {
"description": "Bol Email Subject",
"type": "string"
},
"BolEmailText": {
"description": "Bol Email Text",
"type": "string"
}
}
},
"ref76efa3d9fb59dd45b4bc35d38465862e": {
"id": "ref76efa3d9fb59dd45b4bc35d38465862e",
"properties": {
"Qvn": {
"description": "Qvn",
"type": "integer"
},
"From": {
"description": "From",
"type": "string"
},
"EmailOnFail": {
"description": "Email on fail",
"type": "string"
},
"Subject": {
"description": "Subject",
"type": "string"
},
"Memo": {
"description": "Memo",
"type": "string"
},
"Recipients": {
"description": "Qvn Recipients",
"type": "array",
"items": {
"$ref": "ref6155cec334db021c945bfa4edb40b999"
}
}
}
},
"reffe5264628c05d1b6ee060621cc6fc453": {
"id": "reffe5264628c05d1b6ee060621cc6fc453",
"description": "Handling",
"properties": {
"Charge": {
"description": "Handling Charge",
"type": "string"
},
"ChargeType": {
"description": "Handling Charge Type",
"type": "string"
},
"ChargeValue": {
"description": "Handling Charge Value",
"type": "string"
},
"Instructions": {
"description": "Instructions",
"type": "string"
}
}
},
"ref33ced5c9d1bfd07aa53e9892b1ae830f": {
"id": "ref33ced5c9d1bfd07aa53e9892b1ae830f",
"description": "UPS Dangerous Goods Data",
"properties": {
"Type": {
"type": "integer"
},
"Name": {
"description": "Dangerous Goods Name",
"type": "string",
"maximum": 40
},
"PhoneNumber": {
"description": "Dangerous Goods Phone Number",
"type": "string",
"maximum": 40
},
"PhoneExtension": {
"description": "Dangerous Goods Phone Extension",
"type": "string",
"maximum": 10
}
}
},
"ref0dcdf9e5b6cc5c4e7c9fd812120d6700": {
"id": "ref0dcdf9e5b6cc5c4e7c9fd812120d6700",
"properties": {
"Weekend": {
"description": "Weekend",
"type": "boolean"
},
"Holiday": {
"description": "Holiday",
"type": "boolean"
},
"Inside": {
"description": "Inside",
"type": "boolean"
},
"Residential": {
"description": "Residential",
"type": "boolean"
},
"LimitedAccess": {
"description": "Limited access",
"type": "boolean"
},
"LiftGate": {
"description": "Lift Gate Pickup Required",
"type": "boolean"
},
"Instructions": {
"description": "Instructions",
"type": "string"
}
}
},
"ref24568b42efbb5dcc2375e4ab1910b9f5": {
"id": "ref24568b42efbb5dcc2375e4ab1910b9f5",
"properties": {
"Class": {
"description": "Freight Class",
"type": "number"
},
"PackageType": {
"description": "Freight Package Type",
"type": "string"
},
"PackagesQuantity": {
"description": "Packages Quantity",
"type": "integer"
},
"PayerName": {
"description": "Payer Name",
"type": "string",
"maximum": 40
},
"PayerAddress": {
"description": "Payer Address",
"type": "string",
"maximum": 255
},
"PayerCity": {
"description": "Payer City",
"type": "string",
"maximum": 50
},
"PayerState": {
"description": "Payer State",
"type": "string",
"maximum": 50
},
"SortingAndSegregating": {
"description": "Sorting And Segregating",
"type": "boolean"
},
"SortingQuantity": {
"description": "Sorting Quantity",
"type": "string"
},
"ExtremeLength": {
"description": "Extreme Length",
"type": "boolean"
},
"FreezableProtection": {
"description": "Freezable Protection",
"type": "boolean"
},
"Handling": {
"$ref": "reffe5264628c05d1b6ee060621cc6fc453"
},
"DangerousGoods": {
"$ref": "ref33ced5c9d1bfd07aa53e9892b1ae830f"
},
"Pickup": {
"$ref": "ref0dcdf9e5b6cc5c4e7c9fd812120d6700"
}
}
},
"ref19199fef1591ff29d1cdd6550485705a": {
"id": "ref19199fef1591ff29d1cdd6550485705a",
"description": "UPS specific options",
"properties": {
"SurepostNonMachineable": {
"description": "UPS Surepost Non Machineable",
"type": "boolean"
},
"Qvn": {
"$ref": "ref76efa3d9fb59dd45b4bc35d38465862e"
},
"Freight": {
"$ref": "ref24568b42efbb5dcc2375e4ab1910b9f5"
}
}
},
"refa9568e97afeaa62c6a1459912af32731": {
"id": "refa9568e97afeaa62c6a1459912af32731",
"description": "Export detail",
"properties": {
"Kind": {
"type": "string"
},
"ForeignZoneCode": {
"type": "string"
},
"EntryNumber": {
"type": "string"
},
"LicenseNumber": {
"type": "string"
},
"ExpirationDate": {
"type": "string",
"format": "date"
}
}
},
"ref64ebec899c0c7060f9262df48b50b765": {
"id": "ref64ebec899c0c7060f9262df48b50b765",
"properties": {
"Type": {
"type": "string"
},
"Number": {
"type": "string"
}
}
},
"ref03ffa52698bcc97e1b5cf953d796ff3f": {
"id": "ref03ffa52698bcc97e1b5cf953d796ff3f",
"description": "Recipient",
"properties": {
"TaxId": {
"$ref": "ref64ebec899c0c7060f9262df48b50b765"
},
"CustomsId": {
"$ref": "ref64ebec899c0c7060f9262df48b50b765"
}
}
},
"ref33e6e6e0a72166ef1bd58b3a5a52b7ac": {
"id": "ref33e6e6e0a72166ef1bd58b3a5a52b7ac",
"description": "Hold At Location",
"properties": {
"Applied": {
"type": "string"
},
"Address": {
"type": "string"
},
"AddressType": {
"type": "string"
}
}
},
"refe36da84500293561965704188a2ae4fd": {
"id": "refe36da84500293561965704188a2ae4fd",
"description": "Instructions",
"properties": {
"Handling": {
"type": "string"
},
"Delivery": {
"type": "string"
},
"HomeDelivery": {
"type": "string"
},
"Pickup": {
"type": "string"
}
}
},
"refcd0b9f822af2011e710d9ed7117ad2b4": {
"id": "refcd0b9f822af2011e710d9ed7117ad2b4",
"description": "Freight",
"properties": {
"Class": {
"description": "Freight Class",
"type": "string",
"enum": [
"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": {
"description": "Freight Package Type",
"type": "string",
"enum": [
"BAG",
"BARREL",
"BASKET",
"BOX",
"BUCKET",
"BUNDLE",
"CARTON",
"CASE",
"CONTAINER",
"CRATE",
"CYLINDER",
"DRUM",
"ENVELOPE",
"HAMPER",
"OTHER",
"PAIL",
"PALLET",
"PIECE",
"REEL",
"ROLL",
"SKID",
"TANK",
"TUBE"
]
},
"PrintedReferenceType": {
"description": "Printed Reference Type",
"type": "string",
"enum": [
"BILL_OF_LADING",
"CONSIGNEE_ID_NUMBER",
"SHIPPER_ID_NUMBER"
]
},
"PrintedReferenceValue": {
"description": "Printed Reference Value",
"type": "string",
"maximum": 255
},
"GuaranteeDetailType": {
"description": "Freight Guarantee Detail Type",
"type": "string",
"enum": [
"GUARANTEED_DATE",
"GUARANTEED_MORNING"
]
},
"GuaranteeDetailDate": {
"description": "Freight Guarantee Detail Date",
"type": "string",
"format": "date"
},
"Note": {
"description": "Note",
"type": "string",
"maximum": 255
},
"FreightDirectType": {
"description": "Freight Direct Type",
"type": "string",
"maximum": 255
},
"FreightDirectTransportationType": {
"description": "Freight Direct Transportation Type",
"type": "string",
"maximum": 255
},
"FreightDirectEmail": {
"description": "Freight Direct Email",
"type": "string",
"maximum": 255
},
"FreightDirectPhoneType1": {
"description": "Freight Direct Phone Type 1",
"type": "string",
"maximum": 255
},
"FreightDirectPhoneNumber1": {
"description": "Freight Direct Phone Number 1",
"type": "string",
"maximum": 255
},
"FreightDirectPhoneType2": {
"description": "Freight Direct Phone Type 2",
"type": "string",
"maximum": 255
},
"FreightDirectPhoneNumber2": {
"description": "Freight Direct Phone Number 2",
"type": "string",
"maximum": 255
},
"FreightDirectPhoneType3": {
"description": "Freight Direct Phone Type 3",
"type": "string",
"maximum": 255
},
"FreightDirectPhoneNumber3": {
"description": "Freight Direct Phone Number 3",
"type": "string",
"maximum": 255
}
}
},
"ref2f7b0ecf7fe5b45f1df130f6c8db4f08": {
"id": "ref2f7b0ecf7fe5b45f1df130f6c8db4f08",
"description": "FedEx specific options",
"properties": {
"CustomsOption": {
"description": "Customs option",
"type": "string"
},
"Coverage": {
"type": "string"
},
"ExportDetail": {
"$ref": "refa9568e97afeaa62c6a1459912af32731"
},
"Recipient": {
"$ref": "ref03ffa52698bcc97e1b5cf953d796ff3f"
},
"HoldAtLocation": {
"$ref": "ref33e6e6e0a72166ef1bd58b3a5a52b7ac"
},
"SmartPostEndiciaType": {
"type": "string"
},
"TotalPalletWeight": {
"type": "number"
},
"FreightGuaranteeDetailDate": {
"type": "string"
},
"Delivery": {
"$ref": "ref356f529bb01c4f5b5b5a9855790252e5"
},
"Instructions": {
"$ref": "refe36da84500293561965704188a2ae4fd"
},
"Freight": {
"$ref": "refcd0b9f822af2011e710d9ed7117ad2b4"
},
"BillAccount": {
"type": "string"
},
"CollectTermsType": {
"type": "string"
},
"BrokerType": {
"type": "string"
},
"SignatureReleaseNumber": {
"type": "string"
},
"HandlingUnits": {
"type": "string"
},
"ExpressFreightBookingConfirmationNumber": {
"type": "string"
},
"B13aFilling": {
"type": "string"
},
"ExportStatement": {
"type": "string"
},
"ImportOfRecordAccountNumber": {
"type": "string"
}
}
},
"ref64594f9be29a4b332406fe1ea5f1dd28": {
"id": "ref64594f9be29a4b332406fe1ea5f1dd28",
"description": "DHLeC specific options",
"properties": {
"TermsOfTrade": {
"description": "Terms of Trade",
"type": "string",
"enum": [
"DDP",
"DAP"
]
},
"ConsigneeTaxIdType": {
"description": "Consignee Tax Id Type",
"type": "string",
"enum": [
"OTHER",
"GSTVAT",
"EORI",
"IOSS",
"TBD",
"PAN"
]
},
"ConsigneeTaxId": {
"description": "Consignee Tax Id",
"type": "string"
},
"ConsigneeIdType": {
"description": "Consignee Id Type",
"type": "string"
},
"ConsigneeId": {
"description": "Consignee Id",
"type": "string"
}
}
},
"reff88e691ffe148c8d809c329b462661b6": {
"id": "reff88e691ffe148c8d809c329b462661b6",
"description": "DHL Express specific options",
"properties": {
"DeliveryType": {
"description": "Delivery Type:\n NONE\n DD (Door to Door)\n DA (Door to Airport)\n AA (Airport to Airport)\n DC (Door to Door non- Compliant)",
"type": "string",
"enum": [
"NONE",
"DD",
"DA",
"AA",
"DC"
]
}
}
},
"ref2191e2efbb5c82c98047ba80b9935c32": {
"id": "ref2191e2efbb5c82c98047ba80b9935c32",
"description": "Shipment options",
"properties": {
"InsuranceType": {
"description": "Insurance Type",
"type": "string",
"enum": [
"none",
"teapplix",
"carrier"
]
},
"InsuranceClosed": {
"description": "Insurance Closed flag. Ignored on input.",
"type": "boolean"
},
"InsuranceClosedReason": {
"description": "Insurance Closed Reason message. Ignored on input.",
"type": "string"
},
"Billed": {
"$ref": "refbab8aa72aadf8d50a5a82566945e1389"
},
"DutyBilled": {
"$ref": "refbab8aa72aadf8d50a5a82566945e1389"
},
"SplitDutyVAT": {
"description": "Split Duty VAT",
"type": "boolean"
},
"Delivery": {
"$ref": "ref356f529bb01c4f5b5b5a9855790252e5"
},
"Service": {
"$ref": "ref955693c0d6ac00d2d4fd5c678f01d8ff"
},
"Cod": {
"$ref": "ref08ff9511f4a5e7c367a145fb56573e24"
},
"Ups": {
"$ref": "ref19199fef1591ff29d1cdd6550485705a"
},
"Fedex": {
"$ref": "ref2f7b0ecf7fe5b45f1df130f6c8db4f08"
},
"DHL": {
"$ref": "ref64594f9be29a4b332406fe1ea5f1dd28"
},
"DHLE": {
"$ref": "reff88e691ffe148c8d809c329b462661b6"
},
"ReasonForExport": {
"description": "DEPRECATED! Reason for export",
"type": "string",
"maximum": 20
}
}
},
"refe277621b56884370fa2fe4431dfff4e6": {
"id": "refe277621b56884370fa2fe4431dfff4e6",
"description": "Customs options",
"properties": {
"ReasonForExport": {
"type": "string",
"maximum": 20
},
"IOSSNumber": {
"description": "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.",
"type": "string"
},
"BrokerAddress": {
"description": "Broker Address",
"type": "string"
}
}
},
"ref69eb1b0eaa2273b93be6775513a00f0f": {
"id": "ref69eb1b0eaa2273b93be6775513a00f0f",
"required": [
"TxnId",
"To",
"OrderTotals",
"OrderDetails",
"OrderItems"
],
"properties": {
"TxnId": {
"description": "Unique id of an order in Teapplix. When we say teapplix order xxx, it often means TxnId=xxx",
"type": "string",
"maximum": 40
},
"ParentTxnId": {
"description": "For RMA and splilt orders, the parent orders txn id. On input only allowed on RMA and split orders.",
"type": "string"
},
"OriginalTxnId": {
"description": "Original order id from the marketplace or shopping cart. This is before Teapplix added prefixes etc to make them unique. Ignored on input.",
"type": "string"
},
"StoreType": {
"description": "Marketplace or shopping cart the order is from",
"type": "string",
"enum": [
"3dcart",
"3plcentral",
"Manual",
"RMA",
"aafes",
"academysports",
"acehardware",
"acenda",
"amazon",
"amzv",
"ashley",
"barnesnoble",
"basspro",
"belk",
"belkb2b",
"bestbuy",
"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",
"homedepot",
"homedepot2b",
"homedepotca",
"homedepotso",
"homehardware",
"houzz",
"hsn",
"jcpenney",
"kohls",
"lampsplus",
"lowes",
"lowes2b",
"lowesca",
"lowesm",
"macys",
"magento",
"magento2",
"menards",
"michaels",
"mirakl",
"newegg",
"neweggApi",
"neweggb2b",
"northerntool",
"opencart",
"opensky",
"orgill",
"oscommerce",
"paypal",
"petco",
"petsmart",
"pinnacle",
"prestashop",
"qbi",
"qbo",
"qbr",
"quill",
"qvc",
"rakuten",
"reverb",
"ruegilt",
"samsclub",
"sears",
"shein",
"shipstation",
"shopify",
"sparkpay",
"squarespace",
"staplesadvca",
"supplieroasis",
"target",
"target2b",
"temu",
"tiktok",
"tongtool",
"tophatter",
"tractorsupply",
"volusion",
"walmart",
"walmartdsv",
"walmartpo",
"wayfair",
"wish",
"woocommerce",
"wsonoma",
"xcart",
"xcart5",
"yahoo",
"zencart",
"zoro"
]
},
"StoreKey": {
"description": "Identify different stores for each store type:
\n Amazon and FBA stores
\n Required for this store types. Identify country code of Amazon or FBA store. Accept 2 characted country code, uppercase. E.g. US, CA, etc.
\n CommerceHub\n Required for this store type. Identify marketplace used to get orders via CommerceHub. Accept 2 to 5 characters code of marketplace
\n Enum {sears, rus, hd, gg, wm, dsg, hdso, hdca, lws, khl, qvc, iqvc, jcp, cst, bbb, evn, macy, hdsi, lwsca, bls}
\n Lowercase.
\n Rest store types\n Identify different stores within specific store type. Accept 3 character code set up on Teapplix Marketplace & Carts config.
\n Not required even if multiple-store config used. If not passed - interpreted as empty value key.\n ",
"type": "string"
},
"VSAccountID": {
"type": "string"
},
"SellerID": {
"description": "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",
"type": "string"
},
"OrderSource": {
"description": "Some channel, like shopify and channeladvisor download foreign orders. This optional string gives indication where order downloaded from.",
"type": "string"
},
"EbayBuyerID": {
"type": "string"
},
"PaymentStatus": {
"description": "Payment Status of the order. Normally this should be 'Completed'",
"type": "string",
"enum": [
"Completed",
"Cancelled",
"Refunded",
"PartialRefund"
]
},
"PaymentType": {
"description": "Payment type of the order (from pin.payment_type)",
"type": "string"
},
"LastUpdateDate": {
"type": "string"
},
"To": {
"$ref": "ref6ee81e82b13ed65ee13c36677c707bb1"
},
"BillTo": {
"$ref": "ref7aa882688649fbf5795c590e9f444faf"
},
"SkipAddressValidation": {
"description": "Normally the 'To' address is validated on 'POST' Order input. If SkipAddressValidation is set to true, this validation is skipped. Default false.",
"type": "boolean"
},
"OrderTotals": {
"$ref": "reff7ae7405b7fcacd6fea2f7ce1cb66f66"
},
"OrderDetails": {
"$ref": "refd1fdb1529ea3a2d4feda9587a3440360"
},
"OrderItems": {
"description": "Information related to the order\u2019s items",
"type": "array",
"items": {
"$ref": "ref45ed5d5f40993271a8ee973e25ac88b5"
}
},
"ShippingDetails": {
"description": "Information related to the order\u2019s 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.",
"type": "array",
"items": {
"$ref": "refaf6a999faae7bb71db317916ba8ac2ae"
}
},
"DropshipDetails": {
"$ref": "ref982337d362ac0742d74df2a7da23583e"
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsOptions": {
"$ref": "refe277621b56884370fa2fe4431dfff4e6"
},
"HandlingBy": {
"description": "Date before which the order is expected to be shipped out",
"type": "string"
},
"DeliverBy": {
"description": "Date by which the order is expected to arrive at the buyer",
"type": "string"
},
"SeqNumber": {
"type": "string"
},
"RMACode": {
"type": "string"
}
}
},
"refe12ec725713a55dc89d017e119866e5e": {
"id": "refe12ec725713a55dc89d017e119866e5e",
"description": "'APIToken' header should be included in each request",
"properties": {
"Operation": {
"description": "Requested operation",
"type": "string",
"enum": [
"DropShipRate",
"DropShipSubmit"
]
},
"Orders": {
"description": "Array of orders",
"type": "array",
"items": {
"$ref": "ref69eb1b0eaa2273b93be6775513a00f0f"
}
}
}
},
"refe7c6f50c58f89ea8bb836717be2179e0": {
"id": "refe7c6f50c58f89ea8bb836717be2179e0",
"required": [
"Name",
"Amount"
],
"properties": {
"Name": {
"description": "Name of the transportation fee",
"type": "string",
"maximum": 64
},
"Description": {
"description": "Description of this fee",
"type": "string",
"maximum": 255
},
"Amount": {
"description": "Amount of this fee",
"type": "number"
}
}
},
"ref8566b60bb1815857958edf4b7ece9320": {
"id": "ref8566b60bb1815857958edf4b7ece9320",
"required": [
"Transportation",
"TotalPackages",
"ProductsPrice",
"ProductsCount",
"Method",
"ShipClass"
],
"properties": {
"Transportation": {
"description": "Base transportation price",
"type": "number"
},
"ServiceAmount": {
"description": "The sum of all shipping service fees. This is not include transportation, packaging and handling fees",
"type": "number"
},
"ServiceFees": {
"description": "Detailed description of shipping fees. If set then ServiceAmount will be ignored (if present)",
"type": "array",
"items": {
"$ref": "refe7c6f50c58f89ea8bb836717be2179e0"
}
},
"Packing": {
"description": "The sum of packaging fees for an all items in the order",
"type": "number"
},
"Handling": {
"description": "The sum of handling fees for an all items in the order",
"type": "number"
},
"TotalPackages": {
"description": "Total packages count for this order",
"type": "integer",
"minimum": 1
},
"ProductsPrice": {
"description": "Total price of the all items in the order. This is not include transportation, packaging and handling fees",
"type": "number"
},
"ProductsCount": {
"description": "Total count of products for an order",
"type": "integer",
"minimum": 1
},
"Currency": {
"description": "The currency for this rate",
"type": "string"
},
"Method": {
"description": "Shipping method used to print label. One of \n
USPS:
'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'
USPS Intl:
'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'
USPS Presort:
'PB_PARCELSELECT_LIGHTWEIGHT_PACKAGE_PRESORT', 'PB_PARCELSELECT_PACKAGE_PRESORT', 'USPS_PARCELSELECT_LIGHTWEIGHT_PACKAGE_PRESORT', 'USPS_PARCELSELECT_PACKAGE_PRESORT'
FedEx:
'FEDEX_FREIGHT_1DAY', 'FEDEX_2DAY', 'FEDEX_2DAY_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_ONE_RATE_PAK', 'FEDEX_2DAY_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_TUBE', 'FEDEX_2DAY_AM', 'FEDEX_2DAYAM_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_AM_ONE_RATE_PAK', 'FEDEX_2DAY_AM_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_TUBE', 'FEDEX_FREIGHT_2DAY', 'FEDEX_FREIGHT_3DAY', 'Economy', 'FEDEX_FREIGHT_ECONOMY', 'FEDEX_EXPRESS_SAVER', 'FEDEX_EXPRESS_SAVER_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_MEDIUM_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_PAK', 'FEDEX_EXPRESS_SAVER_ONE_RATE_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_TUBE', 'FEDEX_FREIGHT_FIRST', 'FEDEX_FIRST_OVERNIGHT', 'FEDEX_FIRST_OVERNIGHT_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_GROUND', 'FEDEX_HOME', 'FEDEX_CONNECT_PLUS_INTERNATIONAL', 'FEDEX_ECONOMY_INTERNATIONAL', 'FEDEX_FREIGHT_ECONOMY_INTERNATIONAL', 'FEDEX_FIRST_OVERNIGHT_INTERNATIONAL', 'FEDEX_INTLGROUNDCONSOLIDATION', 'FEDEX_PRIORITY_EXPRESS_INTERNATIONAL', 'FEDEX_FREIGHT_PRIORITY_INTERNATIONAL', 'FEDEX_PRIORITY_OVERNIGHT_INTERNATIONAL', 'FEDEX_FREIGHT_PRIORITY', 'FEDEX_PRIORITY_OVERNIGHT', 'FEDEX_PRIORITY_OVERNIGHT_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_SMART_POST', 'FEDEX_STANDARD_OVERNIGHT', 'FEDEX_STANDARDOVERNIGHT_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_TUBE'
UPS:
'UPS_GROUND', 'UPS_3DAY_SELECT', 'UPS_2DAY_AIR', 'UPS_2DAY_AIR_AM', 'UPS_NEXT_DAY_AIR_SAVER', 'UPS_NEXT_DAY_AIR', 'UPS_NEXT_DAY_AIR_EARLY_AM', '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_SUREPOST_LESS1LB', 'UPS_SUREPOST_LESS1LB_IRREGULAR', 'UPS_SUREPOST_1LB_OR_GREATER_MACHINABLE', 'UPS_SUREPOST_MORE1LB_IRREGULAR', 'UPS_SUREPOST_BPM_IRREGULAR', 'UPS_SUREPOST_MEDIA_IRREGULAR', 'UPS_MAILINNOVATIONS_FIRST', 'UPS_MAILINNOVATIONS_PRIORITY', 'UPS_MAILINNOVATIONS_MACHINABLE', 'UPS_MAILINNOVATIONS_LESS1LB', 'UPS_MAILINNOVATIONS_PARCELPOST', 'UPS_MAILINNOVATIONS_BPM_PARCEL', 'UPS_MAILINNOVATIONS_MEDIA', 'UPS_MAILINNOVATIONS_BPM_FLAT', 'UPS_MAILINNOVATIONS_STANDARD_FLAT', 'UPS_ST_CA', 'UPS_EXPRESS_EARLY_AM', 'UPS_EXPRESS', 'UPS_EXPRESS_SAVER', 'UPS_EXPEDITED'
UPS Intl:
'UPS_STANDARD', 'UPS_WORLDWIDE_EXPEDITED', 'UPS_WORLDWIDE_SAVER', 'UPS_WORLDWIDE_EXPRESS', 'UPS_WORLDWIDE_EXPRESS_PLUS', 'UPS_WORLDWIDE_EXPEDITED_ASIA', 'UPS_WORLDWIDE_SAVER_ASIA', 'UPS_WORLDWIDE_EXPRESS_ASIA', 'UPS_WORLDWIDE_EXPRESS_PLUS_ASIA', 'UPS_MAILINNOVATIONS_PRIORITY_INTERNATIONAL', 'UPS_MAILINNOVATIONS_ECONOMY_INTERNATIONAL', 'MIP/FLATS', 'MIE/FLATS', 'MIE/Machinables', 'MIE/Irregulars', 'MIE/BPM Parcels', 'MIE/Media Mail', 'MIE/BPM Flats', 'MIE/Standard Flats', 'UPS_WORLDWIDE_EXPRESS_PLUS_CANADA', 'UPS_WORLDWIDE_SAVER_CANADA', 'UPS_3DAY_SELECT_CANADA', 'UPS_WORLDWIDE_EXPEDITED_CANADA', 'UPS_WORLDWIDE_EXPRESS_CANADA'
DHL eCommerce:
'DHLEC_PACKET_IPA', 'DHLEC_PARCEL_DIRECT_INTL', 'DHLEC_PARCEL_DIRECT_MAX_CA', 'DHLEC_PARCEL_DIRECT', 'DHLEC_PARCEL_DIRECT_STANDARD_CA', 'DHLEC_PARCEL_STANDARD', 'DHLEC_BPM_EXPEDITED', 'DHLEC_BPM_GROUND', 'DHLEC_PARCELS_EXPEDITED', 'DHLEC_PARCELS_GROUND', 'DHLEC_PARCELS_EXPEDITED_MAX'
DHL Express:
'DHLE_DOMESTIC_EXPRESS', 'DHLE_ECONOMY_SELECT', 'DHLE_ECONOMYSELECT_A', 'DHLE_EUROPACK', 'DHLE_EXPRESS_1030AM', 'DHLE_EXPRESS1030AM_A', 'DHLE_EXPRESS_1200AM', 'DHLE_EXPRESS1200AM_A', 'DHLE_EXPRESS_9AM', 'DHLE_EXPRESS9AM_A', 'DHLE_EXPRESSENVELOPE', 'DHLE_EXPRESSENVELOPE_A', 'DHLE_EXPRESS_WORLDWIDE', 'DHLE_EXPRESSWORLDWIDE_A'
OnTrac:
'ONTRAC_SUNRISE_GOLD', 'ONTRAC_GROUND', 'ONTRAC_SUNRISE'
Amazon:
'AMAZON_SHIPPING_GROUND'
Estes:
'ESTES_GUARANTEED_BASIC', 'ESTES_GUARANTEED_EXCLUSIVE', 'ESTES_GUARANTEED_10AM', 'ESTES_GUARANTEED_12PM', 'ESTES_GUARANTEED_5PM', 'ESTES_GUARANTEED_ECONOMY', 'ESTES_GUARANTEED_STANDARD', 'ESTES_STANDARD'
Canada Post:
'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'
Purolator:
'PUROLATOR_EXPRESS', 'PUROLATOR_EXPRESS_10:30AM', 'PUROLATOR_EXPRESS_12PM', 'PUROLATOR_EXPRESS_9AM', 'PUROLATOR_EXPRESS_EVENING', 'PUROLATOR_EXPRESS_BOX', 'PUROLATOR_EXPRESS_BOX_10:30AM', 'PUROLATOR_EXPRESS_BOX_12PM', 'PUROLATOR_EXPRESS_BOX_9AM', 'PUROLATOR_EXPRESS_BOX_EVENING', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE_10:30AM', 'PUROLATOR_EXPRESS_ENVELOPE_12PM', 'PUROLATOR_EXPRESS_ENVELOPE_9AM', 'PUROLATOR_EXPRESS_ENVELOPE_EVENING', 'PUROLATOR_EXPRESS_PACK', 'PUROLATOR_EXPRESS_PACK_10:30AM', 'PUROLATOR_EXPRESS_PACK_12PM', 'PUROLATOR_EXPRESS_PACK_9AM', 'PUROLATOR_EXPRESS_PACK_EVENING', 'PurolatorFreight', 'PUROLATOR_GROUND', 'PUROLATOR_GROUND_10:30AM', 'PUROLATOR_GROUND_9AM', 'PUROLATOR_GROUND_EVENING'
Australia Post:
'AUPOST_AUEPARCEL', 'AUPOST_AUEXPRESS', 'AUPOST_AULARGELETTER', 'AUPOST_AULARGELETTERR', 'AUPOST_AUPARCELPOST', 'AUPOST_AUPARCELPOSTR', 'AUPOST_AUSMALLLETTER', 'AUPOST_AUSMALLLETTERR'\n ",
"type": "string"
},
"ShipClass": {
"description": "Ship class",
"type": "string",
"enum": [
"Economy",
"Standard",
"Expedited",
"SecondDay",
"OneDay",
"IntlStandard",
"IntlExpedited",
"IntlEconomy"
]
}
}
},
"refedebb232532122a5cf129381625113ce": {
"id": "refedebb232532122a5cf129381625113ce",
"required": [
"TxnId",
"Status"
],
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maximum": 40
},
"Status": {
"description": "Submission status of the given order:\n * 'Accepted' \u2013 order was accepted successfully\n * 'Declined' \u2013 order was declined\n * 'Exists' \u2013 order with specified TxnId already exists\n * 'Processed' - order was processed successfully",
"type": "string",
"enum": [
"Accepted",
"Declined",
"Exists",
"Processed"
]
},
"DeclineReason": {
"description": "Required if order status is 'Declined'",
"type": "string",
"enum": [
"InvalidSKU",
"NoInventory",
"InsufficientFunds",
"Other"
]
},
"DeclineReasonDetails": {
"description": "Required if DeclineReason is 'Other'",
"type": "string",
"maximum": 255
},
"DropShipRates": {
"description": "Information related to the rate of the shipment. Required if ComputePostage enabled and order was accepted.",
"type": "array",
"items": {
"$ref": "ref8566b60bb1815857958edf4b7ece9320"
}
},
"ShippingDetails": {
"description": "Information related to the order\u2019s shipments",
"type": "array",
"items": {
"$ref": "refaf6a999faae7bb71db317916ba8ac2ae"
}
}
}
},
"refbb574ff4894243cabc41e700a5ff0038": {
"id": "refbb574ff4894243cabc41e700a5ff0038",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refedebb232532122a5cf129381625113ce"
}
}
}
},
"OrderDropShip-POST-request": {
"id": "OrderDropShip-POST-request",
"description": "'APIToken' header should be included in each request",
"properties": {
"Operation": {
"description": "Requested operation",
"type": "string",
"enum": [
"DropShipRate",
"DropShipSubmit"
]
},
"Orders": {
"description": "Array of orders",
"type": "array",
"items": {
"$ref": "ref69eb1b0eaa2273b93be6775513a00f0f"
}
}
}
},
"OrderDropShip-POST-200-response": {
"id": "OrderDropShip-POST-200-response",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refedebb232532122a5cf129381625113ce"
}
}
}
},
"OrderDropShip-POST-400-response": {
"id": "OrderDropShip-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderDropShip-POST-401-response": {
"id": "OrderDropShip-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderDropShip-POST-500-response": {
"id": "OrderDropShip-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref1d7bfcc0c58622c8a7e89e63487f40b0": {
"id": "ref1d7bfcc0c58622c8a7e89e63487f40b0",
"properties": {
"TxnId": {
"description": "TxnId of order. Use this parameter to download only one order.",
"type": "string"
},
"StoreType": {
"description": "Store Type.",
"type": "string"
},
"StoreKey": {
"description": "Store Key.",
"type": "string"
},
"SellerId": {
"description": "Seller ID.",
"type": "string"
},
"SeqStart": {
"description": "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.",
"type": "string"
},
"SeqEnd": {
"description": "Ending Unique Id for order sequence (inclusive)",
"type": "string"
},
"Invoice": {
"description": "Invoice number (reference number, marketplace order number)",
"type": "string"
},
"PaymentDateStart": {
"description": "Starting payment date to filter, e.g. PaymentDateStart=2012/01/01 => for orders with payment date >= 2012/01/01 (inclusive)",
"type": "string"
},
"PaymentDateEnd": {
"description": "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)",
"type": "string"
},
"UpdateDateStart": {
"description": "Starting update date to filter, e.g. UpdateDateStart=2019/01/01 => for orders with update date >= 2019/01/01",
"type": "string"
},
"UpdateDateEnd": {
"description": "Ending update date to filter, e.g. UpdateDateEnd=2019/01/31 => for orders with update date <= 2019/01/31",
"type": "string"
},
"ShipDateStart": {
"description": "Ship Date Start (inclusive)",
"type": "string"
},
"ShipDateEnd": {
"description": "Ship Date End (inclusive)",
"type": "string"
},
"PaymentStatus": {
"description": "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.",
"type": "string"
},
"Shipped": {
"description": "Shipped flag (0|1), if you pass this flag, we will only give 'shipped' orders for 1 and only 'open' orders for 0",
"type": "integer"
},
"NotShipped": {
"description": "Deprecated, use 'Shipped' instead. If you pass this flag, we will only give 'open' orders for 1 and 'shipped' order for 0",
"type": "integer"
},
"QueueId": {
"description": "Queue Id, QueueId=0 => for orders with Normal queue; QueueId=3 => for orders with QueueId == 3 (integer; optional)",
"type": "integer"
},
"WarehouseId": {
"description": "Warehouse Id",
"type": "string"
},
"Combine": {
"description": "Combine option (default = combine). The orders selected under these 3 modes are different:
combine: 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
original: 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.
all: all orders, including combined results, cancelled orders, etc, will be in the result.",
"type": "string"
},
"VSAccountID": {
"description": "Virtual Seller AccountID.",
"type": "string"
},
"DetailLevel": {
"description": "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",
"type": "string"
},
"PageSize": {
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"type": "string"
},
"PageNumber": {
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"type": "string"
},
"Tag": {
"description": "Filter by order tag name. Comma-separate multiple tag names to match orders that have any of the given tags.",
"type": "string"
}
}
},
"refba80fb7a06401475065f21091c9c4f65": {
"id": "refba80fb7a06401475065f21091c9c4f65",
"description": "Order totals",
"properties": {
"Shipping": {
"description": "Shipping cost",
"type": "number"
},
"Handling": {
"description": "Handling",
"type": "number"
},
"Discount": {
"description": "Discount amount",
"type": "number"
},
"Tax": {
"description": "Tax amount",
"type": "number"
},
"InsuranceType": {
"description": "Insurance Type. This tag is deprecated. Please use Options/IsuranceType tag instead.",
"type": "string",
"enum": [
"none",
"teapplix",
"carrier"
]
},
"Currency": {
"description": "Order currency",
"type": "string"
},
"PostageCurrency": {
"description": "Postage currency",
"type": "string"
},
"Fee": {
"description": "Fee amount",
"type": "number"
},
"Total": {
"description": "Total amount",
"type": "number"
}
}
},
"ref188871a226ebdc39a781cc85d94288ee": {
"id": "ref188871a226ebdc39a781cc85d94288ee",
"properties": {
"Invoice": {
"description": "If the order matches an invoice, the unique id of the invoice.",
"type": "string",
"maximum": 127
},
"PaymentDate": {
"description": "Date of payment. Format Y-m-D H:i:s or Y-m-d. If not set - current date time will be used",
"type": "string"
},
"Memo": {
"description": "This is memo from the buyer left when placing the order",
"type": "string",
"maximum": 2048
},
"PrivateMemo": {
"description": "This is memo that seller placed on the order to help with processing. This is not from the buyer",
"type": "string",
"maximum": 2048
},
"GiftMessage": {
"description": "Gift message",
"type": "string",
"maximum": 2048
},
"WarehouseId": {
"description": "The id of the teapplix warehouse this order is assigned to",
"type": "integer"
},
"WarehouseName": {
"description": "The name of the teapplix warehouse this order is assigned to",
"type": "string"
},
"QueueId": {
"description": "The id of the teapplix order queue this order is assigned to.",
"type": "integer"
},
"TagList": {
"description": "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.",
"type": "array",
"items": {
"type": "string"
}
},
"ShipClass": {
"description": "Ship class typically indicate the level of shipping speed the order should have",
"type": "string"
},
"Custom": {
"description": "Custom",
"type": "string",
"maximum": 255
},
"Custom2": {
"description": "Custom2",
"type": "string",
"maximum": 255
},
"Custom3": {
"description": "Custom3",
"type": "string",
"maximum": 255
},
"Custom4": {
"description": "Custom4",
"type": "string",
"maximum": 255
}
}
},
"ref4a186d0d8d5f062c6197dae0d62d0363": {
"id": "ref4a186d0d8d5f062c6197dae0d62d0363",
"description": "Mark Shipped Status",
"properties": {
"Status": {
"description": "Shipped status of the order.
\n 1: Order successfully marked as shipped
\n -1: Failed to mark order as shipped
\n 0: Order not yet marked as shipped",
"type": "integer"
}
}
},
"refb271c0c504610a766cad4f7f919b7d9f": {
"id": "refb271c0c504610a766cad4f7f919b7d9f",
"description": "The external status of the order: being reviewed after shipping label generated, tracking upload to marketplace, and invoices etc.",
"properties": {
"Reviewed": {
"$ref": "ref4a186d0d8d5f062c6197dae0d62d0363"
},
"MarkShipped": {
"$ref": "ref4a186d0d8d5f062c6197dae0d62d0363"
}
}
},
"reff192b0f54ba6a550250ab43829ca8633": {
"id": "reff192b0f54ba6a550250ab43829ca8633",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maximum": 40
},
"ParentTxnId": {
"description": "For RMA and splilt orders, the parent orders txn id. On input only allowed on RMA and split orders.",
"type": "string"
},
"OriginalTxnId": {
"description": "Original order id from the marketplace or shopping cart. This is before Teapplix added prefixes etc to make them unique. Ignored on input.",
"type": "string"
},
"StoreType": {
"description": "Marketplace or shopping cart the order is from",
"type": "string",
"enum": [
"__ALL_STORE_TYPES__"
]
},
"StoreKey": {
"description": "Identify different stores for each store type:
\n Amazon and FBA stores
\n Required for this store types. Identify country code of Amazon or FBA store. Accept 2 characted country code, uppercase. E.g. US, CA, etc.
\n CommerceHub\n Required for this store type. Identify marketplace used to get orders via CommerceHub. Accept 2 to 5 characters code of marketplace
\n Enum {sears, rus, hd, gg, wm, dsg, hdso, hdca, lws, khl, qvc, iqvc, jcp, cst, bbb, evn, macy, hdsi, lwsca, bls}
\n Lowercase.
\n Rest store types\n Identify different stores within specific store type. Accept 3 character code set up on Teapplix Marketplace & Carts config.
\n Not required even if multiple-store config used. If not passed - interpreted as empty value key.\n ",
"type": "string"
},
"VSAccountID": {
"type": "string"
},
"SellerID": {
"description": "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",
"type": "string"
},
"OrderSource": {
"description": "Some channel, like shopify and channeladvisor download foreign orders. This optional string gives indication where order downloaded from.",
"type": "string"
},
"EbayBuyerID": {
"type": "string"
},
"PaymentStatus": {
"description": "Payment Status of the order. Normally this should be 'Completed'",
"type": "string",
"enum": [
"Completed",
"Cancelled",
"Refunded",
"PartialRefund"
]
},
"PaymentType": {
"description": "Payment type of the order (from pin.payment_type)",
"type": "string"
},
"LastUpdateDate": {
"type": "string"
},
"To": {
"$ref": "reffdfa44562f676aedb7333bd0fb721e75"
},
"BillTo": {
"$ref": "ref7aa882688649fbf5795c590e9f444faf"
},
"SkipAddressValidation": {
"description": "Normally the 'To' address is validated on 'POST' Order input. If SkipAddressValidation is set to true, this validation is skipped. Default false.",
"type": "boolean"
},
"OrderTotals": {
"$ref": "refba80fb7a06401475065f21091c9c4f65"
},
"OrderDetails": {
"$ref": "ref188871a226ebdc39a781cc85d94288ee"
},
"OrderItems": {
"description": "Information related to the order\u2019s items",
"type": "array",
"items": {
"$ref": "ref45ed5d5f40993271a8ee973e25ac88b5"
}
},
"ShippingDetails": {
"description": "Information related to the order\u2019s 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.",
"type": "array",
"items": {
"$ref": "refaf6a999faae7bb71db317916ba8ac2ae"
}
},
"DropshipDetails": {
"$ref": "ref982337d362ac0742d74df2a7da23583e"
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsOptions": {
"$ref": "refe277621b56884370fa2fe4431dfff4e6"
},
"HandlingBy": {
"description": "Date before which the order is expected to be shipped out",
"type": "string"
},
"DeliverBy": {
"description": "Date by which the order is expected to arrive at the buyer",
"type": "string"
},
"SeqNumber": {
"description": "Unique integer assigned to each order as they are created. Increases",
"type": "string"
},
"RMACode": {
"description": "Type of RMA",
"type": "string"
},
"MarketplaceStatus": {
"$ref": "refb271c0c504610a766cad4f7f919b7d9f"
}
}
},
"refe57caad9ceb11b8736dc5ff1616e2a20": {
"id": "refe57caad9ceb11b8736dc5ff1616e2a20",
"description": "Declares pagination data",
"properties": {
"PageSize": {
"description": "Current Page Size",
"type": "integer"
},
"PageNumber": {
"description": "Current Page Number. Increase it to get next set of data until you get empty items list.",
"type": "integer"
},
"TotalPages": {
"description": "Total Pages",
"type": "integer"
},
"Warning": {
"description": "Warning message",
"type": "string"
}
}
},
"ref6fac079fc98c653a083a013d9ea2127c": {
"id": "ref6fac079fc98c653a083a013d9ea2127c",
"required": [
"Orders"
],
"properties": {
"Orders": {
"type": "array",
"items": {
"$ref": "reff192b0f54ba6a550250ab43829ca8633"
}
},
"Pagination": {
"$ref": "refe57caad9ceb11b8736dc5ff1616e2a20"
}
}
},
"refc98e2464fbc8f07c259391d410527163": {
"id": "refc98e2464fbc8f07c259391d410527163",
"description": "'APIToken' header should be included in each request",
"properties": {
"Operation": {
"description": "Requested operation",
"type": "string",
"enum": [
"Submit"
]
},
"Orders": {
"description": "Array of orders",
"type": "array",
"items": {
"$ref": "ref69eb1b0eaa2273b93be6775513a00f0f"
}
}
}
},
"refed98c3fa3d8b48f59b990b936f1cf609": {
"id": "refed98c3fa3d8b48f59b990b936f1cf609",
"required": [
"TxnId",
"Success",
"Status"
],
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maximum": 40
},
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Status": {
"description": "This field is DEPRECATED and will be removed soon. Please make changes to your API code accordingly.\n * Submission status of the given order:\n * 'Accepted' \u2013 order was accepted successfully\n * 'Declined' \u2013 order was declined\n * 'Exists' \u2013 order with specified TxnId already exists\n * 'Processed' - order was processed successfully",
"type": "string",
"enum": [
"Accepted",
"Declined",
"Exists",
"Processed"
]
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Detailed message. Typically associated with errors",
"type": "string",
"maximum": 255
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref6f85068d8ae7ad5b1dfab78785898272": {
"id": "ref6f85068d8ae7ad5b1dfab78785898272",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refed98c3fa3d8b48f59b990b936f1cf609"
}
}
}
},
"ref6de364985019ec28214c29f9e5aba2ea": {
"id": "ref6de364985019ec28214c29f9e5aba2ea",
"required": [
"Text"
],
"properties": {
"Text": {
"description": "Memo text",
"type": "string",
"maximum": 2048
},
"AppendMode": {
"description": "If true - appends text to current order Memo. Default false.",
"type": "boolean"
}
}
},
"ref3962a1edfa90b218683651b86f139326": {
"id": "ref3962a1edfa90b218683651b86f139326",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maximum": 40
},
"PaymentStatus": {
"type": "string",
"enum": [
"Completed",
"Cancelled",
"Refunded",
"PartialRefund"
]
},
"To": {
"$ref": "reffdfa44562f676aedb7333bd0fb721e75"
},
"OrderItems": {
"description": "Information related to the order\u2019s items",
"type": "array",
"items": {
"$ref": "ref45ed5d5f40993271a8ee973e25ac88b5"
}
},
"QueueId": {
"type": "integer"
},
"TagList": {
"description": "Order\u2019s tags list",
"type": "array",
"items": {
"type": "string"
}
},
"WarehouseId": {
"type": "integer"
},
"Memo": {
"$ref": "ref6de364985019ec28214c29f9e5aba2ea"
},
"Custom": {
"description": "Custom",
"type": "string",
"maximum": 255
},
"Custom2": {
"description": "Custom2",
"type": "string",
"maximum": 255
}
}
},
"refac3b3da5a33716f5cdc0e8b02ffb2b53": {
"id": "refac3b3da5a33716f5cdc0e8b02ffb2b53",
"description": "'APIToken' header should be included in each request",
"properties": {
"Orders": {
"description": "Array of orders to update",
"type": "array",
"items": {
"$ref": "ref3962a1edfa90b218683651b86f139326"
}
}
}
},
"OrderNotification-GET-query": {
"id": "OrderNotification-GET-query",
"properties": {
"TxnId": {
"description": "TxnId of order. Use this parameter to download only one order.",
"type": "string"
},
"StoreType": {
"description": "Store Type.",
"type": "string"
},
"StoreKey": {
"description": "Store Key.",
"type": "string"
},
"SellerId": {
"description": "Seller ID.",
"type": "string"
},
"SeqStart": {
"description": "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.",
"type": "string"
},
"SeqEnd": {
"description": "Ending Unique Id for order sequence (inclusive)",
"type": "string"
},
"Invoice": {
"description": "Invoice number (reference number, marketplace order number)",
"type": "string"
},
"PaymentDateStart": {
"description": "Starting payment date to filter, e.g. PaymentDateStart=2012/01/01 => for orders with payment date >= 2012/01/01 (inclusive)",
"type": "string"
},
"PaymentDateEnd": {
"description": "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)",
"type": "string"
},
"UpdateDateStart": {
"description": "Starting update date to filter, e.g. UpdateDateStart=2019/01/01 => for orders with update date >= 2019/01/01",
"type": "string"
},
"UpdateDateEnd": {
"description": "Ending update date to filter, e.g. UpdateDateEnd=2019/01/31 => for orders with update date <= 2019/01/31",
"type": "string"
},
"ShipDateStart": {
"description": "Ship Date Start (inclusive)",
"type": "string"
},
"ShipDateEnd": {
"description": "Ship Date End (inclusive)",
"type": "string"
},
"PaymentStatus": {
"description": "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.",
"type": "string"
},
"Shipped": {
"description": "Shipped flag (0|1), if you pass this flag, we will only give 'shipped' orders for 1 and only 'open' orders for 0",
"type": "integer"
},
"NotShipped": {
"description": "Deprecated, use 'Shipped' instead. If you pass this flag, we will only give 'open' orders for 1 and 'shipped' order for 0",
"type": "integer"
},
"QueueId": {
"description": "Queue Id, QueueId=0 => for orders with Normal queue; QueueId=3 => for orders with QueueId == 3 (integer; optional)",
"type": "integer"
},
"WarehouseId": {
"description": "Warehouse Id",
"type": "string"
},
"Combine": {
"description": "Combine option (default = combine). The orders selected under these 3 modes are different:
combine: 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
original: 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.
all: all orders, including combined results, cancelled orders, etc, will be in the result.",
"type": "string"
},
"VSAccountID": {
"description": "Virtual Seller AccountID.",
"type": "string"
},
"DetailLevel": {
"description": "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",
"type": "string"
},
"PageSize": {
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"type": "string"
},
"PageNumber": {
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"type": "string"
},
"Tag": {
"description": "Filter by order tag name. Comma-separate multiple tag names to match orders that have any of the given tags.",
"type": "string"
}
}
},
"OrderNotification-GET-200-response": {
"id": "OrderNotification-GET-200-response",
"required": [
"Orders"
],
"properties": {
"Orders": {
"type": "array",
"items": {
"$ref": "reff192b0f54ba6a550250ab43829ca8633"
}
},
"Pagination": {
"$ref": "refe57caad9ceb11b8736dc5ff1616e2a20"
}
}
},
"OrderNotification-GET-400-response": {
"id": "OrderNotification-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderNotification-GET-401-response": {
"id": "OrderNotification-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderNotification-GET-500-response": {
"id": "OrderNotification-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderNotification-POST-request": {
"id": "OrderNotification-POST-request",
"description": "'APIToken' header should be included in each request",
"properties": {
"Operation": {
"description": "Requested operation",
"type": "string",
"enum": [
"Submit"
]
},
"Orders": {
"description": "Array of orders",
"type": "array",
"items": {
"$ref": "ref69eb1b0eaa2273b93be6775513a00f0f"
}
}
}
},
"OrderNotification-POST-200-response": {
"id": "OrderNotification-POST-200-response",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refed98c3fa3d8b48f59b990b936f1cf609"
}
}
}
},
"OrderNotification-POST-400-response": {
"id": "OrderNotification-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderNotification-POST-401-response": {
"id": "OrderNotification-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderNotification-POST-500-response": {
"id": "OrderNotification-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderNotification-PUT-request": {
"id": "OrderNotification-PUT-request",
"description": "'APIToken' header should be included in each request",
"properties": {
"Orders": {
"description": "Array of orders to update",
"type": "array",
"items": {
"$ref": "ref3962a1edfa90b218683651b86f139326"
}
}
}
},
"OrderNotification-PUT-200-response": {
"id": "OrderNotification-PUT-200-response",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refed98c3fa3d8b48f59b990b936f1cf609"
}
}
}
},
"OrderNotification-PUT-400-response": {
"id": "OrderNotification-PUT-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderNotification-PUT-401-response": {
"id": "OrderNotification-PUT-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderNotification-PUT-500-response": {
"id": "OrderNotification-PUT-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref30651b110bc94954a0f7d4b22c0fdd91": {
"id": "ref30651b110bc94954a0f7d4b22c0fdd91",
"description": "Declares packages to be shipped",
"required": [
"Method"
],
"properties": {
"Method": {
"description": "Shipping method used to print label. One of \n
USPS:
'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'
USPS Intl:
'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'
USPS Presort:
'PB_PARCELSELECT_LIGHTWEIGHT_PACKAGE_PRESORT', 'PB_PARCELSELECT_PACKAGE_PRESORT', 'USPS_PARCELSELECT_LIGHTWEIGHT_PACKAGE_PRESORT', 'USPS_PARCELSELECT_PACKAGE_PRESORT'
FedEx:
'FEDEX_FREIGHT_1DAY', 'FEDEX_2DAY', 'FEDEX_2DAY_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_ONE_RATE_PAK', 'FEDEX_2DAY_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_TUBE', 'FEDEX_2DAY_AM', 'FEDEX_2DAYAM_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_AM_ONE_RATE_PAK', 'FEDEX_2DAY_AM_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_TUBE', 'FEDEX_FREIGHT_2DAY', 'FEDEX_FREIGHT_3DAY', 'Economy', 'FEDEX_FREIGHT_ECONOMY', 'FEDEX_EXPRESS_SAVER', 'FEDEX_EXPRESS_SAVER_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_MEDIUM_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_PAK', 'FEDEX_EXPRESS_SAVER_ONE_RATE_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_TUBE', 'FEDEX_FREIGHT_FIRST', 'FEDEX_FIRST_OVERNIGHT', 'FEDEX_FIRST_OVERNIGHT_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_GROUND', 'FEDEX_HOME', 'FEDEX_CONNECT_PLUS_INTERNATIONAL', 'FEDEX_ECONOMY_INTERNATIONAL', 'FEDEX_FREIGHT_ECONOMY_INTERNATIONAL', 'FEDEX_FIRST_OVERNIGHT_INTERNATIONAL', 'FEDEX_INTLGROUNDCONSOLIDATION', 'FEDEX_PRIORITY_EXPRESS_INTERNATIONAL', 'FEDEX_FREIGHT_PRIORITY_INTERNATIONAL', 'FEDEX_PRIORITY_OVERNIGHT_INTERNATIONAL', 'FEDEX_FREIGHT_PRIORITY', 'FEDEX_PRIORITY_OVERNIGHT', 'FEDEX_PRIORITY_OVERNIGHT_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_SMART_POST', 'FEDEX_STANDARD_OVERNIGHT', 'FEDEX_STANDARDOVERNIGHT_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_TUBE'
UPS:
'UPS_GROUND', 'UPS_3DAY_SELECT', 'UPS_2DAY_AIR', 'UPS_2DAY_AIR_AM', 'UPS_NEXT_DAY_AIR_SAVER', 'UPS_NEXT_DAY_AIR', 'UPS_NEXT_DAY_AIR_EARLY_AM', '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_SUREPOST_LESS1LB', 'UPS_SUREPOST_LESS1LB_IRREGULAR', 'UPS_SUREPOST_1LB_OR_GREATER_MACHINABLE', 'UPS_SUREPOST_MORE1LB_IRREGULAR', 'UPS_SUREPOST_BPM_IRREGULAR', 'UPS_SUREPOST_MEDIA_IRREGULAR', 'UPS_MAILINNOVATIONS_FIRST', 'UPS_MAILINNOVATIONS_PRIORITY', 'UPS_MAILINNOVATIONS_MACHINABLE', 'UPS_MAILINNOVATIONS_LESS1LB', 'UPS_MAILINNOVATIONS_PARCELPOST', 'UPS_MAILINNOVATIONS_BPM_PARCEL', 'UPS_MAILINNOVATIONS_MEDIA', 'UPS_MAILINNOVATIONS_BPM_FLAT', 'UPS_MAILINNOVATIONS_STANDARD_FLAT', 'UPS_ST_CA', 'UPS_EXPRESS_EARLY_AM', 'UPS_EXPRESS', 'UPS_EXPRESS_SAVER', 'UPS_EXPEDITED'
UPS Intl:
'UPS_STANDARD', 'UPS_WORLDWIDE_EXPEDITED', 'UPS_WORLDWIDE_SAVER', 'UPS_WORLDWIDE_EXPRESS', 'UPS_WORLDWIDE_EXPRESS_PLUS', 'UPS_WORLDWIDE_EXPEDITED_ASIA', 'UPS_WORLDWIDE_SAVER_ASIA', 'UPS_WORLDWIDE_EXPRESS_ASIA', 'UPS_WORLDWIDE_EXPRESS_PLUS_ASIA', 'UPS_MAILINNOVATIONS_PRIORITY_INTERNATIONAL', 'UPS_MAILINNOVATIONS_ECONOMY_INTERNATIONAL', 'MIP/FLATS', 'MIE/FLATS', 'MIE/Machinables', 'MIE/Irregulars', 'MIE/BPM Parcels', 'MIE/Media Mail', 'MIE/BPM Flats', 'MIE/Standard Flats', 'UPS_WORLDWIDE_EXPRESS_PLUS_CANADA', 'UPS_WORLDWIDE_SAVER_CANADA', 'UPS_3DAY_SELECT_CANADA', 'UPS_WORLDWIDE_EXPEDITED_CANADA', 'UPS_WORLDWIDE_EXPRESS_CANADA'
DHL eCommerce:
'DHLEC_PACKET_IPA', 'DHLEC_PARCEL_DIRECT_INTL', 'DHLEC_PARCEL_DIRECT_MAX_CA', 'DHLEC_PARCEL_DIRECT', 'DHLEC_PARCEL_DIRECT_STANDARD_CA', 'DHLEC_PARCEL_STANDARD', 'DHLEC_BPM_EXPEDITED', 'DHLEC_BPM_GROUND', 'DHLEC_PARCELS_EXPEDITED', 'DHLEC_PARCELS_GROUND', 'DHLEC_PARCELS_EXPEDITED_MAX'
DHL Express:
'DHLE_DOMESTIC_EXPRESS', 'DHLE_ECONOMY_SELECT', 'DHLE_ECONOMYSELECT_A', 'DHLE_EUROPACK', 'DHLE_EXPRESS_1030AM', 'DHLE_EXPRESS1030AM_A', 'DHLE_EXPRESS_1200AM', 'DHLE_EXPRESS1200AM_A', 'DHLE_EXPRESS_9AM', 'DHLE_EXPRESS9AM_A', 'DHLE_EXPRESSENVELOPE', 'DHLE_EXPRESSENVELOPE_A', 'DHLE_EXPRESS_WORLDWIDE', 'DHLE_EXPRESSWORLDWIDE_A'
OnTrac:
'ONTRAC_SUNRISE_GOLD', 'ONTRAC_GROUND', 'ONTRAC_SUNRISE'
Amazon:
'AMAZON_SHIPPING_GROUND'
Estes:
'ESTES_GUARANTEED_BASIC', 'ESTES_GUARANTEED_EXCLUSIVE', 'ESTES_GUARANTEED_10AM', 'ESTES_GUARANTEED_12PM', 'ESTES_GUARANTEED_5PM', 'ESTES_GUARANTEED_ECONOMY', 'ESTES_GUARANTEED_STANDARD', 'ESTES_STANDARD'
Canada Post:
'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'
Purolator:
'PUROLATOR_EXPRESS', 'PUROLATOR_EXPRESS_10:30AM', 'PUROLATOR_EXPRESS_12PM', 'PUROLATOR_EXPRESS_9AM', 'PUROLATOR_EXPRESS_EVENING', 'PUROLATOR_EXPRESS_BOX', 'PUROLATOR_EXPRESS_BOX_10:30AM', 'PUROLATOR_EXPRESS_BOX_12PM', 'PUROLATOR_EXPRESS_BOX_9AM', 'PUROLATOR_EXPRESS_BOX_EVENING', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE_10:30AM', 'PUROLATOR_EXPRESS_ENVELOPE_12PM', 'PUROLATOR_EXPRESS_ENVELOPE_9AM', 'PUROLATOR_EXPRESS_ENVELOPE_EVENING', 'PUROLATOR_EXPRESS_PACK', 'PUROLATOR_EXPRESS_PACK_10:30AM', 'PUROLATOR_EXPRESS_PACK_12PM', 'PUROLATOR_EXPRESS_PACK_9AM', 'PUROLATOR_EXPRESS_PACK_EVENING', 'PurolatorFreight', 'PUROLATOR_GROUND', 'PUROLATOR_GROUND_10:30AM', 'PUROLATOR_GROUND_9AM', 'PUROLATOR_GROUND_EVENING'
Australia Post:
'AUPOST_AUEPARCEL', 'AUPOST_AUEXPRESS', 'AUPOST_AULARGELETTER', 'AUPOST_AULARGELETTERR', 'AUPOST_AUPARCELPOST', 'AUPOST_AUPARCELPOSTR', 'AUPOST_AUSMALLLETTER', 'AUPOST_AUSMALLLETTERR'\n ",
"type": "string"
},
"Weight": {
"$ref": "ref07f702756ae87a1ee2a7f8357ccd01da"
},
"Dimensions": {
"$ref": "ref48ee594915301e37caddcaf617d21c51"
},
"IdenticalPackageCount": {
"description": "Count of identical packages. Currently supported only for FedEx/UPS",
"type": "integer",
"minimum": 1
},
"Type": {
"$ref": "ref8bd46ee36ce60f78eeca8ca459f495aa"
},
"PackageItems": {
"description": "Items and their quantities inside the package. This information is required for certain marketplaces.",
"type": "array",
"items": {
"$ref": "ref67700ad872cc737e7b246385d084c0d7"
}
},
"Reference": {
"description": "This value will be printed on label. BBCODE placeholders can be used.",
"type": "string"
},
"InsuranceValue": {
"description": "Insurance Value.",
"type": "number"
},
"InsuranceFee": {
"description": "Insurance Fee. This value is ignored for input.",
"type": "number"
}
}
},
"ref03299f4f0e1deb29227a2c1332623e94": {
"id": "ref03299f4f0e1deb29227a2c1332623e94",
"description": "Used to set shipping options for order without printing",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Order id to modify.",
"type": "string"
},
"Packages": {
"description": "Packages for the order. If this tag is specified, all existing package definition of the order will be replaced with content of this tag. First package in sequence is main package, others are extra packages. Minimum of 1 package if you specify this tag.",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsOptions": {
"$ref": "refe277621b56884370fa2fe4431dfff4e6"
}
}
},
"OrderShipOptions-POST-request": {
"id": "OrderShipOptions-POST-request",
"description": "Used to set shipping options for order without printing",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Order id to modify.",
"type": "string"
},
"Packages": {
"description": "Packages for the order. If this tag is specified, all existing package definition of the order will be replaced with content of this tag. First package in sequence is main package, others are extra packages. Minimum of 1 package if you specify this tag.",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsOptions": {
"$ref": "refe277621b56884370fa2fe4431dfff4e6"
}
}
},
"OrderShipOptions-POST-200-response": {
"id": "OrderShipOptions-POST-200-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderShipOptions-POST-400-response": {
"id": "OrderShipOptions-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderShipOptions-POST-501-response": {
"id": "OrderShipOptions-POST-501-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refa150722cc4d0e68bba42ac5fb7d13853": {
"id": "refa150722cc4d0e68bba42ac5fb7d13853",
"properties": {
"QueueId": {
"description": "Filter by queue ID (exact match). Use to look up a specific queue by its numeric ID.",
"type": "integer"
},
"QueueName": {
"description": "Case-insensitive substring search on queue name. Returns all queues whose name contains this string.",
"type": "string"
},
"WarehouseId": {
"description": "Filter by warehouse ID (exact match). Returns all queues assigned to that warehouse (FK to /Warehouse).",
"type": "integer"
},
"WarehouseName": {
"description": "Filter by warehouse name (exact match). Alternative to WarehouseId: returns all queues assigned to the warehouse with this name.",
"type": "string"
},
"ProfileId": {
"description": "Filter by shipping profile ID (exact match). Returns all queues using that shipping profile (FK to /ShippingProfile).",
"type": "integer"
},
"ProfileName": {
"description": "Filter by shipping profile name (exact match). Alternative to ProfileId: returns all queues using the profile with this name.",
"type": "string"
}
}
},
"ref841583eeb6c2984f28ec327bb42f99cb": {
"id": "ref841583eeb6c2984f28ec327bb42f99cb",
"description": "Order queue \u2014 groups orders by warehouse and shipping profile. Each queue has a WarehouseId (FK: warehouse.warehouse_id) and a ProfileId (FK: shipping_profile.id). The shipping table references queue_id.",
"properties": {
"QueueId": {
"description": "Unique queue identifier. QueueIds 1-4 are built-in and cannot be deleted. QueueIds 1-2 also have immutable names. On create, omit to auto-assign (must be > 4 if provided). On update/delete, provide to identify the queue (alternative to QueueName).",
"type": "integer",
"minimum": 1
},
"QueueName": {
"description": "Display name for the order queue. Must be unique. Required on create. Immutable for QueueIds 1-2. On update/delete, may be used instead of QueueId to identify the queue (exact match).",
"type": "string"
},
"QueueSeq": {
"description": "Display sequence number controlling the sort order of queues in the UI. Lower values appear first.",
"type": "integer"
},
"WarehouseId": {
"description": "Warehouse assigned to orders in this queue (FK to /Warehouse). Provide either WarehouseId or WarehouseName (not both). Defaults to 1 (default warehouse) if both are omitted on create.",
"type": "integer",
"minimum": 1
},
"WarehouseName": {
"description": "Warehouse name (exact match). Alternative to WarehouseId: provide either WarehouseId or WarehouseName (not both). Use GET /Warehouse to find valid warehouse names. Input-only field \u2014 not returned in GET responses.",
"type": "string"
},
"ProfileId": {
"description": "Shipping profile used for label printing in this queue (FK to /ShippingProfile). Provide either ProfileId or ProfileName (not both). Defaults to 1 (default profile) if both are omitted on create.",
"type": "integer",
"minimum": 1
},
"ProfileName": {
"description": "Shipping profile name (exact match). Alternative to ProfileId: provide either ProfileId or ProfileName (not both). Use GET /ShippingProfile to find valid profile names. Input-only field \u2014 not returned in GET responses.",
"type": "string"
},
"DisplayInAll": {
"description": "Whether this queue's orders appear in the All-Orders view: 1 = yes (visible in all-orders), 0 = no (queue-only). Immutable for QueueIds 1-2.",
"type": "integer"
}
}
},
"refcc64377415dd152e50a27154ebc874ed": {
"id": "refcc64377415dd152e50a27154ebc874ed",
"description": "Response to GET /Queue. Contains a list of order queues matching the query filters, ordered by QueueSeq then QueueId.",
"required": [
"Queues"
],
"properties": {
"Queues": {
"description": "List of order queues matching the query filters. Empty array if none match.",
"type": "array",
"items": {
"$ref": "ref841583eeb6c2984f28ec327bb42f99cb"
}
}
}
},
"ref58cffeb679d6d7ece2a3e52ebfa17acd": {
"id": "ref58cffeb679d6d7ece2a3e52ebfa17acd",
"description": "Result of a single queue create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"QueueId",
"Status"
],
"properties": {
"QueueId": {
"description": "The QueueId of the affected queue. For create operations, this is the newly assigned ID.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no queue matched the given QueueId or QueueName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"ref7c9d71f2a73da9d8d56fb77e79c57d32": {
"id": "ref7c9d71f2a73da9d8d56fb77e79c57d32",
"description": "Request body for DELETE /Queue. Deletes a single order queue. Provide either QueueId or QueueName (not both). Deletion is blocked if the queue has active (unshipped) orders. Built-in queues (QueueId 1-4) cannot be deleted.",
"properties": {
"QueueId": {
"description": "ID of the order queue to delete",
"type": "integer"
},
"QueueName": {
"description": "Name of the order queue to delete (exact match)",
"type": "string"
}
}
},
"Queue-GET-query": {
"id": "Queue-GET-query",
"properties": {
"QueueId": {
"description": "Filter by queue ID (exact match). Use to look up a specific queue by its numeric ID.",
"type": "integer"
},
"QueueName": {
"description": "Case-insensitive substring search on queue name. Returns all queues whose name contains this string.",
"type": "string"
},
"WarehouseId": {
"description": "Filter by warehouse ID (exact match). Returns all queues assigned to that warehouse (FK to /Warehouse).",
"type": "integer"
},
"WarehouseName": {
"description": "Filter by warehouse name (exact match). Alternative to WarehouseId: returns all queues assigned to the warehouse with this name.",
"type": "string"
},
"ProfileId": {
"description": "Filter by shipping profile ID (exact match). Returns all queues using that shipping profile (FK to /ShippingProfile).",
"type": "integer"
},
"ProfileName": {
"description": "Filter by shipping profile name (exact match). Alternative to ProfileId: returns all queues using the profile with this name.",
"type": "string"
}
}
},
"Queue-GET-200-response": {
"id": "Queue-GET-200-response",
"description": "Response to GET /Queue. Contains a list of order queues matching the query filters, ordered by QueueSeq then QueueId.",
"required": [
"Queues"
],
"properties": {
"Queues": {
"description": "List of order queues matching the query filters. Empty array if none match.",
"type": "array",
"items": {
"$ref": "ref841583eeb6c2984f28ec327bb42f99cb"
}
}
}
},
"Queue-GET-400-response": {
"id": "Queue-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-GET-401-response": {
"id": "Queue-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-GET-500-response": {
"id": "Queue-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-POST-request": {
"id": "Queue-POST-request",
"description": "Order queue \u2014 groups orders by warehouse and shipping profile. Each queue has a WarehouseId (FK: warehouse.warehouse_id) and a ProfileId (FK: shipping_profile.id). The shipping table references queue_id.",
"properties": {
"QueueId": {
"description": "Unique queue identifier. QueueIds 1-4 are built-in and cannot be deleted. QueueIds 1-2 also have immutable names. On create, omit to auto-assign (must be > 4 if provided). On update/delete, provide to identify the queue (alternative to QueueName).",
"type": "integer",
"minimum": 1
},
"QueueName": {
"description": "Display name for the order queue. Must be unique. Required on create. Immutable for QueueIds 1-2. On update/delete, may be used instead of QueueId to identify the queue (exact match).",
"type": "string"
},
"QueueSeq": {
"description": "Display sequence number controlling the sort order of queues in the UI. Lower values appear first.",
"type": "integer"
},
"WarehouseId": {
"description": "Warehouse assigned to orders in this queue (FK to /Warehouse). Provide either WarehouseId or WarehouseName (not both). Defaults to 1 (default warehouse) if both are omitted on create.",
"type": "integer",
"minimum": 1
},
"WarehouseName": {
"description": "Warehouse name (exact match). Alternative to WarehouseId: provide either WarehouseId or WarehouseName (not both). Use GET /Warehouse to find valid warehouse names. Input-only field \u2014 not returned in GET responses.",
"type": "string"
},
"ProfileId": {
"description": "Shipping profile used for label printing in this queue (FK to /ShippingProfile). Provide either ProfileId or ProfileName (not both). Defaults to 1 (default profile) if both are omitted on create.",
"type": "integer",
"minimum": 1
},
"ProfileName": {
"description": "Shipping profile name (exact match). Alternative to ProfileId: provide either ProfileId or ProfileName (not both). Use GET /ShippingProfile to find valid profile names. Input-only field \u2014 not returned in GET responses.",
"type": "string"
},
"DisplayInAll": {
"description": "Whether this queue's orders appear in the All-Orders view: 1 = yes (visible in all-orders), 0 = no (queue-only). Immutable for QueueIds 1-2.",
"type": "integer"
}
}
},
"Queue-POST-200-response": {
"id": "Queue-POST-200-response",
"description": "Result of a single queue create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"QueueId",
"Status"
],
"properties": {
"QueueId": {
"description": "The QueueId of the affected queue. For create operations, this is the newly assigned ID.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no queue matched the given QueueId or QueueName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"Queue-POST-400-response": {
"id": "Queue-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-POST-401-response": {
"id": "Queue-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-POST-500-response": {
"id": "Queue-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-PUT-request": {
"id": "Queue-PUT-request",
"description": "Order queue \u2014 groups orders by warehouse and shipping profile. Each queue has a WarehouseId (FK: warehouse.warehouse_id) and a ProfileId (FK: shipping_profile.id). The shipping table references queue_id.",
"properties": {
"QueueId": {
"description": "Unique queue identifier. QueueIds 1-4 are built-in and cannot be deleted. QueueIds 1-2 also have immutable names. On create, omit to auto-assign (must be > 4 if provided). On update/delete, provide to identify the queue (alternative to QueueName).",
"type": "integer",
"minimum": 1
},
"QueueName": {
"description": "Display name for the order queue. Must be unique. Required on create. Immutable for QueueIds 1-2. On update/delete, may be used instead of QueueId to identify the queue (exact match).",
"type": "string"
},
"QueueSeq": {
"description": "Display sequence number controlling the sort order of queues in the UI. Lower values appear first.",
"type": "integer"
},
"WarehouseId": {
"description": "Warehouse assigned to orders in this queue (FK to /Warehouse). Provide either WarehouseId or WarehouseName (not both). Defaults to 1 (default warehouse) if both are omitted on create.",
"type": "integer",
"minimum": 1
},
"WarehouseName": {
"description": "Warehouse name (exact match). Alternative to WarehouseId: provide either WarehouseId or WarehouseName (not both). Use GET /Warehouse to find valid warehouse names. Input-only field \u2014 not returned in GET responses.",
"type": "string"
},
"ProfileId": {
"description": "Shipping profile used for label printing in this queue (FK to /ShippingProfile). Provide either ProfileId or ProfileName (not both). Defaults to 1 (default profile) if both are omitted on create.",
"type": "integer",
"minimum": 1
},
"ProfileName": {
"description": "Shipping profile name (exact match). Alternative to ProfileId: provide either ProfileId or ProfileName (not both). Use GET /ShippingProfile to find valid profile names. Input-only field \u2014 not returned in GET responses.",
"type": "string"
},
"DisplayInAll": {
"description": "Whether this queue's orders appear in the All-Orders view: 1 = yes (visible in all-orders), 0 = no (queue-only). Immutable for QueueIds 1-2.",
"type": "integer"
}
}
},
"Queue-PUT-200-response": {
"id": "Queue-PUT-200-response",
"description": "Result of a single queue create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"QueueId",
"Status"
],
"properties": {
"QueueId": {
"description": "The QueueId of the affected queue. For create operations, this is the newly assigned ID.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no queue matched the given QueueId or QueueName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"Queue-PUT-400-response": {
"id": "Queue-PUT-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-PUT-401-response": {
"id": "Queue-PUT-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-PUT-500-response": {
"id": "Queue-PUT-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-DELETE-request": {
"id": "Queue-DELETE-request",
"description": "Request body for DELETE /Queue. Deletes a single order queue. Provide either QueueId or QueueName (not both). Deletion is blocked if the queue has active (unshipped) orders. Built-in queues (QueueId 1-4) cannot be deleted.",
"properties": {
"QueueId": {
"description": "ID of the order queue to delete",
"type": "integer"
},
"QueueName": {
"description": "Name of the order queue to delete (exact match)",
"type": "string"
}
}
},
"Queue-DELETE-200-response": {
"id": "Queue-DELETE-200-response",
"description": "Result of a single queue create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"QueueId",
"Status"
],
"properties": {
"QueueId": {
"description": "The QueueId of the affected queue. For create operations, this is the newly assigned ID.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no queue matched the given QueueId or QueueName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"Queue-DELETE-400-response": {
"id": "Queue-DELETE-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-DELETE-401-response": {
"id": "Queue-DELETE-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Queue-DELETE-500-response": {
"id": "Queue-DELETE-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"reff3fe3bcffb2499bbc522d0976a5055c5": {
"id": "reff3fe3bcffb2499bbc522d0976a5055c5",
"properties": {
"TxnId": {
"description": "TxnId of order. Use this parameter to download only one order.",
"type": "string"
}
}
},
"refb8da9ab2d8111e49abaaa84365d3e402": {
"id": "refb8da9ab2d8111e49abaaa84365d3e402",
"required": [
"TxnId",
"TagList"
],
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maximum": 40
},
"TagList": {
"description": "Order\u2019s tags list",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"reffb4e5a754b64c2738a7e08738c242439": {
"id": "reffb4e5a754b64c2738a7e08738c242439",
"description": "'APIToken' header should be included in each request",
"properties": {
"Orders": {
"description": "Array of orders",
"type": "array",
"items": {
"$ref": "refb8da9ab2d8111e49abaaa84365d3e402"
}
}
}
},
"refea0490540b1df964e1177aae99d661cd": {
"id": "refea0490540b1df964e1177aae99d661cd",
"required": [
"TxnId",
"Success"
],
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maximum": 40
},
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Detailed message. Typically associated with errors",
"type": "string",
"maximum": 255
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref70a11b80417f449b72a6c68aee23b228": {
"id": "ref70a11b80417f449b72a6c68aee23b228",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refea0490540b1df964e1177aae99d661cd"
}
}
}
},
"OrderTags-GET-query": {
"id": "OrderTags-GET-query",
"properties": {
"TxnId": {
"description": "TxnId of order. Use this parameter to download only one order.",
"type": "string"
}
}
},
"OrderTags-GET-200-response": {
"id": "OrderTags-GET-200-response",
"description": "'APIToken' header should be included in each request",
"properties": {
"Orders": {
"description": "Array of orders",
"type": "array",
"items": {
"$ref": "refb8da9ab2d8111e49abaaa84365d3e402"
}
}
}
},
"OrderTags-GET-400-response": {
"id": "OrderTags-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderTags-GET-401-response": {
"id": "OrderTags-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderTags-GET-500-response": {
"id": "OrderTags-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderTags-POST-request": {
"id": "OrderTags-POST-request",
"description": "'APIToken' header should be included in each request",
"properties": {
"Orders": {
"description": "Array of orders",
"type": "array",
"items": {
"$ref": "refb8da9ab2d8111e49abaaa84365d3e402"
}
}
}
},
"OrderTags-POST-200-response": {
"id": "OrderTags-POST-200-response",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refea0490540b1df964e1177aae99d661cd"
}
}
}
},
"OrderTags-POST-400-response": {
"id": "OrderTags-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderTags-POST-401-response": {
"id": "OrderTags-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderTags-POST-500-response": {
"id": "OrderTags-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderTags-DELETE-request": {
"id": "OrderTags-DELETE-request",
"description": "'APIToken' header should be included in each request",
"properties": {
"Orders": {
"description": "Array of orders",
"type": "array",
"items": {
"$ref": "refb8da9ab2d8111e49abaaa84365d3e402"
}
}
}
},
"OrderTags-DELETE-200-response": {
"id": "OrderTags-DELETE-200-response",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refea0490540b1df964e1177aae99d661cd"
}
}
}
},
"OrderTags-DELETE-400-response": {
"id": "OrderTags-DELETE-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderTags-DELETE-401-response": {
"id": "OrderTags-DELETE-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"OrderTags-DELETE-500-response": {
"id": "OrderTags-DELETE-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref1e3c61afef1f1e733b3f5c60262ccae2": {
"id": "ref1e3c61afef1f1e733b3f5c60262ccae2",
"properties": {
"TagId": {
"description": "Filter by tag ID (exact match). Use to look up a specific tag by its numeric ID.",
"type": "integer"
},
"TagName": {
"description": "Case-insensitive substring search on tag name. Returns all tags whose name contains this string.",
"type": "string"
}
}
},
"refd3ff65e2ce428d644ca482fe06eb9409": {
"id": "refd3ff65e2ce428d644ca482fe06eb9409",
"description": "Order tag entity. Tags are colored labels applied to orders for visual grouping and filtering. TagId 1 (Ready To Ship) and TagId 2 (Hold) are system tags and cannot be deleted. Use /OrderTags to apply or remove tags from orders.",
"properties": {
"TagId": {
"description": "Unique tag identifier. On create, omit to auto-assign. On update/delete, provide to identify the tag (alternative to TagName).",
"type": "integer",
"minimum": 1
},
"TagName": {
"description": "Display name of the tag. Must be unique. Required on create. On update/delete, may be used instead of TagId to identify the tag (exact match).",
"type": "string"
},
"Color": {
"description": "Display color of the tag as a CSS color string (e.g. '#ff0000' or 'red'). Required on create.",
"type": "string"
}
}
},
"refd97ca9ef417c0c56fa7de18720de0bad": {
"id": "refd97ca9ef417c0c56fa7de18720de0bad",
"description": "Response to GET /Tag. Contains a list of tags matching the query filters, ordered by TagId.",
"required": [
"Tags"
],
"properties": {
"Tags": {
"description": "List of tags matching the query filters. Empty array if none match.",
"type": "array",
"items": {
"$ref": "refd3ff65e2ce428d644ca482fe06eb9409"
}
}
}
},
"refd2d718d118e8f1f57d742c665ec6f1a2": {
"id": "refd2d718d118e8f1f57d742c665ec6f1a2",
"description": "Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"TagId",
"Status"
],
"properties": {
"TagId": {
"description": "The TagId of the affected tag. For create operations, this is the newly assigned ID.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no tag matched the given TagId or TagName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"refe69e033d46acd947c7abe7be25e72242": {
"id": "refe69e033d46acd947c7abe7be25e72242",
"description": "Request body for DELETE /Tag. Deletes a single tag. Provide either TagId or TagName (not both). Deletion is blocked if the tag is assigned to any orders. System tags (TagId 1 = Ready To Ship, TagId 2 = Hold) cannot be deleted.",
"properties": {
"TagId": {
"description": "ID of the tag to delete",
"type": "integer"
},
"TagName": {
"description": "Name of the tag to delete (exact match)",
"type": "string"
}
}
},
"Tag-GET-query": {
"id": "Tag-GET-query",
"properties": {
"TagId": {
"description": "Filter by tag ID (exact match). Use to look up a specific tag by its numeric ID.",
"type": "integer"
},
"TagName": {
"description": "Case-insensitive substring search on tag name. Returns all tags whose name contains this string.",
"type": "string"
}
}
},
"Tag-GET-200-response": {
"id": "Tag-GET-200-response",
"description": "Response to GET /Tag. Contains a list of tags matching the query filters, ordered by TagId.",
"required": [
"Tags"
],
"properties": {
"Tags": {
"description": "List of tags matching the query filters. Empty array if none match.",
"type": "array",
"items": {
"$ref": "refd3ff65e2ce428d644ca482fe06eb9409"
}
}
}
},
"Tag-GET-400-response": {
"id": "Tag-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-GET-401-response": {
"id": "Tag-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-GET-500-response": {
"id": "Tag-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-POST-request": {
"id": "Tag-POST-request",
"description": "Order tag entity. Tags are colored labels applied to orders for visual grouping and filtering. TagId 1 (Ready To Ship) and TagId 2 (Hold) are system tags and cannot be deleted. Use /OrderTags to apply or remove tags from orders.",
"properties": {
"TagId": {
"description": "Unique tag identifier. On create, omit to auto-assign. On update/delete, provide to identify the tag (alternative to TagName).",
"type": "integer",
"minimum": 1
},
"TagName": {
"description": "Display name of the tag. Must be unique. Required on create. On update/delete, may be used instead of TagId to identify the tag (exact match).",
"type": "string"
},
"Color": {
"description": "Display color of the tag as a CSS color string (e.g. '#ff0000' or 'red'). Required on create.",
"type": "string"
}
}
},
"Tag-POST-200-response": {
"id": "Tag-POST-200-response",
"description": "Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"TagId",
"Status"
],
"properties": {
"TagId": {
"description": "The TagId of the affected tag. For create operations, this is the newly assigned ID.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no tag matched the given TagId or TagName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"Tag-POST-400-response": {
"id": "Tag-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-POST-401-response": {
"id": "Tag-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-POST-500-response": {
"id": "Tag-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-PUT-request": {
"id": "Tag-PUT-request",
"description": "Order tag entity. Tags are colored labels applied to orders for visual grouping and filtering. TagId 1 (Ready To Ship) and TagId 2 (Hold) are system tags and cannot be deleted. Use /OrderTags to apply or remove tags from orders.",
"properties": {
"TagId": {
"description": "Unique tag identifier. On create, omit to auto-assign. On update/delete, provide to identify the tag (alternative to TagName).",
"type": "integer",
"minimum": 1
},
"TagName": {
"description": "Display name of the tag. Must be unique. Required on create. On update/delete, may be used instead of TagId to identify the tag (exact match).",
"type": "string"
},
"Color": {
"description": "Display color of the tag as a CSS color string (e.g. '#ff0000' or 'red'). Required on create.",
"type": "string"
}
}
},
"Tag-PUT-200-response": {
"id": "Tag-PUT-200-response",
"description": "Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"TagId",
"Status"
],
"properties": {
"TagId": {
"description": "The TagId of the affected tag. For create operations, this is the newly assigned ID.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no tag matched the given TagId or TagName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"Tag-PUT-400-response": {
"id": "Tag-PUT-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-PUT-401-response": {
"id": "Tag-PUT-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-PUT-500-response": {
"id": "Tag-PUT-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-DELETE-request": {
"id": "Tag-DELETE-request",
"description": "Request body for DELETE /Tag. Deletes a single tag. Provide either TagId or TagName (not both). Deletion is blocked if the tag is assigned to any orders. System tags (TagId 1 = Ready To Ship, TagId 2 = Hold) cannot be deleted.",
"properties": {
"TagId": {
"description": "ID of the tag to delete",
"type": "integer"
},
"TagName": {
"description": "Name of the tag to delete (exact match)",
"type": "string"
}
}
},
"Tag-DELETE-200-response": {
"id": "Tag-DELETE-200-response",
"description": "Result of a single tag create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"TagId",
"Status"
],
"properties": {
"TagId": {
"description": "The TagId of the affected tag. For create operations, this is the newly assigned ID.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no tag matched the given TagId or TagName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"Tag-DELETE-400-response": {
"id": "Tag-DELETE-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-DELETE-401-response": {
"id": "Tag-DELETE-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Tag-DELETE-500-response": {
"id": "Tag-DELETE-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refaaf6b409095417934e3ee0ccf6271a0f": {
"id": "refaaf6b409095417934e3ee0ccf6271a0f",
"description": "'APIToken' header should be included in each request",
"required": [
"ProfileId",
"TxnIds"
],
"properties": {
"ProfileId": {
"description": "Id of shipping profile, saved in Teapplix Setup",
"type": "integer",
"minimum": 1
},
"TxnIds": {
"description": "List of order ids to generate SSCC label for",
"type": "array",
"items": {
"type": "string"
}
},
"ForceRegen": {
"description": "Force re-generate SSCC label",
"type": "boolean"
}
}
},
"refac95a64bd730e18a5f60663f2d63baf6": {
"id": "refac95a64bd730e18a5f60663f2d63baf6",
"description": "Document details",
"required": [
"Content"
],
"properties": {
"Type": {
"type": "string",
"enum": [
"URL",
"INLINE"
]
},
"ContentType": {
"type": "string",
"enum": [
"PDF",
"ZIP",
"PNG",
"HTML"
]
},
"Content": {
"type": "string",
"minimum": 1
}
}
},
"PackingListForOrder-POST-request": {
"id": "PackingListForOrder-POST-request",
"description": "'APIToken' header should be included in each request",
"required": [
"ProfileId",
"TxnIds"
],
"properties": {
"ProfileId": {
"description": "Id of shipping profile, saved in Teapplix Setup",
"type": "integer",
"minimum": 1
},
"TxnIds": {
"description": "List of order ids to generate packing list for",
"type": "array",
"items": {
"type": "string"
}
},
"ForceRegen": {
"description": "Force re-generate packing list",
"type": "boolean"
}
}
},
"PackingListForOrder-POST-200-response": {
"id": "PackingListForOrder-POST-200-response",
"description": "Document details",
"required": [
"Content"
],
"properties": {
"Type": {
"type": "string",
"enum": [
"URL",
"INLINE"
]
},
"ContentType": {
"type": "string",
"enum": [
"PDF",
"ZIP",
"PNG",
"HTML"
]
},
"Content": {
"type": "string",
"minimum": 1
}
}
},
"PackingListForOrder-POST-400-response": {
"id": "PackingListForOrder-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PackingListForOrder-POST-500-response": {
"id": "PackingListForOrder-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref9a28bf4353ab004befdba9ee44f3483a": {
"id": "ref9a28bf4353ab004befdba9ee44f3483a",
"description": "Total weight",
"required": [
"Value",
"Unit"
],
"properties": {
"Value": {
"description": "Absolute weight value",
"type": "number"
},
"Unit": {
"description": "Unit",
"type": "string",
"enum": [
"OZ",
"LB",
"GR",
"KG"
]
}
}
},
"refa74a7de4fdd8c51c93b96e3a90595ea3": {
"id": "refa74a7de4fdd8c51c93b96e3a90595ea3",
"description": "Total volume",
"required": [
"Value"
],
"properties": {
"Value": {
"description": "Absolute value",
"type": "number"
}
}
},
"ref730a0f11d9d7bcaa395b2339dbcb8cbc": {
"id": "ref730a0f11d9d7bcaa395b2339dbcb8cbc",
"description": "Pallet information",
"required": [
"Position"
],
"properties": {
"Position": {
"description": "Position value",
"type": "number"
}
}
},
"ref65bae0a26a40b89d32da60c59e3e8179": {
"id": "ref65bae0a26a40b89d32da60c59e3e8179",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnId",
"PickupDateTime",
"Weight",
"Volume",
"Pallet"
],
"properties": {
"TxnId": {
"description": "Order TxnId to be pickuped up",
"type": "string",
"maximum": 40
},
"PickupDateTime": {
"description": "Requested pickup date time. e.g. 2026-01-12T09:00:00-08:00 or 2026-01-12 09:00:00.",
"type": "string"
},
"Weight": {
"$ref": "ref9a28bf4353ab004befdba9ee44f3483a"
},
"Volume": {
"$ref": "refa74a7de4fdd8c51c93b96e3a90595ea3"
},
"Pallet": {
"$ref": "ref730a0f11d9d7bcaa395b2339dbcb8cbc"
}
}
},
"PickupForOrder-POST-request": {
"id": "PickupForOrder-POST-request",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnId",
"PickupDateTime",
"Weight",
"Volume",
"Pallet"
],
"properties": {
"TxnId": {
"description": "Order TxnId to be pickuped up",
"type": "string",
"maximum": 40
},
"PickupDateTime": {
"description": "Requested pickup date time. e.g. 2026-01-12T09:00:00-08:00 or 2026-01-12 09:00:00.",
"type": "string"
},
"Weight": {
"$ref": "ref9a28bf4353ab004befdba9ee44f3483a"
},
"Volume": {
"$ref": "refa74a7de4fdd8c51c93b96e3a90595ea3"
},
"Pallet": {
"$ref": "ref730a0f11d9d7bcaa395b2339dbcb8cbc"
}
}
},
"PickupForOrder-POST-200-response": {
"id": "PickupForOrder-POST-200-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PickupForOrder-POST-400-response": {
"id": "PickupForOrder-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PickupForOrder-POST-401-response": {
"id": "PickupForOrder-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PickupForOrder-POST-500-response": {
"id": "PickupForOrder-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SSCCLabelForOrder-POST-request": {
"id": "SSCCLabelForOrder-POST-request",
"description": "'APIToken' header should be included in each request",
"required": [
"ProfileId",
"TxnIds"
],
"properties": {
"ProfileId": {
"description": "Id of shipping profile, saved in Teapplix Setup",
"type": "integer",
"minimum": 1
},
"TxnIds": {
"description": "List of order ids to generate SSCC label for",
"type": "array",
"items": {
"type": "string"
}
},
"ForceRegen": {
"description": "Force re-generate SSCC label",
"type": "boolean"
}
}
},
"SSCCLabelForOrder-POST-200-response": {
"id": "SSCCLabelForOrder-POST-200-response",
"description": "Document details",
"required": [
"Content"
],
"properties": {
"Type": {
"type": "string",
"enum": [
"URL",
"INLINE"
]
},
"ContentType": {
"type": "string",
"enum": [
"PDF",
"ZIP",
"PNG",
"HTML"
]
},
"Content": {
"type": "string",
"minimum": 1
}
}
},
"SSCCLabelForOrder-POST-400-response": {
"id": "SSCCLabelForOrder-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SSCCLabelForOrder-POST-500-response": {
"id": "SSCCLabelForOrder-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refbbd6e47bf7fdf1f10b5f0aaab94b4d46": {
"id": "refbbd6e47bf7fdf1f10b5f0aaab94b4d46",
"properties": {
"ItemName": {
"description": "Item Name of product",
"type": "string"
},
"ItemType": {
"type": "string"
},
"VariationType": {
"type": "string"
},
"RootItemName": {
"type": "string"
},
"Upc": {
"type": "string"
},
"Location": {
"type": "string"
},
"ItemTitle": {
"type": "string"
},
"Category": {
"type": "string"
},
"JetCategoryId": {
"type": "string"
},
"WalmartCategoryId": {
"type": "string"
},
"WalmartTaxCode": {
"type": "string"
},
"Supplier": {
"type": "string"
},
"Asin": {
"type": "string"
},
"Xref3": {
"type": "string"
},
"DefaultPrice": {
"type": "string"
},
"DefaultPriceSign": {
"description": "Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='",
"type": "string"
},
"Cost": {
"type": "string"
},
"CostSign": {
"description": "Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='",
"type": "string"
},
"SalesRep": {
"type": "string"
},
"CommissionRate": {
"type": "string"
},
"DangerousGoodsType": {
"type": "string"
},
"CountryOfOrigin": {
"type": "string"
},
"Brand": {
"type": "string"
},
"Model": {
"type": "string"
},
"Manufacturer": {
"type": "string"
},
"ManufacturerPartNumber": {
"type": "string"
},
"Status": {
"description": "Status of downloaded inventory products. Possible values: active, inactive, all. Default active",
"type": "string"
},
"PageSize": {
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"type": "string"
},
"PageNumber": {
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"type": "string"
}
}
},
"ref5022200ddeb8dc1faec1cc4cc55b34e1": {
"id": "ref5022200ddeb8dc1faec1cc4cc55b34e1",
"description": "Dangerous Goods Details",
"properties": {
"CommodityType": {
"description": "Commodity Type",
"type": "string",
"enum": [
"UN",
"ID",
"NA"
]
},
"CommodityId": {
"description": "Commodity Type",
"type": "string",
"maximum": 5
},
"PackingGroup": {
"description": "Packing Group",
"type": "string",
"enum": [
"I",
"II",
"III"
]
},
"PackingType": {
"description": "Packing Type",
"type": "string",
"maximum": 60
},
"PackingInstruction": {
"description": "Packing Instruction",
"type": "string",
"maximum": 4
},
"AircraftCategoryType": {
"description": "Aircraft Category Type",
"type": "string",
"enum": [
"PASSENGER_AND_CARGO_AIRCRAFT",
"CARGO_AIRCRAFT_ONLY"
]
},
"ProperName": {
"description": "Proper Name",
"type": "string",
"maximum": 30
},
"TechnicalName": {
"description": "Technical Name",
"type": "string",
"maximum": 20
},
"PrimaryClass": {
"description": "Primary Class",
"type": "string",
"maximum": 4
},
"SubsidiaryClass": {
"description": "Subsidiary Class",
"type": "string",
"maximum": 4
},
"ReportableQty": {
"description": "Reportable Quantity",
"type": "number"
},
"ReportableQtyUnit": {
"description": "Reportable Quantity Unit",
"type": "string",
"enum": [
"oz",
"lb",
"gram",
"kg"
]
},
"Percentage": {
"description": "Percentage",
"type": "string",
"maximum": 3
},
"AuthorizationInfo": {
"description": "AuthorizationInfo",
"type": "string",
"maximum": 40
}
}
},
"ref8880f8a95f56ae929d36f16eb878707b": {
"id": "ref8880f8a95f56ae929d36f16eb878707b",
"description": "Product Main Image",
"properties": {
"ImageUrlLarge": {
"description": "Large Image URL",
"type": "string"
},
"ImageUrlSmall": {
"description": "Small Image URL",
"type": "string"
},
"AltText": {
"description": "Alternate Text",
"type": "string"
}
}
},
"ref44de51572b8616a154db10de51c9b070": {
"id": "ref44de51572b8616a154db10de51c9b070",
"description": "Product Feature",
"properties": {
"AttributeValue": {
"description": "Attribute Value",
"type": "string"
},
"AttributeValueSeq": {
"type": "integer"
}
}
},
"ref7e027027ac152e66d3b38a55be649a4a": {
"id": "ref7e027027ac152e66d3b38a55be649a4a",
"description": "Product Image",
"properties": {
"Url": {
"description": "URL",
"type": "string"
},
"AltText": {
"description": "Alternate Text",
"type": "string"
}
}
},
"refd646fafadbdc89cb41efdccbf7f3410e": {
"id": "refd646fafadbdc89cb41efdccbf7f3410e",
"description": "Product Shipping Exception",
"properties": {
"IsAllowed": {
"description": "Is Allowed",
"type": "integer"
},
"ShipMethod": {
"description": "Ship Method",
"type": "string"
},
"ServiceLevel": {
"type": "string"
},
"ShipRegion": {
"description": "Ship Region",
"type": "string"
},
"ShipPrice": {
"description": "Ship Price",
"type": "number"
},
"OverrideType": {
"description": "Override Type",
"type": "string"
},
"ExceptionType": {
"description": "Exception Type",
"type": "string"
},
"StoreType": {
"description": "Store Type",
"type": "string"
}
}
},
"ref54b745743a0f168db61dca83ced3f4b7": {
"id": "ref54b745743a0f168db61dca83ced3f4b7",
"description": "Declares product",
"required": [
"ItemName"
],
"properties": {
"ItemName": {
"type": "string"
},
"ItemType": {
"type": "string"
},
"VariationType": {
"type": "string",
"enum": [
"none",
"root"
]
},
"ItemTitle": {
"type": "string"
},
"Upc": {
"type": "string"
},
"Brand": {
"type": "string"
},
"Mpn": {
"type": "string"
},
"Location": {
"type": "string"
},
"DangerousGoodsDetails": {
"$ref": "ref5022200ddeb8dc1faec1cc4cc55b34e1"
},
"Category": {
"type": "string"
},
"Asin": {
"type": "string"
},
"Supplier": {
"type": "string"
},
"SupplierSku": {
"type": "string"
},
"Xref3": {
"type": "string"
},
"Active": {
"type": "integer"
},
"MainImage": {
"$ref": "ref8880f8a95f56ae929d36f16eb878707b"
},
"DefaultCost": {
"type": "number"
},
"DefaultPrice": {
"type": "number"
},
"MAPPrice": {
"type": "number"
},
"MSRPPrice": {
"type": "number"
},
"CustomsValue": {
"type": "number"
},
"CustomsDescription": {
"type": "string"
},
"LocalizedCustomsDescription": {
"type": "string"
},
"HarmonizedCode": {
"type": "string"
},
"CountryOfOrigin": {
"description": "2 letter ISO code",
"type": "string",
"minimum": 2,
"maximum": 2
},
"SalesRep": {
"type": "string"
},
"CommissionRate": {
"type": "number"
},
"Weight": {
"$ref": "ref07f702756ae87a1ee2a7f8357ccd01da"
},
"Dimensions": {
"$ref": "ref48ee594915301e37caddcaf617d21c51"
},
"ScanControl": {
"type": "string",
"enum": [
"normal",
"individual_scan",
"serial_scan",
"none"
]
},
"DangerousGoodsType": {
"type": "integer"
},
"Features": {
"description": "Product Features",
"type": "array",
"items": {
"$ref": "ref44de51572b8616a154db10de51c9b070"
}
},
"Keywords": {
"description": "Product Keywords",
"type": "string"
},
"LongDescriptionBase64": {
"type": "string"
},
"AdditionalImages": {
"description": "Additional Images",
"type": "array",
"items": {
"$ref": "ref7e027027ac152e66d3b38a55be649a4a"
}
},
"WalmartCategoryId": {
"type": "string"
},
"WalmartCategoryOptionsBase64": {
"type": "string"
},
"JetCategoryId": {
"type": "integer"
},
"JetCategoryOptionsBase64": {
"type": "string"
},
"JetPricingPolicy": {
"type": "string",
"enum": [
"101",
"102",
"103"
]
},
"WalmartTaxCode": {
"type": "integer"
},
"ShippingExceptions": {
"description": "Item Shipping Exceptions",
"type": "array",
"items": {
"$ref": "refd646fafadbdc89cb41efdccbf7f3410e"
}
}
}
},
"ref2b3b79c12df9706cdb43e9eab2399672": {
"id": "ref2b3b79c12df9706cdb43e9eab2399672",
"required": [
"Products"
],
"properties": {
"Products": {
"type": "array",
"items": {
"$ref": "ref54b745743a0f168db61dca83ced3f4b7"
}
},
"Pagination": {
"$ref": "refe57caad9ceb11b8736dc5ff1616e2a20"
}
}
},
"refa89ce71331a7075525dd6d7935a84fa7": {
"id": "refa89ce71331a7075525dd6d7935a84fa7",
"description": "Used to insert Inventory Products",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Products to be inserted",
"type": "array",
"items": {
"$ref": "ref54b745743a0f168db61dca83ced3f4b7"
}
}
}
},
"ref815a0dac4a65477e361c0000389de7ea": {
"id": "ref815a0dac4a65477e361c0000389de7ea",
"required": [
"ItemName",
"Status"
],
"properties": {
"ItemName": {
"description": "Item Name",
"type": "string",
"maximum": 40
},
"Status": {
"description": "Submission status for product",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Message",
"type": "string"
}
}
},
"refacde637d58328f071ab2a0f2e915736a": {
"id": "refacde637d58328f071ab2a0f2e915736a",
"description": "Product Operation result",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Product create details",
"type": "array",
"items": {
"$ref": "ref815a0dac4a65477e361c0000389de7ea"
}
}
}
},
"refef77e00aa07fd8f94b0f2e312d06a5a5": {
"id": "refef77e00aa07fd8f94b0f2e312d06a5a5",
"description": "Declares product",
"properties": {
"ItemType": {
"type": "string"
},
"ItemTitle": {
"type": "string"
},
"Category": {
"type": "string"
},
"Upc": {
"type": "string"
},
"Asin": {
"type": "string"
},
"Brand": {
"type": "string"
},
"Mpn": {
"type": "string"
},
"Supplier": {
"type": "string"
},
"SupplierSku": {
"type": "string"
},
"Location": {
"type": "string"
},
"Xref3": {
"type": "string"
},
"Active": {
"type": "integer"
},
"MainImage": {
"$ref": "ref8880f8a95f56ae929d36f16eb878707b"
},
"DefaultCost": {
"type": "number"
},
"DefaultPrice": {
"type": "number"
},
"MAPPrice": {
"type": "number"
},
"MSRPPrice": {
"type": "number"
},
"CustomsValue": {
"type": "number"
},
"CustomsDescription": {
"type": "string"
},
"LocalizedCustomsDescription": {
"type": "string"
},
"HarmonizedCode": {
"type": "string"
},
"CountryOfOrigin": {
"description": "2 letter ISO code",
"type": "string",
"minimum": 2,
"maximum": 2
},
"SalesRep": {
"type": "string"
},
"CommissionRate": {
"type": "number"
},
"Weight": {
"$ref": "ref07f702756ae87a1ee2a7f8357ccd01da"
},
"Dimensions": {
"$ref": "ref48ee594915301e37caddcaf617d21c51"
},
"ScanControl": {
"type": "string",
"enum": [
"normal",
"individual_scan",
"serial_scan",
"none"
]
},
"DangerousGoodsType": {
"type": "integer"
},
"DangerousGoodsDetails": {
"$ref": "ref5022200ddeb8dc1faec1cc4cc55b34e1"
},
"Features": {
"description": "Product Features",
"type": "array",
"items": {
"$ref": "ref44de51572b8616a154db10de51c9b070"
}
},
"Keywords": {
"description": "Product Keywords",
"type": "string"
},
"LongDescriptionBase64": {
"type": "string"
},
"AdditionalImages": {
"description": "Additional Images",
"type": "array",
"items": {
"$ref": "ref7e027027ac152e66d3b38a55be649a4a"
}
},
"VariationType": {
"type": "string",
"enum": [
"none",
"root",
"variation"
]
},
"WalmartCategoryId": {
"type": "string"
},
"WalmartCategoryOptionsBase64": {
"type": "string"
},
"JetCategoryId": {
"type": "integer"
},
"JetCategoryOptionsBase64": {
"type": "string"
},
"JetPricingPolicy": {
"type": "string",
"enum": [
"101",
"102",
"103"
]
},
"WalmartTaxCode": {
"type": "integer"
},
"ShippingExceptions": {
"description": "Item Shipping Exceptions",
"type": "array",
"items": {
"$ref": "refd646fafadbdc89cb41efdccbf7f3410e"
}
}
}
},
"ref841b44a9f127997885aed042a882eed9": {
"id": "ref841b44a9f127997885aed042a882eed9",
"description": "Used to update Inventory Products",
"required": [
"ItemName",
"Product"
],
"properties": {
"ItemName": {
"description": "Item Name to be updated",
"type": "string"
},
"Product": {
"$ref": "refef77e00aa07fd8f94b0f2e312d06a5a5"
}
}
},
"ref6ffcc51b0900a7ab6ff01c024f7cfb56": {
"id": "ref6ffcc51b0900a7ab6ff01c024f7cfb56",
"description": "Used to update Inventory Products",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Products to be updated",
"type": "array",
"items": {
"$ref": "ref841b44a9f127997885aed042a882eed9"
}
}
}
},
"ref89ea08fe9574b7369c9a9af9ebaa88cd": {
"id": "ref89ea08fe9574b7369c9a9af9ebaa88cd",
"description": "Used to delete Inventory Products",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Products SKU to be deleted",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-GET-query": {
"id": "Product-GET-query",
"properties": {
"ItemName": {
"description": "Item Name of product",
"type": "string"
},
"ItemType": {
"type": "string"
},
"VariationType": {
"type": "string"
},
"RootItemName": {
"type": "string"
},
"Upc": {
"type": "string"
},
"Location": {
"type": "string"
},
"ItemTitle": {
"type": "string"
},
"Category": {
"type": "string"
},
"JetCategoryId": {
"type": "string"
},
"WalmartCategoryId": {
"type": "string"
},
"WalmartTaxCode": {
"type": "string"
},
"Supplier": {
"type": "string"
},
"Asin": {
"type": "string"
},
"Xref3": {
"type": "string"
},
"DefaultPrice": {
"type": "string"
},
"DefaultPriceSign": {
"description": "Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='",
"type": "string"
},
"Cost": {
"type": "string"
},
"CostSign": {
"description": "Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='",
"type": "string"
},
"SalesRep": {
"type": "string"
},
"CommissionRate": {
"type": "string"
},
"DangerousGoodsType": {
"type": "string"
},
"CountryOfOrigin": {
"type": "string"
},
"Brand": {
"type": "string"
},
"Model": {
"type": "string"
},
"Manufacturer": {
"type": "string"
},
"ManufacturerPartNumber": {
"type": "string"
},
"Status": {
"description": "Status of downloaded inventory products. Possible values: active, inactive, all. Default active",
"type": "string"
},
"PageSize": {
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"type": "string"
},
"PageNumber": {
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"type": "string"
}
}
},
"Product-GET-200-response": {
"id": "Product-GET-200-response",
"required": [
"Products"
],
"properties": {
"Products": {
"type": "array",
"items": {
"$ref": "ref54b745743a0f168db61dca83ced3f4b7"
}
},
"Pagination": {
"$ref": "refe57caad9ceb11b8736dc5ff1616e2a20"
}
}
},
"Product-GET-400-response": {
"id": "Product-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-GET-401-response": {
"id": "Product-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-GET-500-response": {
"id": "Product-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-POST-request": {
"id": "Product-POST-request",
"description": "Used to insert Inventory Products",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Products to be inserted",
"type": "array",
"items": {
"$ref": "ref54b745743a0f168db61dca83ced3f4b7"
}
}
}
},
"Product-POST-200-response": {
"id": "Product-POST-200-response",
"description": "Product Operation result",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Product create details",
"type": "array",
"items": {
"$ref": "ref815a0dac4a65477e361c0000389de7ea"
}
}
}
},
"Product-POST-400-response": {
"id": "Product-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-POST-401-response": {
"id": "Product-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-POST-500-response": {
"id": "Product-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-PUT-request": {
"id": "Product-PUT-request",
"description": "Used to update Inventory Products",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Products to be updated",
"type": "array",
"items": {
"$ref": "ref841b44a9f127997885aed042a882eed9"
}
}
}
},
"Product-PUT-200-response": {
"id": "Product-PUT-200-response",
"description": "Product Operation result",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Product create details",
"type": "array",
"items": {
"$ref": "ref815a0dac4a65477e361c0000389de7ea"
}
}
}
},
"Product-PUT-400-response": {
"id": "Product-PUT-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-PUT-401-response": {
"id": "Product-PUT-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-PUT-500-response": {
"id": "Product-PUT-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-DELETE-request": {
"id": "Product-DELETE-request",
"description": "Used to delete Inventory Products",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Products SKU to be deleted",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-DELETE-200-response": {
"id": "Product-DELETE-200-response",
"description": "Product Operation result",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Product create details",
"type": "array",
"items": {
"$ref": "ref815a0dac4a65477e361c0000389de7ea"
}
}
}
},
"Product-DELETE-400-response": {
"id": "Product-DELETE-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-DELETE-401-response": {
"id": "Product-DELETE-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Product-DELETE-500-response": {
"id": "Product-DELETE-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refe1affcbe366456e858ee2032a039426b": {
"id": "refe1affcbe366456e858ee2032a039426b",
"properties": {
"ParentItemName": {
"type": "string"
}
}
},
"refd49c47cede6fc4a4209e2d7341ab500d": {
"id": "refd49c47cede6fc4a4209e2d7341ab500d",
"description": "Declares Combo Product Child Item",
"required": [
"ItemName"
],
"properties": {
"ItemName": {
"type": "string"
},
"Quantity": {
"type": "integer"
}
}
},
"ref9595381e4bcd9b32fba7b3a4cf752759": {
"id": "ref9595381e4bcd9b32fba7b3a4cf752759",
"required": [
"ChildItems"
],
"properties": {
"ChildItems": {
"type": "array",
"items": {
"$ref": "refd49c47cede6fc4a4209e2d7341ab500d"
}
}
}
},
"ref21aca94b6636883c10e83d6914a14659": {
"id": "ref21aca94b6636883c10e83d6914a14659",
"description": "Used to update Inventory Combo Products",
"required": [
"ParentItemName",
"ChildItems"
],
"properties": {
"ParentItemName": {
"description": "Parent Item Name",
"type": "string"
},
"ChildItems": {
"description": "Combo Product Child Items to be inserted or updated. If you call method again, all Child Items will be overwritten",
"type": "array",
"items": {
"$ref": "refd49c47cede6fc4a4209e2d7341ab500d"
}
}
}
},
"ProductCombo-GET-query": {
"id": "ProductCombo-GET-query",
"properties": {
"ParentItemName": {
"description": "Item Name of parent product",
"type": "string"
}
}
},
"ProductCombo-GET-200-response": {
"id": "ProductCombo-GET-200-response",
"required": [
"ChildItems"
],
"properties": {
"ChildItems": {
"type": "array",
"items": {
"$ref": "refd49c47cede6fc4a4209e2d7341ab500d"
}
}
}
},
"ProductCombo-GET-400-response": {
"id": "ProductCombo-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductCombo-GET-401-response": {
"id": "ProductCombo-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductCombo-GET-500-response": {
"id": "ProductCombo-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductCombo-PUT-request": {
"id": "ProductCombo-PUT-request",
"description": "Used to update Inventory Combo Products",
"required": [
"ParentItemName",
"ChildItems"
],
"properties": {
"ParentItemName": {
"description": "Parent Item Name",
"type": "string"
},
"ChildItems": {
"description": "Combo Product Child Items to be inserted or updated. If you call method again, all Child Items will be overwritten",
"type": "array",
"items": {
"$ref": "refd49c47cede6fc4a4209e2d7341ab500d"
}
}
}
},
"ProductCombo-PUT-200-response": {
"id": "ProductCombo-PUT-200-response",
"description": "Product Operation result",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Product create details",
"type": "array",
"items": {
"$ref": "ref815a0dac4a65477e361c0000389de7ea"
}
}
}
},
"ProductCombo-PUT-400-response": {
"id": "ProductCombo-PUT-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductCombo-PUT-401-response": {
"id": "ProductCombo-PUT-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductCombo-PUT-500-response": {
"id": "ProductCombo-PUT-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref78ef16151ef380dbc582f258dcd7f181": {
"id": "ref78ef16151ef380dbc582f258dcd7f181",
"properties": {
"WarehouseId": {
"type": "string"
},
"ItemName": {
"type": "string"
},
"Upc": {
"type": "string"
}
}
},
"ref6fb5e5ebaeb8eaa58896987b51294427": {
"id": "ref6fb5e5ebaeb8eaa58896987b51294427",
"description": "Product Quantity",
"properties": {
"ItemName": {
"description": "Item Name",
"type": "string"
},
"WarehouseId": {
"description": "Warehouse Id",
"type": "integer"
},
"WarehouseName": {
"description": "Warehouse Name. Provided for external warehouses only.",
"type": "string"
},
"Asin": {
"type": "string"
},
"Upc": {
"description": "Upc",
"type": "string"
},
"Location": {
"description": "Location",
"type": "string"
},
"Xref3": {
"description": "Xref3",
"type": "string"
},
"UnitCost": {
"description": "Unit Cost",
"type": "number"
},
"TotalCost": {
"description": "Total Cost",
"type": "number"
},
"QtyOnHand": {
"description": "Qty On Hand",
"type": "integer"
},
"QtyToShip": {
"description": "Qty To Ship",
"type": "integer"
},
"QtyAvailable": {
"description": "Qty Available",
"type": "integer"
},
"QtyReserve": {
"description": "Qty Reserve",
"type": "integer"
},
"ItemTitle": {
"description": "Item Title",
"type": "string"
}
}
},
"ref5643b315418b8bdef59dd38724de4106": {
"id": "ref5643b315418b8bdef59dd38724de4106",
"description": "Product Operation result",
"required": [
"ProductQuantities"
],
"properties": {
"ProductQuantities": {
"description": "Product quantities data",
"type": "array",
"items": {
"$ref": "ref6fb5e5ebaeb8eaa58896987b51294427"
}
}
}
},
"ref38ed31b9be54d2d37d5fcc00f19a0214": {
"id": "ref38ed31b9be54d2d37d5fcc00f19a0214",
"description": "Product Quantity",
"required": [
"PostDate",
"PostType",
"ItemName",
"Quantity"
],
"properties": {
"PONumber": {
"description": "PO Number",
"type": "integer"
},
"PostDate": {
"description": "Post Date",
"type": "string"
},
"PostType": {
"type": "string",
"enum": [
"debit",
"credit",
"in-stock"
]
},
"WarehouseId": {
"description": "Warehouse Id. WarehouseId, WarehouseName or both WarehouseId and WarehouseName are accepted, but WarehouseName has higher priority if they does not match.",
"type": "integer"
},
"WarehouseName": {
"description": "Warehouse Name. Only allowed for external warehouses. WarehouseId, WarehouseName or both WarehouseId and WarehouseName are accepted, but WarehouseName has higher priority if they does not match.",
"type": "string"
},
"ItemName": {
"description": "Item Name",
"type": "string"
},
"Quantity": {
"description": "Quantity",
"type": "integer"
},
"Location": {
"description": "Location",
"type": "string"
},
"UnitPrice": {
"description": "Unit Price",
"type": "number"
},
"PostComment": {
"description": "Post Comment",
"type": "string"
}
}
},
"ref07e41ee0e0408abf73480c42e5906c55": {
"id": "ref07e41ee0e0408abf73480c42e5906c55",
"description": "Inventory Quantities",
"required": [
"Quantities"
],
"properties": {
"Quantities": {
"description": "Inventory Quantities",
"type": "array",
"items": {
"$ref": "ref38ed31b9be54d2d37d5fcc00f19a0214"
}
},
"Cleanup": {
"description": "Cleanup old in-stock records that are replaced by current import",
"type": "boolean"
},
"ProductCrossReference": {
"description": "Automatically create the referenced product if not found",
"type": "string",
"enum": [
"reject",
"create"
]
}
}
},
"ProductQuantity-GET-query": {
"id": "ProductQuantity-GET-query",
"properties": {
"WarehouseId": {
"type": "string"
},
"ItemName": {
"type": "string"
},
"Upc": {
"type": "string"
}
}
},
"ProductQuantity-GET-200-response": {
"id": "ProductQuantity-GET-200-response",
"description": "Product Operation result",
"required": [
"ProductQuantities"
],
"properties": {
"ProductQuantities": {
"description": "Product quantities data",
"type": "array",
"items": {
"$ref": "ref6fb5e5ebaeb8eaa58896987b51294427"
}
}
}
},
"ProductQuantity-GET-400-response": {
"id": "ProductQuantity-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductQuantity-GET-401-response": {
"id": "ProductQuantity-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductQuantity-GET-500-response": {
"id": "ProductQuantity-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductQuantity-POST-request": {
"id": "ProductQuantity-POST-request",
"description": "Inventory Quantities",
"required": [
"Quantities"
],
"properties": {
"Quantities": {
"description": "Inventory Quantities",
"type": "array",
"items": {
"$ref": "ref38ed31b9be54d2d37d5fcc00f19a0214"
}
},
"Cleanup": {
"description": "Cleanup old in-stock records that are replaced by current import",
"type": "boolean"
},
"ProductCrossReference": {
"description": "Automatically create the referenced product if not found",
"type": "string",
"enum": [
"reject",
"create"
]
}
}
},
"ProductQuantity-POST-200-response": {
"id": "ProductQuantity-POST-200-response",
"description": "Product Operation result",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Product create details",
"type": "array",
"items": {
"$ref": "ref815a0dac4a65477e361c0000389de7ea"
}
}
}
},
"ProductQuantity-POST-400-response": {
"id": "ProductQuantity-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductQuantity-POST-401-response": {
"id": "ProductQuantity-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductQuantity-POST-500-response": {
"id": "ProductQuantity-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref7b5eec57e79a768f18de758fe1ac8dca": {
"id": "ref7b5eec57e79a768f18de758fe1ac8dca",
"description": "Product Feature",
"properties": {
"AttributeName": {
"description": "Attribute Name",
"type": "string"
},
"AttributeValue": {
"description": "Attribute Value",
"type": "string"
},
"SwatchImage": {
"$ref": "ref7e027027ac152e66d3b38a55be649a4a"
}
}
},
"refc77f5b1e20f97022b5138f13f6c8b534": {
"id": "refc77f5b1e20f97022b5138f13f6c8b534",
"description": "Declares product",
"required": [
"ItemName"
],
"properties": {
"ItemName": {
"type": "string"
},
"Asin": {
"type": "string"
},
"Upc": {
"type": "string"
},
"MainImage": {
"$ref": "ref8880f8a95f56ae929d36f16eb878707b"
},
"AdditionalImages": {
"description": "Additional Images",
"type": "array",
"items": {
"$ref": "ref7e027027ac152e66d3b38a55be649a4a"
}
},
"DefaultPrice": {
"type": "number"
},
"Attributes": {
"description": "Variation Attributes",
"type": "array",
"items": {
"$ref": "ref7b5eec57e79a768f18de758fe1ac8dca"
}
},
"DangerousGoodsDetails": {
"$ref": "ref5022200ddeb8dc1faec1cc4cc55b34e1"
}
}
},
"ref35397611093701101f3dccd52437807a": {
"id": "ref35397611093701101f3dccd52437807a",
"description": "Product Variations for selected ParentItemName",
"required": [
"ProductVariations"
],
"properties": {
"ProductVariations": {
"description": "Product variations",
"type": "array",
"items": {
"$ref": "refc77f5b1e20f97022b5138f13f6c8b534"
}
}
}
},
"refe5dad4b9a5ead517328c14e51e14a14c": {
"id": "refe5dad4b9a5ead517328c14e51e14a14c",
"description": "Used to insert Product Variations for ParentItemName",
"required": [
"ParentItemName",
"Variations"
],
"properties": {
"ParentItemName": {
"description": "Parent Item Name of Product Variations inserted",
"type": "string"
},
"Variations": {
"description": "Product Variations to be inserted or updated. If you call method again, all variations will be overwritten",
"type": "array",
"items": {
"$ref": "refc77f5b1e20f97022b5138f13f6c8b534"
}
}
}
},
"ProductVariation-GET-query": {
"id": "ProductVariation-GET-query",
"properties": {
"ParentItemName": {
"type": "string"
}
}
},
"ProductVariation-GET-200-response": {
"id": "ProductVariation-GET-200-response",
"description": "Product Variations for selected ParentItemName",
"required": [
"ProductVariations"
],
"properties": {
"ProductVariations": {
"description": "Product variations",
"type": "array",
"items": {
"$ref": "refc77f5b1e20f97022b5138f13f6c8b534"
}
}
}
},
"ProductVariation-GET-400-response": {
"id": "ProductVariation-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductVariation-GET-401-response": {
"id": "ProductVariation-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductVariation-GET-500-response": {
"id": "ProductVariation-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductVariation-POST-request": {
"id": "ProductVariation-POST-request",
"description": "Used to insert Product Variations for ParentItemName",
"required": [
"ParentItemName",
"Variations"
],
"properties": {
"ParentItemName": {
"description": "Parent Item Name of Product Variations inserted",
"type": "string"
},
"Variations": {
"description": "Product Variations to be inserted or updated. If you call method again, all variations will be overwritten",
"type": "array",
"items": {
"$ref": "refc77f5b1e20f97022b5138f13f6c8b534"
}
}
}
},
"ProductVariation-POST-200-response": {
"id": "ProductVariation-POST-200-response",
"description": "Product Operation result",
"required": [
"Products"
],
"properties": {
"Products": {
"description": "Product create details",
"type": "array",
"items": {
"$ref": "ref815a0dac4a65477e361c0000389de7ea"
}
}
}
},
"ProductVariation-POST-400-response": {
"id": "ProductVariation-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductVariation-POST-401-response": {
"id": "ProductVariation-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductVariation-POST-500-response": {
"id": "ProductVariation-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refd915ab5ba93a5d9c4d36cfc96dbfe502": {
"id": "refd915ab5ba93a5d9c4d36cfc96dbfe502",
"properties": {
"TeapplixSKU": {
"description": "Teapplix SKU",
"type": "string"
},
"SourceItemName": {
"description": "Item Name of product",
"type": "string"
},
"PageSize": {
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"type": "string"
},
"PageNumber": {
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"type": "string"
}
}
},
"ref3f4261940de7d4488ef67218c30ccbe0": {
"id": "ref3f4261940de7d4488ef67218c30ccbe0",
"description": "Declares product mapping",
"required": [
"SourceItemName",
"TeapplixSKU"
],
"properties": {
"SourceItemName": {
"type": "string"
},
"TeapplixSKU": {
"type": "string"
}
}
},
"ref45eaaba2d915b2cbc62095f2f81b9891": {
"id": "ref45eaaba2d915b2cbc62095f2f81b9891",
"required": [
"ProductXrefs"
],
"properties": {
"ProductXrefs": {
"type": "array",
"items": {
"$ref": "ref3f4261940de7d4488ef67218c30ccbe0"
}
},
"Pagination": {
"$ref": "refe57caad9ceb11b8736dc5ff1616e2a20"
}
}
},
"ref01efd5003d37fe041944ab48b2a97dd8": {
"id": "ref01efd5003d37fe041944ab48b2a97dd8",
"description": "Used to insert Products Mapping",
"required": [
"ProductXrefs",
"AutoCleanup"
],
"properties": {
"ProductXrefs": {
"description": "Product Mappings to be inserted",
"type": "array",
"items": {
"$ref": "ref3f4261940de7d4488ef67218c30ccbe0"
}
},
"AutoCleanup": {
"description": "Auto Cleanup flag. false = reject on any issue; true = copy or create of target, followed by deep delete of source, reject if target is QB inventory",
"type": "boolean"
}
}
},
"ref18076dd3bc5dfaa0cc963a0c869ba2c1": {
"id": "ref18076dd3bc5dfaa0cc963a0c869ba2c1",
"required": [
"SourceItemName",
"Success"
],
"properties": {
"SourceItemName": {
"description": "Source Item Name",
"type": "string",
"maximum": 40
},
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page http://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message",
"type": "string"
},
"Teapplix SKU": {
"description": "Teapplix SKU",
"type": "string",
"maximum": 40
}
}
},
"ref81314b20ebec8292eccdce6ccda5d263": {
"id": "ref81314b20ebec8292eccdce6ccda5d263",
"description": "Product Mapping Operation result",
"required": [
"ProductXrefs"
],
"properties": {
"ProductXrefs": {
"description": "Product mapping operation details",
"type": "array",
"items": {
"$ref": "ref18076dd3bc5dfaa0cc963a0c869ba2c1"
}
}
}
},
"ref7aff7e6b13457334e009284c48e4e8b9": {
"id": "ref7aff7e6b13457334e009284c48e4e8b9",
"description": "Used to delete Product Mapping",
"required": [
"ProductXrefs"
],
"properties": {
"ProductXrefs": {
"description": "Source SKU to be deleted",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-GET-query": {
"id": "ProductXref-GET-query",
"properties": {
"TeapplixSKU": {
"description": "Teapplix SKU",
"type": "string"
},
"SourceItemName": {
"description": "Item Name of product",
"type": "string"
},
"PageSize": {
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"type": "string"
},
"PageNumber": {
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"type": "string"
}
}
},
"ProductXref-GET-200-response": {
"id": "ProductXref-GET-200-response",
"required": [
"ProductXrefs"
],
"properties": {
"ProductXrefs": {
"type": "array",
"items": {
"$ref": "ref3f4261940de7d4488ef67218c30ccbe0"
}
},
"Pagination": {
"$ref": "refe57caad9ceb11b8736dc5ff1616e2a20"
}
}
},
"ProductXref-GET-400-response": {
"id": "ProductXref-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-GET-401-response": {
"id": "ProductXref-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-GET-500-response": {
"id": "ProductXref-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-POST-request": {
"id": "ProductXref-POST-request",
"description": "Used to insert Products Mapping",
"required": [
"ProductXrefs",
"AutoCleanup"
],
"properties": {
"ProductXrefs": {
"description": "Product Mappings to be inserted",
"type": "array",
"items": {
"$ref": "ref3f4261940de7d4488ef67218c30ccbe0"
}
},
"AutoCleanup": {
"description": "Auto Cleanup flag. false = reject on any issue; true = copy or create of target, followed by deep delete of source, reject if target is QB inventory",
"type": "boolean"
}
}
},
"ProductXref-POST-200-response": {
"id": "ProductXref-POST-200-response",
"description": "Product Mapping Operation result",
"required": [
"ProductXrefs"
],
"properties": {
"ProductXrefs": {
"description": "Product mapping operation details",
"type": "array",
"items": {
"$ref": "ref18076dd3bc5dfaa0cc963a0c869ba2c1"
}
}
}
},
"ProductXref-POST-400-response": {
"id": "ProductXref-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-POST-401-response": {
"id": "ProductXref-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-POST-500-response": {
"id": "ProductXref-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-DELETE-request": {
"id": "ProductXref-DELETE-request",
"description": "Used to delete Product Mapping",
"required": [
"ProductXrefs"
],
"properties": {
"ProductXrefs": {
"description": "Source SKU to be deleted",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-DELETE-200-response": {
"id": "ProductXref-DELETE-200-response",
"description": "Product Mapping Operation result",
"required": [
"ProductXrefs"
],
"properties": {
"ProductXrefs": {
"description": "Product mapping operation details",
"type": "array",
"items": {
"$ref": "ref18076dd3bc5dfaa0cc963a0c869ba2c1"
}
}
}
},
"ProductXref-DELETE-400-response": {
"id": "ProductXref-DELETE-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-DELETE-401-response": {
"id": "ProductXref-DELETE-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProductXref-DELETE-500-response": {
"id": "ProductXref-DELETE-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref5577cb430e1212c5bb6d493df8d32199": {
"id": "ref5577cb430e1212c5bb6d493df8d32199",
"properties": {
"PSClientID": {
"description": "ClientID known to partner systems. Must uniquely identify a partner account and not duplicate in the partner customer base",
"type": "string"
}
}
},
"ref9e1e442409385663ed383e685f39d6ff": {
"id": "ref9e1e442409385663ed383e685f39d6ff",
"required": [
"AccessToken",
"ClientVHOST",
"ExpireTimeStamp"
],
"properties": {
"AccessToken": {
"description": "Access Token needed to launch UI for a specific paired client account",
"type": "string"
},
"ClientVHOST": {
"description": "This is the Teapplix Account Name for the paired account",
"type": "string"
},
"ExpireTimeStamp": {
"description": "Specifies date time in ISO8601 format, after which access token will expire",
"type": "string"
}
}
},
"PSObtainToken-GET-query": {
"id": "PSObtainToken-GET-query",
"properties": {
"PSClientID": {
"description": "ClientID known to partner systems. Must uniquely identify a partner account and not duplicate in the partner customer base",
"type": "string"
}
}
},
"PSObtainToken-GET-200-response": {
"id": "PSObtainToken-GET-200-response",
"required": [
"AccessToken",
"ClientVHOST",
"ExpireTimeStamp"
],
"properties": {
"AccessToken": {
"description": "Access Token needed to launch UI for a specific paired client account",
"type": "string"
},
"ClientVHOST": {
"description": "This is the Teapplix Account Name for the paired account",
"type": "string"
},
"ExpireTimeStamp": {
"description": "Specifies date time in ISO8601 format, after which access token will expire",
"type": "string"
}
}
},
"PSObtainToken-GET-400-response": {
"id": "PSObtainToken-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PSObtainToken-GET-401-response": {
"id": "PSObtainToken-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PSObtainToken-GET-500-response": {
"id": "PSObtainToken-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref3f9fb92bca2e8d0b5ef16febefb635ec": {
"id": "ref3f9fb92bca2e8d0b5ef16febefb635ec",
"description": "Shipping profile",
"required": [
"ProfileId"
],
"properties": {
"ProfileId": {
"description": "Id of shipping profile, saved in Teapplix Setup",
"type": "integer",
"minimum": 1
}
}
},
"refbca7cf81bcb567f5a24d8ca5b15407e2": {
"id": "refbca7cf81bcb567f5a24d8ca5b15407e2",
"description": "Customs declaration item",
"required": [
"Name",
"Description",
"Quantity",
"Amount"
],
"properties": {
"Name": {
"description": "Item's name",
"type": "string",
"maximum": 255
},
"Sku": {
"description": "Item SKU, should be set if known",
"type": "string",
"maximum": 127
},
"Description": {
"description": "Item's description. Some carriers can print it on label",
"type": "string",
"maximum": 255
},
"Quantity": {
"description": "Quantity of item in the shipment",
"type": "integer",
"minimum": 1
},
"Amount": {
"description": "Customs value subtotal for this item",
"type": "number"
},
"Currency": {
"type": "string"
},
"CustomsWeight": {
"$ref": "ref07f702756ae87a1ee2a7f8357ccd01da"
},
"OriginCountry": {
"description": "Country code of origin country",
"type": "string"
},
"TariffCode": {
"description": "Harmonized Tariff code",
"type": "string"
},
"DGType": {
"description": "USPS Dangerous Goods Type - typically used only for domestic shipments, applies USPS and DHL",
"type": "integer"
}
}
},
"ref6a9d1e9c605c1e954d0e1bb9d5069801": {
"id": "ref6a9d1e9c605c1e954d0e1bb9d5069801",
"description": "Customs declaration",
"properties": {
"ReasonForExport": {
"type": "string",
"maximum": 20
},
"IOSSNumber": {
"description": "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.",
"type": "string"
},
"BrokerAddress": {
"description": "Broker Address",
"type": "string"
},
"Items": {
"description": "For ForOrder version of the API, Teapplix will use your order items to build ocmmercial invoice if Items list is not specified.",
"type": "array",
"items": {
"$ref": "refbca7cf81bcb567f5a24d8ca5b15407e2"
}
}
}
},
"refa699e3818e61b627937a8a17675c30c8": {
"id": "refa699e3818e61b627937a8a17675c30c8",
"description": "Format of returned labels",
"properties": {
"Layout": {
"description": "DEPRECATED! Shipping Profile layout settings are used to select label layout.",
"type": "string",
"enum": [
"4x6",
"4x6_PACKING",
"4x6_ROTATED",
"8x11",
"8x11_PACKING",
"A4",
"10CM"
]
},
"Type": {
"description": "Selects the format label image should be returned in.\n
PDF: Return label as a PDF, with overlays and transformations as dictated by shipping profile.\n
RAW: Return native image from the carrier, without any transfromations.",
"type": "string",
"enum": [
"PDF",
"RAW"
]
},
"LabelReturn": {
"description": "Selects how result label should be returned. \n
URL: return URL to download the label document with in LabelData Content. You must call API DownloadLabel separately to obtain the label\n
INLINE: return base64 encoded label in LabelData Content.",
"type": "string",
"enum": [
"INLINE",
"URL",
"PRINT"
]
}
}
},
"ref45feb94067dc5aec2bd3ef9164961b24": {
"id": "ref45feb94067dc5aec2bd3ef9164961b24",
"description": "Represents single label purchase request",
"required": [
"ClientRequestId",
"From",
"To",
"Packages"
],
"properties": {
"ClientRequestId": {
"description": "Caller supplied unique id for each request. If you call next time using the same unique id, the previously purchased label will be returned to you instead of purchasing a new one.",
"type": "string"
},
"ShipDate": {
"description": "Shipping date of package. Only today or future date is allowed. Past date will be auto-corrected to today.",
"type": "string"
},
"From": {
"$ref": "ref4eff855b7f66f77aa1ef13f6279f3993"
},
"To": {
"$ref": "ref6ee81e82b13ed65ee13c36677c707bb1"
},
"Packages": {
"description": "Packages to be sent",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsDeclaration": {
"$ref": "ref6a9d1e9c605c1e954d0e1bb9d5069801"
},
"ImageFormat": {
"$ref": "refa699e3818e61b627937a8a17675c30c8"
},
"IsReturn": {
"description": "Should be set if return label is requested",
"type": "boolean"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"ref9787a4cd0450894226248088e6791310": {
"id": "ref9787a4cd0450894226248088e6791310",
"description": "Represents purchase label result",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
},
"ClientRequestId": {
"description": "This is the same ClientRequestId that caller passed in, returned to the caller.",
"type": "string"
},
"TrackingInfo": {
"description": "Array with tracking info for generated labels",
"type": "array",
"items": {
"$ref": "refb397657fb92ce6ddbb0880c86ad7ac1a"
}
},
"LabelData": {
"description": "Array with base64 encoded data of label image, in the requested format.",
"type": "array",
"items": {
"$ref": "refac95a64bd730e18a5f60663f2d63baf6"
}
},
"DocumentsData": {
"description": "Array with document URL or contents",
"type": "array",
"items": {
"$ref": "refac95a64bd730e18a5f60663f2d63baf6"
}
},
"PostageAmount": {
"$ref": "ref9363d0ad3362299bf9e573650ac698bf"
},
"ASN": {
"description": "DEPRECATED! ASN Number for Walmart DSV ship to store orders",
"type": "string"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"PurchaseLabel-POST-request": {
"id": "PurchaseLabel-POST-request",
"description": "Represents single label purchase request",
"required": [
"ClientRequestId",
"From",
"To",
"Packages"
],
"properties": {
"ClientRequestId": {
"description": "Caller supplied unique id for each request. If you call next time using the same unique id, the previously purchased label will be returned to you instead of purchasing a new one.",
"type": "string"
},
"ShipDate": {
"description": "Shipping date of package. Only today or future date is allowed. Past date will be auto-corrected to today.",
"type": "string"
},
"From": {
"$ref": "ref4eff855b7f66f77aa1ef13f6279f3993"
},
"To": {
"$ref": "ref6ee81e82b13ed65ee13c36677c707bb1"
},
"Packages": {
"description": "Packages to be sent",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsDeclaration": {
"$ref": "ref6a9d1e9c605c1e954d0e1bb9d5069801"
},
"ImageFormat": {
"$ref": "refa699e3818e61b627937a8a17675c30c8"
},
"IsReturn": {
"description": "Should be set if return label is requested",
"type": "boolean"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"PurchaseLabel-POST-200-response": {
"id": "PurchaseLabel-POST-200-response",
"description": "Represents purchase label result",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
},
"ClientRequestId": {
"description": "This is the same ClientRequestId that caller passed in, returned to the caller.",
"type": "string"
},
"TrackingInfo": {
"description": "Array with tracking info for generated labels",
"type": "array",
"items": {
"$ref": "refb397657fb92ce6ddbb0880c86ad7ac1a"
}
},
"LabelData": {
"description": "Array with base64 encoded data of label image, in the requested format.",
"type": "array",
"items": {
"$ref": "refac95a64bd730e18a5f60663f2d63baf6"
}
},
"DocumentsData": {
"description": "Array with document URL or contents",
"type": "array",
"items": {
"$ref": "refac95a64bd730e18a5f60663f2d63baf6"
}
},
"PostageAmount": {
"$ref": "ref9363d0ad3362299bf9e573650ac698bf"
},
"ASN": {
"description": "DEPRECATED! ASN Number for Walmart DSV ship to store orders",
"type": "string"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"PurchaseLabel-POST-400-response": {
"id": "PurchaseLabel-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PurchaseLabel-POST-500-response": {
"id": "PurchaseLabel-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref5d952382f61961877c7c9269750ab205": {
"id": "ref5d952382f61961877c7c9269750ab205",
"description": "Represents single label purchase request",
"required": [
"TxnId",
"From",
"Packages"
],
"properties": {
"TxnId": {
"description": "Id of order already stored at Teapplix account",
"type": "string"
},
"ShipDate": {
"description": "Shipping date of package. Only today or future date is allowed. Past date will be auto-corrected to today.",
"type": "string"
},
"From": {
"$ref": "ref4eff855b7f66f77aa1ef13f6279f3993"
},
"Packages": {
"description": "Packages to be sent. First package in sequence is main package, others are extra packages. Minimum 1 item required.",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsDeclaration": {
"$ref": "ref6a9d1e9c605c1e954d0e1bb9d5069801"
},
"ImageFormat": {
"$ref": "refa699e3818e61b627937a8a17675c30c8"
},
"IsReturn": {
"description": "DEPRECATED. If an order is a return order, we automatically print a return label.",
"type": "boolean"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"PurchaseLabelForOrder-POST-request": {
"id": "PurchaseLabelForOrder-POST-request",
"description": "Represents single label purchase request",
"required": [
"TxnId",
"From",
"Packages"
],
"properties": {
"TxnId": {
"description": "Id of order already stored at Teapplix account",
"type": "string"
},
"ShipDate": {
"description": "Shipping date of package. Only today or future date is allowed. Past date will be auto-corrected to today.",
"type": "string"
},
"From": {
"$ref": "ref4eff855b7f66f77aa1ef13f6279f3993"
},
"Packages": {
"description": "Packages to be sent. First package in sequence is main package, others are extra packages. Minimum 1 item required.",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsDeclaration": {
"$ref": "ref6a9d1e9c605c1e954d0e1bb9d5069801"
},
"ImageFormat": {
"$ref": "refa699e3818e61b627937a8a17675c30c8"
},
"IsReturn": {
"description": "DEPRECATED. If an order is a return order, we automatically print a return label.",
"type": "boolean"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"PurchaseLabelForOrder-POST-200-response": {
"id": "PurchaseLabelForOrder-POST-200-response",
"description": "Represents purchase label result",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
},
"ClientRequestId": {
"description": "This is the same ClientRequestId that caller passed in, returned to the caller.",
"type": "string"
},
"TrackingInfo": {
"description": "Array with tracking info for generated labels",
"type": "array",
"items": {
"$ref": "refb397657fb92ce6ddbb0880c86ad7ac1a"
}
},
"LabelData": {
"description": "Array with base64 encoded data of label image, in the requested format.",
"type": "array",
"items": {
"$ref": "refac95a64bd730e18a5f60663f2d63baf6"
}
},
"DocumentsData": {
"description": "Array with document URL or contents",
"type": "array",
"items": {
"$ref": "refac95a64bd730e18a5f60663f2d63baf6"
}
},
"PostageAmount": {
"$ref": "ref9363d0ad3362299bf9e573650ac698bf"
},
"ASN": {
"description": "DEPRECATED! ASN Number for Walmart DSV ship to store orders",
"type": "string"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"PurchaseLabelForOrder-POST-400-response": {
"id": "PurchaseLabelForOrder-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PurchaseLabelForOrder-POST-500-response": {
"id": "PurchaseLabelForOrder-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref56cd64f0f35ccb350e1a7fee63b9b7b7": {
"id": "ref56cd64f0f35ccb350e1a7fee63b9b7b7",
"description": "'APIToken' header should be included in each request",
"required": [
"From",
"To",
"Packages"
],
"properties": {
"ShipDate": {
"type": "string"
},
"From": {
"$ref": "ref4eff855b7f66f77aa1ef13f6279f3993"
},
"To": {
"$ref": "ref6ee81e82b13ed65ee13c36677c707bb1"
},
"Packages": {
"description": "Packages to be sent",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsDeclaration": {
"$ref": "ref6a9d1e9c605c1e954d0e1bb9d5069801"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"reffd7f5c4d9135acc755f979da88f690dd": {
"id": "reffd7f5c4d9135acc755f979da88f690dd",
"required": [
"Transportation",
"Name"
],
"properties": {
"Transportation": {
"description": "Base transportation price",
"type": "number"
},
"ServiceAmount": {
"description": "The sum of all shipping service fees",
"type": "number"
},
"ServiceFees": {
"description": "Detailed description of shipping fees. If set then ServiceAmount will be ignored (if present)",
"type": "array",
"items": {
"$ref": "refe7c6f50c58f89ea8bb836717be2179e0"
}
},
"Discount": {
"description": "Detailed description of discounts.",
"type": "array",
"items": {
"$ref": "refe7c6f50c58f89ea8bb836717be2179e0"
}
},
"Currency": {
"description": "The currency for this rate",
"type": "string"
},
"Name": {
"description": "The shipping method name",
"type": "string"
},
"ShipMethod": {
"description": "The shipping method",
"type": "string"
},
"DeliveryDate": {
"description": "Estimated delivery date",
"type": "string"
}
}
},
"ref22e958057b5b4996362915625292595a": {
"id": "ref22e958057b5b4996362915625292595a",
"properties": {
"Zone": {
"description": "Provider's shipping zone (if available)",
"type": "string"
},
"Rate": {
"$ref": "reffd7f5c4d9135acc755f979da88f690dd"
},
"AltRates": {
"description": "Information related to the alternate rates of the shipment",
"type": "array",
"items": {
"$ref": "reffd7f5c4d9135acc755f979da88f690dd"
}
},
"Warnings": {
"description": "Warning related to the this request",
"type": "array",
"items": {
"$ref": "ref16facdc1388da12ce6d4621e89c839eb"
}
}
}
},
"Rates-POST-request": {
"id": "Rates-POST-request",
"description": "'APIToken' header should be included in each request",
"required": [
"From",
"To",
"Packages"
],
"properties": {
"ShipDate": {
"type": "string"
},
"From": {
"$ref": "ref4eff855b7f66f77aa1ef13f6279f3993"
},
"To": {
"$ref": "ref6ee81e82b13ed65ee13c36677c707bb1"
},
"Packages": {
"description": "Packages to be sent",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsDeclaration": {
"$ref": "ref6a9d1e9c605c1e954d0e1bb9d5069801"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"Rates-POST-200-response": {
"id": "Rates-POST-200-response",
"properties": {
"Zone": {
"description": "Provider's shipping zone (if available)",
"type": "string"
},
"Rate": {
"$ref": "reffd7f5c4d9135acc755f979da88f690dd"
},
"AltRates": {
"description": "Information related to the alternate rates of the shipment",
"type": "array",
"items": {
"$ref": "reffd7f5c4d9135acc755f979da88f690dd"
}
},
"Warnings": {
"description": "Warning related to the this request",
"type": "array",
"items": {
"$ref": "ref16facdc1388da12ce6d4621e89c839eb"
}
}
}
},
"Rates-POST-400-response": {
"id": "Rates-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Rates-POST-401-response": {
"id": "Rates-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Rates-POST-500-response": {
"id": "Rates-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Rates-POST-501-response": {
"id": "Rates-POST-501-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refa3990588bc3939e6e9e7000ac1608a99": {
"id": "refa3990588bc3939e6e9e7000ac1608a99",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnId",
"From",
"Packages"
],
"properties": {
"TxnId": {
"type": "string"
},
"ShipDate": {
"type": "string"
},
"From": {
"$ref": "ref4eff855b7f66f77aa1ef13f6279f3993"
},
"Packages": {
"description": "Packages to be sent",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsDeclaration": {
"$ref": "ref6a9d1e9c605c1e954d0e1bb9d5069801"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"RatesForOrder-POST-request": {
"id": "RatesForOrder-POST-request",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnId",
"From",
"Packages"
],
"properties": {
"TxnId": {
"type": "string"
},
"ShipDate": {
"type": "string"
},
"From": {
"$ref": "ref4eff855b7f66f77aa1ef13f6279f3993"
},
"Packages": {
"description": "Packages to be sent",
"type": "array",
"items": {
"$ref": "ref30651b110bc94954a0f7d4b22c0fdd91"
}
},
"Options": {
"$ref": "ref2191e2efbb5c82c98047ba80b9935c32"
},
"CustomsDeclaration": {
"$ref": "ref6a9d1e9c605c1e954d0e1bb9d5069801"
},
"Provider": {
"description": "Provider which will be used to print label",
"type": "string",
"enum": [
"TEAPPLIX",
"EVS",
"GSS",
"PBOWESPS",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"FIMS",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"STAMPS_COM",
"RATESHOP"
]
}
}
},
"RatesForOrder-POST-200-response": {
"id": "RatesForOrder-POST-200-response",
"properties": {
"Zone": {
"description": "Provider's shipping zone (if available)",
"type": "string"
},
"Rate": {
"$ref": "reffd7f5c4d9135acc755f979da88f690dd"
},
"AltRates": {
"description": "Information related to the alternate rates of the shipment",
"type": "array",
"items": {
"$ref": "reffd7f5c4d9135acc755f979da88f690dd"
}
},
"Warnings": {
"description": "Warning related to the this request",
"type": "array",
"items": {
"$ref": "ref16facdc1388da12ce6d4621e89c839eb"
}
}
}
},
"RatesForOrder-POST-400-response": {
"id": "RatesForOrder-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"RatesForOrder-POST-401-response": {
"id": "RatesForOrder-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"RatesForOrder-POST-500-response": {
"id": "RatesForOrder-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refc2c1bb9a10b376e9380b3db5695abfaa": {
"id": "refc2c1bb9a10b376e9380b3db5695abfaa",
"properties": {
"TxnId": {
"description": "Find shipment info for a specific order",
"type": "string"
},
"ShipCarrier": {
"description": "Obtain shipment information with matching carrier",
"type": "string"
},
"TrackingNumber": {
"description": "Obtain shipment infromation with matching tracking number",
"type": "string"
},
"ShipDateStart": {
"description": "inclusive - limit to all orders shipped starting this date, format YYYY-MM-DD, YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00",
"type": "string"
},
"ShipDateEnd": {
"description": "inclusive - limit to all orders shipped until this date, format YYYY-MM-DD, YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00",
"type": "string"
},
"QueueId": {
"description": "Limit orders placed in a specific queue id",
"type": "integer"
},
"StoreType": {
"description": "Store Type. Limit to orders from specific channel",
"type": "string"
},
"StoreKey": {
"description": "Store Key. This must be specified together with StoreType, limit to orders from specific channel + account",
"type": "string"
},
"ReturnLabel": {
"description": "Return Label Flag (0|1). If you set this parameter, return will contain PDF of order label base64 encoded",
"type": "integer"
}
}
},
"ref1dbcafe8e549ec1bcbbf328b747923b1": {
"id": "ref1dbcafe8e549ec1bcbbf328b747923b1",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Unique transaction id",
"type": "string"
},
"PackageNo": {
"description": "Number of package. Starting from 0. Currently support only PackageNo=0",
"type": "integer"
},
"ShipMethod": {
"description": "Ship Method. Will accept both API Enum or Teapplix native value on POST. Will atttempt to always return API Enum on GET.",
"type": "string"
},
"Weight": {
"$ref": "ref07f702756ae87a1ee2a7f8357ccd01da"
},
"Dimensions": {
"$ref": "ref48ee594915301e37caddcaf617d21c51"
},
"IdenticalPackageCount": {
"description": "Count of identical packages. Currently supported only for FedEx/UPS",
"type": "integer",
"minimum": 1
},
"WarehouseId": {
"description": "Warehouse Id the order is shipped from. Affects where inventory is deducted from.",
"type": "integer"
},
"ShipDate": {
"description": "Ship date, format YYYY-MM-DD. On input also supported YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00. If you provide ShipDate in request the order will be marked as shipped. If not you can update ShipMethod, Weight, Dimensions, IdenticalPackageCount and WarehouseId for open orders.",
"type": "string"
},
"TrackingInfo": {
"$ref": "refb397657fb92ce6ddbb0880c86ad7ac1a"
},
"LabelData": {
"$ref": "refac95a64bd730e18a5f60663f2d63baf6"
},
"ProfileId": {
"description": "Profile Id used to print the label. If label is not printed in Teapplix, returns 1. On input only used with Ship Date + LabelData, all Shipments from same POST must have same Profile Id",
"type": "integer"
},
"PostageAmount": {
"$ref": "ref9363d0ad3362299bf9e573650ac698bf"
},
"PostageAccount": {
"description": "Postage Account.",
"type": "string"
}
}
},
"ref2614b81dc9e47469fde47f6ce9c9d557": {
"id": "ref2614b81dc9e47469fde47f6ce9c9d557",
"description": "Shipment details",
"required": [
"Items"
],
"properties": {
"Items": {
"description": "Shipments details of orders",
"type": "array",
"items": {
"$ref": "ref1dbcafe8e549ec1bcbbf328b747923b1"
}
}
}
},
"ref3cd45827c436c746467c3398d4fdcb81": {
"id": "ref3cd45827c436c746467c3398d4fdcb81",
"description": "Used to set shipping details for order shipped outside of Teapplix",
"required": [
"Shipments"
],
"properties": {
"Shipments": {
"description": "Shipments details of orders to be marked",
"type": "array",
"items": {
"$ref": "ref1dbcafe8e549ec1bcbbf328b747923b1"
}
},
"Force": {
"description": "Force - force update of shipment parameters even if order is already marked as shipped. Orders where label is printed in Teapplix cannot be updated again even if you set Force to true",
"type": "boolean"
}
}
},
"ref05c20cc86cced10c71bd5736317d4676": {
"id": "ref05c20cc86cced10c71bd5736317d4676",
"required": [
"TxnId",
"Status"
],
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maximum": 40
},
"Status": {
"description": "Submission status for order:",
"type": "string",
"enum": [
"Confirmed",
"NotFound",
"Failure"
]
},
"Message": {
"description": "Message",
"type": "string"
}
}
},
"ref771639ffc1c8799b9664156929ed9355": {
"id": "ref771639ffc1c8799b9664156929ed9355",
"properties": {
"Items": {
"description": "List of results",
"type": "array",
"items": {
"$ref": "ref05c20cc86cced10c71bd5736317d4676"
}
}
}
},
"Shipment-GET-query": {
"id": "Shipment-GET-query",
"properties": {
"TxnId": {
"description": "Find shipment info for a specific order",
"type": "string"
},
"ShipCarrier": {
"description": "Obtain shipment information with matching carrier",
"type": "string"
},
"TrackingNumber": {
"description": "Obtain shipment infromation with matching tracking number",
"type": "string"
},
"ShipDateStart": {
"description": "inclusive - limit to all orders shipped starting this date, format YYYY-MM-DD, YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00",
"type": "string"
},
"ShipDateEnd": {
"description": "inclusive - limit to all orders shipped until this date, format YYYY-MM-DD, YYYY/MM/DD, or datetime format that contain timezone, e.g. 2024-05-14T09:00:00-08:00",
"type": "string"
},
"QueueId": {
"description": "Limit orders placed in a specific queue id",
"type": "integer"
},
"StoreType": {
"description": "Store Type. Limit to orders from specific channel",
"type": "string"
},
"StoreKey": {
"description": "Store Key. This must be specified together with StoreType, limit to orders from specific channel + account",
"type": "string"
},
"ReturnLabel": {
"description": "Return Label Flag (0|1). If you set this parameter, return will contain PDF of order label base64 encoded",
"type": "integer"
}
}
},
"Shipment-GET-200-response": {
"id": "Shipment-GET-200-response",
"description": "Shipment details",
"required": [
"Items"
],
"properties": {
"Items": {
"description": "Shipments details of orders",
"type": "array",
"items": {
"$ref": "ref1dbcafe8e549ec1bcbbf328b747923b1"
}
}
}
},
"Shipment-GET-400-response": {
"id": "Shipment-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Shipment-GET-401-response": {
"id": "Shipment-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Shipment-GET-500-response": {
"id": "Shipment-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Shipment-POST-request": {
"id": "Shipment-POST-request",
"description": "Used to set shipping details for order shipped outside of Teapplix",
"required": [
"Shipments"
],
"properties": {
"Shipments": {
"description": "Shipments details of orders to be marked",
"type": "array",
"items": {
"$ref": "ref1dbcafe8e549ec1bcbbf328b747923b1"
}
},
"Force": {
"description": "Force - force update of shipment parameters even if order is already marked as shipped. Orders where label is printed in Teapplix cannot be updated again even if you set Force to true",
"type": "boolean"
}
}
},
"Shipment-POST-200-response": {
"id": "Shipment-POST-200-response",
"properties": {
"Items": {
"description": "List of results",
"type": "array",
"items": {
"$ref": "ref05c20cc86cced10c71bd5736317d4676"
}
}
}
},
"Shipment-POST-400-response": {
"id": "Shipment-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Shipment-POST-500-response": {
"id": "Shipment-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref9caff0499a977648c2658abee9935ad2": {
"id": "ref9caff0499a977648c2658abee9935ad2",
"properties": {
"ProfileId": {
"description": "Filter by profile ID (exact match). Use to look up a specific shipping profile by its numeric ID.",
"type": "integer"
},
"Active": {
"description": "Filter by active flag: 1 = active only, 0 = inactive only. Omit to return all profiles.",
"type": "integer"
},
"Name": {
"description": "Case-insensitive substring search on profile name. Returns all profiles whose name contains this string.",
"type": "string"
}
}
},
"ref39e3b52fe0cb4326fd434cadc07ce4eb": {
"id": "ref39e3b52fe0cb4326fd434cadc07ce4eb",
"description": "Shipping profile (identity, address, return address)",
"properties": {
"ProfileId": {
"type": "integer"
},
"ProfileName": {
"type": "string"
},
"Active": {
"type": "integer"
},
"AddressName": {
"type": "string"
},
"AddressCompany": {
"type": "string"
},
"AddressStreet": {
"type": "string"
},
"AddressStreet2": {
"type": "string"
},
"AddressCity": {
"type": "string"
},
"AddressState": {
"type": "string"
},
"AddressZip": {
"type": "string"
},
"AddressCountry": {
"type": "string"
},
"AddressCountryCode": {
"type": "string"
},
"ContactPhone": {
"type": "string"
},
"UseReturnAddress": {
"type": "integer"
},
"ReturnAddressName": {
"type": "string"
},
"ReturnAddressCompany": {
"type": "string"
},
"ReturnAddressStreet": {
"type": "string"
},
"ReturnAddressStreet2": {
"type": "string"
},
"ReturnAddressCity": {
"type": "string"
},
"ReturnAddressState": {
"type": "string"
},
"ReturnAddressZip": {
"type": "string"
},
"ReturnAddressCountry": {
"type": "string"
},
"ReturnAddressCountryCode": {
"type": "string"
},
"ReturnContactPhone": {
"type": "string"
}
}
},
"ref09d68befc6668ff5fda486a03789b50c": {
"id": "ref09d68befc6668ff5fda486a03789b50c",
"required": [
"Profiles"
],
"properties": {
"Profiles": {
"type": "array",
"items": {
"$ref": "ref39e3b52fe0cb4326fd434cadc07ce4eb"
}
}
}
},
"ShippingProfile-GET-query": {
"id": "ShippingProfile-GET-query",
"properties": {
"ProfileId": {
"description": "Filter by profile ID (exact match). Use to look up a specific shipping profile by its numeric ID.",
"type": "integer"
},
"Active": {
"description": "Filter by active flag: 1 = active only, 0 = inactive only. Omit to return all profiles.",
"type": "integer"
},
"Name": {
"description": "Case-insensitive substring search on profile name. Returns all profiles whose name contains this string.",
"type": "string"
}
}
},
"ShippingProfile-GET-200-response": {
"id": "ShippingProfile-GET-200-response",
"required": [
"Profiles"
],
"properties": {
"Profiles": {
"type": "array",
"items": {
"$ref": "ref39e3b52fe0cb4326fd434cadc07ce4eb"
}
}
}
},
"ShippingProfile-GET-400-response": {
"id": "ShippingProfile-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ShippingProfile-GET-401-response": {
"id": "ShippingProfile-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ShippingProfile-GET-500-response": {
"id": "ShippingProfile-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref9334445f70f65ddd393722299aa3eaf6": {
"id": "ref9334445f70f65ddd393722299aa3eaf6",
"description": "Order item",
"properties": {
"Name": {
"description": "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.",
"type": "string",
"maximum": 255
},
"LineNumber": {
"description": "Line Number",
"type": "integer"
},
"Description": {
"description": "Item description",
"type": "string",
"maximum": 255
},
"Quantity": {
"description": "The quantity of this item ordered",
"type": "integer"
},
"Amount": {
"description": "Subtotal for this order line",
"type": "number"
},
"ItemCustom": {
"description": "Item Custom field",
"type": "string",
"maximum": 255
},
"ParentLineNumber": {
"description": "Line Number in Parent. One of ParentLineNumber, ParentItemName or Name is used to find the Item in the Order being split.",
"type": "integer"
},
"ParentItemName": {
"description": "Item Name in Parent. Use Parent Item Name only if it is unique, otherwise use Parent Line Number.",
"type": "string",
"maximum": 255
}
}
},
"ref038c6ecffb6a1a872d48aba9178cc349": {
"id": "ref038c6ecffb6a1a872d48aba9178cc349",
"required": [
"TxnId",
"OrderDetails",
"OrderItems"
],
"properties": {
"TxnId": {
"description": "Order Id for the sub order, must be unique",
"type": "string",
"maximum": 40
},
"OrderDetails": {
"$ref": "refd1fdb1529ea3a2d4feda9587a3440360"
},
"OrderItems": {
"description": "Items assigned to the sub order. SplitOrder API enforces that sum of all sub order's items matches the items of parent order.",
"type": "array",
"items": {
"$ref": "ref9334445f70f65ddd393722299aa3eaf6"
}
},
"ShippingDetails": {
"description": "Information related to the order\u2019s ship method, weight and dimensions. Optional and for split order we do not support extra packages, so specify only one Order Shipment here.",
"type": "array",
"items": {
"$ref": "refaf6a999faae7bb71db317916ba8ac2ae"
}
},
"Hold": {
"description": "Hold for now",
"type": "boolean"
}
}
},
"reff9bb392acf7422182d4f1cae4207d25d": {
"id": "reff9bb392acf7422182d4f1cae4207d25d",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Order Id for the parent order that will be split. Notice that each order can only be split once.",
"type": "string",
"maximum": 40
},
"Orders": {
"description": "Array of 2 or more child Orders to create.",
"type": "array",
"items": {
"$ref": "ref038c6ecffb6a1a872d48aba9178cc349"
}
}
}
},
"refd5f3d7762b320bfc4b4806c370628d0e": {
"id": "refd5f3d7762b320bfc4b4806c370628d0e",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Order Id for the parent order that was split. Please note: all child orders will be removed",
"type": "string",
"maximum": 40
}
}
},
"SplitOrder-POST-request": {
"id": "SplitOrder-POST-request",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Order Id for the parent order that will be split. Notice that each order can only be split once.",
"type": "string",
"maximum": 40
},
"Orders": {
"description": "Array of 2 or more child Orders to create.",
"type": "array",
"items": {
"$ref": "ref038c6ecffb6a1a872d48aba9178cc349"
}
}
}
},
"SplitOrder-POST-200-response": {
"id": "SplitOrder-POST-200-response",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refed98c3fa3d8b48f59b990b936f1cf609"
}
}
}
},
"SplitOrder-POST-400-response": {
"id": "SplitOrder-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SplitOrder-POST-401-response": {
"id": "SplitOrder-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SplitOrder-POST-500-response": {
"id": "SplitOrder-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SplitOrder-DELETE-request": {
"id": "SplitOrder-DELETE-request",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Order Id for the parent order that was split. Please note: all child orders will be removed",
"type": "string",
"maximum": 40
}
}
},
"SplitOrder-DELETE-200-response": {
"id": "SplitOrder-DELETE-200-response",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refed98c3fa3d8b48f59b990b936f1cf609"
}
}
}
},
"SplitOrder-DELETE-400-response": {
"id": "SplitOrder-DELETE-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SplitOrder-DELETE-401-response": {
"id": "SplitOrder-DELETE-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SplitOrder-DELETE-500-response": {
"id": "SplitOrder-DELETE-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SplitOrderCont-POST-request": {
"id": "SplitOrderCont-POST-request",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnId"
],
"properties": {
"TxnId": {
"description": "Order Id for the parent order that will be split. Notice that each order can only be split once.",
"type": "string",
"maximum": 40
},
"Orders": {
"description": "Array of 2 or more child Orders to create.",
"type": "array",
"items": {
"$ref": "ref038c6ecffb6a1a872d48aba9178cc349"
}
}
}
},
"SplitOrderCont-POST-200-response": {
"id": "SplitOrderCont-POST-200-response",
"required": [
"OrdersResult"
],
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "refed98c3fa3d8b48f59b990b936f1cf609"
}
}
}
},
"SplitOrderCont-POST-400-response": {
"id": "SplitOrderCont-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SplitOrderCont-POST-401-response": {
"id": "SplitOrderCont-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"SplitOrderCont-POST-500-response": {
"id": "SplitOrderCont-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref770058d3a4ca9d76c05c46c990860f20": {
"id": "ref770058d3a4ca9d76c05c46c990860f20",
"properties": {
"Carrier": {
"description": "Carrier name, possible values 'USPS', 'UPS', 'FEDEX', 'DHLE', 'DHL'",
"type": "string"
},
"TrackingNumber": {
"description": "Shipment tracking #",
"type": "string"
}
}
},
"ref084481d3ee01b21767fcfcf7c8545a3a": {
"id": "ref084481d3ee01b21767fcfcf7c8545a3a",
"required": [
"Type"
],
"properties": {
"DateTime": {
"description": "Event date and time (UTC)",
"type": "string"
},
"City": {
"description": "City where event occurred (if available)",
"type": "string"
},
"State": {
"description": "State where event occurred (if available)",
"type": "string"
},
"Country": {
"description": "Country where event occurred (if available)",
"type": "string"
},
"PostalCode": {
"description": "Postal or ZIP code where event occurred (if available)",
"type": "string"
},
"Type": {
"description": "Event type",
"type": "string",
"enum": [
"DELIVERY",
"RETURN",
"PICKUP",
"SUBMIT_TO_CARRIER",
"ADJUST_WEIGHT_RATE",
"PRESORT",
"EXCEPTION",
"OTHER"
]
},
"Description": {
"description": "Event type description (if available)",
"type": "string"
}
}
},
"refeb5771d0ba48fffc31bcda395e14347e": {
"id": "refeb5771d0ba48fffc31bcda395e14347e",
"required": [
"TrackingNumber",
"IsDelivered"
],
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maximum": 40
},
"PackageNo": {
"description": "Package Number",
"type": "integer"
},
"ShipDate": {
"description": "Shipping date",
"type": "string",
"format": "date"
},
"TrackingNumber": {
"description": "Tracking number of shipment",
"type": "string",
"maximum": 50
},
"CarrierName": {
"description": "Carrier name which is assigned with tracking",
"type": "string"
},
"IsDelivered": {
"description": "Was package delivered",
"type": "boolean"
},
"EstimatedDeliveryDate": {
"description": "Estimated Delivery Date (if available)",
"type": "string"
},
"Events": {
"description": "Tracking events details",
"type": "array",
"items": {
"$ref": "ref084481d3ee01b21767fcfcf7c8545a3a"
}
}
}
},
"ref56ceb9e5a399bdaa8c515e7e2941ffbe": {
"id": "ref56ceb9e5a399bdaa8c515e7e2941ffbe",
"properties": {
"Shipments": {
"type": "array",
"items": {
"$ref": "refeb5771d0ba48fffc31bcda395e14347e"
}
}
}
},
"Track-GET-query": {
"id": "Track-GET-query",
"properties": {
"Carrier": {
"description": "Carrier name, possible values 'USPS', 'UPS', 'FEDEX', 'DHLE', 'DHL'",
"type": "string"
},
"TrackingNumber": {
"description": "Shipment tracking #",
"type": "string"
}
}
},
"Track-GET-200-response": {
"id": "Track-GET-200-response",
"required": [
"TrackingNumber",
"IsDelivered"
],
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maximum": 40
},
"PackageNo": {
"description": "Package Number",
"type": "integer"
},
"ShipDate": {
"description": "Shipping date",
"type": "string",
"format": "date"
},
"TrackingNumber": {
"description": "Tracking number of shipment",
"type": "string",
"maximum": 50
},
"CarrierName": {
"description": "Carrier name which is assigned with tracking",
"type": "string"
},
"IsDelivered": {
"description": "Was package delivered",
"type": "boolean"
},
"EstimatedDeliveryDate": {
"description": "Estimated Delivery Date (if available)",
"type": "string"
},
"Events": {
"description": "Tracking events details",
"type": "array",
"items": {
"$ref": "ref084481d3ee01b21767fcfcf7c8545a3a"
}
}
}
},
"Track-GET-400-response": {
"id": "Track-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Track-GET-500-response": {
"id": "Track-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Track-POST-request": {
"id": "Track-POST-request",
"properties": {
"Shipments": {
"type": "array",
"items": {
"$ref": "refeb5771d0ba48fffc31bcda395e14347e"
}
}
}
},
"Track-POST-200-response": {
"id": "Track-POST-200-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Track-POST-400-response": {
"id": "Track-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Track-POST-501-response": {
"id": "Track-POST-501-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref9dd412ac92fa8ffe7dfc26c08580dedc": {
"id": "ref9dd412ac92fa8ffe7dfc26c08580dedc",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnIds"
],
"properties": {
"EventId": {
"type": "string",
"enum": [
"80",
"81",
"82"
]
},
"TxnIds": {
"description": "List of TxnId to upload Vendor Scan for",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refeeb2cc6e123d8cb920d802343bf061cb": {
"id": "refeeb2cc6e123d8cb920d802343bf061cb",
"required": [
"Status"
],
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Warnings": {
"description": "Warning related to the this request",
"type": "array",
"items": {
"$ref": "ref16facdc1388da12ce6d4621e89c839eb"
}
}
}
},
"VendorScan-POST-request": {
"id": "VendorScan-POST-request",
"description": "'APIToken' header should be included in each request",
"required": [
"TxnIds"
],
"properties": {
"EventId": {
"type": "string",
"enum": [
"80",
"81",
"82"
]
},
"TxnIds": {
"description": "List of TxnId to upload Vendor Scan for",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"VendorScan-POST-200-response": {
"id": "VendorScan-POST-200-response",
"required": [
"Status"
],
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Warnings": {
"description": "Warning related to the this request",
"type": "array",
"items": {
"$ref": "ref16facdc1388da12ce6d4621e89c839eb"
}
}
}
},
"VendorScan-POST-400-response": {
"id": "VendorScan-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"VendorScan-POST-401-response": {
"id": "VendorScan-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"VendorScan-POST-500-response": {
"id": "VendorScan-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"VendorScan-POST-501-response": {
"id": "VendorScan-POST-501-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"refa61cb0821061a6d87aa67d242d3dbecc": {
"id": "refa61cb0821061a6d87aa67d242d3dbecc",
"properties": {
"WarehouseId": {
"description": "Filter by warehouse ID (exact match). Use this to look up a specific warehouse by its numeric ID.",
"type": "integer"
},
"WarehouseType": {
"description": "Filter by warehouse type (WarehouseType enum). Example: GENERIC, FBA, DROPSHIP. Returns all warehouses of that type.",
"type": "string"
},
"WarehouseName": {
"description": "Case-insensitive substring search on warehouse name. Returns all warehouses whose name contains this string.",
"type": "string"
}
}
},
"ref60473b50915f60e8d815a43bcf402886": {
"id": "ref60473b50915f60e8d815a43bcf402886",
"description": "Warehouse entity. WarehouseType controls inventory tracking: GENERIC/RECONCILE/DROPSHIP/QB are native Teapplix-managed types; FBA and 3PL types (e.g. ECCANGWMS) are provisioned via external integrations and have locked types. QuantityAlgorithm applies only to GENERIC, RECONCILE, DROPSHIP, and DROPSHIP-T types.",
"properties": {
"WarehouseId": {
"description": "Unique warehouse identifier. WarehouseId 1 is the default warehouse and cannot be deleted. On create, omit to auto-assign; on update/delete, provide to identify the warehouse.",
"type": "integer"
},
"WarehouseName": {
"description": "Display name of the warehouse. Must be unique across all warehouses. Required on create. On update/delete, may be used instead of WarehouseId to identify the warehouse (exact match).",
"type": "string"
},
"WarehouseType": {
"description": "Type of warehouse. GENERIC: standard inventory tracking. RECONCILE: tracks discrepancies. DROPSHIP: supplier ships directly. QB: QuickBooks-managed. DROPSHIP-T: Teapplix dropship. FBA: Amazon Fulfillment. 3PL types (e.g. ECCANGWMS): third-party logistics. Required on create. For 3PL/FBA warehouses, WarehouseType is locked after creation.",
"type": "string",
"enum": [
"GENERIC",
"RECONCILE",
"DROPSHIP",
"QB",
"DROPSHIP-T",
"FB4PX",
"DELIVERY51",
"ANMEIGROUP",
"CPWH",
"CHUKOU1",
"ECCANG",
"ECCANGERP",
"ECCANGWMS",
"FINALE",
"GIGAB2B",
"GUCANG",
"K5",
"LECANG",
"LINGXINGERP",
"LINGXINGWMS",
"NETSUITE",
"SHIPOUT",
"SHIPSTATION",
"WARE2GO",
"WINIT",
"FBA"
]
},
"QuantityAlgorithm": {
"description": "Inventory quantity calculation method. CALCULATED: quantity computed from order activity. STATIC: manually managed quantity. FIXED: always shows a fixed quantity (FixedQty). Only applicable to GENERIC, RECONCILE, DROPSHIP, and DROPSHIP-T warehouse types; ignored for FBA and 3PL.",
"type": "string",
"enum": [
"CALCULATED",
"STATIC",
"FIXED"
]
},
"ChannelWarehouseId": {
"description": "3PL account identifier (e.g. 'TES'). Optional for 3PL warehouse creation. When provided, the SyncSourceWarehouseId will be appended to the account's selected warehouses list.",
"type": "string"
},
"SyncSourceWarehouseId": {
"description": "3PL internal warehouse code (e.g. 'US1CA'). Required on create for 3PL warehouse types. Stored as the link between the Teapplix warehouse and the 3PL warehouse.",
"type": "string"
},
"CountryCode": {
"description": "ISO country code for the 3PL warehouse location. Optional. Stored in the account's selected warehouses configuration.",
"type": "string"
},
"ReconcileForWarehouseId": {
"description": "Only for WarehouseType RECONCILE. When provided, the existing warehouse with this ID will have its paired reconcile warehouse set to the newly created warehouse.",
"type": "integer"
}
}
},
"ref2a39f497808bc1e7e6a7e8ad96bd9736": {
"id": "ref2a39f497808bc1e7e6a7e8ad96bd9736",
"description": "Response to GET /Warehouse. Contains a list of warehouses matching the query filters.",
"required": [
"Warehouses"
],
"properties": {
"Warehouses": {
"description": "List of warehouses matching the query filters. Empty array if none match.",
"type": "array",
"items": {
"$ref": "ref60473b50915f60e8d815a43bcf402886"
}
}
}
},
"ref6d813582ed0a2a4ff01608b3f299ba09": {
"id": "ref6d813582ed0a2a4ff01608b3f299ba09",
"description": "Result of a single warehouse create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"WarehouseId",
"Status"
],
"properties": {
"WarehouseId": {
"description": "The WarehouseId of the affected warehouse. For create operations, this is the newly assigned ID. For delete-by-name when not found, this is 0.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no warehouse matched the given WarehouseId or WarehouseName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"ref2718b9c7da946adbf0c40a4bf9ee4444": {
"id": "ref2718b9c7da946adbf0c40a4bf9ee4444",
"description": "Request body for DELETE /Warehouse. Deletes a single warehouse. Provide either WarehouseId or WarehouseName (not both). Deletion is blocked if the warehouse is referenced by an order queue, a marketplace channel mapping, or a listing. WarehouseId 1 (default warehouse) cannot be deleted.",
"properties": {
"WarehouseId": {
"description": "ID of the warehouse to delete",
"type": "integer"
},
"WarehouseName": {
"description": "Name of the warehouse to delete (exact match)",
"type": "string"
}
}
},
"Warehouse-GET-query": {
"id": "Warehouse-GET-query",
"properties": {
"WarehouseId": {
"description": "Filter by warehouse ID (exact match). Use this to look up a specific warehouse by its numeric ID.",
"type": "integer"
},
"WarehouseType": {
"description": "Filter by warehouse type (WarehouseType enum). Example: GENERIC, FBA, DROPSHIP. Returns all warehouses of that type.",
"type": "string"
},
"WarehouseName": {
"description": "Case-insensitive substring search on warehouse name. Returns all warehouses whose name contains this string.",
"type": "string"
}
}
},
"Warehouse-GET-200-response": {
"id": "Warehouse-GET-200-response",
"description": "Response to GET /Warehouse. Contains a list of warehouses matching the query filters.",
"required": [
"Warehouses"
],
"properties": {
"Warehouses": {
"description": "List of warehouses matching the query filters. Empty array if none match.",
"type": "array",
"items": {
"$ref": "ref60473b50915f60e8d815a43bcf402886"
}
}
}
},
"Warehouse-GET-400-response": {
"id": "Warehouse-GET-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-GET-401-response": {
"id": "Warehouse-GET-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-GET-500-response": {
"id": "Warehouse-GET-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-POST-request": {
"id": "Warehouse-POST-request",
"description": "Warehouse entity. WarehouseType controls inventory tracking: GENERIC/RECONCILE/DROPSHIP/QB are native Teapplix-managed types; FBA and 3PL types (e.g. ECCANGWMS) are provisioned via external integrations and have locked types. QuantityAlgorithm applies only to GENERIC, RECONCILE, DROPSHIP, and DROPSHIP-T types.",
"properties": {
"WarehouseId": {
"description": "Unique warehouse identifier. WarehouseId 1 is the default warehouse and cannot be deleted. On create, omit to auto-assign; on update/delete, provide to identify the warehouse.",
"type": "integer"
},
"WarehouseName": {
"description": "Display name of the warehouse. Must be unique across all warehouses. Required on create. On update/delete, may be used instead of WarehouseId to identify the warehouse (exact match).",
"type": "string"
},
"WarehouseType": {
"description": "Type of warehouse. GENERIC: standard inventory tracking. RECONCILE: tracks discrepancies. DROPSHIP: supplier ships directly. QB: QuickBooks-managed. DROPSHIP-T: Teapplix dropship. FBA: Amazon Fulfillment. 3PL types (e.g. ECCANGWMS): third-party logistics. Required on create. For 3PL/FBA warehouses, WarehouseType is locked after creation.",
"type": "string",
"enum": [
"GENERIC",
"RECONCILE",
"DROPSHIP",
"QB",
"DROPSHIP-T",
"FB4PX",
"DELIVERY51",
"ANMEIGROUP",
"CPWH",
"CHUKOU1",
"ECCANG",
"ECCANGERP",
"ECCANGWMS",
"FINALE",
"GIGAB2B",
"GUCANG",
"K5",
"LECANG",
"LINGXINGERP",
"LINGXINGWMS",
"NETSUITE",
"SHIPOUT",
"SHIPSTATION",
"WARE2GO",
"WINIT",
"FBA"
]
},
"QuantityAlgorithm": {
"description": "Inventory quantity calculation method. CALCULATED: quantity computed from order activity. STATIC: manually managed quantity. FIXED: always shows a fixed quantity (FixedQty). Only applicable to GENERIC, RECONCILE, DROPSHIP, and DROPSHIP-T warehouse types; ignored for FBA and 3PL.",
"type": "string",
"enum": [
"CALCULATED",
"STATIC",
"FIXED"
]
},
"ChannelWarehouseId": {
"description": "3PL account identifier (e.g. 'TES'). Optional for 3PL warehouse creation. When provided, the SyncSourceWarehouseId will be appended to the account's selected warehouses list.",
"type": "string"
},
"SyncSourceWarehouseId": {
"description": "3PL internal warehouse code (e.g. 'US1CA'). Required on create for 3PL warehouse types. Stored as the link between the Teapplix warehouse and the 3PL warehouse.",
"type": "string"
},
"CountryCode": {
"description": "ISO country code for the 3PL warehouse location. Optional. Stored in the account's selected warehouses configuration.",
"type": "string"
},
"ReconcileForWarehouseId": {
"description": "Only for WarehouseType RECONCILE. When provided, the existing warehouse with this ID will have its paired reconcile warehouse set to the newly created warehouse.",
"type": "integer"
}
}
},
"Warehouse-POST-200-response": {
"id": "Warehouse-POST-200-response",
"description": "Result of a single warehouse create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"WarehouseId",
"Status"
],
"properties": {
"WarehouseId": {
"description": "The WarehouseId of the affected warehouse. For create operations, this is the newly assigned ID. For delete-by-name when not found, this is 0.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no warehouse matched the given WarehouseId or WarehouseName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"Warehouse-POST-400-response": {
"id": "Warehouse-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-POST-401-response": {
"id": "Warehouse-POST-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-POST-500-response": {
"id": "Warehouse-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-PUT-request": {
"id": "Warehouse-PUT-request",
"description": "Warehouse entity. WarehouseType controls inventory tracking: GENERIC/RECONCILE/DROPSHIP/QB are native Teapplix-managed types; FBA and 3PL types (e.g. ECCANGWMS) are provisioned via external integrations and have locked types. QuantityAlgorithm applies only to GENERIC, RECONCILE, DROPSHIP, and DROPSHIP-T types.",
"properties": {
"WarehouseId": {
"description": "Unique warehouse identifier. WarehouseId 1 is the default warehouse and cannot be deleted. On create, omit to auto-assign; on update/delete, provide to identify the warehouse.",
"type": "integer"
},
"WarehouseName": {
"description": "Display name of the warehouse. Must be unique across all warehouses. Required on create. On update/delete, may be used instead of WarehouseId to identify the warehouse (exact match).",
"type": "string"
},
"WarehouseType": {
"description": "Type of warehouse. GENERIC: standard inventory tracking. RECONCILE: tracks discrepancies. DROPSHIP: supplier ships directly. QB: QuickBooks-managed. DROPSHIP-T: Teapplix dropship. FBA: Amazon Fulfillment. 3PL types (e.g. ECCANGWMS): third-party logistics. Required on create. For 3PL/FBA warehouses, WarehouseType is locked after creation.",
"type": "string",
"enum": [
"GENERIC",
"RECONCILE",
"DROPSHIP",
"QB",
"DROPSHIP-T",
"FB4PX",
"DELIVERY51",
"ANMEIGROUP",
"CPWH",
"CHUKOU1",
"ECCANG",
"ECCANGERP",
"ECCANGWMS",
"FINALE",
"GIGAB2B",
"GUCANG",
"K5",
"LECANG",
"LINGXINGERP",
"LINGXINGWMS",
"NETSUITE",
"SHIPOUT",
"SHIPSTATION",
"WARE2GO",
"WINIT",
"FBA"
]
},
"QuantityAlgorithm": {
"description": "Inventory quantity calculation method. CALCULATED: quantity computed from order activity. STATIC: manually managed quantity. FIXED: always shows a fixed quantity (FixedQty). Only applicable to GENERIC, RECONCILE, DROPSHIP, and DROPSHIP-T warehouse types; ignored for FBA and 3PL.",
"type": "string",
"enum": [
"CALCULATED",
"STATIC",
"FIXED"
]
},
"ChannelWarehouseId": {
"description": "3PL account identifier (e.g. 'TES'). Optional for 3PL warehouse creation. When provided, the SyncSourceWarehouseId will be appended to the account's selected warehouses list.",
"type": "string"
},
"SyncSourceWarehouseId": {
"description": "3PL internal warehouse code (e.g. 'US1CA'). Required on create for 3PL warehouse types. Stored as the link between the Teapplix warehouse and the 3PL warehouse.",
"type": "string"
},
"CountryCode": {
"description": "ISO country code for the 3PL warehouse location. Optional. Stored in the account's selected warehouses configuration.",
"type": "string"
},
"ReconcileForWarehouseId": {
"description": "Only for WarehouseType RECONCILE. When provided, the existing warehouse with this ID will have its paired reconcile warehouse set to the newly created warehouse.",
"type": "integer"
}
}
},
"Warehouse-PUT-200-response": {
"id": "Warehouse-PUT-200-response",
"description": "Result of a single warehouse create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"WarehouseId",
"Status"
],
"properties": {
"WarehouseId": {
"description": "The WarehouseId of the affected warehouse. For create operations, this is the newly assigned ID. For delete-by-name when not found, this is 0.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no warehouse matched the given WarehouseId or WarehouseName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"Warehouse-PUT-400-response": {
"id": "Warehouse-PUT-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-PUT-401-response": {
"id": "Warehouse-PUT-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-PUT-500-response": {
"id": "Warehouse-PUT-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-DELETE-request": {
"id": "Warehouse-DELETE-request",
"description": "Request body for DELETE /Warehouse. Deletes a single warehouse. Provide either WarehouseId or WarehouseName (not both). Deletion is blocked if the warehouse is referenced by an order queue, a marketplace channel mapping, or a listing. WarehouseId 1 (default warehouse) cannot be deleted.",
"properties": {
"WarehouseId": {
"description": "ID of the warehouse to delete",
"type": "integer"
},
"WarehouseName": {
"description": "Name of the warehouse to delete (exact match)",
"type": "string"
}
}
},
"Warehouse-DELETE-200-response": {
"id": "Warehouse-DELETE-200-response",
"description": "Result of a single warehouse create, update, or delete operation. Status is Success, Failure, or NotFound. Message contains a human-readable description of the outcome or error.",
"required": [
"WarehouseId",
"Status"
],
"properties": {
"WarehouseId": {
"description": "The WarehouseId of the affected warehouse. For create operations, this is the newly assigned ID. For delete-by-name when not found, this is 0.",
"type": "integer"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = error occurred (see Message); NotFound = no warehouse matched the given WarehouseId or WarehouseName.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Human-readable description of the outcome. Always present on Failure and NotFound; also present on Success.",
"type": "string"
}
}
},
"Warehouse-DELETE-400-response": {
"id": "Warehouse-DELETE-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-DELETE-401-response": {
"id": "Warehouse-DELETE-401-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Warehouse-DELETE-500-response": {
"id": "Warehouse-DELETE-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ref790f5ea711d0e7643fad43316efbeabb": {
"id": "ref790f5ea711d0e7643fad43316efbeabb",
"description": "Shipment route",
"required": [
"FromZip",
"ToZip"
],
"properties": {
"FromZip": {
"description": "Sender's zip code",
"type": "string"
},
"ToZip": {
"description": "Recipient zip code",
"type": "string"
}
}
},
"ref4ab7eb8e65412da5334248adb29c5cdb": {
"id": "ref4ab7eb8e65412da5334248adb29c5cdb",
"description": "Request to obtain shipping zone",
"required": [
"Routes"
],
"properties": {
"Routes": {
"description": "The packages routes",
"type": "array",
"items": {
"$ref": "ref790f5ea711d0e7643fad43316efbeabb"
}
}
}
},
"ref8d75b4b2cf961ef75877e2a26390deab": {
"id": "ref8d75b4b2cf961ef75877e2a26390deab",
"properties": {
"Level": {
"type": "string"
},
"Code": {
"type": "string"
},
"Message": {
"type": "string"
}
}
},
"refe1b72fb11e11b2c9d6b1e1dcda43fab5": {
"id": "refe1b72fb11e11b2c9d6b1e1dcda43fab5",
"required": [
"FromZip",
"ToZip"
],
"properties": {
"FromZip": {
"description": "From zip code",
"type": "string"
},
"ToZip": {
"description": "To zip code",
"type": "string"
},
"Zone": {
"description": "Delivery zone (if available)",
"type": "string"
},
"Error": {
"$ref": "ref8d75b4b2cf961ef75877e2a26390deab"
}
}
},
"ref8feced4084bc910fbd76600d1030e0a0": {
"id": "ref8feced4084bc910fbd76600d1030e0a0",
"properties": {
"Routes": {
"type": "array",
"items": {
"$ref": "refe1b72fb11e11b2c9d6b1e1dcda43fab5"
}
}
}
},
"Zones-POST-request": {
"id": "Zones-POST-request",
"description": "Request to obtain shipping zone",
"required": [
"Routes"
],
"properties": {
"Routes": {
"description": "The packages routes",
"type": "array",
"items": {
"$ref": "ref790f5ea711d0e7643fad43316efbeabb"
}
}
}
},
"Zones-POST-200-response": {
"id": "Zones-POST-200-response",
"properties": {
"Routes": {
"type": "array",
"items": {
"$ref": "refe1b72fb11e11b2c9d6b1e1dcda43fab5"
}
}
}
},
"Zones-POST-400-response": {
"id": "Zones-POST-400-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Zones-POST-500-response": {
"id": "Zones-POST-500-response",
"required": [
"Success"
],
"properties": {
"Success": {
"description": "Indicate API success or failure. true | false",
"type": "boolean"
},
"Code": {
"description": "Indicate error code or 0 if success. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115",
"type": "integer"
},
"Message": {
"description": "Message typically associated with errors",
"type": "string"
},
"Description": {
"description": "Detailed description",
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}