Skip to main content

List Shipping Methods

GET 

/api/portal/shipping-methods

List the shipping methods available at checkout, each priced for the current cart and ship-to.

Buyer portal token

Called by a B2B portal buyer with the bearer token POST /api/portal/auth/login returns (or the buyer's feed key) — not with a staff Personal Access Token.

The ship-to is a saved address (ship_to_address_id), an ad-hoc one (ship_to[...]), or — with neither — the account's default shipping address. Methods that do not apply to this cart (destination, subtotal, weight or origin limits) are left out. The account's default method for the ship-to comes first with is_default: true.

Each method: id, name, full_name, delivery_min_days, delivery_max_days, is_pickup, customer_arranges_freight, is_default and price:

  • mode: live_rate, flat, free or on_review.
  • amount (number|null): null = calculated on review (the seller prices shipping after you order); 0 = free.
  • currency, label (Free, Calculated on review, Estimated for a live carrier rate, or null for a plain flat price), is_estimate, delivery_days, delivery_min_days, delivery_max_days.

Top level: free_shipping — the cart's progress toward free shipping (threshold, remaining, met, account_free when the account always ships free), or null when there is no threshold — and defaults (default_id, domestic_id, international_id) so a client can re-pick the default when the address changes.

Send the shown price.amount as expected_shipping_amount on Submit Checkout so a price that moved is confirmed before the order is placed.

Request​

Responses​

OK

Response Headers
    Content-Type