SKUs
The SKU resource
barcode
String
Barcode of the SKU
batch_tracking_enabled
Boolean
Whether batch tracking of this SKU is enabled
cost_in_cents
Integer
Cost in cents (currency of the shop is implied)
country_code_of_origin
String
created_at
ISO8601 datetime (read-only)
When this SKU was created
fulfilled_by
String (read-only)
Who is fulfilling this SKU. Valid values: hive, other, new
hs_code
String
id
Integer (read-only)
Hive unique identifier for this SKU
image_url
String
Publicly accessible URL of an image for this SKU
inventory
Current inventory
inventory_batches
Current inventory per batch
inventory_per_warehouse
Current inventory per warehouse
merchant_sku_id*
String
SKU code as provided by the merchant
name*
String
Name of this SKU
status
String (read-only)
Valid values: active, deleted
weight_in_kg
Float
Weight of SKU in kilograms
*Required properties when creating a new record.
The SkuInventory resource
reserved
Integer (read-only)
Quantity reserved for orders
stocked
Integer (read-only)
Available for sale (minus any buffer quantity, if configured)
total
Integer (read-only)
Available (will be equal to stocked if buffer is 0)
The SkuInventoryBatches resource
expiry_date
ISO8601 date (read-only)
Expiration date of the batch
id
Integer (read-only)
Hive unique ID for the batch
name
String (read-only)
Name of the batch
stocked_quantities
Available for sale per warehouse
tracking_code
String (read-only)
Tracking code
The SkuInventoryPerWarehouse resource
reserved
Integer (read-only)
Quantity reserved for orders
stocked
Integer (read-only)
Available for sale (minus any buffer quantity, if configured)
total
Integer (read-only)
Available (will be equal to stocked if buffer is 0)
warehouse_id
Integer (read-only)
Hive's unique warehouse ID
The InventoryPerWarehouse resource
quantity
Integer (read-only)
Available for sale
warehouse_id
Integer (read-only)
Hive's unique warehouse ID
List all SKUs
GET
https://app.hive.app/merchant_api/v1/skus
Returns SKUs ordered by descending creation time.
Query Parameters
merchant_sku_ids[]
String[]
Allow to filters skus by merchant_sku_id
created_at[lt]
ISO8601 datetime
Return results where the created_at
field is less than this value.
created_at[lte]
ISO8601 datetime
Return results where the created_at
field is less than or equal to this value.
created_at[gt]
ISO8601 datetime
Return results where the created_at
field is greater than this value.
created_at[gte]
ISO8601 datetime
Return results where the created_at
field is greater than or equal to this value.
Create a new SKU
POST
https://app.hive.app/merchant_api/v1/skus
Request Body
name*
String
A human-readable name or title
merchant_sku_id*
String
An ID that uniquely identifies this SKU
cost_in_cents
Integer
The cost (not price) of this SKU
country_code_of_origin
String
hs_code
String
weight_in_kg
Float
Weight in kilograms
image_url
String
Image of the product, must be publicly accessible.
barcode
String
The SKU barcode
batch_tracking_enabled
Boolean
Enables inventory tracking per batch (defaults to false if omitted)
Update an SKU
PATCH
https://app.hive.app/merchant_api/v1/skus/{id}
Path Parameters
id*
Integer
The (Hive) ID of the SKU to update
Request Body
merchant_sku_id
String
An ID that uniquely identifies this SKU
name
String
A human-readable name or title
cost_in_cents
Integer
The cost (not price) of this SKU
country_code_of_origin
String
hs_code
String
weight_in_kg
Float
Weight in kilograms
image_url
String
Image of the product, must be publicly accessible.
barcode
String
The SKU barcode
batch_tracking_enabled
Boolean
Enables inventory tracking per batch
Batch upsert SKUs
POST
https://app.hive.app/merchant_api/v1/skus/bulk_upsert
For each item in the provided list, it creates an SKU if it does not exist yet on our side, updates if it already exists.
The endpoint accepts up to 100 items in the skus
key of the request body. At least one should be provided. Each item should have the same structure as in the POST /skus
endpoint. All fields except name
and merchant_sku_id
are optional.
If any field of an existing SKU already has a value set on our side (e.g. cost_in_cents=100
) and you omit that field in the request, it will be set to null
on our side. However, if batch_tracking_enabled
is omitted in the request, its existing value will remain unchanged. To update batch_tracking_enabled
, you must include it explicitly (true
/false
) in the request body.
Request Body
skus*
Object[]
List of SKUs for upsert
Delete an SKU
DELETE
https://app.hive.app/merchant_api/v1/skus/{id}
Marks an active SKU as "deleted". Will be set back to "active" on next create, update or batch upsert of that sku.
Path Parameters
id*
Integer
The (Hive) ID of the SKU to delete
Last updated