curl --request POST \
  --url https://api.tagada.io/api/public/v1/shipping-rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "storeId": "store_xxx",
  "shippingRateName": "Free Standard",
  "description": "Delivered in 5–7 business days.",
  "isFree": true,
  "isPickupPoint": false,
  "amount": {
    "USD": {
      "amount": 0
    },
    "EUR": {
      "amount": 0
    }
  },
  "highlighted": true,
  "estimatedDeliveryTime": 7
}
'

{
  "id": "shippingrate_abc123"
}

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

shipping

Create a shipping rate

Create a shipping rate for a store. The new rate is matched against incoming checkout sessions on country, cart subtotal, and total weight, and surfaced via GET /checkout-sessions/:id/shipping-rates.

Conditions interact additively — a customer must satisfy all set thresholds. Leave a field undefined to skip the corresponding check (e.g. omit countryCodes to allow any country).

Requires the org:admin role (granted automatically to UUID-format API keys).

POST

api

public

shipping-rates

curl --request POST \
  --url https://api.tagada.io/api/public/v1/shipping-rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "storeId": "store_xxx",
  "shippingRateName": "Free Standard",
  "description": "Delivered in 5–7 business days.",
  "isFree": true,
  "isPickupPoint": false,
  "amount": {
    "USD": {
      "amount": 0
    },
    "EUR": {
      "amount": 0
    }
  },
  "highlighted": true,
  "estimatedDeliveryTime": 7
}
'

{
  "id": "shippingrate_abc123"
}

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter your API key as: Bearer your-api-key

Body

application/json

shippingRateName

string

required

Minimum string length: 1

amount

object

required

Show child attributes

storeId

string

required

isFree

boolean

required

isPickupPoint

boolean

required

string

description

string

icon

string

highlighted

boolean

shippingRateMinAmount

object | null

Show child attributes

shippingRateMaxAmount

object | null

Show child attributes

shippingRateMinWeight

number | null

shippingRateMaxWeight

number | null

countryCodes

string[]

pickupPointCarriers

string[] | null

estimatedDeliveryTime

integer | null

Required range: x > 0

Response

Successful response

List template types List tax exemptions

Overview

Guides

auth

builder

checkout

payments

block-rules

plugins

plugins-v2

domains

orders

subscriptions

products

events

customers

payment-instruments

3ds

stores

funnels

funnel-sessions

funnel-tracking

health

test

webhooks

promotions

promotion-codes

processors

payment-flows

offers

checkout-offers

radar-sessions

email-templates

shipping

tax-exemptions

Create a shipping rate

Authorizations

Body

Response