API 레퍼런스

박스히어로 앱 외부에서 박스히어로 내의 데이터를 조회하는 목적으로 사용할 수 있는 공개 API입니다.

Endpoint

https://rest.boxhero-app.com

요청 예시

curl -X 'GET' \
  'https://rest.boxhero-app.com/v1/products?location_ids=12345&location_ids=34567&limit=100' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer test-api-token-123'

Authorization

[결제 및 설정] - [외부 서비스 연동 & API] 메뉴에서 API 토큰을 생성하실 수 있습니다.

모든 API 요청의 Authorization 헤더에 Bearer {API토큰} 형태로 포함해 주세요.

Rate limits

안정적인 서비스 제공을 위해 요청 횟수를 아래와 같이 제한합니다.

• Endpoint별 1초당 5회의 쿼리가 가능합니다.

요청 횟수 제한을 초과한 경우 에러 메세지와 함께 아래 응답 헤더를 반환합니다.

• X-Ratelimit-Limit - 분당 최대 쿼리 횟수

• X-Ratelimit-Remaining - 잔여 쿼리 횟수

• X-Ratelimit-Reset - 잔여 횟수 초기화까지 남은 시간 (초 단위)

Response

성공

HTTP 상태 코드가 200 범위 내에 있는 응답은 모두 API가 정상임을 의미합니다.

실패

HTTP 상태 코드가 400 혹은 500 범위 내에 있는 응답은 요청의 처리가 실패했음을 의미합니다.

• 400 범위 내의 상태 코드는 요청과 함께 제공된 정보에 의해 처리가 실패한 경우를 의미합니다. (예: 필수 매개변수의 누락)

• 500 범위 내의 상태 코드는 서버의 문제로 요청이 정상적으로 처리되지 못했음을 의미합니다.

박스히어로 REST API에서 발생하는 모든 에러는 예외 없이 아래와 같은 형식을 갖추고 있습니다.

{
  "id": "ex_ku3gij67k9xzc8ef6r5esyu5",
  "type": "/errors/tokens/invalid",
  "title": "Authentication token is invalid. Please provide a valid token.",
  "correlation_id": "rq_z4g7dh55ykol7v2cx6homkpd",
  "given": "invalid-token-123"
}

• id : 오류를 식별할 수 있는 고유한 ID입니다.

• type : 오류의 유형을 식별할 수 있는 URL 형태의 코드입니다.

• title : 오류의 내용을 사람이 읽을 수 있는 형태로 제공합니다.

• correlation_id : 해당 오류와 연관된 요청의 ID를 가리킵니다.

• 기타 : 예시에 등장한 'given'과 같이 부가 정보를 제공하기 위해 추가적인 필드가 포함될 수 있습니다.

대표적인 오류 유형들

Type	Description
/errors/not-found	요청한 자원을 찾을 수 없는 경우 발생합니다. (예: 특정 ID의 제품이 존재하지 않음)
/errors/invalid-request	요청과 함께 제공된 매개변수 등에 오류가 있음을 의미합니다. (응답 중 'errors' 필드에 매개변수별 오류들이 포함됩니다.)
/errors/invalid-team-mode	요청한 쿼리가 현재 팀 모드에서 처리될 수 없는 경우 발생합니다. (예: 기본 모드에서 위치 조회 API를 사용함)
/errors/tokens/required	요청을 처리하는 데 API 토큰이 필요한데, 토큰이 제공되지 않은 경우 발생합니다.
/errors/tokens/invalid	제공된 API 토큰이 잘못된 경우 발생합니다. (예: API 토큰이 만료됨)
/errors/too-many-requests	Rate limit을 초과한 요청이 발생한 경우입니다.
/errors/unhandled	처리되지 못한 서버측 에러가 발생한 경우입니다.
/errors/core/usage-limit-exceeded	사용량이 초과되어 요청을 처리할 수 없는 경우를 의미합니다. 해당 팀의 플랜을 업그레이드해주세요.

오류 보고 및 추가 개발 요청

