Create a shipping method

POST https://api.tamio.com/v2/shippings/create

Creates a new shipping method with geographic targeting, pricing, and optional bundling rules for multi-item orders. Bundling rules define quantity-based pricing tiers using either range (from–to) or max (up to N) logic.

Body Parameters

label string*

Display name for the shipping method.

price integer*

Base shipping price in smallest currency unit (e.g. cents).

currency string*

ISO currency code.

active boolean*

Whether this shipping method is available for selection.

destination array of string*

Country or region codes where shipping is available (ISO 3166-1 alpha-2).

states array of string

State/province restrictions within destinations.

postcodes array of string

Postcode restrictions (up to 10 characters each).

bundling_rules array of BundlingRuleInput

Quantity-based pricing tiers for multi-item orders. Each rule is either a range (from–to) or a max (up to N items) type. Only one max rule is allowed. Ranges must not overlap.

JSON

{ "bundling_rules": [ { "cost": 200, "cost_rule": "fixed", "type": "range", "max": null, "from": 2, "to": 5 } ] }

cost integer*

Shipping cost for this tier (smallest currency unit).

cost_rule string*

unit — cost per item; fixed — flat rate for the tier.

unitfixed

type string*

range — quantity between from and to; max — quantity up to max.

rangemax

max integer

Maximum quantity (required when type is max, null otherwise).

from integer

Starting quantity (required when type is range, null otherwise).

to integer

Ending quantity (required when type is range, null otherwise).

Responses

200 Shipping method created

Shipping method created

status integer

shipping Shipping

400 Validation or business-logic error.

Validation or business-logic error.

Code	Description
`1003`	A max bundling rule already exists
`1004`	Bundling rule starting range is greater than ending range
`1005`	Bundling rules have conflicting or overlapping ranges
`10239`	Shipping method quota reached (fair use limit)

status integer

error string

error_code integer

401 Missing or invalid API key

List all shipping methods

Update a shipping method

/shippings/create

1 const response = await fetch("https://api.tamio.com/v2/shippings/create", {
2   method: "POST",
3   headers: {
4     "Authorization": "Bearer YOUR_API_KEY",
5     "Content-Type": "application/json"
6   },
7   body: JSON.stringify({
8     "label": "Standard Delivery",
9     "price": 500,
10     "currency": "EUR",
11     "active": true,
12     "destination": [
13       "US",
14       "GB",
15       "DE"
16     ],
17     "states": [
18       "CA",
19       "NY"
20     ],
21     "postcodes": [
22       "90210",
23       "10001"
24     ],
25     "bundling_rules": [
26       {
27         "cost": 200,
28         "cost_rule": "fixed",
29         "type": "range",
30         "max": null,
31         "from": 2,
32         "to": 5
33       }
34     ]
35   })
36 });
37 const data = await response.json();

1 require "uri"
2 require "net/http"
3 require "json"
4 
5 url = URI("https://api.tamio.com/v2/shippings/create")
6 
7 https = Net::HTTP.new(url.host, url.port)
8 https.use_ssl = true
9 
10 request = Net::HTTP::Post.new(url)
11 request["Accept"] = "application/json"
12 request["Authorization"] = "Bearer YOUR_API_KEY"
13 request["Content-Type"] = "application/json"
14 request.body = {
15   label: "Standard Delivery",
16   price: 500,
17   currency: "EUR",
18   active: true,
19   destination: ["US", "GB", "DE"],
20   states: ["CA", "NY"],
21   postcodes: ["90210", "10001"],
22   bundling_rules: [
23     {
24       cost: 200,
25       cost_rule: "fixed",
26       type: "range",
27       max: nil,
28       from: 2,
29       to: 5
30     }
31   ]
32 }.to_json
33 
34 response = https.request(request)
35 puts response.read_body

Responses

{
  "status": 200,
  "shipping": {
    "id": "999e4567-e89b-12d3-a456-426614174000",
    "label": "Standard Delivery",
    "object": "shipping",
    "currency": "EUR",
    "destination": [
      "US",
      "GB",
      "DE"
    ],
    "price": 500,
    "has_bundling": true,
    "postcodes": [
      "90210",
      "10001"
    ],
    "states": [
      "CA",
      "NY"
    ],
    "bundling_rules": [
      {
        "type": "range",
        "cost": 200,
        "cost_rule": "fixed",
        "max": null,
        "from": 2,
        "to": 5
      }
    ],
    "active": true,
    "has_notes": false
  }
}

1	const response = await fetch("https://api.tamio.com/v2/shippings/create", {
2	method: "POST",
3	headers: {
4	"Authorization": "Bearer YOUR_API_KEY",
5	"Content-Type": "application/json"
6	},
7	body: JSON.stringify({
8	"label": "Standard Delivery",
9	"price": 500,
10	"currency": "EUR",
11	"active": true,
12	"destination": [
13	"US",
14	"GB",
15	"DE"
16	],
17	"states": [
18	"CA",
19	"NY"
20	],
21	"postcodes": [
22	"90210",
23	"10001"
24	],
25	"bundling_rules": [
26	{
27	"cost": 200,
28	"cost_rule": "fixed",
29	"type": "range",
30	"max": null,
31	"from": 2,
32	"to": 5
33	}
34	]
35	})
36	});
37	const data = await response.json();

1	require "uri"
2	require "net/http"
3	require "json"
4
5	url = URI("https://api.tamio.com/v2/shippings/create")
6
7	https = Net::HTTP.new(url.host, url.port)
8	https.use_ssl = true
9
10	request = Net::HTTP::Post.new(url)
11	request["Accept"] = "application/json"
12	request["Authorization"] = "Bearer YOUR_API_KEY"
13	request["Content-Type"] = "application/json"
14	request.body = {
15	label: "Standard Delivery",
16	price: 500,
17	currency: "EUR",
18	active: true,
19	destination: ["US", "GB", "DE"],
20	states: ["CA", "NY"],
21	postcodes: ["90210", "10001"],
22	bundling_rules: [
23	{
24	cost: 200,
25	cost_rule: "fixed",
26	type: "range",
27	max: nil,
28	from: 2,
29	to: 5
30	}
31	]
32	}.to_json
33
34	response = https.request(request)
35	puts response.read_body