Create a partner

Creates a new partner.

Set type to 0 for a supplier (used in Stock In) or 1 for a customer (used in Stock Out). May return 402 when the team’s partner quota has been reached.

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

การยืนยันสิทธิ์

Authorizationstringจำเป็น

เฮดเดอร์การยืนยันตัวตนแบบ Bearer ในรูปแบบ Bearer <token> โดย <token> คือ โทเค็น API ของคุณ

เนื้อหาคำขอ

typeintegerminimum 0, maximum 1จำเป็น

Partner classification. 0 = supplier (used in Stock In transactions), 1 = customer (used in Stock Out transactions).

namestringmin length 1, max length 255จำเป็น

Partner display name. 1–255 characters.

phonestringmax length 255

Phone number. Optional.

emailstringmax length 255

Email address. Optional.

addressstringmax length 2000

Postal address. Optional.

memostringmax length 2000

Free-text memo. Optional.

การตอบกลับ

201The created partner’s id.

idintegerminimum 0, maximum 2147483647จำเป็น

Id of the newly created partner.

400Request validation failed. See the response body for field-level errors.

idstringจำเป็น

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.

typestringจำเป็น

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

ค่าที่เป็นไปได้/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

titlestringจำเป็น

Human-readable summary of the error, in English.

correlationIDstringจำเป็น

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.

instancestringจำเป็น

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

401Missing or invalid API token.

idstringจำเป็น

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.

typestringจำเป็น

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

titlestringจำเป็น

Human-readable summary of the error, in English.

correlationIDstringจำเป็น

instancestringจำเป็น

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

402The team’s partner quota has been reached. Upgrade the plan or delete an existing partner to continue.

idstringจำเป็น

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.

typestringจำเป็น

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

titlestringจำเป็น

Human-readable summary of the error, in English.

correlationIDstringจำเป็น

instancestringจำเป็น

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

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

idstringจำเป็น

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.

typestringจำเป็น

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

titlestringจำเป็น

Human-readable summary of the error, in English.

correlationIDstringจำเป็น

instancestringจำเป็น

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.

แสดงพร็อพเพอร์ตี

patharray of string | numberจำเป็น

messagestringจำเป็น

คำขอ

curl --request POST \
  --url 'https://rest.boxhero-app.com/v1/partners' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "type": 0,
    "name": "Acme Supply Co.",
    "address": "123 Market St, San Francisco, CA 94103",
    "email": "orders@acme-supply.example.com",
    "phone": "+1-415-555-0101",
    "memo": ""
  }'

const response = await fetch("https://rest.boxhero-app.com/v1/partners", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": 0,
    "name": "Acme Supply Co.",
    "address": "123 Market St, San Francisco, CA 94103",
    "email": "orders@acme-supply.example.com",
    "phone": "+1-415-555-0101",
    "memo": ""
  }),
});
const data = await response.json();

import os
import requests

response = requests.post(
    "https://rest.boxhero-app.com/v1/partners",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
    json={
        "type": 0,
        "name": "Acme Supply Co.",
        "address": "123 Market St, San Francisco, CA 94103",
        "email": "orders@acme-supply.example.com",
        "phone": "+1-415-555-0101",
        "memo": "",
    },
)
data = response.json()

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

{
  "type": 0,
  "name": "Acme Supply Co.",
  "address": "123 Market St, San Francisco, CA 94103",
  "email": "orders@acme-supply.example.com",
  "phone": "+1-415-555-0101",
  "memo": ""
}

การตอบกลับ

{
  "id": 431485
}

{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/invalid-request",
  "title": "Request validation failed. See the response body for field-level errors.",
  "instance": "/partners"
}

{
  "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's partner quota has been reached. Upgrade the plan or delete an existing partner to continue.",
  "instance": "/partners"
}

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