Skip to content
BuildBase
HTTP API menu

Create a shipping rate for the signed-in user as a seller

Saves a rate: its name, amount and currency, the countries it ships to, and how it is worked out (flat, brackets, per item or a carrier quote).

Warning

Not fully described yet. The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

POST/api/v1/public/me/shipping-rates

Sign-in
A signed-in user's session: send the session id in the x-session-id header.
Rate limit
Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Saves a rate: its name, amount and currency, the countries it ships to, and how it is worked out (flat, brackets, per item or a carrier quote). Answers 404 when the user has not started selling, and 422 when the rate is not valid or the seller already keeps the most rates allowed (5).

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
namestringYes1 to 50 characters-
amountintegerYesat least 0, at most 10000000-
currencystringYes3 to 3 characters-
countriesarray of stringYesat least 1 items, at most 60 items-
minDaysinteger or nullNoat least 0, at most 365-
maxDaysinteger or nullNoat least 0, at most 365-
freeOverinteger or nullNoat least 0, at most 10000000-
pickupbooleanNo--
basisstringNoone of "flat", "weight", "subtotal", "items", "carrier"-
bracketsarray of object or nullNoat most 10 items-
brackets[].upTointeger or nullNoat least 0, at most 9007199254740991-
brackets[].amountintegerNoat least 0, at most 10000000-
perIteminteger or nullNoat least 0, at most 10000000-
carrierobject or nullNo--
carrier.carriersarray of stringNoat most 10 items-
carrier.servicesarray of stringNoat most 20 items-
carrier.markupBpsintegerNoat least 0, at most 10000-
carrier.markupFixedintegerNoat least 0, at most 10000000-
carrier.fallbackAmountinteger or nullNoat least 0, at most 10000000-
carrier.originobjectNo--
carrier.origin.namestringNo1 to 100 characters-
carrier.origin.line1stringNo1 to 200 characters-
carrier.origin.line2string or nullNoat most 200 characters-
carrier.origin.citystringNo1 to 100 characters-
carrier.origin.statestring or nullNoat most 50 characters-
carrier.origin.postalCodestringNo1 to 20 characters-
carrier.origin.countrystringNo2 to 2 characters-
carrier.origin.phonestring or nullNoat most 30 characters-

Example request

Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.

curl -X POST "https://api.console.buildbase.app/api/v1/public/me/shipping-rates" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "amount": 0,
  "currency": "string",
  "countries": [
    "string"
  ]
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/me/shipping-rates',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Example',
      amount: 0,
      currency: 'string',
      countries: ['string'],
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
import os

import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/public/me/shipping-rates",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "name": "Example",
        "amount": 0,
        "currency": "string",
        "countries": [
            "string",
        ],
    },
    timeout=30,
)
response.raise_for_status()
data = response.text

Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

Errors

Each refusal, what it means, and what to do. The request changed nothing.

400 Bad Request

What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.

What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.

Example
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}

401 Unauthorized

What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.

What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

Example
Unauthorized

429 Too Many Requests

What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.

What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}