Receive returned quantities

Creates a partial receiving transaction for a sales return.

Quantities are positive; the transaction direction is Stock In. Recording stock through the transaction endpoints moves the status forward automatically: confirmed becomes in-progress once any quantity is recorded, and done once nothing remains; a done return is never reverted by later transaction changes.

POSThttps://rest.boxhero-app.com/v1/returns/{return_id}/transactions

Xác thực

Authorizationstringbắt buộc

Header xác thực Bearer có dạng Bearer <token>, trong đó <token> là token API của bạn.

Tham số đường dẫn

return_idintegerminimum 0, maximum 2147483647bắt buộc

Nội dung yêu cầu

location_idintegerminimum 0, maximum 2147483647bắt buộc

transaction_timestringdate-time

memostringmax length 2000

itemsarray of objectbắt buộc

Hiển thị thuộc tính

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.

quantitynumberbắt buộc

Positive quantity; direction is derived by resource.

revisionintegerminimum 0, maximum 9007199254740991

Phản hồi

201The created transaction's id.

idintegerminimum 0, maximum 2147483647bắt buộc

Created location transaction id.

400Request validation failed (including an unknown item_sku), or the team is not in LOCATION mode.

idstringbắt buộc

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.

typestringbắt buộc

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

Giá trị có thể có/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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

Request correlation id (rq_ followed by 32 lowercase hex chars, no dashes — e.g. rq_01abf3...). Identical to the X-Correlation-Id response header. A client-supplied X-Correlation-Id request header (at most 128 chars of A-Z a-z 0-9 . _ : / = -) is echoed back here and in the response header; a missing or invalid value is silently replaced with a generated rq_… id.

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

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 request-validation /errors/invalid-request (400) responses. Absent on malformed-JSON 400, 413 body-too-large, and most errors mapped from BoxHero core (which include it only when core supplies an array; this can include 403). Each entry locates a single failure via JSONPath-like path segments and a human-readable message.

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

401Missing, invalid, or revoked API token. /errors/tokens/required when no Bearer token is sent; /errors/tokens/invalid when the token is unknown or revoked (a revoked token may keep working for up to 60 seconds because validation results are cached).

idstringbắt buộc

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.

typestringbắt buộc

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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

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

idstringbắt buộc

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.

typestringbắt buộc

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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

409The supplied revision is stale.

idstringbắt buộc

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.

typestringbắt buộc

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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

413Request body exceeds the size limit (1 MiB). Returned with type /errors/invalid-request.

idstringbắt buộc

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.

typestringbắt buộc

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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

429Rate limit exceeded. Limits are per team and shared by all of the team's API tokens: 5 requests per second and 300 requests per minute. The RateLimit and X-RateLimit-* headers reflect the per-minute window; check them and Retry-After before retrying. This status is also returned when the client IP exceeds 30 failed authentication attempts within 60 seconds, even if the token is valid.

idstringbắt buộc

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.

typestringbắt buộc

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

titlestringbắt buộc

Human-readable summary of the error, in English.

correlationIDstringbắt buộc

instancestring

Pointer to the specific failing resource (e.g. /items/12345). Path-only, no /v1 version prefix. Absent on unknown-path 404 and unexpected 500 responses.

codestring

errorsarray of object

Hiển thị thuộc tính

patharray of string | numberbắt buộc

messagestringbắt buộc

Yêu cầu

curl --request POST \
  --url 'https://rest.boxhero-app.com/v1/returns/{return_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/returns/{return_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/returns/{return_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/returns/{return_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
}

Phản hồi

{
  "id": 14012345
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/invalid-request",
  "title": "Request validation failed (including an unknown item_sku), or the team is not in LOCATION mode.",
  "instance": "/returns/12345/transactions"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "instance": "/returns/12345/transactions",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/not-found",
  "title": "No return with the given id was found in this team.",
  "instance": "/returns/12345/transactions"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/invalid-request",
  "title": "The supplied revision is stale.",
  "instance": "/returns/12345/transactions"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/invalid-request",
  "title": "Request body is too large.",
  "instance": "/returns/12345/transactions"
}

{
  "id": "ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a",
  "correlationID": "rq_01abf3c2b8e44a59be2a9c0f1e7d6a40",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/returns/12345/transactions",
  "retryAfter": 60
}