snapcasterDevelopers

    API reference · Types

    OrderAdditionOfferMoney

    Part of the response of GET /orders/{orderId}/addition-offers, POST /orders/{orderId}/addition-offers and POST /orders/{orderId}/addition-offers/{offerRef}/withdraw and the payload of order.addition_offer.updated.

    Type: object

    Example

    Schema example: from the GET /orders/{orderId}/addition-offers response
    {
  "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
    }
  ]
}

    Fields

    currency string required

    The ISO 4217 currency code used for monetary amounts.

    Example CAD

    merchandise_cents integer required

    The offered cards, AFTER any seller discount.

    Example 800

    reference_merchandise_cents integer required

    The same cards at the seller’s listing prices; above merchandise_cents by the discount.

    Example 900

    shipping_cents integer required

    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_upgrade option’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 0

    purchase_fee_cents integer required

    The buyer purchase fee at the ORIGINAL order’s frozen rate, on the discounted merchandise.

    Example 28

    tax_cents integer required

    Example 104

    total_cents integer required

    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 932

    tax_lines array of object required
    Show child fieldsHide child fields
    tax_lines[].label string required

    Example HST

    tax_lines[].rate number required

    The decimal tax rate applied to the taxable amount.

    Example 0.13

    tax_lines[].amount integer required

    The monetary amount in minor currency units.

    Example 104

    Used by