Private API reference

Inventory

Private Inventory API endpoints

Endpoints

GET/inventory_items
POST/inventory_items
GET/inventory_items/{inventory_item_id}
PUT/inventory_items/{inventory_item_id}
POST/inventory_items/{inventory_item_id}/archive
GET/inventory_groups
POST/inventory_groups
GET/inventory_groups/{inventory_group_id}
PUT/inventory_groups/{inventory_group_id}

Get list of inventory items

GET /inventory_items

Query parameters

pageoptionalinteger

Page number

Defaults to 1.

per_pageoptionalinteger

Items per page

Defaults to 15.

group_idoptionalinteger

Filter by inventory group ID

statusoptionalboolean

Filter by active status

queryoptionalstring

Search by name or SKU

Returnsobject

Inventory items list response

curl https://api.subbly.co/private/v1/inventory_items \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "sku": "sku",
      "name": "name",
      "description": "description",
      "photo_url": "photo_url",
      "buy_price": 1,
      "msrp_price": 1,
      "stock_count": 1,
      "status": true,
      "inventory_group_id": 1,
      "inventory_group": {
        "id": 1,
        "name": "name"
      },
      "weight": 1.5,
      "width": 1.5,
      "height": 1.5,
      "depth": 1.5,
      "hs_code": "hs_code",
      "country_origin_id": 1,
      "priority": 1,
      "tags": [
        {
          "id": 1,
          "value": "value"
        }
      ],
      "low_stock": true,
      "out_of_stock": true,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ]
}

Create a new inventory item

POST /inventory_items

Request body

nameRequiredstring

skuRequiredstring

Unique SKU within the shop

stock_countRequiredinteger

statusRequiredinteger

Possible values: 0, 1.

priorityoptionalinteger | null

inventory_group_idoptionalinteger | null

buy_priceoptionalinteger | null

Buy price in cents

msrp_priceoptionalinteger | null

MSRP price in cents

descriptionoptionalstring | null

photo_urloptionalstring | null

Format: url.

weightoptionalnumber | null

widthoptionalnumber | null

heightoptionalnumber | null

depthoptionalnumber | null

hs_codeoptionalstring | null

Harmonized System code

country_origin_idoptionalinteger | null

Country of origin ID

tagsoptionalobject

ReturnsInventoryItem

Inventory item created successfully

curl -X POST https://api.subbly.co/private/v1/inventory_items \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "name",
  "sku": "sku",
  "stock_count": 1,
  "status": 0,
  "priority": 1,
  "inventory_group_id": 1,
  "buy_price": 0,
  "msrp_price": 0,
  "description": "description",
  "photo_url": "https://example.com",
  "weight": 0.01,
  "width": 0.01,
  "height": 0.01,
  "depth": 0.01,
  "hs_code": "hs_code",
  "country_origin_id": 1,
  "tags": {
    "create": [
      {
        "value": "value"
      }
    ]
  }
}'

Response

{
  "id": 1,
  "sku": "sku",
  "name": "name",
  "description": "description",
  "photo_url": "photo_url",
  "buy_price": 1,
  "msrp_price": 1,
  "stock_count": 1,
  "status": true,
  "inventory_group_id": 1,
  "inventory_group": {
    "id": 1,
    "name": "name"
  },
  "weight": 1.5,
  "width": 1.5,
  "height": 1.5,
  "depth": 1.5,
  "hs_code": "hs_code",
  "country_origin_id": 1,
  "priority": 1,
  "tags": [
    {
      "id": 1,
      "value": "value"
    }
  ],
  "low_stock": true,
  "out_of_stock": true,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

Get inventory item by ID

GET /inventory_items/{inventory_item_id}

Path parameters

inventory_item_idRequiredinteger

Inventory item ID

ReturnsInventoryItem

Inventory item object response

curl https://api.subbly.co/private/v1/inventory_items/{inventory_item_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "sku": "sku",
  "name": "name",
  "description": "description",
  "photo_url": "photo_url",
  "buy_price": 1,
  "msrp_price": 1,
  "stock_count": 1,
  "status": true,
  "inventory_group_id": 1,
  "inventory_group": {
    "id": 1,
    "name": "name"
  },
  "weight": 1.5,
  "width": 1.5,
  "height": 1.5,
  "depth": 1.5,
  "hs_code": "hs_code",
  "country_origin_id": 1,
  "priority": 1,
  "tags": [
    {
      "id": 1,
      "value": "value"
    }
  ],
  "low_stock": true,
  "out_of_stock": true,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

Update an inventory item

PUT /inventory_items/{inventory_item_id}

Path parameters

inventory_item_idRequiredinteger

Inventory item ID

Request body

nameoptionalstring

skuoptionalstring

stock_countoptionalinteger

statusoptionalinteger

Possible values: 0, 1.

priorityoptionalinteger | null

inventory_group_idoptionalinteger

buy_priceoptionalinteger | null

Buy price in cents

msrp_priceoptionalinteger | null

MSRP price in cents

descriptionoptionalstring | null

photo_urloptionalstring | null

Format: url.

weightoptionalnumber | null

widthoptionalnumber | null

heightoptionalnumber | null

depthoptionalnumber | null

hs_codeoptionalstring | null

country_origin_idoptionalinteger | null

tagsoptionalobject

ReturnsInventoryItem

Inventory item updated successfully

curl -X PUT https://api.subbly.co/private/v1/inventory_items/{inventory_item_id} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "name",
  "sku": "sku",
  "stock_count": 1,
  "status": 0,
  "priority": 1,
  "inventory_group_id": 1,
  "buy_price": 0,
  "msrp_price": 0,
  "description": "description",
  "photo_url": "https://example.com",
  "weight": 0.01,
  "width": 0.01,
  "height": 0.01,
  "depth": 0.01,
  "hs_code": "hs_code",
  "country_origin_id": 1,
  "tags": {
    "create": [
      {
        "value": "value"
      }
    ],
    "delete": [
      {
        "id": 1
      }
    ]
  }
}'

