snapcasterDevelopers

    API reference · Types

    ListingExportItem

    Part of the response of GET /listings.

    Type: object

    Example

    Generated Schema example: Generated ListingExportItem
    {
  "id": 0,
  "skuId": 0,
  "productId": 0,
  "matchStatus": "matched",
  "quantity": 0,
  "available": 0,
  "price": 0,
  "externalRef": "string",
  "browsable": true,
  "deletedAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "asOf": "2026-01-01T00:00:00.000Z"
}

    Fields

    id integer required

    Snapcaster's id for the listing, the listing_id a change request's substitute names. A fulfillment report you file names its substitute by substituteSkuId, not by this id.

    skuId integer required

    See Canonical catalog in Core concepts.

    productId integer required

    See Canonical catalog in Core concepts.

    matchStatus string required

    See Matched and unmatched in Core concepts.

    Constraints: allowed values: matched, unmatched

    quantity integer required

    The on-hand quantity supplied by the platform, as stored.

    available integer required

    On-hand minus outstanding committed holds, with a minimum of zero. Calculated when read; equals quantity when there are no holds.

    price integer required

    Integer minor units (cents) in the seller’s currency.

    externalRef string or null required

    See Listing in Core concepts.

    browsable boolean required

    Whether this listing currently passes every browse gate. See Browse readiness in Core concepts.

    deletedAt string or null required

    Soft-delete timestamp, or null if live.

    Constraints: format: date-time

    updatedAt string required

    Constraints: format: date-time

    asOf string or null required

    See Send ordered listing snapshots in Core concepts.

    Constraints: format: date-time

    Used by