Update an item

Partially updates an item.

Only the fields you include are changed. Use attrs[<id>] = null to remove a single custom attribute value. Stock levels are not modified here — issue a transaction instead.

PUThttps://rest.boxhero-app.com/v1/items/{item_id}

Autorisierung

Authorizationstringerforderlich

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

Pfadparameter

item_idintegerminimum 0, maximum 2147483647erforderlich

Anfragetext

namestringmin length 1, max length 255

New display name. 1–255 characters.

skustringmax length 255

New SKU. Pass an empty string to clear. Must remain unique within the team.

barcodestringmax length 255

New primary barcode.

photo_urlstringmax length 2048

New photo URL. Pass an empty string to clear.

coststring

Cost per unit, as a decimal string. Range ±999,999,999.999 with up to 3 decimal places. Example: "12345.234". The team’s currency is reported on GET /v1/teams/linked.

pricestring

Selling price per unit, as a decimal string. Range ±999,999,999.999 with up to 3 decimal places. Example: "12345.234". The team’s currency is reported on GET /v1/teams/linked.

attrsarray of object

Patch attribute values. Official request format is [{ "id": <attr_id>, "value": <value> }, ...]. Set value to null to remove that attribute. The legacy object form { "<attr_id>": <value> } is still accepted for compatibility.

Eigenschaften anzeigen

idintegerminimum 0, maximum 2147483647erforderlich

Attribute spec id.

valuestring | numbernullableerforderlich

Attribute value (typed per the spec); null removes the attribute.

Antworten

200The updated item’s id.

idintegerminimum 0, maximum 2147483647erforderlich

Id of the updated item.

400Request validation failed (e.g. duplicate SKU, invalid attribute value, file-type attribute). See the response body for field-level errors.

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

404No item with the given id was found in this team.

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 PUT \
  --url 'https://rest.boxhero-app.com/v1/items/{item_id}' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Finish Setting Powder",
    "sku": "SKU-12345678",
    "attrs": [
      {
        "id": 485697,
        "value": null
      },
      {
        "id": 485086,
        "value": 20
      }
    ]
  }'

const response = await fetch("https://rest.boxhero-app.com/v1/items/{item_id}", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Finish Setting Powder",
    "sku": "SKU-12345678",
    "attrs": [
      {
        "id": 485697,
        "value": null
      },
      {
        "id": 485086,
        "value": 20
      }
    ]
  }),
});
const data = await response.json();

import os
import requests

response = requests.put(
    "https://rest.boxhero-app.com/v1/items/{item_id}",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
    json={
        "name": "Finish Setting Powder",
        "sku": "SKU-12345678",
        "attrs": [
            {
                "id": 485697,
                "value": None,
            },
            {
                "id": 485086,
                "value": 20,
            },
        ],
    },
)
data = response.json()

PUT /v1/items/{item_id} HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Finish Setting Powder",
  "sku": "SKU-12345678",
  "attrs": [
    {
      "id": 485697,
      "value": null
    },
    {
      "id": 485086,
      "value": 20
    }
  ]
}

Antwort

{
  "id": 14290445
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/invalid-request",
  "title": "Request validation failed (e.g. duplicate SKU, invalid attribute value, file-type attribute). See the response body for field-level errors.",
  "instance": "/items/12345"
}

{
  "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/not-found",
  "title": "No item with the given id was found in this team.",
  "instance": "/items/12345"
}

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