Create a shipping rate in a zone

POST

/admin/v1/shipping/rates

const url = 'https://your-store.example.com/admin/v1/shipping/rates';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"zoneId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","name":"example","type":"flat","amount":1,"currency":"example","freeOverAmount":1,"weightMinGrams":1,"weightMaxGrams":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://your-store.example.com/admin/v1/shipping/rates \
  --header 'Content-Type: application/json' \
  --data '{ "zoneId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "type": "flat", "amount": 1, "currency": "example", "freeOverAmount": 1, "weightMinGrams": 1, "weightMaxGrams": 1 }'

Request Body^required

application/json

object

zoneId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

>= 1 characters <= 128 characters

type

required

string

Allowed values: flat free_over weight_based

amount

required

integer

<= 9007199254740991

currency

required

string

/^[A-Za-z]{3}$/

freeOverAmount

Any of:

integer
null

integer

<= 9007199254740991

weightMinGrams

Any of:

integer
null

integer

<= 9007199254740991

weightMaxGrams

Any of:

integer
null

integer

<= 9007199254740991

Create a shipping rate in a zone

Request Body^required

Responses

201

Create a shipping rate in a zone

Request Body required

Responses

201

Request Body^required