snapcasterDevelopers

    API reference · Types

    ListingItemResult

    Part of the response of POST /listings, DELETE /listings and POST /listings/bulk.

    Type: object

    Example

    Schema example: from the POST /listings response
    {
  "skuId": 14602,
  "op": "upsert",
  "status": "applied",
  "externalRef": "platform-listing-1042"
}

    Fields

    skuId integer required

    See Canonical catalog in Core concepts.

    Example 14602

    op string required

    The write operation to apply to this item.

    Constraints: allowed values: upsert, delete Example upsert

    status string required

    The result for this item. unmatched corresponds to UNMATCHED: Snapcaster stored the item, but its SKU is absent from the canonical catalog. rejected corresponds to REJECTED: validation failed and Snapcaster did not store the item. Check reason for details.

    Constraints: allowed values: applied, unmatched, rejected, noop Example applied

    code string

    The stable machine-readable code for this result.

    Constraints: allowed values: INVALID_REQUEST, STALE_SNAPSHOT, SNAPSHOT_CONFLICT, PRODUCT_MISMATCH

    reason string

    Why the item was rejected; present only when status is "rejected".

    externalRef string

    The submitted listing reference, if supplied.

    Example platform-listing-1042

    Used by