Ship units of an order the signed-in user sold
Records a shipment by hand (carrier, tracking number, a PDF label the seller uploaded) or buys a label from the app's label provider; with no lines named it...
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/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).
Records a shipment by hand (carrier, tracking number, a PDF label the seller uploaded) or buys a label from the app's label provider; with no lines named it carries every unit left. Answers 409 when the order is not paid, is picked up, was refused for its address, has an address held for confirmation (send confirmAddress: true) or has another shipment being made; 422 when the lines, tracking or label are not valid; 503 when the app has not connected its label provider.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
id | string | Yes | matches ^[a-f0-9]{24}$ | - |
Send the body as application/json. The body is optional.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
lines | array of object | No | at most 100 items | - |
lines[].lineKey | string | No | 1 to 64 characters | - |
lines[].quantity | integer | No | at least 1, at most 1000 | - |
provider | string | No | one of "manual", "easypost", "shippo" | - |
carrier | string or null | No | at most 50 characters | - |
service | string or null | No | at most 80 characters | - |
trackingNumber | string or null | No | at most 64 characters | - |
trackingUrl | string or null | No | at most 500 characters | - |
labelFileId | string or null | No | matches ^[a-f0-9]{24}$ | - |
from | object | No | - | - |
from.name | string | No | 1 to 100 characters | - |
from.line1 | string | No | 1 to 200 characters | - |
from.line2 | string or null | No | at most 200 characters | - |
from.city | string | No | 1 to 100 characters | - |
from.state | string or null | No | at most 50 characters | - |
from.postalCode | string | No | 1 to 20 characters | - |
from.country | string | No | 2 to 2 characters | - |
from.phone | string or null | No | at most 30 characters | - |
parcel | object | No | - | - |
parcel.weightOz | number | No | more than 0, at most 2400 | - |
parcel.lengthIn | number | No | more than 0, at most 200 | - |
parcel.widthIn | number | No | more than 0, at most 200 | - |
parcel.heightIn | number | No | more than 0, at most 200 | - |
contentsType | string | No | one of "merchandise", "gift", "documents", "sample", "returned_goods", "other" | - |
confirmAddress | boolean | No | - | - |
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/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/me/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/me/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.textResponses
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.
{
"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.
Unauthorized429 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.
{
"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:
Related
- All Me operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
me.sales.shipments.createin public-v1.json