Skip to content
BuildBase
HTTP API menu

Create a shipment for one of the workspace's sales

Needs workspace:selling:manage.

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/workspaces/workspaceId/sales/id/shipments

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).

Needs workspace:selling:manage. Ships the named units (or every unit left) by hand with a carrier and tracking number, or with a label bought from the app's shipping provider; the first shipment on its way marks the order shipped. Refused with 409 when the order is unpaid, collected, refused for its region, its address is held (confirmAddress) or another shipment is in progress, and 502 SHIPPING_PROVIDER_UNAVAILABLE when the label cannot be bought.

Request

Path parameters

FieldTypeRequiredConstraintsDescription
workspaceIdstringYes--
idstringYesmatches ^[a-f0-9]{24}$-

Send the body as application/json. The body is optional.

Body

FieldTypeRequiredConstraintsDescription
linesarray of objectNoat most 100 items-
lines[].lineKeystringNo1 to 64 characters-
lines[].quantityintegerNoat least 1, at most 1000-
providerstringNoone of "manual", "easypost", "shippo"-
carrierstring or nullNoat most 50 characters-
servicestring or nullNoat most 80 characters-
trackingNumberstring or nullNoat most 64 characters-
trackingUrlstring or nullNoat most 500 characters-
labelFileIdstring or nullNomatches ^[a-f0-9]{24}$-
fromobjectNo--
from.namestringNo1 to 100 characters-
from.line1stringNo1 to 200 characters-
from.line2string or nullNoat most 200 characters-
from.citystringNo1 to 100 characters-
from.statestring or nullNoat most 50 characters-
from.postalCodestringNo1 to 20 characters-
from.countrystringNo2 to 2 characters-
from.phonestring or nullNoat most 30 characters-
parcelobjectNo--
parcel.weightOznumberNomore than 0, at most 2400-
parcel.lengthInnumberNomore than 0, at most 200-
parcel.widthInnumberNomore than 0, at most 200-
parcel.heightInnumberNomore than 0, at most 200-
contentsTypestringNoone of "merchandise", "gift", "documents", "sample", "returned_goods", "other"-
confirmAddressbooleanNo--

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/workspaces/YOUR_WORKSPACE_ID/sales/YOUR_ID/shipments" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "lines": [
    {
      "lineKey": "string",
      "quantity": 1
    }
  ],
  "provider": "manual",
  "carrier": "string"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/sales/YOUR_ID/shipments',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      lines: [
        {
          lineKey: 'string',
          quantity: 1,
        },
      ],
      provider: 'manual',
      carrier: '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/workspaces/YOUR_WORKSPACE_ID/sales/YOUR_ID/shipments",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "lines": [
            {
                "lineKey": "string",
                "quantity": 1,
            },
        ],
        "provider": "manual",
        "carrier": "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
}

Events

A successful call can send these webhook events to the endpoints that subscribe to them: