Referensi API

Inventori

Item stok master, gudang, dokumen stok, dan buku besar stok.

Bulk update variants

POST/v1/bulk/variants

Change marketplace price and stock of many variants; pushed per store.

Variants that follow a master item with sync on reject the managed field with VARIANT_MANAGED.

Scope:products:write

Request bodyapplication/json

updatesarray<object>wajib
item min 1 · item maks 200
Tampilkan 3 atribut turunan
- variantIdstringwajib
  format: uuid
- pricestring (decimal)opsional
  Decimal string with two fraction digits.
- stockintegeropsional
  min 0 · maks 99999

Response200 · application/json

Outcome per variant, in request order

resultsarray<object>wajib
Tampilkan 3 atribut turunan
- variantIdstringwajib
  format: uuid
- okbooleanwajib
- errorobjectwajibnullable
  Tampilkan 2 atribut turunan
  - codestringwajib
  - messagestringwajib

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/bulk/variants" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "updates": [
    {
      "variantId": "0192f0c4-8d1e-7a4b-9c3e-5f6a7b8c9d0e"
    }
  ]
}'

List inventory items

GET/v1/inventory/items

Master stock items.

Scope:products:read

Query parameter

qstringopsional
panjang maks 100

Response200 · application/json

Items ordered by SKU

itemsarray<InventoryItem>wajib
Tampilkan 15 atribut turunan
- idstringwajib
  format: uuid
- skustringwajib
- namestringwajib
- stockintegerwajib
  Sum over sellable warehouses.
- onHandintegerwajib
  Sum over all warehouses.
- avgCoststring (decimal)wajibnullable
  Moving-average unit cost from receipts.
- safetyStockintegerwajib
- availableintegerwajib
  max(0, stock - safetyStock); the quantity pushed to marketplaces.
- pricestring (decimal)wajibnullable
  Decimal string with two fraction digits.
- currencystringwajib
- syncStockbooleanwajib
- syncPricebooleanwajib
- linkCountintegerwajib
- errorCountintegerwajib
- updatedAtstringwajib
  format: date-time

Contoh request · curl

curl "https://api.comnethub.app/v1/inventory/items" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Create inventory item

POST/v1/inventory/items

Create a master stock item.

Scope:products:write

Request bodyapplication/json

skustringwajib
panjang min 1 · panjang maks 100
namestringwajib
panjang min 1 · panjang maks 200
stockintegeropsional
min 0 · maks 1000000
warehouseIdstringopsional
Warehouse for the initial stock; defaults to the default warehouse.
format: uuid
safetyStockintegeropsional
min 0 · maks 1000000
pricestring (decimal)opsionalnullable
Decimal string with two fraction digits.
syncStockbooleanopsional
syncPricebooleanopsional

Response201 · application/json

Created item

idstringwajib
format: uuid
skustringwajib
namestringwajib
stockintegerwajib
Sum over sellable warehouses.
onHandintegerwajib
Sum over all warehouses.
avgCoststring (decimal)wajibnullable
Moving-average unit cost from receipts.
safetyStockintegerwajib
availableintegerwajib
max(0, stock - safetyStock); the quantity pushed to marketplaces.
pricestring (decimal)wajibnullable
Decimal string with two fraction digits.
currencystringwajib
syncStockbooleanwajib
syncPricebooleanwajib
linkCountintegerwajib
errorCountintegerwajib
updatedAtstringwajib
format: date-time

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/inventory/items" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "sku": "string",
  "name": "string"
}'

Get inventory item

GET/v1/inventory/items/{itemId}

Item with linked marketplace variants and recent movements.

Scope:products:read

Path parameter

itemIdstringwajib
format: uuid

Response200 · application/json

Item detail

idstringwajib
format: uuid
skustringwajib
namestringwajib
stockintegerwajib
Sum over sellable warehouses.
onHandintegerwajib
Sum over all warehouses.
avgCoststring (decimal)wajibnullable
Moving-average unit cost from receipts.
safetyStockintegerwajib
availableintegerwajib
max(0, stock - safetyStock); the quantity pushed to marketplaces.
pricestring (decimal)wajibnullable
Decimal string with two fraction digits.
currencystringwajib
syncStockbooleanwajib
syncPricebooleanwajib
linkCountintegerwajib
errorCountintegerwajib
updatedAtstringwajib
format: date-time
warehousesarray<ItemWarehouseStock>wajib
Tampilkan 5 atribut turunan
- warehouseIdstringwajib
  format: uuid
