BoxHero API Reference

BoxHero API can be used for retrieving data from outside the app.

Endpoint

https://rest.boxhero-app.com

Request Example

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

In the [Settings] - [Integrations & API] menu, you can issue a new API token. All API requests should have Authorization header as a Bearer {API token}.

Rate limits

We rate limit the API requests as follows.

5 queries per second for each endpoint.

Once you are rate limited, the response will be an error message with the following additional information.

X-Ratelimit-Limit - Maximum queries per minute
X-Ratelimit-Remaining - Remaining queries
X-Ratelimit-Reset - Time to remaining query count reset (in seconds)

Response

Successes

Any response with an HTTP status code within the 200 range means that the API is processed successfully.

Errors

A response with an HTTP status code in the 400 or 500 range means that the request failed to be processed.

400 range: error due to information provided with the request (ex: missing a required parameter).
500 range: error due to a problem associated with the server.

When an error occurs, expect the following response.

{
  "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 : A unique ID to identify the error.
type : A code in the form of a URL that identifies the type of error.
title : Provide the contents of the error in human-readable form.
correlation_id : Points to the ID of the request associated with the error.
others : Additional fields may be included to provide additional information, such as "given" in the example.

Common Error Types

Type	Description
/errors/not-found	Fires when the requested resource cannot be found (for example, an item with a specific ID does not exist).
/errors/invalid-request	There is an error in the parameters provided with the request. (The 'errors' field in the response will contain parameter-specific errors).
/errors/invalid-team-mode	Fires when the requested query cannot be processed in the current team mode (for example, using the location lookup API in basic mode).
/errors/tokens/required	Fires when an API token is required to process the request but is not provided.
/errors/tokens/invalid	Fires if the API token provided is invalid (e.g., the API token has expired).
/errors/too-many-requests	A request has exceeded the rate limit.
/errors/unhandled	There was a server-side error that was not handled.
/errors/core/usage-limit-exceeded	Cannot process request due to usage limit. Please upgrade your team's plan.

Type

Description

/errors/not-found

Fires when the requested resource cannot be found (for example, an item with a specific ID does not exist).

/errors/invalid-request

There is an error in the parameters provided with the request. (The 'errors' field in the response will contain parameter-specific errors).

/errors/invalid-team-mode

Fires when the requested query cannot be processed in the current team mode (for example, using the location lookup API in basic mode).

/errors/tokens/required

Fires when an API token is required to process the request but is not provided.

/errors/tokens/invalid

Fires if the API token provided is invalid (e.g., the API token has expired).

/errors/too-many-requests

A request has exceeded the rate limit.

/errors/unhandled

There was a server-side error that was not handled.

/errors/core/usage-limit-exceeded

Cannot process request due to usage limit. Please upgrade your team's plan.

Error Report and Development Requests

If the API is not working as expected or you experience other difficulties, please send us an email with your response to the email address listed below.

Additionally, if you have any development requests regarding the API, please send us an email to the following:

Email : support@bgpworks.com

Resources

Team

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

GET/v1/teams/linked

Authorization

Response

Body

item*object

The information of the team

Request

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

Query parameters

Response

Body

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

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

Query parameters

Body

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

Body

id*nullable integer

The id of the created item.

Request

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

Path parameters

item_id*nullable integer

The id of the item to be queried

Query parameters

Response

Body

item*object

The minimum unit used for inventory management in BoxHero.

Request

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

Path parameters

item_id*nullable integer

The id of the item to be queried

Body

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

Body

id*nullable integer

The id of the updated item.

Request

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

{}

Delete an existing item.

DELETE/v1/items/{item_id}

Authorization

Path parameters

item_id*nullable integer

The id of the item to be queried

Response

Body

id*nullable integer

The id of the updated item.

Request

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

Response

{}

Item Attributes

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

GET/v1/item-attrs

Authorization

Response

Body

items*array of object

List of items

count*number

Count of items

Request

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
}

Creates a new item attribute.