API가 예상과 다르게 작동하거나 부적절한 동작이 발생하는 경우, 아래에 명시된 이메일 주소로 응답 내용을 첨부하여 전송해 주시면 저희가 검토 후 적절한 조치를 취하도록 하겠습니다.

또한, 추가적인 API 개발에 대한 요청이 있으시다면 동일한 이메일로 연락 주시기 바랍니다.

이메일 : [e-mail]

Resources

Team

Retrieves the information of the team linked to the current API token.

GET/v1/teams/linked

Authorization

api-token

Response

200

Body

application/json

item*object

The information of the team

Request

JavaScriptCurl

const response = await fetch('/v1/teams/linked', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "item": {
    "id": 149058,
    "name": "Beauty",
    "mode": 0,
    "currency_symbol": "$",
    "memo": null
  }
}

Items

Retrieve the list of items.

GET/v1/items

Authorization

api-token

Query parameters

Response

200

Body

application/json

items*array of object

List of items

count*number

Count of items

limitnumber

the maximum number of items to be returned in a single request

cursor*nullable integer

points to a specific spot in the items, allowing clients to request the next set of items.

has_more*boolean

The 'has_more' field indicates whether there are more items beyond the current items returned by the request.

Request

JavaScriptCurl

const response = await fetch('/v1/items', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": 14277653,
      "name": "Charlotte Tilbury Airbrush Flawless Finish Setting Powder",
      "barcode": "854561151",
      "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/45cfd563-8879-4932-b552-331af8e010ee",
      "cost": "138",
      "price": "200",
      "attrs": [
        {
          "id": 485697,
          "name": "Brand",
          "type": "text",
          "value": "Charlotte Tilbury"
        },
        {
          "id": 485086,
          "name": "Minimum Stock",
          "type": "number",
          "value": 10
        },
        {
          "id": 489457,
          "name": "Barcode-Shopify",
          "type": "barcode",
          "value": "2044754769156"
        },
        {
          "id": 489458,
          "name": "Expiration Date",
          "type": "date",
          "value": "2023-07-21"
        }
      ],
      "quantity": 85
    },
    {
      "id": 14277654,
      "name": "Charlotte Tilbury Airbrush Flawless Longwear Foundation 10 Cool",
      "barcode": "854561154",
      "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/555470db-399c-436e-b882-2e255ab5c084",
      "cost": "100",
      "price": "200",
      "attrs": [
        {
          "id": 412746,
          "name": "Category",
          "type": "text",
          "value": "Makeup"
        },
        {
          "id": 485697,
          "name": "Brand",
          "type": "text",
          "value": "Charlotte Tilbury"
        }
      ],
      "quantity": 271
    },
    {
      "id": 14277655,
      "name": "Charlotte Tilbury Airbrush Flawless Longwear Foundation 6 Warm",
      "barcode": "854561152",
      "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/6c97693e-4e99-4e9a-9221-db07cf10ac99",
      "cost": "100",
      "price": "200",
      "attrs": [
        {
          "id": 412746,
          "name": "Category",
          "type": "text",
          "value": "Makeup"
        },
        {
          "id": 485697,
          "name": "Brand",
          "type": "text",
          "value": "Charlotte Tilbury"
        }
      ],
      "quantity": 329
    },
    {
      "id": 14277656,
      "name": "Charlotte Tilbury Airbrush Flawless Longwear Foundation 9 Cool",
      "barcode": "854561153",
      "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/7ab5bee4-779b-4e4b-b72d-e11f5e16e300",
      "cost": "100",
      "price": "200",
      "attrs": [
        {
          "id": 412746,
          "name": "Category",
          "type": "text",
          "value": "Makeup"
        },
        {
          "id": 485697,
          "name": "Brand",
          "type": "text",
          "value": "Charlotte Tilbury"
        }
      ],
      "quantity": 225
    },
    {
      "id": 14277657,
      "name": "Charlotte Tilbury Eyeliner - Pillow Talk Collection",
      "barcode": "854561150",
      "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/4ecfb54a-2a7b-4984-bb3d-36c7cfd4f33d",
      "cost": "0",
      "price": "200",
      "attrs": [
        {
          "id": 412746,
          "name": "Category",
          "type": "text",
          "value": "Makeup"
        },
        {
          "id": 485697,
          "name": "Brand",
          "type": "text",
          "value": "Charlotte Tilbury"
        }
      ],
      "quantity": 1372
    }
  ],
  "count": 5,
  "limit": 5,
  "cursor": 14277657,
  "has_more": false
}

