Fulfillment Item Bundle Search

GET{{api_url}}/shop/connection/fulfillment/item_bundle/search

Lists the Item Bundle Groups on the account. An Item Bundle Group tells a fulfillment partner how to ship a bundle SKU as its components. Each entry maps one source_sku, the bundle SKU as sold on your channels and carried on the order, to one or more dest_sku lines with a dest_sku_qty each, the component SKUs and quantities the 3PL, fulfillment service, or drop shipper actually picks. When an order line's SKU matches a source_sku in the group a fulfillment connection has selected, InfiPlex sends the partner the dest_sku lines in place of that line, multiplied by the quantity ordered.

Item Bundle Groups are used only by fulfillment, 3PL, and drop shipper connections, each of which selects a group in its settings. They do not change inventory and are separate from Bundles under Shop/Products, which build real bundle stock from components. A SKU Map, by contrast, swaps one SKU for one SKU; an Item Bundle Group swaps one SKU for several lines. Groups are managed at Inventory > Item Bundles in the OMS or by CSV upload.

Parameters

All parameters are optional.

ParameterTypeDescription
search_termstringPartial match against the group name.
just_countintegerSet to 1 to return only a count of matching groups instead of the groups themselves.
limitintegerMaximum number of groups to return.
limit_startintegerNumber 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/connection/fulfillment/item_bundle/search

Groups whose name contains "lip balm":

{{api_url}}/shop/connection/fulfillment/item_bundle/search?search_term=lip balm

How many groups exist:

{{api_url}}/shop/connection/fulfillment/item_bundle/search?just_count=1

Response

A JSON array, one object per group. The SKU lines themselves are not included here; use Fulfillment Item Bundle Get for those.

[
    {
        "shop_drop_shipper_item_bundle_group_id": "2",
        "shop_drop_shipper_item_bundle_group_sitearea_id": "16",
        "bundle_group_name": "Lip Balm Bundles",
        "total_unique_source_skus": "1"
    },
    {
        "shop_drop_shipper_item_bundle_group_id": "1",
        "shop_drop_shipper_item_bundle_group_sitearea_id": "16",
        "bundle_group_name": "test 1",
        "total_unique_source_skus": "3"
    }
]
FieldTypeDescription
shop_drop_shipper_item_bundle_group_idstringThe group id. Pass this to Fulfillment Item Bundle Get.
shop_drop_shipper_item_bundle_group_sitearea_idstringThe InfiPlex site area the group belongs to.
bundle_group_namestringThe group name as shown in the OMS and in a fulfillment connection's settings.
total_unique_source_skusstringNumber of distinct bundle SKUs the group explodes. One source SKU usually has several component lines.

Authorization

Bearer token, sent in the Authorization header. Inherited from the collection.

Query Parameters

KeyValueDescription
just_count optionalSet to 1 to return only a count of matching item bundle groups instead of the groups themselves
limit optionalMaximum number of item bundle groups to return
limit_start optionalNumber of leading results to skip, for paging. With limit 100 and limit_start 100 you get groups 101 through 200
search_term optionalmapPartial match against the group name

Example Request

curl --location --request GET '{{api_url}}/shop/connection/fulfillment/item_bundle/search' \
--header 'Authorization: Bearer {{auth_token}}'

Example Responses

Fulfillment Item Bundle Search

Request

curl --location --request GET '{{api_url}}/shop/connection/fulfillment/item_bundle/search' \
--header 'Authorization: Bearer YOUR_API_KEY'

Response 200 OK

[
    {
        "shop_drop_shipper_item_bundle_group_id": "2",
        "shop_drop_shipper_item_bundle_group_sitearea_id": "16",
        "bundle_group_name": "Lip Balm Bundles",
        "total_unique_source_skus": "1"
    },
    {
        "shop_drop_shipper_item_bundle_group_id": "1",
        "shop_drop_shipper_item_bundle_group_sitearea_id": "16",
        "bundle_group_name": "test 1",
        "total_unique_source_skus": "3"
    }
]