Listing - Get

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

GET /listing/get

Listing - Get

cURL

curl --request GET \
  --url https://api.skulabs.com/listing/get \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "store_id": "507f1f77bcf86cd799439011",
    "id": "<string>",
    "active": true,
    "type": "<string>",
    "name": "<string>",
    "sku": "<string>",
    "upc": "<string>",
    "weight": 123,
    "weight_unit": "<string>",
    "length": 123,
    "width": 123,
    "height": 123,
    "dimensions_unit": "<string>",
    "cost": 123,
    "retail": 123,
    "location": "<string>",
    "on_hand": 123,
    "image": "<string>",
    "price": 123,
    "variants": [
      {
        "id": "<string>",
        "sku": "<string>",
        "name": "<string>",
        "upc": "<string>",
        "price": 123,
        "image": "<string>",
        "weight": 123,
        "weight_unit": "<string>",
        "on_hand": 123,
        "inventory_rule": "<string>",
        "price_rule": "<string>",
        "last_pushed": 123,
        "last_pushed_time": "2025-01-15T12:00:00.000Z",
        "last_failed": 123,
        "last_failed_time": "2025-01-15T12:00:00.000Z",
        "last_price": 123,
        "inventory": [
          {}
        ]
      }
    ],
    "variant_sets": [
      {}
    ],
    "variants_rule": "<string>",
    "inventory_rule": "<string>",
    "price_rule": "<string>",
    "fulfillment_rule": "<string>",
    "restock_date": "2025-01-15",
    "restock_quantity": 123,
    "last_pushed": 123,
    "last_pushed_time": "2025-01-15T12:00:00.000Z",
    "last_failed": 123,
    "last_failed_time": "2025-01-15T12:00:00.000Z",
    "last_price": 123,
    "custom_fields": [
      {
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

selector · object · required

Query selector object for filtering results

limit · number

Max results to return

Example:

50

skip · number

Number of results to skip

Example:

0

sort · object

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

Response

200

application/json

Array of listings matching the query

_id · string · required

Unique listing identifier

Example:

"507f1f77bcf86cd799439011"

store_id · string · required

Store ID this listing belongs to

Example:

"507f1f77bcf86cd799439011"

id · string · required

Listing ID from the sales channel

active · boolean

Whether the listing is active for sync

type · string

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

name · string

Listing name / title

sku · string

Listing SKU

upc · string

Listing barcode / UPC

weight · number

Listing weight

weight_unit · string

Weight unit (lb, kg, oz, g)

length · number

Package length

width · number

Package width

height · number

Package height

dimensions_unit · string

Dimensions unit (in, cm)

cost · number

Listing cost

retail · number

Retail price

location · string

Warehouse location

on_hand · number

On-hand quantity reported by the channel

image · string

Listing image URL

price · number

Listing price

variants · object[] | null

Listing variants

Show child attributes

variant_sets · object[]

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

variants_rule · string

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

inventory_rule · string

Inventory sync rule

price_rule · string

Price sync rule

fulfillment_rule · string | null

Fulfillment rule (Amazon only)

restock_date · string | null

Restock date (Amazon only)

Example:

"2025-01-15"

restock_quantity · number | null

Restock quantity (Amazon only)

last_pushed · number | null

Last quantity pushed to the channel

last_pushed_time · string | null

Timestamp of last inventory push

Example:

"2025-01-15T12:00:00.000Z"

last_failed · number | null

Last failed push quantity

last_failed_time · string | null

Timestamp of last failed push

Example:

"2025-01-15T12:00:00.000Z"

last_price · number | null

Last price pushed to the channel

custom_fields · object[]

Custom field key-value pairs

Show child attributes