snapcasterDevelopers

    API reference · Types

    ListingExportPageResponse

    Part of the response of GET /listings.

    Type: object

    Example

    Generated Schema example: Generated ListingExportPageResponse
    {
  "success": true,
  "data": {
    "items": [
      {
        "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"
      }
    ],
    "nextCursor": "string"
  }
}

    Fields

    success boolean required

    Whether the operation completed as requested.

    Constraints: allowed values: true

    data object required

    The operation or event payload.

    Show child fieldsHide child fields
    data.items ListingExportItem[] required

    The records included in this page or batch.

    Show child fieldsHide child fields
    data.items[].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.

    data.items[].skuId integer required

    See Canonical catalog in Core concepts.

    data.items[].productId integer required

    See Canonical catalog in Core concepts.

    data.items[].matchStatus string required

    See Matched and unmatched in Core concepts.

    Constraints: allowed values: matched, unmatched

    data.items[].quantity integer required

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

    data.items[].available integer required

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

    data.items[].price integer required

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

    data.items[].externalRef string or null required

    See Listing in Core concepts.

    data.items[].browsable boolean required

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

    data.items[].deletedAt string or null required

    Soft-delete timestamp, or null if live.

    Constraints: format: date-time

    data.items[].updatedAt string required

    Constraints: format: date-time

    data.items[].asOf string or null required

    See Send ordered listing snapshots in Core concepts.

    Constraints: format: date-time

    data.nextCursor string or null required

    Opaque cursor for the next page; null on the last page.

    Used by