Skip to content
snapcasterDevelopers

ListingItemResult

Reusable ListingItemResult schema.

Type: object

Fields

FieldTypeConstraintsMeaningExample
skuIdrequiredintegerNoneSku Id supplied to or returned by this operation.0 (generated)
oprequiredstringallowed values: upsert, deleteThe write operation to apply to this item.upsert (generated)
statusrequiredstringallowed values: applied, unmatched, rejectedPer-item outcome. `unmatched` corresponds to the public per-item code `UNMATCHED` (persisted but not in the Canonical Catalog); `rejected` corresponds to `REJECTED` (failed validation, not persisted; see `reason`).applied (generated)
reasonstringNoneWhy the item was rejected; present only when status is "rejected".string (generated)
externalRefstringNoneEcho of the pushed external_ref, when one was supplied.string (generated)

Examples

Generated Schema example: Generated ListingItemResult
{
"skuId": 0,
"op": "upsert",
"status": "applied"
}

Source commit: 64bff06fe339e6ffa0ef24cd7da55cb3efefefb9