README

这是Kaufland.de卖家API v2。更多详细信息请访问https://sellerapi.kaufland.com/

安装与使用

要求

PHP 7.4及更高版本。也应与PHP 8.0兼容。

Composer

要使用Composer安装绑定，请将以下内容添加到composer.json

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/wpify/kaufland-api-php-sdk.git"
    }
  ],
  "require": {
    "wpify/kaufland-api-php-sdk": "*@dev"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

入门指南

请按照安装过程进行操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new KauflandApiClient\Api\AttributesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id_attribute = 21; // int | The ID of the attribute
$storefront = new \KauflandApiClient\Model\Storefront(); // Storefront | Specifies the store by country
$locale = new \KauflandApiClient\Model\ProductDataLocale(); // ProductDataLocale | Allows clients to consume the data in languages that are different from the storefront-default locale

try {
    $result = $apiInstance->getAttribute($id_attribute, $storefront, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttributesApi->getAttribute: ', $e->getMessage(), PHP_EOL;
}

API端点

所有URI相对于/v2

类	方法	HTTP请求	描述
AttributesApi	getAttribute	GET /attributes/{id_attribute}	通过ID获取属性
AttributesApi	getAttributeByName	GET /attributes/by-name/{name}	通过名称获取属性
AttributesApi	getAttributeList	GET /attributes	获取属性列表
AttributesApi	getAttributeListBySearch	GET /attributes/search	通过搜索词获取属性
CarriersApi	getCarriers	GET /carriers	获取可用承运商列表
CategoriesApi	decideCategory	POST /categories/decide	猜测分类
CategoriesApi	getCategoriesList	GET /categories	通过搜索词获取分类列表
CategoriesApi	getCategory	GET /categories/{id_category}	通过ID获取分类
CategoriesApi	getCategoryTree	GET /categories/tree	获取完整的分类树
ImportFilesApi	createInventoryCommandImportFile	POST /import-files/inventory-command	添加INVENTORY_COMMAND文件URL
ImportFilesApi	createInventoryFeedImportFile	POST /import-files/inventory-feed	添加INVENTORY_FEED文件URL
ImportFilesApi	createOrderCommandImportFile	POST /import-files/order-command	添加ORDER_COMMAND文件URL
ImportFilesApi	getInventoryCommandImportFile	GET /import-files/inventory-command/{id_import_file}	通过ID获取库存命令导入文件
ImportFilesApi	getInventoryCommandImportFiles	GET /import-files/inventory-command	获取您的库存命令导入文件列表
ImportFilesApi	getInventoryFeedImportFile	GET /import-files/inventory-feed/{id_import_file}	通过ID获取库存导入文件
ImportFilesApi	getInventoryFeedImportFiles	GET /import-files/inventory-feed	获取您的库存导入文件列表
ImportFilesApi	getOrderCommandImportFile	GET /import-files/order-command/{id_import_file}	通过ID获取订单命令导入文件
ImportFilesApi	getOrderCommandImportFiles	GET /import-files/order-command	获取您的订单命令导入文件列表
InfoApi	getAllLocales	GET /info/locale	获取'locale'参数的值
InfoApi	getAllStorefronts	GET /info/storefront	获取'storefront'参数的值
OrderInvoicesApi	deleteOrderInvoice	DELETE /order-invoices/{id_order}/{id_invoice}	通过给定的订单ID和发票ID删除订单发票
OrderInvoicesApi	getOrderInvoice	GET /order-invoices/{id_order}/{id_invoice}	通过订单ID和发票ID获取订单发票
OrderInvoicesApi	getOrderInvoices	GET /order-invoices	获取订单发票列表
OrderInvoicesApi	uploadOrderInvoice	POST /order-invoices/{id_order}	将订单发票上传到指定的订单
订单单元API	取消订单单元	PATCH /order-units/{id_order_unit}/cancel	取消订单单元
订单单元API	履行订单单元	PATCH /order-units/{id_order_unit}/fulfil	标记订单单元为履行状态
订单单元API	获取订单单元	GET /order-units/{id_order_unit}	通过ID获取订单单元
订单单元API	获取订单单元列表	GET /order-units	获取订单单元列表
订单单元API	退款订单单元	PATCH /order-units/{id_order_unit}/refund	向客户发送退款
订单单元API	发送订单单元	PATCH /order-units/{id_order_unit}/send	标记订单单元为已发送
订单API	获取订单	GET /orders/{id_order}	通过ID获取订单
订单API	获取订单列表	GET /orders	获取订单列表
产品数据API	创建产品数据	PUT /product-data	为EAN添加新产品数据或替换现有数据
产品数据API	创建产品数据文件	POST /product-data/import-files	添加导入文件URL
产品数据API	删除产品数据	DELETE /product-data/{ean}	删除EAN的产品数据
产品数据API	获取产品数据	GET /product-data/{ean}	获取EAN的产品数据
产品数据API	获取产品数据文件	GET /product-data/import-files/{id_import_file}	通过ID获取导入文件
产品数据API	获取产品数据文件列表	GET /product-data/import-files	获取导入文件
产品数据API	获取产品数据状态	GET /product-data/status/{ean}	获取产品数据处理状态
产品数据API	更新产品数据	PATCH /product-data	更新EAN的现有产品数据
产品API	获取产品	GET /products/{id_product}	通过ID获取产品
产品API	通过EAN获取产品	GET /products/ean/{ean}	通过EAN获取产品
产品API	获取产品列表	GET /products/search	通过搜索词获取产品列表
报告API	获取报告	GET /reports/{id_report}	通过ID获取单个报告的元数据
报告API	获取报告列表	GET /reports	获取报告列表
报告API	请求账户清单报告	POST /reports/account-listing	排队库存报告
报告API	请求带商店价格的账户清单报告	POST /reports/account-listing-with-shop-price	排队库存报告
报告API	请求取消报告	POST /reports/cancellations	排队取消报告
报告API	请求竞争对手比较报告	POST /reports/competitors-comparer	排队竞争对手比较报告
报告API	请求未找到EAN的报告	POST /reports/eans-not-found	排队未找到EAN的报告
报告API	请求新预订报告	POST /reports/bookings-new	排队预订报告
报告API	请求新销售报告	POST /reports/sales-new	排队销售报告
报告API	请求产品数据变更报告	POST /reports/product-data-changes	排队产品数据变更报告
报告API	请求产品数据导入文件错误报告	POST /reports/product-data-import-file-errors	排队产品数据导入文件错误报告
退货单元API	接受退货单元	PATCH /return-units/{id_return_unit}/accept	接受退货单元
退货单元API	澄清退货单元	PATCH /return-units/{id_return_unit}/clarify	澄清退货单元
退货单元API	通过ID获取退货单元	GET /return-units/{id_return_unit}	通过ID获取退货单元
退货单元API	获取退货单元列表	GET /return-units	获取退货单元列表
退货单元API	拒绝退货单元	PATCH /return-units/{id_return_unit}/reject	拒绝退货单元
退货单元API	维修退货单元	PATCH /return-units/{id_return_unit}/repair	维修退货单元
退货API	通过ID获取退货	GET /returns/{id_return}	通过ID获取退货
退货API	获取退货列表	GET /returns	获取退货列表
退货API	初始化退货	POST /returns	初始化退货
退货API	更新退货	PUT /returns/{id_return}	向已存在的退货中添加一个或多个订单单元
ShipmentsApi	addShipment	POST /shipments	向已标记为已发送的订单单元添加一个发货
ShippingGroupsApi	getShippingGroup	GET /shipping-groups/{id_shipping_group}	通过ID获取一个发货组
ShippingGroupsApi	getShippingGroups	GET /shipping-groups	获取预定义的发货组列表
StatusApi	ping	GET /status/ping	通过Kaufland的Marketplace Seller API进行ping
SubscriptionsApi	addSubscription	POST /subscriptions	订阅事件
SubscriptionsApi	deleteSubscription	DELETE /subscriptions/{id_subscription}	取消订阅事件
SubscriptionsApi	getSubscription	GET /subscriptions/{id_subscription}	通过ID获取推送通知订阅
SubscriptionsApi	getSubscriptions	GET /subscriptions	获取推送通知订阅列表
SubscriptionsApi	updateSubscription	PATCH /subscriptions/{id_subscription}	更新订阅
TicketsApi	closeTicket	PATCH /tickets/{id_ticket}/close	通过ID关闭一个工单
TicketsApi	createTicketMessage	POST /tickets/{id_ticket}/messages	为工单创建新消息
TicketsApi	getTicket	GET /tickets/{id_ticket}	通过ID获取一个工单
TicketsApi	getTicketMessages	GET /tickets/messages	获取工单消息列表
TicketsApi	getTickets	GET /tickets	获取工单列表
TicketsApi	openTicket	POST /tickets	打开一个工单
UnitsApi	createUnit	POST /units	添加一个单元
UnitsApi	deleteUnit	DELETE /units/{id_unit}	删除一个单元
UnitsApi	getUnit	GET /units/{id_unit}	通过ID获取一个单元
UnitsApi	getUnits	GET /units	获取你的单元列表
UnitsApi	patchUnit	PATCH /units/{id_unit}	更新单元的一些字段
WarehousesApi	createWarehouse	POST /warehouses	创建一个新的仓库
WarehousesApi	deleteWarehouse	DELETE /warehouses/{id_warehouse}	删除一个仓库
WarehousesApi	getWarehouse	GET /warehouses/{id_warehouse}	通过其ID获取一个仓库
WarehousesApi	getWarehouses	GET /warehouses	获取你的仓库列表
WarehousesApi	updateWarehouse	PUT /warehouses/{id_warehouse}	更新一个仓库

Models

Authorization

所有端点都不需要授权。

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

seller-api-support@kaufland-online.de

关于此包

此PHP包由OpenAPI Generator项目自动生成

API版本：2.10.1
构建包：org.openapitools.codegen.languages.PhpClientCodegen

wpify / kaufland-api-php-sdk

维护者

详细信息