- codestringwajib
- namestringwajib
- sellablebooleanwajib
- quantityintegerwajib
linksarray<InventoryLink>wajib
Tampilkan 13 atribut turunan
- variantIdstringwajib
  format: uuid
- storeIdstringwajib
  format: uuid
- storeNamestringwajib
- marketplacestringwajib
  Salah satu dari:tiktokshopeelazadatokopedia
- productTitlestringwajib
- variantNamestringwajibnullable
- skustringwajibnullable
- stockintegerwajibnullable
- pricestring (decimal)wajibnullable
  Decimal string with two fraction digits.
- lastPushedStockintegerwajibnullable
- lastPushedAtstringwajibnullable
  format: date-time
- lastErrorstringwajibnullable
- linkedAtstringwajib
  format: date-time
movementsarray<InventoryMovement>wajib
Tampilkan 15 atribut turunan
- idstringwajib
  format: uuid
- deltaintegerwajib
- reasonstringwajib
  Salah satu dari:adjustsetordercancelreceiveissuetransfer_intransfer_outstocktakereturn
- batchIdstringwajibnullable
  Shared by the lines and transfer legs of one stock document.
  format: uuid
- warehouseIdstringwajib
  format: uuid
- warehouseCodestringwajib
- unitCoststring (decimal)wajibnullable
  Decimal string with two fraction digits.
- purchaseOrderIdstringwajibnullable
  format: uuid
- purchaseOrderNumberstringwajibnullable
- stocktakeIdstringwajibnullable
  format: uuid
- stocktakeNumberstringwajibnullable
- orderIdstringwajibnullable
  format: uuid
- externalOrderIdstringwajibnullable
- notestringwajibnullable
- createdAtstringwajib
  format: date-time

Contoh request · curl

curl "https://api.comnethub.app/v1/inventory/items/$ITEM_ID" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Update inventory item

PATCH/v1/inventory/items/{itemId}

Edit name, safety stock, price, or sync switches.

Scope:products:write

Path parameter

itemIdstringwajib
format: uuid

Request bodyapplication/json

namestringopsional
panjang min 1 · panjang maks 200
safetyStockintegeropsional
min 0 · maks 1000000
pricestring (decimal)opsionalnullable
Decimal string with two fraction digits.
syncStockbooleanopsional
syncPricebooleanopsional

Response200 · application/json

Updated item

idstringwajib
format: uuid
skustringwajib
namestringwajib
stockintegerwajib
Sum over sellable warehouses.
onHandintegerwajib
Sum over all warehouses.
avgCoststring (decimal)wajibnullable
Moving-average unit cost from receipts.
safetyStockintegerwajib
availableintegerwajib
max(0, stock - safetyStock); the quantity pushed to marketplaces.
pricestring (decimal)wajibnullable
Decimal string with two fraction digits.
currencystringwajib
syncStockbooleanwajib
syncPricebooleanwajib
linkCountintegerwajib
errorCountintegerwajib
updatedAtstringwajib
format: date-time

Contoh request · curl

curl -X PATCH "https://api.comnethub.app/v1/inventory/items/$ITEM_ID" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "safetyStock": 1,
  "price": "150000.00",
  "syncStock": true,
  "syncPrice": true
}'

Adjust inventory stock

POST/v1/inventory/items/{itemId}/adjust

Set or change stock; queues a push to linked marketplaces.

Scope:products:write

Path parameter

itemIdstringwajib
format: uuid

Request bodyapplication/json

modestringwajib
Salah satu dari:setdelta
quantityintegerwajib
min -1000000 · maks 1000000
warehouseIdstringopsional
Defaults to the default warehouse; set mode applies to that warehouse.
format: uuid
notestringopsional
panjang maks 200

Response200 · application/json

Item after the change

idstringwajib
format: uuid
skustringwajib
namestringwajib
stockintegerwajib
Sum over sellable warehouses.
onHandintegerwajib
Sum over all warehouses.
avgCoststring (decimal)wajibnullable
Moving-average unit cost from receipts.
safetyStockintegerwajib
availableintegerwajib
max(0, stock - safetyStock); the quantity pushed to marketplaces.
pricestring (decimal)wajibnullable
Decimal string with two fraction digits.
currencystringwajib
syncStockbooleanwajib
syncPricebooleanwajib
linkCountintegerwajib
errorCountintegerwajib
updatedAtstringwajib
format: date-time

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/inventory/items/$ITEM_ID/adjust" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "set",
  "quantity": 1
}'

Link inventory variant

POST/v1/inventory/items/{itemId}/links