Creates a new item.

POST/v1/items

Authorization

api-token

Query parameters

Body

application/json

name*string

The name of the item.

barcodestring

The barcode used when scanning the item.

photo_urlstring

The photo of the item.

coststring

The purchase cost of the item.

pricestring

The sale price of the item.

attrsobject

The attributes of the item.

quantitynullable number

The initial quantity of the item.

Response

200

Body

application/json

id*nullable integer

The id of the created item.

Request

JavaScriptCurl

const response = await fetch('/v1/items', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Finish Setting Powder",
      "barcode": "2097678335587",
      "photo_url": "https://your.image-server.com/item_image.png",
      "cost": "12345.234",
      "price": "12345.323",
      "attrs": {
        "485086": 10,
        "489458": "2023-07-21"
      },
      "quantity": 32
    }),
});
const data = await response.json();

Response

{}

Retrieve information about a specific item.

GET/v1/items/{item_id}

Authorization

api-token

Path parameters

item_id*nullable integer

The id of the item to be queried

Query parameters

Response

200

Body

application/json

item*object

The minimum unit used for inventory management in BoxHero.

Request

JavaScriptCurl

const response = await fetch('/v1/items/{item_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "item": {
    "id": 14277653,
    "name": "Charlotte Tilbury Airbrush Flawless Finish Setting Powder",
    "barcode": "854561151",
    "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/45cfd563-8879-4932-b552-331af8e010ee",
    "cost": "138",
    "price": "200",
    "attrs": [
      {
        "id": 485697,
        "name": "Brand",
        "type": "text",
        "value": "Charlotte Tilbury"
      },
      {
        "id": 485086,
        "name": "Minimum Stock",
        "type": "number",
        "value": 10
      },
      {
        "id": 489457,
        "name": "Barcode-Shopify",
        "type": "barcode",
        "value": "2044754769156"
      },
      {
        "id": 489458,
        "name": "Expiration Date",
        "type": "date",
        "value": "2023-07-21"
      }
    ],
    "quantity": 85
  }
}

Updates the details of an existing item.

PUT/v1/items/{item_id}

Authorization

api-token

Path parameters

item_id*nullable integer

The id of the item to be queried

Body

application/json

namestring

The name of the item.

barcodestring

The barcode used when scanning the item.

photo_urlstring

The photo of the item.

coststring

The purchase cost of the item.

pricestring

The sale price of the item.

attrsobject

The attributes of the item. If you want to delete a specific attribute, please assign a null value.

Response

200

Body

application/json

id*nullable integer

The id of the updated item.

Request

JavaScriptCurl

const response = await fetch('/v1/items/{item_id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Finish Setting Powder",
      "barcode": "2097678335587",
      "photo_url": "https://your.image-server.com/item_image.png",
      "cost": "12345.234",
      "price": "12345.323",
      "attrs": {
        "485083": null,
        "485086": 10,
        "489458": "2023-07-21"
      }
    }),
});
const data = await response.json();

Response

{}

Retrieves the list of item attribute specifications used within the team.

GET/v1/item-attrs

Authorization

api-token

Response

200

Body

application/json

items*array of object

List of items

count*number

Count of items

Request

JavaScriptCurl

const response = await fetch('/v1/item-attrs', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": 485698,
      "attr_name": "Size",
      "attr_type": "number",
      "rank": 6
    },
    {
      "id": 485086,
      "attr_name": "Minimum Stock",
      "attr_type": "number",
      "rank": 2
    },
    {
      "id": 485697,
      "attr_name": "Brand",
      "attr_type": "text",
      "rank": 1
    },
    {
      "id": 412746,
      "attr_name": "Category",
      "attr_type": "text",
      "rank": 0
    }
  ],
  "count": 4
}

