Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
listing

Listing - Get

Retrieve product listings with optional filtering by store and linked item status.

get/listing/get

Query parameters

selectorobject required

Query selector object for filtering results

limitnumber

Max results to return

Example:50
skipnumber

Number of results to skip

sortobject

Sort fields object, e.g. { "name": 1 }

Response

Array of listings matching the query

_idstring required

Unique listing identifier

store_idstring required

Store ID this listing belongs to

idstring required

Listing ID from the sales channel

activeboolean

Whether the listing is active for sync

typestring

Listing type (e.g. FBA, FBM for Amazon)

namestring

Listing name / title

skustring

Listing SKU

upcstring

Listing barcode / UPC

weightnumber

Listing weight

weight_unitstring

Weight unit (lb, kg, oz, g)

lengthnumber

Package length

widthnumber

Package width

heightnumber

Package height

dimensions_unitstring

Dimensions unit (in, cm)

costnumber

Listing cost

retailnumber

Retail price

locationstring

Warehouse location

on_handnumber

On-hand quantity reported by the channel

imagestring

Listing image URL

pricenumber

Listing price

variant_setsobject[]

Variant option sets (e.g. Size, Color)

variants_rulestring

Rule for handling variant sync (e.g. sync_all, sync_none)

inventory_rulestring

Inventory sync rule

price_rulestring

Price sync rule

fulfillment_rulestring nullable

Fulfillment rule (Amazon only)

restock_datestring nullable

Restock date (Amazon only)

restock_quantitynumber nullable

Restock quantity (Amazon only)

last_pushednumber nullable

Last quantity pushed to the channel

last_pushed_timestring nullable

Timestamp of last inventory push

last_failednumber nullable

Last failed push quantity

last_failed_timestring nullable

Timestamp of last failed push

last_pricenumber nullable

Last price pushed to the channel

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "store_id": "507f1f77bcf86cd799439011",
    "variants": [
      {
        "last_pushed_time": "2025-01-15T12:00:00.000Z",
        "last_failed_time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "restock_date": "2025-01-15",
    "last_pushed_time": "2025-01-15T12:00:00.000Z",
    "last_failed_time": "2025-01-15T12:00:00.000Z"
  }
]