snapcasterDevelopers

    API reference · Types

    ChangeRequestSubstituteCandidateListResponse

    Part of the response of GET /orders/{orderId}/substitute-candidates.

    Type: object

    Example

    Schema example: from the GET /orders/{orderId}/substitute-candidates response
    {
  "success": true,
  "data": {
    "items": [
      {
        "sku_id": 363348,
        "product_id": 86,
        "external_ref": "platform-listing-1043",
        "available": 1,
        "unit_price": 2699,
        "name": "Abyssal Nightstalker",
        "set": "Portal Second Age",
        "condition": "LP",
        "language": "EN",
        "finish": "Normal"
      }
    ]
  }
}

    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.items ChangeRequestSubstituteCandidate[] required

    The SKUs the line can be substituted with, cheapest first; empty when none qualify.

    Show child fieldsHide child fields
    data.items[].sku_id integer required

    The SKU to send as substituteSkuId (STABLE).

    Example 363348

    data.items[].product_id integer required

    The catalog product of that SKU, the same one the line's SKU belongs to (STABLE).

    Example 86

    data.items[].external_ref string or null required

    Your platform's reference on the seller's listing for that SKU; null when none was sent (STABLE).

    Example platform-listing-1043

    data.items[].available integer required

    Units of that SKU available now: the listing's quantity less the units other orders hold. Provisional: nothing is held for the substitute until the buyer accepts, and the accept checks stock again (STABLE).

    Example 1

    data.items[].unit_price integer required

    The listing's price per unit in cents. For reference only: the buyer still pays the line's own unit_price, less your creditCents (STABLE).

    Example 2699

    data.items[].name string or null required

    The card title; null when the catalog has none (STABLE).

    Example Abyssal Nightstalker

    data.items[].set string or null required

    The set the printing belongs to; null when the catalog has none (STABLE).

    Example Portal Second Age

    data.items[].condition string or null required

    The condition grade; null when the catalog has none (STABLE).

    Example LP

    data.items[].language string or null required

    The printing language; null when the catalog has none (STABLE).

    Example EN

    data.items[].finish string or null required

    The printing or finish, such as Foil; null when the catalog has none (STABLE).

    Example Normal

    Used by