SKU Group Search
GET
{{api_url}}/shop/products/sku_group/searchLists the SKU Inventory Groups on the account. A SKU Inventory Group ties several SKUs to one inventory level, for example the same physical product listed under different SKUs on different channels. Any inventory change to one SKU in a group is applied to every SKU in the group. Groups are created at Inventory > SKU Inventory Groups in the OMS or by CSV upload.
Parameters
All parameters are optional.
| Parameter | Type | Description |
|---|---|---|
search_term | string | Partial match against the group name. |
just_count | integer | Set to 1 to return only a count of matching groups instead of the groups themselves. |
limit | integer | Maximum number of groups to return. |
limit_start | integer | Number of leading results to skip, for paging. With limit 100 and limit_start 100 you get groups 101 through 200. |
Examples
All groups:
{{api_url}}/shop/products/sku_group/search
Groups whose name contains "master":
{{api_url}}/shop/products/sku_group/search?search_term=master
How many groups exist:
{{api_url}}/shop/products/sku_group/search?just_count=1
Response
A JSON array, one object per group:
[
{
"shop_product_inventory_group_id": "4",
"shop_product_inventory_group_siteareaid": "16",
"group_name": "First Test",
"product_count": "4"
},
{
"shop_product_inventory_group_id": "9",
"shop_product_inventory_group_siteareaid": "16",
"group_name": "use_master_SKU_Number",
"product_count": "3"
}
]
| Field | Type | Description |
|---|---|---|
shop_product_inventory_group_id | string | The group id. Pass this to SKU Group Get. |
shop_product_inventory_group_siteareaid | string | The InfiPlex site area the group belongs to. |
group_name | string | The group name as shown in the OMS. |
product_count | string | Number of SKUs in the group. |
To see which SKUs are in a group, use SKU Group Get with the group id.
Authorization
Bearer token, sent in the Authorization header. Inherited from the collection.
Query Parameters
| Key | Value | Description |
|---|---|---|
just_count optional | Set to 1 to return only a count of matching groups instead of the groups themselves. | |
limit optional | Maximum number of groups to return. | |
limit_start optional | Number of leading results to skip, for paging. With limit 100 and limit_start 100 you get groups 101 through 200. | |
search_term optional | Partial match against the group name. |
Example Request
curl --location --request GET '{{api_url}}/shop/products/sku_group/search' \
--header 'Authorization: Bearer {{auth_token}}'Example Responses
SKU Group Search
Request
curl --location --request GET '{{api_url}}/shop/sku_group/search' \
--header 'Authorization: Bearer YOUR_API_KEY'Response 200 OK
[
{
"shop_product_inventory_group_id": "4",
"shop_product_inventory_group_siteareaid": "16",
"group_name": "First Test",
"product_count": "4"
},
{
"shop_product_inventory_group_id": "9",
"shop_product_inventory_group_siteareaid": "16",
"group_name": "use_master_SKU_Number",
"product_count": "3"
}
]