EasyTBK Documentation

The HotelRoomAddRequest class is used to construct a request for the TaoBao TOP API taobao.hotel.room.add. This API allows you to add or update hotel room availability, pricing, and policies.

Key configuration areas include:

• Identification: Requires hid (Hotel ID) and rid (Room Type ID).
• Pricing & Inventory: Use roomQuotas to provide a JSON array of availability for up to 90 days. Each entry includes date (YYYY-MM-DD), price (in cents), and num (available quantity).
• Policies: Define refundPolicyInfo as a JSON string to specify cancellation fees and timing.
• Sales Control: Set startTime and endTime for daily sales, and gmtEffective/gmtDeadline to control the validity period of the rate plan.
• Invoicing: Configure receiptType (A: Hotel Accommodation, B: Other) and associated descriptions.

use NiuGengYun\EasyTBK\TaoBao\request\HotelRoomAddRequest;

$request = new HotelRoomAddRequest();
$request->setHid(12345); // Hotel ID
$request->setRid(67890); // Room Type ID
$request->setTitle("Deluxe Ocean View");
$request->setRoomQuotas([
    ["date" => "2023-10-01", "price" => 10000, "num" => 5],
    ["date" => "2023-10-02", "price" => 12000, "num" => 3]
]);
$request->setRefundPolicyInfo('{"cancelPolicyType":1}'); // Any cancellation is allowed

Use the JdUnionGoodsSeckillQueryRequest class to query Jingdong (JD) Union seckill (flash sale) goods. This request object maps to the jd.union.open.goods.seckill.query API method.

Available Parameters

Usage Note

When calling getParamJson(), the object filters out all null values and wraps the remaining parameters in a JSON object under the key goodsReq.

use NiuGengYun\
EasyTBK\
JingDong\
Request\
JdUnionGoodsSeckillQueryRequest;

$request = new JdUnionGoodsSeckillQueryRequest();
$request->setSkuIds(['SKU123', 'SKU456']);
$request->setPageSize(20);
$request->setSort('asc');
$request->setSortName('seckillPrice');

// To get the JSON payload for the API call:
$jsonPayload = $request->getParamJson();

The TbkDgMaterialOptionalRequest class is used to construct a request for the TaoBao TOP API taobao.tbk.dg.material.optional. This API allows you to search for DG (Direct Goods) materials with various filters such as category, price range, commission rates, and sorting options.

To use this request object, instantiate it and use the provided setter methods to populate the required and optional parameters. Once configured, you can retrieve the parameters for the API call using getApiParas().

Key Parameters

use NiuGengYun\EasyTBK\TaoBao\request\TbkDgMaterialOptionalRequest;

$request = new TbkDgMaterialOptionalRequest();
$request->setAdzoneId('your_adzone_id');
$request->setQ('search term');
$request->setPageSize(50);
$request->setSort('total_sales');
$request->setStartTkRate(1000); // 10.00%

// Retrieve parameters for the API call
$params = $request->getApiParas();

The JdUnionPromotionByunionidGetRequest class is used to request promotion links from the Jingdong (JD) Union platform using a unionId. It implements RequestInterface and maps to the JD API method jd.union.open.promotion.byunionid.get.

Parameters

To use this request, instantiate the class, set the required parameters using the provided setter methods, and call getParamJson() to retrieve the JSON payload for the API call.

use NiuGengYun\EasyTBK\JingDong\Request\JdUnionPromotionByunionidGetRequest;

$request = new JdUnionPromotionByunionidGetRequest();
$request->setUnionId('TARGET_UNION_ID');
$request->setPid('SUB_ID_WEBSITE_ID_POSITION_ID');
$request->setMaterialId('https://...');
$request->setChainType(2); // Short link

// Get the JSON payload for the API request
$jsonPayload = $request->getParamJson();

The TbkScMaterialOptionalRequest class is used to construct a request for the Taobao TOP API taobao.tbk.sc.material.optional. This API allows you to search for and filter Taobao promotional materials (SC materials) based on various criteria such as category, price range, commission rate, and more.

To use this class, instantiate it and use the provided setter methods to populate the request parameters. Required fields include adzone_id and site_id.

use NiuGengYun\EasyTBK\TaoBao\request\TbkScMaterialOptionalRequest;

$request = new TbkScMaterialOptionalRequest();
$request->setAdzoneId('YOUR_ADZONE_ID');
$request->setSiteId('YOUR_SITE_ID');
$request->setQ('search keyword');
$request->setPageSize(50);
$request->setSort('total_sales'); // Options: _des, _asc, total_sales, tk_rate, tk_total_sales, tk_total_commi, price

// Validate the request
$request->check();

// Get parameters for the API call
$params = $request->getApiParas();