API reference · Sandbox
Have the sandbox buyer answer a fulfillment report
/sandbox/orders/{orderId}/change-requests/{requestId}/answerSandbox only: the production API does not serve this operation. Snapcaster's sandbox buyer answers a fulfillment report this seller filed with POST /orders/{orderId}/change-requests, exactly as a buyer does from their order page. accept takes the report as filed: removed lines are cancelled and substituted lines take the substitute. remove_instead removes every affected line. cancel_order cancels the whole order. It works only on an order from this seller's own test purchase; any other order returns 404 ORDER_NOT_FOUND. Snapcaster emails the seller and sends order.change_request.resolved with the outcome, and the order.updated with reason: line_substituted or the order.cancelled the answer causes, the same as for a real buyer. A retry with the same Idempotency-Key and body replays the first response. Returns the answered report.
Example
These examples send requests to the sandbox.
Replace the example orderId and requestId in the URL with your own.
curl --request POST \
--url 'https://api-sandbox.snapcaster.ca/api/v1/marketplace/sandbox/orders/ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW/change-requests/381/answer' \
--header "Authorization: Bearer $MARKETPLACE_API_KEY" \
--header "Idempotency-Key: $(uuidgen)" \
--header 'Content-Type: application/json' \
--data '{
"answer": "accept"
}'$(uuidgen) makes a new Idempotency-Key each time you run the command. To retry a command after a lost response, send the key from the first attempt.
{
"success": true,
"data": {
"id": 382,
"order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
"kind": "fulfillment_report",
"status": "accepted",
"proposed_by_party": "seller",
"created_at": "2026-09-04T19:01:12.000Z",
"resolved_at": "2026-09-04T19:20:41.000Z",
"lines": [
{
"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
}
],
"amount_cents": 233,
"note": "Our near mint copy was damaged; we can send a lightly played one.",
"credits": {
"accept_cents": 233,
"remove_instead_cents": 1165,
"cancel_order_cents": 2039
},
"address": null,
"previous_address": null
}
}Endpoint
| Environment | URL |
|---|---|
| Sandbox | https://api-sandbox.snapcaster.ca/api/v1/marketplace |
marketplaceApiKey-http bearer. Send the seller's marketplace API key asAuthorization: Bearer mp_{sellerCode}_{hex}. Themp_{sellerCode}_prefix identifies the seller; the trailing hex is the secret. The seller generates the key and supplies it to your platform.
Request
Path parameters
orderIdstring requiredThe opaque public order id (the webhook/poll
order_id).Constraints: minimum length: 1 Example
ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VWrequestIdinteger requiredThe change request id from the list or a webhook.
Constraints: exclusive minimum: 0 Example
381
Headers
Idempotency-Keystring requiredKeep this UUID when retrying the same order operation and body. Keys remain valid for the lifetime of the order. Changed contents return 409 IDEMPOTENCY_CONFLICT; a concurrent attempt returns 409 REQUEST_IN_PROGRESS with Retry-After.
Constraints: format: uuid Example
f04e4a96-3c99-44dc-abce-5b6862c589c9X-Snapcaster-Api-VersionstringOverride the platform pin for this request only. Webhook versions and the platform pin do not change.
Constraints: allowed values:
2026-10Example2026-10
Request body
answerstring requiredThe door the sandbox buyer takes on the fulfillment report.
accepttakes it as filed.remove_insteadremoves every affected line.cancel_ordercancels the whole order.Constraints: allowed values:
accept,remove_instead,cancel_orderExampleaccept
Response
200
The fulfillment report, now answered.
Response body: Change
successboolean requiredWhether the operation completed as requested.
Constraints: allowed values:
trueExampletruedataChangerequiredRequest The operation or event payload.
Show child fieldsHide child fields
data.integer requiredid The change request id, stable for the life of the request and the
{requestId}of its answers (STABLE).Constraints: exclusive minimum: 0 Example
382data.string requiredorder_id The order the request is about (STABLE).
Example
ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VWdata.string requiredkind address_change: the buyer asks to ship toaddressinstead ofprevious_address.cancel_lines: the buyer asks to removelines, or every remaining line to end the order.fulfillment_report: the seller reports thatlinescannot ship as sold, and the buyer answers it (STABLE).Constraints: allowed values:
cancel_lines,fulfillment_report,address_changeExamplefulfillment_reportdata.string requiredstatus pendinguntil it is answered; a request has no deadline.accepted: the change ran.declined: the answering party refused it and nothing changed.withdrawn: the party who raised it took it back.voided: the order shipped, was cancelled or refunded, its address was corrected, or Snapcaster closed the support conversation the request belonged to, before anyone answered.removed_insteadandorder_cancelledare the buyer answers to afulfillment_reportthat remove every affected line or end the order.expiredappears only on requests from before requests stopped lapsing (STABLE).Constraints: allowed values:
pending,accepted,removed_instead,order_cancelled,declined,withdrawn,voided,expiredExampleaccepteddata.string requiredproposed_by_party Who raised it. The seller answers a
buyerrequest by accepting or declining it; the buyer answers asellerrequest (STABLE).Constraints: allowed values:
buyer,seller,operator,systemExamplesellerdata.string requiredcreated_at When the request was raised (STABLE).
Constraints: format: date-time Example
2026-09-04T19:01:12.000Zdata.string or null requiredresolved_at When the request left
pending; null while it is pending (STABLE).Constraints: format: date-time Example
2026-09-04T19:20:41.000Zdata.lines Changeor null requiredRequest Line[] The lines a
cancel_linesorfulfillment_reportrequest names; null on anaddress_change(STABLE).Show child fieldsHide child fields
data.string requiredlines[]. line_ref The purchase line the request names, the same
line_refthe order carries (STABLE).Example
oln_1f0c8a4d7e2b45c9a1d6f3b8e07c9241data.string requiredlines[]. name The line title, or
SKU <sku_id>when the catalog had none (STABLE).Example
Abyssal Nightstalkerdata.integer requiredlines[]. quantity How many units of the line the request covers (STABLE).
Constraints: exclusive minimum: 0 Example
2data.integer requiredlines[]. sku_id The SKU the line was sold as (STABLE).
Example
14602data.integer or null requiredlines[]. product_id The product that SKU belongs to; null on a request recorded before it was kept (STABLE).
Example
86data.object requiredlines[]. ordered The card the buyer ordered, as the request recorded it. A fact the request never recorded is null (STABLE).
Show child fieldsHide child fields
data.string or null requiredlines[]. ordered. name The card title (STABLE).
Example
Abyssal Nightstalkerdata.string or null requiredlines[]. ordered. set The set the printing belongs to; null when it was never recorded (STABLE).
Example
Portal Second Agedata.string or null requiredlines[]. ordered. language The printing language; null when it was never recorded (STABLE).
Example
ENdata.string or null requiredlines[]. ordered. finish The printing or finish, such as
Foil; null when never recorded (STABLE).Example
Normaldata.string or null requiredlines[]. ordered. rarity The rarity; null when it was never recorded (STABLE).
Example
Udata.string or null requiredlines[]. ordered. condition The condition grade; null when it was never recorded (STABLE).
Example
NMdata.string or null requiredlines[]. ordered. collector_number The collector number as the catalog states it, such as
161/302; null when never recorded (STABLE).Example
null
data.string requiredlines[]. action removeon everycancel_linesline and on a report line that removes units.substituteon a report line that ships a replacement named insubstituteat a per-unitcredit_cents.spliton a report line whose units go several ways, listed indispositions(STABLE).Constraints: allowed values:
remove,substitute,splitExamplesubstitutedata.lines[]. substitute Changeor null requiredRequest Substitute The replacement on a
substituteline; null on every other line (STABLE).Show child fieldsHide child fields
data.integer requiredlines[]. substitute. listing_id Snapcaster's id for the seller listing offered in place of the line (STABLE).
Example
5021data.integer requiredlines[]. substitute. sku_id The SKU the line ships as once the report is accepted (STABLE).
Example
363348data.integer requiredlines[]. substitute. product_id The product, the same one the replaced line belongs to (STABLE).
Example
86data.string or null requiredlines[]. substitute. external_ref Your platform's reference on that listing when the report was filed; null when none was sent (STABLE).
Example
platform-listing-1043data.string or null requiredlines[]. substitute. name The card title (STABLE).
Example
Abyssal Nightstalkerdata.string or null requiredlines[]. substitute. set The set the printing belongs to; null when it was never recorded (STABLE).
Example
Portal Second Agedata.string or null requiredlines[]. substitute. language The printing language; null when it was never recorded (STABLE).
Example
ENdata.string or null requiredlines[]. substitute. finish The printing or finish, such as
Foil; null when never recorded (STABLE).Example
Normaldata.string or null requiredlines[]. substitute. rarity The rarity; null when it was never recorded (STABLE).
Example
Udata.string or null requiredlines[]. substitute. condition The condition grade; null when it was never recorded (STABLE).
Example
LPdata.string or null requiredlines[]. substitute. collector_number The collector number as the catalog states it, such as
161/302; null when never recorded (STABLE).Example
nulldata.string or null requiredlines[]. substitute. printing The same fact as
finish, under the catalog name (STABLE).Example
Normal
data.integer or null requiredlines[]. credit_cents The credit per unit on a
substituteline, in cents; null on every other line (STABLE).Example
100data.array of object or null requiredlines[]. dispositions On a
splitline, each portion in the order the seller listed them; null on every other line (STABLE).Show child fieldsHide child fields
data.string requiredlines[]. dispositions[]. action What happens to this portion (STABLE).
Constraints: allowed values:
remove,substitutedata.integer requiredlines[]. dispositions[]. quantity How many of the line units go this way (STABLE).
Constraints: exclusive minimum: 0
data.lines[]. dispositions[]. substitute Changeor null requiredRequest Substitute The replacement on a
substituteline; null on every other line (STABLE).Show child fieldsHide child fields
data.integer requiredlines[]. dispositions[]. substitute. listing_id Snapcaster's id for the seller listing offered in place of the line (STABLE).
data.integer requiredlines[]. dispositions[]. substitute. sku_id The SKU the line ships as once the report is accepted (STABLE).
data.integer requiredlines[]. dispositions[]. substitute. product_id The product, the same one the replaced line belongs to (STABLE).
data.string or null requiredlines[]. dispositions[]. substitute. external_ref Your platform's reference on that listing when the report was filed; null when none was sent (STABLE).
data.string or null requiredlines[]. dispositions[]. substitute. name The card title (STABLE).
data.string or null requiredlines[]. dispositions[]. substitute. set The set the printing belongs to; null when it was never recorded (STABLE).
data.string or null requiredlines[]. dispositions[]. substitute. language The printing language; null when it was never recorded (STABLE).
data.string or null requiredlines[]. dispositions[]. substitute. finish The printing or finish, such as
Foil; null when never recorded (STABLE).data.string or null requiredlines[]. dispositions[]. substitute. rarity The rarity; null when it was never recorded (STABLE).
data.string or null requiredlines[]. dispositions[]. substitute. condition The condition grade; null when it was never recorded (STABLE).
data.string or null requiredlines[]. dispositions[]. substitute. collector_number The collector number as the catalog states it, such as
161/302; null when never recorded (STABLE).data.string or null requiredlines[]. dispositions[]. substitute. printing The same fact as
finish, under the catalog name (STABLE).
data.integer or null requiredlines[]. dispositions[]. credit_cents The credit per unit for a
substituteportion; null for a removal (STABLE).
data.integer or null requiredamount_cents The refund, tax included, that accepting a
cancel_linesrequest returns to the buyer, or the refund afulfillment_reportreturns when the buyer accepts it. Fixed when the request was raised. Null on anaddress_changeand on an order with no payment (STABLE).Example
233data.string or null requirednote The seller's note to the buyer on a
fulfillment_report; null when none was given and on every other kind (STABLE).Example
Our near mint copy was damaged; we can send a lightly played one.data.object or null requiredcredits The refund behind each buyer answer to a
fulfillment_report, fixed when it was raised; null on every other kind and on an order with no payment (STABLE).Show child fieldsHide child fields
data.integer requiredcredits. accept_cents The refund if the buyer accepts the report; repeats
amount_cents(STABLE).Example
233data.integer requiredcredits. remove_instead_cents The refund if the buyer has every affected line removed instead (STABLE).
Example
1165data.integer requiredcredits. cancel_order_cents The refund if the buyer ends the whole order instead (STABLE).
Example
2039
data.address Orderor null requiredWebhook Shipping Address The shipping address an
address_changeasks for. Set only on anaddress_change; null on every other kind (STABLE).Show child fieldsHide child fields
data.string requiredaddress. line1 The street address.
data.string or null requiredaddress. line2 The unit, suite, or second address line, if supplied.
data.string requiredaddress. city The city in the shipping address.
data.string requiredaddress. province The Canadian province or territory in the delivery address.
data.string requiredaddress. postal_code The Canadian postal code in the delivery address.
data.string requiredaddress. country ISO 3166-1 alpha-2 country code.
data.previous_address Orderor null requiredWebhook Shipping Address The shipping address the order had when the
address_changewas raised. Set only on anaddress_change; null on every other kind (STABLE).Show child fieldsHide child fields
data.string requiredprevious_address. line1 The street address.
data.string or null requiredprevious_address. line2 The unit, suite, or second address line, if supplied.
data.string requiredprevious_address. city The city in the shipping address.
data.string requiredprevious_address. province The Canadian province or territory in the delivery address.
data.string requiredprevious_address. postal_code The Canadian postal code in the delivery address.
data.string requiredprevious_address. country ISO 3166-1 alpha-2 country code.
Errors
Errors return a Marketplace body, except HTTP 413, 500 (Api). Error codes explains both error bodies and lists every code.
400
INVALID_REQUESTIDEMPOTENCY_KEY_REQUIREDUNSUPPORTED_API_VERSIONInvalid command body or missing/invalid UUID Idempotency-Key. Unknown or retired API-version override (
UNSUPPORTED_API_VERSION).Do this: Correct the request fields and supply a UUID Idempotency-Key. Keep the same key when retrying the same command. For UNSUPPORTED_API_VERSION, choose a supported version from the API versioning guide.
401
UNAUTHORIZEDMissing or invalid marketplace API key (
UNAUTHORIZED).Do this: Send the marketplace API key for this seller as a Bearer token, then retry.
403
SUBSCRIPTION_EXCLUDES_ORDERSThe platform's subscription is
inventory, which does not include orders (SUBSCRIPTION_EXCLUDES_ORDERS). Onlyordersandbothsubscriptions read and act on orders.Do this: Do not retry. Ask Snapcaster to change the platform subscription to
ordersorbothif the platform should handle orders.404
ORDER_NOT_FOUNDORDER_CHANGE_REQUEST_NOT_FOUNDNo order matches this id for the authenticated seller (
ORDER_NOT_FOUND), or no change request with this id is on the order (ORDER_CHANGE_REQUEST_NOT_FOUND). An order of this seller that no test purchase of this seller created also returns 404 (ORDER_NOT_FOUND): the sandbox buyer acts only on orders fromPOST /sandbox/test-purchases.Do this: Read GET /orders/{orderId}/change-requests for the ids on the order.
409
IDEMPOTENCY_CONFLICTREQUEST_IN_PROGRESSORDER_CHANGE_REQUEST_NOT_PENDINGIDEMPOTENCY_CONFLICT or REQUEST_IN_PROGRESS. Retry an in-progress command with the same key after Retry-After seconds. ORDER_CHANGE_REQUEST_NOT_PENDING when the request was already answered, withdrawn or voided;
details.statusis its status now.Do this: For REQUEST_IN_PROGRESS, wait Retry-After seconds and retry the same key and body. For IDEMPOTENCY_CONFLICT, reuse the original body or create a new UUID for a different operation. For ORDER_CHANGE_REQUEST_NOT_PENDING, do not retry: the request needs no answer.
413
PAYLOAD_TOO_LARGEThe body is larger than this route accepts (
PAYLOAD_TOO_LARGE).Do this: Send a smaller body and retry.
422
ORDER_CHANGE_REQUEST_NOT_ALLOWEDINVALID_TRANSITIONThe buyer cannot answer this request this way (
ORDER_CHANGE_REQUEST_NOT_ALLOWED): the buyer raised it, so the seller answers it, or a substitute no longer passes its rule (detailsnames the SKU and the rule).INVALID_TRANSITION: the order moved so the answer cannot run.Do this: Answer only a fulfillment report this seller filed. For a substitute that fails, take another answer or file a new report.
500
INTERNAL_ERRORAn unexpected failure (
INTERNAL_ERROR).Do this: Retry with bounded retries and jitter. If the failure persists, contact Snapcaster with the X-Correlation-ID response header.
503
TEST_PURCHASE_NOT_AVAILABLEThis deployment cannot act as the sandbox buyer right now (
TEST_PURCHASE_NOT_AVAILABLE): it is not the sandbox, its payments are not in test mode, or its sandbox buyer is missing.Do this: Call the sandbox API. If this persists there, contact Snapcaster with the X-Correlation-ID response header.