Link a marketplace variant; it immediately receives the item's stock.

Scope:products:write

Path parameter

itemIdstringwajib
format: uuid

Request bodyapplication/json

variantIdstringwajib
format: uuid

Response200 · application/json

Item detail

idstringwajib
format: uuid
skustringwajib
namestringwajib
stockintegerwajib
Sum over sellable warehouses.
onHandintegerwajib
Sum over all warehouses.
avgCoststring (decimal)wajibnullable
Moving-average unit cost from receipts.
safetyStockintegerwajib
availableintegerwajib
max(0, stock - safetyStock); the quantity pushed to marketplaces.
pricestring (decimal)wajibnullable
Decimal string with two fraction digits.
currencystringwajib
syncStockbooleanwajib
syncPricebooleanwajib
linkCountintegerwajib
errorCountintegerwajib
updatedAtstringwajib
format: date-time
warehousesarray<ItemWarehouseStock>wajib
Tampilkan 5 atribut turunan
- warehouseIdstringwajib
  format: uuid
- codestringwajib
- namestringwajib
- sellablebooleanwajib
- quantityintegerwajib
linksarray<InventoryLink>wajib
Tampilkan 13 atribut turunan
- variantIdstringwajib
  format: uuid
- storeIdstringwajib
  format: uuid
- storeNamestringwajib
- marketplacestringwajib
  Salah satu dari:tiktokshopeelazadatokopedia
- productTitlestringwajib
- variantNamestringwajibnullable
- skustringwajibnullable
- stockintegerwajibnullable
- pricestring (decimal)wajibnullable
  Decimal string with two fraction digits.
- lastPushedStockintegerwajibnullable
- lastPushedAtstringwajibnullable
  format: date-time
- lastErrorstringwajibnullable
- linkedAtstringwajib
  format: date-time
movementsarray<InventoryMovement>wajib
Tampilkan 15 atribut turunan
- idstringwajib
  format: uuid
- deltaintegerwajib
- reasonstringwajib
  Salah satu dari:adjustsetordercancelreceiveissuetransfer_intransfer_outstocktakereturn
- batchIdstringwajibnullable
  Shared by the lines and transfer legs of one stock document.
  format: uuid
- warehouseIdstringwajib
  format: uuid
- warehouseCodestringwajib
- unitCoststring (decimal)wajibnullable
  Decimal string with two fraction digits.
- purchaseOrderIdstringwajibnullable
  format: uuid
- purchaseOrderNumberstringwajibnullable
- stocktakeIdstringwajibnullable
  format: uuid
- stocktakeNumberstringwajibnullable
- orderIdstringwajibnullable
  format: uuid
- externalOrderIdstringwajibnullable
- notestringwajibnullable
- createdAtstringwajib
  format: date-time

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/inventory/items/$ITEM_ID/links" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "variantId": "0192f0c4-8d1e-7a4b-9c3e-5f6a7b8c9d0e"
}'

Unlink inventory variant

DELETE/v1/inventory/items/{itemId}/links/{variantId}

Stop syncing a variant.

Scope:products:write

Path parameter

itemIdstringwajib
format: uuid
variantIdstringwajib
format: uuid

Response204

Unlinked

Tidak ada response body.

Contoh request · curl

curl -X DELETE "https://api.comnethub.app/v1/inventory/items/$ITEM_ID/links/$VARIANT_ID" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Push inventory item

POST/v1/inventory/items/{itemId}/push

Queue a push of stock (and price when enabled) to every linked variant.

Scope:products:write

Path parameter

itemIdstringwajib
format: uuid

Response202

Queued

Tidak ada response body.

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/inventory/items/$ITEM_ID/push" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

List unlinked variants

GET/v1/inventory/variants

Synced marketplace variants not linked to any item.

Scope:products:read

Query parameter

qstringopsional
panjang maks 100

Response200 · application/json

Variants

itemsarray<MarketplaceVariant>wajib
Tampilkan 9 atribut turunan
- variantIdstringwajib
  format: uuid
- storeIdstringwajib
  format: uuid
- storeNamestringwajib
- marketplacestringwajib
  Salah satu dari:tiktokshopeelazadatokopedia
- productTitlestringwajib
- variantNamestringwajibnullable
- skustringwajibnullable
- stockintegerwajibnullable
- pricestring (decimal)wajibnullable
  Decimal string with two fraction digits.

Contoh request · curl

curl "https://api.comnethub.app/v1/inventory/variants" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

List warehouses

GET/v1/inventory/warehouses

