ListingWriteResponse

Reusable ListingWriteResponse schema.

Type: object

Fields

Field	Type	Constraints	Meaning	Example
successrequired	boolean	allowed values: true	Whether the operation completed as requested.	true (generated)
datarequired	object	None	The operation or event payload.	{ "results": [ { "skuId": 0, "op": "upsert", "status": "applied" } ] } (generated)
data.resultsrequired	array of object	None	The outcome recorded for each submitted item.	[ { "skuId": 0, "op": "upsert", "status": "applied" } ] (generated)
data.results[].skuIdrequired	integer	None	Sku Id for the surrounding results item record.	0 (generated)
data.results[].oprequired	string	allowed values: upsert, delete	The write operation to apply to this item.	upsert (generated)
data.results[].statusrequired	string	allowed values: applied, unmatched, rejected	Per-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)
data.results[].reason	string	None	Why the item was rejected; present only when status is "rejected".	string (generated)
data.results[].externalRef	string	None	Echo of the pushed external_ref, when one was supplied.	string (generated)

Examples

Generated Schema example: Generated ListingWriteResponse

{
  "success": true,
  "data": {
    "results": [
      {
        "skuId": 0,
        "op": "upsert",
        "status": "applied"
      }
    ]
  }
}