Inventory Buffer Search

GET{{api_url}}/shop/inventory/buffer/search?search_term=iphone

Lists the Inventory Buffers on the account. An Inventory Buffer holds back a number of units of a SKU from the quantity InfiPlex sends to your sales channels. With a buffer of 4 and 10 on hand, every channel is told 6. The buffer's excluded marketplaces are the exception: they receive the actual quantity, which makes them the channels allowed to sell the last units. Sellers pick the excluded marketplace by fees, sell-through speed, or oversell penalties. Exclusions and buffer are independent: a buffer with no exclusions holds units back everywhere, and excluded_mps is null in that case.

A connection's set-to-zero threshold fires before the buffer. If the threshold sends 0, the buffer is skipped for that SKU and channel; otherwise the buffer is applied. Buffers are managed at Inventory > Inventory Buffer in the OMS or by CSV upload.

Parameters

All parameters are optional.

Parameter	Type	Description
`search_term`	string	Partial match against the SKU.
`just_count`	integer	Set to `1` to return only a count of matching buffers instead of the buffers themselves.
`limit`	integer	Maximum number of buffers to return.
`limit_start`	integer	Number of leading results to skip, for paging. With `limit` 100 and `limit_start` 100 you get buffers 101 through 200.

Examples

All buffers:

{{api_url}}/shop/inventory/buffer/search

Buffers on SKUs containing "iphone":

{{api_url}}/shop/inventory/buffer/search?search_term=iphone

How many SKUs have a buffer:

{{api_url}}/shop/inventory/buffer/search?just_count=1

Response

A JSON array, one object per buffered SKU:

[
    {
        "shop_inventory_buffer_id": "2",
        "shop_inventory_buffer_siteareaid": "16",
        "sku": "iPhoneX",
        "buffer_amount": "4",
        "excluded_mps": [
            {
                "shop_inventory_buffer_marketplace_exclude_id": "4",
                "sibme_shop_inventory_buffer_id": "2",
                "mp_ident": "azc"
            },
            {
                "shop_inventory_buffer_marketplace_exclude_id": "3",
                "sibme_shop_inventory_buffer_id": "2",
                "mp_ident": "azu"
            }
        ]
    },
    {
        "shop_inventory_buffer_id": "5",
        "shop_inventory_buffer_siteareaid": "16",
        "sku": "ExcludeNone",
        "buffer_amount": "2",
        "excluded_mps": null
    }
]

Field	Type	Description
`shop_inventory_buffer_id`	string	The buffer id. Pass this to Inventory Buffer Get.
`shop_inventory_buffer_siteareaid`	string	The InfiPlex site area the buffer belongs to.
`sku`	string	The SKU the buffer applies to. One buffer per SKU.
`buffer_amount`	string	Units held back from the quantity sent to every channel not listed in `excluded_mps`.
`excluded_mps`	array or null	Marketplaces that receive the actual quantity with no buffer applied. `null` when the buffer applies everywhere.
`excluded_mps[].shop_inventory_buffer_marketplace_exclude_id`	string	Id of this exclusion row.
`excluded_mps[].sibme_shop_inventory_buffer_id`	string	The buffer id, repeated.
`excluded_mps[].mp_ident`	string	The marketplace identifier. Full list below.

In the example above, iPhoneX with 10 on hand is sent as 6 to every channel except Amazon.com and Amazon.ca, which are sent 10.

Marketplace identifiers

Values mp_ident can hold:

Identifier	Marketplace	Identifier	Marketplace
`aep`	AliExpress	`mko`	Marketo
`azu`	Amazon.com	`mlb`	Mercado Libre
`azc`	Amazon.ca	`mtq`	Method QB
`azt`	Amazon Today	`mic`	Michaels
`avc`	Amazon Vendor Central	`msd`	MS Dynamics
`avr`	Amazon Vendor Central Retail	`nst`	NetSuite
`adn`	AspDotNet	`neu`	Newegg
`auz`	AutoZone	`nvf`	Newegg VF
`bmk`	Back Market	`odp`	Office Depot
`bmb`	Back Market Business	`osk`	Open Sky
`byd`	Backyard.com	`ovs`	Overstock
`bck`	Badcock	`pdn`	PageDNA
`bbb`	Bed Bath & Beyond	`phs`	Phone House Spain
`beb`	Best Buy	`qbs`	Quickbase
`bgc`	BigCommerce	`qvc`	QVC
`bst`	Bluestem	`rak`	Rakuten
`byn`	Blue Yonder	`rkf`	Rakuten.fr
`bza`	Bonanza	`reb`	Reebelo
`brs`	Bright Sites	`rde`	Refurbed.de
`brt`	Brown Trout	`rtg`	Rooms To Go
`bcm`	Build.com	`rdu`	Rue du
`cdi`	Cdiscount	`rll`	Rue La La
`cad`	Channel Advisor	`rpm`	RPMWare
`cgt`	Channel Gate	`sgw`	Sage World
`cin`	Cin7	`sam`	Sams Club
`cos`	Costco	`srs`	Sears
`drt`	Darty	`scd`	Sellercloud
`dep`	Deposco	`shs`	ShipStation
`dsc`	Dsco	`shp`	Shopify
`esh`	EasyShip	`shq`	ShopHQ
`eby`	eBay	`skv`	Sku Vault
`ecw`	Ecwid	`sqs`	Squarespace
`epi`	Epicor	`squ`	Square Up
`ets`	Etsy	`swp`	Swappa
`fai`	Faire	`tga`	Tanga
`far`	FarApp	`tgt`	Target
`fee`	Feedonomics	`tgp`	Target+
`fnc`	Fnac	`tgs`	Target Stores
`fii`	Finale Inventory	`twc`	Teamwork Commerce
`gos`	Google Shopping	`tem`	Temu
`grp`	Groupon	`ttk`	TikTok
`gpe`	Groupon EDI	`trs`	Tire Shop
`hds`	HD Supply	`tsu`	Tractor Supply
`hol`	Hollar	`ung`	Until Gone
`hod`	Home Depot	`wal`	Walmart
`hro`	HomeRoots	`w1s`	Walmart 1P Supplier
`htp`	Hot Topic	`way`	Wayfair
`hoz`	Houzz	`web`	Website
`hsn`	HSN	`wsh`	Wish
`inf`	InfiPlex	`wix`	Wix
`jet`	Jet	`woo`	Woo Commerce
`laz`	Lazada	`wmk`	World Market
`low`	Lowes	`zoh`	Zoho
`lmp`	Lowes Marketplace	`zor`	Zoro Tools
`mag`	Magento	`zly`	Zulily
`mai`	Maisonette

Authorization

Bearer token, sent in the Authorization header. Inherited from the collection.

Query Parameters

Key	Value	Description
`just_count` optional		Set to 1 to return only a count of matching inventory buffers instead of the inventory buffers themselves.
`limit` optional		Maximum number of inventory buffers to return
`limit_start` optional		Number of leading results to skip, for paging. With limit 100 and limit_start 100 you get inventory buffers 101 through 200
`search_term`	`iphone`	Partial match against the SKU

Example Request

curl --location --request GET '{{api_url}}/shop/inventory/buffer/search?search_term=iphone' \
--header 'Authorization: Bearer {{auth_token}}'

Example Responses