API reference · Types
OrderAdditionOfferUpdatedEvent
Part of the payload of order.addition_offer.updated.
Type: object
Example
{
"event_id": "evt_sandbox_01K4AA5H9R2C6Y3M8Q1J7V4B0S",
"type": "order.addition_offer.updated",
"created_at": "2026-09-04T19:14:03.000Z",
"data": {
"offer_ref": "oao_9e2b7c4d1a6f43b8a5c0d3e7f1b8a264",
"status": "sent",
"lines": [
{
"sku_id": 14602,
"product_id": 86,
"quantity": 2,
"reference_unit_price_cents": 450,
"unit_price_cents": 400,
"name": "Abyssal Nightstalker",
"set_name": "Portal Second Age",
"condition": "Near Mint",
"category_name": "Magic: The Gathering",
"language": "English",
"finish": "Normal",
"collector_number": null,
"rarity": "Uncommon"
}
],
"money": {
"currency": "CAD",
"merchandise_cents": 800,
"reference_merchandise_cents": 900,
"shipping_cents": 0,
"purchase_fee_cents": 28,
"tax_cents": 104,
"total_cents": 932,
"tax_lines": [
{
"label": "HST",
"rate": 0.13,
"amount": 104
}
]
},
"shipping_upgrade": null,
"note": "Two more, at the price you paid",
"request_ref": "oar_5c1e9a7f3b2d48e6a0f4c8d1b7e3a925",
"support_case_id": null,
"replaces_offer_ref": null,
"sent_at": "2026-09-04T19:14:03.000Z",
"expires_at": "2026-09-05T19:14:03.000Z",
"resolved_by_party": null,
"resolved_at": null,
"resolution_note": null,
"payment": null,
"seller_fees": {
"commission_cents": 40,
"processing_fee_cents": 57,
"platform_collected_tax_cents": 0,
"fee_terms": {
"marketplace_fee_rate_basis_points": 500,
"marketplace_fee_per_item_cap_cents": 2500,
"purchase_fee_rate_basis_points": 350,
"processing_fee_rate_basis_points": 290,
"processing_fee_fixed_cents": 30
}
},
"order_id": "ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VW",
"seller_id": 42,
"reason": "sent"
},
"api_version": "2026-10"
}Fields
event_idstring requiredA globally unique event id that stays the same across retries. Use it to deduplicate deliveries (STABLE).
Example
evt_sandbox_01K4AA5H9R2C6Y3M8Q1J7V4B0Stypestring requiredThe event type (STABLE).
Constraints: allowed values:
order.addition_offer.updatedExampleorder.addition_offer.updatedcreated_atstring requiredISO-8601 UTC instant of the change the event reports; unchanged across retries (STABLE).
Example
2026-09-04T19:14:03.000ZdataOrderrequiredAddition Offer Event Data The operation or event payload.
Show child fieldsHide child fields
data.string requiredoffer_ref The opaque public offer id (
oao_…) - the{offerRef}of the withdraw and decline paths.Example
oao_9e2b7c4d1a6f43b8a5c0d3e7f1b8a264data.string requiredstatus sentandacceptedare the two OUTSTANDING states:acceptedmeans the buyer approved the exact amount and a payment is in flight, which is why the offer can no longer be withdrawn, replaced or expired.withdrawnis the seller taking it back;declinedis the buyer’s answer;expiredis the 24 hours running out;replacedis a different offer sent in its place;paidmeans the payment succeeded and the cards are now purchases on the order;payment_blockedmeans a captured payment was screened out and returned. Every ending is one-way, and every one butpaidfrees the stock the offer held -paidconverts it into the purchase.Constraints: allowed values:
sent,accepted,withdrawn,declined,expired,replaced,paid,payment_blockedExamplesentdata.lines OrderrequiredAddition Offer Line[] The line items in this request, response, or event.
Show child fieldsHide child fields
data.integer requiredlines[]. sku_id The exact printing offered. Everything beside it is frozen from it.
Example
14602data.integer requiredlines[]. product_id See Canonical catalog in Core concepts.
Example
86data.integer requiredlines[]. quantity The number of units.
Example
2data.integer requiredlines[]. reference_unit_price_cents The seller’s live listing price when the offer was authored: the ceiling this offer was allowed to charge up to, and the “was” price a discount reads against.
Example
450data.integer requiredlines[]. unit_price_cents What this offer charges per unit; at or below the reference.
Example
400data.string or null requiredlines[]. name Example
Abyssal Nightstalkerdata.string or null requiredlines[]. set_name Example
Portal Second Agedata.string or null requiredlines[]. condition The normalized condition assigned to the card.
Example
Near Mintdata.string or null requiredlines[]. category_name Example
Magic: The Gatheringdata.string or null requiredlines[]. language The language of the card printing.
Example
Englishdata.string or null requiredlines[]. finish The catalog’s printing, under the name the order line snapshot uses.
Example
Normaldata.string or null requiredlines[]. collector_number Example
nulldata.string or null requiredlines[]. rarity The rarity assigned to the card printing.
Example
Uncommon
data.money OrderrequiredAddition Offer Money Show child fieldsHide child fields
data.string requiredmoney. currency The ISO 4217 currency code used for monetary amounts.
Example
CADdata.integer requiredmoney. merchandise_cents The offered cards, AFTER any seller discount.
Example
800data.integer requiredmoney. reference_merchandise_cents The same cards at the seller’s listing prices; above
merchandise_centsby the discount.Example
900data.integer requiredmoney. shipping_cents The shipping DIFFERENCE over shipping already paid for this parcel. EXACTLY 0 when the combined remaining quantities still fit the shipping option already paid for - nothing extra is charged for carriage the buyer has. Otherwise it is the
shipping_upgradeoption’s price less every shipping amount this parcel has already collected, including earlier paid upgrades, so a second upgrade never re-charges the first.Example
0data.integer requiredmoney. purchase_fee_cents The buyer purchase fee at the ORIGINAL order’s frozen rate, on the discounted merchandise.
Example
28data.integer requiredmoney. tax_cents Example
104data.integer requiredmoney. total_cents The EXACT amount the buyer would pay - the sum of the four components above, frozen for the offer’s whole validity period. Nothing may accept for a different figure.
Example
932data.array of object requiredmoney. tax_lines Show child fieldsHide child fields
data.string requiredmoney. tax_lines[]. label Example
HSTdata.number requiredmoney. tax_lines[]. rate The decimal tax rate applied to the taxable amount.
Example
0.13data.integer requiredmoney. tax_lines[]. amount The monetary amount in minor currency units.
Example
104
data.shipping_upgrade Orderor null requiredAddition Offer Shipping Upgrade The shipping option this addition would UPGRADE the parcel to, or null when it rides the one already paid for. All purchased additions share the original parcel: there is never a second shipment. The upgrade becomes the order’s effective option and tracking requirement only when the payment succeeds, and the historical shipping charges are not rewritten - each stays on the payment that collected it. The amount is
money.shipping_cents.Show child fieldsHide child fields
data.string requiredshipping_upgrade. method The upgraded option’s label, in the wording an order’s shipping method uses.
data.boolean requiredshipping_upgrade. is_tracked Whether the upgraded option requires tracking when the order is marked shipped.
data.string or null requirednote The seller’s own words beside the quote; null when none was given.
Example
Two more, at the price you paiddata.string or null requiredrequest_ref The buyer request this offer answered, or null when the seller offered directly.
Example
oar_5c1e9a7f3b2d48e6a0f4c8d1b7e3a925data.integer or null requiredsupport_case_id Example
nulldata.string or null requiredreplaces_offer_ref The offer this one replaced, or null when it replaced none.
Example
nulldata.string requiredsent_at Example
2026-09-04T19:14:03.000Zdata.string requiredexpires_at When the offer and its stock hold stop being valid: 24 hours after
sent_at. Show it.Example
2026-09-05T19:14:03.000Zdata.string or null requiredresolved_by_party Who ended it -
buyeron a decline,selleron a withdrawal or replacement,systemon expiry, which belongs to nobody. Null while outstanding.Constraints: allowed values:
buyer,seller,operator,system,nullExamplenulldata.string or null requiredresolved_at Example
nulldata.string or null requiredresolution_note Example
nulldata.payment Orderor null requiredAddition Payment The buyer’s payment for this offer, or null until one accepts it.
Show child fieldsHide child fields
data.string requiredpayment. payment_ref The opaque public payment id (
oap_…).data.string requiredpayment. status processingmeans the answer is not in yet - a browser redirect does not prove a payment succeeded, so keep asking.succeededmeans the cards are on the order.failedmeans the attempt collected nothing and the offer can be accepted again.blockedmeans a captured payment was screened out and returned; this offer is over.Constraints: allowed values:
processing,succeeded,failed,blockeddata.string requiredpayment. currency The ISO 4217 currency code used for monetary amounts.
data.integer requiredpayment. amount_cents The exact amount the buyer approved, frozen from the offer.
data.string requiredpayment. accepted_at data.string requiredpayment. completes_at When this attempt’s 15-minute completion window closes - distinct from the offer’s own 24 hours. Past it a
processingpayment is UNKNOWN rather than failed, and is reconciled against the provider.data.string or null requiredpayment. resolved_at data.string or null requiredpayment. failure_reason data.integer requiredpayment. attempts Above 1 when a declined card was retried on the same payment.
data.seller_fees OrderrequiredAddition Offer Seller Fees Show child fieldsHide child fields
data.integer requiredseller_fees. commission_cents Commission on the discounted merchandise, capped per UNIT at the order’s frozen cap.
Example
40data.integer requiredseller_fees. processing_fee_cents Processing on the WHOLE additional payment - purchase fee and tax included - plus one fixed component for this one payment. It is never reapplied to the original capture.
Example
57data.integer requiredseller_fees. platform_collected_tax_cents Example
0data.object requiredseller_fees. fee_terms The five terms this quote was priced at: the ORDER’s frozen terms as captured, never today’s Marketplace settings. An order that cannot prove all five cannot carry an addition at all.
Show child fieldsHide child fields
data.integer requiredseller_fees. fee_terms. marketplace_fee_rate_basis_points Example
500data.integer requiredseller_fees. fee_terms. marketplace_fee_per_item_cap_cents Example
2500data.integer requiredseller_fees. fee_terms. purchase_fee_rate_basis_points Example
350data.integer requiredseller_fees. fee_terms. processing_fee_rate_basis_points Example
290data.integer requiredseller_fees. fee_terms. processing_fee_fixed_cents Example
30
data.string requiredorder_id The order the add-on is for (STABLE).
Example
ord_sandbox_01K4A8Y6D4QJH2N3P5R7S9T0VWdata.integer requiredseller_id The seller that owns the order. Use this id to route the event to the right store (STABLE).
Example
42data.string requiredreason What happened to the offer.
sent: the seller sent it and its units are reserved.replaced: a newer offer named inreplaces_offer_refof its successor took its place and its reservation.withdrawn: the seller took it back.declined: the buyer refused it.expired: its 24 hours ran out. In each of those four endings its units are released.accepted: the buyer started paying, and the units stay reserved until the payment resolves.paid: the payment succeeded;order.updatedwith reasonitems_addedannounces the new lines.payment_failed: the attempt collected nothing and the offer is payable again untilexpires_at.payment_blocked: a captured payment was screened out and returned, and the offer is over (STABLE).Constraints: allowed values:
sent,replaced,withdrawn,declined,expired,accepted,paid,payment_failed,payment_blockedExamplesent
api_versionstring requiredThe dated API version used for this payload, frozen when Snapcaster queued the delivery. Changing the platform pin does not change queued events or retries; they keep the same version. See https://developers.snapcaster.ca/guide/api-versioning (STABLE).
Constraints: allowed values:
2026-10Example2026-10