跳转到内容
TeapplixTeapplixTeapplix Help

Listing

此内容尚不支持你的语言。

Listing API allows you to download listing data and update listing data in Teapplix:

  • GET - based on certain criteria, download listing object from your Teapplix account. In the below list of criteria, at least one must be provided. Otherwise error will be returned. Notice that this GET query has no cursor capability and only return max 5000 results.

    1. Channel — which marketplace or shopping cart’s listing we want
    2. SellerId — if you linked multiple accounts from the same channel into Teapplix, SellerId typically names one of those accounts. In the case of eBay, Amazon, this will be the seller id or merchant id. In the case of other channels, this typically is the “store key” assigned in Teapplix when you linked the channel account.
    3. SellerSKU — Seller SKU you assigned on the Marketplace or Shopping Cart.
    4. TeapplixSKU — Mapped SKU in Teapplix. If you did not do any mapping, this is the same as SellerSKU
    5. WarehouseId — which warehouse id the listing is assigned to. Specifying this parameter will fetch only listings assigned to that particular warehouse id. This is an integer.

  • PUT - based on provided key, update certain fields for listing object in your Teapplix account.

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

GET Request

Query parameters

PropertyTypeDescriptionConstraints
StoreType string Listing marketplace. Amazon = 'amazon'; Amazon Vendor = 'amzv'; eBay = 'ebay'; cart marketplaces use their own store type code.
SellerId string For amazon/amzv: Amazon merchant ID. For ebay: ebay_api.username. Ignored for cart marketplaces.
SellerSKU string Seller SKU
TeapplixSKU string Teapplix SKU
WarehouseId integer Warehouse ID
ListingType string Listing Type, only available if StoreType is 'amazon' or 'amzv'. Possible values: 'DEFAULT', 'AMAZON_NA'.

GET Response - 200

Listings result

PropertyTypeDescriptionConstraints
Listings Listing[] Required

Listing

PropertyTypeDescriptionConstraints
StoreType string Store Listing is From One of: 3dcart, 3plcentral, Manual, RMA, aafes, aafes2, academysports, acehardware, acenda, amazon, amzv, ashley, ashley2, barnesnoble, basspro, belk, belkb2b, bestbuy, bestbuy2bca, bigcommerce, bonanza, ca2, campwrld, chewy, commercehub, corecommerce, costco, costcoca, costcojp, cratejoy, creloaded, cscart, cymax, doitbest, dsco, ebay, essentialhub, etsy, fabfitfun, fleetfarm, generic, goflow, googlec, googleexpress, groupongoods, hdpro, hdsupply, hdsupplyso, homedepot, homedepot2b, homedepotca, homedepotso, homehardware, houzz, hsn, jcpenney, kohls, lampsplus, lowes, lowes2b, lowesca, lowesm, macys, magento, magento2, menards, michaels, mirakl, newegg, neweggApi, neweggb2b, nfm, northerntool, opencart, opensky, orgill, oscommerce, paypal, pcrs, petco, petsmart, pinnacle, prestashop, qbi, qbo, qbr, quill, qvc, rakuten, reverb, ruegilt, samsclub, sears, shein, shipstation, shopify, sparkpay, squarespace, staplesadvca, staplesca, staplesca2b, supplieroasis, target, target2b, temu, tiktok, tongtool, tophatter, tractorsupply, tractorsupply2b, volusion, walmart, walmartdsv, walmartpo, wayfair, wish, woocommerce, wsonoma, xcart, xcart5, yahoo, zencart, zoro
StoreKey string Unique id for each store type, filled for StoreType other than ebay or amazon Pattern: (^$)|[a-zA-Z0-9]{3}
VSAccountID string
SellerId string For StoreType ebay or amazon only
ListingTitle string Listing Title Max-Length: 255
TeapplixSKU string Teapplix SKU
SellerSKU string Seller SKU
ListingId string Listing Id
ImageUrl string Image Url
ListingType string Listing Type
QtyOnMarketplace integer Quantity On Marketplace
QtyAvailable integer Quantity Available
ChannelWarehouseId string Channel Warehouse Id
WarehouseId integer Warehouse Id
altListingId string Alternative listing id
UPC string UPC
Open integer Product Open flag
handlingTime string Handling Time
brand string Brand
manufacturer string Manufacturer
asin string ASIN

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