Warehouses with stock totals.

Scope:products:read

Query parameter

archivedbooleanopsional

Response200 · application/json

itemsarray<Warehouse>wajib
Tampilkan 12 atribut turunan
- receivesReturnsbooleanwajib
  Returned goods are restocked here (e.g. for inspection); otherwise into the order's warehouse.
- idstringwajib
  format: uuid
- codestringwajib
- namestringwajib
- addressstringwajibnullable
- sellablebooleanwajib
- isDefaultbooleanwajib
- archivedbooleanwajib
- itemCountintegerwajib
  Items with non-zero quantity.
- onHandintegerwajib
- storeCountintegerwajib
  Stores whose orders deduct from this warehouse.
- createdAtstringwajib
  format: date-time

Contoh request · curl

curl "https://api.comnethub.app/v1/inventory/warehouses" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

List warehouse stock

GET/v1/inventory/warehouses/{warehouseId}/stock

Item quantities in one warehouse.

Scope:products:read

Path parameter

warehouseIdstringwajib
format: uuid

Query parameter

qstringopsional
panjang maks 100
nonZerobooleanopsional

Response200 · application/json

itemsarray<WarehouseStockRow>wajib
Tampilkan 5 atribut turunan
- itemIdstringwajib
  format: uuid
- skustringwajib
- namestringwajib
- quantityintegerwajib
- avgCoststring (decimal)wajibnullable
  Decimal string with two fraction digits.

Contoh request · curl

curl "https://api.comnethub.app/v1/inventory/warehouses/$WAREHOUSE_ID/stock" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"

Post stock document

POST/v1/inventory/stock-documents

Receive, issue, or transfer stock in one batch.

Scope:products:write

Request bodyapplication/json

typestringwajib
Salah satu dari:receiveissuetransfer
warehouseIdstringwajib
Destination for receive, source for issue and transfer.
format: uuid
toWarehouseIdstringopsional
Required for transfer.
format: uuid
notestringopsional
panjang maks 200
linesarray<object>wajib
item min 1 · item maks 200
Tampilkan 3 atribut turunan
- itemIdstringwajib
  format: uuid
- quantityintegerwajib
  min 1 · maks 1000000
- unitCoststring (decimal)opsional
  Receive only; updates the item's average cost.

Response201 · application/json

batchIdstringwajib
format: uuid
movementsintegerwajib

Contoh request · curl

curl -X POST "https://api.comnethub.app/v1/inventory/stock-documents" \
  -H "Authorization: Bearer $THECOMNET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "receive",
  "warehouseId": "0192f0c4-8d1e-7a4b-9c3e-5f6a7b8c9d0e",
  "lines": [
    {
      "itemId": "0192f0c4-8d1e-7a4b-9c3e-5f6a7b8c9d0e",
      "quantity": 1
    }
  ]
}'

List stock movements

GET/v1/inventory/movements

Stock ledger, newest first.

Scope:products:read

Query parameter

warehouseIdstringopsional
format: uuid
itemIdstringopsional
format: uuid
reasonMovementReasonopsional
Salah satu dari:adjustsetordercancelreceiveissuetransfer_intransfer_outstocktakereturn
beforestringopsional
Cursor; returns movements older than this movement id.
format: uuid
limitintegeropsional
min 1 · maks 500

Response200 · application/json

itemsarray<StockLedgerEntry>wajib
Tampilkan 18 atribut turunan
- idstringwajib
  format: uuid
- deltaintegerwajib
- reasonstringwajib
  Salah satu dari:adjustsetordercancelreceiveissuetransfer_intransfer_outstocktakereturn
- batchIdstringwajibnullable
  Shared by the lines and transfer legs of one stock document.
  format: uuid
- warehouseIdstringwajib
  format: uuid
- warehouseCodestringwajib
- unitCoststring (decimal)wajibnullable
  Decimal string with two fraction digits.
- purchaseOrderIdstringwajibnullable
  format: uuid
- purchaseOrderNumberstringwajibnullable
- stocktakeIdstringwajibnullable
  format: uuid
- stocktakeNumberstringwajibnullable
- orderIdstringwajibnullable
  format: uuid
- externalOrderIdstringwajibnullable
- notestringwajibnullable
- createdAtstringwajib
  format: date-time
- itemIdstringwajib
  format: uuid
- skustringwajib
- itemNamestringwajib

Contoh request · curl

curl "https://api.comnethub.app/v1/inventory/movements?limit=20" \
  -H "Authorization: Bearer $THECOMNET_API_KEY"