Skip to content
Developers

Create a shipping rate

POST
/shipping-rates/add
curl --request POST \
  --url https://acme.mykreezalid.com/api/v1/shipping-rates/add \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "Standard", "description": "example", "cart_info": "example", "price": 6.95, "step_price": 1.45, "always_selected": false, "is_online": true, "pickup_delivery": false, "shipping_fees_paid_out_to_supplier": false, "apply_to_all_countries": true, "restricted_countries": [ "FR", "BE" ], "carrier_alias": "example", "tracking_number_pattern": "example", "tracking_url": "example", "sort_priority": 0, "external_id": "example" }'

Creates a shipping rate. The answer always has the HTTP status 200: check success.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
title

Name shown to customers

string

Example 

Standard
description
string
cart_info

Details shown in the cart, returned as details_in_cart

string
price
number

Example 

6.95
step_price

Price added for each additional item

number

Example 

1.45
always_selected
boolean
is_online
boolean
default: true
pickup_delivery

The customer collects the order in person: no shipping address is asked

boolean
shipping_fees_paid_out_to_supplier
boolean
apply_to_all_countries
boolean
default: true
restricted_countries
Array<string>

Example 

[
  "FR",
  "BE"
]
carrier_alias
string
tracking_number_pattern
string
tracking_url
string
sort_priority
integer
0
external_id
string

Responses

Section titled “Responses”

200

Section titled “200”

Whether the shipping rate has been created

Media typeapplication/json
object
id

Identifier of the new rate; null when it was not created

integer
nullable
success
boolean
message
string
content

A shipping rate customers can choose at checkout.

object
id

Shipping rate’s unique identifier

integer
object
string
title

Name shown to customers

string
nullable
description

Short description

string
nullable
details_in_cart

Details shown in the cart

string
nullable
price

Price of the shipping

number
nullable
step_price

Price added for each additional item

number
nullable
always_selected

Whether the rate is selected by default

boolean
nullable
is_online

Whether the rate is offered

boolean
nullable
pickup_delivery

Whether the customer collects the order in person, so that no shipping address is needed

boolean
nullable
shipping_fees_paid_out_to_supplier

Whether the shipping fees are paid out to the vendor (otherwise they go to the marketplace)

boolean
nullable
apply_to_all_countries

Whether the rate applies to every country

boolean
nullable
restricted_countries

Countries the rate is restricted to, when it does not apply to every country

Array<string>
nullable
carrier_alias

Identifier of the carrier

string
nullable
tracking_number_pattern

Expected format of the tracking numbers

string
nullable
tracking_url

Tracking URL of the carrier

string
nullable
sort_priority

Position of the rate in lists, lowest first

integer
nullable
external_id

Your own identifier for this rate

string
nullable

Example 

{
  "id": 432424,
  "success": true,
  "message": "Shipping rate created",
  "content": {
    "id": 432424,
    "object": "ShippingRate",
    "title": "Standard",
    "price": 6.95,
    "step_price": 1.45,
    "restricted_countries": [
      "FR",
      "BE"
    ],
    "sort_priority": 0,
    "external_id": "ABC123"
  }
}