Item Attributes

Creates a new item attribute.

POST/v1/item-attrs

Authorization

api-token

Body

application/json

name*string

type*enum

Indicates the type of value that can be assigned to the item attributes.

textdatenumberbarcode

rank*number

The rank for sorting attributes.

Response

200

Body

application/json

id*integer

The unique identifier of the attribute.

Request

JavaScriptCurl

const response = await fetch('/v1/item-attrs', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Brand",
      "type": "text",
      "rank": 1
    }),
});
const data = await response.json();

Response

{}

Retrieve a specific item attribute.

GET/v1/item-attrs/{attr_id}

Authorization

api-token

Path parameters

attr_id*nullable integer

Response

200

Body

application/json

item*object

Specifications used to add additional information to the item.

Request

JavaScriptCurl

const response = await fetch('/v1/item-attrs/{attr_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "item": {
    "attr_type": "text",
    "attr_name": "text",
    "rank": 0
  }
}

Updates information of a specific item attribute.

PUT/v1/item-attrs/{attr_id}

Authorization

api-token

Path parameters

attr_id*nullable integer

The unique identifier of the item attribute spec.

Body

application/json

name*string

Response

200

Body

application/json

id*integer

The unique identifier of the item attribute spec.

Request

JavaScriptCurl

const response = await fetch('/v1/item-attrs/{attr_id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Brand"
    }),
});
const data = await response.json();

Response

{}

Deletes a specific item attribute.

DELETE/v1/item-attrs/{attr_id}

Authorization

api-token

Path parameters

attr_id*nullable integer

The unique identifier of the item attribute spec.

Response

200

Body

application/json

DeleteAttrResponseDTO (object)

Request

JavaScriptCurl

const response = await fetch('/v1/item-attrs/{attr_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{}

Changes the order between item attributes.

PUT/v1/item-attrs/ranks

Authorization

api-token

Body

application/json

id*integer

The unique identifier of the item attribute spec.

rank*number

The rank for sorting attributes.

Response

200

Body

application/json

UpdateAttrRanksResponseDTO (object)

Request

JavaScriptCurl

const response = await fetch('/v1/item-attrs/ranks', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": 1,
        "rank": 2
      },
      {
        "id": 2,
        "rank": 1
      }
    ]),
});
const data = await response.json();

Response

{}

Partners

Retrieves a list of partners.

GET/v1/partners

Authorization

api-token

Query parameters

Response

200

Body

application/json

items*array of object

List of items

count*number

Count of items

limitnumber

the maximum number of items to be returned in a single request

cursor*nullable integer

points to a specific spot in the items, allowing clients to request the next set of items.

has_more*boolean

The 'has_more' field indicates whether there are more items beyond the current items returned by the request.

Request

JavaScriptCurl

const response = await fetch('/v1/partners', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": 431485,
      "type": 0,
      "name": "ATS",
      "address": "",
      "email": "",
      "phone": "",
      "memo": ""
    },
    {
      "id": 431488,
      "type": 1,
      "name": "the real",
      "address": "",
      "email": "",
      "phone": "",
      "memo": ""
    },
    {
      "id": 458739,
      "type": 1,
      "name": "shine",
      "address": "",
      "email": "",
      "phone": "",
      "memo": ""
    },
    {
      "id": 458740,
      "type": 0,
      "name": "RBS",
      "address": "",
      "email": "",
      "phone": "",
      "memo": ""
    },
    {
      "id": 478991,
      "type": 1,
      "name": "Amazon",
      "address": "",
      "email": "",
      "phone": "",
      "memo": ""
    },
    {
      "id": 535330,
      "type": 0,
      "name": "072140011611",
      "address": "",
      "email": "",
      "phone": "",
      "memo": ""
    }
  ],
  "count": 6,
  "limit": 6,
  "cursor": 535330,
  "has_more": false
}

Adds a new partner.

POST/v1/partners

Authorization

api-token

Body

application/json

type*nullable integer

