콘텐츠로 이동
TeapplixTeapplixTeapplix Help

Warehouse — Inventory

이 콘텐츠는 아직 번역되지 않았습니다.

Use this API to obtain a list of warehouses defined in your Teapplix account:

The query parameter WarehouseId is optional. If you supply it, API will return array with a single Warehouse. If you do not supply WarehouseId, then all Warehouses defined in the Teapplix account will be returned.

https://api.teapplix.com/api2/Warehouse Explorer

GET Request

Query parameters

PropertyTypeDescriptionConstraints
WarehouseId integer Filter by warehouse ID (exact match). Use this to look up a specific warehouse by its numeric ID.
WarehouseType string Filter by warehouse type (WarehouseType enum). Example: GENERIC, FBA, DROPSHIP. Returns all warehouses of that type.
WarehouseName string Case-insensitive substring search on warehouse name. Returns all warehouses whose name contains this string.

GET Response - 200

Warehouse Get Response

Response to GET /Warehouse. Contains a list of warehouses matching the query filters.

PropertyTypeDescriptionConstraints
Warehouses Warehouse[] List of warehouses matching the query filters. Empty array if none match. Required

Warehouse

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.

PropertyTypeDescriptionConstraints
WarehouseId integer 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.
WarehouseName string 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).
WarehouseType string 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. One of: 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 string 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. One of: CALCULATED, STATIC, FIXED
3PLKey string 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.
3PLWarehouseCode string 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.
CountryCode string ISO country code for the 3PL warehouse location. Optional. Stored in the account's selected warehouses configuration.
ReconcileForWarehouseId integer Only for WarehouseType RECONCILE. When provided, the existing warehouse with this ID will have its paired reconcile warehouse set to the newly created warehouse.

GET Response - 400

Message

PropertyTypeDescriptionConstraints
Success boolean Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. Required
Code integer Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
Message string Message typically associated with errors
Description string[] Detailed description

GET Response - 401

Message

PropertyTypeDescriptionConstraints
Success boolean Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. Required
Code integer Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
Message string Message typically associated with errors
Description string[] Detailed description

GET Response - 500

Message

PropertyTypeDescriptionConstraints
Success boolean Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. Required
Code integer Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115
Message string Message typically associated with errors
Description string[] Detailed description
Test Request