{
"openapi": "3.1.0",
"info": {
"title": "Teapplix REST API",
"version": "2.0.1",
"description": "The Teapplix REST API v2. It is the interface behind every Teapplix integration:\norders, products, inventory, shipping labels, tracking and reports.\n\nThis document is generated from the annotations the server itself validates against,\nso a field described here is a field the server knows. Prose that the annotations\ncannot carry is merged in from an overlay in the `help` repository.\n\nAuthentication is one `APIToken` header per request, and the account served is the\none the token belongs to. Read the errors page before relying on HTTP status alone:\nseveral endpoints report a per-item failure inside an HTTP 200.",
"license": {
"name": "Proprietary — Teapplix, Inc.",
"url": "https://www.teapplix.com/terms/"
},
"contact": {
"name": "Teapplix support",
"url": "https://www.teapplix.com/help/"
}
},
"servers": [
{
"url": "https://api.teapplix.com/api2",
"description": "Production"
},
{
"url": "https://api7.teapplix.com/api2",
"description": "Development — reachable inside the Teapplix network only"
},
{
"url": "https://api17.teapplix.com/api2",
"description": "Local Development — reachable locally only"
}
],
"security": [
{
"APIToken": []
}
],
"tags": [
{
"name": "AddressValidation",
"description": "Return a valid address or an error message"
},
{
"name": "ApplyPackingPlan",
"description": "Apply packing plan to one or more orders. This will either add extra packages or split orders based on the packing plan configuration."
},
{
"name": "CancelLabel",
"description": "Label can be cancelled either by transaction id, client request id or by tracking number"
},
{
"name": "DeferredAction",
"description": "Get Deferred Action Status by session id"
},
{
"name": "DeliveryHistory",
"description": "Export delivery history as CSV from sapi_tracking table"
},
{
"name": "DownloadLabel",
"description": "Hidden endpoint"
},
{
"name": "Listing",
"description": "Create, update, and delete listings"
},
{
"name": "Manifest",
"description": "A manifest is the end-of-day handover document a carrier expects for labels already bought. Submitting one closes the batch of shipments it names."
},
{
"name": "MarkReview",
"description": "Mark Review"
},
{
"name": "OrderNotification",
"description": "The main orders endpoint: create orders, apply partial updates or cancellations, and query orders already in the account. All three shapes are batch-oriented."
},
{
"name": "OrderShipOptions",
"description": "API call allows to get or set Shipping options for existing order"
},
{
"name": "OrderTags",
"description": "Tags are free-form labels on an order, used to route it through queues and filters. This endpoint reads them, adds them and removes them."
},
{
"name": "PSObtainToken",
"description": "Create Access Token needed to launch UI for a specific paired client account"
},
{
"name": "PackingListForOrder",
"description": "Generates the packing list document for one order and returns it as a file. The document lists what the picker has to put in the box."
},
{
"name": "PickupForOrder",
"description": "Request Pickup For Order"
},
{
"name": "Product",
"description": "The product catalogue: the SKUs an account sells, their descriptions, prices, weights and shipping defaults. Orders and inventory both key on these SKUs."
},
{
"name": "ProductCombo",
"description": "A combo product is a SKU that ships as a set of other SKUs — a kit or bundle. Selling one draws down the inventory of every component."
},
{
"name": "ProductQuantity",
"description": "On-hand inventory quantities per SKU and warehouse. Reading gives the current picture; writing sets the quantity Teapplix will push to the marketplaces."
},
{
"name": "ProductVariation",
"description": "A variation is a child SKU of a parent product — a size or a colour. This endpoint reads the variations of a product and adds new ones."
},
{
"name": "ProductXref",
"description": "A product mapping ties a marketplace listing identifier to a Teapplix SKU, so an order arriving with the marketplace SKU resolves to the right product."
},
{
"name": "PurchaseLabel",
"description": "Provides method to purchase label. All packages must use the same carrier."
},
{
"name": "PurchaseLabelForOrder",
"description": "Method used to purchase label for existing order. All packages must use the same carrier."
},
{
"name": "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."
},
{
"name": "Rates",
"description": "All packages must use the same carrier."
},
{
"name": "RatesForOrder",
"description": "All packages must use the same carrier."
},
{
"name": "Report",
"description": "Create and query reports"
},
{
"name": "SSCCLabelForOrder",
"description": "Generates the SSCC carton or pallet label an EDI trading partner requires, and returns it as a file. The serial number is allocated by Teapplix."
},
{
"name": "ShipMethod",
"description": "List and manage shipping methods. GET returns the catalog of methods available to the account across all carriers (hardwired USPS, integrated carriers, 3PL, generic carriers, and RateShop), with the API method name, carrier, and the package types each method accepts; RateShop methods also carry a RateShop object with the Candidates they compare, and generic carrier methods a GenericCarrier object with their settings. POST, PUT, and DELETE manage editable methods, identified by Carrier + Name: Carrier RATESHOP creates rate-shop methods, and any carrier name you define yourself creates generic carrier methods (the same ones managed on the Generic Carriers settings page). Methods provided by carrier integrations or 3PL vendors cannot be created or modified here."
},
{
"name": "Shipment",
"description": "Used by external systems to inform Teapplix that certain orders are shipped outside of Teapplix, and the details around those shipments"
},
{
"name": "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."
},
{
"name": "SplitOrder",
"description": "Splitting an order divides its items into separate shipments that can be shipped from different warehouses or on different days. The split can also be reverted."
},
{
"name": "SplitOrderCont",
"description": "Continues a split that was started against an order which had already been split, so the remaining items can be divided again."
},
{
"name": "Submit3PL",
"description": "Submit order to 3PL vendor based on order tracking status"
},
{
"name": "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."
},
{
"name": "Track",
"description": "Track shipment"
},
{
"name": "VendorScan",
"description": "Records a vendor scan event against an order — the events a dropship vendor reports as it picks, packs and hands over a shipment."
},
{
"name": "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."
},
{
"name": "Zones",
"description": "API call allows to get provider's shipping zone (if available)"
}
],
"paths": {
"/AddressValidation": {
"post": {
"tags": [
"AddressValidation"
],
"operationId": "postAddressvalidation",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Addressvalidation"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressValidationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"422": {
"description": "422 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Validate a shipping address"
}
},
"/ApplyPackingPlan": {
"post": {
"tags": [
"ApplyPackingPlan"
],
"operationId": "postApplyPackingPlan",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplyPackingPlan"
}
}
}
},
"responses": {
"200": {
"description": "Response for applying packing plan to orders",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSplitResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Apply a packing plan to orders"
}
},
"/CancelLabel": {
"post": {
"tags": [
"CancelLabel"
],
"operationId": "postCancelpurchasedlabels",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cancelpurchasedlabels"
}
}
}
},
"responses": {
"200": {
"description": "Result of cancelling a previously purchased label",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelLabelResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Cancel purchased labels"
}
},
"/DeferredAction": {
"get": {
"tags": [
"DeferredAction"
],
"operationId": "getDeferredActionOperationResult",
"parameters": [
{
"name": "DeferredActionID",
"in": "query",
"required": false,
"description": "Deferred Action ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeferredActionOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "404 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Check a deferred action's status"
}
},
"/DeliveryHistory": {
"get": {
"tags": [
"DeliveryHistory"
],
"operationId": "getDocument2",
"parameters": [
{
"name": "DateStart",
"in": "query",
"required": false,
"description": "Start date filter (required if TxnId and TrackingNumber not provided, format: YYYY-MM-DD or YYYY/MM/DD)",
"schema": {
"type": "string"
}
},
{
"name": "DateEnd",
"in": "query",
"required": false,
"description": "End date filter (required if TxnId and TrackingNumber not provided, format: YYYY-MM-DD or YYYY/MM/DD)",
"schema": {
"type": "string"
}
},
{
"name": "TxnId",
"in": "query",
"required": false,
"description": "Order ID",
"schema": {
"type": "string"
}
},
{
"name": "TrackingNumber",
"in": "query",
"required": false,
"description": "Tracking number",
"schema": {
"type": "string"
}
},
{
"name": "IndiciumSource",
"in": "query",
"required": false,
"description": "Carrier. USPS carrier is further subdivided by pc postage provider. (e.g., 'usps', 'easypost', 'pbowes')",
"schema": {
"type": "string"
}
},
{
"name": "Status",
"in": "query",
"required": false,
"description": "Delivery status. Valid values: 'no_delivered' (not delivered), 'delivered', 'pre_transit', 'in_transit', 'out_for_delivery', 'available_for_pickup', 'picked_up', 'not_picked_up'. 'picked_up' maps to pre_transit/in_transit/out_for_delivery, 'not_picked_up' maps to available_for_pickup.",
"schema": {
"type": "string"
}
},
{
"name": "ForceRegen",
"in": "query",
"required": false,
"description": "Force re-generate CSV export",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Document details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Retrieve delivery history"
}
},
"/DownloadLabel/{path}": {
"get": {
"tags": [
"DownloadLabel"
],
"operationId": "getFileContent",
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileContent"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "404 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Download a label file"
},
"parameters": [
{
"name": "path",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"/Listing": {
"get": {
"tags": [
"Listing"
],
"operationId": "getListingsresult",
"parameters": [
{
"name": "StoreType",
"in": "query",
"required": false,
"description": "Listing marketplace. Amazon = 'amazon'; Amazon Vendor = 'amzv'; eBay = 'ebay'; cart marketplaces use their own store type code.",
"schema": {
"type": "string"
}
},
{
"name": "SellerId",
"in": "query",
"required": false,
"description": "For amazon/amzv: Amazon merchant ID. For ebay: ebay_api.username. Ignored for cart marketplaces.",
"schema": {
"type": "string"
}
},
{
"name": "SellerSKU",
"in": "query",
"required": false,
"description": "Seller SKU",
"schema": {
"type": "string"
}
},
{
"name": "TeapplixSKU",
"in": "query",
"required": false,
"description": "Teapplix SKU",
"schema": {
"type": "string"
}
},
{
"name": "WarehouseId",
"in": "query",
"required": false,
"description": "Warehouse ID",
"schema": {
"type": "integer"
}
},
{
"name": "ListingType",
"in": "query",
"required": false,
"description": "Listing Type, only available if StoreType is 'amazon' or 'amzv'. Possible values: 'DEFAULT', 'AMAZON_NA'.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Listingsresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query marketplace listings"
},
"put": {
"tags": [
"Listing"
],
"operationId": "putListingupdaterequest",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Listingupdaterequest"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListingUpdateResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"403": {
"description": "403 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Update a marketplace listing"
},
"delete": {
"tags": [
"Listing"
],
"operationId": "deleteListingKey",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListingKey"
}
}
}
},
"responses": {
"200": {
"description": "SuccessMessage variant that reports how many items were acted on by the request (created, deleted, cancelled, reviewed, submitted, etc.).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountedSuccessMessage"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "404 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Delete a marketplace listing"
}
},
"/Manifest": {
"post": {
"tags": [
"Manifest"
],
"operationId": "postManifestrequest",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manifestrequest"
}
}
}
},
"responses": {
"200": {
"description": "Result of submitting a shipping manifest. HTTP 200 always — domain-level failures (carrier/upstream rejected the manifest) surface as Status='Failure' with detail in the inherited Message/Description fields. Transport / validation errors arrive as the error envelope (Message) with a 4xx/5xx status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Manifestresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"501": {
"description": "501 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Submit a shipping manifest"
}
},
"/MarkReview": {
"post": {
"tags": [
"MarkReview"
],
"operationId": "postMarkReview",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkReview"
}
}
}
},
"responses": {
"200": {
"description": "Result of marking orders as reviewed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkReviewResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Mark an order as reviewed"
}
},
"/OrderNotification": {
"get": {
"tags": [
"OrderNotification"
],
"operationId": "getOrderQueryNotifications",
"parameters": [
{
"name": "TxnId",
"in": "query",
"required": false,
"description": "TxnId of order. Use this parameter to download only one order.",
"schema": {
"type": "string"
}
},
{
"name": "StoreType",
"in": "query",
"required": false,
"description": "Store Type.",
"schema": {
"type": "string"
}
},
{
"name": "StoreKey",
"in": "query",
"required": false,
"description": "Store Key.",
"schema": {
"type": "string"
}
},
{
"name": "SellerId",
"in": "query",
"required": false,
"description": "Seller ID.",
"schema": {
"type": "string"
}
},
{
"name": "SeqStart",
"in": "query",
"required": false,
"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.",
"schema": {
"type": "string"
}
},
{
"name": "SeqEnd",
"in": "query",
"required": false,
"description": "Ending Unique Id for order sequence (inclusive)",
"schema": {
"type": "string"
}
},
{
"name": "Invoice",
"in": "query",
"required": false,
"description": "Invoice number (reference number, marketplace order number)",
"schema": {
"type": "string"
}
},
{
"name": "PaymentDateStart",
"in": "query",
"required": false,
"description": "Starting payment date to filter, e.g. PaymentDateStart=2012/01/01 => for orders with payment date >= 2012/01/01 (inclusive)",
"schema": {
"type": "string"
}
},
{
"name": "PaymentDateEnd",
"in": "query",
"required": false,
"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)",
"schema": {
"type": "string"
}
},
{
"name": "UpdateDateStart",
"in": "query",
"required": false,
"description": "Starting update date to filter, e.g. UpdateDateStart=2019/01/01 => for orders with update date >= 2019/01/01",
"schema": {
"type": "string"
}
},
{
"name": "UpdateDateEnd",
"in": "query",
"required": false,
"description": "Ending update date to filter, e.g. UpdateDateEnd=2019/01/31 => for orders with update date <= 2019/01/31",
"schema": {
"type": "string"
}
},
{
"name": "ShipDateStart",
"in": "query",
"required": false,
"description": "Ship Date Start (inclusive)",
"schema": {
"type": "string"
}
},
{
"name": "ShipDateEnd",
"in": "query",
"required": false,
"description": "Ship Date End (inclusive)",
"schema": {
"type": "string"
}
},
{
"name": "PaymentStatus",
"in": "query",
"required": false,
"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.",
"schema": {
"type": "string"
}
},
{
"name": "Shipped",
"in": "query",
"required": false,
"description": "Shipped flag (0|1), if you pass this flag, we will only give 'shipped' orders for 1 and only 'open' orders for 0",
"schema": {
"type": "integer"
}
},
{
"name": "NotShipped",
"in": "query",
"required": false,
"description": "Deprecated, use 'Shipped' instead. If you pass this flag, we will only give 'open' orders for 1 and 'shipped' order for 0",
"schema": {
"type": "integer"
}
},
{
"name": "QueueId",
"in": "query",
"required": false,
"description": "Queue Id, QueueId=0 => for orders with Normal queue; QueueId=3 => for orders with QueueId == 3 (integer; optional)",
"schema": {
"type": "integer"
}
},
{
"name": "WarehouseId",
"in": "query",
"required": false,
"description": "Warehouse Id",
"schema": {
"type": "string"
}
},
{
"name": "Combine",
"in": "query",
"required": false,
"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.",
"schema": {
"type": "string"
}
},
{
"name": "VSAccountID",
"in": "query",
"required": false,
"description": "Virtual Seller AccountID.",
"schema": {
"type": "string"
}
},
{
"name": "DetailLevel",
"in": "query",
"required": false,
"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",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"required": false,
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"schema": {
"type": "string"
}
},
{
"name": "PageNumber",
"in": "query",
"required": false,
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"schema": {
"type": "string"
}
},
{
"name": "Tag",
"in": "query",
"required": false,
"description": "Filter by order tag name. Comma-separate multiple tag names to match orders that have any of the given tags.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderQueryNotifications"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query orders"
},
"post": {
"tags": [
"OrderNotification"
],
"operationId": "postOrderNotifications",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderNotifications"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSplitResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Create orders"
},
"put": {
"tags": [
"OrderNotification"
],
"operationId": "putOrderNotifications",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderUpdateNotifications"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSplitResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Update or cancel orders"
}
},
"/OrderShipOptions": {
"get": {
"tags": [
"OrderShipOptions"
],
"operationId": "getShippingOptionsGetResult",
"parameters": [
{
"name": "TxnId",
"in": "query",
"required": true,
"description": "Order ID to retrieve options for.",
"schema": {
"type": "string"
}
},
{
"name": "DetailLevel",
"in": "query",
"required": false,
"description": "Pass 'carrier' to receive the full carrier-specific Options tree. Default returns only carrier-agnostic fields (InsuranceType, Delivery).",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response from GET /OrderShipOptions. By default returns only carrier-agnostic Options fields (InsuranceType, Delivery). Pass DetailLevel=carrier to receive the full carrier-specific Options tree.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingOptionsGetResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "404 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"409": {
"description": "409 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Read an order's shipping options"
},
"post": {
"tags": [
"OrderShipOptions"
],
"operationId": "postShippingOptions",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingOptions"
}
}
}
},
"responses": {
"200": {
"description": "Result of updating shipping options for an existing order",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingOptionsResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "404 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"409": {
"description": "409 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"422": {
"description": "422 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"501": {
"description": "501 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Set an order's shipping options"
}
},
"/OrderTags": {
"get": {
"tags": [
"OrderTags"
],
"operationId": "getOrderTagsQueryNotifications",
"parameters": [
{
"name": "TxnId",
"in": "query",
"required": false,
"description": "TxnId of order. Use this parameter to download only one order.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderTags"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query order tags"
},
"post": {
"tags": [
"OrderTags"
],
"operationId": "postOrderTags",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderTags"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderTagsResults"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Add tags to orders"
},
"delete": {
"tags": [
"OrderTags"
],
"operationId": "deleteOrderTags",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderTags"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderTagsResults"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Remove tags from orders"
}
},
"/PSObtainToken": {
"get": {
"tags": [
"PSObtainToken"
],
"operationId": "getObtainaccesstokenresult",
"parameters": [
{
"name": "PSClientID",
"in": "query",
"required": false,
"description": "ClientID known to partner systems. Must uniquely identify a partner account and not duplicate in the partner customer base",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Obtainaccesstokenresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Obtain a partner access token"
}
},
"/PackingListForOrder": {
"post": {
"tags": [
"PackingListForOrder"
],
"operationId": "postPackingListForOrder",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SSCCLabelForOrder"
}
}
}
},
"responses": {
"200": {
"description": "Document details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Generate a packing list for an order"
}
},
"/PickupForOrder": {
"post": {
"tags": [
"PickupForOrder"
],
"operationId": "postRequestPickupForOrder",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestPickupForOrder"
}
}
}
},
"responses": {
"200": {
"description": "Result of submitting a pickup-for-order request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PickupForOrderResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Request a carrier pickup for an order"
}
},
"/Product": {
"get": {
"tags": [
"Product"
],
"operationId": "getProductGetResponse",
"parameters": [
{
"name": "ItemName",
"in": "query",
"required": false,
"description": "Item Name of product",
"schema": {
"type": "string"
}
},
{
"name": "ItemType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "VariationType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "RootItemName",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Upc",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Location",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ItemTitle",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Category",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "WalmartCategoryId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "WalmartTaxCode",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Supplier",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Asin",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Xref3",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "DefaultPrice",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "DefaultPriceSign",
"in": "query",
"required": false,
"description": "Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='",
"schema": {
"type": "string"
}
},
{
"name": "Cost",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "CostSign",
"in": "query",
"required": false,
"description": "Condition Sign to search, available signs '=', '>', '<', '>=', '<=', '<>', defaults to '='",
"schema": {
"type": "string"
}
},
{
"name": "SalesRep",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "CommissionRate",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "DangerousGoodsType",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "CountryOfOrigin",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Brand",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Model",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Manufacturer",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ManufacturerPartNumber",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Status",
"in": "query",
"required": false,
"description": "Status of downloaded inventory products. Possible values: active, inactive, all. Default active",
"schema": {
"type": "string"
}
},
{
"name": "DetailLevel",
"in": "query",
"required": false,
"description": "Set to 'CatalogInfo' to include catalog and listing fields in the response",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"required": false,
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"schema": {
"type": "string"
}
},
{
"name": "PageNumber",
"in": "query",
"required": false,
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductGetResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query products"
},
"post": {
"tags": [
"Product"
],
"operationId": "postProducts",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductsToSave"
}
}
},
"description": "Used to insert Inventory Products"
},
"responses": {
"200": {
"description": "Product Operation result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductResults"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Create products"
},
"put": {
"tags": [
"Product"
],
"operationId": "putProducts",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductsToSave"
}
}
}
},
"responses": {
"200": {
"description": "Product Operation result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductResults"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Update products"
},
"delete": {
"tags": [
"Product"
],
"operationId": "deleteProducts",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductsToDelete"
}
}
}
},
"responses": {
"200": {
"description": "Product Operation result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductResults"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Delete products"
}
},
"/ProductCombo": {
"get": {
"tags": [
"ProductCombo"
],
"operationId": "getComboProductGetResponse",
"parameters": [
{
"name": "ParentItemName",
"in": "query",
"required": false,
"description": "Item Name of parent product",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComboProductGetResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query combo products"
},
"put": {
"tags": [
"ProductCombo"
],
"operationId": "putComboProductdatatoupdate",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComboProductdatatoupdate"
}
}
}
},
"responses": {
"200": {
"description": "Combo Product Operation result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComboProductOperationresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "404 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Update a combo product"
}
},
"/ProductQuantity": {
"get": {
"tags": [
"ProductQuantity"
],
"operationId": "getProductOperationresult",
"parameters": [
{
"name": "WarehouseId",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ItemName",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Upc",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Product Operation result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryQuantityResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query inventory quantities"
},
"post": {
"tags": [
"ProductQuantity"
],
"operationId": "postInventoryQuantities",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryQuantities"
}
}
}
},
"responses": {
"200": {
"description": "Product Operation result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductResults"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Set inventory quantities"
}
},
"/ProductVariation": {
"get": {
"tags": [
"ProductVariation"
],
"operationId": "getProductVariation",
"parameters": [
{
"name": "ParentItemName",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Product Variations for selected ParentItemName",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductVariationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query product variations"
},
"post": {
"tags": [
"ProductVariation"
],
"operationId": "postProductVariation",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductVariationsToAdd"
}
}
}
},
"responses": {
"200": {
"description": "Product Operation result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductResults"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Add a product variation"
}
},
"/ProductXref": {
"get": {
"tags": [
"ProductXref"
],
"operationId": "getProductMappingResponse",
"parameters": [
{
"name": "TeapplixSKU",
"in": "query",
"required": false,
"description": "Teapplix SKU",
"schema": {
"type": "string"
}
},
{
"name": "SourceItemName",
"in": "query",
"required": false,
"description": "Item Name of product",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"required": false,
"description": "Max records to return per response. Default 100. Limit 1000. Use 'Next' or 'Prev' link to paginate",
"schema": {
"type": "string"
}
},
{
"name": "PageNumber",
"in": "query",
"required": false,
"description": "Page number. Considering PageNumber, returns the PageNumber-th page, 1-indexed",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductMappingResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query marketplace SKU mappings"
},
"post": {
"tags": [
"ProductXref"
],
"operationId": "postProductsMapping",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductsMapping"
}
}
}
},
"responses": {
"200": {
"description": "Product Mapping Operation result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductMappingOperationresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Create marketplace SKU mappings"
},
"delete": {
"tags": [
"ProductXref"
],
"operationId": "deleteProductsMappingDeleteRequest",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductsMappingDeleteRequest"
}
}
}
},
"responses": {
"200": {
"description": "Product Mapping Operation result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductMappingOperationresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Delete marketplace SKU mappings"
}
},
"/PurchaseLabel": {
"post": {
"tags": [
"PurchaseLabel"
],
"operationId": "postPurchaseLabel",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseLabelRequest"
}
}
}
},
"responses": {
"200": {
"description": "Represents purchase label result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseLabelResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Purchase a shipping label"
}
},
"/PurchaseLabelForOrder": {
"post": {
"tags": [
"PurchaseLabelForOrder"
],
"operationId": "postPurchaseLabel2",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseLabelForOrderRequest"
}
}
}
},
"responses": {
"200": {
"description": "Represents purchase label result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PurchaseLabelResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Purchase a shipping label for an order"
}
},
"/Queue": {
"get": {
"tags": [
"Queue"
],
"operationId": "getQueueGetResponse",
"parameters": [
{
"name": "QueueId",
"in": "query",
"required": false,
"description": "Filter by queue ID (exact match). Use to look up a specific queue by its numeric ID.",
"schema": {
"type": "integer"
}
},
{
"name": "QueueName",
"in": "query",
"required": false,
"description": "Case-insensitive substring search on queue name. Returns all queues whose name contains this string.",
"schema": {
"type": "string"
}
},
{
"name": "WarehouseId",
"in": "query",
"required": false,
"description": "Filter by warehouse ID (exact match). Returns all queues assigned to that warehouse (FK to /Warehouse).",
"schema": {
"type": "integer"
}
},
{
"name": "WarehouseName",
"in": "query",
"required": false,
"description": "Filter by warehouse name (exact match). Alternative to WarehouseId: returns all queues assigned to the warehouse with this name.",
"schema": {
"type": "string"
}
},
{
"name": "ProfileId",
"in": "query",
"required": false,
"description": "Filter by shipping profile ID (exact match). Returns all queues using that shipping profile (FK to /ShippingProfile).",
"schema": {
"type": "integer"
}
},
{
"name": "ProfileName",
"in": "query",
"required": false,
"description": "Filter by shipping profile name (exact match). Alternative to ProfileId: returns all queues using the profile with this name.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response to GET /Queue. Contains a list of order queues matching the query filters, ordered by QueueSeq then QueueId.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueGetResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query order queues"
},
"post": {
"tags": [
"Queue"
],
"operationId": "postOrderQueue",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderQueue"
}
}
}
},
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Create an order queue"
},
"put": {
"tags": [
"Queue"
],
"operationId": "putOrderQueue",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderQueue"
}
}
}
},
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Update an order queue"
},
"delete": {
"tags": [
"Queue"
],
"operationId": "deleteQueueDelete",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueDelete"
}
}
}
},
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Delete an order queue"
}
},
"/Rates": {
"post": {
"tags": [
"Rates"
],
"operationId": "postShippingratesrequest",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingRatesRequest"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Shippingrateresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"501": {
"description": "501 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Get shipping rates"
}
},
"/RatesForOrder": {
"post": {
"tags": [
"RatesForOrder"
],
"operationId": "postShippingratesrequest2",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingRatesForOrderRequest"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Shippingrateresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Get shipping rates for an order"
}
},
"/Report": {
"get": {
"tags": [
"Report"
],
"operationId": "getDocument",
"parameters": [
{
"name": "ReportId",
"in": "query",
"required": true,
"description": "Report ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Document details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"404": {
"description": "404 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Download a generated report"
},
"post": {
"tags": [
"Report"
],
"operationId": "postReportRequest",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportRequest"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Request a report"
}
},
"/SSCCLabelForOrder": {
"post": {
"tags": [
"SSCCLabelForOrder"
],
"operationId": "postSSCCLabelForOrder",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SSCCLabelForOrder"
}
}
}
},
"responses": {
"200": {
"description": "Document details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Document"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Generate an SSCC label for an order"
}
},
"/ShipMethod": {
"get": {
"tags": [
"ShipMethod"
],
"operationId": "getShipMethodGetResponse",
"parameters": [
{
"name": "Carrier",
"in": "query",
"required": false,
"description": "Filter methods by carrier (e.g. USPS, FEDEX, UPS, DHLEC, DHLE, ONTRAC, RATESHOP). Returns only methods supported by that provider. Matched case-insensitively.",
"schema": {
"type": "string"
}
},
{
"name": "PackageType",
"in": "query",
"required": false,
"description": "Filter methods by package type. Exact match on the packageType field (e.g. 'envelope' or 'package'). Not applied to RATESHOP methods.",
"schema": {
"type": "string"
}
},
{
"name": "Name",
"in": "query",
"required": false,
"description": "Return only the method with this exact API method name (e.g. USPS_GROUND_ADVANTAGE, or a RateShop method name). Omit to return all methods.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response to GET /ShipMethod. Contains a list of shipping method entries.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipMethodGetResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query shipping methods"
},
"post": {
"tags": [
"ShipMethod"
],
"operationId": "postShipMethod",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipMethod"
}
}
}
},
"responses": {
"200": {
"description": "Result of a ship method create, update, or delete operation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipMethodOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
}
},
"put": {
"tags": [
"ShipMethod"
],
"operationId": "putShipMethod",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipMethod"
}
}
}
},
"responses": {
"200": {
"description": "Result of a ship method create, update, or delete operation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipMethodOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
}
},
"delete": {
"tags": [
"ShipMethod"
],
"operationId": "deleteShipMethodDelete",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipMethodDelete"
}
}
}
},
"responses": {
"200": {
"description": "Result of a ship method create, update, or delete operation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipMethodOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
}
}
},
"/Shipment": {
"get": {
"tags": [
"Shipment"
],
"operationId": "getShipmentdata",
"parameters": [
{
"name": "TxnId",
"in": "query",
"required": false,
"description": "Find shipment info for a specific order",
"schema": {
"type": "string"
}
},
{
"name": "ShipCarrier",
"in": "query",
"required": false,
"description": "Obtain shipment information with matching carrier",
"schema": {
"type": "string"
}
},
{
"name": "TrackingNumber",
"in": "query",
"required": false,
"description": "Obtain shipment infromation with matching tracking number",
"schema": {
"type": "string"
}
},
{
"name": "ShipDateStart",
"in": "query",
"required": false,
"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",
"schema": {
"type": "string"
}
},
{
"name": "ShipDateEnd",
"in": "query",
"required": false,
"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",
"schema": {
"type": "string"
}
},
{
"name": "QueueId",
"in": "query",
"required": false,
"description": "Limit orders placed in a specific queue id",
"schema": {
"type": "integer"
}
},
{
"name": "StoreType",
"in": "query",
"required": false,
"description": "Store Type. Limit to orders from specific channel",
"schema": {
"type": "string"
}
},
{
"name": "StoreKey",
"in": "query",
"required": false,
"description": "Store Key. This must be specified together with StoreType, limit to orders from specific channel + account",
"schema": {
"type": "string"
}
},
{
"name": "ReturnLabel",
"in": "query",
"required": false,
"description": "Return Label Flag (0|1). If you set this parameter, return will contain PDF of order label base64 encoded",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Shipment details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentQueryResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query shipments"
},
"post": {
"tags": [
"Shipment"
],
"operationId": "postShippingconfirmation",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Shippingconfirmation"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingConfirmationresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Confirm a shipment"
}
},
"/ShippingProfile": {
"get": {
"tags": [
"ShippingProfile"
],
"operationId": "getShippingProfileGetResponse",
"parameters": [
{
"name": "ProfileId",
"in": "query",
"required": false,
"description": "Filter by profile ID (exact match). Use to look up a specific shipping profile by its numeric ID.",
"schema": {
"type": "integer"
}
},
{
"name": "Active",
"in": "query",
"required": false,
"description": "Filter by active flag: true = active only, false = inactive only. Omit to return all profiles.",
"schema": {
"type": "boolean"
}
},
{
"name": "ProfileName",
"in": "query",
"required": false,
"description": "Case-insensitive substring search on profile name. Returns all profiles whose name contains this string.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingProfileGetResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query shipping profiles"
},
"post": {
"tags": [
"ShippingProfile"
],
"operationId": "postShippingProfile",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingProfile"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingProfileOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Create a shipping profile"
},
"put": {
"tags": [
"ShippingProfile"
],
"operationId": "putShippingProfile",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingProfile"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingProfileOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Update a shipping profile"
},
"delete": {
"tags": [
"ShippingProfile"
],
"operationId": "deleteShippingProfileDelete",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingProfileDelete"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingProfileOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Delete a shipping profile"
}
},
"/SplitOrder": {
"post": {
"tags": [
"SplitOrder"
],
"operationId": "postOrderSplit",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSplitRequest"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSplitResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Split an order"
},
"delete": {
"tags": [
"SplitOrder"
],
"operationId": "deleteOrderSplitRevert",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSplitRevert"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSplitResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Revert an order split"
}
},
"/SplitOrderCont": {
"post": {
"tags": [
"SplitOrderCont"
],
"operationId": "postOrderSplit2",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSplitRequest"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderSplitResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Continue splitting an order"
}
},
"/Submit3PL": {
"post": {
"tags": [
"Submit3PL"
],
"operationId": "postSubmit3PLRequest",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Submit3PLRequest"
}
}
}
},
"responses": {
"200": {
"description": "Response from submitting an order to a 3PL vendor. Per-object shape: even on order-not-found / vendor-decline, returns HTTP 200 with Status indicating the per-object outcome (matches the bulk-result envelope rule).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Submit3PLResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Submit an order to a 3PL vendor"
}
},
"/Tag": {
"get": {
"tags": [
"Tag"
],
"operationId": "getTagGetResponse",
"parameters": [
{
"name": "TagId",
"in": "query",
"required": false,
"description": "Filter by tag ID (exact match). Use to look up a specific tag by its numeric ID.",
"schema": {
"type": "integer"
}
},
{
"name": "TagName",
"in": "query",
"required": false,
"description": "Case-insensitive substring search on tag name. Returns all tags whose name contains this string.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response to GET /Tag. Contains a list of tags matching the query filters, ordered by TagId.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagGetResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query tags"
},
"post": {
"tags": [
"Tag"
],
"operationId": "postTag",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Create a tag"
},
"put": {
"tags": [
"Tag"
],
"operationId": "putTag",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Update a tag"
},
"delete": {
"tags": [
"Tag"
],
"operationId": "deleteTagDelete",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagDelete"
}
}
}
},
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Delete a tag"
}
},
"/Track": {
"get": {
"tags": [
"Track"
],
"operationId": "getTrack",
"parameters": [
{
"name": "Carrier",
"in": "query",
"required": false,
"description": "Carrier name, possible values 'USPS', 'UPS', 'FEDEX', 'DHLE', 'DHL', 'GOFO', 'YANWEN'",
"schema": {
"type": "string"
}
},
{
"name": "TrackingNumber",
"in": "query",
"required": false,
"description": "Shipment tracking #",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Track"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Track a shipment"
},
"post": {
"tags": [
"Track"
],
"operationId": "postRecord",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackRequest"
}
}
}
},
"responses": {
"200": {
"description": "Result of a track-notification submission. Currently the endpoint is a stub (returns 501); when implemented, the success body extends SuccessMessage and carries the resolved shipments under Shipments.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackNotificationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"501": {
"description": "501 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Record tracking information"
}
},
"/VendorScan": {
"post": {
"tags": [
"VendorScan"
],
"operationId": "postVendorScanrequest",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorScanrequest"
}
}
}
},
"responses": {
"200": {
"description": "Result of submitting vendor scan events to the upstream job runner. HTTP 200 always — domain-level failures (upstream EOD job declined the event) surface as Status='Failure' with detail in Warnings; transport / validation errors arrive as the error envelope (Message) with a 4xx/5xx status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VendorScanresult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"501": {
"description": "501 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Submit vendor scan events"
}
},
"/Warehouse": {
"get": {
"tags": [
"Warehouse"
],
"operationId": "getWarehouseGetResponse",
"parameters": [
{
"name": "WarehouseId",
"in": "query",
"required": false,
"description": "Filter by warehouse ID (exact match). Use this to look up a specific warehouse by its numeric ID.",
"schema": {
"type": "integer"
}
},
{
"name": "WarehouseType",
"in": "query",
"required": false,
"description": "Filter by warehouse type (WarehouseType enum). Example: GENERIC, FBA, DROPSHIP. Returns all warehouses of that type.",
"schema": {
"type": "string"
}
},
{
"name": "WarehouseName",
"in": "query",
"required": false,
"description": "Case-insensitive substring search on warehouse name. Returns all warehouses whose name contains this string.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response to GET /Warehouse. Contains a list of warehouses matching the query filters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseGetResponse"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Query warehouses"
},
"post": {
"tags": [
"Warehouse"
],
"operationId": "postWarehouse",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
},
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Create a warehouse"
},
"put": {
"tags": [
"Warehouse"
],
"operationId": "putWarehouse",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Warehouse"
}
}
}
},
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Update a warehouse"
},
"delete": {
"tags": [
"Warehouse"
],
"operationId": "deleteWarehouseDelete",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseDelete"
}
}
}
},
"responses": {
"200": {
"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.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WarehouseOperationResult"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"401": {
"description": "401 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Delete a warehouse"
}
},
"/Zones": {
"post": {
"tags": [
"Zones"
],
"operationId": "postZones",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Zones"
}
}
}
},
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShippingZone"
}
}
}
},
"400": {
"description": "400 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
},
"500": {
"description": "500 response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
}
}
}
}
},
"summary": "Get a carrier's shipping zone"
}
}
},
"components": {
"securitySchemes": {
"APIToken": {
"type": "apiKey",
"in": "header",
"name": "APIToken",
"description": "Account API token. Generate one in the Teapplix UI under Settings, then send it in the APIToken request header."
}
},
"schemas": {
"Address": {
"title": "Address",
"description": "Address structure",
"type": "object",
"properties": {
"Street": {
"description": "Street address 1st line",
"type": "string",
"maxLength": 255
},
"Street2": {
"description": "Street address 2nd line",
"type": "string",
"maxLength": 255
},
"City": {
"description": "The city or town name.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"State": {
"description": "State code or region name",
"type": "string",
"maxLength": 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",
"minLength": 2,
"maxLength": 2,
"pattern": "[A-Z]{2}"
}
},
"additionalProperties": true
},
"Addressvalidation": {
"title": "Address validation",
"type": "object",
"properties": {
"Address": {
"$ref": "#/components/schemas/Address",
"description": "Address to validate"
},
"Provider": {
"description": "Provider which will be used for address validation. TEAPPLIX will map to USPS and however your account is configured to print USPS Labels. You must have linked carrier accounts for the provider you choose to use.",
"type": "string",
"enum": [
"TEAPPLIX",
"UPS",
"FEDEX"
]
}
},
"additionalProperties": false,
"required": [
"Address",
"Provider"
]
},
"Amount": {
"title": "Amount",
"description": "Declares any amount value",
"type": "object",
"properties": {
"Amount": {
"type": "number"
},
"Currency": {
"type": "string",
"pattern": "[A-Z]{3}"
}
},
"additionalProperties": false
},
"ApplyPackingPlan": {
"title": "Apply Packing Plan",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"TxnIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "TxnIds",
"description": "Array of order IDs to apply packing plan. One or more order IDs can be provided.",
"minItems": 1
}
},
"additionalProperties": false,
"required": [
"TxnIds"
]
},
"CancelLabelResult": {
"title": "CancelLabelResult",
"description": "Result of cancelling a previously purchased label",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Operation status: 'Cancelled' on success.",
"type": "string",
"enum": [
"Cancelled"
]
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"Cancelpurchasedlabels": {
"title": "Cancel purchased labels",
"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.",
"type": "object",
"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": "#/components/schemas/TrackingInfo"
},
"Force": {
"description": "Mark order as unshipped in case of FedEx and UPS label cancel error",
"type": "boolean"
}
},
"additionalProperties": false
},
"Cod": {
"title": "Cod",
"description": "C.O.D. details",
"type": "object",
"properties": {
"Amount": {
"$ref": "#/components/schemas/Amount"
},
"Kind": {
"description": "Kind",
"type": "string"
},
"CollectionType": {
"description": "Collection Type",
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
]
},
"Address": {
"$ref": "#/components/schemas/ReturnAddress"
},
"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",
"pattern": "\\d+"
},
"BillingOption": {
"description": "Billing Option",
"type": "string",
"enum": [
"Prepaid",
"Freight Collect"
]
}
},
"additionalProperties": false
},
"ComboProductChildItem": {
"title": "Combo Product Child Item",
"description": "Declares Combo Product Child Item",
"type": "object",
"properties": {
"ItemName": {
"type": "string"
},
"Quantity": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"ItemName"
]
},
"ComboProductGetResponse": {
"title": "Combo Product Get Response",
"type": "object",
"properties": {
"ChildItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComboProductChildItem"
},
"title": "ChildItems"
}
},
"additionalProperties": false,
"required": [
"ChildItems"
]
},
"ComboProductOperationresult": {
"title": "Combo Product Operation result",
"description": "Combo Product Operation result",
"type": "object",
"properties": {
"ChildItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOperationResult"
},
"title": "ChildItems",
"description": "Result of each child item operation"
}
},
"additionalProperties": false,
"required": [
"ChildItems"
]
},
"ComboProductdatatoupdate": {
"title": "Combo Product data to update",
"description": "Used to update Inventory Combo Products",
"type": "object",
"properties": {
"ParentItemName": {
"description": "Parent Item Name",
"type": "string"
},
"ChildItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComboProductChildItem"
},
"title": "ChildItems",
"description": "Combo Product Child Items to be inserted or updated. If you call method again, all Child Items will be overwritten"
}
},
"additionalProperties": false,
"required": [
"ParentItemName",
"ChildItems"
]
},
"CountedSuccessMessage": {
"title": "CountedSuccessMessage",
"description": "SuccessMessage variant that reports how many items were acted on by the request (created, deleted, cancelled, reviewed, submitted, etc.).",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Per-domain success discriminator (e.g. 'Cancelled', 'Reviewed', 'Submitted', 'Updated', 'Purchased', 'Created', 'Deleted'). Subclasses constrain this with @Enum.",
"type": "string"
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
},
"Count": {
"description": "Number of items acted on by the request (e.g. created, deleted, cancelled, reviewed, submitted).",
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"Status",
"Count"
]
},
"CustomPackageName": {
"title": "CustomPackageName",
"description": "Declares name of a custom package",
"type": "object",
"properties": {
"CustomPackageName": {
"description": "Name of custom package type saved in Teapplix Setup",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"CustomPackageName"
]
},
"CustomsId": {
"title": "CustomsId",
"type": "object",
"properties": {
"Type": {
"type": "string"
},
"Number": {
"type": "string"
}
},
"additionalProperties": false
},
"Customsdeclaration": {
"title": "Customs declaration",
"description": "Customs declaration",
"type": "object",
"properties": {
"ReasonForExport": {
"type": "string",
"maxLength": 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": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Customsitem"
},
"title": "Items",
"description": "For ForOrder version of the API, Teapplix will use your order items to build ocmmercial invoice if Items list is not specified."
}
},
"additionalProperties": false
},
"Customsitem": {
"title": "Customs item",
"description": "Customs declaration item",
"type": "object",
"properties": {
"Name": {
"description": "Item's name",
"type": "string",
"maxLength": 255
},
"Sku": {
"description": "Item SKU, should be set if known",
"type": "string",
"maxLength": 127
},
"Description": {
"description": "Item's description. Some carriers can print it on label",
"type": "string",
"maxLength": 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",
"pattern": "[A-Z]{3}"
},
"CustomsWeight": {
"$ref": "#/components/schemas/Weight",
"description": "Unit customs weight - weight of a single item"
},
"OriginCountry": {
"description": "Country code of origin country",
"type": "string",
"pattern": "[A-Z]{2}"
},
"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"
}
},
"additionalProperties": false,
"required": [
"Name",
"Description",
"Quantity",
"Amount"
]
},
"Customsoptions": {
"title": "Customs options",
"description": "Customs options",
"type": "object",
"properties": {
"ReasonForExport": {
"type": "string",
"maxLength": 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"
}
},
"additionalProperties": false
},
"DHL": {
"title": "DHL",
"description": "DHLeC specific options",
"type": "object",
"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"
}
},
"additionalProperties": false
},
"DHLE": {
"title": "DHLE",
"description": "DHL Express specific options",
"type": "object",
"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"
]
}
},
"additionalProperties": false
},
"DangerousGoods": {
"title": "DangerousGoods",
"description": "UPS Dangerous Goods Data",
"type": "object",
"properties": {
"Type": {
"type": "integer"
},
"Name": {
"description": "Dangerous Goods Name",
"type": "string",
"maxLength": 40
},
"PhoneNumber": {
"description": "Dangerous Goods Phone Number",
"type": "string",
"maxLength": 40
},
"PhoneExtension": {
"description": "Dangerous Goods Phone Extension",
"type": "string",
"maxLength": 10
}
},
"additionalProperties": false
},
"DangerousGoodsDetails": {
"title": "DangerousGoodsDetails",
"description": "Dangerous Goods Details",
"type": "object",
"properties": {
"CommodityType": {
"description": "Commodity Type",
"type": "string",
"enum": [
"UN",
"ID",
"NA"
]
},
"CommodityId": {
"description": "Commodity Type",
"type": "string",
"maxLength": 5
},
"PackingGroup": {
"description": "Packing Group",
"type": "string",
"enum": [
"I",
"II",
"III"
]
},
"PackingType": {
"description": "Packing Type",
"type": "string",
"maxLength": 60
},
"PackingInstruction": {
"description": "Packing Instruction",
"type": "string",
"maxLength": 4
},
"AircraftCategoryType": {
"description": "Aircraft Category Type",
"type": "string",
"enum": [
"PASSENGER_AND_CARGO_AIRCRAFT",
"CARGO_AIRCRAFT_ONLY"
]
},
"ProperName": {
"description": "Proper Name",
"type": "string",
"maxLength": 30
},
"TechnicalName": {
"description": "Technical Name",
"type": "string",
"maxLength": 20
},
"PrimaryClass": {
"description": "Primary Class",
"type": "string",
"maxLength": 4
},
"SubsidiaryClass": {
"description": "Subsidiary Class",
"type": "string",
"maxLength": 4
},
"ReportableQty": {
"description": "Reportable Quantity",
"type": "number"
},
"ReportableQtyUnit": {
"description": "Reportable Quantity Unit",
"type": "string",
"enum": [
"oz",
"lb",
"gram",
"kg"
]
},
"Percentage": {
"description": "Percentage",
"type": "string",
"maxLength": 3
},
"AuthorizationInfo": {
"description": "AuthorizationInfo",
"type": "string",
"maxLength": 40
}
},
"additionalProperties": false
},
"DeferredActionDetails": {
"title": "Deferred Action Details",
"description": "List of deferred action details",
"type": "object",
"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"
}
},
"additionalProperties": false,
"required": [
"ID",
"Name"
]
},
"DeferredActionOperationResult": {
"title": "Deferred Action Operation Result",
"type": "object",
"properties": {
"Status": {
"description": "Operation status",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Messages": {
"type": "array",
"items": {
"type": "string"
},
"title": "Messages",
"description": "Messages related to the this request"
},
"DeferredAction": {
"$ref": "#/components/schemas/DeferredActionDetails",
"description": "Deferred Action data"
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"Delivery": {
"title": "Delivery",
"description": "Delivery",
"type": "object",
"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"
}
},
"additionalProperties": false
},
"Dimensionsofpackage": {
"title": "Dimensions of package",
"description": "If not set Teapplix will apply 6x6x4 by default",
"type": "object",
"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"
]
}
},
"additionalProperties": false,
"required": [
"Length",
"Width",
"Depth",
"Unit"
]
},
"Document": {
"title": "Document",
"description": "Document details",
"type": "object",
"properties": {
"Type": {
"type": "string",
"enum": [
"URL",
"INLINE"
]
},
"ContentType": {
"type": "string",
"enum": [
"PDF",
"ZIP",
"PNG",
"HTML",
"CSV"
]
},
"Content": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"Content"
]
},
"DrophipDetails": {
"title": "DrophipDetails",
"type": "object",
"properties": {
"ProductPrice": {
"description": "Product Price",
"type": "number"
},
"Markup": {
"description": "Markup",
"type": "number"
},
"Handling": {
"description": "Handling",
"type": "number"
},
"Packing": {
"description": "Packing",
"type": "number"
}
},
"additionalProperties": false
},
"DutyBilled": {
"title": "DutyBilled",
"description": "Duties and Taxes data",
"type": "object",
"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",
"maxLength": 10
},
"AccountCountryCode": {
"description": "Account Country Code. Currently UPS only",
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "[A-Z]{2}"
}
},
"additionalProperties": false,
"required": [
"Role"
]
},
"Error": {
"title": "Error",
"type": "object",
"properties": {
"Level": {
"type": "string"
},
"Code": {
"type": "string"
},
"Message": {
"type": "string"
}
},
"additionalProperties": false
},
"ExportDetail": {
"title": "ExportDetail",
"description": "Export detail",
"type": "object",
"properties": {
"Kind": {
"type": "string"
},
"ForeignZoneCode": {
"type": "string"
},
"EntryNumber": {
"type": "string"
},
"LicenseNumber": {
"type": "string"
},
"ExpirationDate": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false
},
"Fedex": {
"title": "Fedex",
"description": "FedEx specific options",
"type": "object",
"properties": {
"CustomsOption": {
"description": "Customs option",
"type": "string"
},
"Coverage": {
"type": "string"
},
"ExportDetail": {
"$ref": "#/components/schemas/ExportDetail"
},
"Recipient": {
"$ref": "#/components/schemas/Recipient"
},
"HoldAtLocation": {
"$ref": "#/components/schemas/HoldAtLocation"
},
"SmartPostEndiciaType": {
"type": "string"
},
"TotalPalletWeight": {
"type": "number"
},
"FreightGuaranteeDetailDate": {
"type": "string"
},
"Delivery": {
"$ref": "#/components/schemas/Delivery"
},
"Instructions": {
"$ref": "#/components/schemas/Instructions"
},
"Freight": {
"$ref": "#/components/schemas/FedExFreight"
},
"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"
}
},
"additionalProperties": false
},
"FileContent": {
"title": "File Content",
"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.",
"type": "object",
"properties": {
"Content-Type": {
"description": "MIME type of the downloaded file",
"type": "string",
"enum": [
"application/pdf",
"image/png",
"image/gif",
"image/tiff",
"application/octet-stream"
]
}
},
"additionalProperties": false
},
"From": {
"title": "From",
"description": "Sender address or shipping profile id",
"oneOf": [
{
"$ref": "#/components/schemas/ReturnAddress"
},
{
"$ref": "#/components/schemas/ProfileId"
}
]
},
"GenericCarrierDetails": {
"title": "GenericCarrierDetails",
"description": "Settings of a method belonging to a generic carrier - a carrier you define yourself, managed on the Generic Carriers settings page. Present on a ShipMethod whose Carrier is one of yours, and accepted on POST/PUT for those carriers. Methods provided by carrier integrations and by 3PL vendors do not carry this object and cannot be edited.",
"type": "object",
"properties": {
"DestinationRegion": {
"description": "Destinations this method is offered for, which decides the method lists it appears in: us = domestic, ca = Canada, intl = international, all = every destination, and the combinations us+ca / intl+ca / intl+caintl. Defaults to all on create. Note this is a wider set than the RateShop DestinationRegion, which only has all/us/intl.",
"type": "string",
"enum": [
"all",
"us",
"ca",
"intl",
"us+ca",
"intl+ca",
"intl+caintl"
]
},
"CarrierDescription": {
"description": "Human-readable carrier name shown in the UI next to the method (config_method.carrier_description). Up to 255 characters.",
"type": "string"
},
"WeightMin": {
"description": "Lowest package weight this method accepts, in WeightUnit. Defaults to 1 on create. Note: saving the Generic Carriers settings page rewrites this to the default.",
"type": "number"
},
"WeightMax": {
"description": "Highest package weight this method accepts, in WeightUnit. Defaults to 150 on create. Note: saving the Generic Carriers settings page rewrites this to the default.",
"type": "number"
},
"WeightUnit": {
"description": "Unit for WeightMin/WeightMax. Defaults to lb on create. Note: saving the Generic Carriers settings page rewrites this to the default.",
"type": "string",
"enum": [
"oz",
"lb",
"gram",
"kg"
]
}
},
"additionalProperties": false
},
"Handling": {
"title": "Handling",
"description": "Handling",
"type": "object",
"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"
}
},
"additionalProperties": false
},
"HoldAtLocation": {
"title": "HoldAtLocation",
"description": "Hold At Location",
"type": "object",
"properties": {
"Applied": {
"type": "string"
},
"Address": {
"type": "string"
},
"AddressType": {
"type": "string"
}
},
"additionalProperties": false
},
"ImageFormat": {
"title": "Image Format",
"description": "Format of returned labels",
"type": "object",
"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"
]
}
},
"additionalProperties": false
},
"Instructions": {
"title": "Instructions",
"description": "Instructions",
"type": "object",
"properties": {
"Handling": {
"type": "string"
},
"Delivery": {
"type": "string"
},
"HomeDelivery": {
"type": "string"
},
"Pickup": {
"type": "string"
}
},
"additionalProperties": false
},
"InventoryQuantities": {
"title": "Inventory Quantities",
"description": "Inventory Quantities",
"type": "object",
"properties": {
"Quantities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryQuantity"
},
"title": "Quantities",
"description": "Inventory Quantities"
},
"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"
]
}
},
"additionalProperties": false,
"required": [
"Quantities"
]
},
"ListingKey": {
"title": "Listing Key",
"description": "Composite key used to identify a row in the listing / listing_variation tables across all marketplaces. The full key is StoreType + StoreKey + SellerId + ListingId + ChannelWarehouseId. StoreKey and SellerId roles vary by marketplace — see each field's description.",
"type": "object",
"properties": {
"StoreType": {
"description": "Marketplace identifier. Amazon = 'amazon'; Amazon Vendor = 'amzv'; eBay = 'ebay'; cart marketplaces use their own store type code (e.g. mirakl, bigcommerce, shopify).",
"type": "string",
"enum": [
"3dcart",
"3plcentral",
"Manual",
"RMA",
"aafes",
"aafes2",
"academysports",
"acehardware",
"acenda",
"amazon",
"amzv",
"ashley",
"ashley2",
"barnesnoble",
"basspro",
"belk",
"belkb2b",
"bestbuy",
"bestbuy2bca",
"bigcommerce",
"bonanza",
"ca2",
"campwrld",
"chewy",
"commercehub",
"corecommerce",
"costco",
"costcoca",
"costcojp",
"cratejoy",
"creloaded",
"cscart",
"cymax",
"doitbest",
"dsco",
"ebay",
"essentialhub",
"etsy",
"fabfitfun",
"fleetfarm",
"generic",
"goflow",
"googlec",
"googleexpress",
"groupongoods",
"hdpro",
"hdsupply",
"hdsupplyso",
"homedepot",
"homedepot2b",
"homedepotca",
"homedepotso",
"homehardware",
"houzz",
"hsn",
"jcpenney",
"kohls",
"lampsplus",
"lowes",
"lowes2b",
"lowesca",
"lowesm",
"macys",
"magento",
"magento2",
"menards",
"michaels",
"mirakl",
"newegg",
"neweggApi",
"neweggb2b",
"nfm",
"northerntool",
"opencart",
"opensky",
"orgill",
"oscommerce",
"paypal",
"pcrs",
"petco",
"petsmart",
"pinnacle",
"prestashop",
"qbi",
"qbo",
"qbr",
"quill",
"qvc",
"rakuten",
"reverb",
"ruegilt",
"samsclub",
"sears",
"shein",
"shipstation",
"shopify",
"sparkpay",
"squarespace",
"staplesadvca",
"staplesca",
"staplesca2b",
"supplieroasis",
"target",
"target2b",
"temu",
"tiktok",
"tongtool",
"tophatter",
"tractorsupply",
"tractorsupply2b",
"volusion",
"walmart",
"walmartdsv",
"walmartpo",
"wayfair",
"wish",
"woocommerce",
"wsonoma",
"xcart",
"xcart5",
"yahoo",
"zencart",
"zoro"
]
},
"StoreKey": {
"description": "For StoreType 'amazon' or 'amzv': the Amazon marketplace country code (e.g. US, CA, UK). For cart marketplaces: the cart store key. Not used for StoreType 'ebay'.",
"type": "string",
"pattern": "(^$)|[a-zA-Z0-9]{2,7}"
},
"SellerId": {
"description": "For StoreType 'amazon' or 'amzv': the Amazon Selling Partner ID. For StoreType 'ebay': the Username. Ignored for cart marketplaces.",
"type": "string"
},
"ListingId": {
"description": "Listing ID on the marketplace.",
"type": "string"
},
"ChannelWarehouseId": {
"description": "Channel warehouse ID as reported by the marketplace. Optional; defaults to empty when the marketplace does not report one.",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"StoreType"
]
},
"Listingsresult": {
"title": "Listings result",
"type": "object",
"properties": {
"Listings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Listing"
},
"title": "Listings"
}
},
"additionalProperties": false,
"required": [
"Listings"
]
},
"Listingupdateentry": {
"title": "Listing update entry",
"description": "One listing row to update on PUT /Listing. Inherits the composite-key fields (StoreType, StoreKey, SellerId, ListingId, ChannelWarehouseId) from ListingKey. At least one of WarehouseId or Discontinued must be provided; both may be provided together to apply both updates in a single call. ListingId is the primary row identifier; SellerSKU is accepted only as a deprecated fallback when ListingId is empty.",
"type": "object",
"properties": {
"StoreType": {
"description": "Marketplace identifier. Amazon = 'amazon'; Amazon Vendor = 'amzv'; eBay = 'ebay'; cart marketplaces use their own store type code (e.g. mirakl, bigcommerce, shopify).",
"type": "string",
"enum": [
"3dcart",
"3plcentral",
"Manual",
"RMA",
"aafes",
"aafes2",
"academysports",
"acehardware",
"acenda",
"amazon",
"amzv",
"ashley",
"ashley2",
"barnesnoble",
"basspro",
"belk",
"belkb2b",
"bestbuy",
"bestbuy2bca",
"bigcommerce",
"bonanza",
"ca2",
"campwrld",
"chewy",
"commercehub",
"corecommerce",
"costco",
"costcoca",
"costcojp",
"cratejoy",
"creloaded",
"cscart",
"cymax",
"doitbest",
"dsco",
"ebay",
"essentialhub",
"etsy",
"fabfitfun",
"fleetfarm",
"generic",
"goflow",
"googlec",
"googleexpress",
"groupongoods",
"hdpro",
"hdsupply",
"hdsupplyso",
"homedepot",
"homedepot2b",
"homedepotca",
"homedepotso",
"homehardware",
"houzz",
"hsn",
"jcpenney",
"kohls",
"lampsplus",
"lowes",
"lowes2b",
"lowesca",
"lowesm",
"macys",
"magento",
"magento2",
"menards",
"michaels",
"mirakl",
"newegg",
"neweggApi",
"neweggb2b",
"nfm",
"northerntool",
"opencart",
"opensky",
"orgill",
"oscommerce",
"paypal",
"pcrs",
"petco",
"petsmart",
"pinnacle",
"prestashop",
"qbi",
"qbo",
"qbr",
"quill",
"qvc",
"rakuten",
"reverb",
"ruegilt",
"samsclub",
"sears",
"shein",
"shipstation",
"shopify",
"sparkpay",
"squarespace",
"staplesadvca",
"staplesca",
"staplesca2b",
"supplieroasis",
"target",
"target2b",
"temu",
"tiktok",
"tongtool",
"tophatter",
"tractorsupply",
"tractorsupply2b",
"volusion",
"walmart",
"walmartdsv",
"walmartpo",
"wayfair",
"wish",
"woocommerce",
"wsonoma",
"xcart",
"xcart5",
"yahoo",
"zencart",
"zoro"
]
},
"StoreKey": {
"description": "For StoreType 'amazon' or 'amzv': the Amazon marketplace country code (e.g. US, CA, UK). For cart marketplaces: the cart store key. Not used for StoreType 'ebay'.",
"type": "string",
"pattern": "(^$)|[a-zA-Z0-9]{2,7}"
},
"SellerId": {
"description": "For StoreType 'amazon' or 'amzv': the Amazon Selling Partner ID. For StoreType 'ebay': the Username. Ignored for cart marketplaces.",
"type": "string"
},
"ListingId": {
"description": "Listing ID on the marketplace.",
"type": "string"
},
"ChannelWarehouseId": {
"description": "Channel warehouse ID as reported by the marketplace. Optional; defaults to empty when the marketplace does not report one.",
"type": "string"
},
"SellerSKU": {
"description": "DEPRECATED: use ListingId. Seller SKU is accepted only as a fallback row identifier when ListingId is empty.",
"type": "string"
},
"WarehouseId": {
"description": "New Warehouse ID to set. At least one of WarehouseId or Discontinued must be present.",
"type": "integer"
},
"Price": {
"description": "New listing price to set. At least one of WarehouseId, Price, or Discontinued must be present.",
"type": "number"
},
"Discontinued": {
"description": "Set to 1 to discontinue or 0 to re-activate the listing. At least one of WarehouseId, Price, or Discontinued must be present.",
"type": "integer",
"enum": [
0,
1
]
}
},
"additionalProperties": false,
"required": [
"StoreType"
]
},
"Listingupdaterequest": {
"title": "Listing update request",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"Listings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Listingupdateentry"
},
"title": "Listings"
}
},
"additionalProperties": false
},
"Manifestrequest": {
"title": "Manifest request",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"AirwayBillId": {
"type": "string"
},
"TxnIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "TxnIds",
"description": "List of TxnId to be included in manifest",
"minItems": 1
},
"Force": {
"description": "Force submit Txns that were already manifested. Default false. Affects PBOWESPS only.",
"type": "boolean"
},
"Provider": {
"description": "Provider if specified will force usage of label from MARKETPLACE vs NATIVE carrier accounts linked in Teapplix.",
"type": "string",
"enum": [
"NATIVE",
"MARKETPLACE",
"TEAPPLIX",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"RATESHOP"
]
}
},
"additionalProperties": false,
"required": [
"TxnIds"
]
},
"Manifestresult": {
"title": "Manifest result",
"description": "Result of submitting a shipping manifest. HTTP 200 always — domain-level failures (carrier/upstream rejected the manifest) surface as Status='Failure' with detail in the inherited Message/Description fields. Transport / validation errors arrive as the error envelope (Message) with a 4xx/5xx status.",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Operation status: 'Success' if the manifest was generated and the SCAN form returned; 'Failure' if the upstream rejected the request (see Message / Description).",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
},
"Warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Warning"
},
"title": "Warnings",
"description": "DEPRECATED: per-warning detail will be folded into the inherited Message and Description fields in the next API major version. Continue to read it for now if you need structured warnings; new clients should rely on Message/Description instead."
},
"PickupDocument": {
"description": "Base64 encoded Pickup Document",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"MarkReview": {
"title": "Mark Review",
"description": "Mark Review",
"type": "object",
"properties": {
"TxnIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "TxnIds",
"description": "Array of Txn Ids"
}
},
"additionalProperties": false
},
"MarkReviewResult": {
"title": "MarkReviewResult",
"description": "Result of marking orders as reviewed",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Operation status: 'Reviewed' on success.",
"type": "string",
"enum": [
"Reviewed"
]
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"MarkShipped": {
"title": "MarkShipped",
"description": "Mark Shipped Status",
"type": "object",
"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"
}
},
"additionalProperties": false
},
"MarketplaceStatus": {
"title": "MarketplaceStatus",
"description": "The external status of the order: being reviewed after shipping label generated, tracking upload to marketplace, and invoices etc.",
"type": "object",
"properties": {
"Reviewed": {
"$ref": "#/components/schemas/MarkShipped"
},
"MarkShipped": {
"$ref": "#/components/schemas/MarkShipped"
}
},
"additionalProperties": false
},
"Memo": {
"title": "Memo",
"type": "object",
"properties": {
"Text": {
"description": "Memo text",
"type": "string",
"maxLength": 2048
},
"AppendMode": {
"description": "If true - appends text to current order Memo. Default false.",
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"Text"
]
},
"Message": {
"title": "Message",
"type": "object",
"properties": {
"Success": {
"description": "Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status.",
"type": "boolean"
},
"Code": {
"description": "Indicate error code. 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": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
}
},
"additionalProperties": false,
"required": [
"Success"
]
},
"Obtainaccesstokenresult": {
"title": "Obtain access token result",
"type": "object",
"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"
}
},
"additionalProperties": false,
"required": [
"AccessToken",
"ClientVHOST",
"ExpireTimeStamp"
]
},
"OrderDetails": {
"title": "OrderDetails",
"description": "Order details including queue, warehouse, tags, memo, and custom fields",
"type": "object",
"properties": {
"Invoice": {
"description": "If the order matches an invoice, the unique id of the invoice.",
"type": "string",
"maxLength": 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",
"pattern": "^\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])( (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$"
},
"Memo": {
"description": "This is memo from the buyer left when placing the order",
"type": "string",
"maxLength": 2048
},
"PrivateMemo": {
"description": "This is memo that seller placed on the order to help with processing. This is not from the buyer",
"type": "string",
"maxLength": 2048
},
"GiftMessage": {
"description": "Gift message",
"type": "string",
"maxLength": 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": {
"type": "array",
"items": {
"type": "string"
},
"title": "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."
},
"ShipClass": {
"description": "Ship class typically indicate the level of shipping speed the order should have",
"type": "string"
},
"Custom": {
"description": "Custom",
"type": "string",
"maxLength": 255
},
"Custom2": {
"description": "Custom2",
"type": "string",
"maxLength": 255
},
"Custom3": {
"description": "Custom3",
"type": "string",
"maxLength": 255
},
"Custom4": {
"description": "Custom4",
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
},
"OrderOperationResult": {
"title": "OrderOperationResult",
"type": "object",
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maxLength": 40
},
"Status": {
"description": "Submission status for order:",
"type": "string",
"enum": [
"Confirmed",
"NotFound",
"Failure"
]
},
"Message": {
"description": "Message",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"TxnId",
"Status"
]
},
"OrderQueryNotifications": {
"title": "Order Query Notifications",
"type": "object",
"properties": {
"Orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderQueryResult"
},
"title": "Orders"
},
"Pagination": {
"$ref": "#/components/schemas/Pagination",
"description": "Pagination data"
}
},
"additionalProperties": false,
"required": [
"Orders"
]
},
"OrderQueue": {
"title": "Order Queue",
"description": "Order queue — 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.",
"type": "object",
"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
},
"QueueType": {
"description": "Purpose for the Queue. Controls how the queue is handled in the UI and workflow. Allowed values: DISPLAY, HOLD, PRINT, RETURN, 3PL and AGENT. DISPLAY QUEUE is the default and for every day use. HOLD queue are for orders not to be printed for now and we may block label print or submit to 3pl until orders are moved out. PRINT and 3PL are for orders ready to print shipping label or submit to external warehouses. RETURN are for return shipments from customers back. AGENT is desiged to hold orders where AI Agent will run automated processes based on Agent.md to further route and distribute the orders.",
"type": "string",
"enum": [
"DISPLAY",
"HOLD",
"AGENT",
"PRINT",
"RETURN",
"3PL"
]
},
"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"
},
"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 — 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 — not returned in GET responses.",
"type": "string"
},
"AgentInstructions": {
"description": "Markdown instructions / Agent.md for the AGENT queue on how to process the orders. Ignored and not returned for all other queue types.",
"type": "string"
},
"AdditionalProfiles": {
"type": "array",
"items": {
"type": "integer"
},
"title": "AdditionalProfiles",
"description": "Additional shipping profile IDs for this queue (stored in queue_profile table). Each profile ID must exist in shipping_profile table. Returns empty array if no additional profiles."
}
},
"additionalProperties": false
},
"OrderResult": {
"title": "OrderResult",
"type": "object",
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maxLength": 40
},
"Success": {
"description": "DEPRECATED: use Code (0 = success, non-zero = error) and Status (Accepted/Declined/Exists/Processed) instead. This field will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Per-order submission status. This is the canonical per-item discriminator going forward (use it instead of Success):\n * 'Accepted' – order was accepted successfully\n * 'Declined' – order was declined\n * 'Exists' – order with specified TxnId already exists\n * 'Processed' - order was processed successfully",
"type": "string",
"enum": [
"Accepted",
"Declined",
"Exists",
"Processed"
]
},
"Code": {
"description": "DEPRECATED: under HTTP 200, the canonical per-order discriminator is Status (Accepted/Declined/Exists/Processed). For specific failure detail, read Message and Description. Code will be removed in the next API major version. The error envelope (HTTP 4xx/5xx Message) keeps Code as canonical — only this per-item Code is being phased out.",
"type": "integer"
},
"Message": {
"description": "Detailed message. Typically associated with errors",
"type": "string",
"maxLength": 255
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
}
},
"additionalProperties": false,
"required": [
"TxnId",
"Success",
"Status"
]
},
"OrderShipment": {
"title": "OrderShipment",
"type": "object",
"properties": {
"Package": {
"$ref": "#/components/schemas/ShipmentPackage",
"description": "Package specifies weight, dimension and shipping method for an order. On a shipped order, tracking info is also specified."
},
"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",
"pattern": "^(\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$"
},
"PostageAccount": {
"description": "Postage Account. Ignored on input.",
"type": "string"
}
},
"additionalProperties": false
},
"OrderSplitRevert": {
"title": "Order Split Revert",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"TxnId": {
"description": "Order Id for the parent order that was split. Please note: all child orders will be removed",
"type": "string",
"maxLength": 40,
"pattern": "[\\s\\S]"
}
},
"additionalProperties": false,
"required": [
"TxnId"
]
},
"OrderTotals": {
"title": "OrderTotals",
"description": "Order totals",
"type": "object",
"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",
"pattern": "[A-Z]{3}"
},
"PostageCurrency": {
"description": "Postage currency",
"type": "string",
"pattern": "[A-Z]{3}"
},
"Fee": {
"description": "Fee amount",
"type": "number"
},
"Total": {
"description": "Total amount",
"type": "number"
}
},
"additionalProperties": false
},
"PackageItem": {
"title": "PackageItem",
"description": "Declares package item to be shipped",
"type": "object",
"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
}
},
"additionalProperties": false,
"required": [
"Quantity"
]
},
"PackageType": {
"title": "PackageType",
"description": "Declares type of a custom package saved in Teapplix Setup",
"type": "object",
"properties": {
"PackageType": {
"description": "Type of custom package",
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"PackageType"
]
},
"Pagination": {
"title": "Pagination",
"description": "Declares pagination data",
"type": "object",
"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"
}
},
"additionalProperties": false
},
"Palletentity": {
"title": "Pallet entity",
"description": "Pallet information",
"type": "object",
"properties": {
"Position": {
"description": "Position value",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"Position"
]
},
"Pickup": {
"title": "Pickup",
"type": "object",
"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"
}
},
"additionalProperties": false
},
"PickupForOrderResult": {
"title": "PickupForOrderResult",
"description": "Result of submitting a pickup-for-order request",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Operation status: 'Submitted' on success.",
"type": "string",
"enum": [
"Submitted"
]
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"Product": {
"title": "Product",
"type": "object",
"properties": {
"ItemName": {
"type": "string"
},
"ItemType": {
"type": "string"
},
"VariationType": {
"type": "string",
"enum": [
"none",
"root"
]
},
"ItemTitle": {
"type": "string"
},
"Active": {
"type": "integer"
},
"Upc": {
"type": "string"
},
"Asin": {
"type": "string"
},
"CustomField": {
"type": "string"
},
"CustomField2": {
"type": "string"
},
"CustomField3": {
"type": "string"
},
"CustomField4": {
"type": "string"
},
"Supplier": {
"type": "string"
},
"SupplierSku": {
"type": "string"
},
"Brand": {
"type": "string"
},
"Mpn": {
"type": "string"
},
"Location": {
"type": "string"
},
"DefaultPrice": {
"type": "number"
},
"DefaultCost": {
"type": "number"
},
"HarmonizedCode": {
"type": "string"
},
"CountryOfOrigin": {
"description": "2 letter ISO code",
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "[A-Z]{2}"
},
"CustomsValue": {
"type": "number"
},
"CustomsDescription": {
"type": "string"
},
"LocalizedCustomsDescription": {
"type": "string"
},
"SalesRep": {
"type": "string"
},
"CommissionRate": {
"type": "number"
},
"ScanControl": {
"type": "string",
"enum": [
"normal",
"individual_scan",
"serial_scan",
"none"
]
},
"DangerousGoodsType": {
"type": "integer"
},
"DangerousGoodsDetails": {
"$ref": "#/components/schemas/DangerousGoodsDetails"
},
"MainImage": {
"$ref": "#/components/schemas/ProductMainImage",
"description": "Main Image"
},
"Weight": {
"$ref": "#/components/schemas/Weight"
},
"Dimensions": {
"$ref": "#/components/schemas/Dimensionsofpackage"
},
"ShippingPlan": {
"$ref": "#/components/schemas/ProductShippingPlan"
},
"CatalogInfo": {
"$ref": "#/components/schemas/ProductCatalogInfo"
}
},
"additionalProperties": false,
"required": [
"ItemName"
]
},
"ProductCasePack": {
"title": "ProductCasePack",
"description": "Case pack configuration. When an order quantity is a multiple of UnitsPerCase, each case ships as a separate unit according to Strategy.",
"type": "object",
"properties": {
"UnitsPerCase": {
"description": "Number of product units per case shipped. When this is set product is typicalled sold in multiples of this quantity. Typically applies in case of B2B sales.",
"type": "integer",
"minimum": 1
},
"Strategy": {
"description": "How each case is shipped. SPLIT creates a separate child order per case. EP (Extra Package) adds each case as an extra package on the same order.",
"type": "string",
"enum": [
"SPLIT",
"EP"
]
}
},
"additionalProperties": false,
"required": [
"UnitsPerCase",
"Strategy"
]
},
"ProductCatalogInfo": {
"title": "ProductCatalogInfo",
"description": "Product catalog and listing fields. Only populated when DetailLevel=CatalogInfo is requested.",
"type": "object",
"properties": {
"Category": {
"type": "string"
},
"ShortDescriptionBase64": {
"type": "string"
},
"LongDescriptionBase64": {
"type": "string"
},
"WalmartCategoryId": {
"type": "string"
},
"WalmartCategoryOptionsBase64": {
"type": "string"
},
"WalmartTaxCode": {
"type": "integer"
},
"MAPPrice": {
"type": "number"
},
"MSRPPrice": {
"type": "number"
},
"AdditionalImages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductImage"
},
"title": "AdditionalImages",
"description": "Additional Images"
},
"Features": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductFeature"
},
"title": "Features",
"description": "Product Features"
},
"ShippingExceptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductShippingException"
},
"title": "ShippingExceptions",
"description": "Item Shipping Exceptions"
},
"Keywords": {
"description": "Product Keywords",
"type": "string"
}
},
"additionalProperties": false
},
"ProductGetResponse": {
"title": "Product Get Response",
"type": "object",
"properties": {
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
},
"title": "Products"
},
"Pagination": {
"$ref": "#/components/schemas/Pagination",
"description": "Pagination data"
}
},
"additionalProperties": false,
"required": [
"Products"
]
},
"ProductImage": {
"title": "ProductImage",
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"seqNum": {
"type": "string"
},
"url": {
"type": "string"
},
"altText": {
"type": "string"
},
"purpose": {
"type": "string"
}
},
"additionalProperties": false
},
"ProductMainImage": {
"title": "ProductMainImage",
"description": "Product Main Image",
"type": "object",
"properties": {
"ImageUrlLarge": {
"description": "Large Image URL",
"type": "string"
},
"ImageUrlSmall": {
"description": "Small Image URL",
"type": "string"
},
"AltText": {
"description": "Alternate Text",
"type": "string"
}
},
"additionalProperties": true
},
"ProductMapping": {
"title": "Product Mapping",
"description": "Declares product mapping",
"type": "object",
"properties": {
"SourceItemName": {
"type": "string"
},
"TeapplixSKU": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"SourceItemName",
"TeapplixSKU"
]
},
"ProductMappingOperationdetails": {
"title": "Product Mapping Operation details",
"type": "object",
"properties": {
"SourceItemName": {
"description": "Source Item Name",
"type": "string",
"maxLength": 40
},
"Success": {
"description": "DEPRECATED: use Code (0 = success, non-zero = error) instead. This field will be removed in the next API major version.",
"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",
"maxLength": 40
}
},
"additionalProperties": false,
"required": [
"SourceItemName",
"Success"
]
},
"ProductMappingOperationresult": {
"title": "Product Mapping Operation result",
"description": "Product Mapping Operation result",
"type": "object",
"properties": {
"ProductXrefs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductMappingOperationdetails"
},
"title": "ProductXrefs",
"description": "Product mapping operation details"
}
},
"additionalProperties": false,
"required": [
"ProductXrefs"
]
},
"ProductMappingResponse": {
"title": "Product Mapping Response",
"type": "object",
"properties": {
"ProductXrefs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductMapping"
},
"title": "ProductXrefs"
},
"Pagination": {
"$ref": "#/components/schemas/Pagination",
"description": "Pagination data"
}
},
"additionalProperties": false,
"required": [
"ProductXrefs"
]
},
"ProductOperationResult": {
"title": "ProductOperationResult",
"type": "object",
"properties": {
"ItemName": {
"description": "Item Name",
"type": "string",
"maxLength": 40
},
"Status": {
"description": "Submission status for product",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"description": "Message",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"ItemName",
"Status"
]
},
"ProductShippingException": {
"title": "ProductShippingException",
"description": "Product Shipping Exception",
"type": "object",
"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"
}
},
"additionalProperties": true
},
"ProductShippingPlan": {
"title": "ProductShippingPlan",
"description": "Default shipping execution policy for this product. Controls which carrier methods are used, case pack behavior, and add-on options. All fields are optional.",
"type": "object",
"properties": {
"EconomyMethod": {
"description": "Carrier method code for Economy class. Valid values from GET /ShipMethods.",
"type": "string"
},
"StandardMethod": {
"description": "Carrier method code for Standard class. Valid values from GET /ShipMethods.",
"type": "string"
},
"ExpeditedMethod": {
"description": "Carrier method code for Expedited class. Valid values from GET /ShipMethods.",
"type": "string"
},
"SecondDayMethod": {
"description": "Carrier method code for 2-Day class. Valid values from GET /ShipMethods.",
"type": "string"
},
"OneDayMethod": {
"description": "Carrier method code for 1-Day class. Valid values from GET /ShipMethods.",
"type": "string"
},
"IntlEconomyMethod": {
"description": "Carrier method code for International Economy class. Valid values from GET /ShipMethods.",
"type": "string"
},
"IntlStandardMethod": {
"description": "Carrier method code for International Standard class. Valid values from GET /ShipMethods.",
"type": "string"
},
"IntlExpeditedMethod": {
"description": "Carrier method code for International Expedited class. Valid values from GET /ShipMethods.",
"type": "string"
},
"DomesticInsurance": {
"description": "Add insurance to domestic shipments. 1 = yes, 0 = no.",
"type": "integer",
"enum": [
0,
1
]
},
"InternationalInsurance": {
"description": "Add insurance to international shipments. 1 = yes, 0 = no.",
"type": "integer",
"enum": [
0,
1
]
},
"SignatureRequired": {
"description": "Require signature on delivery. 1 = yes, 0 = no.",
"type": "integer",
"enum": [
0,
1
]
},
"IdenticalPackageCount": {
"description": "Number of identical packages a single product unit ships in. Opposite of CasePack: CasePack groups multiple units into one case, IdenticalPackageCount splits one unit across N same-sized boxes.",
"type": "integer",
"minimum": 1
},
"PackageInstructions": {
"description": "Free-form packing instructions for this product. Max 255 characters.",
"type": "string"
},
"CasePack": {
"$ref": "#/components/schemas/ProductCasePack",
"description": "Case pack configuration. Required fields UnitsPerCase and Strategy must both be provided together."
}
},
"additionalProperties": false
},
"ProductsMapping": {
"title": "Products Mapping",
"description": "Used to insert Products Mapping",
"type": "object",
"properties": {
"ProductXrefs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductMapping"
},
"title": "ProductXrefs",
"description": "Product Mappings to be inserted"
},
"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"
}
},
"additionalProperties": false,
"required": [
"ProductXrefs",
"AutoCleanup"
]
},
"ProductsMappingDeleteRequest": {
"title": "Products Mapping Delete Request",
"description": "Used to delete Product Mapping",
"type": "object",
"properties": {
"ProductXrefs": {
"type": "array",
"items": {
"type": "string"
},
"title": "ProductXrefs",
"description": "Source SKU to be deleted"
}
},
"additionalProperties": false,
"required": [
"ProductXrefs"
]
},
"ProfileId": {
"title": "ProfileId",
"description": "Shipping profile",
"type": "object",
"properties": {
"ProfileId": {
"description": "Id of shipping profile, saved in Teapplix Setup",
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false,
"required": [
"ProfileId"
]
},
"QueueDelete": {
"title": "Queue Delete",
"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.",
"type": "object",
"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"
}
},
"additionalProperties": false
},
"QueueGetResponse": {
"title": "Queue Get Response",
"description": "Response to GET /Queue. Contains a list of order queues matching the query filters, ordered by QueueSeq then QueueId.",
"type": "object",
"properties": {
"Queues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderQueue"
},
"title": "Queues",
"description": "List of order queues matching the query filters. Empty array if none match."
}
},
"additionalProperties": false,
"required": [
"Queues"
]
},
"QueueOperationResult": {
"title": "QueueOperationResult",
"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.",
"type": "object",
"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"
}
},
"additionalProperties": false,
"required": [
"QueueId",
"Status"
]
},
"Qvn": {
"title": "Qvn",
"type": "object",
"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": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FreightNotificationRecipient"
},
"title": "Recipients",
"description": "Qvn Recipients"
}
},
"additionalProperties": false
},
"Rate": {
"title": "Rate",
"type": "object",
"properties": {
"Transportation": {
"description": "Base transportation price",
"type": "number"
},
"ServiceAmount": {
"description": "The sum of all shipping service fees",
"type": "number"
},
"ServiceFees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RateAdjustment"
},
"title": "ServiceFees",
"description": "Detailed description of shipping fees. If set then ServiceAmount will be ignored (if present)"
},
"Discounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RateAdjustment"
},
"title": "Discounts",
"description": "Detailed description of discounts. Each entry's Amount is negative."
},
"Currency": {
"description": "The currency for this rate",
"type": "string",
"pattern": "[A-Z]{3}"
},
"Name": {
"description": "The shipping method name",
"type": "string"
},
"ShipMethod": {
"description": "The shipping method",
"type": "string"
},
"Carrier": {
"description": "The carrirer name",
"type": "string"
},
"Provider": {
"description": "The provider name if applicable",
"type": "string"
},
"DeliveryDate": {
"description": "Estimated delivery date",
"type": "string",
"pattern": "^\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$"
},
"Volume": {
"description": "Cubic volume applied to the rate",
"type": "string"
},
"Benefits": {
"description": "Comma-separated list of included benefits (e.g. CLAIMS_PROTECTED)",
"type": "string"
},
"Error": {
"description": "The error message if selected rate is not available",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"Transportation",
"Name"
]
},
"RateAdjustment": {
"title": "RateAdjustment",
"description": "A named adjustment to a rate. Positive amounts are fees/surcharges; negative amounts are discounts.",
"type": "object",
"properties": {
"Name": {
"description": "Name of the adjustment",
"type": "string",
"maxLength": 64
},
"Description": {
"description": "Description of this adjustment",
"type": "string",
"maxLength": 255
},
"Amount": {
"description": "Amount of this adjustment. Negative for discounts.",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"Name",
"Amount"
]
},
"RateShopCandidate": {
"title": "RateShopCandidate",
"description": "One candidate inside a RateShop method: a pointer to another shipping method (ShipMethod, by name) plus the constraints and price adjustment that apply when it is considered. At label time the candidates whose weight/dimension constraints match the package are rated and the cheapest (after adjustment) wins.",
"type": "object",
"properties": {
"ShipMethod": {
"description": "The shipping method to rate, by Name: an API method name as returned by GET /ShipMethod (e.g. USPS_PRIORITY_PACKAGE), or an internal method code (e.g. PRIORITY/RECTPARCEL). Must be unique across the method's candidates - the same method cannot be listed twice, including via a different alias of the same method. A RateShop method cannot be used as a candidate.",
"type": "string"
},
"Seq": {
"description": "Priority order, starting at 1, unique within the method (1-127). If omitted on all candidates, sequence is assigned from array position.",
"type": "integer"
},
"MinWeight": {
"description": "Only consider this candidate when package weight is at least this value (in WeightUnit). Omit for no lower bound.",
"type": "number"
},
"MaxWeight": {
"description": "Only consider this candidate when package weight is at most this value (in WeightUnit). Omit for no upper bound.",
"type": "number"
},
"WeightUnit": {
"description": "Unit for MinWeight/MaxWeight. Default oz.",
"type": "string",
"enum": [
"oz",
"lb",
"gram",
"kg"
]
},
"MaxLength": {
"description": "Only consider this candidate when the longest package side is at most this many inches. Omit for no limit.",
"type": "integer"
},
"MaxWidth": {
"description": "Only consider this candidate when package width is at most this many inches. Omit for no limit.",
"type": "integer"
},
"MaxDepth": {
"description": "Only consider this candidate when package depth is at most this many inches. Omit for no limit.",
"type": "integer"
},
"AdjustmentAmount": {
"description": "Adjustment applied to this candidate's rate during comparison, in cents or percent depending on AdjustmentAmountType. Default 0.",
"type": "integer"
},
"AdjustmentAmountType": {
"description": "Unit of AdjustmentAmount. Default cent.",
"type": "string",
"enum": [
"cent",
"percent"
]
},
"AltProfileList": {
"description": "Comma-separated list of alternate shipping profile IDs to also rate this candidate under.",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"ShipMethod"
]
},
"RateShopDetails": {
"title": "RateShopDetails",
"description": "The rate-shop settings of a shipping method: which methods it compares (Candidates) and the constraints applied when choosing between them. Present on a ShipMethod only when its Carrier is RATESHOP, and accepted on POST/PUT only for that carrier.",
"type": "object",
"properties": {
"DestinationRegion": {
"description": "Destination scope the method applies to: us = domestic, intl = international, all = both. Defaults to us on create.",
"type": "string",
"enum": [
"all",
"us",
"intl"
]
},
"HonorDeliverBy": {
"description": "When true, only rates that meet the order's deliver-by date are considered. Defaults to false on create.",
"type": "boolean"
},
"MaxDeliveryDays": {
"description": "Only consider rates with estimated delivery within this many days (1-127). Omit for no limit; on PUT send 0 to clear a previously set value.",
"type": "integer"
},
"Candidates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RateShopCandidate"
},
"title": "Candidates",
"description": "The shipping methods this rate-shop method compares at label time; the cheapest candidate satisfying its constraints wins. Required on create (at least one). On PUT: omit to keep the existing candidates, or provide the full new set to replace them. Each method may appear only once. Mixing UPS (other than Mail Innovations) with non-UPS candidates, or FedEx Ground with FedEx Home Delivery, is rejected."
}
},
"additionalProperties": false
},
"Recipient": {
"title": "Recipient",
"description": "Recipient",
"type": "object",
"properties": {
"TaxId": {
"$ref": "#/components/schemas/CustomsId"
},
"CustomsId": {
"$ref": "#/components/schemas/CustomsId"
}
},
"additionalProperties": false
},
"ReportParams": {
"title": "Report Params",
"description": "Parameters for Report - structure varies by ReportType",
"type": "object",
"properties": {
"DateStart": {
"description": "Start date (YYYY-MM-DD or YYYY/MM/DD). REQUIRED for INVENTORY_SALES_REPORT and PO_FORECAST_REPORT. Required for TRACKING_REPORT when TxnId and TrackingNumber are not provided.",
"type": "string"
},
"DateEnd": {
"description": "End date (YYYY-MM-DD or YYYY/MM/DD). REQUIRED for INVENTORY_SALES_REPORT and PO_FORECAST_REPORT. Required for TRACKING_REPORT when TxnId and TrackingNumber are not provided. Date range cannot exceed 90 days for TRACKING_REPORT.",
"type": "string"
},
"DateField": {
"description": "Date field to filter by. For INVENTORY_SALES_REPORT and PO_FORECAST_REPORT. Default: PaymentDate",
"type": "string",
"enum": [
"PaymentDate",
"ShipDate"
]
},
"StoreType": {
"description": "Filter by store type/platform. For INVENTORY_SALES_REPORT and PO_FORECAST_REPORT.",
"type": "string"
},
"ItemCategory": {
"description": "Filter by item category. Only for INVENTORY_SALES_REPORT.",
"type": "string"
},
"UPC": {
"description": "Filter by UPC. Only for INVENTORY_SALES_REPORT.",
"type": "string"
},
"ASIN": {
"description": "Filter by ASIN. Only for INVENTORY_SALES_REPORT.",
"type": "string"
},
"Location": {
"description": "Filter by inventory location. Only for INVENTORY_SALES_REPORT.",
"type": "string"
},
"Supplier": {
"description": "Filter by supplier. Only for INVENTORY_SALES_REPORT.",
"type": "string"
},
"Compare": {
"description": "Layout of the sales sheet. Only for INVENTORY_SALES_REPORT. When omitted the plain layout is used (one metric column group for the whole range). 'week'/'month'/'quarter'/'year': split the figures into period buckets, one metric column group per bucket. 'prev_period'/'prev_year': compare the whole range against the previous period or the same range a year back and add Prev/Change metric column groups.",
"type": "string",
"enum": [
"week",
"month",
"quarter",
"year",
"prev_period",
"prev_year"
]
},
"WarehouseId": {
"description": "Filter by warehouse ID. For INVENTORY_SALES_REPORT, SHIPPED_INVENTORY_REPORT, INVENTORY_QUANTITY_REPORT, INVENTORY_STALE_REPORT and INVENTORY_SHORTAGE_REPORT.",
"type": "integer"
},
"ItemName": {
"description": "Filter by Teapplix SKU (ItemName). For INVENTORY_SALES_REPORT, SHIPPED_INVENTORY_REPORT, INVENTORY_QUANTITY_REPORT, INVENTORY_STALE_REPORT, INVENTORY_SHORTAGE_REPORT and PO_FORECAST_REPORT.",
"type": "string"
},
"ItemType": {
"description": "Filter by item type. For SHIPPED_INVENTORY_REPORT and INVENTORY_QUANTITY_REPORT. Values: 'inventory'=Inventory Item (0), 'combo'=Combo Item (1), 'non_inventory'=Non Inventory (2), 'other'=Other (3). Note: ItemType filter is not supported for INVENTORY_STALE_REPORT and INVENTORY_SHORTAGE_REPORT.",
"type": "string",
"enum": [
"inventory",
"combo",
"non_inventory",
"other"
]
},
"TxnId": {
"description": "Filter by order ID (TxnId). Only for TRACKING_REPORT. If provided, DateStart/DateEnd are optional.",
"type": "string"
},
"TrackingNumber": {
"description": "Filter by tracking number. Only for TRACKING_REPORT. If provided, DateStart/DateEnd are optional.",
"type": "string"
},
"Status": {
"description": "Filter by delivery status. Only for TRACKING_REPORT. Values: 'no_delivered'=not delivered, 'delivered', 'pre_transit', 'in_transit', 'out_for_delivery', 'available_for_pickup', 'picked_up' (maps to pre_transit/in_transit/out_for_delivery), 'not_picked_up' (maps to available_for_pickup).",
"type": "string",
"enum": [
"no_delivered",
"delivered",
"pre_transit",
"in_transit",
"out_for_delivery",
"available_for_pickup",
"picked_up",
"not_picked_up"
]
},
"IndiciumSource": {
"description": "Filter by indicium source (carrier/PC postage provider). Only for TRACKING_REPORT. Values: 'easypost', 'dhl', 'gss', 'pbowes'.",
"type": "string",
"enum": [
"easypost",
"dhl",
"gss",
"pbowes"
]
},
"Action": {
"description": "Filter by action type. For POSTAGE_TRANSACTIONS and POSTAGE_REFUNDS. Values: 'purchase', 'refund', 'rebate'.",
"type": "string"
},
"Provider": {
"description": "Filter by postage provider. For POSTAGE_TRANSACTIONS and POSTAGE_REFUNDS. Examples: 'USPS', 'UPS', 'FedEx', 'DHL'.",
"type": "string"
},
"Reconcile": {
"description": "Filter by refund reconciliation status. Only for POSTAGE_REFUNDS. Values: 'requested', 'not_charged', 'rejected', 'approved', 'charged'.",
"type": "string",
"enum": [
"requested",
"not_charged",
"rejected",
"approved",
"charged"
]
}
},
"additionalProperties": false
},
"ReportRequest": {
"title": "Report Request",
"description": "Request to create a new report",
"type": "object",
"properties": {
"ReportType": {
"description": "Report type. Supported types:\n\n - TRACKING_REPORT: Delivery exception history report from sapi_tracking table.\n Optional params: TxnId, TrackingNumber, Status, IndiciumSource, DateStart, DateEnd.\n IMPORTANT: If neither TxnId nor TrackingNumber is provided, DateStart and DateEnd are REQUIRED.\n Date range cannot exceed 90 days.\n\n - INVENTORY_SALES_REPORT: Sales chart data report.\n REQUIRED params: DateStart, DateEnd.\n Optional params: DateField, enum(PaymentDate, ShipDate) - specify if we limit by payment date or date order is shipped, default PaymentDate\n Other ptional params: StoreType, ItemName, WarehouseId, ItemCategory, UPC, ASIN, Location, Supplier - further limit order or items included in report\n - SALES_REPORT: Deprecated alias for INVENTORY_SALES_REPORT, will be removed soon. Use INVENTORY_SALES_REPORT instead.\n\n - SHIPPED_INVENTORY_REPORT: Shipped inventory report.\n Optional params: WarehouseId, ItemName, ItemType ('inventory', 'combo', 'non_inventory', 'other').\n\n - INVENTORY_QUANTITY_REPORT: Inventory quantity report (current quantity).\n Optional params: WarehouseId, ItemName, ItemType ('inventory', 'combo', 'non_inventory', 'other').\n\n - INVENTORY_STALE_REPORT: Stale inventory report (items with weeks_to_empty > stale_weeks).\n Optional params: WarehouseId, ItemName.\n Note: ItemType filter is NOT supported for this report.\n\n - INVENTORY_SHORTAGE_REPORT: Shortage inventory report (items with weeks_to_empty < shortage_weeks).\n Optional params: WarehouseId, ItemName.\n Note: ItemType filter is NOT supported for this report.\n\n - PO_FORECAST_REPORT: PO based on existing sales volume data.\n REQUIRED params: DateStart, DateEnd.\n Optional params: DateField enum(PaymentDate, ShipDate) - specify if we limit by payment date or date order is shipped, default PaymentDate\n Other optional params: StoreType, ItemName - further limit order or items included to build the forecast.\n\n - POSTAGE_TRANSACTIONS: Postage transactions report.\n Optional params: DateStart, DateEnd, Action, Provider, TrackingNumber, TxnId.\n\n - POSTAGE_REFUNDS: Postage refunds report.\n Optional params: DateStart, DateEnd, Action, Provider, TrackingNumber, TxnId, Reconcile.\n\n - POSTAGE_PAYMENTS: Postage payments report.\n Optional params: DateStart, DateEnd.\n ",
"type": "string",
"enum": [
"TRACKING_REPORT",
"INVENTORY_SALES_REPORT",
"SALES_REPORT",
"SHIPPED_INVENTORY_REPORT",
"INVENTORY_QUANTITY_REPORT",
"INVENTORY_STALE_REPORT",
"INVENTORY_SHORTAGE_REPORT",
"PO_FORECAST_REPORT",
"POSTAGE_TRANSACTIONS",
"POSTAGE_REFUNDS",
"POSTAGE_PAYMENTS"
]
},
"Params": {
"$ref": "#/components/schemas/ReportParams",
"description": "Report parameters. Structure varies by ReportType:\n *\n * ================================================================================\n * TRACKING_REPORT (Delivery exception history report)\n * ================================================================================\n * If TxnId or TrackingNumber is provided, DateStart/DateEnd are optional.\n * If neither TxnId nor TrackingNumber is provided, DateStart/DateEnd are REQUIRED.\n * Date range cannot exceed 90 days.\n *\n * - TxnId: Order ID filter (string)\n * - TrackingNumber: Tracking number filter (string)\n * - Status: Delivery status filter (string)\n * Valid values: 'no_delivered' (not delivered), 'delivered', 'pre_transit',\n * 'in_transit', 'out_for_delivery', 'available_for_pickup', 'picked_up',\n * 'not_picked_up'\n * - IndiciumSource: Carrier/PC postage provider filter (string)\n * Valid values: 'easypost', 'dhl', 'gss', 'pbowes'\n * - DateStart: Start date (YYYY-MM-DD or YYYY/MM/DD)\n * - DateEnd: End date (YYYY-MM-DD or YYYY/MM/DD)\n *\n * ================================================================================\n * INVENTORY_SALES_REPORT (Sales chart data report; deprecated alias: SALES_REPORT)\n * ================================================================================\n * DateStart and DateEnd are REQUIRED.\n *\n * - DateStart: Start date (YYYY-MM-DD or YYYY/MM/DD) [REQUIRED]\n * - DateEnd: End date (YYYY-MM-DD or YYYY/MM/DD) [REQUIRED]\n * - DateField: Date field to filter by (string)\n * Valid values: 'PaymentDate' (default), 'ShipDate'\n * - StoreType: Store type/platform filter (string)\n * - ItemName: Teapplix SKU filter (string)\n * - WarehouseId: Warehouse ID filter (integer)\n * - ItemCategory: Item category filter (string)\n * - UPC: UPC filter (string)\n * - ASIN: ASIN filter (string)\n * - Location: Inventory location filter (string)\n * - Supplier: Supplier filter (string)\n *\n * ================================================================================\n * SHIPPED_INVENTORY_REPORT (Shipped inventory report)\n * ================================================================================\n * All parameters are optional.\n *\n * - WarehouseId: Warehouse ID filter (integer)\n * - ItemName: Teapplix SKU filter (string)\n * - ItemType: Item type filter (string)\n * Valid values: 'inventory' (Inventory Item), 'combo' (Combo Item),\n * 'non_inventory' (Non Inventory), 'other' (Other)\n *\n * ================================================================================\n * INVENTORY_QUANTITY_REPORT (Inventory quantity report)\n * ================================================================================\n * Reports current inventory quantity with cost calculations.\n * All parameters are optional.\n *\n * - WarehouseId: Warehouse ID filter (integer)\n * - ItemName: Teapplix SKU filter (string)\n * - ItemType: Item type filter (string)\n * Valid values: 'inventory' (Inventory Item), 'combo' (Combo Item),\n * 'non_inventory' (Non Inventory), 'other' (Other)\n *\n * ================================================================================\n * INVENTORY_STALE_REPORT (Stale inventory report)\n * ================================================================================\n * Reports items where weeks_to_empty > stale_weeks (configured in account settings).\n * All parameters are optional.\n *\n * - WarehouseId: Warehouse ID filter (integer)\n * - ItemName: Teapplix SKU filter (string)\n * Note: ItemType is NOT supported for this report.\n *\n * ================================================================================\n * INVENTORY_SHORTAGE_REPORT (Shortage inventory report)\n * ================================================================================\n * Reports items where weeks_to_empty < shortage_weeks (configured in account settings).\n * All parameters are optional.\n *\n * - WarehouseId: Warehouse ID filter (integer)\n * - ItemName: Teapplix SKU filter (string)\n * Note: ItemType is NOT supported for this report.\n *\n * ================================================================================\n * PO_FORECAST_REPORT (PO based on sales forecast report)\n * ================================================================================\n * Exports sales data for PO planning. DateStart and DateEnd are REQUIRED.\n *\n * - DateStart: Start date (YYYY-MM-DD or YYYY/MM/DD) [REQUIRED]\n * - DateEnd: End date (YYYY-MM-DD or YYYY/MM/DD) [REQUIRED]\n * - DateField: Date field to filter by (string)\n * Valid values: 'PaymentDate' (default), 'ShipDate'\n * - StoreType: Store type/platform filter (string)\n * - ItemName: Teapplix SKU filter (string)\n * "
}
},
"additionalProperties": false,
"required": [
"ReportType"
]
},
"ReportResponse": {
"title": "Report Response",
"type": "object",
"properties": {
"Success": {
"description": "Operation success",
"type": "boolean"
},
"ReportId": {
"description": "Generated report ID",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"Success"
]
},
"RequestPickupForOrder": {
"title": "Request Pickup For Order",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"TxnId": {
"description": "Order TxnId to be pickuped up",
"type": "string",
"maxLength": 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": "#/components/schemas/Weight"
},
"Volume": {
"$ref": "#/components/schemas/Volumeentity"
},
"Pallet": {
"$ref": "#/components/schemas/Palletentity"
}
},
"additionalProperties": false,
"required": [
"TxnId",
"PickupDateTime",
"Weight",
"Volume",
"Pallet"
]
},
"ReturnAddress": {
"title": "ReturnAddress",
"description": "Return address printed on labels",
"type": "object",
"properties": {
"Name": {
"description": "Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required.",
"type": "string",
"maxLength": 128
},
"FirstName": {
"description": "First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name.",
"type": "string",
"maxLength": 128
},
"LastName": {
"description": "Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name.",
"type": "string",
"maxLength": 128
},
"Company": {
"description": "Company or organization name. At least one of Name, FirstName + LastName, or Company is required.",
"type": "string",
"maxLength": 127
},
"Street": {
"description": "Street address, line 1 (building number and street name).",
"type": "string",
"maxLength": 255
},
"Street2": {
"description": "Street address, line 2 (apartment, suite, unit, floor, etc.).",
"type": "string",
"maxLength": 255
},
"City": {
"description": "City or town name.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"State": {
"description": "US state abbreviation (e.g. CA) or province/region name for international addresses.",
"type": "string",
"maxLength": 40
},
"ZipCode": {
"description": "US ZIP code or international postal code.",
"type": "string"
},
"CountryCode": {
"description": "ISO 3166-1 alpha-2 country code (e.g. US, CA, GB).",
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "[A-Z]{2}"
},
"Country": {
"description": "Full country name (e.g. United States, Canada). Defaults to United States",
"type": "string"
},
"PhoneNumber": {
"description": "Phone number. Format may be normalized by the carrier.",
"type": "string",
"maxLength": 40
},
"Email": {
"description": "Email address.",
"type": "string"
}
},
"additionalProperties": true
},
"Route": {
"title": "Route",
"description": "Shipment route",
"type": "object",
"properties": {
"FromZip": {
"description": "Sender's zip code",
"type": "string",
"pattern": "[0-9]{5}"
},
"ToZip": {
"description": "Recipient zip code",
"type": "string",
"pattern": "[0-9]{5}"
}
},
"additionalProperties": false,
"required": [
"FromZip",
"ToZip"
]
},
"SSCCLabelForOrder": {
"title": "SSCC Label For Order",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"ProfileId": {
"description": "Id of shipping profile, saved in Teapplix Setup",
"type": "integer",
"minimum": 1
},
"TxnIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "TxnIds",
"description": "List of order ids to generate SSCC label for",
"minItems": 1
},
"ForceRegen": {
"description": "Force re-generate SSCC label",
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"ProfileId",
"TxnIds"
]
},
"Service": {
"title": "Service",
"type": "object",
"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"
}
},
"additionalProperties": false
},
"ShipMethod": {
"title": "ShipMethod",
"description": "A shipping method. Name + Carrier identify it, and Name is the method constant used everywhere else a ship method is accepted (PurchaseLabel, Shipment, ...). The same object is returned by GET and accepted by POST/PUT. Most methods are provided by carrier integrations and are read-only; methods with Carrier RATESHOP are managed through this endpoint and carry a RateShop object holding their rate-shop settings, which is absent for every other carrier.",
"type": "object",
"properties": {
"Name": {
"description": "Shipping method constant name (e.g. FEDEX_GROUND, UPS_GROUND, USPS_PRIORITY_FLAT_RATE_BOX, or a RateShop method name). With Carrier this identifies the method on PUT and DELETE. Required on write.",
"type": "string"
},
"Carrier": {
"description": "Carrier identifier (e.g. FEDEX, UPS, USPS, DHLEC, DHLE, ONTRAC, RATESHOP). Acts as the discriminator on write: only RATESHOP methods can be created, updated, or deleted. Required on write.",
"type": "string"
},
"Description": {
"description": "Human-readable service name (e.g. 'Ground', 'Priority Flat Rate Box'). Writable for RATESHOP methods (up to 255 characters); for carrier-provided methods this is the derived service name and is read-only.",
"type": "string"
},
"PackageType": {
"description": "Broad container category: 'envelope' for letter/envelope services, 'package' for all others. Read-only; ignored on write.",
"type": "string"
},
"RateShop": {
"$ref": "#/components/schemas/RateShopDetails",
"description": "Rate-shop settings: the methods this one compares (Candidates) and the constraints applied when choosing between them. Present on GET only when Carrier is RATESHOP, and accepted on POST/PUT only for that carrier. Required on POST for RATESHOP; on PUT, omit to leave all rate-shop settings unchanged."
},
"GenericCarrier": {
"$ref": "#/components/schemas/GenericCarrierDetails",
"description": "Settings of a method on a generic carrier - a carrier you define yourself. Present on GET only when Carrier is one of yours, and accepted on POST/PUT for those carriers. Optional on POST (defaults are applied); on PUT, omit to leave these settings unchanged."
}
},
"additionalProperties": false
},
"ShipMethodDelete": {
"title": "Ship Method Delete",
"description": "Used to delete an editable shipping method by name: a RateShop method, or a method on a generic carrier you defined. Method names are unique across both, so the name alone identifies it. Methods provided by carrier integrations and 3PL vendors cannot be deleted.",
"type": "object",
"properties": {
"Name": {
"description": "Name of the method to delete: a RateShop method name, or the method code of a generic carrier method.",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"Name"
]
},
"ShipMethodGetResponse": {
"title": "ShipMethod Get Response",
"description": "Response to GET /ShipMethod. Contains a list of shipping method entries.",
"type": "object",
"properties": {
"Methods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipMethod"
},
"title": "Methods",
"description": "List of shipping methods."
}
},
"additionalProperties": false,
"required": [
"Methods"
]
},
"ShipMethodOperationResult": {
"title": "ShipMethodOperationResult",
"description": "Result of a ship method create, update, or delete operation.",
"type": "object",
"properties": {
"Carrier": {
"description": "Carrier of the affected method, upper-cased.",
"type": "string"
},
"Name": {
"description": "Name of the affected method.",
"type": "string"
},
"Status": {
"description": "Outcome of the operation: Success = completed successfully; Failure = validation or database error (see Message); NotFound = no method matched the given Carrier + Name.",
"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"
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"ShippingConfirmationresult": {
"title": "Shipping Confirmation result",
"type": "object",
"properties": {
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderOperationResult"
},
"title": "Items",
"description": "List of results"
}
},
"additionalProperties": false
},
"ShippingOptions": {
"title": "ShippingOptions",
"description": "Used to set shipping options for order without printing",
"type": "object",
"properties": {
"TxnId": {
"description": "Order id to modify.",
"type": "string"
},
"Packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Package"
},
"title": "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.",
"minItems": 1
},
"Options": {
"$ref": "#/components/schemas/OrderShippingOptions"
},
"CustomsOptions": {
"$ref": "#/components/schemas/Customsoptions"
}
},
"additionalProperties": false,
"required": [
"TxnId"
]
},
"ShippingOptionsGetResult": {
"title": "ShippingOptionsGetResult",
"description": "Response from GET /OrderShipOptions. By default returns only carrier-agnostic Options fields (InsuranceType, Delivery). Pass DetailLevel=carrier to receive the full carrier-specific Options tree.",
"type": "object",
"properties": {
"TxnId": {
"description": "Order ID.",
"type": "string"
},
"Options": {
"$ref": "#/components/schemas/SavedShippingOptions",
"description": "Shipping options for the order. By default contains carrier-agnostic fields only (InsuranceType, Delivery.Signature, Delivery.Residential). Pass DetailLevel=carrier to include the full carrier-specific options tree."
}
},
"additionalProperties": false,
"required": [
"TxnId",
"Options"
]
},
"ShippingOptionsResult": {
"title": "ShippingOptionsResult",
"description": "Result of updating shipping options for an existing order",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Operation status: 'Updated' on success.",
"type": "string",
"enum": [
"Updated"
]
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"ShippingProfile": {
"title": "ShippingProfile",
"description": "Shipping profile (identity, address, return address)",
"type": "object",
"properties": {
"ProfileId": {
"type": "integer"
},
"ProfileName": {
"type": "string"
},
"Address": {
"$ref": "#/components/schemas/ReturnAddress",
"description": "Shipper address used when printing labels"
},
"ReturnAddress": {
"$ref": "#/components/schemas/ReturnAddress",
"description": "Return address printed on labels"
},
"OnlyBill3rdParty": {
"description": "Only bill 3rd party",
"type": "boolean"
},
"ForceProvider": {
"description": "Force label provider: 'marketplace' or 'native'. Set to 'off' to clear (no forcing).",
"type": "string",
"enum": [
"marketplace",
"native",
"off"
]
},
"Reference1": {
"description": "Reference 1",
"type": "string"
},
"Reference2": {
"description": "Reference 2",
"type": "string"
},
"Reference3": {
"description": "Reference 3",
"type": "string"
},
"Reference4": {
"description": "Reference 4",
"type": "string"
},
"Active": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ShippingProfileDelete": {
"title": "Shipping Profile Delete",
"description": "Used to delete a shipping profile. Provide either ProfileId or ProfileName.",
"type": "object",
"properties": {
"ProfileId": {
"description": "ID of the profile to delete",
"type": "integer"
},
"ProfileName": {
"description": "Name of the profile to delete (used if ProfileId is not provided)",
"type": "string"
}
},
"additionalProperties": false
},
"ShippingProfileGetResponse": {
"title": "Shipping Profile Get Response",
"type": "object",
"properties": {
"Profiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingProfile"
},
"title": "Profiles"
}
},
"additionalProperties": false,
"required": [
"Profiles"
]
},
"ShippingProfileOperationResult": {
"title": "ShippingProfileOperationResult",
"type": "object",
"properties": {
"ProfileId": {
"type": "integer"
},
"Status": {
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Message": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"ShippingZone": {
"title": "ShippingZone",
"type": "object",
"properties": {
"Routes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingZoneRoute"
},
"title": "Routes"
}
},
"additionalProperties": false
},
"Shippingconfirmation": {
"title": "Shipping confirmation",
"description": "Used to set shipping details for order shipped outside of Teapplix",
"type": "object",
"properties": {
"Shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentData"
},
"title": "Shipments",
"description": "Shipments details of orders to be marked"
},
"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"
}
},
"additionalProperties": false,
"required": [
"Shipments"
]
},
"Shippingrateresult": {
"title": "Shipping rate result",
"type": "object",
"properties": {
"Zone": {
"description": "Provider's shipping zone (if available)",
"type": "string"
},
"Rate": {
"$ref": "#/components/schemas/Rate"
},
"AltRates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rate"
},
"title": "AltRates",
"description": "Information related to the alternate rates of the shipment"
},
"Warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Warning"
},
"title": "Warnings",
"description": "Warning related to the this request"
}
},
"additionalProperties": false
},
"Submit3PLRequest": {
"title": "Submit 3PL Request",
"description": "Submit order to 3PL vendor",
"type": "object",
"properties": {
"TxnId": {
"description": "Order transaction ID",
"type": "string",
"maxLength": 40
},
"3PLType": {
"description": "3PL Type. Teapplix has helper methods to list available 3PLs to submit order to",
"type": "string",
"maxLength": 50,
"pattern": "^[a-zA-Z0-9_]+$"
},
"3PLKey": {
"description": "If you linked more than one account with the same 3PLType, 3PLKey uniquely identifies the account.",
"type": "string",
"maxLength": 100
},
"3PLWarehouseCode": {
"description": "For most 3PLs, an id indicating requested warehouse facility to send the order out of.",
"type": "string",
"maxLength": 100
},
"ShipMethod": {
"description": "3PL service code or ship method requested. This may be required for certain 3PL. For others this may be computed based on other parameters.",
"type": "string",
"maxLength": 100
},
"Weight": {
"$ref": "#/components/schemas/Weight"
}
},
"additionalProperties": false,
"required": [
"TxnId",
"3PLType"
]
},
"Submit3PLResponse": {
"title": "Submit 3PL Response",
"description": "Response from submitting an order to a 3PL vendor. Per-object shape: even on order-not-found / vendor-decline, returns HTTP 200 with Status indicating the per-object outcome (matches the bulk-result envelope rule).",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Submission status: 'Accepted' (vendor accepted), 'Declined' (vendor declined the submission), or 'NotFound' (order or shipping record not found in Teapplix).",
"type": "string",
"enum": [
"Accepted",
"Declined",
"NotFound"
]
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
},
"TxnId": {
"description": "Teapplix Order ID",
"type": "string"
},
"DropshipTxnId": {
"description": "ID assigned to the order by the 3PL. Used to track order fulfillment status. Only returned on successful submit.",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"Status",
"TxnId"
]
},
"Tag": {
"title": "Tag",
"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.",
"type": "object",
"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"
}
},
"additionalProperties": false
},
"TagDelete": {
"title": "Tag Delete",
"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.",
"type": "object",
"properties": {
"TagId": {
"description": "ID of the tag to delete",
"type": "integer"
},
"TagName": {
"description": "Name of the tag to delete (exact match)",
"type": "string"
}
},
"additionalProperties": false
},
"TagGetResponse": {
"title": "Tag Get Response",
"description": "Response to GET /Tag. Contains a list of tags matching the query filters, ordered by TagId.",
"type": "object",
"properties": {
"Tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
},
"title": "Tags",
"description": "List of tags matching the query filters. Empty array if none match."
}
},
"additionalProperties": false,
"required": [
"Tags"
]
},
"TagOperationResult": {
"title": "TagOperationResult",
"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.",
"type": "object",
"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"
}
},
"additionalProperties": false,
"required": [
"TagId",
"Status"
]
},
"To": {
"title": "To",
"description": "Recipient address",
"type": "object",
"properties": {
"Name": {
"description": "Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required.",
"type": "string",
"maxLength": 128
},
"FirstName": {
"description": "First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name.",
"type": "string",
"maxLength": 128
},
"LastName": {
"description": "Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name.",
"type": "string",
"maxLength": 128
},
"Company": {
"description": "Company or organization name. At least one of Name, FirstName + LastName, or Company is required.",
"type": "string",
"maxLength": 127
},
"Street": {
"description": "Street address, line 1 (building number and street name).",
"type": "string",
"maxLength": 255
},
"Street2": {
"description": "Street address, line 2 (apartment, suite, unit, floor, etc.).",
"type": "string",
"maxLength": 255
},
"City": {
"description": "City or town name.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"State": {
"description": "US state abbreviation (e.g. CA) or province/region name for international addresses.",
"type": "string",
"maxLength": 40
},
"ZipCode": {
"description": "US ZIP code or international postal code.",
"type": "string"
},
"CountryCode": {
"description": "ISO 3166-1 alpha-2 country code (e.g. US, CA, GB).",
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "[A-Z]{2}"
},
"Country": {
"description": "Full country name (e.g. United States, Canada). Defaults to United States",
"type": "string"
},
"PhoneNumber": {
"description": "Phone number. Format may be normalized by the carrier.",
"type": "string",
"maxLength": 40
},
"Email": {
"description": "Email address.",
"type": "string"
}
},
"additionalProperties": true
},
"Track": {
"title": "Track",
"type": "object",
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maxLength": 40,
"pattern": "[\\s\\S]"
},
"PackageNo": {
"description": "Package Number",
"type": "integer"
},
"ShipDate": {
"description": "Shipping date",
"type": "string",
"format": "date"
},
"TrackingNumber": {
"description": "Tracking number of shipment",
"type": "string",
"maxLength": 50
},
"CarrierName": {
"description": "Carrier name which is assigned with tracking",
"type": "string"
},
"IsDelivered": {
"description": "Was package delivered",
"type": "boolean"
},
"Status": {
"description": "Teapplix tracking status: delivered, in_transit, out_for_delivery, picked_up, pre_transit, return_to_sender, failure, unknown",
"type": "string"
},
"EstimatedDeliveryDate": {
"description": "Estimated Delivery Date (if available)",
"type": "string",
"pattern": "^\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$"
},
"Events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingEventDetails"
},
"title": "Events",
"description": "Tracking events details"
}
},
"additionalProperties": false,
"required": [
"TrackingNumber",
"IsDelivered"
]
},
"TrackNotificationResult": {
"title": "TrackNotificationResult",
"description": "Result of a track-notification submission. Currently the endpoint is a stub (returns 501); when implemented, the success body extends SuccessMessage and carries the resolved shipments under Shipments.",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Operation status: 'Recorded' on success.",
"type": "string",
"enum": [
"Recorded"
]
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
},
"Shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Track"
},
"title": "Shipments",
"description": "Per-shipment tracking detail resolved by the request."
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"TrackingEventDetails": {
"title": "TrackingEventDetails",
"type": "object",
"properties": {
"DateTime": {
"description": "Event date and time (UTC)",
"type": "string",
"pattern": "^\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$"
},
"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"
]
},
"Status": {
"description": "Teapplix tracking status: delivered, in_transit, out_for_delivery, picked_up, pre_transit, return_to_sender, failure, unknown",
"type": "string"
},
"Description": {
"description": "Event type description (if available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"Type"
]
},
"TrackingInfo": {
"title": "Tracking Info",
"description": "Tracking info",
"type": "object",
"properties": {
"TrackingNumber": {
"description": "Tracking number of shipment",
"type": "string",
"maxLength": 50
},
"CarrierName": {
"description": "Carrier name which is assigned with tracking",
"type": "string"
},
"SSCC": {
"description": "Serial Shipping Container Code",
"type": "string"
}
},
"additionalProperties": false
},
"Type": {
"title": "Type",
"description": "Allows you to specify a built-in package type (integer) defined by the carrier, or a custom package you defined by name in your Teapplix account. You should specify one of 'Type' or 'Dimensions' in your input.",
"oneOf": [
{
"$ref": "#/components/schemas/PackageType"
},
{
"$ref": "#/components/schemas/CustomPackageName"
}
]
},
"Ups": {
"title": "Ups",
"description": "UPS specific options",
"type": "object",
"properties": {
"SurepostNonMachineable": {
"description": "UPS Surepost Non Machineable",
"type": "boolean"
},
"Qvn": {
"$ref": "#/components/schemas/Qvn"
},
"Freight": {
"$ref": "#/components/schemas/UPSFreight"
}
},
"additionalProperties": false
},
"VendorScanrequest": {
"title": "Vendor Scan request",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"EventId": {
"type": "string",
"enum": [
"80",
"81",
"82"
]
},
"TxnIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "TxnIds",
"description": "List of TxnId to upload Vendor Scan for",
"minItems": 1
}
},
"additionalProperties": false,
"required": [
"TxnIds"
]
},
"VendorScanresult": {
"title": "Vendor Scan result",
"description": "Result of submitting vendor scan events to the upstream job runner. HTTP 200 always — domain-level failures (upstream EOD job declined the event) surface as Status='Failure' with detail in Warnings; transport / validation errors arrive as the error envelope (Message) with a 4xx/5xx status.",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Operation status: 'Success' if the upstream job accepted the scan event; 'Failure' if the job ran but reported an error (see Warnings).",
"type": "string",
"enum": [
"Success",
"Failure"
]
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
},
"Warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Warning"
},
"title": "Warnings",
"description": "Structured warnings returned by the upstream EOD job (richer than the inherited string Description)."
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"Volumeentity": {
"title": "Volume entity",
"description": "Total volume",
"type": "object",
"properties": {
"Value": {
"description": "Absolute value",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"Value"
]
},
"Warehouse": {
"title": "Warehouse",
"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.",
"type": "object",
"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: your own warehouse where you track inventory quantity in Teapplix. QB: your own warehouse where you track inventory in QuickBooks. FBA: Amazon Fulfillment. 3PL types (e.g. ECCANGWMS): third-party warehouses where they manage your inventory for you. Required on create. For 3PL/FBA warehouses, WarehouseType cannot be modified after creation. RECONCILE is a special type of virtual warehouse. It is used to compare quanitty using your own calculation against quantities reported by a 3rd party warehouse.",
"type": "string",
"enum": [
"GENERIC",
"RECONCILE",
"DROPSHIP",
"QB",
"DROPSHIP-T",
"FB4PX",
"DELIVERY51",
"ANMEIGROUP",
"CPWH",
"CHUKOU1",
"ECCANG",
"ECCANGERP",
"ECCANGWMS",
"FINALE",
"GIGAB2B",
"GUCANG",
"JUNMAOWMS",
"K5",
"LECANG",
"LINGXINGERP",
"LINGXINGWMS",
"NETSUITE",
"SHIPOUT",
"SHIPSTATION",
"WARE2GO",
"WINIT",
"YUNQUNA",
"FBA",
"WAYFAIR"
]
},
"QuantityAlgorithm": {
"description": "Inventory quantity calculation method for warehouses where quantity is maintained by Teapplix. CALCULATED: quantity computed from credits and debits plus order activity where each order coming in will debit inventory. STATIC: computed from credits and debits without considering order quantity. Not having to look at orders make computation of quantity faster. FIXED: always shows a fixed quantity, this is typcally the case when you want to expose the quantity to external systems and you are a manfacture and you can always make more as needed. Only applicable to GENERIC, RECONCILE warehouse types; Ignored for warehouess where quantity is managed externally.",
"type": "string",
"enum": [
"CALCULATED",
"STATIC",
"FIXED"
]
},
"3PLKey": {
"description": "When you have multiple accounts at a single 3PL, this key identifies which account it is. Normally this is blank as most people only have one account per 3PL.",
"type": "string"
},
"3PLWarehouseCode": {
"description": "Identifies a single warehouse facility at a certain 3PL. This will link this warehouse to a Teapplix warehouse object. We may keep track of inventory quantity held at this warehouse and also submit orders to this warehouse for fulfillment.",
"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"
}
},
"additionalProperties": false
},
"WarehouseDelete": {
"title": "Warehouse Delete",
"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.",
"type": "object",
"properties": {
"WarehouseId": {
"description": "ID of the warehouse to delete",
"type": "integer"
},
"WarehouseName": {
"description": "Name of the warehouse to delete (exact match)",
"type": "string"
}
},
"additionalProperties": false
},
"WarehouseGetResponse": {
"title": "Warehouse Get Response",
"description": "Response to GET /Warehouse. Contains a list of warehouses matching the query filters.",
"type": "object",
"properties": {
"Warehouses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Warehouse"
},
"title": "Warehouses",
"description": "List of warehouses matching the query filters. Empty array if none match."
}
},
"additionalProperties": false,
"required": [
"Warehouses"
]
},
"WarehouseOperationResult": {
"title": "WarehouseOperationResult",
"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.",
"type": "object",
"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"
}
},
"additionalProperties": false,
"required": [
"WarehouseId",
"Status"
]
},
"Warning": {
"title": "Warning",
"type": "object",
"properties": {
"Code": {
"description": "Warning code (if applicable)",
"type": "string"
},
"Message": {
"description": "Warning message",
"type": "string"
},
"ShipMethod": {
"description": "The shipping method",
"type": "string"
},
"Carrier": {
"description": "The carrirer name",
"type": "string"
},
"Provider": {
"description": "The provider name if applicable",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"Message"
]
},
"Zones": {
"title": "Zones",
"description": "Request to obtain shipping zone",
"type": "object",
"properties": {
"Routes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Route"
},
"title": "Routes",
"description": "The packages routes",
"minItems": 1
}
},
"additionalProperties": false,
"required": [
"Routes"
]
},
"UPSFreight": {
"title": "UPS Freight",
"type": "object",
"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",
"maxLength": 40
},
"PayerAddress": {
"description": "Payer Address",
"type": "string",
"maxLength": 255
},
"PayerCity": {
"description": "Payer City",
"type": "string",
"maxLength": 50
},
"PayerState": {
"description": "Payer State",
"type": "string",
"maxLength": 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": "#/components/schemas/Handling"
},
"DangerousGoods": {
"$ref": "#/components/schemas/DangerousGoods"
},
"Pickup": {
"$ref": "#/components/schemas/Pickup"
}
},
"additionalProperties": false
},
"FedExFreight": {
"title": "FedEx Freight",
"description": "Freight",
"type": "object",
"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",
"maxLength": 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",
"maxLength": 255
},
"FreightDirectType": {
"description": "Freight Direct Type",
"type": "string",
"maxLength": 255
},
"FreightDirectTransportationType": {
"description": "Freight Direct Transportation Type",
"type": "string",
"maxLength": 255
},
"FreightDirectEmail": {
"description": "Freight Direct Email",
"type": "string",
"maxLength": 255
},
"FreightDirectPhoneType1": {
"description": "Freight Direct Phone Type 1",
"type": "string",
"maxLength": 255
},
"FreightDirectPhoneNumber1": {
"description": "Freight Direct Phone Number 1",
"type": "string",
"maxLength": 255
},
"FreightDirectPhoneType2": {
"description": "Freight Direct Phone Type 2",
"type": "string",
"maxLength": 255
},
"FreightDirectPhoneNumber2": {
"description": "Freight Direct Phone Number 2",
"type": "string",
"maxLength": 255
},
"FreightDirectPhoneType3": {
"description": "Freight Direct Phone Type 3",
"type": "string",
"maxLength": 255
},
"FreightDirectPhoneNumber3": {
"description": "Freight Direct Phone Number 3",
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
},
"ListingToUpdate": {
"title": "Listing To Update",
"type": "object",
"properties": {
"StoreType": {
"description": "Order type",
"type": "string",
"enum": [
"3dcart",
"3plcentral",
"Manual",
"RMA",
"aafes",
"aafes2",
"academysports",
"acehardware",
"acenda",
"amazon",
"amzv",
"ashley",
"ashley2",
"barnesnoble",
"basspro",
"belk",
"belkb2b",
"bestbuy",
"bestbuy2bca",
"bigcommerce",
"bonanza",
"ca2",
"campwrld",
"chewy",
"commercehub",
"corecommerce",
"costco",
"costcoca",
"costcojp",
"cratejoy",
"creloaded",
"cscart",
"cymax",
"doitbest",
"dsco",
"ebay",
"essentialhub",
"etsy",
"fabfitfun",
"fleetfarm",
"generic",
"goflow",
"googlec",
"googleexpress",
"groupongoods",
"hdpro",
"hdsupply",
"hdsupplyso",
"homedepot",
"homedepot2b",
"homedepotca",
"homedepotso",
"homehardware",
"houzz",
"hsn",
"jcpenney",
"kohls",
"lampsplus",
"lowes",
"lowes2b",
"lowesca",
"lowesm",
"macys",
"magento",
"magento2",
"menards",
"michaels",
"mirakl",
"newegg",
"neweggApi",
"neweggb2b",
"nfm",
"northerntool",
"opencart",
"opensky",
"orgill",
"oscommerce",
"paypal",
"pcrs",
"petco",
"petsmart",
"pinnacle",
"prestashop",
"qbi",
"qbo",
"qbr",
"quill",
"qvc",
"rakuten",
"reverb",
"ruegilt",
"samsclub",
"sears",
"shein",
"shipstation",
"shopify",
"sparkpay",
"squarespace",
"staplesadvca",
"staplesca",
"staplesca2b",
"supplieroasis",
"target",
"target2b",
"temu",
"tiktok",
"tongtool",
"tophatter",
"tractorsupply",
"tractorsupply2b",
"volusion",
"walmart",
"walmartdsv",
"walmartpo",
"wayfair",
"wish",
"woocommerce",
"wsonoma",
"xcart",
"xcart5",
"yahoo",
"zencart",
"zoro"
]
},
"StoreKey": {
"description": "Unique id for each store type, filled for StoreType other than ebay or amazon",
"type": "string",
"pattern": "(^$)|[a-zA-Z0-9]{3}"
},
"SellerSKU": {
"description": "Seller SKU",
"type": "string"
},
"SellerId": {
"type": "string"
},
"ListingId": {
"description": "Listing Id",
"type": "string"
},
"ChannelWarehouseId": {
"description": "Channel warehouse ID as reported by the marketplace; empty when the marketplace does not report one.",
"type": "string"
},
"Status": {
"description": "Status",
"type": "string"
},
"Message": {
"description": "Status Message",
"type": "string"
}
},
"additionalProperties": false
},
"ListingUpdateResult": {
"title": "Listing Update Result",
"type": "object",
"properties": {
"Listings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ListingToUpdate"
},
"title": "Listings",
"description": "Listing Results"
}
},
"additionalProperties": false
},
"Listing": {
"title": "Listing",
"type": "object",
"properties": {
"StoreType": {
"description": "Store Listing is From",
"type": "string",
"enum": [
"3dcart",
"3plcentral",
"Manual",
"RMA",
"aafes",
"aafes2",
"academysports",
"acehardware",
"acenda",
"amazon",
"amzv",
"ashley",
"ashley2",
"barnesnoble",
"basspro",
"belk",
"belkb2b",
"bestbuy",
"bestbuy2bca",
"bigcommerce",
"bonanza",
"ca2",
"campwrld",
"chewy",
"commercehub",
"corecommerce",
"costco",
"costcoca",
"costcojp",
"cratejoy",
"creloaded",
"cscart",
"cymax",
"doitbest",
"dsco",
"ebay",
"essentialhub",
"etsy",
"fabfitfun",
"fleetfarm",
"generic",
"goflow",
"googlec",
"googleexpress",
"groupongoods",
"hdpro",
"hdsupply",
"hdsupplyso",
"homedepot",
"homedepot2b",
"homedepotca",
"homedepotso",
"homehardware",
"houzz",
"hsn",
"jcpenney",
"kohls",
"lampsplus",
"lowes",
"lowes2b",
"lowesca",
"lowesm",
"macys",
"magento",
"magento2",
"menards",
"michaels",
"mirakl",
"newegg",
"neweggApi",
"neweggb2b",
"nfm",
"northerntool",
"opencart",
"opensky",
"orgill",
"oscommerce",
"paypal",
"pcrs",
"petco",
"petsmart",
"pinnacle",
"prestashop",
"qbi",
"qbo",
"qbr",
"quill",
"qvc",
"rakuten",
"reverb",
"ruegilt",
"samsclub",
"sears",
"shein",
"shipstation",
"shopify",
"sparkpay",
"squarespace",
"staplesadvca",
"staplesca",
"staplesca2b",
"supplieroasis",
"target",
"target2b",
"temu",
"tiktok",
"tongtool",
"tophatter",
"tractorsupply",
"tractorsupply2b",
"volusion",
"walmart",
"walmartdsv",
"walmartpo",
"wayfair",
"wish",
"woocommerce",
"wsonoma",
"xcart",
"xcart5",
"yahoo",
"zencart",
"zoro"
]
},
"StoreKey": {
"description": "Unique id for each store type, filled for StoreType other than ebay or amazon",
"type": "string",
"pattern": "(^$)|[a-zA-Z0-9]{3}"
},
"VSAccountID": {
"type": "string"
},
"SellerId": {
"description": "For StoreType ebay or amazon only",
"type": "string"
},
"ListingTitle": {
"description": "Listing Title",
"type": "string",
"maxLength": 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"
}
},
"additionalProperties": false
},
"OrderShippingOptions": {
"title": "Order Shipping Options",
"description": "Shipment options",
"type": "object",
"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": "#/components/schemas/DutyBilled"
},
"DutyBilled": {
"$ref": "#/components/schemas/DutyBilled"
},
"SplitDutyVAT": {
"description": "Split Duty VAT",
"type": "boolean"
},
"Delivery": {
"$ref": "#/components/schemas/Delivery"
},
"Service": {
"$ref": "#/components/schemas/Service"
},
"Cod": {
"$ref": "#/components/schemas/Cod"
},
"Ups": {
"$ref": "#/components/schemas/Ups"
},
"Fedex": {
"$ref": "#/components/schemas/Fedex"
},
"DHL": {
"$ref": "#/components/schemas/DHL"
},
"DHLE": {
"$ref": "#/components/schemas/DHLE"
},
"ReasonForExport": {
"description": "DEPRECATED! Reason for export",
"type": "string",
"maxLength": 20
}
},
"additionalProperties": false
},
"SavedShippingOptions": {
"title": "Saved Shipping Options",
"description": "Shipping options for the order. By default contains carrier-agnostic fields only (InsuranceType, Delivery.Signature, Delivery.Residential). Pass DetailLevel=carrier to include the full carrier-specific options tree.",
"type": "object",
"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": "#/components/schemas/DutyBilled"
},
"DutyBilled": {
"$ref": "#/components/schemas/DutyBilled"
},
"SplitDutyVAT": {
"description": "Split Duty VAT",
"type": "boolean"
},
"Delivery": {
"$ref": "#/components/schemas/Delivery"
},
"Service": {
"$ref": "#/components/schemas/Service"
},
"Cod": {
"$ref": "#/components/schemas/Cod"
},
"Ups": {
"$ref": "#/components/schemas/Ups"
},
"Fedex": {
"$ref": "#/components/schemas/Fedex"
},
"DHL": {
"$ref": "#/components/schemas/DHL"
},
"DHLE": {
"$ref": "#/components/schemas/DHLE"
},
"ReasonForExport": {
"description": "DEPRECATED! Reason for export",
"type": "string",
"maxLength": 20
}
},
"additionalProperties": false
},
"OrderToCreate": {
"title": "Order To Create",
"type": "object",
"properties": {
"TxnId": {
"description": "Unique id of an order in Teapplix. When we say teapplix order xxx, it often means TxnId=xxx",
"type": "string",
"maxLength": 40,
"pattern": "[\\s\\S]"
},
"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",
"aafes2",
"academysports",
"acehardware",
"acenda",
"amazon",
"amzv",
"ashley",
"ashley2",
"barnesnoble",
"basspro",
"belk",
"belkb2b",
"bestbuy",
"bestbuy2bca",
"bigcommerce",
"bonanza",
"ca2",
"campwrld",
"chewy",
"commercehub",
"corecommerce",
"costco",
"costcoca",
"costcojp",
"cratejoy",
"creloaded",
"cscart",
"cymax",
"doitbest",
"dsco",
"ebay",
"essentialhub",
"etsy",
"fabfitfun",
"fleetfarm",
"generic",
"goflow",
"googlec",
"googleexpress",
"groupongoods",
"hdpro",
"hdsupply",
"hdsupplyso",
"homedepot",
"homedepot2b",
"homedepotca",
"homedepotso",
"homehardware",
"houzz",
"hsn",
"jcpenney",
"kohls",
"lampsplus",
"lowes",
"lowes2b",
"lowesca",
"lowesm",
"macys",
"magento",
"magento2",
"menards",
"michaels",
"mirakl",
"newegg",
"neweggApi",
"neweggb2b",
"nfm",
"northerntool",
"opencart",
"opensky",
"orgill",
"oscommerce",
"paypal",
"pcrs",
"petco",
"petsmart",
"pinnacle",
"prestashop",
"qbi",
"qbo",
"qbr",
"quill",
"qvc",
"rakuten",
"reverb",
"ruegilt",
"samsclub",
"sears",
"shein",
"shipstation",
"shopify",
"sparkpay",
"squarespace",
"staplesadvca",
"staplesca",
"staplesca2b",
"supplieroasis",
"target",
"target2b",
"temu",
"tiktok",
"tongtool",
"tophatter",
"tractorsupply",
"tractorsupply2b",
"volusion",
"walmart",
"walmartdsv",
"walmartpo",
"wayfair",
"wish",
"woocommerce",
"wsonoma",
"xcart",
"xcart5",
"yahoo",
"zencart",
"zoro"
]
},
"StoreKey": {
"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",
"pattern": "(^$)|[a-zA-Z0-9]{2,5}"
},
"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": "#/components/schemas/To"
},
"BillTo": {
"$ref": "#/components/schemas/ReturnAddress"
},
"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": "#/components/schemas/OrderTotals"
},
"OrderDetails": {
"$ref": "#/components/schemas/OrderDetails"
},
"OrderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
},
"title": "OrderItems",
"description": "Information related to the order’s items",
"minItems": 1
},
"ShippingDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderShipment"
},
"title": "ShippingDetails",
"description": "Information related to the order’s packages. This tag is optional, but if specified array must have at least one OrderShipment to define the main package for the order. If you add more OrderShipment, those will represent extra packages for the order."
},
"DropshipDetails": {
"$ref": "#/components/schemas/DrophipDetails"
},
"Options": {
"$ref": "#/components/schemas/OrderShippingOptions"
},
"CustomsOptions": {
"$ref": "#/components/schemas/Customsoptions"
},
"HandlingBy": {
"description": "Date before which the order is expected to be shipped out",
"type": "string",
"pattern": "^(\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$"
},
"DeliverBy": {
"description": "Date by which the order is expected to arrive at the buyer",
"type": "string",
"pattern": "^(\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$"
},
"SeqNumber": {
"type": "string"
},
"RMACode": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"TxnId",
"To",
"OrderTotals",
"OrderDetails",
"OrderItems"
]
},
"OrderToUpdate": {
"title": "Order To Update",
"type": "object",
"properties": {
"TxnId": {
"description": "TxnId for order being updated",
"type": "string",
"maxLength": 40,
"pattern": "[\\s\\S]"
},
"PaymentStatus": {
"description": "If specified, we will modify order PaymentStatus. If you set PaymentStatus to Cancelled, you must also add a Memo.",
"type": "string",
"enum": [
"Completed",
"Cancelled",
"Refunded",
"PartialRefund"
]
},
"To": {
"$ref": "#/components/schemas/ReturnAddress"
},
"OrderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
},
"title": "OrderItems",
"description": "Order items, if specified the orders items will be replaced with what is specified here."
},
"OrderDetails": {
"$ref": "#/components/schemas/OrderDetails"
},
"ShippingDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderShipment"
},
"title": "ShippingDetails",
"description": "Shipping packages for the order. If specified, the array must contain at least one OrderShipment defining the main package; additional entries represent extra packages."
},
"Options": {
"$ref": "#/components/schemas/OrderShippingOptions"
},
"AppendMode": {
"description": "If true, appends OrderDetails.Memo and OrderDetails.PrivateMemo to the existing memo values; if false (default), replaces them.",
"type": "boolean"
},
"QueueId": {
"description": "DEPRECATED: Use OrderDetails.QueueId instead.",
"type": "integer"
},
"TagList": {
"type": "array",
"items": {
"type": "string"
},
"title": "TagList",
"description": "DEPRECATED: Use OrderDetails.TagList instead."
},
"WarehouseId": {
"description": "DEPRECATED: Use OrderDetails.WarehouseId instead.",
"type": "integer"
},
"Memo": {
"$ref": "#/components/schemas/Memo"
},
"Custom": {
"description": "DEPRECATED: Use OrderDetails.Custom instead.",
"type": "string",
"maxLength": 255
},
"Custom2": {
"description": "DEPRECATED: Use OrderDetails.Custom2 instead.",
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"TxnId"
]
},
"OrderQueryResult": {
"title": "Order Query Result",
"type": "object",
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maxLength": 40,
"pattern": "[\\s\\S]"
},
"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",
"pattern": "(^$)|[a-zA-Z0-9]{2,5}"
},
"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": "#/components/schemas/ReturnAddress"
},
"BillTo": {
"$ref": "#/components/schemas/ReturnAddress"
},
"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": "#/components/schemas/OrderTotals"
},
"OrderDetails": {
"$ref": "#/components/schemas/OrderDetails"
},
"OrderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
},
"title": "OrderItems",
"description": "Information related to the order’s items",
"minItems": 1
},
"ShippingDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderShipment"
},
"title": "ShippingDetails",
"description": "Information related to the order’s packages. This tag is optional, but if specified array must have at least one OrderShipment to define the main package for the order. If you add more OrderShipment, those will represent extra packages for the order."
},
"DropshipDetails": {
"$ref": "#/components/schemas/DrophipDetails"
},
"Options": {
"$ref": "#/components/schemas/OrderShippingOptions"
},
"CustomsOptions": {
"$ref": "#/components/schemas/Customsoptions"
},
"HandlingBy": {
"description": "Date before which the order is expected to be shipped out",
"type": "string",
"pattern": "^(\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$"
},
"DeliverBy": {
"description": "Date by which the order is expected to arrive at the buyer",
"type": "string",
"pattern": "^(\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])){0,1}$"
},
"SeqNumber": {
"description": "Unique integer assigned to each order as they are created. Increases",
"type": "string"
},
"RMACode": {
"description": "Type of RMA",
"type": "string"
},
"MarketplaceStatus": {
"$ref": "#/components/schemas/MarketplaceStatus"
}
},
"additionalProperties": false,
"required": [
"TxnId"
]
},
"OrderToSplit": {
"title": "Order To Split",
"type": "object",
"properties": {
"TxnId": {
"description": "Order Id for the sub order, must be unique",
"type": "string",
"maxLength": 40,
"pattern": "[\\s\\S]"
},
"OrderDetails": {
"$ref": "#/components/schemas/OrderDetails"
},
"OrderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItemToSplit"
},
"title": "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.",
"minItems": 1
},
"ShippingDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderShipment"
},
"title": "ShippingDetails",
"description": "Information related to the order’s ship method, weight and dimensions. Optional and for split order we do not support extra packages, so specify only one Order Shipment here.",
"maxItems": 1
},
"Hold": {
"description": "Hold for now",
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"TxnId",
"OrderDetails",
"OrderItems"
]
},
"OrderNotifications": {
"title": "Order Notifications",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"Operation": {
"description": "Requested operation",
"type": "string",
"enum": [
"Submit"
]
},
"Orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderToCreate"
},
"title": "Orders",
"description": "Array of orders"
}
},
"additionalProperties": false
},
"OrderUpdateNotifications": {
"title": "Order Update Notifications",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"Orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderToUpdate"
},
"title": "Orders",
"description": "Array of orders to update"
}
},
"additionalProperties": false
},
"OrderSplitRequest": {
"title": "Order Split Request",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"TxnId": {
"description": "Order Id for the parent order that will be split. Notice that each order can only be split once.",
"type": "string",
"maxLength": 40,
"pattern": "[\\s\\S]"
},
"Orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderToSplit"
},
"title": "Orders",
"description": "Array of 2 or more child Orders to create."
}
},
"additionalProperties": false,
"required": [
"TxnId"
]
},
"OrderSplitResult": {
"title": "Order Split Result",
"type": "object",
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderResult"
},
"title": "OrdersResult"
}
},
"additionalProperties": false,
"required": [
"OrdersResult"
]
},
"OrderTags": {
"title": "Order Tags",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"Orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderTagsOfOneOrder"
},
"title": "Orders",
"description": "Array of orders"
}
},
"additionalProperties": false
},
"OrderTagsOfOneOrder": {
"title": "Order Tags Of One Order",
"type": "object",
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maxLength": 40,
"pattern": "[\\s\\S]"
},
"TagList": {
"type": "array",
"items": {
"type": "string"
},
"title": "TagList",
"description": "Order’s tags list"
}
},
"additionalProperties": false,
"required": [
"TxnId",
"TagList"
]
},
"OrderTagsResult": {
"title": "Order Tags Result",
"type": "object",
"properties": {
"TxnId": {
"description": "Unique id for each entry",
"type": "string",
"maxLength": 40
},
"Success": {
"description": "DEPRECATED: use Status (Success/Failure/NotFound) and Code instead. This field will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Per-order operation status: 'Success' if the tag operation succeeded, 'NotFound' if the order does not exist, 'Failure' for any other error.",
"type": "string",
"enum": [
"Success",
"Failure",
"NotFound"
]
},
"Code": {
"description": "DEPRECATED: under HTTP 200, the canonical per-order discriminator is Status (Success/Failure/NotFound). For specific failure detail, read Message and Description. Code will be removed in the next API major version. The error envelope (HTTP 4xx/5xx Message) keeps Code as canonical — only this per-item Code is being phased out.",
"type": "integer"
},
"Message": {
"description": "Detailed message. Typically associated with errors",
"type": "string",
"maxLength": 255
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
}
},
"additionalProperties": false,
"required": [
"TxnId",
"Success",
"Status"
]
},
"OrderTagsResults": {
"title": "Order Tags Results",
"type": "object",
"properties": {
"OrdersResult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderTagsResult"
},
"title": "OrdersResult"
}
},
"additionalProperties": false,
"required": [
"OrdersResult"
]
},
"OrderItem": {
"title": "Order Item",
"description": "Order item",
"type": "object",
"properties": {
"Name": {
"description": "Item's name",
"type": "string",
"maxLength": 255
},
"LineNumber": {
"description": "Line Number",
"type": "integer"
},
"ItemId": {
"description": "Seller item Id. This typically maps to the listing id on catalogs",
"type": "string",
"maxLength": 127
},
"ItemSKU": {
"description": "Mapped product name in Teapplix",
"type": "string",
"maxLength": 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",
"maxLength": 255
},
"Quantity": {
"description": "The quantity of this item ordered",
"type": "integer"
},
"UnitOfMeasure": {
"description": "Unit of measure for this item (e.g. EA, CS). Accepted and provided only for store types that support unit of measure",
"type": "string",
"maxLength": 40
},
"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. Accepted and provided only for store types that support this custom field",
"type": "string",
"maxLength": 255
},
"ItemCustom2": {
"description": "Item Custom2 field. Accepted and provided only for store types that support this custom field",
"type": "string",
"maxLength": 255
},
"ItemCustom3": {
"description": "Item Custom3 field. Accepted and provided only for store types that support this custom field",
"type": "string",
"maxLength": 255
},
"ItemCustom4": {
"description": "Item Custom4 field. Accepted and provided only for store types that support this custom field",
"type": "string",
"maxLength": 255
},
"Shipping Tax": {
"description": "Shipping tax amount",
"type": "number"
}
},
"additionalProperties": false
},
"OrderItemToSplit": {
"title": "Order Item To Split",
"description": "Order item",
"type": "object",
"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",
"maxLength": 255
},
"LineNumber": {
"description": "Line Number",
"type": "integer"
},
"Description": {
"description": "Item description",
"type": "string",
"maxLength": 255
},
"Quantity": {
"description": "The quantity of this item ordered",
"type": "integer"
},
"UnitOfMeasure": {
"description": "Unit of measure for this item (e.g. EA, CS). Accepted and provided only for store types that support unit of measure",
"type": "string",
"maxLength": 40
},
"Amount": {
"description": "Subtotal for this order line",
"type": "number"
},
"ItemCustom": {
"description": "Item Custom field. Accepted and provided only for store types that support this custom field",
"type": "string",
"maxLength": 255
},
"ItemCustom2": {
"description": "Item Custom2 field. Accepted and provided only for store types that support this custom field",
"type": "string",
"maxLength": 255
},
"ItemCustom3": {
"description": "Item Custom3 field. Accepted and provided only for store types that support this custom field",
"type": "string",
"maxLength": 255
},
"ItemCustom4": {
"description": "Item Custom4 field. Accepted and provided only for store types that support this custom field",
"type": "string",
"maxLength": 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",
"maxLength": 255
}
},
"additionalProperties": false
},
"Package": {
"title": "Package",
"description": "Declares packages to be shipped",
"type": "object",
"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'
FedEx:
'FEDEX_GROUND', 'FEDEX_HOME', 'FEDEX_FIRST_OVERNIGHT', 'FEDEX_PRIORITY_OVERNIGHT', 'FEDEX_STANDARD_OVERNIGHT', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_2DAY', 'FEDEX_2DAY_AM', 'FEDEX_EXPRESS_SAVER', 'FEDEX_SMART_POST', 'FEDEX_FIRST_OVERNIGHT_INTERNATIONAL', 'FEDEX_PRIORITY_OVERNIGHT_INTERNATIONAL', 'FEDEX_ECONOMY_INTERNATIONAL', 'FEDEX_GROUND_INTERNATIONAL', 'FEDEX_FREIGHT_1DAY', 'FEDEX_FREIGHT_2DAY', 'FEDEX_FREIGHT_3DAY', 'FEDEX_FREIGHT_FIRST', 'FEDEX_FREIGHT_ECONOMY', 'FEDEX_FREIGHT_PRIORITY', 'FEDEX_FREIGHT_PRIORITY_INTERNATIONAL', 'FEDEX_FREIGHT_ECONOMY_INTERNATIONAL', 'FEDEX_CONNECT_PLUS_INTERNATIONAL', 'FEDEX_PRIORITY_EXPRESS_INTERNATIONAL', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_PAK', 'FEDEX_2DAY_ONE_RATE_TUBE', 'FEDEX_2DAY_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_PAK', 'FEDEX_2DAY_AM_ONE_RATE_TUBE', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_AM_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_PAK', 'FEDEX_EXPRESS_SAVER_ONE_RATE_TUBE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_MEDIUM_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ENVELOPE', 'FEDEX_2DAY_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ENVELOPE', 'FEDEX_2DAYAM_ENVELOPE', 'FEDEX_INTLGROUNDCONSOLIDATION', 'FEDEX_STANDARDOVERNIGHT_ENVELOPE'
UPS:
'UPS_GROUND', 'UPS_NEXT_DAY_AIR', 'UPS_NEXT_DAY_AIR_EARLY_AM', 'UPS_NEXT_DAY_AIR_SAVER', 'UPS_2DAY_AIR_AM', 'UPS_2DAY_AIR', 'UPS_3DAY_SELECT', 'UPS_STANDARD', 'UPS_EXPRESS_EARLY_AM', 'UPS_EXPRESS', 'UPS_EXPRESS_SAVER', 'UPS_EXPEDITED', 'UPS_WORLDWIDE_EXPRESS_PLUS', 'UPS_WORLDWIDE_EXPRESS', 'UPS_WORLDWIDE_SAVER', 'UPS_WORLDWIDE_EXPEDITED', 'UPS_STANDARD_TO_CANADA', 'UPS_GROUND_SAVER', 'UPS_SUREPOST_LESS1LB', 'UPS_SUREPOST_LESS1LB_IRREGULAR', 'UPS_SUREPOST_MORE1LB_IRREGULAR', 'UPS_SUREPOST_MEDIA_IRREGULAR', 'UPS_SUREPOST_BPM_IRREGULAR', 'UPS_SUREPOST_1LB_OR_GREATER_MACHINABLE', 'UPS_MAILINNOVATIONS_LESS1LB', 'UPS_MAILINNOVATIONS_PARCELPOST', 'UPS_MAILINNOVATIONS_MACHINABLE', 'UPS_MAILINNOVATIONS_STANDARD_FLAT', 'UPS_MAILINNOVATIONS_BPM_PARCEL', 'UPS_MAILINNOVATIONS_BPM_FLAT', 'UPS_MAILINNOVATIONS_MEDIA', 'UPS_MAILINNOVATIONS_FIRST', 'UPS_MAILINNOVATIONS_PRIORITY', 'UPS_MAILINNOVATIONS_PRIORITY_INTERNATIONAL', 'UPS_MAILINNOVATIONS_ECONOMY_INTERNATIONAL', 'UPS_FREIGHT', 'UPS_FREIGHT_GUARANTEED', 'UPS_FREIGHT_GUARANTEED_AM', 'UPS_FREIGHT_STANDARD', 'UPS_GROUND_SIMPLE_RATE_XS', 'UPS_GROUND_SIMPLE_RATE_S', 'UPS_GROUND_SIMPLE_RATE_M', 'UPS_GROUND_SIMPLE_RATE_L', 'UPS_GROUND_SIMPLE_RATE_XL', 'UPS_2DAY_AIR_SIMPLE_RATE_XS', 'UPS_2DAY_AIR_SIMPLE_RATE_S', 'UPS_2DAY_AIR_SIMPLE_RATE_M', 'UPS_2DAY_AIR_SIMPLE_RATE_L', 'UPS_2DAY_AIR_SIMPLE_RATE_XL', 'UPS_3DAY_SELECT_SIMPLE_RATE_XS', 'UPS_3DAY_SELECT_SIMPLE_RATE_S', 'UPS_3DAY_SELECT_SIMPLE_RATE_M', 'UPS_3DAY_SELECT_SIMPLE_RATE_L', 'UPS_3DAY_SELECT_SIMPLE_RATE_XL', 'UPS_ST_CA', 'UPS_WORLDWIDE_SAVER_ASIA', 'UPS_WORLDWIDE_EXPEDITED_ASIA', 'UPS_WORLDWIDE_EXPRESS_ASIA', 'UPS_WORLDWIDE_EXPRESS_PLUS_ASIA', 'UPS_WORLDWIDE_SAVER_CANADA', 'UPS_3DAY_SELECT_CANADA', 'UPS_WORLDWIDE_EXPEDITED_CANADA', 'UPS_WORLDWIDE_EXPRESS_PLUS_CANADA', 'UPS_WORLDWIDE_EXPRESS_CANADA'
DHL Express:
'DHLE_EXPRESS_9AM', 'DHLE_ECONOMY_SELECT', 'DHLE_EXPRESS_1030AM', 'DHLE_DOMESTIC_EXPRESS', 'DHLE_EXPRESS_WORLDWIDE', 'DHLE_EUROPACK', 'DHLE_EXPRESS_1200AM', 'DHLE_EXPRESS_WORLDWIDE_DOC', 'DHLE_EXPRESS_1200AM_DOC', 'DHLE_EXPRESS_9AM_DOC', 'DHLE_EXPRESS_1030AM_DOC', 'DHLE_ECONOMYSELECT_A', 'DHLE_EXPRESS1030AM_A', 'DHLE_EXPRESS1200AM_A', 'DHLE_EXPRESS9AM_A', 'DHLE_EXPRESSENVELOPE', 'DHLE_EXPRESSENVELOPE_A', 'DHLE_EXPRESSWORLDWIDE_A'
DHL eCommerce:
'DHLEC_PARCELS_GROUND', 'DHLEC_PARCELS_GROUND_IRREGULAR', 'DHLEC_PARCELS_PLUS_GROUND', 'DHLEC_PARCELS_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCEL_GROUND_IRREGULAR', 'DHLEC_PARCEL_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED', 'DHLEC_PARCELS_EXPEDITED_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED_MAX', 'DHLEC_PARCELS_PLUS_EXPEDITED', 'DHLEC_PARCELS_PLUS_EXPEDITED_MAX', 'DHLEC_PARCEL_EXPEDITED_MAX', 'DHLEC_PARCEL_PLUS_EXPEDITED_MAX', 'DHLEC_PRIORITY', 'DHLEC_FIRST_PARCEL', 'DHLEC_FIRST_PARCEL_IRREGULAR', 'DHLEC_MARKETING_PARCEL_GROUND', 'DHLEC_MARKETING_PARCEL_GROUND_IRREGULAR', 'DHLEC_MARKETING_PARCEL_EXPEDITED', 'DHLEC_MARKETING_PARCEL_EXPEDITED_IRREGULAR', 'DHLEC_BPM_GROUND', 'DHLEC_BPM_EXPEDITED', 'DHLEC_CATALOG_BPM_GROUND', 'DHLEC_CATALOG_BPM_EXPEDITED', 'DHLEC_PACKET_STANDARD', 'DHLEC_PACKET_PRIORITY', 'DHLEC_PACKET_PLUS', 'DHLEC_PACKET_IPA', 'DHLEC_PACKET_ISAL', 'DHLEC_PARCEL_STANDARD', 'DHLEC_PARCEL_PRIORITY', 'DHLEC_PARCEL_DIRECT', 'DHLEC_PARCEL_DIRECT_EXPRESS', 'DHLEC_BUSINESS_STANDARD', 'DHLEC_BUSINESS_PRIORITY', 'DHLEC_BUSINESS_IPA', 'DHLEC_BUSINESS_ISAL', 'DHLEC_EXPEDITED_FLAT', 'DHLEC_GROUND_FLAT', 'DHLEC_PARCEL_RETURN_PLUS', 'DHLEC_PARCEL_RETURN_GROUND', 'DHLEC_PARCEL_RETURN_LIGHT', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_FORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_FORMAL', 'DHLEC_PARCEL_DIRECT_INTL', 'DHLEC_PARCEL_DIRECT_STANDARD_CA', 'DHLEC_PARCEL_DIRECT_PRIORITY_CA', 'DHLEC_PARCEL_DIRECT_MAX_CA', 'DHLEC_PARCELDIRECTEXPEDITED_RECTPARCEL'
OnTrac:
'ONTRAC_GROUND', 'ONTRAC_SUNRISE', 'ONTRAC_SUNRISE_GOLD'
Estes:
'ESTES_GUARANTEED_STANDARD', 'ESTES_GUARANTEED_ECONOMY', 'ESTES_GUARANTEED_BASIC', 'ESTES_GUARANTEED_EXCLUSIVE', 'ESTES_GUARANTEED_5PM', 'ESTES_GUARANTEED_12PM', 'ESTES_GUARANTEED_10AM', 'ESTES_STANDARD'
Purolator:
'PUROLATOR_GROUND', 'PUROLATOR_GROUND_9AM', 'PUROLATOR_GROUND_10:30AM', 'PUROLATOR_GROUND_EVENING', 'PUROLATOR_EXPRESS', 'PUROLATOR_EXPRESS_9AM', 'PUROLATOR_EXPRESS_10:30AM', 'PUROLATOR_EXPRESS_12PM', 'PUROLATOR_EXPRESS_EVENING', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE_9AM', 'PUROLATOR_EXPRESS_ENVELOPE_10:30AM', 'PUROLATOR_EXPRESS_ENVELOPE_12PM', 'PUROLATOR_EXPRESS_ENVELOPE_EVENING', 'PUROLATOR_EXPRESS_PACK', 'PUROLATOR_EXPRESS_PACK_9AM', 'PUROLATOR_EXPRESS_PACK_10:30AM', 'PUROLATOR_EXPRESS_PACK_12PM', 'PUROLATOR_EXPRESS_PACK_EVENING', 'PUROLATOR_EXPRESS_BOX', 'PUROLATOR_EXPRESS_BOX_9AM', 'PUROLATOR_EXPRESS_BOX_10:30AM', 'PUROLATOR_EXPRESS_BOX_12PM', 'PUROLATOR_EXPRESS_BOX_EVENING'
Amazon:
'AMAZON_SHIPPING_GROUND'
GoFo Express:
'GOFO_STANDARD', 'GOFO_GROUND'
UniUni:
'UNIUNI_STANDARD', 'UNIUNI_EXPRESS'
Yanwen:
'YW_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'\n ",
"type": "string"
},
"Weight": {
"$ref": "#/components/schemas/Weight"
},
"Dimensions": {
"$ref": "#/components/schemas/Dimensionsofpackage"
},
"IdenticalPackageCount": {
"description": "Count of identical packages. Currently supported only for FedEx/UPS",
"type": "integer",
"minimum": 1
},
"Type": {
"$ref": "#/components/schemas/Type",
"description": "Allows you to specify a built-in package type (integer) defined by the carrier, or a custom package you defined by name in your Teapplix account. You should specify one of 'Type' or 'Dimensions' in your input."
},
"PackageItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageItem"
},
"title": "PackageItems",
"description": "Items and their quantities inside the package. This information is required for certain marketplaces.",
"minItems": 1
},
"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"
}
},
"additionalProperties": false,
"required": [
"Method"
]
},
"ShipmentPackage": {
"title": "Shipment Package",
"description": "Declares packages to be shipped",
"type": "object",
"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'
FedEx:
'FEDEX_GROUND', 'FEDEX_HOME', 'FEDEX_FIRST_OVERNIGHT', 'FEDEX_PRIORITY_OVERNIGHT', 'FEDEX_STANDARD_OVERNIGHT', 'FEDEX_FIRST_OVERNIGHT_EXTRA_HOURS', 'FEDEX_PRIORITY_OVERNIGHT_EXTRA_HOURS', 'FEDEX_STANDARD_OVERNIGHT_EXTRA_HOURS', 'FEDEX_2DAY', 'FEDEX_2DAY_AM', 'FEDEX_EXPRESS_SAVER', 'FEDEX_SMART_POST', 'FEDEX_FIRST_OVERNIGHT_INTERNATIONAL', 'FEDEX_PRIORITY_OVERNIGHT_INTERNATIONAL', 'FEDEX_ECONOMY_INTERNATIONAL', 'FEDEX_GROUND_INTERNATIONAL', 'FEDEX_FREIGHT_1DAY', 'FEDEX_FREIGHT_2DAY', 'FEDEX_FREIGHT_3DAY', 'FEDEX_FREIGHT_FIRST', 'FEDEX_FREIGHT_ECONOMY', 'FEDEX_FREIGHT_PRIORITY', 'FEDEX_FREIGHT_PRIORITY_INTERNATIONAL', 'FEDEX_FREIGHT_ECONOMY_INTERNATIONAL', 'FEDEX_CONNECT_PLUS_INTERNATIONAL', 'FEDEX_PRIORITY_EXPRESS_INTERNATIONAL', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_PRIORITY_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_ENVELOPE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_PAK', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_TUBE', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_SMALL_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_MEDIUM_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_LARGE_BOX', 'FEDEX_STANDARD_OVERNIGHT_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_ONE_RATE_PAK', 'FEDEX_2DAY_ONE_RATE_TUBE', 'FEDEX_2DAY_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_ENVELOPE', 'FEDEX_2DAY_AM_ONE_RATE_PAK', 'FEDEX_2DAY_AM_ONE_RATE_TUBE', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_SMALL_BOX', 'FEDEX_2DAY_AM_ONE_RATE_MEDIUM_BOX', 'FEDEX_2DAY_AM_ONE_RATE_LARGE_BOX', 'FEDEX_2DAY_AM_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_PAK', 'FEDEX_EXPRESS_SAVER_ONE_RATE_TUBE', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_SMALL_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_MEDIUM_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_LARGE_BOX', 'FEDEX_EXPRESS_SAVER_ONE_RATE_EXTRA_LARGE_BOX', 'FEDEX_FIRST_OVERNIGHT_ENVELOPE', 'FEDEX_PRIORITY_OVERNIGHT_ENVELOPE', 'FEDEX_2DAY_ENVELOPE', 'FEDEX_EXPRESS_SAVER_ENVELOPE', 'FEDEX_2DAYAM_ENVELOPE', 'FEDEX_INTLGROUNDCONSOLIDATION', 'FEDEX_STANDARDOVERNIGHT_ENVELOPE'
UPS:
'UPS_GROUND', 'UPS_NEXT_DAY_AIR', 'UPS_NEXT_DAY_AIR_EARLY_AM', 'UPS_NEXT_DAY_AIR_SAVER', 'UPS_2DAY_AIR_AM', 'UPS_2DAY_AIR', 'UPS_3DAY_SELECT', 'UPS_STANDARD', 'UPS_EXPRESS_EARLY_AM', 'UPS_EXPRESS', 'UPS_EXPRESS_SAVER', 'UPS_EXPEDITED', 'UPS_WORLDWIDE_EXPRESS_PLUS', 'UPS_WORLDWIDE_EXPRESS', 'UPS_WORLDWIDE_SAVER', 'UPS_WORLDWIDE_EXPEDITED', 'UPS_STANDARD_TO_CANADA', 'UPS_GROUND_SAVER', 'UPS_SUREPOST_LESS1LB', 'UPS_SUREPOST_LESS1LB_IRREGULAR', 'UPS_SUREPOST_MORE1LB_IRREGULAR', 'UPS_SUREPOST_MEDIA_IRREGULAR', 'UPS_SUREPOST_BPM_IRREGULAR', 'UPS_SUREPOST_1LB_OR_GREATER_MACHINABLE', 'UPS_MAILINNOVATIONS_LESS1LB', 'UPS_MAILINNOVATIONS_PARCELPOST', 'UPS_MAILINNOVATIONS_MACHINABLE', 'UPS_MAILINNOVATIONS_STANDARD_FLAT', 'UPS_MAILINNOVATIONS_BPM_PARCEL', 'UPS_MAILINNOVATIONS_BPM_FLAT', 'UPS_MAILINNOVATIONS_MEDIA', 'UPS_MAILINNOVATIONS_FIRST', 'UPS_MAILINNOVATIONS_PRIORITY', 'UPS_MAILINNOVATIONS_PRIORITY_INTERNATIONAL', 'UPS_MAILINNOVATIONS_ECONOMY_INTERNATIONAL', 'UPS_FREIGHT', 'UPS_FREIGHT_GUARANTEED', 'UPS_FREIGHT_GUARANTEED_AM', 'UPS_FREIGHT_STANDARD', 'UPS_GROUND_SIMPLE_RATE_XS', 'UPS_GROUND_SIMPLE_RATE_S', 'UPS_GROUND_SIMPLE_RATE_M', 'UPS_GROUND_SIMPLE_RATE_L', 'UPS_GROUND_SIMPLE_RATE_XL', 'UPS_2DAY_AIR_SIMPLE_RATE_XS', 'UPS_2DAY_AIR_SIMPLE_RATE_S', 'UPS_2DAY_AIR_SIMPLE_RATE_M', 'UPS_2DAY_AIR_SIMPLE_RATE_L', 'UPS_2DAY_AIR_SIMPLE_RATE_XL', 'UPS_3DAY_SELECT_SIMPLE_RATE_XS', 'UPS_3DAY_SELECT_SIMPLE_RATE_S', 'UPS_3DAY_SELECT_SIMPLE_RATE_M', 'UPS_3DAY_SELECT_SIMPLE_RATE_L', 'UPS_3DAY_SELECT_SIMPLE_RATE_XL', 'UPS_ST_CA', 'UPS_WORLDWIDE_SAVER_ASIA', 'UPS_WORLDWIDE_EXPEDITED_ASIA', 'UPS_WORLDWIDE_EXPRESS_ASIA', 'UPS_WORLDWIDE_EXPRESS_PLUS_ASIA', 'UPS_WORLDWIDE_SAVER_CANADA', 'UPS_3DAY_SELECT_CANADA', 'UPS_WORLDWIDE_EXPEDITED_CANADA', 'UPS_WORLDWIDE_EXPRESS_PLUS_CANADA', 'UPS_WORLDWIDE_EXPRESS_CANADA'
DHL Express:
'DHLE_EXPRESS_9AM', 'DHLE_ECONOMY_SELECT', 'DHLE_EXPRESS_1030AM', 'DHLE_DOMESTIC_EXPRESS', 'DHLE_EXPRESS_WORLDWIDE', 'DHLE_EUROPACK', 'DHLE_EXPRESS_1200AM', 'DHLE_EXPRESS_WORLDWIDE_DOC', 'DHLE_EXPRESS_1200AM_DOC', 'DHLE_EXPRESS_9AM_DOC', 'DHLE_EXPRESS_1030AM_DOC', 'DHLE_ECONOMYSELECT_A', 'DHLE_EXPRESS1030AM_A', 'DHLE_EXPRESS1200AM_A', 'DHLE_EXPRESS9AM_A', 'DHLE_EXPRESSENVELOPE', 'DHLE_EXPRESSENVELOPE_A', 'DHLE_EXPRESSWORLDWIDE_A'
DHL eCommerce:
'DHLEC_PARCELS_GROUND', 'DHLEC_PARCELS_GROUND_IRREGULAR', 'DHLEC_PARCELS_PLUS_GROUND', 'DHLEC_PARCELS_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCEL_GROUND_IRREGULAR', 'DHLEC_PARCEL_PLUS_GROUND_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED', 'DHLEC_PARCELS_EXPEDITED_IRREGULAR', 'DHLEC_PARCELS_EXPEDITED_MAX', 'DHLEC_PARCELS_PLUS_EXPEDITED', 'DHLEC_PARCELS_PLUS_EXPEDITED_MAX', 'DHLEC_PARCEL_EXPEDITED_MAX', 'DHLEC_PARCEL_PLUS_EXPEDITED_MAX', 'DHLEC_PRIORITY', 'DHLEC_FIRST_PARCEL', 'DHLEC_FIRST_PARCEL_IRREGULAR', 'DHLEC_MARKETING_PARCEL_GROUND', 'DHLEC_MARKETING_PARCEL_GROUND_IRREGULAR', 'DHLEC_MARKETING_PARCEL_EXPEDITED', 'DHLEC_MARKETING_PARCEL_EXPEDITED_IRREGULAR', 'DHLEC_BPM_GROUND', 'DHLEC_BPM_EXPEDITED', 'DHLEC_CATALOG_BPM_GROUND', 'DHLEC_CATALOG_BPM_EXPEDITED', 'DHLEC_PACKET_STANDARD', 'DHLEC_PACKET_PRIORITY', 'DHLEC_PACKET_PLUS', 'DHLEC_PACKET_IPA', 'DHLEC_PACKET_ISAL', 'DHLEC_PARCEL_STANDARD', 'DHLEC_PARCEL_PRIORITY', 'DHLEC_PARCEL_DIRECT', 'DHLEC_PARCEL_DIRECT_EXPRESS', 'DHLEC_BUSINESS_STANDARD', 'DHLEC_BUSINESS_PRIORITY', 'DHLEC_BUSINESS_IPA', 'DHLEC_BUSINESS_ISAL', 'DHLEC_EXPEDITED_FLAT', 'DHLEC_GROUND_FLAT', 'DHLEC_PARCEL_RETURN_PLUS', 'DHLEC_PARCEL_RETURN_GROUND', 'DHLEC_PARCEL_RETURN_LIGHT', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_INFORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_PRIORITY_FORMAL', 'DHLEC_PARCEL_DIRECT_INBOUND_STANDARD_FORMAL', 'DHLEC_PARCEL_DIRECT_INTL', 'DHLEC_PARCEL_DIRECT_STANDARD_CA', 'DHLEC_PARCEL_DIRECT_PRIORITY_CA', 'DHLEC_PARCEL_DIRECT_MAX_CA', 'DHLEC_PARCELDIRECTEXPEDITED_RECTPARCEL'
OnTrac:
'ONTRAC_GROUND', 'ONTRAC_SUNRISE', 'ONTRAC_SUNRISE_GOLD'
Estes:
'ESTES_GUARANTEED_STANDARD', 'ESTES_GUARANTEED_ECONOMY', 'ESTES_GUARANTEED_BASIC', 'ESTES_GUARANTEED_EXCLUSIVE', 'ESTES_GUARANTEED_5PM', 'ESTES_GUARANTEED_12PM', 'ESTES_GUARANTEED_10AM', 'ESTES_STANDARD'
Purolator:
'PUROLATOR_GROUND', 'PUROLATOR_GROUND_9AM', 'PUROLATOR_GROUND_10:30AM', 'PUROLATOR_GROUND_EVENING', 'PUROLATOR_EXPRESS', 'PUROLATOR_EXPRESS_9AM', 'PUROLATOR_EXPRESS_10:30AM', 'PUROLATOR_EXPRESS_12PM', 'PUROLATOR_EXPRESS_EVENING', 'PUROLATOR_EXPRESS_ENVELOPE', 'PUROLATOR_EXPRESS_ENVELOPE_9AM', 'PUROLATOR_EXPRESS_ENVELOPE_10:30AM', 'PUROLATOR_EXPRESS_ENVELOPE_12PM', 'PUROLATOR_EXPRESS_ENVELOPE_EVENING', 'PUROLATOR_EXPRESS_PACK', 'PUROLATOR_EXPRESS_PACK_9AM', 'PUROLATOR_EXPRESS_PACK_10:30AM', 'PUROLATOR_EXPRESS_PACK_12PM', 'PUROLATOR_EXPRESS_PACK_EVENING', 'PUROLATOR_EXPRESS_BOX', 'PUROLATOR_EXPRESS_BOX_9AM', 'PUROLATOR_EXPRESS_BOX_10:30AM', 'PUROLATOR_EXPRESS_BOX_12PM', 'PUROLATOR_EXPRESS_BOX_EVENING'
Amazon:
'AMAZON_SHIPPING_GROUND'
GoFo Express:
'GOFO_STANDARD', 'GOFO_GROUND'
UniUni:
'UNIUNI_STANDARD', 'UNIUNI_EXPRESS'
Yanwen:
'YW_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'\n ",
"type": "string"
},
"Weight": {
"$ref": "#/components/schemas/Weight"
},
"Dimensions": {
"$ref": "#/components/schemas/Dimensionsofpackage"
},
"IdenticalPackageCount": {
"description": "Count of identical packages. Currently supported only for FedEx/UPS",
"type": "integer",
"minimum": 1
},
"Type": {
"$ref": "#/components/schemas/Type",
"description": "Allows you to specify a built-in package type (integer) defined by the carrier, or a custom package you defined by name in your Teapplix account. You should specify one of 'Type' or 'Dimensions' in your input."
},
"PackageItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageItem"
},
"title": "PackageItems",
"description": "Items and their quantities inside the package. This information is required for certain marketplaces.",
"minItems": 1
},
"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": "#/components/schemas/TrackingInfo"
}
},
"additionalProperties": false
},
"ProductVariationAttribute": {
"title": "Product Variation Attribute",
"description": "Product Feature",
"type": "object",
"properties": {
"AttributeName": {
"description": "Attribute Name",
"type": "string"
},
"AttributeValue": {
"description": "Attribute Value",
"type": "string"
},
"SwatchImage": {
"$ref": "#/components/schemas/ProductImage"
}
},
"additionalProperties": true
},
"ProductFeature": {
"title": "Product Feature",
"description": "Product Feature",
"type": "object",
"properties": {
"AttributeValue": {
"description": "Attribute Value",
"type": "string"
},
"AttributeValueSeq": {
"type": "integer"
}
},
"additionalProperties": true
},
"ProductResults": {
"title": "Product Results",
"description": "Product Operation result",
"type": "object",
"properties": {
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOperationResult"
},
"title": "Products",
"description": "Product create details"
}
},
"additionalProperties": false,
"required": [
"Products"
]
},
"InventoryQuantityResult": {
"title": "Inventory Quantity Result",
"description": "Product Operation result",
"type": "object",
"properties": {
"ProductQuantities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductQuantity"
},
"title": "ProductQuantities",
"description": "Product quantities data"
}
},
"additionalProperties": false,
"required": [
"ProductQuantities"
]
},
"ProductQuantity": {
"title": "Product Quantity",
"description": "Product Quantity",
"type": "object",
"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"
}
},
"additionalProperties": true
},
"InventoryQuantity": {
"title": "Inventory Quantity",
"description": "Product Quantity",
"type": "object",
"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"
}
},
"additionalProperties": true,
"required": [
"PostDate",
"PostType",
"ItemName",
"Quantity"
]
},
"ProductVariation": {
"title": "Product Variation",
"description": "Declares product",
"type": "object",
"properties": {
"ItemName": {
"type": "string",
"pattern": "[\\s\\S]"
},
"Asin": {
"type": "string"
},
"Upc": {
"type": "string"
},
"MainImage": {
"$ref": "#/components/schemas/ProductMainImage"
},
"AdditionalImages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductImage"
},
"title": "AdditionalImages",
"description": "Additional Images"
},
"DefaultPrice": {
"type": "number"
},
"Attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductVariationAttribute"
},
"title": "Attributes",
"description": "Variation Attributes"
}
},
"additionalProperties": false,
"required": [
"ItemName"
]
},
"ProductVariationResult": {
"title": "Product Variation Result",
"description": "Product Variations for selected ParentItemName",
"type": "object",
"properties": {
"ProductVariations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductVariation"
},
"title": "ProductVariations",
"description": "Product variations"
}
},
"additionalProperties": false,
"required": [
"ProductVariations"
]
},
"ProductVariationsToAdd": {
"title": "Product Variations To Add",
"description": "Used to insert Product Variations for ParentItemName",
"type": "object",
"properties": {
"ParentItemName": {
"description": "Parent Item Name of Product Variations inserted",
"type": "string"
},
"Variations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductVariation"
},
"title": "Variations",
"description": "Product Variations to be inserted or updated. If you call method again, all variations will be overwritten"
}
},
"additionalProperties": false,
"required": [
"ParentItemName",
"Variations"
]
},
"ProductsToSave": {
"title": "Products To Save",
"description": "Used to update Inventory Products",
"type": "object",
"properties": {
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
},
"title": "Products",
"description": "Products to be updated"
}
},
"additionalProperties": false,
"required": [
"Products"
]
},
"ProductsToDelete": {
"title": "Products To Delete",
"description": "Used to delete Inventory Products",
"type": "object",
"properties": {
"Products": {
"type": "array",
"items": {
"type": "string"
},
"title": "Products",
"description": "Products SKU to be deleted"
}
},
"additionalProperties": false,
"required": [
"Products"
]
},
"PurchaseLabelRequest": {
"title": "Purchase Label Request",
"description": "Represents single label purchase request",
"type": "object",
"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",
"pattern": "^\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$"
},
"From": {
"$ref": "#/components/schemas/From"
},
"To": {
"$ref": "#/components/schemas/To"
},
"Packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Package"
},
"title": "Packages",
"description": "Packages to be sent",
"minItems": 1
},
"Options": {
"$ref": "#/components/schemas/OrderShippingOptions"
},
"CustomsDeclaration": {
"$ref": "#/components/schemas/Customsdeclaration"
},
"ImageFormat": {
"$ref": "#/components/schemas/ImageFormat"
},
"IsReturn": {
"description": "Should be set if return label is requested",
"type": "boolean"
},
"Provider": {
"description": "Provider if specified will force usage of label from MARKETPLACE vs NATIVE carrier accounts linked in Teapplix.",
"type": "string",
"enum": [
"NATIVE",
"MARKETPLACE",
"TEAPPLIX",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"RATESHOP"
]
}
},
"additionalProperties": false,
"required": [
"ClientRequestId",
"From",
"To",
"Packages"
]
},
"PurchaseLabelForOrderRequest": {
"title": "Purchase Label For Order Request",
"description": "Represents single label purchase request",
"type": "object",
"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",
"pattern": "^\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$"
},
"From": {
"$ref": "#/components/schemas/From"
},
"Packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Package"
},
"title": "Packages",
"description": "Packages to be sent. First package in sequence is main package, others are extra packages. Minimum 1 item required.",
"minItems": 1
},
"Options": {
"$ref": "#/components/schemas/OrderShippingOptions"
},
"CustomsDeclaration": {
"$ref": "#/components/schemas/Customsdeclaration"
},
"ImageFormat": {
"$ref": "#/components/schemas/ImageFormat"
},
"IsReturn": {
"description": "DEPRECATED. If an order is a return order, we automatically print a return label.",
"type": "boolean"
},
"Provider": {
"description": "Provider if specified will force usage of label from MARKETPLACE vs NATIVE carrier accounts linked in Teapplix.",
"type": "string",
"enum": [
"NATIVE",
"MARKETPLACE",
"TEAPPLIX",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"RATESHOP"
]
}
},
"additionalProperties": false,
"required": [
"TxnId",
"From",
"Packages"
]
},
"PurchaseLabelResult": {
"title": "Purchase Label Result",
"description": "Represents purchase label result",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Operation status: 'Purchased' on success.",
"type": "string",
"enum": [
"Purchased"
]
},
"Message": {
"description": "Human-readable result message.",
"type": "string"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Detailed description"
},
"ClientRequestId": {
"description": "This is the same ClientRequestId that caller passed in, returned to the caller.",
"type": "string"
},
"TrackingInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingInfo"
},
"title": "TrackingInfo",
"description": "Array with tracking info for generated labels"
},
"LabelData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
},
"title": "LabelData",
"description": "Array with base64 encoded data of label image, in the requested format."
},
"DocumentsData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
},
"title": "DocumentsData",
"description": "Array with document URL or contents"
},
"PostageAmount": {
"$ref": "#/components/schemas/Amount"
},
"ASN": {
"description": "DEPRECATED! ASN Number for Walmart DSV ship to store orders",
"type": "string"
},
"Provider": {
"description": "Provider if specified will force usage of label from MARKETPLACE vs NATIVE carrier accounts linked in Teapplix.",
"type": "string",
"enum": [
"NATIVE",
"MARKETPLACE",
"TEAPPLIX",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"RATESHOP"
]
}
},
"additionalProperties": false,
"required": [
"Status"
]
},
"ShipmentData": {
"title": "Shipment Data",
"type": "object",
"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": "#/components/schemas/Weight",
"description": "Shipping weight"
},
"Dimensions": {
"$ref": "#/components/schemas/Dimensionsofpackage"
},
"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": "#/components/schemas/TrackingInfo",
"description": "Tracking info. Required on input if you specify ShipDate"
},
"LabelData": {
"$ref": "#/components/schemas/Document",
"description": "Document details. Optional."
},
"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": "#/components/schemas/Amount",
"description": "Shipping cost"
},
"PostageAccount": {
"description": "Postage Account.",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"TxnId"
]
},
"ShipmentQueryResult": {
"title": "Shipment Query Result",
"description": "Shipment details",
"type": "object",
"properties": {
"Items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentData"
},
"title": "Items",
"description": "Shipments details of orders"
}
},
"additionalProperties": false,
"required": [
"Items"
]
},
"ShippingRatesRequest": {
"title": "Shipping Rates Request",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"ShipDate": {
"type": "string",
"pattern": "^\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$"
},
"From": {
"$ref": "#/components/schemas/From",
"description": "Sender address or shipping profile id"
},
"To": {
"$ref": "#/components/schemas/To"
},
"Packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Package"
},
"title": "Packages",
"description": "Packages to be sent",
"minItems": 1
},
"Options": {
"$ref": "#/components/schemas/OrderShippingOptions",
"description": "Shipment options"
},
"CustomsDeclaration": {
"$ref": "#/components/schemas/Customsdeclaration",
"description": "Customs declaration"
},
"Provider": {
"description": "Provider if specified will force usage of label from MARKETPLACE vs NATIVE carrier accounts linked in Teapplix.",
"type": "string",
"enum": [
"NATIVE",
"MARKETPLACE",
"TEAPPLIX",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"RATESHOP"
]
}
},
"additionalProperties": false,
"required": [
"From",
"To",
"Packages"
]
},
"ShippingRatesForOrderRequest": {
"title": "Shipping Rates For Order Request",
"description": "'APIToken' header should be included in each request",
"type": "object",
"properties": {
"TxnId": {
"type": "string"
},
"ShipDate": {
"type": "string",
"pattern": "^\\d\\d\\d\\d-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$"
},
"From": {
"$ref": "#/components/schemas/From",
"description": "Sender address or shipping profile id"
},
"Packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Package"
},
"title": "Packages",
"description": "Packages to be sent",
"minItems": 1
},
"Options": {
"$ref": "#/components/schemas/OrderShippingOptions",
"description": "Shipment options"
},
"CustomsDeclaration": {
"$ref": "#/components/schemas/Customsdeclaration",
"description": "Customs declaration"
},
"Provider": {
"description": "Provider if specified will force usage of label from MARKETPLACE vs NATIVE carrier accounts linked in Teapplix.",
"type": "string",
"enum": [
"NATIVE",
"MARKETPLACE",
"TEAPPLIX",
"DHL",
"DHL_EXPRESS",
"FEDEX",
"UPS",
"ONTRAC",
"AMAZON_BUY_SHIPPING",
"ENDICIA",
"RATESHOP"
]
}
},
"additionalProperties": false,
"required": [
"TxnId",
"From",
"Packages"
]
},
"Weight": {
"title": "Weight",
"description": "Weight of a package or an item.",
"type": "object",
"properties": {
"Value": {
"description": "Absolute weight value",
"type": "number"
},
"Unit": {
"description": "Unit",
"type": "string",
"enum": [
"OZ",
"LB",
"GR",
"KG"
]
}
},
"additionalProperties": false,
"required": [
"Value",
"Unit"
]
},
"AddressValidationResult": {
"title": "Address Validation Result",
"type": "object",
"properties": {
"Success": {
"description": "DEPRECATED: always true on this envelope. Read Status instead. Will be removed in the next API major version.",
"type": "boolean"
},
"Status": {
"description": "Operation status. Both Validated Changed and Validated Not Changed Status are considered good addresses. Not Changed return means address has hard failed and impossible to fix. If the validation system itself has failed we will be returning http status codes 4xx or 5xx with different return schema.",
"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"
},
"Description": {
"type": "array",
"items": {
"type": "string"
},
"title": "Description",
"description": "Not returned by address validation"
},
"Address": {
"$ref": "#/components/schemas/Address"
},
"Residential": {
"description": "Address residential indicator, if available",
"type": "boolean"
},
"DeliveryPoint": {
"description": "The delivery point, if available",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"Status",
"Address"
]
},
"TrackRequest": {
"title": "Track Request",
"type": "object",
"properties": {
"Shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Track"
},
"title": "Shipments"
}
},
"additionalProperties": false
},
"FreightNotificationRecipient": {
"type": "object",
"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"
}
},
"additionalProperties": false,
"title": "Freight Notification Recipient"
},
"ShippingZoneRoute": {
"type": "object",
"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": "#/components/schemas/Error"
}
},
"additionalProperties": false,
"required": [
"FromZip",
"ToZip"
],
"title": "Shipping Zone Route"
}
}
},
"x-tagGroups": [
{
"name": "Orders",
"tags": [
"OrderNotification",
"OrderTags",
"OrderShipOptions",
"MarkReview",
"SplitOrder",
"SplitOrderCont",
"ApplyPackingPlan"
]
},
{
"name": "Products and inventory",
"tags": [
"Product",
"ProductCombo",
"ProductVariation",
"ProductXref",
"ProductQuantity",
"Listing"
]
},
{
"name": "Rates and labels",
"tags": [
"Rates",
"RatesForOrder",
"PurchaseLabel",
"PurchaseLabelForOrder",
"CancelLabel",
"DownloadLabel",
"ShipMethod",
"Zones",
"AddressValidation",
"PickupForOrder"
]
},
{
"name": "Shipments and tracking",
"tags": [
"Shipment",
"Track",
"DeliveryHistory",
"Manifest"
]
},
{
"name": "Documents and reports",
"tags": [
"PackingListForOrder",
"SSCCLabelForOrder",
"Report"
]
},
{
"name": "Account setup",
"tags": [
"ShippingProfile",
"Queue",
"Warehouse",
"Tag"
]
},
{
"name": "Partners and 3PL",
"tags": [
"Submit3PL",
"VendorScan",
"PSObtainToken",
"DeferredAction"
]
}
]
}