snapcasterDevelopers

    API reference · Types

    ChangeRequestLine

    Part of the response of 7 operations and the payload of order.change_request.created and order.change_request.resolved.

    Type: object

    Example

    Schema example: from the POST /orders/{orderId}/change-requests response
    {
  "line_ref": "oln_1f0c8a4d7e2b45c9a1d6f3b8e07c9241",
  "name": "Abyssal Nightstalker",
  "quantity": 2,
  "sku_id": 14602,
  "product_id": 86,
  "ordered": {
    "name": "Abyssal Nightstalker",
    "set": "Portal Second Age",
    "language": "EN",
    "finish": "Normal",
    "rarity": "U",
    "condition": "NM",
    "collector_number": null
  },
  "action": "substitute",
  "substitute": {
    "listing_id": 5021,
    "sku_id": 363348,
    "product_id": 86,
    "external_ref": "platform-listing-1043",
    "name": "Abyssal Nightstalker",
    "set": "Portal Second Age",
    "language": "EN",
    "finish": "Normal",
    "rarity": "U",
    "condition": "LP",
    "collector_number": null,
    "printing": "Normal"
  },
  "credit_cents": 100,
  "dispositions": null
}

    Fields

    line_ref string required

    The purchase line the request names, the same line_ref the order carries (STABLE).

    Example oln_1f0c8a4d7e2b45c9a1d6f3b8e07c9241

    name string required

    The line title, or SKU <sku_id> when the catalog had none (STABLE).

    Example Abyssal Nightstalker

    quantity integer required

    How many units of the line the request covers (STABLE).

    Constraints: exclusive minimum: 0 Example 2

    sku_id integer required

    The SKU the line was sold as (STABLE).

    Example 14602

    product_id integer or null required

    The product that SKU belongs to; null on a request recorded before it was kept (STABLE).

    Example 86

    ordered object required

    The card the buyer ordered, as the request recorded it. A fact the request never recorded is null (STABLE).

    Show child fieldsHide child fields
    ordered.name string or null required

    The card title (STABLE).

    Example Abyssal Nightstalker

    ordered.set string or null required

    The set the printing belongs to; null when it was never recorded (STABLE).

    Example Portal Second Age

    ordered.language string or null required

    The printing language; null when it was never recorded (STABLE).

    Example EN

    ordered.finish string or null required

    The printing or finish, such as Foil; null when never recorded (STABLE).

    Example Normal

    ordered.rarity string or null required

    The rarity; null when it was never recorded (STABLE).

    Example U

    ordered.condition string or null required

    The condition grade; null when it was never recorded (STABLE).

    Example NM

    ordered.collector_number string or null required

    The collector number as the catalog states it, such as 161/302; null when never recorded (STABLE).

    Example null

    action string required

    remove on every cancel_lines line and on a report line that removes units. substitute on a report line that ships a replacement named in substitute at a per-unit credit_cents. split on a report line whose units go several ways, listed in dispositions (STABLE).

    Constraints: allowed values: remove, substitute, split Example substitute

    substitute ChangeRequestSubstitute or null required

    The replacement on a substitute line; null on every other line (STABLE).

    Show child fieldsHide child fields
    substitute.listing_id integer required

    Snapcaster's id for the seller listing offered in place of the line (STABLE).

    Example 5021

    substitute.sku_id integer required

    The SKU the line ships as once the report is accepted (STABLE).

    Example 363348

    substitute.product_id integer required

    The product, the same one the replaced line belongs to (STABLE).

    Example 86

    substitute.external_ref string or null required

    Your platform's reference on that listing when the report was filed; null when none was sent (STABLE).

    Example platform-listing-1043

    substitute.name string or null required

    The card title (STABLE).

    Example Abyssal Nightstalker

    substitute.set string or null required

    The set the printing belongs to; null when it was never recorded (STABLE).

    Example Portal Second Age

    substitute.language string or null required

    The printing language; null when it was never recorded (STABLE).

    Example EN

    substitute.finish string or null required

    The printing or finish, such as Foil; null when never recorded (STABLE).

    Example Normal

    substitute.rarity string or null required

    The rarity; null when it was never recorded (STABLE).

    Example U

    substitute.condition string or null required

    The condition grade; null when it was never recorded (STABLE).

    Example LP

    substitute.collector_number string or null required

    The collector number as the catalog states it, such as 161/302; null when never recorded (STABLE).

    Example null

    substitute.printing string or null required

    The same fact as finish, under the catalog name (STABLE).

    Example Normal

    credit_cents integer or null required

    The credit per unit on a substitute line, in cents; null on every other line (STABLE).

    Example 100

    dispositions array of object or null required

    On a split line, each portion in the order the seller listed them; null on every other line (STABLE).

    Show child fieldsHide child fields
    dispositions[].action string required

    What happens to this portion (STABLE).

    Constraints: allowed values: remove, substitute

    dispositions[].quantity integer required

    How many of the line units go this way (STABLE).

    Constraints: exclusive minimum: 0

    dispositions[].substitute ChangeRequestSubstitute or null required

    The replacement on a substitute line; null on every other line (STABLE).

    Show child fieldsHide child fields
    dispositions[].substitute.listing_id integer required

    Snapcaster's id for the seller listing offered in place of the line (STABLE).

    dispositions[].substitute.sku_id integer required

    The SKU the line ships as once the report is accepted (STABLE).

    dispositions[].substitute.product_id integer required

    The product, the same one the replaced line belongs to (STABLE).

    dispositions[].substitute.external_ref string or null required

    Your platform's reference on that listing when the report was filed; null when none was sent (STABLE).

    dispositions[].substitute.name string or null required

    The card title (STABLE).

    dispositions[].substitute.set string or null required

    The set the printing belongs to; null when it was never recorded (STABLE).

    dispositions[].substitute.language string or null required

    The printing language; null when it was never recorded (STABLE).

    dispositions[].substitute.finish string or null required

    The printing or finish, such as Foil; null when never recorded (STABLE).

    dispositions[].substitute.rarity string or null required

    The rarity; null when it was never recorded (STABLE).

    dispositions[].substitute.condition string or null required

    The condition grade; null when it was never recorded (STABLE).

    dispositions[].substitute.collector_number string or null required

    The collector number as the catalog states it, such as 161/302; null when never recorded (STABLE).

    dispositions[].substitute.printing string or null required

    The same fact as finish, under the catalog name (STABLE).

    dispositions[].credit_cents integer or null required

    The credit per unit for a substitute portion; null for a removal (STABLE).

    Used by