Type of the partner - (0: Supplier, 1: Customer)

namenullable string

Name of the partner

phonenullable string

Contact number of the partner

emailnullable string

Email address of the partner

addressnullable string

Address of the partner

memonullable string

Notes for the vendor

Response

200

Body

application/json

id*integer

The unique identifier of the partner.

Request

JavaScriptCurl

const response = await fetch('/v1/partners', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": 0,
      "name": "BGPworks",
      "address": "3003 North First Street Suite 221 San Jose, CA 95134",
      "email": "[e-mail]",
      "phone": "",
      "memo": ""
    }),
});
const data = await response.json();

Response

{}

Retrieve a specific partner.

GET/v1/partners/{partner_id}

Authorization

api-token

Path parameters

partner_id*nullable integer

Response

200

Body

application/json

item*object

Partner Information

Request

JavaScriptCurl

const response = await fetch('/v1/partners/{partner_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "item": {
    "id": 478991,
    "type": 1,
    "name": "BGPworks",
    "address": "3003 North First Street Suite 221 San Jose, CA 95134",
    "email": "[e-mail]",
    "phone": "",
    "memo": ""
  }
}

Updates the partner information.

PUT/v1/partners/{partner_id}

Authorization

api-token

Path parameters

partner_id*nullable integer

The id of the partner to be queried

Body

application/json

namenullable string

Name of the partner

phonenullable string

Contact number of the partner

emailnullable string

Email address of the partner

addressnullable string

Address of the partner

memonullable string

Notes for the vendor

Response

200

Body

application/json

id*integer

The unique identifier of the partner.

Request

JavaScriptCurl

const response = await fetch('/v1/partners/{partner_id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "BGPworks",
      "address": "3003 North First Street Suite 221 San Jose, CA 95134",
      "email": "[e-mail]",
      "phone": "",
      "memo": ""
    }),
});
const data = await response.json();

Response

{}

Deletes the partner.

DELETE/v1/partners/{partner_id}

Authorization

api-token

Path parameters

partner_id*nullable integer

The id of the partner to be queried

Response

200

Body

application/json

DeleteVendorResponseDTO (object)

Request

JavaScriptCurl

const response = await fetch('/v1/partners/{partner_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{}

Locations

Retrieve the list of locations.

GET/v1/locations

Authorization

api-token

Response

200

Body

application/json

items*array of object

List of items

count*number

Count of items

Request

JavaScriptCurl

const response = await fetch('/v1/locations', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": 47043,
      "name": "store",
      "quantity": 2471,
      "memo": ""
    },
    {
      "id": 47042,
      "name": "office",
      "quantity": 84,
      "memo": ""
    },
    {
      "id": 47041,
      "name": "warehouse",
      "quantity": 9923,
      "memo": ""
    }
  ],
  "count": 3
}

Creates a new location.

POST/v1/locations

Authorization

api-token

Body

application/json

name*string

The name of the location.

memostring

Notes related to the location.

Response

200

Body

application/json

item*object

The place where inventory can be located.

Request

JavaScriptCurl

const response = await fetch('/v1/locations', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "store",
      "memo": ""
    }),
});
const data = await response.json();

Response

{
  "item": {
    "id": 47043,
    "name": "store",
    "quantity": 2471,
    "memo": ""
  }
}

Retrieve information about a specific location.

GET/v1/locations/{location_id}

Authorization

api-token

Path parameters

location_id*nullable integer

The id of the location to be queried

Response

200

Body

application/json

item*object

The place where inventory can be located.

Request

JavaScriptCurl

const response = await fetch('/v1/locations/{location_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "item": {
    "id": 47043,
    "name": "store",
    "quantity": 2471,
    "memo": ""
  }
}

Creates a new location.

PUT/v1/locations/{location_id}

Authorization

api-token

Path parameters

location_id*nullable integer

The id of the location to be queried

Body

application/json

namestring

The name of the location.

memostring

Notes related to the location.

Response

200

Body

application/json

UpdateLocationResponseDTO (object)

Request

JavaScriptCurl

