Create a bundle

Creates a bundle from existing items.

Bundles cannot contain other bundles and do not create stock on their own.

POSThttps://rest.boxhero-app.com/v1/bundles

Autorisierung

Authorizationstringerforderlich

Bearer-Authentifizierungsheader im Format Bearer <token>, wobei <token> Ihr API-Token ist.

Anfragetext

namestringmin length 1, max length 255erforderlich

Bundle display name.

skustringmin length 1, max length 255erforderlich

Stock Keeping Unit. Must be unique across active bundles in the team.

barcodestringmax length 255

Primary bundle barcode.

photo_urlstringmax length 2048

Public URL of the bundle photo.

memostringmax length 2000

Free-text memo.

coststring

Cost per bundle, as a decimal string.

pricestring

Selling price per bundle, as a decimal string.

componentsarray of objecterforderlich

Component list. When provided on update, this replaces the full component list.

Eigenschaften anzeigen

item_idintegerminimum 0, maximum 2147483647

Component item id. Mutually exclusive with item_sku.

item_skustringmin length 1, max length 255

Component item SKU (case-insensitive). Mutually exclusive with item_id.

quantitynumbererforderlich

Quantity of this item required per bundle.

Antworten

201The created bundle’s id.

idintegerminimum 0, maximum 2147483647erforderlich

Id of the newly created bundle.

400Request validation failed, such as duplicate SKU or duplicate/invalid component items.

idstringerforderlich

Unique exception id (ex_ followed by 32 lowercase hex chars, no dashes — e.g. ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a). Quote this in support tickets so we can find the request in our logs.

typestringerforderlich

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

Mögliche Werte/errors/not-found/errors/invalid-request/errors/invalid-team-mode/errors/tokens/invalid/errors/tokens/required/errors/too-many-requests/errors/core/usage-limit-exceeded/errors/core/forbidden/errors/core/unhandled/errors/unhandled

titlestringerforderlich

Human-readable summary of the error, in English.

correlationIDstringerforderlich

Request correlation id (rq_ followed by 32 lowercase hex chars, no dashes — e.g. rq_01abf3...). Identical to the X-Correlation-Id response header. Pass an X-Correlation-Id request header to thread your trace through to ours.

instancestringerforderlich

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. not-available-for-api-token on 403). Use this for fine-grained branching after dispatching on type.

errorsarray of object

Field-level error details. Present on /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Eigenschaften anzeigen

patharray of string | numbererforderlich

messagestringerforderlich

401Missing or invalid API token.

idstringerforderlich

Unique exception id (ex_ followed by 32 lowercase hex chars, no dashes — e.g. ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a). Quote this in support tickets so we can find the request in our logs.

typestringerforderlich

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

titlestringerforderlich

Human-readable summary of the error, in English.

correlationIDstringerforderlich

instancestringerforderlich

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

errorsarray of object

Field-level error details. Present on /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Eigenschaften anzeigen

patharray of string | numbererforderlich

messagestringerforderlich

429Rate limit exceeded. Check RateLimit, Retry-After, and X-RateLimit-* response headers before retrying.

idstringerforderlich

Unique exception id (ex_ followed by 32 lowercase hex chars, no dashes — e.g. ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a). Quote this in support tickets so we can find the request in our logs.

typestringerforderlich

Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on title.

titlestringerforderlich

Human-readable summary of the error, in English.

correlationIDstringerforderlich

instancestringerforderlich

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix.

codestring

errorsarray of object

Field-level error details. Present on /errors/invalid-request (400) responses. Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Eigenschaften anzeigen

patharray of string | numbererforderlich

messagestringerforderlich

Anfrage

curl --request POST \
  --url 'https://rest.boxhero-app.com/v1/bundles' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Starter kit",
    "sku": "BUNDLE-STARTER",
    "barcode": "8801234567890",
    "cost": "12.50",
    "price": "29.99",
    "components": [
      {
        "item_id": 14290445,
        "quantity": 1
      },
      {
        "item_id": 14290446,
        "quantity": 2
      }
    ]
  }'

const response = await fetch("https://rest.boxhero-app.com/v1/bundles", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Starter kit",
    "sku": "BUNDLE-STARTER",
    "barcode": "8801234567890",
    "cost": "12.50",
    "price": "29.99",
    "components": [
      {
        "item_id": 14290445,
        "quantity": 1
      },
      {
        "item_id": 14290446,
        "quantity": 2
      }
    ]
  }),
});
const data = await response.json();

import os
import requests

response = requests.post(
    "https://rest.boxhero-app.com/v1/bundles",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
    json={
        "name": "Starter kit",
        "sku": "BUNDLE-STARTER",
        "barcode": "8801234567890",
        "cost": "12.50",
        "price": "29.99",
        "components": [
            {
                "item_id": 14290445,
                "quantity": 1,
            },
            {
                "item_id": 14290446,
                "quantity": 2,
            },
        ],
    },
)
data = response.json()

POST /v1/bundles HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Starter kit",
  "sku": "BUNDLE-STARTER",
  "barcode": "8801234567890",
  "cost": "12.50",
  "price": "29.99",
  "components": [
    {
      "item_id": 14290445,
      "quantity": 1
    },
    {
      "item_id": 14290446,
      "quantity": 2
    }
  ]
}

Antwort

{
  "id": 4042
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/invalid-request",
  "title": "Request validation failed, such as duplicate SKU or duplicate/invalid component items.",
  "instance": "/bundles"
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/bundles",
  "retryAfter": 60
}