Skip to main content

Setting up Shipping Methods

Relevant API endpoints

To set up shipping method(s) with topi, you'll need to call an endpoint. But first, let's understand what's a shipping method and why it's needed by topi.

What is a shipping method?

DHL Standard, DHL Express, UPS Standard, UPS Express, etc. are shipping methods.

The shipping method does not include the price; the price, along with the shipping method, can be sent when creating a topi offer on topi so that you retain control over shipping cost calculations per checkout.

Why topi needs your shipping methods

As mentioned in Syncing your Catalog, topi is unlike simple payment solutions like PayPal or Klarna. Your customers will have the option to custommize their product's rental terms and select add-on services (e.g. topi Care, a product insurance add-on), which will alter the total price at checkout.

To give customers the best experience, topi shows an order summary on the topi Hosted Checkout as the last step before they place an order, and this summary includes your shipping price. This is why topi needs your shipping methods.

At every checkout, when you create a topi offer, you have the option of sending shipping information. Here, you'll specify the seller_shipping_reference and the price:

"shipping": {
"price": {
"currency": "EUR",
"gross": 119_000,
"net": 100_000
},
"seller_shipping_reference": "DHL Standard"
},

If you're alarmed by the large number in the example, fret not, our sellers don't typically charge a hundred thousand euros for shipping! We just use basis points for numbers.


Now that you have your catalog synced and shipping methods created, you are ready to start calling the Seller API for topi prices and displaying them on your ecommerce store.