const response = await fetch('/v1/locations/{location_id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "store",
      "memo": ""
    }),
});
const data = await response.json();

Response

{}

Delete an existing location.

DELETE/v1/locations/{location_id}

Authorization

api-token

Path parameters

location_id*nullable integer

The id of the location to be queried

Response

200

Body

application/json

DeleteLocationResponseDTO (object)

Request

JavaScriptCurl

const response = await fetch('/v1/locations/{location_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{}

Transactions (Basic mode)

Retrieve the list of transactions.

GET/v1/txs

Authorization

api-token

Query parameters

Response

200

Body

application/json

items*array of object

List of items

count*number

Count of items

limitnumber

the maximum number of items to be returned in a single request

cursor*nullable integer

points to a specific spot in the items, allowing clients to request the next set of items.

has_more*boolean

The 'has_more' field indicates whether there are more items beyond the current items returned by the request.

Request

JavaScriptCurl

const response = await fetch('/v1/txs', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "items": [
    {
      "type": "in",
      "partner": {
        "name": "text",
        "deleted": false
      },
      "created_at": "2024-04-27T18:41:29.657Z",
      "created_by": {
        "name": "text",
        "deleted": false
      },
      "url": "https://example.com",
      "memo": "text"
    }
  ],
  "count": 0,
  "limit": 0,
  "has_more": false
}

Add a new transaction.

POST/v1/txs

Authorization

api-token

Body

application/json

type*enum

inoutmoveadjust

tx_timenullable string (date-time)

partner_idnullable integer

memostring

items*array of object

Response

200

Body

application/json

id*nullable integer

The id of the created transaction.

Request

JavaScriptCurl

const response = await fetch('/v1/txs', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "out",
      "tx_time": "2023-11-09T01:18:32.407Z",
      "partner_id": 509973,
      "memo": "memo",
      "items": [
        {
          "item_id": 214582,
          "quantity": 3
        },
        {
          "item_id": 231213,
          "quantity": 2
        }
      ]
    }),
});
const data = await response.json();

Response

{}

Retrieve a specific transaction.

GET/v1/txs/{tx_id}

Authorization

api-token

Path parameters

tx_id*nullable integer

Response

200

Body

application/json

item*object

Request

JavaScriptCurl

const response = await fetch('/v1/txs/{tx_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "item": {
    "id": 16160911,
    "type": "in",
    "items": [
      {
        "id": 14277699,
        "name": "belif Cleansing Gel Oil Enriched",
        "quantity": 2,
        "deleted": false,
        "new_stock_level": 40
      },
      {
        "id": 14277698,
        "name": "belif Aqua Bomb Jelly Cleanser",
        "quantity": 2,
        "deleted": false,
        "new_stock_level": 207
      }
    ],
    "created_at": "2023-08-14T05:14:29.499Z",
    "created_by": {
      "id": 201345,
      "name": "corp",
      "deleted": false
    },
    "count_of_items": 2,
    "total_quantity": 4,
    "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911",
    "revision": 0
  }
}

Update a specific transaction.

PUT/v1/txs/{tx_id}

Authorization

api-token

Path parameters

tx_id*nullable integer

Body

application/json

partner_idnullable integer

memostring

itemsarray of object

revisionnullable integer

Response

200

Body

application/json

id*nullable integer

The id of the updated transaction.

Request

JavaScriptCurl

const response = await fetch('/v1/txs/{tx_id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "partner_id": 509973,
      "items": [
        {
          "item_id": 214582,
          "quantity": 3
        }
      ]
    }),
});
const data = await response.json();

Response

{}

Delete a specific transaction.

DELETE/v1/txs/{tx_id}

Authorization

api-token

Path parameters

tx_id*nullable integer

Body

application/json

memostring

revisionnullable integer

Response

200

Body

application/json

DeleteTransactionResponseDTO (object)

Request

JavaScriptCurl

const response = await fetch('/v1/txs/{tx_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "memo": "memo...",
      "revision": 0
    }),
});
const data = await response.json();

Response

{}

Transactions (Location mode)

