Skip to content

Get a SKU by merchant SKU code

Request

Returns a specific SKU using the merchant's SKU code.

Security
BearerAuth
Query
sku_codestring, non-emptyrequired
include_archived_batchesboolean

When true, includes archived inventory batches in addition to active ones. Defaults to false (only active batches are returned).

Default:false
curl -i -X GET \
  'https://developers.hive.app/_mock/merchant-api-v2/mapi_v2_oas31/skus/by_sku_code?sku_code=string&include_archived_batches=false' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

A SKU

Bodyapplication/json
barcodestring or null, non-empty

Barcode of the SKU

batch_tracking_enabledbooleanrequired

Whether batch tracking of this SKU is enabled

cost_in_centsinteger or null, >= 0

Cost in cents (currency of the shop is implied)

country_code_of_originstring or null^[A-Z]{2}$

2-letter ISO 3166-1 code of country of origin

created_atstring, (date-time)read-onlyrequired

When this SKU was created

updated_atstring, (date-time)read-onlyrequired

When this SKU was last updated

dangerous_goodbooleanrequired

Sku is a dangerous good

fulfilled_bystring(SkuFulfilledBy)required

Who is fulfilling this SKU. Possible values:

  • hive: Fulfilled by Hive
  • new: Default value for newly imported SKUs
  • other: Fulfilled by another party
Enum:"hive""new""other"
h_codesArray of stringsrequired

Hazardous good H Codes

buffer_per_sales_channelArray of objects(SkuBufferPerSalesChannel)required

Inventory-level buffer (in units) held back from the stock levels pushed to each sales channel configured. Each entry reflects one sales channel: buffer_setting is the raw override (0 means "no override, use the sales channel default"), buffer_effective is the value actually applied after falling back to the sales channel default when the override is 0.

has_blocking_issuesboolean

Whether this SKU has pending blocking issues that prevent fulfillment

hazardous_goodbooleanrequired

SKU is a hazardous good

hs_codestring or null

The general Harmonized System (HS) code for the SKU

idinteger, (int64)read-onlyrequired

Hive unique identifier for this SKU

image_urlstring or null

Publicly accessible URL of an image for this SKU

inventoryobject(SkuInventory)required
Example:
{
  "available": 90,
  "reserved": 10,
  "stocked": 100,
  "outbound": 4,
  "blocked": 0,
  "damaged": 2,
  "missing": 0,
  "in_restocking": 5,
  "returned": 3,
  "thrown_away": 0,
  "sendback": 1
}
inventory_batchesArray of objects(SkuInventoryBatch)required

Current inventory per batch

inventory_per_warehouseArray of objects(SkuInventoryPerWarehouse)required

Current inventory per warehouse, ordered by warehouse_id: every warehouse that holds, receives, reserves or ships units of the SKU, and every warehouse that held them before, which then reports zeros.

effective_inventory_batch_settingsInventoryBatchSettings (object) or nullrequired
Any of:

Inventory batch settings for a merchant or specific SKU.

namestringrequired

Name of this SKU

sku_codestringrequired

SKU code - visible in the UI

statusstring(SkuStatus)required

Status of this SKU. Possible values:

  • active: SKU is active and available for orders
  • deleted: SKU is deleted and no longer available
Enum:"active""deleted"
un_numbersArray of stringsrequired

Dangerous good UN Numbers

weight_in_kgnumber or nullrequired
Any of:

Weight of SKU in kilograms

>= 0
number
Response
{
  "id": 1001,
  "name": "T-Shirt Black M",
  "sku_code": "SKU-001",
  "barcode": "1234567890123",
  "batch_tracking_enabled": false,
  "buffer_per_sales_channel": [
    { … },
    { … }
  ],
  "cost_in_cents": 800,
  "country_code_of_origin": "DE",
  "created_at": "2023-09-01T08:00:00Z",
  "updated_at": "2023-10-01T14:30:00Z",
  "dangerous_good": false,
  "fulfilled_by": "hive",
  "h_codes": [],
  "hazardous_good": false,
  "hs_code": "610910",
  "image_url": "https://cdn.hive.app/skus/sku-001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4%&X-Amz-Date=20230525T083045Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d8e3",
  "inventory": {
    "available": 90,
    "reserved": 10,
    "stocked": 100,
    "outbound": 4,
    "blocked": 0,
    "damaged": 0,
    "missing": 0,
    "in_restocking": 0,
    "returned": 0,
    "thrown_away": 0,
    "sendback": 0
  },
  "inventory_batches": [],
  "inventory_per_warehouse": [
    { … }
  ],
  "status": "active",
  "un_numbers": [],
  "weight_in_kg": 0.2,
  "effective_inventory_batch_settings": {
    "id": 501,
    "batch_priority": "first_expired_first_out",
    "b2c_shelf_life_in_weeks": 12,
    "b2b_shelf_life_in_weeks": 24,
    "ito_shelf_life_in_weeks": 8,
    "kit_shelf_life_in_weeks": 6,
    "is_merchant_default": true,
    "sku_id": null,
    "action_weeks_before_expiry": 4,
    "expiry_follow_up_action": "block_and_dispose"
  }
}