Skip to main content
POST
/
api
/
public
/
v1
/
shipping-rates
Create a shipping rate
curl --request POST \
  --url http://app.localhost:3000/api/public/v1/shipping-rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shippingRateName": "<string>",
  "amount": {},
  "storeId": "<string>",
  "isFree": true,
  "isPickupPoint": true,
  "id": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "highlighted": true,
  "shippingRateMinAmount": {},
  "shippingRateMaxAmount": {},
  "shippingRateMinWeight": 123,
  "shippingRateMaxWeight": 123,
  "countryCodes": [
    "<string>"
  ],
  "pickupPointCarriers": [
    "<string>"
  ],
  "estimatedDeliveryTime": 1
}
'
{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
shippingRateName
string
required
Minimum string length: 1
amount
object
required
storeId
string
required
isFree
boolean
required
isPickupPoint
boolean
required
id
string
description
string
icon
string
highlighted
boolean
shippingRateMinAmount
object
shippingRateMaxAmount
object
shippingRateMinWeight
number | null
shippingRateMaxWeight
number | null
countryCodes
string[]
pickupPointCarriers
string[] | null
estimatedDeliveryTime
integer | null
Required range: x > 0

Response

Successful response