Retrieve the list of transactions. (location mode)

GET/v1/location-txs

Authorization

api-token

Query parameters

Response

200

Body

application/json

items*array of object

List of items

count*number

Count of items

limitnumber

the maximum number of items to be returned in a single request

cursor*nullable integer

points to a specific spot in the items, allowing clients to request the next set of items.

has_more*boolean

The 'has_more' field indicates whether there are more items beyond the current items returned by the request.

Request

JavaScriptCurl

const response = await fetch('/v1/location-txs', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "items": [
    {
      "type": "in",
      "partner": {
        "name": "text",
        "deleted": false
      },
      "created_at": "2024-04-27T18:41:29.657Z",
      "created_by": {
        "name": "text",
        "deleted": false
      },
      "url": "https://example.com",
      "memo": "text",
      "form_location": {
        "name": "text",
        "deleted": false
      },
      "to_location": {
        "name": "text",
        "deleted": false
      }
    }
  ],
  "count": 0,
  "limit": 0,
  "has_more": false
}

Add a new transaction. (location mode)

POST/v1/location-txs

Authorization

api-token

Body

application/json

type*enum

inoutmoveadjust

tx_timenullable string (date-time)

from_location_idnullable integer

to_location_id*nullable integer

partner_idnullable integer

memostring

items*array of object

Response

200

Body

application/json

id*nullable integer

The id of the created transaction.

Request

JavaScriptCurl

const response = await fetch('/v1/location-txs', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "move",
      "to_location_id": 47038,
      "from_location_id": 47037,
      "items": [
        {
          "item_id": 14290445,
          "quantity": 2
        }
      ],
      "memo": "memo.."
    }),
});
const data = await response.json();

Response

{}

Retrieve a specific transaction. (location mode)

GET/v1/location-txs/{tx_id}

Authorization

api-token

Path parameters

tx_id*nullable integer

Response

200

Body

application/json

item*object

Request

JavaScriptCurl

const response = await fetch('/v1/location-txs/{tx_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Token"
    },
});
const data = await response.json();

Response

{
  "item": {
    "id": 3692714,
    "type": "move",
    "from_location": {
      "id": 52765,
      "name": "Warehouse 2",
      "deleted": false
    },
    "to_location": {
      "id": 52766,
      "name": "Warehouse 3",
      "deleted": false
    },
    "items": [
      {
        "id": 14873303,
        "name": "Auto liner 3.5mm",
        "quantity": 1,
        "deleted": false,
        "from_location_new_stock_level": -1,
        "to_location_new_stock_level": 1
      }
    ],
    "created_at": "2023-04-25T05:42:27.545Z",
    "created_by": {
      "id": 176829,
      "name": "Joy Kim",
      "deleted": false
    },
    "count_of_items": 1,
    "total_quantity": 1,
    "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714",
    "revision": 0
  }
}

Update a specific transaction. (location mode)

PUT/v1/location-txs/{tx_id}

Authorization

api-token

Path parameters

tx_id*nullable integer

Body

application/json

from_location_idnullable integer

to_location_idnullable integer

partner_idnullable integer

memostring

itemsarray of object

revisionnullable integer

Response

200

Body

application/json

id*nullable integer

The id of the updated transaction.

Request

JavaScriptCurl

const response = await fetch('/v1/location-txs/{tx_id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "to_location_id": 47038,
      "from_location_id": 47037,
      "partner_id": 32123,
      "items": [
        {
          "item_id": 14290445,
          "quantity": 2
        }
      ],
      "memo": "memo.."
    }),
});
const data = await response.json();

Response

{}

Delete a specific transaction. (location mode)

DELETE/v1/location-txs/{tx_id}

Authorization

api-token

Path parameters

tx_id*nullable integer

Body

application/json

memostring

revisionnullable integer

Response

200

Body

application/json

DeleteLocationTransactionResponseDTO (object)

Request

JavaScriptCurl

const response = await fetch('/v1/location-txs/{tx_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "memo": "memo...",
      "revision": 1
    }),
});
const data = await response.json();

Response

{}