SKUs
List all SKUs
Lists all SKUs
GET
https://app.hive.app/merchant_api/v1/skus
Returns SKUs ordered by descending creation time.
Query Parameters
Name | Type | Description |
---|---|---|
merchant_sku_ids[] | String[] | Allow to filters skus by merchant_sku_id |
created_at[lt] | ISO8601 datetime | Return results where the |
created_at[lte] | ISO8601 datetime | Return results where the |
created_at[gt] | ISO8601 datetime | Return results where the |
created_at[gte] | ISO8601 datetime | Return results where the |
Create a new SKU
Creates a new SKU
POST
https://app.hive.app/merchant_api/v1/skus
Request Body
Name | Type | Description |
---|---|---|
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 | 2-letter ISO 3166-1 code of country of origin |
hs_code | String | Harmonized System code |
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
Updates an SKU
PATCH
https://app.hive.app/merchant_api/v1/skus/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id* | Integer | The (Hive) ID of the SKU to update |
Request Body
Name | Type | Description |
---|---|---|
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 | 2-letter ISO 3166-1 code of country of origin |
hs_code | String | Harmonized System code |
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
Upserts 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, but if any field of an existing SKU already has value set on our side (e.g. cost_in_cents=100
) and you omit that field in the request then it would be set to null
on our side.
Request Body
Name | Type | Description |
---|---|---|
skus* | Object[] | List of SKUs for upsert |
Delete an SKU
Deletes 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
Name | Type | Description |
---|---|---|
id* | Integer | The (Hive) ID of the SKU to delete |
Last updated