Ship sales order quantities

Creates a partial fulfillment transaction for a sales order.

Public quantities are positive; the core payload is recorded as Stock Out. The target location_id must be covered by the team’s plan. Stock is allowed to go negative if the requested quantity exceeds on-hand.

POSThttps://rest.boxhero-app.com/v1/sales-orders/{order_id}/transactions

Autorización

Authorizationstringobligatorio

Encabezado de autenticación Bearer con el formato Bearer <token>, donde <token> es tu token de API.

Parámetros de ruta

order_idintegerminimum 0, maximum 2147483647obligatorio

Cuerpo de la solicitud

location_idintegerminimum 0, maximum 2147483647obligatorio

transaction_timestringdate-time

memostringmax length 2000

itemsarray of objectobligatorio

Mostrar propiedades

item_idintegerminimum 0, maximum 2147483647

Item id to fulfill. Mutually exclusive with item_sku. Bundles cannot be fulfilled.

item_skustringmin length 1, max length 255

Item SKU to fulfill (case-insensitive). Mutually exclusive with item_id.

quantitynumberobligatorio

Positive quantity; direction is derived by resource.

revisionintegerminimum 0, maximum 9007199254740991

Respuestas

201The created transaction’s id.

idintegerminimum 0, maximum 2147483647obligatorio

Created location transaction id.

401Missing or invalid API token.

idstringobligatorio

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.

typestringobligatorio

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

Valores posibles/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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

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.

instancestringobligatorio

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.

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

402The team is over its location plan limit — it has more locations than the current plan covers (for example, extra locations kept after a downgrade), so this stock write is blocked. The limit is team-wide, so targeting a different location does not help; upgrade the plan or remove excess locations to continue.

idstringobligatorio

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.

typestringobligatorio

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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

instancestringobligatorio

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.

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

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

idstringobligatorio

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.

typestringobligatorio

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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

instancestringobligatorio

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.

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

409The supplied revision is stale.

idstringobligatorio

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.

typestringobligatorio

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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

instancestringobligatorio

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.

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

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

idstringobligatorio

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.

typestringobligatorio

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

titlestringobligatorio

Human-readable summary of the error, in English.

correlationIDstringobligatorio

instancestringobligatorio

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.

Mostrar propiedades

patharray of string | numberobligatorio

messagestringobligatorio

Solicitud

curl --request POST \
  --url 'https://rest.boxhero-app.com/v1/sales-orders/{order_id}/transactions' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "location_id": 47041,
    "transaction_time": "2026-01-16T11:00:00.000Z",
    "memo": "Partial receipt",
    "items": [
      {
        "item_sku": "SKU-12345678",
        "quantity": 60
      }
    ],
    "revision": 3
  }'

const response = await fetch("https://rest.boxhero-app.com/v1/sales-orders/{order_id}/transactions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "location_id": 47041,
    "transaction_time": "2026-01-16T11:00:00.000Z",
    "memo": "Partial receipt",
    "items": [
      {
        "item_sku": "SKU-12345678",
        "quantity": 60
      }
    ],
    "revision": 3
  }),
});
const data = await response.json();

import os
import requests

response = requests.post(
    "https://rest.boxhero-app.com/v1/sales-orders/{order_id}/transactions",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
    json={
        "location_id": 47041,
        "transaction_time": "2026-01-16T11:00:00.000Z",
        "memo": "Partial receipt",
        "items": [
            {
                "item_sku": "SKU-12345678",
                "quantity": 60,
            },
        ],
        "revision": 3,
    },
)
data = response.json()

POST /v1/sales-orders/{order_id}/transactions HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "location_id": 47041,
  "transaction_time": "2026-01-16T11:00:00.000Z",
  "memo": "Partial receipt",
  "items": [
    {
      "item_sku": "SKU-12345678",
      "quantity": 60
    }
  ],
  "revision": 3
}

Respuesta

{
  "id": 14012345
}

{
  "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/core/usage-limit-exceeded",
  "title": "The team is over its location plan limit — it has more locations than the current plan covers (for example, extra locations kept after a downgrade), so this stock write is blocked. The limit is team-wide, so targeting a different location does not help; upgrade the plan or remove excess locations to continue.",
  "instance": "/sales-orders/12345/transactions"
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/not-found",
  "title": "No sales order with the given id was found in this team.",
  "instance": "/sales-orders/12345/transactions"
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/invalid-request",
  "title": "The supplied revision is stale.",
  "instance": "/sales-orders/12345/transactions"
}

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