Skip to content
snapcasterDevelopers

ListingExportPageResponse

Reusable ListingExportPageResponse schema.

Type: object

Fields

FieldTypeConstraintsMeaningExample
successrequiredbooleanallowed values: trueWhether the operation completed as requested.true (generated)
datarequiredobjectNoneThe operation or event payload.{ "items": [ { "skuId": 0, "productId": 0, "matchStatus": "matched", "quantity": 0, "available": 0, "price": 0, "externalRef": "string", "browsable": true, "deletedAt": "string", "updatedAt": "string" } ], "nextCursor": "string" } (generated)
data.itemsrequiredarray of objectNoneThe records included in this page or batch.[ { "skuId": 0, "productId": 0, "matchStatus": "matched", "quantity": 0, "available": 0, "price": 0, "externalRef": "string", "browsable": true, "deletedAt": "string", "updatedAt": "string" } ] (generated)
data.items[].skuIdrequiredintegerNoneSku Id for the surrounding items item record.0 (generated)
data.items[].productIdrequiredintegerNoneProduct Id for the surrounding items item record.0 (generated)
data.items[].matchStatusrequiredstringallowed values: matched, unmatchedMatch Status for the surrounding items item record.matched (generated)
data.items[].quantityrequiredintegerNoneOn-hand: the pushed quantity, as stored.0 (generated)
data.items[].availablerequiredintegerNoneOn-hand minus outstanding committed holds, never negative. Derived at read time; with no holds, equals `quantity`.0 (generated)
data.items[].pricerequiredintegerNoneInteger minor units (cents) in the Seller’s currency.0 (generated)
data.items[].externalRefrequiredstring or nullNoneExternal Ref for the surrounding items item record.string (generated)
data.items[].browsablerequiredbooleanNoneWhether this Listing currently passes every Browse gate.true (generated)
data.items[].deletedAtrequiredstring or nullNoneSoft-delete timestamp, or null if live.string (generated)
data.items[].updatedAtrequiredstringNoneUpdated At for the surrounding items item record.string (generated)
data.nextCursorrequiredstring or nullNoneOpaque cursor for the next page; null on the last page.string (generated)

Examples

Generated Schema example: Generated ListingExportPageResponse
{
"success": true,
"data": {
"items": [
{
"skuId": 0,
"productId": 0,
"matchStatus": "matched",
"quantity": 0,
"available": 0,
"price": 0,
"externalRef": "string",
"browsable": true,
"deletedAt": "string",
"updatedAt": "string"
}
],
"nextCursor": "string"
}
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9