Response

{
  "id": 1,
  "sku": "sku",
  "name": "name",
  "description": "description",
  "photo_url": "photo_url",
  "buy_price": 1,
  "msrp_price": 1,
  "stock_count": 1,
  "status": true,
  "inventory_group_id": 1,
  "inventory_group": {
    "id": 1,
    "name": "name"
  },
  "weight": 1.5,
  "width": 1.5,
  "height": 1.5,
  "depth": 1.5,
  "hs_code": "hs_code",
  "country_origin_id": 1,
  "priority": 1,
  "tags": [
    {
      "id": 1,
      "value": "value"
    }
  ],
  "low_stock": true,
  "out_of_stock": true,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

Archive an inventory item

POST /inventory_items/{inventory_item_id}/archive

Path parameters

inventory_item_idRequiredinteger

Inventory item ID

ReturnsInventoryItem

Inventory item archived

curl -X POST https://api.subbly.co/private/v1/inventory_items/{inventory_item_id}/archive \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "sku": "sku",
  "name": "name",
  "description": "description",
  "photo_url": "photo_url",
  "buy_price": 1,
  "msrp_price": 1,
  "stock_count": 1,
  "status": true,
  "inventory_group_id": 1,
  "inventory_group": {
    "id": 1,
    "name": "name"
  },
  "weight": 1.5,
  "width": 1.5,
  "height": 1.5,
  "depth": 1.5,
  "hs_code": "hs_code",
  "country_origin_id": 1,
  "priority": 1,
  "tags": [
    {
      "id": 1,
      "value": "value"
    }
  ],
  "low_stock": true,
  "out_of_stock": true,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

Get list of inventory groups

GET /inventory_groups

Query parameters

pageoptionalinteger

Page number

Defaults to 1.

per_pageoptionalinteger

Items per page

Defaults to 15.

queryoptionalstring

Search by name or brand name

Returnsobject

Inventory groups list response

curl https://api.subbly.co/private/v1/inventory_groups \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "name": "name",
      "brand_name": "brand_name",
      "description": "description",
      "status": true,
      "items_count": 1,
      "total_stock": 1,
      "low_stock_count": 1,
      "out_of_stock_count": 1,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ]
}

Create a new inventory group

POST /inventory_groups

Request body

nameRequiredstring

brand_nameoptionalstring | null

ReturnsInventoryGroup

Inventory group created successfully

curl -X POST https://api.subbly.co/private/v1/inventory_groups \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "name",
  "brand_name": "brand_name"
}'

Response

{
  "id": 1,
  "name": "name",
  "brand_name": "brand_name",
  "description": "description",
  "status": true,
  "items_count": 1,
  "total_stock": 1,
  "low_stock_count": 1,
  "out_of_stock_count": 1,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

Get inventory group by ID

GET /inventory_groups/{inventory_group_id}

Path parameters

inventory_group_idRequiredinteger

Inventory group ID

ReturnsInventoryGroup

Inventory group object response

curl https://api.subbly.co/private/v1/inventory_groups/{inventory_group_id} \
  -H 'X-API-KEY: <api-key>'

Response

{
  "id": 1,
  "name": "name",
  "brand_name": "brand_name",
  "description": "description",
  "status": true,
  "items_count": 1,
  "total_stock": 1,
  "low_stock_count": 1,
  "out_of_stock_count": 1,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

Update an inventory group

PUT /inventory_groups/{inventory_group_id}

Path parameters

inventory_group_idRequiredinteger

Inventory group ID

Request body

nameoptionalstring

brand_nameoptionalstring | null

descriptionoptionalstring | null

ReturnsInventoryGroup

Inventory group updated successfully

curl -X PUT https://api.subbly.co/private/v1/inventory_groups/{inventory_group_id} \
  -H 'X-API-KEY: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "name",
  "brand_name": "brand_name",
  "description": "description"
}'

Response

{
  "id": 1,
  "name": "name",
  "brand_name": "brand_name",
  "description": "description",
  "status": true,
  "items_count": 1,
  "total_stock": 1,
  "low_stock_count": 1,
  "out_of_stock_count": 1,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}