shipping_options
What it costs to ship an order, and the token that lets you buy it. REQUIRED before checkout_intent on anything physical: an escrow hold is struck at an exact amount and cannot be topped up afterwards, so the postage has to be inside it. Pass the same items and the same ship_to you will check out with, and you get the carrier services this shop can actually sell to that address, each with a price and a rate_token. Pick one, then pass ITS token to checkout_intent. The token is bound to the address you priced against — retype the address and it stops matching, by design, so quote once and reuse the object. This reads and signs: it opens nothing, holds nothing, and no money moves on this call. A digital-only order needs none of this.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| shop | Yes | the shop's slug | |
| items | Yes | the same lines you will check out with — the bag decides the box | |
| ship_to | Yes | where it is going — the SAME object you will hand checkout_intent | |
| buyer_email | Yes | the buyer's REAL email — the same one checkout_intent will carry |