Shipper API gives interface access to our clients to get Bundle SKU from their own system to Shipper Order Management System

Authorizations : X-API-Key_Header

Request Body Schema : application/json

Method	Endpoint
GET	/v3/fulfillment/bundle/stock

Body Request Parameter

Parameter	Type	Mandatory/Optional	Note
merchant_id	integer	Mandatory	The ID of the merchant
warehouse_codes	string	Optional	The code(s) of the warehouse(s), the concept is aloshoo warehouse, shipperOMS will do the conversion.
bundles	string	Optional	the bundle name
skus	string	Optional	the SKU name
shop_code	string	Optional	The code of the shop
page	integer	Optional	the page of the result, default 1
limit	integer	Optional	the size of the result in each page,default 20

Sample Request

{{host}}/v3/fulfillment/bundle?merchant_id={{adamkong_merchant_id}}&warehouse_codes=MP2-WH-TGR04&warehouse_codes=MP3-WH-TGR04&shop_code=CS283

Response Parameters

Parameter	Type	Note
data	array	The list of packages
pagination	object	The pagination information
metadata	object	The metadata information
id	integer	The ID of the package
bundle_code	string	The code of the package
owner_code	string	The code of the owner of the package
shop_code	string	The code(s) of the shop(s)
warehouse_code	string	The code(s) of the warehouse(s)
skus	array	The information of the products in the package
bundle	string	The name of the package
bundle_source	string	The source of the package
bundle_desc	string	The description of the package
operator	string	The operator of the package
status	string	The status of the package
gmt_create	integer	The timestamp when the package was created
gmt_modified	integer	The timestamp when the package was last modified
sku	string	The SKU of the product
qty	integer	The quantity of the product

Sample Response

{
    "data": [
        {
            "id": 473,
            "bundle_code": "BU202304240220006711",
            "owner_code": "ADAMKONG123456789-1",
            "shop_code": [
                "CS283"
            ],
            "warehouse_code": [
                "WH-CGK09",
                "WH-TGR04"
            ],
            "skus": [
                {
                    "sku": "ZHANGSKU12311",
                    "qty": 2
                },
                {
                    "sku": "ZHANGSKU12314",
                    "qty": 1
                }
            ],
            "bundle": "KEVINDAIPOSTMANBUNDLE01",
            "bundle_source": "aloshop",
            "bundle_desc": "",
            "operator": "[email protected]",
            "status": "Active",
            "gmt_create": 1682302811812,
            "gmt_modified": 1682324170184
        },
        {
            "id": 409,
            "bundle_code": "BU202303030302706057",
            "owner_code": "ADAMKONG123456789-1",
            "shop_code": [
                "CS283",
                "CS242"
            ],
            "warehouse_code": [
                "WH-TGR04",
                "WH-CGK09"
            ],
            "skus": [
                {
                    "sku": "ZHANGSKU12320",
                    "qty": 1
                },
                {
                    "sku": "ZHANGSKU12319",
                    "qty": 1
                }
            ],
            "bundle": "ASSIGN_0409_1920OK",
            "bundle_source": "omsPortal",
            "bundle_desc": "",
            "operator": "[email protected]",
            "status": "Active",
            "gmt_create": 1677812522292,
            "gmt_modified": 1677812611113
        },
        {
            "id": 403,
            "bundle_code": "BU202303020657705910",
            "owner_code": "ADAMKONG123456789-1",
            "shop_code": [
                "CS242",
                "CS283"
            ],
            "warehouse_code": [
                "WH-TGR04",
                "WH-CGK09"
            ],
            "skus": [
                {
                    "sku": "ZHANGSKU1235",
                    "qty": 1
                },
                {
                    "sku": "ZHANGSKU1234",
                    "qty": 1
                }
            ],
            "bundle": "BUNDLE-CGK09TGR04",
            "bundle_source": "omsPortal",
            "bundle_desc": "",
            "operator": "[email protected]",
            "status": "Active",
            "gmt_create": 1677740256095,
            "gmt_modified": 1678429273823
        }
    ],
    "pagination": {
        "current_page": 1,
        "current_elements": 3,
        "total_pages": 1,
        "total_elements": 3,
        "sort_by": null
    },
    "metadata": {
        "path": "/v3/fulfillment/bundle",
        "status": "OK",
        "message": "GET /v3/fulfillment/bundle [200] OK",
        "timestamp": 1682416713,
        "http_status_code": 200
    }
}