POST/v1/item-attrs

Authorization

Body

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

Body

id*integer

The unique identifier of the attribute.

Request

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

Path parameters

attr_id*nullable integer

Response

Body

item*object

Specifications used to add additional information to the item.

Request

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

Path parameters

attr_id*nullable integer

The unique identifier of the item attribute spec.

Body

name*string

Response

Body

id*integer

The unique identifier of the item attribute spec.

Request

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

Path parameters

attr_id*nullable integer

The unique identifier of the item attribute spec.

Response

Body

DeleteAttrResponseDTO (object)

Request

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

Body

id*integer

The unique identifier of the item attribute spec.

rank*number

The rank for sorting attributes.

Response

Body

UpdateAttrRanksResponseDTO (object)

Request

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

Query parameters

Response

Body

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

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

Body

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

Body

id*integer

The unique identifier of the partner.

Request

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": "admin@bgpworks.com",
      "phone": "",
      "memo": ""
    }),
});
const data = await response.json();

Response

{}

Retrieve a specific partner.

GET/v1/partners/{partner_id}

Authorization

Path parameters

partner_id*nullable integer

Response

Body

item*object

Partner Information

Request

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": "admin@bgpworks.com",
    "phone": "",
    "memo": ""
  }
}

Updates the partner information.

PUT/v1/partners/{partner_id}

Authorization

Path parameters

partner_id*nullable integer

The id of the partner to be queried

Body

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

Body

id*integer

The unique identifier of the partner.

Request

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": "admin@bgpworks.com",
      "phone": "",
      "memo": ""
    }),
});
const data = await response.json();

Response

{}

Deletes the partner.

DELETE/v1/partners/{partner_id}

Authorization

Path parameters

partner_id*nullable integer

The id of the partner to be queried

Response

Body

DeleteVendorResponseDTO (object)

Request

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

Response

Body

items*array of object

List of items

count*number

Count of items

Request

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

Body

name*string

The name of the location.

memostring

Notes related to the location.

Response

Body

item*object

The place where inventory can be located.

Request

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

Path parameters

location_id*nullable integer

The id of the location to be queried

Response

Body

item*object

The place where inventory can be located.

Request

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

Path parameters

location_id*nullable integer

The id of the location to be queried

Body

namestring

The name of the location.

memostring

Notes related to the location.

Response

Body

UpdateLocationResponseDTO (object)

Request

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

Path parameters

location_id*nullable integer

The id of the location to be queried

Response

Body

DeleteLocationResponseDTO (object)

Request

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

Query parameters

Response

Body

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

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-27T06:32:44.615Z",
      "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

Body

type*enum

inoutmoveadjust

tx_timenullable string (date-time)

partner_idnullable integer

memostring

items*array of object

Response

Body

id*nullable integer

The id of the created transaction.

Request

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

Path parameters

tx_id*nullable integer

Response

Body

item*object

Request

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

Path parameters

tx_id*nullable integer

Body

partner_idnullable integer

memostring

itemsarray of object

revisionnullable integer

Response

Body

id*nullable integer

The id of the updated transaction.

Request

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

Path parameters

tx_id*nullable integer

Body

memostring

revisionnullable integer

Response

Body

DeleteTransactionResponseDTO (object)

Request

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

Query parameters

Response

Body

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

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-27T06:32:44.615Z",
      "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

Body

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

Body

id*nullable integer

The id of the created transaction.

Request

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

Path parameters

tx_id*nullable integer

Response

Body

item*object

Request

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

Path parameters

tx_id*nullable integer

Body

from_location_idnullable integer

to_location_idnullable integer

partner_idnullable integer

memostring

itemsarray of object

revisionnullable integer

Response

Body

id*nullable integer

The id of the updated transaction.

Request

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

Path parameters

tx_id*nullable integer

Body

memostring

revisionnullable integer

Response

Body

DeleteLocationTransactionResponseDTO (object)

Request

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

{}

Last updated 5 months ago