喜鹿 / 库存产品API
StockProductApi模块提供了一个REST API,用于简单的产品库存更新。
1.0.0.beta.1
2023-03-20 07:43 UTC
Requires
- php: >=8.0
- spryker/api: ^0.4.0
- spryker/api-extension: ^0.1.0
- spryker/api-query-builder: ^0.1
- spryker/stock: ^8.0.0
Requires (Dev)
This package is auto-updated.
Last update: 2024-08-27 12:32:10 UTC
README
StockProductApi模块提供了一个REST API,用于简单的产品库存更新。
包从 fond-of-spryker/stock-api
转移而来
安装
composer require fond-of-oryx/stock-product-api
在 ApiDependencyProvider
中注册插件
/**
* @return \Spryker\Zed\Api\Dependency\Plugin\ApiResourcePluginInterface[]
*/
protected function getApiResourcePluginCollection(): array
{
return [
...
new StockProductApiResourcePlugin(),
];
}
/**
* @return \Spryker\Zed\Api\Dependency\Plugin\ApiValidatorPluginInterface[]
*/
protected function getApiValidatorPluginCollection(): array
{
return [
...
new StockProductApiValidatorPlugin(),
];
}
API
更新具体产品的库存。 sku
、stock_type
和 quantity
是必填字段。
PATCH /api/rest/stock-products/{id_stock_product}
示例
curl -X PATCH "http://zed.yourdomain.com/api/rest/stock-products/{id_stock_product}" \ -H 'Content-Type: application/json' \ -d $'{ "data": { "sku": "SKU", "stock_type": "EU", "quantity": 10, "is_never_out_of_stock": true } }'
创建具体产品的库存。 sku
、stock_type
和 quantity
是必填字段。
POST /api/rest/stock-products
示例
curl -X POST "http://zed.yourdomain.com/api/rest/stock-products" \ -H 'Content-Type: application/json' \ -d $'{ "data": { "sku": "SKU", "stock_type": "EU", "quantity": 10, "is_never_out_of_stock": true } }'
通过 sku
和 stock_type
(名称)查找具体库存产品
GET /api/rest/stock-products?filter={"condition":"AND","rules":[{"id":"name","field":"name","type":"string","input":"text","operator":"equal","value":"EU"},{"id":"sku","field":"sku","type":"string","input":"text","operator":"equal","value":"SKU"}]}
示例
curl -X GET "http://zed.yourdomain.com/api/rest/stock-products?filter=$'{"condition":"AND","rules":[{"id":"name","field":"name","type":"string","input":"text","operator":"equal","value":"EU"},{"id":"sku","field":"sku","type":"string","input":"text","operator":"equal","value":"SKU"}]}'" \ -H 'Content-Type: application/json'
通过 idStockProduct 获取库存产品
GET /api/rest/stock-products/{id_stock_product}
示例
curl -X GET "http://zed.yourdomain.com/api/rest/stock-products/{id_stock_product}" \ -H 'Content-Type: application/json'