snapcasterDevelopers

    API reference · Types

    ListingWriteResponse

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

    Type: object

    Example

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

    Fields

    success boolean required

    Whether the operation completed as requested.

    Constraints: allowed values: true Example true

    data object required

    The operation or event payload.

    Show child fieldsHide child fields
    data.results ListingItemResult[] required

    The outcome recorded for each submitted item.

    Show child fieldsHide child fields
    data.results[].skuId integer required

    See Canonical catalog in Core concepts.

    Example 14602

    data.results[].op string required

    The write operation to apply to this item.

    Constraints: allowed values: upsert, delete Example upsert

    data.results[].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

    data.results[].code string

    The stable machine-readable code for this result.

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

    data.results[].reason string

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

    data.results[].externalRef string

    The submitted listing reference, if supplied.

    Example platform-listing-1042

    Used by