Update a sales order by order number

Looks up a sales order by order number and applies the same partial update as the by-id endpoint.

Whitespace is ignored and letters are uppercased.

PUThttps://rest.boxhero-app.com/v1/sales-orders/by-number/{order_number}

Autorização

Authorizationstringobrigatório

Cabeçalho de autenticação Bearer no formato Bearer <token>, em que <token> é o seu token de API.

Parâmetros de caminho

order_numberstringobrigatório

Order number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores.

Corpo da requisição

order_numberstring

Order number. Whitespace is ignored and letters are uppercased. Use only letters, numbers, hyphens, and underscores. Auto-generated when omitted on create.

partner_idintegerminimum 0, maximum 2147483647, nullable

Supplier for purchase orders or customer for sales orders. Pass null to clear.

order_timestring | number | string

ISO 8601 timestamp or millisecond epoch.

estimated_timestring | number | stringnullable

ISO 8601 timestamp or millisecond epoch.

memostringmax length 2000

custom_fieldsarray of object

Ordered custom field name-value pairs.

Mostrar propriedades

namestringobrigatório

valuestringobrigatório

currency_codestringmin length 3, max length 3

ISO 4217 currency code.

itemsarray of object

Replacement order lines. Omit to preserve the current lines. Within a line, include id to update an existing line in place, or omit it to add a new line.

Mostrar propriedades

idintegerminimum 0, maximum 2147483647

Existing line id to update in place. Omit to add a new line.

item_idintegerminimum 0, maximum 2147483647

Existing item id. Mutually exclusive with item_sku, bundle_id, bundle_sku.

item_skustringmin length 1, max length 255

Item SKU (case-insensitive). Mutually exclusive with item_id, bundle_id, bundle_sku.

bundle_idintegerminimum 0, maximum 2147483647

Existing bundle id. Mutually exclusive with item_id, item_sku, bundle_sku.

bundle_skustringmin length 1, max length 255

Bundle SKU (case-sensitive). Mutually exclusive with item_id, item_sku, bundle_id.

quantitynumberobrigatório

Quantity. May include up to four decimal places in core data.

pricestringobrigatório

taxLineTaxInputnullable

Tax configuration for an order or return line.

Mostrar propriedades

namestringmin length 1, max length 255obrigatório

ratestringobrigatório

Decimal value encoded as a string to avoid floating point drift.

inclusivebooleanobrigatório

discountLineDiscountInputnullable

Discount configuration for an order or return line.

Mostrar propriedades

namestringmin length 1, max length 255obrigatório

typestringobrigatório

Discount type. "percent" is a 0-100 percentage; "amount" is an absolute amount.

Valores possíveispercentamount

valuestringobrigatório

Decimal value encoded as a string to avoid floating point drift.

costsarray of OrderCostInput

Replacement additional costs, in display order. Omit to preserve the current costs; pass an empty array to remove all of them.

Mostrar propriedades

namestringmin length 1, max length 255obrigatório

Cost name.

amountstringobrigatório

Cost amount. Negative for a deduction such as a prepayment. Additional costs carry no tax or discount, so the amount is the final value.

revisionintegerminimum 0, maximum 9007199254740991

Latest observed revision. Omit to use the current revision.

Respostas

200The updated sales order’s id.

idintegerminimum 0, maximum 2147483647obrigatório

Updated order id.

400Request validation failed or core rejected the update.

idstringobrigatório

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.

typestringobrigatório

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

Valores possíveis/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

titlestringobrigatório

Human-readable summary of the error, in English.

correlationIDstringobrigatório

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.

instancestringobrigatório

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 propriedades

patharray of string | numberobrigatório

messagestringobrigatório

401Missing or invalid API token.

idstringobrigatório

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.

typestringobrigatório

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

titlestringobrigatório

Human-readable summary of the error, in English.

correlationIDstringobrigatório

instancestringobrigatório

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 propriedades

patharray of string | numberobrigatório

messagestringobrigatório

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

idstringobrigatório

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.

typestringobrigatório

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

titlestringobrigatório

Human-readable summary of the error, in English.

correlationIDstringobrigatório

instancestringobrigatório

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 propriedades

patharray of string | numberobrigatório

messagestringobrigatório

409The supplied revision is stale.

idstringobrigatório

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.

typestringobrigatório

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

titlestringobrigatório

Human-readable summary of the error, in English.

correlationIDstringobrigatório

instancestringobrigatório

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 propriedades

patharray of string | numberobrigatório

messagestringobrigatório

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

idstringobrigatório

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.

typestringobrigatório

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

titlestringobrigatório

Human-readable summary of the error, in English.

correlationIDstringobrigatório

instancestringobrigatório

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 propriedades

patharray of string | numberobrigatório

messagestringobrigatório

Requisição

curl --request PUT \
  --url 'https://rest.boxhero-app.com/v1/sales-orders/by-number/{order_number}' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "memo": "Updated restock note",
    "costs": [
      {
        "name": "Shipping fee",
        "amount": "45.00"
      }
    ],
    "items": [
      {
        "id": 700101,
        "item_sku": "SKU-12345678",
        "quantity": 120,
        "price": "19.99"
      }
    ],
    "revision": 3
  }'

const response = await fetch("https://rest.boxhero-app.com/v1/sales-orders/by-number/{order_number}", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "memo": "Updated restock note",
    "costs": [
      {
        "name": "Shipping fee",
        "amount": "45.00"
      }
    ],
    "items": [
      {
        "id": 700101,
        "item_sku": "SKU-12345678",
        "quantity": 120,
        "price": "19.99"
      }
    ],
    "revision": 3
  }),
});
const data = await response.json();

import os
import requests

response = requests.put(
    "https://rest.boxhero-app.com/v1/sales-orders/by-number/{order_number}",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
    json={
        "memo": "Updated restock note",
        "costs": [
            {
                "name": "Shipping fee",
                "amount": "45.00",
            },
        ],
        "items": [
            {
                "id": 700101,
                "item_sku": "SKU-12345678",
                "quantity": 120,
                "price": "19.99",
            },
        ],
        "revision": 3,
    },
)
data = response.json()

PUT /v1/sales-orders/by-number/{order_number} HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "memo": "Updated restock note",
  "costs": [
    {
      "name": "Shipping fee",
      "amount": "45.00"
    }
  ],
  "items": [
    {
      "id": 700101,
      "item_sku": "SKU-12345678",
      "quantity": 120,
      "price": "19.99"
    }
  ],
  "revision": 3
}

Resposta

{
  "id": 90101
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/invalid-request",
  "title": "Request validation failed or core rejected the update.",
  "instance": "/sales-orders/by-number/PO-1001"
}

{
  "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 sales order with the given order number was found in this team.",
  "instance": "/sales-orders/by-number/PO-1001"
}

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

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