'1.0',
'info' => ['style' => 'ROA', 'product' => 'linkedmall', 'version' => '2023-09-30'],
'directories' => [
[
'children' => ['ListPurchaserShops', 'GetPurchaserShop'],
'type' => 'directory',
'title' => 'Procurement store',
],
[
'children' => ['GetSelectionProduct', 'ListSelectionProducts', 'GetSelectionProductSaleInfo', 'ListSelectionProductSaleInfos', 'ListSelectionSkuSaleInfos', 'ListCategories', 'SearchProducts', 'SelectionGroupAddProduct', 'SelectionGroupRemoveProduct'],
'type' => 'directory',
'title' => 'Product',
],
[
'children' => ['SplitPurchaseOrder', 'RenderPurchaseOrder', 'CreatePurchaseOrder', 'GetPurchaseOrderStatus'],
'type' => 'directory',
'title' => 'Purchase order',
],
[
'children' => ['GetOrder', 'QueryOrders', 'ListLogisticsOrders', 'ConfirmDisburse'],
'type' => 'directory',
'title' => 'Order',
],
[
'children' => ['RenderRefundOrder', 'CreateRefundOrder', 'CancelRefundOrder', 'GetRefundOrder', 'CreateGoodsShippingNotice'],
'type' => 'directory',
'title' => 'After-sales order',
],
[
'children' => ['QueryChildDivisionCode'],
'type' => 'directory',
'title' => 'Region code',
],
],
'components' => [
'schemas' => [
'AddressInfo' => [
'title' => '地址',
'description' => 'Shipping address',
'type' => 'object',
'properties' => [
'divisionCode' => ['title' => '三级地址code(建议必填)', 'description' => 'The level-4 address code for the district or county. This parameter is recommended.', 'type' => 'string', 'required' => false, 'example' => '330106'],
'addressDetail' => ['title' => '收货地址详细地址', 'description' => 'The detailed shipping address. Enter the full address in the format of province, city, district/county, street, and community.', 'type' => 'string', 'required' => true, 'example' => '陕西省西安市新城区xx街道xxx大厦xx室'],
'receiverPhone' => ['title' => '收货人电话', 'description' => 'The phone number of the recipient.', 'type' => 'string', 'required' => true, 'example' => '182***5674'],
'townDivisionCode' => ['title' => '四级地址code(建议必填)', 'description' => 'The level-5 address code for the town or street. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => '330106109'],
'receiver' => ['title' => '收货人', 'description' => 'The recipient.', 'type' => 'string', 'required' => true, 'example' => '任先生'],
'addressId' => ['title' => '地址ID', 'description' => 'The address ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
'example' => '',
],
'ApplyReason' => [
'title' => '申请理由',
'description' => 'The reason for the refund request.',
'type' => 'object',
'properties' => [
'reasonTextId' => ['title' => '理由ID', 'description' => 'The reason ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '403769'],
'reasonTips' => ['title' => '理由文本', 'description' => 'The reason text.', 'type' => 'string', 'required' => false, 'example' => '不想要了'],
],
'example' => '',
],
'Category' => [
'description' => 'The category chain.',
'type' => 'object',
'properties' => [
'name' => ['title' => '类目名称', 'description' => 'The name of the category.', 'type' => 'string', 'required' => false, 'example' => '名称测试'],
'isLeaf' => ['title' => '是否叶子类目', 'description' => 'Indicates whether the category is a leaf category.', 'type' => 'boolean', 'example' => 'false', 'required' => false],
'level' => ['title' => '层级', 'description' => 'The level of the category.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
'categoryId' => ['title' => '类目id', 'description' => 'The ID of the category.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '201792301'],
'parentId' => ['title' => '父类id', 'description' => 'The ID of the parent category.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
'title' => '',
'example' => '',
],
'CategoryListQuery' => [
'title' => '类目查询参数',
'description' => 'Category query parameters ',
'type' => 'object',
'properties' => [
'parentCategoryId' => ['title' => '父类目id', 'description' => 'Parent category ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '5200001'],
'categoryIds' => [
'title' => '类目id集合',
'description' => 'Collection of category IDs ',
'type' => 'array',
'items' => ['type' => 'integer', 'format' => 'int64', 'example' => '5200067', 'description' => 'Category ID '."\n"
.'> The maximum number of category IDs allowed in a single query is 50. ', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'CategoryListResult' => [
'title' => '类目查询结果',
'description' => 'category',
'type' => 'object',
'properties' => [
'requestId' => ['title' => '请求id', 'description' => 'request ID', 'type' => 'string', 'example' => ''],
'categories' => [
'title' => '类目集合',
'description' => 'category collection',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/Category', 'description' => '', 'title' => '', 'example' => ''],
'example' => '',
],
],
'example' => '',
],
'ConfirmDisburseCmd' => [
'title' => '',
'description' => 'The input parameters for confirming receipt.'."\n"
.'> '."\n"
.'> - If both the purchaseOrderId and orderId fields are specified, the system uses the purchaseOrderId field, which means all orders under the purchase order are confirmed.',
'type' => 'object',
'properties' => [
'orderId' => ['title' => '', 'description' => 'The primary distribution order ID.', 'type' => 'string', 'required' => false, 'example' => '6692****5457'],
'purchaseOrderId' => ['title' => '', 'description' => 'The distribution transaction ID.', 'type' => 'string', 'required' => false, 'example' => '6692****5696'],
'disputeId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
'ConfirmDisburseResult' => [
'title' => '确认收货结果',
'description' => 'Confirm Delivery Result ',
'type' => 'object',
'properties' => [
'result' => ['title' => '确认收货返回结果', 'description' => 'Return Result of Confirm Delivery ', 'type' => 'string', 'required' => false, 'example' => 'success'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'API Request requestId ', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
],
'example' => '',
],
'CooperationShop' => [
'title' => '合作方店铺',
'description' => 'The partner shop.',
'type' => 'object',
'properties' => [
'shopId' => ['title' => '店铺id', 'description' => 'The shop ID.', 'type' => 'string', 'example' => ''],
'cooperationCompanyId' => ['title' => '合作企业id', 'description' => 'The partner company ID.', 'type' => 'string', 'example' => ''],
'cooperationShopId' => ['title' => '合作店铺id', 'description' => 'The partner shop ID.', 'type' => 'string', 'example' => ''],
],
'example' => '',
],
'DeliveryInfo' => [
'title' => '履约信息',
'description' => 'Fulfillment Information ',
'type' => 'object',
'properties' => [
'postFee' => ['title' => '运费金额', 'description' => 'Shipping fee amount ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
'serviceType' => ['title' => 'serviceType', 'description' => 'serviceType', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-4'],
'id' => ['title' => '唯一ID', 'description' => 'Unique ID ', 'type' => 'string', 'required' => false, 'example' => '20'],
'displayName' => ['title' => '显示名称', 'description' => 'Display name ', 'type' => 'string', 'required' => false, 'example' => '快递 免邮'],
],
'example' => '',
],
'DistributionMaxRefundFee' => [
'title' => '退费金额',
'description' => 'Refund fee ',
'type' => 'object',
'properties' => [
'minRefundFee' => ['title' => '本单最小可退款金额', 'description' => 'Minimum refundable amount for this order ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'maxRefundFee' => ['title' => '本单最大可退款金额', 'description' => 'Maximum refundable amount for this order ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
'example' => '',
],
'Division' => [
'title' => '区域信息',
'description' => 'divisionList',
'type' => 'object',
'properties' => [
'divisionName' => ['title' => '地址名称', 'description' => 'Address Name ', 'type' => 'string', 'required' => false, 'example' => '上海'],
'divisionCode' => ['title' => '地址编码', 'description' => 'Address encoding ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '310000'],
'divisionLevel' => ['title' => '地址等级', 'description' => 'Address Level ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
'pinyin' => ['title' => '地址拼音', 'description' => 'Address pinyin ', 'type' => 'string', 'required' => false, 'example' => 'shang hai'],
'parentId' => ['title' => '父级ID', 'description' => 'Parent ID ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
'example' => '',
],
'DivisionPageResult' => [
'title' => '区域分页返回',
'description' => 'Paged region results',
'type' => 'object',
'properties' => [
'divisionList' => [
'title' => '区域集合',
'description' => 'Collection of regions',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/Division', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'requestId' => ['title' => '接口请求requestId', 'description' => 'API request ID', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
],
'example' => '',
],
'DivisionQuery' => [
'title' => '区域查询',
'description' => 'Area query',
'type' => 'object',
'properties' => [
'divisionCode' => ['title' => 'divisionCode', 'description' => 'divisionCode', 'type' => 'string', 'required' => true, 'example' => '1', 'default' => '1'],
],
'example' => '',
],
'EticketInfo' => [
'type' => 'object',
'properties' => [
'code' => ['description' => 'The unique code for the e-ticket.', 'type' => 'string', 'title' => '', 'example' => 'taobao******tpg'],
'qrcodeUrl' => ['description' => 'The URL of the QR code image for the e-ticket.'."\n"
."\n"
.'> This field is not currently populated. Distributors must generate the QR code using the `code` field.', 'type' => 'string', 'title' => '', 'example' => 'http://qrcode.alicdn.com/img.jpg'],
'codeStatus' => [
'description' => 'The status of the e-ticket.'."\n"
."\n"
.'> Valid enum values:'."\n"
.'>'."\n"
.'> - 1: valid'."\n"
.'>'."\n"
.'> - -1: redeemed'."\n"
.'>'."\n"
.'> - -2: expired'."\n"
.'>'."\n"
.'> - -5: expired'."\n"
.'>'."\n"
.'> - -8: expired',
'enumValueTitles' => [1 => '有效', -1 => '已核销', -2 => '已失效', -5 => '已失效', -8 => '已失效'],
'type' => 'integer',
'title' => '',
'example' => "\n"
.'-1',
'format' => 'int64',
],
'startTime' => ['description' => 'The start time of the e-ticket validity period.', 'type' => 'string', 'title' => '', 'example' => "\n"
.'2026-02-04T00:00:00.000+08:00'],
'endTime' => ['description' => 'The end time of the e-ticket validity period.', 'type' => 'string', 'title' => '', 'example' => '2026-08-02T23:59:59.000+08:00'],
'usedNum' => ['description' => 'The number of redeemed units.', 'type' => 'integer', 'title' => '', 'example' => '1', 'format' => 'int64'],
'useTime' => ['description' => 'The time the e-ticket was redeemed.', 'type' => 'string', 'title' => '', 'example' => "\n"
.'2026-02-04T15:07:59.000+08:00'],
'lockNum' => ['description' => 'The number of locked units.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int64'],
'availableNum' => ['description' => 'The number of available units.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int64'],
],
'description' => 'Contains the details of an e-ticket.',
'title' => '',
'example' => '',
],
'GeneralBill' => [
'description' => 'bill',
'type' => 'object',
'properties' => [
'totalAmount' => ['required' => false, '$ref' => '#/components/schemas/Money', 'description' => '', 'title' => '', 'example' => ''],
'gmtModified' => ['title' => '账单修改时间', 'description' => 'bill Updated At', 'type' => 'string', 'required' => false, 'example' => ''],
'billId' => ['title' => '账单id', 'description' => 'bill ID', 'type' => 'string', 'required' => false, 'example' => ''],
'downloadUrl' => [
'title' => '明细下载地址',
'description' => 'download URL for details',
'type' => 'array',
'items' => ['title' => '明细下载地址', 'description' => 'download URL for details', 'type' => 'string', 'required' => false, 'example' => ''],
'required' => false,
'example' => '',
],
'shopName' => ['title' => '店铺名称', 'description' => 'shop Name', 'type' => 'string', 'required' => false, 'example' => ''],
'startTime' => ['title' => '账期开始时间', 'description' => 'billing cycle Start Time', 'type' => 'string', 'required' => false, 'example' => ''],
'endTime' => ['title' => '账期结束时间', 'description' => 'billing cycle End Time', 'type' => 'string', 'required' => false, 'example' => ''],
'shopId' => ['title' => '店铺id', 'description' => 'shop ID', 'type' => 'string', 'required' => false, 'example' => ''],
'gmtCreate' => ['title' => '账单创建时间', 'description' => 'bill Creation Time', 'type' => 'string', 'required' => false, 'example' => ''],
'billPeriod' => ['title' => '账期', 'description' => 'billing cycle', 'type' => 'string', 'required' => false, 'example' => ''],
],
'title' => '',
'example' => '',
],
'GeneralBillPageQuery' => [
'title' => '账单查询入参',
'description' => 'Bill query input parameters ',
'type' => 'object',
'properties' => [
'asc' => ['title' => 'asc', 'description' => 'asc', 'type' => 'boolean', 'required' => false, 'example' => ''],
'pageNumber' => ['title' => 'pageNumber', 'description' => 'pageNumber', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''],
'billId' => ['title' => 'billId', 'description' => 'billId', 'type' => 'string', 'required' => false, 'example' => ''],
'limit' => ['title' => 'limit', 'description' => 'limit', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''],
'start' => ['title' => 'start', 'description' => 'start', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''],
'orderBy' => ['title' => 'orderBy', 'description' => 'orderBy', 'type' => 'string', 'required' => false, 'example' => ''],
'orderDirection' => ['title' => 'orderDirection', 'description' => 'orderDirection', 'type' => 'string', 'required' => false, 'example' => ''],
'pageSize' => ['title' => 'pageSize', 'description' => 'pageSize', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''],
'shopId' => ['title' => 'shopId', 'description' => 'shopId', 'type' => 'string', 'required' => false, 'example' => ''],
'billPeriod' => ['title' => 'billPeriod', 'description' => 'billPeriod', 'type' => 'string', 'required' => false, 'example' => ''],
],
'example' => '',
],
'GeneralBillPageResult' => [
'title' => '',
'description' => 'Bill query result.',
'type' => 'object',
'properties' => [
'pageSize' => ['title' => '', 'description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''],
'total' => ['title' => '', 'description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'],
'pageNumber' => ['title' => '', 'description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''],
'requestId' => ['title' => '', 'description' => 'API request ID.', 'type' => 'string', 'required' => false, 'example' => '3239281273464326823'],
'generalBills' => [
'title' => '',
'description' => 'List of bills.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/GeneralBill', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
],
'example' => '',
],
'Good' => [
'description' => 'Product collection ',
'type' => 'object',
'properties' => [
'goodName' => ['title' => '货品名称', 'description' => 'Product name ', 'type' => 'string', 'required' => false, 'example' => '儿童学习桌'],
'productId' => ['title' => '商品ID', 'description' => 'Product ID ', 'type' => 'string', 'required' => false, 'example' => '6600****6736'],
'quantity' => ['title' => '数量', 'description' => 'Quantity ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'skuId' => ['description' => 'SKU ID ', 'title' => 'skuId', 'type' => 'string', 'example' => '7232****2321'],
'skuTitle' => ['description' => 'SKU title ', 'title' => 'sku标题', 'type' => 'string', 'example' => '白色'],
],
'title' => '',
'example' => '',
],
'GoodsShippingNoticeCreateCmd' => [
'title' => '提交物流入参',
'description' => 'Submit logistics input parameters ',
'type' => 'object',
'properties' => [
'cpCode' => [
'title' => '公司代码',
'description' => 'Company code ',
'type' => 'string',
'required' => true,
'example' => 'SF',
'enumValueTitles' => [
'TAOBAO' => '淘宝物流', 'YUNDA' => '韵达快递', 'ZJS' => '宅急送', 'FEDEX' => '联邦快递', 'ZTKY' => '中铁物流', 'POST' => '中国邮政', 'DBKD' => '德邦物流', 'EMS' => 'EMS', 'JT' => '极兔物流', 'QFKD' => '全峰快递',
'POSTB' => '邮政快递包裹', 'EYB' => '邮政电商标快EYB', 'STO' => '申通快递', 'OTHER' => '其他', 'SF' => '顺丰速运', 'ZTO' => '中通快递', 'YTO' => '圆通快递', 'TTKDEX' => '天天快递', 'JDLEx' => '京东快递', 'CNDJWL' => '菜鸟大件物流',
'TN' => '特能', 'HTKY' => '百世快递', 'SHQ' => '华强物流', 'ZMKM' => '菜鸟速递',
],
],
'logisticsNo' => ['title' => '物流单号', 'description' => 'Logistics tracking number ', 'type' => 'string', 'required' => true, 'example' => 'SF145****4353'],
'disputeId' => ['title' => '纠纷ID', 'description' => 'Dispute ID ', 'type' => 'string', 'format' => 'int64', 'required' => true, 'example' => '6693****4352'],
],
'example' => '',
],
'GoodsShippingNoticeCreateResult' => [
'title' => '提交物流结果',
'description' => 'Submit logistics result ',
'type' => 'object',
'properties' => [
'result' => ['title' => '提交物流信息返回结果', 'description' => 'Return result of submitting logistics information ', 'type' => 'string', 'required' => false, 'example' => 'success'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'API request requestId ', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
],
'example' => '',
],
'LeavePictureList' => [
'title' => '图片信息',
'description' => 'Credential ',
'type' => 'object',
'properties' => [
'picture' => ['title' => '图片地址', 'description' => 'Image of the after-sales Credential>If the after-sales order rendering API returns that an after-sales image is required, this field is mandatory. ', 'type' => 'string', 'required' => false, 'example' => 'https://img.alicdn.com/imgextra/i3/221428******/O1CN01w4vomR1QYYE*******_!!221428*******.jpg'],
'desc' => ['title' => '描述', 'description' => 'Description>If the after-sales order rendering API returns that a message description is required, this field is mandatory. ', 'type' => 'string', 'required' => false, 'example' => '外观破损了。'],
],
'example' => '',
],
'LimitRule' => [
'title' => '限购配置',
'description' => 'Purchase limit rule',
'type' => 'object',
'properties' => [
'ruleType' => [
'title' => '限购类型',
'description' => 'Purchase limit type',
'enumValueTitles' => ['UpperNumberPerUserPeriod' => '周期总量限购', 'LowerNumberPerBuy' => '单次限购最低购买数量', 'UpperNumberPerBuy' => '单次限购', 'UpperNumberPerUser' => '总量限购'],
'type' => 'string',
'example' => 'UpperNumberPerUser',
],
'limitNum' => ['title' => '限购数量', 'description' => 'Purchase limit quantity'."\n"
."\n"
.'> If multiple purchase limit rules are active at the same time, the final limit is the minimum value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'beginTime' => ['title' => '生效开始时间', 'description' => 'Start time of validity'."\n"
."\n"
.'> UNIX timestamp in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1724947200000'],
'endTime' => ['title' => '生效截止时间', 'description' => 'End time of validity'."\n"
."\n"
.'> UNIX timestamp in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '1724947200000'],
'condcase' => [
'title' => '周期条件',
'description' => 'Period condition'."\n"
."\n"
.'> This field applies only when ruleType is UpperNumberPerUserPeriod.',
'enumValueTitles' => ['Null' => 'Null', 'week' => '每周', 'month' => '每月', 'day' => '每天'],
'type' => 'string',
'example' => 'day',
],
],
'example' => '',
],
'LogisticsDetail' => [
'title' => '物流详情',
'description' => 'Collection of logistics details ',
'type' => 'object',
'properties' => [
'ocurrTimeStr' => ['title' => '物流发生时间', 'description' => 'Time when the logistics event occurred ', 'type' => 'string', 'required' => false, 'example' => '2023-09-11T12:22:24.000+08:00'],
'standerdDesc' => ['title' => '物流描述信息', 'description' => 'Description of the logistics event ', 'type' => 'string', 'required' => false, 'example' => '已签收'],
],
'example' => '',
],
'LogisticsInformationData' => [
'title' => 'A short description of struct',
'description' => 'Logistics information.',
'type' => 'object',
'properties' => [
'purchaserId' => ['title' => '采购方id', 'description' => 'The ID of the purchaser.', 'type' => 'string', 'example' => 'PID22000009'],
'trackingCompanyCode' => ['title' => '快递公司代码', 'description' => 'The code of the logistics company.', 'type' => 'string', 'example' => 'SF'],
'trackingCompanyName' => ['title' => '快递公司名称', 'description' => 'The name of the logistics company.', 'type' => 'string', 'example' => '顺丰快递'],
'modifiedTime' => ['title' => '更新时间 yyyy-MM-dd HH:mm:ss', 'description' => 'The time when the information was last updated, in yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '1713407100321'],
'orderLineId' => ['title' => '子单id', 'description' => 'The ID of the order line.', 'type' => 'string', 'example' => '6692****5458'],
'trackingNumber' => ['title' => '快递单号', 'description' => 'The tracking number.', 'type' => 'string', 'example' => 'SF198913131'],
'outerPurchaseOrderId' => ['title' => '创建采购单传入的外部采购单号', 'description' => 'The external ID of the purchase order, provided upon creation.', 'type' => 'string', 'example' => '233111'],
'logisticsStatus' => ['title' => '物流状态 2=已发货 -> 等待买家确认收货', 'description' => 'The logistics status. A value of 2 indicates that the order is shipped and awaits the buyer\'s confirmation of receipt.', 'type' => 'string', 'example' => '1'],
'orderId' => ['title' => '订单id', 'description' => 'The order ID.', 'type' => 'string', 'example' => '6696070566****8593'],
],
'example' => '',
],
'LogisticsOrderListResult' => [
'title' => '物流单信息',
'description' => 'Logistics order information',
'type' => 'object',
'properties' => [
'logisticsOrderList' => [
'title' => '物流集合',
'description' => 'Collection of logistics orders',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/LogisticsOrderResult', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'requestId' => ['title' => '接口请求requestId', 'description' => 'Request ID for the API call', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
],
'example' => '',
],
'LogisticsOrderResult' => [
'description' => 'Represents a logistics order.',
'type' => 'object',
'properties' => [
'mailNo' => ['title' => '物流单号', 'description' => 'The tracking number.'."\n"
."\n"
.'> For an e-ticket, the tracking number is a fixed value: \\*', 'type' => 'string', 'required' => false, 'example' => 'SF234***2345'],
'dataProviderTitle' => ['title' => '数据文本', 'description' => 'The display title of the data provider.', 'type' => 'string', 'required' => false, 'example' => '菜鸟裹裹'],
'logisticsCompanyName' => ['title' => '物流公司名称', 'description' => 'The name of the logistics company.', 'type' => 'string', 'required' => false, 'example' => '顺丰'],
'logisticsDetailList' => [
'title' => '物流详情',
'description' => 'A list of logistics details.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/LogisticsDetail', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'goods' => [
'title' => '货品详情',
'description' => 'Details of the goods.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/Good', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'dataProvider' => ['title' => '数据来源', 'description' => 'The data provider.', 'type' => 'string', 'required' => false, 'example' => '菜鸟'],
'logisticsCompanyCode' => [
'title' => '物流公司代码',
'description' => 'The logistics company code.'."\n"
."\n"
.'> Valid values:'."\n"
.'>'."\n"
.'> - `ZTKY` - China Railway Logistics'."\n"
.'>'."\n"
.'> - `POST` - China Post'."\n"
.'>'."\n"
.'> - `DBKD` - Deppon Express'."\n"
.'>'."\n"
.'> - `JT` - J\\&T Express'."\n"
.'>'."\n"
.'> - `QFKD` - Quanfeng Express'."\n"
.'>'."\n"
.'> - `EYB` - China Post E-commerce Express'."\n"
.'>'."\n"
.'> - `STO` - STO Express'."\n"
.'>'."\n"
.'> - `SF` - SF Express'."\n"
.'>'."\n"
.'> - `ZTO` - ZTO Express'."\n"
.'>'."\n"
.'> - `YTO` - YTO Express'."\n"
.'>'."\n"
.'> - `TTKDEX` - Tiantian Express'."\n"
.'>'."\n"
.'> - `JDLEx` - JD Express'."\n"
.'>'."\n"
.'> - `ETICKET` - e-ticket'."\n"
.'>'."\n"
.'> - `HTKY` - Best Express'."\n"
.'>'."\n"
.'> - `SHQ` - Huaqiang Logistics'."\n"
.'>'."\n"
.'> - `TAOBAO` - Taobao Logistics'."\n"
.'>'."\n"
.'> - `YUNDA` - Yunda Express'."\n"
.'>'."\n"
.'> - `ZJS` - ZJS Express'."\n"
.'>'."\n"
.'> - `FEDEX` - FedEx'."\n"
.'>'."\n"
.'> - `EMS` - EMS'."\n"
.'>'."\n"
.'> - `POSTB` - China Post Parcel'."\n"
.'>'."\n"
.'> - `OTHER` - other'."\n"
.'>'."\n"
.'> - `CNDJWL` - Cainiao Heavy Parcel Logistics'."\n"
.'>'."\n"
.'> - `TN` - T-neng Logistics'."\n"
.'>'."\n"
.'> - `ZMKM` - Cainiao Express',
'enumValueTitles' => [
'TAOBAO' => '淘宝物流', 'YUNDA' => '韵达快递', 'ZJS' => '宅急送', 'FEDEX' => '联邦快递', 'ZTKY' => '中铁物流', 'POST' => '中国邮政', 'DBKD' => '德邦物流', 'EMS' => 'EMS', 'JT' => '极兔物流', 'QFKD' => '全峰快递',
'POSTB' => '邮政快递包裹', 'EYB' => '邮政电商标快EYB', 'STO' => '申通快递', 'OTHER' => '其他', 'SF' => '顺丰速运', 'ZTO' => '中通快递', 'YTO' => '圆通快递', 'TTKDEX' => '天天快递', 'JDLEx' => '京东快递', 'CNDJWL' => '菜鸟大件物流',
'TN' => '特能', 'HTKY' => '百世快递', 'SHQ' => '华强物流', 'ZMKM' => '菜鸟速递',
],
'type' => 'string',
'required' => false,
'example' => 'SF',
],
],
'title' => '',
'example' => '',
],
'Money' => [
'description' => 'Bill amount ',
'type' => 'object',
'properties' => [
'amount' => ['title' => 'amount', 'description' => 'amount', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
'amountString' => ['title' => 'amountString', 'description' => 'amountString', 'type' => 'string', 'required' => false, 'example' => ''],
'cent' => ['title' => 'cent', 'description' => 'cent', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => ''],
'amountAsString' => ['title' => 'amountAsString', 'description' => 'amountAsString', 'type' => 'string', 'required' => false, 'example' => ''],
'currency' => [
'title' => 'currency',
'description' => 'currency',
'type' => 'object',
'properties' => [
'symbol' => ['title' => 'symbol', 'description' => 'symbol', 'type' => 'string', 'required' => false, 'example' => ''],
'displayName' => ['title' => 'displayName', 'description' => 'displayName', 'type' => 'string', 'required' => false, 'example' => ''],
'currencyCode' => ['title' => 'currencyCode', 'description' => 'currencyCode', 'type' => 'string', 'required' => false, 'example' => ''],
'defaultFractionDigits' => ['title' => 'defaultFractionDigits', 'description' => 'defaultFractionDigits', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''],
'numericCode' => ['title' => 'numericCode', 'description' => 'numericCode', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => ''],
],
'required' => false,
'example' => '',
],
'positive' => ['title' => 'positive', 'description' => 'positive', 'type' => 'boolean', 'required' => false, 'example' => ''],
'currencyCode' => ['title' => 'currencyCode', 'description' => 'currencyCode', 'type' => 'string', 'required' => false, 'example' => ''],
],
'title' => '',
'example' => '',
],
'OrderLineResult' => [
'title' => '子单信息',
'description' => 'A collection of order line items.',
'type' => 'object',
'properties' => [
'productTitle' => ['title' => '商品名称', 'description' => 'The product name.', 'type' => 'string', 'required' => false, 'example' => '儿童学习桌'],
'number' => ['title' => '数量', 'description' => 'The number of items.', 'type' => 'string', 'required' => false, 'example' => '1'],
'skuTitle' => ['title' => 'sku名称', 'description' => 'The SKU name.', 'type' => 'string', 'required' => false, 'example' => '浅绿色'],
'productId' => ['title' => '商品ID', 'description' => 'The unique ID of the product.', 'type' => 'string', 'required' => false, 'example' => '6600****6736'],
'orderId' => ['title' => '订单id(主订单id)', 'description' => 'The unique ID of the main order.', 'type' => 'string', 'required' => false, 'example' => '6692****5457'],
'productPic' => ['title' => '商品图片', 'description' => 'The URL of the product image.', 'type' => 'string', 'required' => false, 'example' => '//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0'],
'orderLineId' => ['title' => '子订单id', 'description' => 'The unique ID of the order line.', 'type' => 'string', 'required' => false, 'example' => '6692****5458'],
'logisticsStatus' => [
'title' => '物流状态',
'description' => 'The logistics status of the order line.',
'enumValueTitles' => [1 => '未发货>待卖家发货', '已发货>待买家收货', '已收货>确认收货', 6 => '部分发货', 8 => '未创建物流订单'],
'type' => 'string',
'required' => false,
'example' => '1',
],
'payFee' => ['title' => '子订单应付金额', 'description' => 'The payable amount for the order line.', 'type' => 'integer', 'example' => '100', 'format' => 'int64', 'required' => false],
'skuId' => ['title' => 'skuId', 'description' => 'The unique ID of the SKU.', 'type' => 'string', 'required' => false, 'example' => '6600****6737'],
'orderLineStatus' => [
'title' => '子订单状态',
'description' => 'The status of the order line.',
'enumValueTitles' => [1 => '待付款', '已付款', 4 => '退款成功', 6 => '交易成功', 8 => '交易关闭'],
'type' => 'string',
'required' => false,
'example' => '1',
],
'eticketInfos' => [
'type' => 'array',
'items' => ['description' => 'An electronic voucher.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/EticketInfo'],
'description' => 'A list of electronic vouchers.',
'title' => '',
'example' => '',
],
],
'example' => '',
],
'OrderListResult' => [
'title' => '订单分页结果',
'description' => 'Paged order results',
'type' => 'object',
'properties' => [
'orderList' => [
'title' => '订单集合',
'description' => 'Collection of orders',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/OrderResult', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'requestId' => ['title' => '接口请求requestId', 'description' => 'The request ID for the API call', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
'total' => ['title' => '总数量', 'description' => 'Total number of orders', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'],
],
'example' => '',
],
'OrderPageQuery' => [
'title' => '',
'description' => 'The input parameters for the order paged query.',
'type' => 'object',
'properties' => [
'pageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
'orderIdList' => [
'title' => '',
'description' => 'The list of primary order IDs.',
'type' => 'array',
'items' => ['description' => 'The order ID (orderId).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '8234****1234'],
'required' => false,
'example' => '',
],
'pageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
'purchaseOrderId' => ['title' => '', 'description' => 'The purchase order ID.', 'type' => 'string', 'required' => false, 'example' => '6692****5696'],
'outPurchaseOrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
'OrderProductResult' => [
'title' => '订单商品信息',
'description' => 'Product information ',
'type' => 'object',
'properties' => [
'productTitle' => ['title' => '商品标题', 'description' => 'Product title ', 'type' => 'string', 'required' => false, 'example' => '儿童学习桌'],
'features' => ['title' => '商品额外信息', 'description' => 'Additional product information ', 'type' => 'object', 'required' => false, 'example' => ''],
'skuTitle' => ['title' => 'sku标题', 'description' => 'SKU title ', 'type' => 'string', 'required' => false, 'example' => '浅绿色'],
'quantity' => ['title' => '购买数量', 'description' => 'Quantity ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'productId' => ['title' => '商品id', 'description' => 'Product ID ', 'type' => 'string', 'required' => false, 'example' => '6600****6736'],
'canSell' => ['title' => '商品是否可售卖', 'description' => 'Indicates whether the product is available for sale ', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'price' => ['title' => '商品价格(单位:分)', 'description' => 'Product price (unit: cent) ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'productPicUrl' => ['title' => '商品图片链接', 'description' => 'Product image link ', 'type' => 'string', 'required' => false, 'example' => '//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0'],
'purchaserId' => ['title' => '采购方id', 'description' => 'Purchaser ID ', 'type' => 'string', 'required' => false, 'example' => 'PID56****2304'],
'message' => ['title' => '不可售原因', 'description' => 'Reason for unavailability ', 'type' => 'string', 'required' => false, 'example' => '库存为0'],
'skuId' => ['title' => 'SKUID', 'description' => 'SKUID', 'type' => 'string', 'required' => false, 'example' => '6600****6737'],
],
'example' => '',
],
'OrderRenderProductDTO' => [
'title' => '渲染商品',
'description' => 'Product collection ',
'type' => 'object',
'properties' => [
'quantity' => ['title' => '购买数量', 'description' => 'Quantity ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
'purchaserId' => ['title' => '采购方id', 'description' => 'Purchaser ID ', 'type' => 'string', 'required' => true, 'example' => 'PID56****2304'],
'productId' => ['title' => '商品ID', 'description' => 'Product ID ', 'type' => 'string', 'required' => true, 'example' => '6600****6736'],
'skuId' => ['title' => 'skuID', 'description' => 'skuID', 'type' => 'string', 'required' => true, 'example' => '6600****6737'],
],
'example' => '',
],
'OrderRenderResult' => [
'title' => '采购单渲染返回',
'description' => 'The list of unavailable items in the order.',
'type' => 'object',
'properties' => [
'message' => ['title' => '不可售原因', 'description' => 'The reason why the item is unavailable.', 'type' => 'string', 'required' => false, 'example' => '库存为0'],
'deliveryInfoList' => [
'title' => '履约信息',
'description' => 'The fulfillment information.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/DeliveryInfo', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'canSell' => ['title' => '是否可售', 'description' => 'Indicates whether the item can be sold.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'productList' => [
'title' => '商品集合',
'description' => 'The list of products.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/OrderProductResult', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'extInfo' => ['title' => '扩展信息', 'description' => 'The extension information.', 'type' => 'object', 'required' => false, 'example' => ''],
],
'example' => '',
],
'OrderResult' => [
'title' => '订单详情',
'description' => 'Information about the main order.',
'type' => 'object',
'properties' => [
'orderAmount' => ['title' => '订单金额(分)', 'description' => 'The order amount, in cents.', 'type' => 'integer', 'required' => false, 'example' => '100', 'format' => 'int64'],
'orderLineList' => [
'title' => '子订单集合',
'description' => 'The list of sub-orders.',
'type' => 'array',
'items' => ['description' => 'An object that represents a single sub-order.', 'required' => false, '$ref' => '#/components/schemas/OrderLineResult', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'orderId' => ['title' => '订单id(主订单id)', 'description' => 'The ID of the main order.', 'type' => 'string', 'required' => false, 'example' => '6692****5457'],
'distributorId' => ['title' => '分销商ID', 'description' => 'The distributor ID.', 'type' => 'string', 'required' => false, 'example' => '12****01'],
'orderStatus' => ['title' => '订单状态1=待支付,2=已支付,4=已退款关闭,6=交易成功,8=已关闭', 'description' => 'The order status. Valid values: 1 (Pending Payment), 2 (Paid), 4 (Closed with Refund), 6 (Transaction Successful), and 8 (Closed).', 'type' => 'string', 'required' => false, 'example' => '1'],
'logisticsStatus' => ['title' => '物流状态 1=未发货 -> 等待卖家发货 2=已发货 -> 等待买家确认收货 3=已收货 -> 交易成功 4=已经退货 -> 交易失败 5=部分收货 -> 交易成功 6=部分发货中 8=还未创建物流订单', 'description' => 'The logistics status. Valid values: 1 (Awaiting Seller\'s Shipment), 2 (Awaiting Buyer\'s Confirmation), 3 (Received), 4 (Returned), 5 (Partially Received), 6 (Partially Shipped), and 8 (Logistics Order Not Created).', 'type' => 'string', 'required' => false, 'example' => '1'],
'createDate' => ['title' => '创建时间', 'description' => 'The order creation time.', 'type' => 'string', 'required' => false, 'example' => '2023-09-11T12:22:24.000+08:00'],
'requestId' => ['title' => '请求ID', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '841471F6-5D61-1331-8C38-2****B55'],
'orderClosedReason' => ['title' => '订单关单原因', 'description' => 'The reason the order was closed.', 'type' => 'string', 'example' => '系统关单'],
],
'example' => '',
],
'Product' => [
'title' => '商品',
'description' => 'The product.',
'type' => 'object',
'properties' => [
'categoryChain' => [
'title' => '类目链',
'description' => 'The category chain.',
'type' => 'array',
'items' => ['description' => 'A category in the chain.', 'required' => false, '$ref' => '#/components/schemas/Category', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'skus' => [
'title' => 'skus',
'description' => 'The product SKUs.',
'type' => 'array',
'items' => ['description' => 'A product SKU.', 'required' => false, '$ref' => '#/components/schemas/Sku', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'lmItemId' => ['title' => 'LM商品id', 'description' => 'The LM product ID.', 'type' => 'string', 'example' => '2100****7-458****812'],
'canSell' => [
'title' => '商品是否可售,计算值',
'description' => 'Indicates whether the product is available for sale. This is a calculated value.',
'enumValueTitles' => ['flase' => '不可售', 'true' => '可售'],
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'fuzzyQuantity' => [
'title' => '模糊库存',
'description' => 'The stock status.',
'enumValueTitles' => ['有货' => '有货', '库存紧张' => '库存紧张', '无货' => '无货'],
'type' => 'string',
'required' => false,
'example' => '有货',
],
'title' => ['title' => '标题', 'description' => 'The product title.', 'type' => 'string', 'required' => false, 'example' => '发财树'],
'extendProperties' => [
'description' => 'The product\'s extended properties.',
'title' => '商品扩展属性',
'type' => 'array',
'items' => ['description' => 'An extended property.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ProductExtendProperty'],
'example' => '',
],
'servicePromises' => [
'description' => 'The service promises.> Suppliers maintain all service promises. If a supplier fails to update this information in a timely manner, the service promise labels for some products may be inaccurate. Distributors should display this information to their customers with caution.>',
'title' => '服务承诺',
'type' => 'array',
'items' => ['title' => 'SEVEN_DAYS:7天无理由退货', 'description' => 'A service promise. For example, `SEVEN_DAYS` indicates a 7-day return for any reason.', 'type' => 'string', 'example' => ''],
'example' => '',
],
'soldQuantity' => ['title' => '销量', 'description' => 'The quantity sold.', 'type' => 'string', 'required' => false, 'example' => '100+'],
'picUrl' => ['title' => '商品主图', 'description' => 'The main product image URL.', 'type' => 'string', 'required' => false, 'example' => 'https://img.alicdn.com/imgextra/i3/221*******988/O1CN01w4vomR1QYYEx6nyr5_!!221******988.jpg'],
'categoryLeafId' => ['title' => '类目id', 'description' => 'The leaf category ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '201****501'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => '3239281273******823'],
'shopId' => ['title' => '渠道店铺id', 'description' => 'The channel shop ID.', 'type' => 'string', 'required' => false, 'example' => '210*****7'],
'inGroup' => [
'title' => '是否入库',
'description' => 'The warehousing status.',
'enumValueTitles' => ['true' => '已入库', 'false' => '已出库'],
'type' => 'boolean',
'example' => 'True',
],
'productType' => [
'title' => '商品类型',
'description' => 'The product type.',
'enumValueTitles' => ['Virtual' => '虚拟类型', 'Normal' => '普通商品'],
'type' => 'string',
'required' => false,
'example' => 'Normal',
'enum' => ['Normal', 'Virtual'],
],
'images' => [
'title' => 'images',
'description' => 'The product images.',
'type' => 'array',
'items' => ['description' => 'An image URL.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '[]'],
'required' => false,
'example' => '',
],
'brandName' => ['title' => '品牌名称', 'description' => 'The brand name.', 'type' => 'string', 'example' => 'Apple/苹果'],
'quantity' => ['title' => '库存', 'description' => 'The inventory.'."\n"
."\n"
.'> - This parameter is fixed at -1 and can be ignored.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'],
'productId' => ['title' => '商品id', 'description' => 'The product ID.', 'type' => 'string', 'required' => false, 'example' => '660460842******080'],
'productSpecs' => [
'title' => 'productSpecs',
'description' => 'The product specifications.',
'type' => 'array',
'items' => ['description' => 'A product specification.', 'required' => false, '$ref' => '#/components/schemas/ProductSpec', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'productStatus' => [
'title' => '商品状态',
'description' => 'The product status.',
'enumValueTitles' => ['Offline' => '下架状态', 'Online' => '上架状态'],
'type' => 'string',
'required' => false,
'example' => 'Online',
],
'taxCode' => ['title' => '税码', 'description' => 'The tax code.', 'type' => 'string', 'required' => false, 'example' => '3040203000*******000'],
'divisionCode' => ['title' => '区域码', 'description' => 'The region code.', 'type' => 'string', 'required' => false, 'example' => '110000'],
'taxRate' => ['title' => '税率', 'description' => 'The tax rate.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600'],
'limitRules' => [
'description' => 'The purchase limit rules.',
'title' => '限购配置',
'type' => 'array',
'items' => ['description' => 'Purchase Limit Rules ', '$ref' => '#/components/schemas/LimitRule', 'title' => '', 'example' => ''],
'example' => '',
],
'descPath' => ['title' => '商品详情链接', 'description' => 'The product description URL.', 'type' => 'string', 'required' => false, 'example' => 'https://img.alicdn.com/descpath/O1CN01wciRDp22AEU1*******f34'],
'properties' => [
'title' => '商品属性',
'description' => 'The product attributes.',
'type' => 'array',
'items' => ['description' => 'A product attribute.', 'required' => false, '$ref' => '#/components/schemas/ProductProperty', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
],
'example' => '',
],
'ProductDTO' => [
'title' => '商品信息',
'description' => 'Product collection ',
'type' => 'object',
'properties' => [
'quantity' => ['title' => '购买数量', 'description' => 'Quantity ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
'purchaserId' => ['title' => '采购方id', 'description' => 'Purchaser ID ', 'type' => 'string', 'required' => true, 'example' => '56****2304'],
'productId' => ['title' => '商品ID', 'description' => 'Product ID ', 'type' => 'string', 'required' => true, 'example' => '6600****6736'],
'price' => ['title' => '商品价格(单位:分)', 'description' => 'Product price (unit: cent)>It is recommended to include this field. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'skuId' => ['title' => 'SKUID', 'description' => 'SKUID', 'type' => 'string', 'required' => true, 'example' => '6600****6737'],
],
'example' => '',
],
'ProductExtendProperty' => [
'title' => '商品扩展属性',
'description' => 'The extended property of the product.',
'type' => 'object',
'properties' => [
'key' => [
'title' => '属性key',
'description' => 'The property key.'."\n"
."\n"
.'> Valid values:'."\n"
.'>'."\n"
.'> - - `ss_picture_scene` (scene picture)'."\n"
.'>'."\n"
.'> - - `ss_picture_white_background` (white background picture)'."\n"
.'>'."\n"
.'> - - `extraPeriod` (shelf life)'."\n"
.'>'."\n"
.'> - - `itemBoundaryInventoryZeroTag` (Reserved. Ignore this parameter.)'."\n"
.'>'."\n"
.'> - - `shoppingShowTitle` (shopping guide title)'."\n"
.'>'."\n"
.'> - - `itemCCStatus` (Reserved. Ignore this parameter.)'."\n"
.'>'."\n"
.'> - - `brandLogo` (brand logo)'."\n"
.'>'."\n"
.'> - - `multipleBuyLimit` (purchase multiple)'."\n"
.'>'."\n"
.'> - - `eticket_type` (electronic coupon type)'."\n"
.'>'."\n"
.'> - - `eticket_upper_buy_limit` (maximum purchase quantity of electronic coupons per order)'."\n"
.'>'."\n"
.'> - - `validity_type` (validity period type of electronic coupon)'."\n"
.'>'."\n"
.'> - - `etc_expiry_date` (Validity period of the electronic coupon. Valid only when `validity_type` is `1`.)'."\n"
.'>'."\n"
.'> - - `etc_duration_date` (Validity period of the electronic coupon. Valid only when `validity_type` is `2`, `3`, or `5`.)'."\n"
.'>'."\n"
.'> - - `f_refund` (Automatic refund ratio for valid electronic coupons)'."\n"
.'>'."\n"
.'> - - `refund` (automatic refund ratio for expired electronic coupons)'."\n"
.'>'."\n"
.'> - - `writeoff` (Reserved. Ignore this parameter.)',
'enumValueTitles' => ['ss_picture_scene' => '氛围图', 'ss_picture_white_background' => '白底图', 'extraPeriod' => '保质期', 'itemBoundaryInventoryZeroTag' => '保留字段,请忽略', 'itemCCStatus' => '保留字段,请忽略', 'brandLogo' => '品牌Logo图', 'multipleBuyLimit' => '购买倍数', 'shoppingShowTitle' => '商品导购标题'],
'type' => 'string',
'example' => 'ss_picture_scene',
],
'value' => ['title' => '属性值', 'description' => 'The property value.', 'type' => 'string', 'example' => '场景图'],
],
'example' => '',
],
'ProductPageResult' => [
'title' => '分页查询商品结果',
'description' => 'Paged query result for products',
'type' => 'object',
'properties' => [
'pageSize' => ['title' => '页大小', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
'total' => ['title' => '总数量', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '24'],
'pageNumber' => ['title' => '当前页码', 'description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'Request ID for the API call', 'type' => 'string', 'required' => false, 'example' => '3239281273464326823'],
'products' => [
'title' => '商品集合',
'description' => 'Collection of products',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/Product', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
],
'required' => true,
'example' => '',
],
'ProductPrice' => [
'description' => 'Product price ',
'type' => 'object',
'properties' => [
'fundAmountMoney' => ['title' => '应付金额', 'description' => 'Amount payable ', 'type' => 'string', 'required' => false, 'example' => '120'],
],
'title' => '',
'example' => '',
],
'ProductProperty' => [
'title' => '商品属性',
'description' => 'Product property',
'type' => 'object',
'properties' => [
'text' => ['title' => '属性文本', 'description' => 'The text of the property.', 'type' => 'string', 'required' => false, 'example' => '颜色'],
'values' => [
'title' => '属性值集合',
'description' => 'A collection of property values.',
'type' => 'array',
'items' => ['type' => 'string', 'required' => false, 'example' => '白色', 'description' => '', 'title' => ''],
'required' => false,
'example' => '',
],
],
'example' => '',
],
'ProductQuery' => [
'title' => '商品查询参数',
'description' => 'Product query parameter ',
'type' => 'object',
'properties' => [
'divisionCode' => ['title' => '区域码', 'description' => 'Area code ', 'type' => 'string', 'required' => false, 'example' => '110000'],
'distributorShopId' => ['title' => '分销店铺id', 'description' => 'Distributor shop ID ', 'type' => 'string', 'required' => true, 'example' => '22000009'],
],
'example' => '',
],
'ProductSaleInfo' => [
'title' => '商品',
'description' => 'Product',
'type' => 'object',
'properties' => [
'divisionCode' => ['title' => '区域码', 'description' => 'Region code', 'type' => 'string', 'required' => false, 'example' => '330106109'],
'quantity' => ['title' => '库存', 'description' => 'Inventory', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
'skus' => [
'title' => 'sku集合',
'description' => 'SKU collection',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/SkuSaleInfo', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'productId' => ['title' => '商品id', 'description' => 'Product ID', 'type' => 'string', 'required' => false, 'example' => '660460842235822080'],
'canSell' => ['title' => '商品是否可售,计算值', 'description' => 'Is sellable, calculated value', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'API request ID', 'type' => 'string', 'required' => false, 'example' => '3239281273464326823'],
'fuzzyQuantity' => [
'title' => '模糊库存',
'description' => 'Fuzzy inventory quantity.',
'enumValueTitles' => ['有货' => '有货', '库存紧张' => '库存紧张', '无货' => '无货'],
'type' => 'string',
'required' => false,
'example' => '有货',
],
'productStatus' => ['title' => '商品状态', 'description' => 'Product status', 'type' => 'string', 'required' => false, 'example' => 'Online'],
'shopId' => ['title' => '渠道店铺id', 'description' => 'Channel shop ID', 'type' => 'string', 'required' => false, 'example' => '21000017'],
'title' => ['title' => '标题', 'description' => 'Title', 'type' => 'string', 'required' => false, 'example' => '发财树'],
'lmItemId' => ['title' => 'LM商品id', 'description' => 'LM product ID', 'type' => 'string', 'example' => '21000017-4580902812'],
'limitRules' => [
'description' => 'Purchase limit configuration',
'title' => '限购配置',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/LimitRule', 'description' => '', 'title' => '', 'example' => ''],
'example' => '',
],
],
'example' => '',
],
'ProductSaleInfoListQuery' => [
'title' => '商品销售信息查询参数',
'description' => 'Product sales information query parameters ',
'type' => 'object',
'properties' => [
'divisionCode' => ['title' => '区域码', 'description' => 'Area code (recommended to use a five-level township/street-level address code) ', 'type' => 'string', 'required' => false, 'example' => '330106109'],
'productIds' => [
'title' => '查询商品id集合',
'description' => 'Collection of product IDs to query, supporting batch queries of 1 to 10 items ',
'type' => 'array',
'items' => ['title' => '查询商品id集合', 'description' => 'Collection of product IDs to query ', 'type' => 'string', 'required' => true, 'example' => '660460842235822080'],
'required' => true,
'example' => '',
],
'purchaserId' => ['title' => '采购方id', 'description' => 'Purchaser ID ', 'type' => 'string', 'required' => true, 'example' => '22000009'],
],
'required' => true,
'example' => '',
],
'ProductSaleInfoListResult' => [
'title' => '商品销售信息查询结果',
'description' => 'Query result for product sales information',
'type' => 'object',
'properties' => [
'requestId' => ['title' => '接口请求requestId', 'description' => 'The request ID of the API call', 'type' => 'string', 'required' => false, 'example' => '3239281273464326823'],
'productSaleInfos' => [
'title' => '商品销售信息',
'description' => 'Product sales information',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/ProductSaleInfo', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
],
'example' => '',
],
'ProductSaleInfoQuery' => [
'title' => '商品销售信息查询参数',
'description' => 'Product sales information query parameter ',
'type' => 'object',
'properties' => [
'divisionCode' => ['title' => '区域码', 'description' => 'Area code ', 'type' => 'string', 'required' => false, 'example' => '110000'],
'distributorShopId' => ['title' => '分销店铺id', 'description' => 'Distributor shop ID ', 'type' => 'string', 'required' => true, 'example' => '22000009'],
],
'example' => '',
],
'ProductSpec' => [
'title' => '商品规格',
'description' => 'Product specifications (sales properties).',
'type' => 'object',
'properties' => [
'keyId' => ['title' => '规格', 'description' => 'Specification', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
'key' => ['title' => '规格key名称', 'description' => 'The name of the specification key.', 'type' => 'string', 'required' => false, 'example' => '颜色分类'],
'values' => [
'title' => '规则key取值',
'description' => 'The values of the rule key.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/ProductSpecValue', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
],
'example' => '',
],
'ProductSpecValue' => [
'title' => '商品规格值',
'description' => 'Product specification value ',
'type' => 'object',
'properties' => [
'value' => ['title' => '规格值', 'description' => 'Specification value ', 'type' => 'string', 'required' => false, 'example' => '白色'],
'valueId' => ['title' => '规则值id', 'description' => 'Rule value ID ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
'valueAlias' => ['description' => 'Specification value alias ', 'title' => '规格值别名', 'type' => 'string', 'example' => '秘色'],
],
'example' => '',
],
'PurchaseOrderCreateCmd' => [
'title' => '采购单创建入参',
'description' => 'Purchase order creation request parameter',
'type' => 'object',
'properties' => [
'outerPurchaseOrderId' => ['title' => '分销商业务中的订单ID,分销商自定义', 'description' => 'Order ID in the distributor\'s business, customized by the distributor.', 'type' => 'string', 'required' => true, 'example' => 'outer123456'],
'buyerId' => ['title' => '分销商业务中的用户ID,分销商自定义。', 'description' => 'User ID in the distributor\'s business, customized by the distributor.'."\n"
."\n"
.'>'."\n"
."\n"
.'Allocate different buyer IDs for different buyers.'."\n"
."\n"
.'>', 'type' => 'string', 'required' => true, 'example' => 'buyer123456'],
'deliveryAddress' => ['title' => '地址信息', 'description' => 'Address information.', 'required' => true, '$ref' => '#/components/schemas/AddressInfo', 'example' => ''],
'productList' => [
'title' => '商品集合',
'description' => 'Product collection.'."\n"
."\n"
.'> Maximum number of SKUs per purchase order: 20.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/ProductDTO', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
'minItems' => 1,
'example' => '',
],
'extInfo' => ['title' => '扩展信息', 'description' => 'Extension information.', 'type' => 'object', 'required' => false, 'example' => ''],
],
'example' => '',
],
'PurchaseOrderCreateResult' => [
'title' => '采购单创建返回',
'description' => 'Purchase Order Creation Response ',
'type' => 'object',
'properties' => [
'purchaseOrderId' => ['title' => '采购单ID', 'description' => 'Purchase Order ID ', 'type' => 'string', 'required' => false, 'example' => '6692****5696'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'API Request requestId ', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
],
'example' => '',
],
'PurchaseOrderRenderQuery' => [
'title' => '采购单渲染入参',
'description' => 'Request parameters for purchase order rendering.',
'type' => 'object',
'properties' => [
'buyerId' => ['title' => '分销真实买家ID', 'description' => 'The ID of the end buyer.>Assign a unique ID to each buyer.>', 'type' => 'string', 'required' => true, 'example' => 'test1234567'],
'deliveryAddress' => ['title' => '地址信息', 'description' => 'Delivery address information.', 'required' => true, '$ref' => '#/components/schemas/AddressInfo', 'example' => ''],
'productList' => [
'title' => '商品集合',
'description' => 'A collection of products.'."\n"
."\n"
.'> A single purchase order can contain a maximum of 20 SKUs.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/OrderRenderProductDTO', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
'minItems' => 1,
'example' => '',
],
'extInfo' => ['title' => '扩展信息', 'description' => 'Extended information.', 'type' => 'object', 'required' => false, 'example' => '{}'],
],
'example' => '',
],
'PurchaseOrderRenderResult' => [
'title' => '采购单渲染结果',
'description' => 'The rendering result of the purchase order.',
'type' => 'object',
'properties' => [
'addressList' => [
'title' => '地址集合',
'description' => 'A collection of addresses.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/AddressInfo', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'canSell' => ['title' => '是否可售', 'description' => 'Indicates whether the item can be sold.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'The ID of the request.', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
'orderList' => [
'title' => '可售主单集合',
'description' => 'A collection of sellable main orders.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/OrderRenderResult', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'unsellableOrderList' => [
'title' => '不可售主单集合',
'description' => 'A collection of unsellable main orders.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/OrderRenderResult', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'message' => ['title' => '不可售原因', 'description' => 'The reason why the item cannot be sold.', 'type' => 'string', 'required' => false, 'example' => '库存为0'],
'extInfo' => ['title' => '扩展信息', 'description' => 'Extended information.', 'type' => 'object', 'required' => false, 'example' => ''],
],
'example' => '',
],
'PurchaseOrderStatusResult' => [
'title' => '采购单状态',
'description' => 'Purchase order status ',
'type' => 'object',
'properties' => [
'requestId' => ['title' => '接口请求requestId', 'description' => 'API request requestId ', 'type' => 'string', 'required' => false, 'example' => '3239281273464326823'],
'status' => [
'title' => '采购单状态',
'description' => 'Purchase order status ',
'type' => 'string',
'required' => false,
'example' => '10',
'enumValueTitles' => [1 => '采购单创建中', 10 => '采购中', 20 => '采购成功,待发货', '采购成功,部分发货', '采购成功,全部发货', 30 => '部分采购成功,待发货', '部分采购成功,部分发货', '部分采购成功,全部发货', 80 => '交易失败', 99 => '交易成功'],
],
],
'example' => '',
],
'RefundFeeData' => [
'title' => '退费金额信息',
'description' => 'Refund interval ',
'type' => 'object',
'properties' => [
'minRefundFee' => ['title' => '最小金额(分)', 'description' => 'Minimum amount (cents) ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'maxRefundFee' => ['title' => '最大金额(分)', 'description' => 'Maximum amount (cents) ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
'example' => '',
],
'RefundOrderCmd' => [
'title' => '创建逆向',
'description' => 'Create a return or refund request',
'type' => 'object',
'properties' => [
'applyRefundCount' => ['title' => '退货数量', 'description' => 'Number of items to return', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
'bizClaimType' => ['title' => '退款类型', 'description' => 'Refund type'."\n"
.'1: Refund only'."\n"
.'3: Return and refund', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
'goodsStatus' => ['title' => '货物状态', 'description' => 'Item status'."\n"
.'4: Not shipped'."\n"
.'1: Not received'."\n"
.'2: Received', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
'leaveMessage' => ['title' => '留言', 'description' => 'Customer message', 'type' => 'string', 'required' => false, 'example' => '不想要了'],
'applyReasonTextId' => ['title' => '退款原因ID', 'description' => 'Refund reason ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '47821'],
'applyReasonTips' => ['title' => '退款原因文本', 'description' => 'Refund reason text', 'type' => 'string', 'required' => false, 'example' => '不想要了'],
'applyRefundFee' => ['title' => '申请退款金额(分)', 'description' => 'Refund amount in cents', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
'leavePictureLists' => [
'title' => '图片集合',
'description' => 'Collection of images',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/LeavePictureList', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'orderLineId' => ['title' => '子分销订单ID', 'description' => 'Sub-distribution order ID', 'type' => 'string', 'required' => true, 'example' => '6692****5458'],
],
'example' => '',
],
'RefundOrderResult' => [
'title' => '逆向操作结果',
'description' => 'Reverse operation result ',
'type' => 'object',
'properties' => [
'orderLineId' => ['title' => '当前发起逆向的子分销订单号', 'description' => 'Sub-distribution order ID for which the reverse operation was initiated ', 'type' => 'string', 'required' => false, 'example' => '6692****5458'],
'disputeId' => ['title' => '纠纷id', 'description' => 'Dispute ID ', 'type' => 'string', 'required' => false, 'example' => '6693****4352'],
'disputeStatus' => ['title' => '逆向的状态', 'description' => 'Status of the reverse operation '."\n"
.'1 – Return pending '."\n"
.'2 – Awaiting buyer return '."\n"
.'3 – Awaiting merchant receipt '."\n"
.'4 – Refund closed '."\n"
.'5 – Refund succeeded '."\n"
.'6 – Refund denied '."\n"
.'17 – Canceling refund ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'API request ID ', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
],
'example' => '',
],
'RefundReason' => [
'title' => '逆向理由',
'description' => 'Refund reason ',
'type' => 'object',
'properties' => [
'reasonTextId' => ['title' => '理由文本id', 'description' => 'Reason text ID ', 'type' => 'string', 'required' => false, 'example' => '47683'],
'proofRequired' => ['title' => '是否要求上传凭证', 'description' => 'Is upload credential required ', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'reasonTips' => ['title' => '理由文本', 'description' => 'Reason text ', 'type' => 'string', 'required' => false, 'example' => '不想要了'],
'refundDescRequired' => ['title' => '是否要求留言', 'description' => 'Is a message required ', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'example' => '',
],
'RefundRenderCmd' => [
'title' => '逆向创建入参',
'description' => 'Input parameters for reverse creation ',
'type' => 'object',
'properties' => [
'bizClaimType' => ['title' => '退款类型 1 仅退款,3 退货退款', 'description' => 'Refund Type: 1 for refund only, 3 for return and refund ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
'goodsStatus' => ['title' => '货物状态 4: 未发货, 1: 未收到货, 2: 已收到货', 'description' => 'Goods Status: 4 for not shipped, 1 for not received, 2 for received ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '4'],
'orderLineId' => ['title' => '子分销订单ID', 'description' => 'Sub-distribution order ID ', 'type' => 'string', 'required' => true, 'example' => '6692****5458'],
],
'example' => '',
],
'RefundRenderResult' => [
'title' => '逆向渲染结果',
'description' => 'Refund rendering result.',
'type' => 'object',
'properties' => [
'maxRefundFeeData' => ['required' => false, '$ref' => '#/components/schemas/DistributionMaxRefundFee', 'description' => '', 'title' => '', 'example' => ''],
'refundReasonList' => [
'title' => '逆向理由集合',
'description' => 'A collection of refund reasons.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/RefundReason', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'bizClaimType' => ['title' => '支持的订单退货方式', 'description' => 'The return methods supported for the order.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'orderLineId' => ['title' => '子分销订单号', 'description' => 'The ID of the sub-distribution order.', 'type' => 'string', 'required' => false, 'example' => '6692****5458'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'The ID of the request.', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
],
'example' => '',
],
'RefundResult' => [
'title' => '逆向信息',
'description' => 'Reverse information ',
'type' => 'object',
'properties' => [
'refundFee' => ['title' => '退费金额', 'description' => 'Refund amount ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'refundFeeData' => ['title' => '退费区间', 'description' => 'Refund period ', 'required' => false, '$ref' => '#/components/schemas/RefundFeeData', 'example' => ''],
'applyDisputeDesc' => ['title' => '当前买家申请退款说明', 'description' => 'Current buyer\'s refund request description ', 'type' => 'string', 'required' => false, 'example' => '多拍不想要'],
'refunderTel' => ['title' => '退货联系方式', 'description' => 'Return contact information ', 'type' => 'string', 'required' => false, 'example' => '182****1334'],
'bizClaimType' => ['title' => '订单退货方式 1, 标识仅退款,3,标识退货退款', 'description' => 'Order return method '."\n"
.'1 – identity indicates refund only '."\n"
.'3 – identity indicates return and refund ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'disputeDesc' => ['title' => '申请逆向描述', 'description' => 'Reverse request description ', 'type' => 'string', 'required' => false, 'example' => '多拍不想要'],
'sellerRefuseReason' => ['title' => '商家拒绝原因', 'description' => 'Merchant denial reason ', 'type' => 'string', 'required' => false, 'example' => '商品没问题,买家举证无效'],
'orderId' => ['title' => '主单ID', 'description' => 'Main order ID ', 'type' => 'string', 'required' => false, 'example' => '6692****5457'],
'refunderName' => ['title' => '退货收货人', 'description' => 'Return recipient name ', 'type' => 'string', 'required' => false, 'example' => '赵先生'],
'applyReason' => ['title' => '申请理由', 'description' => 'Request reason ', 'required' => false, '$ref' => '#/components/schemas/ApplyReason', 'example' => ''],
'refunderAddress' => ['title' => '商家退货地址', 'description' => 'Merchant return address (available when disputeStatus=2, indicating the status is pending buyer return; save the return address during this status if needed) ', 'type' => 'string', 'required' => false, 'example' => '阿里云云谷'],
'refunderZipCode' => ['title' => '退货地址邮编', 'description' => 'Return address ZIP code ', 'type' => 'string', 'required' => false, 'example' => '331001'],
'disputeEndTime' => ['title' => '逆向结束时间', 'description' => 'Reverse process end time ', 'type' => 'string', 'required' => false, 'example' => '2023-09-15T19:23:59.000+08:00'],
'sellerRefuseAgreementMessage' => ['title' => '卖家拒绝的留言说明', 'description' => 'Merchant\'s message explaining the denial ', 'type' => 'string', 'required' => false, 'example' => '不同意退款'],
'disputeId' => ['title' => '逆向单ID', 'description' => 'Reverse order ID ', 'type' => 'string', 'required' => false, 'example' => '6693****4352'],
'disputeStatus' => ['title' => '逆向单状态', 'description' => 'Reverse order status '."\n"
.'1 – Return pending '."\n"
.'2 – Awaiting buyer return '."\n"
.'3 – Awaiting merchant receipt '."\n"
.'4 – Refund shutdown '."\n"
.'5 – Refund succeeded '."\n"
.'6 – Refund denied '."\n"
.'17 – Canceling refund ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'returnGoodLogisticsStatus' => ['title' => '退货物流状态', 'description' => 'Return logistics status '."\n"
.'0 – Return not initiated '."\n"
.'1 – Awaiting pickup '."\n"
.'2 – Package picked up '."\n"
.'3 – In transit '."\n"
.'4 – Out for delivery '."\n"
.'5 – Delivered '."\n"
.'6 – Delivery failed', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
'orderLogisticsStatus' => ['title' => '订单物流状态', 'description' => 'Order logistics status '."\n"
.'1 – Not shipped → Awaiting seller shipment '."\n"
.'2 – Shipped → Awaiting buyer confirmation of receipt '."\n"
.'3 – Received → Transaction succeeded '."\n"
.'6 – Partially shipping '."\n"
.'8 – Logistics order not yet created', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'disputeCreateTime' => ['title' => '逆向创建时间', 'description' => 'Dispute creation time', 'type' => 'string', 'required' => false, 'example' => '2023-09-15T19:23:59.000+08:00'],
'orderLineId' => ['title' => '子订单ID', 'description' => 'Sub-order ID', 'type' => 'string', 'required' => false, 'example' => '6692****5458'],
'sellerAgreeMsg' => ['title' => '卖家同意退货说明,真实的退货地址会在这个字段进行返回。', 'description' => 'Seller’s return approval message', 'type' => 'string', 'required' => false, 'example' => '同意退款'],
'requestId' => ['description' => 'Request ID', 'title' => '请求ID', 'type' => 'string', 'example' => '841471F6-5D61-1331-8C38-2****B55'],
],
'example' => '',
],
'Shop' => [
'title' => '店铺详情',
'description' => 'The details of the shop.',
'type' => 'object',
'properties' => [
'endDate' => ['title' => '结束时间', 'description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2023-09-11T12:22:24.000+08:00'],
'distributorId' => ['title' => '分销商id', 'description' => 'The ID of the distributor.', 'type' => 'string', 'required' => false, 'example' => '12****09'],
'shopName' => ['title' => '店铺名称', 'description' => 'The name of the shop.', 'type' => 'string', 'required' => false, 'example' => '儿童分销店铺'],
'shopId' => ['title' => '店铺id', 'description' => 'The ID of the shop.', 'type' => 'string', 'required' => false, 'example' => '22****09'],
'shopType' => ['title' => '店铺类型', 'description' => 'The type of the shop.', 'type' => 'string', 'required' => false, 'example' => 'DistributorQYG'],
'cooperationShops' => [
'description' => 'The partner shops.',
'title' => '合作方店铺',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/CooperationShop', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '12***01',
],
'startDate' => ['title' => '开始时间', 'description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2023-09-11T12:22:24.000+08:00'],
'status' => ['title' => '店铺状态', 'description' => 'The status of the shop.', 'type' => 'string', 'required' => false, 'example' => 'Working'],
'requestId' => ['title' => '接口请求requestId', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '48A34399-A72C-1E23-8388-7E63****E927'],
'purchaserId' => ['title' => '采购方id', 'description' => 'The ID of the purchaser.', 'type' => 'string', 'example' => 'PID56****2304'],
],
'example' => '',
],
'ShopPageDataResult' => [
'title' => '店铺分页结果',
'description' => 'Shop paging result',
'type' => 'object',
'properties' => [
'endDate' => ['title' => '结束时间', 'description' => 'End time', 'type' => 'string', 'required' => false, 'example' => '2023-09-11T12:22:24.000+08:00'],
'shopName' => ['title' => '店铺名称', 'description' => 'Shop name', 'type' => 'string', 'required' => false, 'example' => '儿童座椅分销店铺'],
'shopId' => ['title' => '店铺id', 'description' => 'Shop ID', 'type' => 'string', 'required' => false, 'example' => '22****09'],
'shopType' => ['title' => '店铺类型', 'description' => 'Shop type', 'type' => 'string', 'required' => false, 'example' => 'DistributorQYG'],
'cooperationShops' => [
'description' => 'Partner shops',
'title' => '合作方店铺',
'type' => 'array',
'items' => ['$ref' => '#/components/schemas/CooperationShop', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '12****01',
],
'startDate' => ['title' => '开始时间', 'description' => 'Start time', 'type' => 'string', 'required' => false, 'example' => '2023-09-11T12:22:24.000+08:00'],
'status' => ['title' => '店铺状态', 'description' => 'Shop status', 'type' => 'string', 'required' => false, 'example' => 'Working'],
'purchaserId' => ['title' => '采购方id', 'description' => 'Purchaser ID', 'type' => 'string', 'example' => 'PID56****2304'],
],
'example' => '',
],
'ShopPageResult' => [
'title' => '店铺分页查询返回',
'description' => 'Shop paged query return',
'type' => 'object',
'properties' => [
'requestId' => ['title' => '接口请求requestId', 'description' => 'API request ID', 'type' => 'string', 'required' => false, 'example' => '841471F6-5D61-1331-8C38-2****B55'],
'total' => ['title' => '总数量', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'],
'shopList' => [
'title' => '店铺集合',
'description' => 'Shop collection',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/ShopPageDataResult', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
],
'example' => '',
],
'Sku' => [
'description' => 'SKU list',
'type' => 'object',
'properties' => [
'quantity' => ['title' => '可售库存', 'description' => 'Available inventory. Note: This field is currently set to -1 for all SKUs and has no practical meaning.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'],
'productId' => ['title' => '商品Id', 'description' => 'Product ID', 'type' => 'string', 'required' => false, 'example' => '660460842235822080'],
'canSell' => ['title' => 'sku是否可售', 'description' => 'Indicates whether the SKU is available for sale', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'fuzzyQuantity' => [
'title' => '模糊可售库存',
'description' => 'Fuzzy inventory availability',
'enumValueTitles' => ['有货' => '有货', '库存紧张' => '库存紧张', '无货' => '无货'],
'type' => 'string',
'required' => false,
'example' => '有货'."\n"
.'无货'."\n"
.'库存紧张',
],
'skuStatus' => ['title' => 'sku管控状态', 'description' => 'SKU control status', 'type' => 'string', 'required' => false, 'example' => 'Online'],
'skuSpecsCode' => ['title' => 'sku销售规格,辅助前端来筛选', 'description' => 'SKU sales specification code. Used by the frontend to filter SKUs', 'type' => 'string', 'required' => false, 'example' => '颜色分类:天蓝色'],
'platformPrice' => ['title' => '平台当前售价, 单位分', 'description' => 'Suggested retail price, in cents', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '999900'],
'title' => ['title' => 'sku标题', 'description' => 'SKU title. Note: We recommend that distributors build the customer-facing SKU title by concatenating the value or valueAlias field from the SkuSpec struct (use `valueAlias` if it is present). Do not use this field directly as the customer-facing SKU title.', 'type' => 'string', 'required' => false, 'example' => '天蓝色'],
'divisionCode' => ['title' => '区域码', 'description' => 'Region code', 'type' => 'string', 'required' => false, 'example' => '110000'],
'picUrl' => ['title' => 'sku图片', 'description' => 'SKU image URL', 'type' => 'string', 'required' => false, 'example' => 'https:////img.alicdn.com/imgextra///img.alicdn.com/imgextra/i2/2216003305543/O1CN010DEQCX1qokFYGRfPE_!!2216003305543.png'],
'markPrice' => ['title' => '划线价, 单位分', 'description' => 'Strikethrough price, in cents', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '999900'],
'skuSpecs' => [
'title' => 'sku',
'description' => 'SKU specifications',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/SkuSpec', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
'price' => ['title' => '售价,单位分', 'description' => 'Distributor purchase price, in cents', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '19800'],
'shopId' => ['title' => '店铺Id', 'description' => 'Shop ID', 'type' => 'string', 'required' => false, 'example' => '21000017'],
'skuId' => ['title' => 'skuId', 'description' => 'SKU ID', 'type' => 'string', 'required' => false, 'example' => '660460842235822081'],
'barcode' => ['title' => '69码', 'description' => '69 barcode', 'type' => 'string', 'example' => '6922454329176'],
'rankValue' => ['title' => 'SKU排序', 'description' => 'SKU sort order', 'type' => 'integer', 'example' => '3', 'format' => 'int64'],
'suggestedRetailPrice' => ['title' => '建议零售价(无优惠)', 'description' => 'Reserved field', 'type' => 'integer', 'example' => '', 'format' => 'int64'],
'discountRetailPrice' => ['title' => '建议零售价(券后)', 'description' => 'Reserved field', 'type' => 'integer', 'example' => '', 'format' => 'int64'],
'skuAlias' => ['title' => 'sku别名', 'description' => 'SKU note', 'type' => 'string', 'example' => ''],
],
'title' => '',
'example' => '',
],
'SkuQueryParam' => [
'title' => '查询商品参数',
'description' => 'Query Product parameters ',
'type' => 'object',
'properties' => [
'productId' => ['title' => '商品id', 'description' => 'Product ID ', 'type' => 'string', 'required' => true, 'example' => '660460842235822080'],
'skuId' => ['title' => 'skuid', 'description' => 'skuid', 'type' => 'string', 'required' => true, 'example' => '660460842235822081'],
'buyAmount' => ['description' => 'Quantity ', 'title' => '购买数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
'example' => '',
],
'SkuSaleInfo' => [
'title' => 'SKU详细信息',
'description' => 'SKU details ',
'type' => 'object',
'properties' => [
'divisionCode' => ['title' => '区域码', 'description' => 'Area code ', 'type' => 'string', 'required' => false, 'example' => '330106109'],
'markPrice' => ['title' => '划线价, 单位分', 'description' => 'Strikethrough price, in cents ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '999900'],
'quantity' => ['title' => '可售库存', 'description' => 'Available inventory ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1'],
'productId' => ['title' => '商品Id', 'description' => 'Product ID ', 'type' => 'string', 'required' => false, 'example' => '660460842235822080'],
'canSell' => ['title' => 'sku是否可售', 'description' => 'Indicates whether the SKU is sellable ', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'price' => ['title' => '售价,单位分', 'description' => 'Distributor purchase price, in cents ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '19800'],
'fuzzyQuantity' => [
'title' => '模糊可售库存',
'description' => 'Blur inventory availability ',
'type' => 'string',
'required' => false,
'example' => '有货',
'enumValueTitles' => ['有货' => '有货', '库存紧张' => '库存紧张', '无货' => '无货'],
],
'skuStatus' => ['title' => 'sku管控状态', 'description' => 'SKU control status ', 'type' => 'string', 'required' => false, 'example' => 'Online'],
'shopId' => ['title' => '店铺Id', 'description' => 'Shop ID ', 'type' => 'string', 'required' => false, 'example' => '21000017'],
'title' => ['title' => 'sku标题', 'description' => 'SKU title ', 'type' => 'string', 'required' => false, 'example' => '天蓝色'],
'skuId' => ['title' => 'skuId', 'description' => 'skuId', 'type' => 'string', 'required' => false, 'example' => '660460842235822081'],
'canNotSellReason' => ['description' => 'Reason for not being sellable ', 'title' => '不可售原因', 'type' => 'string', 'example' => '不可售'],
],
'example' => '',
],
'SkuSaleInfoListQuery' => [
'title' => 'SKU销售信息查询参数',
'description' => 'SKU sales information query parameters',
'type' => 'object',
'properties' => [
'divisionCode' => ['title' => '区域码', 'description' => 'Region code. Use a five-level administrative division code, such as a town or subdistrict code.', 'type' => 'string', 'required' => false, 'example' => '330106109'],
'purchaserId' => ['title' => '采购方id', 'description' => 'Purchaser ID', 'type' => 'string', 'required' => true, 'example' => '21000017'],
'skuQueryParams' => [
'title' => '查询商品参数',
'description' => 'Product query parameters'."\n"
."\n"
.'> You can query up to 20 SKUs per request.',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/SkuQueryParam', 'description' => '', 'title' => '', 'example' => ''],
'required' => true,
'example' => '',
],
],
'required' => true,
'example' => '',
],
'SkuSaleInfoListResult' => [
'title' => '商品销售信息查询结果',
'description' => 'Product sales information query result',
'type' => 'object',
'properties' => [
'requestId' => ['title' => '接口请求requestId', 'description' => 'Request ID of the API call', 'type' => 'string', 'required' => false, 'example' => '3239281273464326823'],
'skuSaleInfos' => [
'title' => 'sku库存集合',
'description' => 'Collection of SKU inventory records',
'type' => 'array',
'items' => ['required' => false, '$ref' => '#/components/schemas/SkuSaleInfo', 'description' => '', 'title' => '', 'example' => ''],
'required' => false,
'example' => '',
],
],
'example' => '',
],
'SkuSpec' => [
'title' => 'sku规格',
'description' => 'SKU specification (sales property)',
'type' => 'object',
'properties' => [
'keyId' => ['title' => '规格id', 'description' => 'Specification ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
'valueId' => ['title' => '规格值id', 'description' => 'Specification value ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
'value' => ['title' => '规格值', 'description' => 'Specification value', 'type' => 'string', 'required' => false, 'example' => '天蓝色'],
'key' => ['title' => '规格键', 'description' => 'Specification key', 'type' => 'string', 'required' => false, 'example' => '颜色分类'],
'valueAlias' => ['description' => 'Specification value alias (Recommendation: If this field is not empty (null), use its value as the frontend display specification; if this field is empty (null), use the value field as the frontend display specification.)', 'title' => '规格值别名', 'type' => 'string', 'example' => '秘色'],
],
'example' => '',
],
],
],
'apis' => [
'CancelRefundOrder' => [
'summary' => 'Cancels a refund order.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/refunds/{disputeId}/commands/cancel',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'disputeId',
'in' => 'path',
'allowEmptyValue' => true,
'schema' => ['description' => 'The ID of the refund order.', 'type' => 'string', 'required' => false, 'example' => '601853367760207872', 'title' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'The refund order resource.', 'required' => false, '$ref' => '#/components/schemas/RefundOrderResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"orderLineId\\": \\"6692****5458\\",\\n \\"disputeId\\": \\"6693****4352\\",\\n \\"disputeStatus\\": 1,\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\"\\n}","type":"json"}]',
'title' => 'Cancel the after-sales order',
'description' => 'Cancel a refund order.',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "0F5BFCA7-98B9-1D59-80C2-30622***CFB1",'."\n"
.' "orderLineId": "66931024438***7746",'."\n"
.' "disputeStatus": 1,'."\n"
.' "disputeId": "66931163166***4352"'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CancelRefundOrder'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'linkedmall:CancelRefundOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ConfirmDisburse' => [
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/orders/commands/confirmDisburse',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['title' => '', 'description' => 'The request body for confirming the receipt of goods.', 'required' => true, '$ref' => '#/components/schemas/ConfirmDisburseCmd', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'schema' => ['description' => 'The result of confirming the receipt of goods.', 'required' => false, '$ref' => '#/components/schemas/ConfirmDisburseResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'title' => 'Confirm receipt of goods',
'summary' => 'Confirms the receipt of goods.',
'description' => 'Confirms the receipt of goods.',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "orderId": "6696667996****5953"'."\n"
.'}',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "FF83DFBE-CBF2-1D73-83A3-5010****C402",'."\n"
.' "result": "success"'."\n"
.'}',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ConfirmDisburse'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'linkedmall:ConfirmDisburse',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": \\"success\\",\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\"\\n}","type":"json"}]',
],
'CreateGoodsShippingNotice' => [
'summary' => 'Backfill shipping notice information.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/refunds/command/createGoodsShippingNotice',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['description' => 'Submit shipping notice information.', 'required' => true, '$ref' => '#/components/schemas/GoodsShippingNoticeCreateCmd', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Operation result.', 'required' => false, '$ref' => '#/components/schemas/GoodsShippingNoticeCreateResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"result\\": \\"success\\",\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\"\\n}","type":"json"}]',
'title' => 'Backfill Waybill Information',
'description' => 'Backfill shipping notice information.',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "cpCode": "YUNDA",'."\n"
.' "disputeId": "6696233432****5024",'."\n"
.' "logisticsNo": "4334027****6583"'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "FA53BE49-2740-1AE1-BCBE-3640****5BE5",'."\n"
.' "result": "success"'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'linkedmall:CreateGoodsShippingNotice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateGoodsShippingNotice'],
],
],
],
'CreatePurchaseOrder' => [
'summary' => 'Creates a purchase order and returns the purchase order ID. The specific result of order creation is communicated through messages. After the order is created, you can query the order details associated with the purchase order using the order API.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/purchaseOrders',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['description' => 'Creates a purchase order.', 'required' => true, '$ref' => '#/components/schemas/PurchaseOrderCreateCmd', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Purchase order creation result (returns the purchase order ID).'."\n"
.'>Note: Purchase order creation is an asynchronous task. If a distributor calls this API and receives an abnormal status (such as error code 503), do not immediately process customer refunds. Distributors must wait for and consume the PurchaseOrderCreate message (purchase order creation result message) to determine the order status (for example, by consuming the order status synchronization message) before processing business logic. This prevents financial losses.>', 'required' => false, '$ref' => '#/components/schemas/PurchaseOrderCreateResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"purchaseOrderId\\": \\"6692****5696\\",\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\"\\n}","type":"json"}]',
'title' => 'Create Purchase Order'."\n",
'description' => 'Creates a purchase order and returns the purchase order ID. Messages communicate the specific result of order creation. After the order is created, you can query the order details associated with the purchase order using the order API.'."\n"
.'>Note: Purchase order creation is an asynchronous task. If a distributor calls this API and receives an abnormal status (such as error code 503), do not immediately process customer refunds. Distributors must wait for and consume the PurchaseOrderCreate message (the purchase order creation result message) to determine the order status—for example, by consuming the order status synchronization message—before proceeding with business logic. This prevents financial losses.>'."\n"
.'>Note: If you do not receive the PurchaseOrderCreate message (the purchase order creation result message) after calling the purchase order creation API, submit a ticket to the technical support team to inquire about the cause.>',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "outerPurchaseOrderId": "outer00****0",'."\n"
.' "deliveryAddress": {'."\n"
.' "divisionCode": "610102",'."\n"
.' "addressDetail": "Shaanxi Province, Xi\'an City, *** Building",'."\n"
.' "receiverPhone": "187****1553",'."\n"
.' "receiver": "Mr. Yan",'."\n"
.' "townDivisionCode": "61010212"'."\n"
.' },'."\n"
.' "buyerId": "yt12345085",'."\n"
.' "productList": ['."\n"
.' {'."\n"
.' "quantity": 1,'."\n"
.' "productId": "6600622091****6736",'."\n"
.' "purchaserId": "PID2****09",'."\n"
.' "skuId": "6600622091****6737"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "48A34399-A72C-1E23-8388-7E63****E927",'."\n"
.' "purchaseOrderId": "6696070481****5680"'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'linkedmall:CreatePurchaseOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '3500', 'countWindow' => 100, 'regionId' => '*', 'api' => 'CreatePurchaseOrder'],
],
],
],
'CreateRefundOrder' => [
'summary' => 'Create a support ticket.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/refunds',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['description' => 'Create a return order', 'required' => true, '$ref' => '#/components/schemas/RefundOrderCmd', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Refund order resource', 'required' => false, '$ref' => '#/components/schemas/RefundOrderResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"orderLineId\\": \\"6692****5458\\",\\n \\"disputeId\\": \\"6693****4352\\",\\n \\"disputeStatus\\": 1,\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\"\\n}","type":"json"}]',
'title' => 'Create a return order',
'description' => 'Creates a refund order.',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "4DFA4CBA-AB08-13E2-9E25-0A26****72F2",'."\n"
.' "orderLineId": "6696070566****8594",'."\n"
.' "disputeStatus": 1,'."\n"
.' "disputeId": "6696233432****5024"'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'linkedmall:CreateRefundOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateRefundOrder'],
],
],
],
'GetOrder' => [
'summary' => 'Queries the details of an order.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/orders/{orderId}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'orderId',
'in' => 'path',
'allowEmptyValue' => true,
'schema' => ['description' => 'The ID of the order.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '669607056****8593'],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'The details of the order.', 'required' => false, '$ref' => '#/components/schemas/OrderResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"orderAmount\\": 100,\\n \\"orderLineList\\": [\\n {\\n \\"productTitle\\": \\"儿童学习桌\\",\\n \\"number\\": \\"1\\",\\n \\"skuTitle\\": \\"浅绿色\\",\\n \\"productId\\": \\"6600****6736\\",\\n \\"orderId\\": \\"6692****5457\\",\\n \\"productPic\\": \\"//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0\\",\\n \\"orderLineId\\": \\"6692****5458\\",\\n \\"logisticsStatus\\": \\"1\\",\\n \\"payFee\\": 100,\\n \\"skuId\\": \\"6600****6737\\",\\n \\"orderLineStatus\\": \\"1\\",\\n \\"eticketInfos\\": [\\n {\\n \\"code\\": \\"taobao******tpg\\",\\n \\"qrcodeUrl\\": \\"http://qrcode.alicdn.com/img.jpg\\",\\n \\"codeStatus\\": -1,\\n \\"startTime\\": \\"\\\\n2026-02-04T00:00:00.000+08:00\\",\\n \\"endTime\\": \\"2026-08-02T23:59:59.000+08:00\\",\\n \\"usedNum\\": 1,\\n \\"useTime\\": \\"\\\\n2026-02-04T15:07:59.000+08:00\\",\\n \\"lockNum\\": 0,\\n \\"availableNum\\": 0\\n }\\n ]\\n }\\n ],\\n \\"orderId\\": \\"6692****5457\\",\\n \\"distributorId\\": \\"12****01\\",\\n \\"orderStatus\\": \\"1\\",\\n \\"logisticsStatus\\": \\"1\\",\\n \\"createDate\\": \\"2023-09-11T12:22:24.000+08:00\\",\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\",\\n \\"orderClosedReason\\": \\"系统关单\\"\\n}","type":"json"}]',
'title' => 'Obtain order details ',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "createDate": "2023-09-09 10:57:23",'."\n"
.' "distributorId": "6599775553****9296",'."\n"
.' "logisticsStatus": "1",'."\n"
.' "orderId": "6696070566****8593",'."\n"
.' "orderAmount": "1",'."\n"
.' "orderStatus": "2",'."\n"
.' "orderLineList": ['."\n"
.' {'."\n"
.' "productPic": "//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0DYLWA_!!2216003305543.jpg",'."\n"
.' "productPrice": ['."\n"
.' {'."\n"
.' "fundAmountMoney": "1" // The amount payable for the order'."\n"
.' }'."\n"
.' ],'."\n"
.' "productTitle": "Children\'s study desk",'."\n"
.' "productId": "6600622091****6736",'."\n"
.' "number": "1",'."\n"
.' "orderLineStatus": "2",'."\n"
.' "logisticsStatus": "1",'."\n"
.' "skuId": "6600622091****6737",'."\n"
.' "skuTitle": "Light gray",'."\n"
.' "orderLineId": "6696070566****8594",'."\n"
.' "orderId": "6696070566****8593"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '550', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetOrder'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetPurchaseOrderStatus' => [
'summary' => 'Retrieve the purchase order status.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/purchaseOrders/{purchaseOrderId}/status',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'purchaseOrderId',
'in' => 'path',
'allowEmptyValue' => true,
'schema' => ['description' => 'Purchase order ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '6696070481****5680'],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => [
'description' => 'Transaction order status',
'enumValueTitles' => [],
'required' => false,
'$ref' => '#/components/schemas/PurchaseOrderStatusResult',
'title' => '',
'example' => '',
],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3239281273464326823\\",\\n \\"status\\": \\"10\\"\\n}","type":"json"}]',
'title' => 'Obtain the purchase order status ',
'description' => 'Retrieve the transaction order status.',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "AC85D1AE-3015-1024-B17C-D056****3583",'."\n"
.' "status": "20"'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetPurchaseOrderStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '130', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetPurchaseOrderStatus'],
],
],
],
'GetPurchaserShop' => [
'summary' => 'Retrieves the purchaser\'s shop.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/purchaserShops/{purchaserId}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'purchaserId',
'in' => 'path',
'schema' => ['description' => 'Purchaser ID', 'type' => 'string', 'required' => true, 'example' => 'PID22000016', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => ['description' => 'Shop details', '$ref' => '#/components/schemas/Shop', 'title' => '', 'example' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"endDate\\": \\"2023-09-11T12:22:24.000+08:00\\",\\n \\"distributorId\\": \\"12****09\\",\\n \\"shopName\\": \\"儿童分销店铺\\",\\n \\"shopId\\": \\"22****09\\",\\n \\"shopType\\": \\"DistributorQYG\\",\\n \\"cooperationShops\\": [\\n {\\n \\"shopId\\": \\"\\",\\n \\"cooperationCompanyId\\": \\"\\",\\n \\"cooperationShopId\\": \\"\\"\\n }\\n ],\\n \\"startDate\\": \\"2023-09-11T12:22:24.000+08:00\\",\\n \\"status\\": \\"Working\\",\\n \\"requestId\\": \\"48A34399-A72C-1E23-8388-7E63****E927\\",\\n \\"purchaserId\\": \\"PID56****2304\\"\\n}","type":"json"}]',
'title' => 'Obtain the purchaser\'s store',
'description' => 'Retrieves the purchaser\'s shop.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetPurchaserShop',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetPurchaserShop'],
],
],
],
'GetRefundOrder' => [
'summary' => 'Retrieve details of an after-sales order.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/refunds/{disputeId}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'disputeId',
'in' => 'path',
'allowEmptyValue' => true,
'schema' => ['description' => 'ID of the after-sales order', 'type' => 'string', 'required' => false, 'example' => '6696233432****5024', 'title' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'After-sales order result', 'required' => false, '$ref' => '#/components/schemas/RefundResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"refundFee\\": 1,\\n \\"refundFeeData\\": {\\n \\"minRefundFee\\": 1,\\n \\"maxRefundFee\\": 100\\n },\\n \\"applyDisputeDesc\\": \\"多拍不想要\\",\\n \\"refunderTel\\": \\"182****1334\\",\\n \\"bizClaimType\\": 1,\\n \\"disputeDesc\\": \\"多拍不想要\\",\\n \\"sellerRefuseReason\\": \\"商品没问题,买家举证无效\\",\\n \\"orderId\\": \\"6692****5457\\",\\n \\"refunderName\\": \\"赵先生\\",\\n \\"applyReason\\": {\\n \\"reasonTextId\\": 403769,\\n \\"reasonTips\\": \\"不想要了\\"\\n },\\n \\"refunderAddress\\": \\"阿里云云谷\\",\\n \\"refunderZipCode\\": \\"331001\\",\\n \\"disputeEndTime\\": \\"2023-09-15T19:23:59.000+08:00\\",\\n \\"sellerRefuseAgreementMessage\\": \\"不同意退款\\",\\n \\"disputeId\\": \\"6693****4352\\",\\n \\"disputeStatus\\": 1,\\n \\"returnGoodLogisticsStatus\\": 0,\\n \\"orderLogisticsStatus\\": 1,\\n \\"disputeCreateTime\\": \\"2023-09-15T19:23:59.000+08:00\\",\\n \\"orderLineId\\": \\"6692****5458\\",\\n \\"sellerAgreeMsg\\": \\"同意退款\\",\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\"\\n}","type":"json"}]',
'title' => 'Obtain after-sales ticket details ',
'description' => 'Retrieve after-sales order details',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "applyDisputeDesc": null,'."\n"
.' "applyReason": {'."\n"
.' "reasonTextId": 403883,'."\n"
.' "reasonTips": "Product ingredient description does not match"'."\n"
.' },'."\n"
.' "bizClaimType": 3,'."\n"
.' "disputeCreateTime": "2023-09-09 12:00:35",'."\n"
.' "disputeDesc": null,'."\n"
.' "disputeEndTime": null,'."\n"
.' "disputeId": "6696233432****5024",'."\n"
.' "disputeStatus": 3,'."\n"
.' "disputeType": 1,'."\n"
.' "orderId": "6696070566****8593",'."\n"
.' "refundFeeData": {'."\n"
.' "maxRefundFee": null,'."\n"
.' "minRefundFee": null'."\n"
.' },'."\n"
.' "orderLogisticsStatus": 2,'."\n"
.' "refundFee": 1,'."\n"
.' "refunderAddress": null,'."\n"
.' "refunderName": null,'."\n"
.' "refunderTel": null,'."\n"
.' "refunderZipCode": null,'."\n"
.' "returnGoodCount": null,'."\n"
.' "returnGoodLogisticsStatus": null,'."\n"
.' "sellerAgreeMsg": null,'."\n"
.' "sellerRefuseAgreementMessage": null,'."\n"
.' "sellerRefuseReason": null,'."\n"
.' "orderLineId": "6696070566****8594"'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetRefundOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '270', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetRefundOrder'],
],
],
],
'GetSelectionProduct' => [
'summary' => 'Query the details of a product in the selection pool.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/selectionPool/products/{productId}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'productId',
'in' => 'path',
'allowEmptyValue' => true,
'schema' => ['description' => 'Product ID', 'type' => 'string', 'required' => true, 'example' => '660460842235822080', 'title' => ''],
'examples' => [],
],
[
'name' => 'purchaserId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'Purchaser ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'PID22000009'],
'examples' => [],
],
[
'name' => 'divisionCode',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'Region code (use a five-level township or subdistrict address code)', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '330106109'],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Product details', '$ref' => '#/components/schemas/Product', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"categoryChain\\": [\\n {\\n \\"name\\": \\"名称测试\\",\\n \\"isLeaf\\": false,\\n \\"level\\": 0,\\n \\"categoryId\\": 201792301,\\n \\"parentId\\": 0\\n }\\n ],\\n \\"skus\\": [\\n {\\n \\"quantity\\": -1,\\n \\"productId\\": \\"660460842235822080\\",\\n \\"canSell\\": true,\\n \\"fuzzyQuantity\\": \\"有货\\\\n无货\\\\n库存紧张\\",\\n \\"skuStatus\\": \\"Online\\",\\n \\"skuSpecsCode\\": \\"颜色分类:天蓝色\\",\\n \\"platformPrice\\": 999900,\\n \\"title\\": \\"天蓝色\\",\\n \\"divisionCode\\": \\"110000\\",\\n \\"picUrl\\": \\"https:////img.alicdn.com/imgextra///img.alicdn.com/imgextra/i2/2216003305543/O1CN010DEQCX1qokFYGRfPE_!!2216003305543.png\\",\\n \\"markPrice\\": 999900,\\n \\"skuSpecs\\": [\\n {\\n \\"keyId\\": 1000,\\n \\"valueId\\": 1000,\\n \\"value\\": \\"天蓝色\\",\\n \\"key\\": \\"颜色分类\\",\\n \\"valueAlias\\": \\"秘色\\"\\n }\\n ],\\n \\"price\\": 19800,\\n \\"shopId\\": \\"21000017\\",\\n \\"skuId\\": \\"660460842235822081\\",\\n \\"barcode\\": \\"6922454329176\\",\\n \\"rankValue\\": 3,\\n \\"suggestedRetailPrice\\": 0,\\n \\"discountRetailPrice\\": 0,\\n \\"skuAlias\\": \\"\\"\\n }\\n ],\\n \\"lmItemId\\": \\"2100****7-458****812\\",\\n \\"canSell\\": true,\\n \\"fuzzyQuantity\\": \\"有货\\",\\n \\"title\\": \\"发财树\\",\\n \\"extendProperties\\": [\\n {\\n \\"key\\": \\"ss_picture_scene\\",\\n \\"value\\": \\"场景图\\"\\n }\\n ],\\n \\"servicePromises\\": [\\n \\"\\"\\n ],\\n \\"soldQuantity\\": \\"100+\\",\\n \\"picUrl\\": \\"https://img.alicdn.com/imgextra/i3/221*******988/O1CN01w4vomR1QYYEx6nyr5_!!221******988.jpg\\",\\n \\"categoryLeafId\\": 0,\\n \\"requestId\\": \\"3239281273******823\\",\\n \\"shopId\\": \\"210*****7\\",\\n \\"inGroup\\": true,\\n \\"productType\\": \\"Normal\\",\\n \\"images\\": [\\n \\"[]\\"\\n ],\\n \\"brandName\\": \\"Apple/苹果\\",\\n \\"quantity\\": -1,\\n \\"productId\\": \\"660460842******080\\",\\n \\"productSpecs\\": [\\n {\\n \\"keyId\\": 1000,\\n \\"key\\": \\"颜色分类\\",\\n \\"values\\": [\\n {\\n \\"value\\": \\"白色\\",\\n \\"valueId\\": 1000,\\n \\"valueAlias\\": \\"秘色\\"\\n }\\n ]\\n }\\n ],\\n \\"productStatus\\": \\"Online\\",\\n \\"taxCode\\": \\"3040203000*******000\\",\\n \\"divisionCode\\": \\"110000\\",\\n \\"taxRate\\": 600,\\n \\"limitRules\\": [\\n {\\n \\"ruleType\\": \\"UpperNumberPerUser\\",\\n \\"limitNum\\": 1,\\n \\"beginTime\\": 1724947200000,\\n \\"endTime\\": 1724947200000,\\n \\"condcase\\": \\"day\\"\\n }\\n ],\\n \\"descPath\\": \\"https://img.alicdn.com/descpath/O1CN01wciRDp22AEU1*******f34\\",\\n \\"properties\\": [\\n {\\n \\"text\\": \\"颜色\\",\\n \\"values\\": [\\n \\"白色\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query product details in the selection pool',
'description' => 'Retrieve product details from the selection pool using the product ID. You can also specify a region code to check regional inventory.',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "productId": "660057403063402509",'."\n"
.' "purchaserId": "PID22000009",'."\n"
.' "divisionCode": "330106109"'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "EA2F57E7-94AF-1C51-B607-47EECC6CCAB2",'."\n"
.' "productId": "660057403063402509",'."\n"
.' "title": "Xi\'an/Chengdu purchase-limited test item - yh - do not place order, edited via QianNiu and synced",'."\n"
.' "picUrl": "//img.alicdn.com/imgextra/i2/2214281521988/O1CN01mBXX711QYYFAxfNiX_!!2214281521988.jpg",'."\n"
.' "descPath": "//itemcdn.tmall.com/desc/icoss!0724961349057!11733929840",'."\n"
.' "categoryLeafId": 50022568,'."\n"
.' "images": ['."\n"
.' "//img.alicdn.com/imgextra/i2/2214281521988/O1CN01mBXX711QYYFAxfNiX_!!2214281521988.jpg",'."\n"
.' "//img.alicdn.com/imgextra/i1/2214281521988/O1CN011QYYFMQFeubcGuJ_!!2214281521988.jpg"'."\n"
.' ],'."\n"
.' "properties": ['."\n"
.' {'."\n"
.' "text": "Brand",'."\n"
.' "values": ['."\n"
.' "Qi Qing (Fresh Flowers)"'."\n"
.' ]'."\n"
.' },'."\n"
.' {'."\n"
.' "text": "Color classification",'."\n"
.' "values": ['."\n"
.' "Light gray",'."\n"
.' "Black",'."\n"
.' "Single SKU item why111, edited via QianNiu and synced"'."\n"
.' ]'."\n"
.' }'."\n"
.' ],'."\n"
.' "productSpecs": ['."\n"
.' {'."\n"
.' "keyId": 0,'."\n"
.' "key": "Color classification",'."\n"
.' "values": ['."\n"
.' {'."\n"
.' "valueId": 0,'."\n"
.' "value": "Light gray"'."\n"
.' },'."\n"
.' {'."\n"
.' "valueId": 0,'."\n"
.' "value": "Black"'."\n"
.' },'."\n"
.' {'."\n"
.' "valueId": 0,'."\n"
.' "value": "Single SKU item why111, edited via QianNiu and synced"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ],'."\n"
.' "skus": ['."\n"
.' {'."\n"
.' "shopId": "21000017",'."\n"
.' "productId": "660057403063402509",'."\n"
.' "skuId": "660057403063402511",'."\n"
.' "title": "Light gray",'."\n"
.' "picUrl": "//img.alicdn.com/imgextra/i2/2214281521988/O1CN01mBXX711QYYFAxfNiX_!!2214281521988.jpg",'."\n"
.' "skuSpecs": ['."\n"
.' {'."\n"
.' "keyId": 0,'."\n"
.' "key": "Color classification",'."\n"
.' "valueId": 0,'."\n"
.' "value": "Light gray"'."\n"
.' }'."\n"
.' ],'."\n"
.' "skuSpecsCode": "",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": true,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock",'."\n"
.' "price": 2,'."\n"
.' "markPrice": 777700,'."\n"
.' "platformPrice": 777700,'."\n"
.' "divisionCode": "330106109"'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "21000017",'."\n"
.' "productId": "660057403063402509",'."\n"
.' "skuId": "660057403063402510",'."\n"
.' "title": "Single SKU item why111, edited via QianNiu and synced",'."\n"
.' "picUrl": "//img.alicdn.com/imgextra/i2/2214281521988/O1CN01mBXX711QYYFAxfNiX_!!2214281521988.jpg",'."\n"
.' "skuSpecs": ['."\n"
.' {'."\n"
.' "keyId": 0,'."\n"
.' "key": "Color classification",'."\n"
.' "valueId": 0,'."\n"
.' "value": "Single SKU item why111"'."\n"
.' }'."\n"
.' ],'."\n"
.' "skuSpecsCode": "",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": true,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock",'."\n"
.' "price": 1,'."\n"
.' "markPrice": 777700,'."\n"
.' "platformPrice": 777700,'."\n"
.' "divisionCode": "330106109"'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "21000017",'."\n"
.' "productId": "660057403063402509",'."\n"
.' "skuId": "660057403063402512",'."\n"
.' "title": "Black",'."\n"
.' "picUrl": "//img.alicdn.com/imgextra/i2/2214281521988/O1CN01mBXX711QYYFAxfNiX_!!2214281521988.jpg",'."\n"
.' "skuSpecs": ['."\n"
.' {'."\n"
.' "keyId": 0,'."\n"
.' "key": "Color classification",'."\n"
.' "valueId": 0,'."\n"
.' "value": "Black"'."\n"
.' }'."\n"
.' ],'."\n"
.' "skuSpecsCode": "",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": true,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock",'."\n"
.' "price": 9,'."\n"
.' "markPrice": 777700,'."\n"
.' "platformPrice": 777700,'."\n"
.' "divisionCode": "330106109"'."\n"
.' }'."\n"
.' ],'."\n"
.' "canSell": true,'."\n"
.' "productType": "Normal",'."\n"
.' "productStatus": "Online",'."\n"
.' "shopId": "21000017",'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock",'."\n"
.' "taxRate": null,'."\n"
.' "taxCode": null,'."\n"
.' "categoryChain": ['."\n"
.' {'."\n"
.' "categoryId": 50020808,'."\n"
.' "name": "Home Decor",'."\n"
.' "parentId": 0,'."\n"
.' "level": 0,'."\n"
.' "isLeaf": false'."\n"
.' },'."\n"
.' {'."\n"
.' "categoryId": 50022568,'."\n"
.' "name": "Other Craft Decorations",'."\n"
.' "parentId": 50020808,'."\n"
.' "level": 0,'."\n"
.' "isLeaf": true'."\n"
.' }'."\n"
.' ],'."\n"
.' "soldQuantity": "2",'."\n"
.' "divisionCode": "330106109"'."\n"
.'}'."\n"
.'```',
'changeSet' => [
['createdAt' => '2024-03-29T03:14:22.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetSelectionProduct'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetSelectionProduct',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetSelectionProductSaleInfo' => [
'summary' => 'Queries sales information for products in the selection pool.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/selectionPool/products/{productId}/saleInfo',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'productId',
'in' => 'path',
'allowEmptyValue' => true,
'schema' => ['description' => 'Product ID', 'type' => 'string', 'required' => true, 'example' => '660460842235822080', 'title' => ''],
'examples' => [],
],
[
'name' => 'purchaserId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'Purchaser ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'PID22000009'],
'examples' => [],
],
[
'name' => 'divisionCode',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'Administrative division code. We recommend using a five-level code (township or subdistrict level).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '330106109'],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Product sales information', '$ref' => '#/components/schemas/ProductSaleInfo', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"divisionCode\\": \\"330106109\\",\\n \\"quantity\\": 10,\\n \\"skus\\": [\\n {\\n \\"divisionCode\\": \\"330106109\\",\\n \\"markPrice\\": 999900,\\n \\"quantity\\": -1,\\n \\"productId\\": \\"660460842235822080\\",\\n \\"canSell\\": true,\\n \\"price\\": 19800,\\n \\"fuzzyQuantity\\": \\"有货\\",\\n \\"skuStatus\\": \\"Online\\",\\n \\"shopId\\": \\"21000017\\",\\n \\"title\\": \\"天蓝色\\",\\n \\"skuId\\": \\"660460842235822081\\",\\n \\"canNotSellReason\\": \\"不可售\\"\\n }\\n ],\\n \\"productId\\": \\"660460842235822080\\",\\n \\"canSell\\": true,\\n \\"requestId\\": \\"3239281273464326823\\",\\n \\"fuzzyQuantity\\": \\"有货\\",\\n \\"productStatus\\": \\"Online\\",\\n \\"shopId\\": \\"21000017\\",\\n \\"title\\": \\"发财树\\",\\n \\"lmItemId\\": \\"21000017-4580902812\\",\\n \\"limitRules\\": [\\n {\\n \\"ruleType\\": \\"UpperNumberPerUser\\",\\n \\"limitNum\\": 1,\\n \\"beginTime\\": 1724947200000,\\n \\"endTime\\": 1724947200000,\\n \\"condcase\\": \\"day\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query Product sales information in the selection pool ',
'description' => 'Queries sales information for products in the selection pool. Distributors can call this operation to check product sales details, such as product status. Use the divisionCode input parameter to check whether a product is available for sale in a specific region. We recommend using a five-level administrative division code (township or subdistrict level).',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "productId": "660460842235822080",'."\n"
.' "purchaserId": "PID22000009",'."\n"
.' "divisionCode": "330106109"'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "33D4B4FC-E37F-1CB1-A4DD-F953B7F296DB",'."\n"
.' "shopId": "21000019",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "title": "Money Tree 5—Testing Xiao Yi product only. Do not use other products.",'."\n"
.' "skus": ['."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822081",'."\n"
.' "title": "Sky blue",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": false,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "Out of stock",'."\n"
.' "price": 1,'."\n"
.' "markPrice": 999900'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822082",'."\n"
.' "title": "Red",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": true,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock",'."\n"
.' "price": 2,'."\n"
.' "markPrice": 999900'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822083",'."\n"
.' "title": "Black",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": false,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "Out of stock",'."\n"
.' "price": 1,'."\n"
.' "markPrice": 999900'."\n"
.' }'."\n"
.' ],'."\n"
.' "canSell": true,'."\n"
.' "productStatus": "Online",'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock"'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetSelectionProductSaleInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetSelectionProductSaleInfo'],
],
],
],
'ListCategories' => [
'summary' => 'Lists categories.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/categories/commands/list',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'schema' => ['description' => 'Category query parameters', '$ref' => '#/components/schemas/CategoryListQuery', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Category', '$ref' => '#/components/schemas/CategoryListResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"categories\\": [\\n {\\n \\"name\\": \\"名称测试\\",\\n \\"isLeaf\\": false,\\n \\"level\\": 0,\\n \\"categoryId\\": 201792301,\\n \\"parentId\\": 0\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query Category List',
'description' => 'Retrieves all subcategories for a parent category ID, or the details for a specific category ID.'."\n"
."\n"
.'If the parent category ID (parentCategoryId) is 0, the API returns the top-level categories under the root category.',
'requestParamsDescription' => '```'."\n"
.'// List all subcategories under a parent category (parentCategoryId)'."\n"
.'{'."\n"
.' "body": {'."\n"
.' "parentCategoryId": "50016422"'."\n"
.' }'."\n"
.'}'."\n"
."\n"
.'// Query multiple categories by their IDs (categoryIds)'."\n"
.'{'."\n"
.' "body": {'."\n"
.' "categoryIds": ['."\n"
.' "202007601",'."\n"
.' "201792301"'."\n"
.' ]'."\n"
.' }'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "4D1FC14F-CE54-1A1F-A322-D6DC87D49AFE",'."\n"
.' "categories": ['."\n"
.' {'."\n"
.' "categoryId": 201792301,'."\n"
.' "name": "Instant noodles/Ramen/Noodles/Light meal noodles/Instant food",'."\n"
.' "parentId": 50016422,'."\n"
.' "level": 2,'."\n"
.' "isLeaf": false'."\n"
.' },'."\n"
.' {'."\n"
.' "categoryId": 202007601,'."\n"
.' "name": "Voucher for instant food and frozen food",'."\n"
.' "parentId": 50016422,'."\n"
.' "level": 2,'."\n"
.' "isLeaf": false'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListCategories',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListCategories'],
],
],
],
'ListLogisticsOrders' => [
'summary' => 'Query logistics information for an order.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/orders/{orderId}/logisticsOrders',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'orderId',
'in' => 'path',
'allowEmptyValue' => true,
'schema' => ['description' => 'Order ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '6696070566****8593'],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Logistics information', 'required' => false, '$ref' => '#/components/schemas/LogisticsOrderListResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"logisticsOrderList\\": [\\n {\\n \\"mailNo\\": \\"SF234***2345\\",\\n \\"dataProviderTitle\\": \\"菜鸟裹裹\\",\\n \\"logisticsCompanyName\\": \\"顺丰\\",\\n \\"logisticsDetailList\\": [\\n {\\n \\"ocurrTimeStr\\": \\"2023-09-11T12:22:24.000+08:00\\",\\n \\"standerdDesc\\": \\"已签收\\"\\n }\\n ],\\n \\"goods\\": [\\n {\\n \\"goodName\\": \\"儿童学习桌\\",\\n \\"productId\\": \\"6600****6736\\",\\n \\"quantity\\": 1,\\n \\"skuId\\": \\"7232****2321\\",\\n \\"skuTitle\\": \\"白色\\"\\n }\\n ],\\n \\"dataProvider\\": \\"菜鸟\\",\\n \\"logisticsCompanyCode\\": \\"SF\\"\\n }\\n ],\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\"\\n}","type":"json"}]',
'title' => 'Query order logistics information ',
'description' => 'Retrieves logistics information for an order.',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "ED080FA8-F005-10B1-A9AB-CCFD****9149",'."\n"
.' "logisticsOrderList": ['."\n"
.' {'."\n"
.' "dataProvider": "Cainiao Wrap",'."\n"
.' "dataProviderTitle": "Data provided by Cainiao Wrap",'."\n"
.' "goods": ['."\n"
.' {'."\n"
.' "goodName": "Children\'s study desk",'."\n"
.' "productId": 2384738123****7238,'."\n"
.' "quantity": 1'."\n"
.' }'."\n"
.' ],'."\n"
.' "logisticsCompanyCode": "SF",'."\n"
.' "logisticsCompanyName": "SF Express",'."\n"
.' "logisticsDetailList": ['."\n"
.' {'."\n"
.' "ocurrTimeStr": "2023-06-06 14:44:45",'."\n"
.' "standerdDesc": "SF Express has picked up the package"'."\n"
.' },'."\n"
.' {'."\n"
.' "ocurrTimeStr": "2023-06-06 14:44:46",'."\n"
.' "standerdDesc": "Package sorted at Jiaogongchang Store. Ready to ship to Shenyang **** Transit Center"'."\n"
.' },'."\n"
.' {'."\n"
.' "ocurrTimeStr": "2023-06-06 18:24:09",'."\n"
.' "standerdDesc": "Package arrived at Shenyang **** Transit Center"'."\n"
.' },'."\n"
.' {'."\n"
.' "ocurrTimeStr": "2023-06-06 18:28:26",'."\n"
.' "standerdDesc": "Package sorted at Shenyang **** Transit Center. Ready to ship to Xi\'an **** Transit Center"'."\n"
.' },'."\n"
.' {'."\n"
.' "ocurrTimeStr": "2023-06-07 05:40:35",'."\n"
.' "standerdDesc": "Package shipped"'."\n"
.' }'."\n"
.' ],'."\n"
.' "mailNo": "SF162546****599"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListLogisticsOrders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '250', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListLogisticsOrders'],
],
],
],
'ListPurchaserShops' => [
'summary' => 'Lists purchaser shops.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/purchaserShops',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'pageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'Page number of the request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '1'],
'examples' => [],
],
[
'name' => 'pageSize',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '10'],
'examples' => [],
],
],
'responses' => [
200 => [
'schema' => ['description' => 'Information about the shop list.', '$ref' => '#/components/schemas/ShopPageResult', 'title' => '', 'example' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\",\\n \\"total\\": 24,\\n \\"shopList\\": [\\n {\\n \\"endDate\\": \\"2023-09-11T12:22:24.000+08:00\\",\\n \\"shopName\\": \\"儿童座椅分销店铺\\",\\n \\"shopId\\": \\"22****09\\",\\n \\"shopType\\": \\"DistributorQYG\\",\\n \\"cooperationShops\\": [\\n {\\n \\"shopId\\": \\"\\",\\n \\"cooperationCompanyId\\": \\"\\",\\n \\"cooperationShopId\\": \\"\\"\\n }\\n ],\\n \\"startDate\\": \\"2023-09-11T12:22:24.000+08:00\\",\\n \\"status\\": \\"Working\\",\\n \\"purchaserId\\": \\"PID56****2304\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Obtain the list of purchaser shops ',
'description' => 'Lists purchaser shops.',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "AEE64C1D-7FBD-1F10-B8C7-12A854A1D6B4",'."\n"
.' "total": 6,'."\n"
.' "shopList": ['."\n"
.' {'."\n"
.' "shopId": "22000019",'."\n"
.' "purchaserId": "PID22000019",'."\n"
.' "shopName": "Shop Name 001",'."\n"
.' "cooperationShops": ['."\n"
.' {'."\n"
.' "shopId": "22000019",'."\n"
.' "cooperationCompanyId": "11200003",'."\n"
.' "cooperationShopId": "21000026"'."\n"
.' }'."\n"
.' ],'."\n"
.' "shopType": "DistributorQYG",'."\n"
.' "startDate": null,'."\n"
.' "endDate": null,'."\n"
.' "status": "WORKING"'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "22000018",'."\n"
.' "purchaserId": "PID22000018",'."\n"
.' "shopName": "Shop Name 002",'."\n"
.' "cooperationShops": [],'."\n"
.' "shopType": "DistributorQYG",'."\n"
.' "startDate": null,'."\n"
.' "endDate": null,'."\n"
.' "status": "APPROVED"'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "22000017",'."\n"
.' "purchaserId": "PID22000017",'."\n"
.' "shopName": "Distribution Shop 0817",'."\n"
.' "cooperationShops": [],'."\n"
.' "shopType": "DistributorQYG",'."\n"
.' "startDate": null,'."\n"
.' "endDate": null,'."\n"
.' "status": "TO_BE_APPROVED"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [
['createdAt' => '2023-09-15T07:17:09.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListPurchaserShops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '25', 'countWindow' => 5, 'regionId' => '*', 'api' => 'ListPurchaserShops'],
],
],
],
'ListSelectionProductSaleInfos' => [
'summary' => 'Query product sales information for the selection pool in batches.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/selectionPool/products/saleInfo/commands/list',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['description' => 'Parameters for querying product sales information in batches', 'required' => true, '$ref' => '#/components/schemas/ProductSaleInfoListQuery', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Product sales information', '$ref' => '#/components/schemas/ProductSaleInfoListResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3239281273464326823\\",\\n \\"productSaleInfos\\": [\\n {\\n \\"divisionCode\\": \\"330106109\\",\\n \\"quantity\\": 10,\\n \\"skus\\": [\\n {\\n \\"divisionCode\\": \\"330106109\\",\\n \\"markPrice\\": 999900,\\n \\"quantity\\": -1,\\n \\"productId\\": \\"660460842235822080\\",\\n \\"canSell\\": true,\\n \\"price\\": 19800,\\n \\"fuzzyQuantity\\": \\"有货\\",\\n \\"skuStatus\\": \\"Online\\",\\n \\"shopId\\": \\"21000017\\",\\n \\"title\\": \\"天蓝色\\",\\n \\"skuId\\": \\"660460842235822081\\",\\n \\"canNotSellReason\\": \\"不可售\\"\\n }\\n ],\\n \\"productId\\": \\"660460842235822080\\",\\n \\"canSell\\": true,\\n \\"requestId\\": \\"3239281273464326823\\",\\n \\"fuzzyQuantity\\": \\"有货\\",\\n \\"productStatus\\": \\"Online\\",\\n \\"shopId\\": \\"21000017\\",\\n \\"title\\": \\"发财树\\",\\n \\"lmItemId\\": \\"21000017-4580902812\\",\\n \\"limitRules\\": [\\n {\\n \\"ruleType\\": \\"UpperNumberPerUser\\",\\n \\"limitNum\\": 1,\\n \\"beginTime\\": 1724947200000,\\n \\"endTime\\": 1724947200000,\\n \\"condcase\\": \\"day\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Batch query the sales information of Products in the selection pool ',
'description' => 'You can query product sales information for the selection pool in batches. Distributors can call this operation to retrieve product sales details, such as product status. Use the divisionCode input parameter to check whether products are available for sale in a specific region. We recommend that you pass a five-level address code (town or street level).',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "purchaserId": "PID22000009",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productIds": ['."\n"
.' "660460842235822080"'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "1556385F-6098-114E-84F8-14B383EF5AA8",'."\n"
.' "productSaleInfos": ['."\n"
.' {'."\n"
.' "requestId": null,'."\n"
.' "shopId": "21000019",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "title": "Lucky Bamboo Tree 5 - I will use this Xiao Yi product only. Do not use your other products.",'."\n"
.' "skus": ['."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822081",'."\n"
.' "title": "Sky Blue",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": false,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "Out of stock",'."\n"
.' "price": 1,'."\n"
.' "markPrice": 999900'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822082",'."\n"
.' "title": "Red",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": true,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock",'."\n"
.' "price": 2,'."\n"
.' "markPrice": 999900'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822083",'."\n"
.' "title": "Black",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": false,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "Out of stock",'."\n"
.' "price": 1,'."\n"
.' "markPrice": 999900'."\n"
.' }'."\n"
.' ],'."\n"
.' "canSell": true,'."\n"
.' "productStatus": "Online",'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListSelectionProductSaleInfos'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListSelectionProductSaleInfos',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListSelectionProducts' => [
'summary' => 'Retrieves a list of products from a product selection pool.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/selectionPool/products',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'pageSize',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 20.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '10'],
],
[
'name' => 'pageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The page number. The value must be 1 or greater.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'],
],
[
'name' => 'purchaserId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The ID of the purchaser.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'PID22000009'],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'The product details.', '$ref' => '#/components/schemas/ProductPageResult', 'title' => '', 'example' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageSize\\": 10,\\n \\"total\\": 24,\\n \\"pageNumber\\": 1,\\n \\"requestId\\": \\"3239281273464326823\\",\\n \\"products\\": [\\n {\\n \\"categoryChain\\": [\\n {\\n \\"name\\": \\"名称测试\\",\\n \\"isLeaf\\": false,\\n \\"level\\": 0,\\n \\"categoryId\\": 201792301,\\n \\"parentId\\": 0\\n }\\n ],\\n \\"skus\\": [\\n {\\n \\"quantity\\": -1,\\n \\"productId\\": \\"660460842235822080\\",\\n \\"canSell\\": true,\\n \\"fuzzyQuantity\\": \\"有货\\\\n无货\\\\n库存紧张\\",\\n \\"skuStatus\\": \\"Online\\",\\n \\"skuSpecsCode\\": \\"颜色分类:天蓝色\\",\\n \\"platformPrice\\": 999900,\\n \\"title\\": \\"天蓝色\\",\\n \\"divisionCode\\": \\"110000\\",\\n \\"picUrl\\": \\"https:////img.alicdn.com/imgextra///img.alicdn.com/imgextra/i2/2216003305543/O1CN010DEQCX1qokFYGRfPE_!!2216003305543.png\\",\\n \\"markPrice\\": 999900,\\n \\"skuSpecs\\": [\\n {\\n \\"keyId\\": 1000,\\n \\"valueId\\": 1000,\\n \\"value\\": \\"天蓝色\\",\\n \\"key\\": \\"颜色分类\\",\\n \\"valueAlias\\": \\"秘色\\"\\n }\\n ],\\n \\"price\\": 19800,\\n \\"shopId\\": \\"21000017\\",\\n \\"skuId\\": \\"660460842235822081\\",\\n \\"barcode\\": \\"6922454329176\\",\\n \\"rankValue\\": 3,\\n \\"suggestedRetailPrice\\": 0,\\n \\"discountRetailPrice\\": 0,\\n \\"skuAlias\\": \\"\\"\\n }\\n ],\\n \\"lmItemId\\": \\"2100****7-458****812\\",\\n \\"canSell\\": true,\\n \\"fuzzyQuantity\\": \\"有货\\",\\n \\"title\\": \\"发财树\\",\\n \\"extendProperties\\": [\\n {\\n \\"key\\": \\"ss_picture_scene\\",\\n \\"value\\": \\"场景图\\"\\n }\\n ],\\n \\"servicePromises\\": [\\n \\"\\"\\n ],\\n \\"soldQuantity\\": \\"100+\\",\\n \\"picUrl\\": \\"https://img.alicdn.com/imgextra/i3/221*******988/O1CN01w4vomR1QYYEx6nyr5_!!221******988.jpg\\",\\n \\"categoryLeafId\\": 0,\\n \\"requestId\\": \\"3239281273******823\\",\\n \\"shopId\\": \\"210*****7\\",\\n \\"inGroup\\": true,\\n \\"productType\\": \\"Normal\\",\\n \\"images\\": [\\n \\"[]\\"\\n ],\\n \\"brandName\\": \\"Apple/苹果\\",\\n \\"quantity\\": -1,\\n \\"productId\\": \\"660460842******080\\",\\n \\"productSpecs\\": [\\n {\\n \\"keyId\\": 1000,\\n \\"key\\": \\"颜色分类\\",\\n \\"values\\": [\\n {\\n \\"value\\": \\"白色\\",\\n \\"valueId\\": 1000,\\n \\"valueAlias\\": \\"秘色\\"\\n }\\n ]\\n }\\n ],\\n \\"productStatus\\": \\"Online\\",\\n \\"taxCode\\": \\"3040203000*******000\\",\\n \\"divisionCode\\": \\"110000\\",\\n \\"taxRate\\": 600,\\n \\"limitRules\\": [\\n {\\n \\"ruleType\\": \\"UpperNumberPerUser\\",\\n \\"limitNum\\": 1,\\n \\"beginTime\\": 1724947200000,\\n \\"endTime\\": 1724947200000,\\n \\"condcase\\": \\"day\\"\\n }\\n ],\\n \\"descPath\\": \\"https://img.alicdn.com/descpath/O1CN01wciRDp22AEU1*******f34\\",\\n \\"properties\\": [\\n {\\n \\"text\\": \\"颜色\\",\\n \\"values\\": [\\n \\"白色\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query Product List in the Selection Pool ',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "pageNumber": 1,'."\n"
.' "pageSize": 10,'."\n"
.' "purchaserId": "PID22000009"'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "87C11800-27D4-1CF7-A544-D006AC4ADAD5",'."\n"
.' "total": 48,'."\n"
.' "pageNumber": 2,'."\n"
.' "pageSize": 20,'."\n"
.' "products": ['."\n"
.' {'."\n"
.' "requestId": null,'."\n"
.' "productId": "660460842235822080",'."\n"
.' "title": "Fortune Tree 5--I will use this Xiaoyi product-qhh, not your other products",'."\n"
.' "picUrl": "//img.alicdn.com/imgextra/i4/2216003305543/O1CN01NtbRbi1qokFAIsvNo_!!2216003305543.jpg",'."\n"
.' "descPath": "//itemcdn.tmall.com/desc/icoss!0724961349057!11733929840",'."\n"
.' "categoryLeafId": 50011150,'."\n"
.' "images": ['."\n"
.' "//img.alicdn.com/imgextra/i4/2216003305543/O1CN01NtbRbi1qokFAIsvNo_!!2216003305543.jpg",'."\n"
.' "//img.alicdn.com/imgextra/i2/2216003305543/O1CN010DEQCX1qokFYGRfPE_!!2216003305543.png",'."\n"
.' "//img.alicdn.com/imgextra/i4/2216003305543/O1CN01E6yC8z1qokFueiOI7_!!2216003305543.jpg",'."\n"
.' "//img.alicdn.com/imgextra/i3/2216003305543/O1CN01K3DLfJ1qokF5BPhVJ_!!2216003305543.jpg"'."\n"
.' ],'."\n"
.' "properties": ['."\n"
.' {'."\n"
.' "text": "Color",'."\n"
.' "values": ['."\n"
.' "Sky Blue",'."\n"
.' "Red",'."\n"
.' "Black"'."\n"
.' ]'."\n"
.' }'."\n"
.' ],'."\n"
.' "productSpecs": ['."\n"
.' {'."\n"
.' "keyId": 0,'."\n"
.' "key": "Color",'."\n"
.' "values": ['."\n"
.' {'."\n"
.' "valueId": 0,'."\n"
.' "value": "Sky Blue"'."\n"
.' },'."\n"
.' {'."\n"
.' "valueId": 0,'."\n"
.' "value": "Red"'."\n"
.' },'."\n"
.' {'."\n"
.' "valueId": 0,'."\n"
.' "value": "Black"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ],'."\n"
.' "skus": ['."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822081",'."\n"
.' "title": "Sky Blue",'."\n"
.' "picUrl": "//img.alicdn.com/imgextra///img.alicdn.com/imgextra/i2/2216003305543/O1CN010DEQCX1qokFYGRfPE_!!2216003305543.png",'."\n"
.' "skuSpecs": ['."\n"
.' {'."\n"
.' "keyId": 0,'."\n"
.' "key": "Color",'."\n"
.' "valueId": 0,'."\n"
.' "value": "Sky Blue"'."\n"
.' }'."\n"
.' ],'."\n"
.' "skuSpecsCode": "",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": false,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "Out of stock",'."\n"
.' "price": 1,'."\n"
.' "markPrice": 999900,'."\n"
.' "platformPrice": 999900,'."\n"
.' "divisionCode": null'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822082",'."\n"
.' "title": "Red",'."\n"
.' "picUrl": "//img.alicdn.com/imgextra///img.alicdn.com/imgextra/i3/2216003305543/O1CN01EWJ8tO1qokF2BAhv3_!!2216003305543.jpg",'."\n"
.' "skuSpecs": ['."\n"
.' {'."\n"
.' "keyId": 0,'."\n"
.' "key": "Color",'."\n"
.' "valueId": 0,'."\n"
.' "value": "Red"'."\n"
.' }'."\n"
.' ],'."\n"
.' "skuSpecsCode": "",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": true,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock",'."\n"
.' "price": 2,'."\n"
.' "markPrice": 999900,'."\n"
.' "platformPrice": 999900,'."\n"
.' "divisionCode": null'."\n"
.' },'."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822083",'."\n"
.' "title": "Black",'."\n"
.' "picUrl": "//img.alicdn.com/imgextra/i4/2216003305543/O1CN01NtbRbi1qokFAIsvNo_!!2216003305543.jpg",'."\n"
.' "skuSpecs": ['."\n"
.' {'."\n"
.' "keyId": 0,'."\n"
.' "key": "Color",'."\n"
.' "valueId": 0,'."\n"
.' "value": "Black"'."\n"
.' }'."\n"
.' ],'."\n"
.' "skuSpecsCode": "",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": false,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "Out of stock",'."\n"
.' "price": 1,'."\n"
.' "markPrice": 999900,'."\n"
.' "platformPrice": 999900,'."\n"
.' "divisionCode": null'."\n"
.' }'."\n"
.' ],'."\n"
.' "canSell": true,'."\n"
.' "productType": "Normal",'."\n"
.' "productStatus": "Online",'."\n"
.' "shopId": "21000019",'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock",'."\n"
.' "taxRate": null,'."\n"
.' "taxCode": null,'."\n"
.' "categoryChain": ['."\n"
.' {'."\n"
.' "categoryId": 50023724,'."\n"
.' "name": "Other",'."\n"
.' "parentId": 0,'."\n"
.' "level": 0,'."\n"
.' "isLeaf": false'."\n"
.' },'."\n"
.' {'."\n"
.' "categoryId": 50011150,'."\n"
.' "name": "Other",'."\n"
.' "parentId": 50023724,'."\n"
.' "level": 0,'."\n"
.' "isLeaf": true'."\n"
.' }'."\n"
.' ],'."\n"
.' "soldQuantity": "0",'."\n"
.' "divisionCode": null'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListSelectionProducts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListSelectionProducts'],
],
],
],
'ListSelectionSkuSaleInfos' => [
'summary' => 'Query SKU sales information for items in the selection pool in batch.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/selectionPool/skus/saleInfo/commands/list',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['description' => 'Parameters for querying SKU sales information in batch', 'required' => true, '$ref' => '#/components/schemas/SkuSaleInfoListQuery', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'SKU sales information', '$ref' => '#/components/schemas/SkuSaleInfoListResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3239281273464326823\\",\\n \\"skuSaleInfos\\": [\\n {\\n \\"divisionCode\\": \\"330106109\\",\\n \\"markPrice\\": 999900,\\n \\"quantity\\": -1,\\n \\"productId\\": \\"660460842235822080\\",\\n \\"canSell\\": true,\\n \\"price\\": 19800,\\n \\"fuzzyQuantity\\": \\"有货\\",\\n \\"skuStatus\\": \\"Online\\",\\n \\"shopId\\": \\"21000017\\",\\n \\"title\\": \\"天蓝色\\",\\n \\"skuId\\": \\"660460842235822081\\",\\n \\"canNotSellReason\\": \\"不可售\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Batch query sales information of SKUs in the product selection pool ',
'description' => 'Query SKU sales information for items in the selection pool in batch. Distributors can call this API to retrieve batch details about SKU sales status and other attributes. To determine whether SKUs are sellable in a specific region, use the divisionCode parameter—preferably a five-level administrative division code for townships or subdistricts.',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "divisionCode": "330106109",'."\n"
.' "purchaserId": "PID22000009",'."\n"
.' "skuQueryParams": ['."\n"
.' {'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822082"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "6F3A5B0A-AC2B-1083-A2ED-ACE62BF1C100",'."\n"
.' "skuSaleInfos": ['."\n"
.' {'."\n"
.' "shopId": "21000019",'."\n"
.' "divisionCode": "330106109",'."\n"
.' "productId": "660460842235822080",'."\n"
.' "skuId": "660460842235822082",'."\n"
.' "title": "Red",'."\n"
.' "skuStatus": "Online",'."\n"
.' "canSell": true,'."\n"
.' "quantity": -1,'."\n"
.' "fuzzyQuantity": "In stock",'."\n"
.' "price": 2,'."\n"
.' "markPrice": 999900'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListSelectionSkuSaleInfos',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListSelectionSkuSaleInfos'],
],
],
],
'QueryChildDivisionCode' => [
'summary' => 'Queries child division codes.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/division/commands/queryChildDivisionCode',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['description' => 'The parameters for querying child division codes.', 'required' => true, '$ref' => '#/components/schemas/DivisionQuery', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'The child division codes.', 'required' => false, '$ref' => '#/components/schemas/DivisionPageResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"divisionList\\": [\\n {\\n \\"divisionName\\": \\"上海\\",\\n \\"divisionCode\\": 310000,\\n \\"divisionLevel\\": 2,\\n \\"pinyin\\": \\"shang hai\\",\\n \\"parentId\\": 1\\n }\\n ],\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\"\\n}","type":"json"}]',
'title' => 'Query sub-area encoding ',
'description' => 'Queries child division codes.',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "divisionCode": "1"'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "85144A43-F418-1094-9A40-B8CE****8F30",'."\n"
.' "divisionList": ['."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 310000,'."\n"
.' "divisionName": "Shanghai",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "shang hai"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 530000,'."\n"
.' "divisionName": "Yunnan Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "yun nan sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 150000,'."\n"
.' "divisionName": "Inner Mongolia Autonomous Region",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "nei meng gu zi zhi qu"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 110000,'."\n"
.' "divisionName": "Beijing",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "bei jing"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 220000,'."\n"
.' "divisionName": "Jilin Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "ji lin sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 510000,'."\n"
.' "divisionName": "Sichuan Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "si chuan sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 120000,'."\n"
.' "divisionName": "Tianjin",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "tian jin"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 640000,'."\n"
.' "divisionName": "Ningxia Hui Autonomous Region",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "ning xia hui zu zi zhi qu"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 340000,'."\n"
.' "divisionName": "Anhui Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "an hui sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 370000,'."\n"
.' "divisionName": "Shandong Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "shan dong sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 140000,'."\n"
.' "divisionName": "Shanxi Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "shan xi sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 440000,'."\n"
.' "divisionName": "Guangdong Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "guang dong sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 450000,'."\n"
.' "divisionName": "Guangxi Zhuang Autonomous Region",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "guang xi zhuang zu zi zhi qu"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 650000,'."\n"
.' "divisionName": "Xinjiang Uygur Autonomous Region",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "xin jiang wei wu er zi zhi qu"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 320000,'."\n"
.' "divisionName": "Jiangsu Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "jiang su sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 360000,'."\n"
.' "divisionName": "Jiangxi Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "jiang xi sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 130000,'."\n"
.' "divisionName": "Hebei Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "he bei sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 410000,'."\n"
.' "divisionName": "Henan Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "he nan sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 330000,'."\n"
.' "divisionName": "Zhejiang Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "zhe jiang sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 460000,'."\n"
.' "divisionName": "Hainan Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "hai nan sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 420000,'."\n"
.' "divisionName": "Hubei Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "hu bei sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 430000,'."\n"
.' "divisionName": "Hunan Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "hu nan sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 620000,'."\n"
.' "divisionName": "Gansu Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "gan su sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 350000,'."\n"
.' "divisionName": "Fujian Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "fu jian sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 540000,'."\n"
.' "divisionName": "Tibet Autonomous Region",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "xi zang zi zhi qu"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 520000,'."\n"
.' "divisionName": "Guizhou Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "gui zhou sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 210000,'."\n"
.' "divisionName": "Liaoning Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "liao ning sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 500000,'."\n"
.' "divisionName": "Chongqing",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "chong qing"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 610000,'."\n"
.' "divisionName": "Shaanxi Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "shan xi sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 630000,'."\n"
.' "divisionName": "Qinghai Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "qing hai sheng"'."\n"
.' },'."\n"
.' {'."\n"
.' "parentId": 1,'."\n"
.' "divisionCode": 230000,'."\n"
.' "divisionName": "Heilongjiang Province",'."\n"
.' "divisionLevel": 2,'."\n"
.' "pinyin": "hei long jiang sheng"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'QueryChildDivisionCode'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:QueryChildDivisionCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'QueryOrders' => [
'summary' => 'Lists orders.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/orders/commands/query',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['title' => '', 'description' => 'Queries the list of main orders.', 'required' => true, '$ref' => '#/components/schemas/OrderPageQuery', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'The order list.', 'required' => false, '$ref' => '#/components/schemas/OrderListResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"orderList\\": [\\n {\\n \\"orderAmount\\": 100,\\n \\"orderLineList\\": [\\n {\\n \\"productTitle\\": \\"儿童学习桌\\",\\n \\"number\\": \\"1\\",\\n \\"skuTitle\\": \\"浅绿色\\",\\n \\"productId\\": \\"6600****6736\\",\\n \\"orderId\\": \\"6692****5457\\",\\n \\"productPic\\": \\"//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0\\",\\n \\"orderLineId\\": \\"6692****5458\\",\\n \\"logisticsStatus\\": \\"1\\",\\n \\"payFee\\": 100,\\n \\"skuId\\": \\"6600****6737\\",\\n \\"orderLineStatus\\": \\"1\\",\\n \\"eticketInfos\\": [\\n {\\n \\"code\\": \\"taobao******tpg\\",\\n \\"qrcodeUrl\\": \\"http://qrcode.alicdn.com/img.jpg\\",\\n \\"codeStatus\\": -1,\\n \\"startTime\\": \\"\\\\n2026-02-04T00:00:00.000+08:00\\",\\n \\"endTime\\": \\"2026-08-02T23:59:59.000+08:00\\",\\n \\"usedNum\\": 1,\\n \\"useTime\\": \\"\\\\n2026-02-04T15:07:59.000+08:00\\",\\n \\"lockNum\\": 0,\\n \\"availableNum\\": 0\\n }\\n ]\\n }\\n ],\\n \\"orderId\\": \\"6692****5457\\",\\n \\"distributorId\\": \\"12****01\\",\\n \\"orderStatus\\": \\"1\\",\\n \\"logisticsStatus\\": \\"1\\",\\n \\"createDate\\": \\"2023-09-11T12:22:24.000+08:00\\",\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\",\\n \\"orderClosedReason\\": \\"系统关单\\"\\n }\\n ],\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\",\\n \\"total\\": 24\\n}","type":"json"}]',
'title' => 'List orders',
'description' => 'Lists orders.',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "pageNumber": 1,'."\n"
.' "pageSize": 10,'."\n"
.' "orderIdList": ['."\n"
.' "6696070566****8593"'."\n"
.' ],'."\n"
.' "purchaseOrderId": "6696070566****8593",'."\n"
.' "outPurchaseOrderId": "6696070566****8512"'."\n"
.'}',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "15BC537F-26F7-1AD0-AC3C-B79****D540",'."\n"
.' "total": 10,'."\n"
.' "orderList": ['."\n"
.' {'."\n"
.' "requestId": null,'."\n"
.' "createDate": "2023-09-09 10:57:23",'."\n"
.' "distributorId": "12****01",'."\n"
.' "logisticsStatus": "2",'."\n"
.' "orderId": "6696070566****8593",'."\n"
.' "orderAmount": "1",'."\n"
.' "orderStatus": "2",'."\n"
.' "orderLineList": ['."\n"
.' {'."\n"
.' "productPic": "//img.alicdn.com/imgextra/i4/2216****05543/O1CN01bip3Un1qo****YLWA_!!2216003****43.jpg",'."\n"
.' "productPrice": ['."\n"
.' {'."\n"
.' "fundAmountMoney": "1"'."\n"
.' }'."\n"
.' ],'."\n"
.' "productTitle": "儿童学习桌",'."\n"
.' "productId": "6600622091****6736",'."\n"
.' "number": "1",'."\n"
.' "orderLineStatus": "2",'."\n"
.' "logisticsStatus": "2",'."\n"
.' "skuId": "6600622091****6737",'."\n"
.' "skuTitle": "浅灰色",'."\n"
.' "orderLineId": "6696070566****8594",'."\n"
.' "orderId": "6696070566****8593"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.'}',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 10, 'regionId' => '*', 'api' => 'QueryOrders'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'linkedmall:QueryOrders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'RenderPurchaseOrder' => [
'summary' => 'Renders a purchase order and returns both sellable and unsellable products. Customers can then select the sellable products to place their orders.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/purchaseOrders/commands/render',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['description' => 'Render purchase order', 'required' => true, '$ref' => '#/components/schemas/PurchaseOrderRenderQuery', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Purchase order rendering result', 'required' => false, '$ref' => '#/components/schemas/PurchaseOrderRenderResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"addressList\\": [\\n {\\n \\"divisionCode\\": \\"330106\\",\\n \\"addressDetail\\": \\"陕西省西安市新城区xx街道xxx大厦xx室\\",\\n \\"receiverPhone\\": \\"182***5674\\",\\n \\"townDivisionCode\\": \\"330106109\\",\\n \\"receiver\\": \\"任先生\\",\\n \\"addressId\\": 0\\n }\\n ],\\n \\"canSell\\": true,\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\",\\n \\"orderList\\": [\\n {\\n \\"message\\": \\"库存为0\\",\\n \\"deliveryInfoList\\": [\\n {\\n \\"postFee\\": 0,\\n \\"serviceType\\": -4,\\n \\"id\\": \\"20\\",\\n \\"displayName\\": \\"快递 免邮\\"\\n }\\n ],\\n \\"canSell\\": true,\\n \\"productList\\": [\\n {\\n \\"productTitle\\": \\"儿童学习桌\\",\\n \\"features\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"skuTitle\\": \\"浅绿色\\",\\n \\"quantity\\": 1,\\n \\"productId\\": \\"6600****6736\\",\\n \\"canSell\\": true,\\n \\"price\\": 100,\\n \\"productPicUrl\\": \\"//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0\\",\\n \\"purchaserId\\": \\"PID56****2304\\",\\n \\"message\\": \\"库存为0\\",\\n \\"skuId\\": \\"6600****6737\\"\\n }\\n ],\\n \\"extInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"unsellableOrderList\\": [\\n {\\n \\"message\\": \\"库存为0\\",\\n \\"deliveryInfoList\\": [\\n {\\n \\"postFee\\": 0,\\n \\"serviceType\\": -4,\\n \\"id\\": \\"20\\",\\n \\"displayName\\": \\"快递 免邮\\"\\n }\\n ],\\n \\"canSell\\": true,\\n \\"productList\\": [\\n {\\n \\"productTitle\\": \\"儿童学习桌\\",\\n \\"features\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"skuTitle\\": \\"浅绿色\\",\\n \\"quantity\\": 1,\\n \\"productId\\": \\"6600****6736\\",\\n \\"canSell\\": true,\\n \\"price\\": 100,\\n \\"productPicUrl\\": \\"//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0\\",\\n \\"purchaserId\\": \\"PID56****2304\\",\\n \\"message\\": \\"库存为0\\",\\n \\"skuId\\": \\"6600****6737\\"\\n }\\n ],\\n \\"extInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"message\\": \\"库存为0\\",\\n \\"extInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
'title' => 'Purchase Order Rendering ',
'description' => '>'."\n"
."\n"
.'This API will be offline soon. For purchase order rendering, use the SplitPurchaseOrder API, which supports both purchase order rendering and splitting.'."\n"
."\n"
.'>',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "deliveryAddress": {'."\n"
.' "divisionCode": "610102",'."\n"
.' "addressDetail": "Shaanxi Province, Xi\'an City, *** Building",'."\n"
.' "receiverPhone": "187****1553",'."\n"
.' "receiver": "Mr. Yan",'."\n"
.' "townDivisionCode": "61010212"'."\n"
.' },'."\n"
.' "buyerId": "test1234****679",'."\n"
.' "productList": ['."\n"
.' {'."\n"
.' "quantity": 1,'."\n"
.' "productId": "6600622091****6736",'."\n"
.' "purchaserId": "22000009",'."\n"
.' "skuId": "6600622091****6737"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "0928251D-713B-17A1-A2B0-1A57****90B4",'."\n"
.' "orderList": ['."\n"
.' {'."\n"
.' "productList": ['."\n"
.' {'."\n"
.' "productId": "6600622091****6736",'."\n"
.' "productTitle": "Children\'s study desk",'."\n"
.' "skuTitle": "Light gray",'."\n"
.' "skuId": "6600622091****6737",'."\n"
.' "purchaserId": "22***09",'."\n"
.' "promotionFee": null,'."\n"
.' "quantity": 1,'."\n"
.' "productUrl": null,'."\n"
.' "productPicUrl": "//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0DYLWA_!!2216003305543.jpg",'."\n"
.' "price": 1,'."\n"
.' "canSell": true,'."\n"
.' "message": null,'."\n"
.' "features": null'."\n"
.' }'."\n"
.' ],'."\n"
.' "deliveryInfoList": ['."\n"
.' {'."\n"
.' "id": "20",'."\n"
.' "displayName": "Express delivery, free shipping",'."\n"
.' "postFee": 0,'."\n"
.' "serviceType": -4'."\n"
.' }'."\n"
.' ],'."\n"
.' "invoiceInfo": null,'."\n"
.' "extInfo": null,'."\n"
.' "canSell": true,'."\n"
.' "message": null'."\n"
.' }'."\n"
.' ],'."\n"
.' "unsellableOrderList": ['."\n"
.' {'."\n"
.' "productList": [],'."\n"
.' "deliveryInfoList": null,'."\n"
.' "invoiceInfo": null,'."\n"
.' "extInfo": null,'."\n"
.' "canSell": false,'."\n"
.' "message": null'."\n"
.' }'."\n"
.' ],'."\n"
.' "addressList": ['."\n"
.' {'."\n"
.' "addressId": 0,'."\n"
.' "receiver": "Mr. Yan",'."\n"
.' "receiverPhone": "187****1553",'."\n"
.' "addressDetail": "Shaanxi Province, Xi\'an City, *** Building",'."\n"
.' "divisionCode": "610102",'."\n"
.' "townDivisionCode": "610102002"'."\n"
.' }'."\n"
.' ],'."\n"
.' "extInfo": null,'."\n"
.' "canSell": true,'."\n"
.' "message": null'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'linkedmall:RenderPurchaseOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '250', 'countWindow' => 10, 'regionId' => '*', 'api' => 'RenderPurchaseOrder'],
],
],
],
'RenderRefundOrder' => [
'summary' => 'Reverse Single Rendering',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/refunds/commands/render',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'tags' => [],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'allowEmptyValue' => true,
'schema' => ['description' => 'Refund order rendering', 'required' => true, '$ref' => '#/components/schemas/RefundRenderCmd', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => ['description' => 'Refund order rendering result', 'required' => false, '$ref' => '#/components/schemas/RefundRenderResult', 'title' => '', 'example' => ''],
'examples' => [],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxRefundFeeData\\": {\\n \\"minRefundFee\\": 1,\\n \\"maxRefundFee\\": 100\\n },\\n \\"refundReasonList\\": [\\n {\\n \\"reasonTextId\\": \\"47683\\",\\n \\"proofRequired\\": true,\\n \\"reasonTips\\": \\"不想要了\\",\\n \\"refundDescRequired\\": true\\n }\\n ],\\n \\"bizClaimType\\": 1,\\n \\"orderLineId\\": \\"6692****5458\\",\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\"\\n}","type":"json"}]',
'title' => 'After-sales order rendering ',
'description' => 'Renders a refund order.',
'requestParamsDescription' => '```'."\n"
.'{'."\n"
.' "bizClaimType": 3,'."\n"
.' "goodsStatus": 2,'."\n"
.' "orderLineId": "6696070566****8594"'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": "6D7C43A1-2EFC-185E-816E-A8CB****36EB",'."\n"
.' "orderLineId": "6696070566****8594",'."\n"
.' "bizClaimType": 3,'."\n"
.' "maxRefundFeeData": {'."\n"
.' "maxRefundFee": 1,'."\n"
.' "minRefundFee": 0'."\n"
.' },'."\n"
.' "refundReasonList": ['."\n"
.' {'."\n"
.' "reasonTextId": "402652",'."\n"
.' "proofRequired": false,'."\n"
.' "reasonTips": "Ordered wrong/too many/don\'t like",'."\n"
.' "refundDescRequired": false'."\n"
.' },'."\n"
.' {'."\n"
.' "reasonTextId": "403883",'."\n"
.' "proofRequired": false,'."\n"
.' "reasonTips": "Product ingredients do not match description",'."\n"
.' "refundDescRequired": false'."\n"
.' },'."\n"
.' {'."\n"
.' "reasonTextId": "402641",'."\n"
.' "proofRequired": false,'."\n"
.' "reasonTips": "Size/specifications do not match",'."\n"
.' "refundDescRequired": false'."\n"
.' },'."\n"
.' {'."\n"
.' "reasonTextId": "402649",'."\n"
.' "proofRequired": false,'."\n"
.' "reasonTips": "Color/style/packaging does not match product description",'."\n"
.' "refundDescRequired": false'."\n"
.' },'."\n"
.' {'."\n"
.' "reasonTextId": "402645",'."\n"
.' "proofRequired": false,'."\n"
.' "reasonTips": "Received incomplete/damaged/deformed product",'."\n"
.' "refundDescRequired": false'."\n"
.' },'."\n"
.' {'."\n"
.' "reasonTextId": "402638",'."\n"
.' "proofRequired": false,'."\n"
.' "reasonTips": "Withered/dead",'."\n"
.' "refundDescRequired": false'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'linkedmall:RenderRefundOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 10, 'regionId' => '*', 'api' => 'RenderRefundOrder'],
],
],
],
'SearchProducts' => [
'summary' => 'The product search API is a paginated interface for searching products based on various criteria.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/selectionPool/selection-group/product/command/searchProduct',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '263793',
'abilityTreeNodes' => ['FEATURElinkedmallMY1IED'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'Request body',
'type' => 'object',
'properties' => [
'purchaserId' => ['description' => 'Purchaser ID', 'type' => 'string', 'required' => true, 'example' => 'PIDxxxx', 'title' => ''],
'categoryIds' => [
'description' => 'Collection of category IDs',
'type' => 'array',
'items' => ['description' => 'Category ID', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
'productStatus' => [
'description' => 'Product status',
'enumValueTitles' => ['Unsellable' => 'Unsellable', 'Sellable' => 'Sellable'],
'type' => 'string',
'required' => false,
'example' => 'Sellable',
'title' => '',
],
'productName' => ['description' => 'Product name', 'type' => 'string', 'required' => false, 'example' => '绿植', 'title' => ''],
'productId' => ['description' => 'Product ID', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxx', 'title' => ''],
'lmItemId' => ['description' => 'LM product ID', 'type' => 'string', 'required' => false, 'example' => 'xxx-xxxxx', 'title' => ''],
'inGroup' => [
'description' => 'Whether the product is in inventory',
'enumValueTitles' => ['true' => 'In inventory', 'false' => 'Not in inventory'],
'type' => 'boolean',
'required' => false,
'example' => 'true',
'title' => '',
],
'inventoryRiskLevel' => [
'description' => 'Inventory risk level',
'enumValueTitles' => ['High' => 'High', 'Low' => 'Low'],
'type' => 'string',
'required' => false,
'example' => 'Low',
'title' => '',
],
'distributionLowPrice' => ['description' => 'Lower limit of distribution purchase price', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100(单位:分)', 'title' => ''],
'distributionHighPrice' => ['description' => 'Upper limit of distribution purchase price', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100(单位:分)', 'title' => ''],
'distributionLowPriceRatio' => ['description' => 'Lower limit of distribution premium rate', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '133(1.33%)', 'title' => ''],
'distributionHighPriceRatio' => ['description' => 'Upper limit of distribution premium rate', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '244(2.44%)', 'title' => ''],
'lowMarkPrice' => ['description' => 'Lower limit of strikethrough price', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100(单位:分)', 'title' => ''],
'highMarkPrice' => ['description' => 'Upper limit of strikethrough price', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100(单位:分)', 'title' => ''],
'lowPrice' => ['description' => 'Lower limit of suggested retail price', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100(单位:分)', 'title' => ''],
'highPrice' => ['description' => 'Upper limit of suggested retail price', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100(单位:分)', 'title' => ''],
'platform' => [
'description' => 'Source platform',
'enumValueTitles' => ['Tmall' => 'Tmall', 'Taobao' => 'Taobao'],
'type' => 'string',
'required' => false,
'example' => 'Taobao(来源淘宝)'."\n"
.'Tmall(来源天猫)'."\n"
.'Cbu(来源1688分销货盘)',
'title' => '',
],
'brandName' => ['description' => 'Brand name', 'type' => 'string', 'required' => false, 'example' => '绿植', 'title' => ''],
'inGroupStartTime' => ['description' => 'Inventory start time', 'type' => 'string', 'required' => false, 'example' => '2025-01-02 12:23:34'."\n"
.'(yyyy-MM-dd HH:mm:ss)', 'title' => ''],
'inGroupEndTime' => ['description' => 'End time of the product’s entry period.', 'type' => 'string', 'required' => false, 'example' => '2025-01-02 12:23:34'."\n"
.'(yyyy-MM-dd HH:mm:ss)', 'title' => ''],
'modifyStartTime' => ['description' => 'Modification start time', 'type' => 'string', 'required' => false, 'example' => '2025-01-02 12:23:34'."\n"
.'(yyyy-MM-dd HH:mm:ss)', 'title' => ''],
'modifyEndTime' => ['description' => 'Modification end time', 'type' => 'string', 'required' => false, 'example' => '2025-01-02 12:23:34'."\n"
.'(yyyy-MM-dd HH:mm:ss)', 'title' => ''],
'createStartTime' => ['description' => 'Creation start time', 'type' => 'string', 'required' => false, 'example' => '2025-01-02 12:23:34'."\n"
.'(yyyy-MM-dd HH:mm:ss)', 'title' => ''],
'createEndTime' => ['description' => 'Creation end time', 'type' => 'string', 'required' => false, 'example' => '2025-01-02 12:23:34'."\n"
.'(yyyy-MM-dd HH:mm:ss)', 'title' => ''],
'tradeModeAndCredit' => [
'description' => 'Sales pattern',
'enumValueTitles' => ['Credit90' => 'Supports 90-day billing cycle', 'NonCredit' => 'Does not support billing cycle', 'ConsignmentJingXiao' => 'Distribution and consignment', 'JingXiao' => 'Distribution', 'None' => 'No configuration'],
'type' => 'string',
'required' => false,
'example' => 'JingXiao',
'title' => '',
],
'taxRate' => [
'description' => 'Tax rate'."\n"
."\n"
.'> - Supports combining multiple tax rate enumeration values as request parameters. Use commas to separate them, for example: Rate0,Rate1.'."\n"
.'>'."\n"
.'> - HasRate cannot be combined with other enumeration values as request parameters.',
'enumValueTitles' => ['Rate1' => '1%', 'Rate0' => '0% tax rate', 'Rate5' => '5%', 'Rate6' => '6%', 'HasRate' => 'Has tax rate', 'Rate9' => '9%', 'Rate13' => '13%', 'NonRate' => 'No tax rate', 'TaxExemption' => 'Tax exemption'],
'type' => 'string',
'required' => false,
'example' => 'Rate0',
'title' => '',
],
'pageSize' => ['description' => 'Page size'."\n"
."\n"
.'> - Maximum of 20 items per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
'pageNumber' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
'orderBy' => [
'description' => 'Sort field'."\n"
."\n"
.'> - Used in combination with the sort direction field',
'enumValueTitles' => ['soldQuantity' => 'Sort by sales volume'],
'type' => 'string',
'required' => false,
'example' => 'soldQuantity(按销量排序,不填默认创建时间倒序)',
'title' => '',
],
'orderDirection' => [
'description' => 'Sort direction'."\n"
."\n"
.'> - Used in combination with the sort field',
'enumValueTitles' => [' ASC' => 'Ascending order', 'DESC' => 'Descending order'],
'type' => 'string',
'required' => false,
'example' => 'ASC',
'title' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'total' => ['description' => 'Total quantity', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'products' => [
'description' => 'Product collection',
'type' => 'array',
'items' => [
'description' => 'Product collection',
'type' => 'object',
'properties' => [
'picUrl' => ['description' => 'Product main image URL', 'type' => 'string', 'example' => 'https://img.alicdn.com/xxx.jpg', 'title' => ''],
'productName' => ['description' => 'Product name', 'type' => 'string', 'example' => '绿植', 'title' => ''],
'productId' => ['description' => 'Product ID', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
'lmItemId' => ['description' => 'LM product ID', 'type' => 'string', 'example' => 'xxx-xxxxx', 'title' => ''],
'distributionPrice' => ['description' => 'Distribution purchase price range', 'type' => 'string', 'example' => '¥0.05 ~ ¥21.10', 'title' => ''],
'diffPrice' => ['description' => 'Price difference range', 'type' => 'string', 'example' => '¥-9998.95 ~ ¥-9977.90', 'title' => ''],
'distributionPriceRatio' => ['description' => 'Distribution premium rate range', 'type' => 'string', 'example' => '-100.00% ~ -99.79%', 'title' => ''],
'platformPrice' => ['description' => 'Suggested retail price range', 'type' => 'string', 'example' => '¥9999.00 ~ ¥9999.00', 'title' => ''],
'platformReservePrice' => ['description' => 'Strikethrough price range', 'type' => 'string', 'example' => '¥9999.00 ~ ¥9999.00', 'title' => ''],
'soldQuantity' => ['description' => 'Accumulated sales volume', 'type' => 'string', 'example' => '100', 'title' => ''],
'inventoryRiskLevel' => [
'description' => 'Inventory risk level',
'enumValueTitles' => ['High' => 'High', 'Low' => 'Low'],
'type' => 'string',
'example' => 'Low',
'title' => '',
],
'externalPlatformType' => ['description' => 'Source platform', 'type' => 'string', 'example' => 'Taobao(来源淘宝)'."\n"
.'Tmall(来源天猫)'."\n"
.'Cbu(来源1688分销货盘)', 'title' => ''],
'shopName' => ['description' => 'Channel store name', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'categoryChain' => [
'description' => 'Category',
'type' => 'array',
'items' => [
'description' => 'Category',
'type' => 'object',
'properties' => [
'categoryId' => ['description' => 'Category ID', 'type' => 'integer', 'format' => 'int64', 'example' => '201792301', 'title' => ''],
'name' => ['description' => 'Category name', 'type' => 'string', 'example' => '名称测试', 'title' => ''],
'parentId' => ['description' => 'Parent class ID', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'isLeaf' => ['description' => 'Is leaf node', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'level' => ['description' => 'Level', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'bandName' => ['description' => 'Brand name', 'type' => 'string', 'example' => '绿植', 'title' => ''],
'canSell' => ['description' => 'Whether the product is sellable (calculated value)', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'canNotSellReason' => ['description' => 'Reason for unsellable status', 'type' => 'string', 'example' => '库存不足', 'title' => ''],
'tradeMode' => ['description' => 'Sales pattern', 'type' => 'string', 'example' => 'JingXiao', 'title' => ''],
'credit' => [
'description' => 'Billing cycle',
'type' => 'array',
'items' => [
'description' => 'Billing cycle',
'enumValueTitles' => ['Credit90' => '90-day billing cycle', 'NonCredit' => 'Does not support billing cycle'],
'type' => 'string',
'example' => 'Credit90',
'title' => '',
],
'title' => '',
'example' => '',
],
'invoiceType' => [
'description' => 'Invoice type',
'enumValueTitles' => ['HasInvoice' => 'Invoice available', 'NonInvoice' => 'Invoice not available'],
'type' => 'string',
'example' => 'HasInvoice',
'title' => '',
],
'taxRate' => ['description' => 'Tax rate', 'type' => 'integer', 'format' => 'int64', 'example' => '600(6%)'."\n"
.'-100(免税)', 'title' => ''],
'taxCode' => ['description' => 'Tax code', 'type' => 'string', 'example' => '3040203000000000000', 'title' => ''],
'gmtCreate' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2025-01-02 12:23:34'."\n"
.'(yyyy-MM-dd HH:mm:ss)'."\n", 'title' => ''],
'inGroupTime' => ['description' => 'Inventory time', 'type' => 'string', 'example' => '2025-01-02 12:23:34'."\n"
.'(yyyy-MM-dd HH:mm:ss)'."\n", 'title' => ''],
'gmtModified' => ['description' => 'Last modified time.', 'type' => 'string', 'example' => '2025-01-02 12:23:34'."\n"
.'(yyyy-MM-dd HH:mm:ss)'."\n", 'title' => ''],
'inGroup' => [
'description' => 'Whether the product is in inventory',
'enumValueTitles' => ['true' => 'In inventory', 'false' => 'Not in inventory'],
'type' => 'boolean',
'example' => 'true',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 3,\\n \\"products\\": [\\n {\\n \\"picUrl\\": \\"https://img.alicdn.com/xxx.jpg\\",\\n \\"productName\\": \\"绿植\\",\\n \\"productId\\": \\"xxxxx\\",\\n \\"lmItemId\\": \\"xxx-xxxxx\\",\\n \\"distributionPrice\\": \\"¥0.05 ~ ¥21.10\\",\\n \\"diffPrice\\": \\"¥-9998.95 ~ ¥-9977.90\\",\\n \\"distributionPriceRatio\\": \\"-100.00% ~ -99.79%\\",\\n \\"platformPrice\\": \\"¥9999.00 ~ ¥9999.00\\",\\n \\"platformReservePrice\\": \\"¥9999.00 ~ ¥9999.00\\",\\n \\"soldQuantity\\": \\"100\\",\\n \\"inventoryRiskLevel\\": \\"Low\\",\\n \\"externalPlatformType\\": \\"Taobao(来源淘宝)\\\\nTmall(来源天猫)\\\\nCbu(来源1688分销货盘)\\",\\n \\"shopName\\": \\"xxx\\",\\n \\"categoryChain\\": [\\n {\\n \\"categoryId\\": 201792301,\\n \\"name\\": \\"名称测试\\",\\n \\"parentId\\": 0,\\n \\"isLeaf\\": false,\\n \\"level\\": 1\\n }\\n ],\\n \\"bandName\\": \\"绿植\\",\\n \\"canSell\\": true,\\n \\"canNotSellReason\\": \\"库存不足\\",\\n \\"tradeMode\\": \\"JingXiao\\",\\n \\"credit\\": [\\n \\"Credit90\\"\\n ],\\n \\"invoiceType\\": \\"HasInvoice\\",\\n \\"taxRate\\": 0,\\n \\"taxCode\\": \\"3040203000000000000\\",\\n \\"gmtCreate\\": \\"2025-01-02 12:23:34\\\\n(yyyy-MM-dd HH:mm:ss)\\\\n\\",\\n \\"inGroupTime\\": \\"2025-01-02 12:23:34\\\\n(yyyy-MM-dd HH:mm:ss)\\\\n\\",\\n \\"gmtModified\\": \\"2025-01-02 12:23:34\\\\n(yyyy-MM-dd HH:mm:ss)\\\\n\\",\\n \\"inGroup\\": true\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Search Product Selection Pool Products ',
'responseParamsDescription' => '```'."\n"
.'{'."\n"
.' "requestId": null,'."\n"
.' "total": 1,'."\n"
.' "products": ['."\n"
.' {'."\n"
.' "picUrl": "//img.alicdn.com/imgextra/i4/xxx.jpg",'."\n"
.' "productName": "xxx",'."\n"
.' "productId": "xxxx",'."\n"
.' "lmItemId": "xxx-xxx",'."\n"
.' "distributionPrice": "¥0.01 ~ ¥0.02",'."\n"
.' "diffPrice": "¥0.00 ~ ¥0.00",'."\n"
.' "distributionPriceRatio": "0.00% ~ 0.00%",'."\n"
.' "platformPrice": "¥0.01 ~ ¥0.02",'."\n"
.' "platformReservePrice": "¥0.01 ~ ¥0.02",'."\n"
.' "soldQuantity": "1",'."\n"
.' "inventoryRiskLevel": "Low",'."\n"
.' "externalPlatformType": "Tmall",'."\n"
.' "shopName": "xxxx",'."\n"
.' "categoryChain": ['."\n"
.' {'."\n"
.' "categoryId": 50050359,'."\n"
.' "name": "Aquatic products/Meat/Fresh vegetables/Cooked food",'."\n"
.' "parentId": 0,'."\n"
.' "level": 1,'."\n"
.' "isLeaf": false'."\n"
.' },'."\n"
.' {'."\n"
.' "categoryId": 50050372,'."\n"
.' "name": "Raw meat/Meat products",'."\n"
.' "parentId": 50050359,'."\n"
.' "level": 2,'."\n"
.' "isLeaf": false'."\n"
.' },'."\n"
.' {'."\n"
.' "categoryId": 50050667,'."\n"
.' "name": "Chicken products",'."\n"
.' "parentId": 50050372,'."\n"
.' "level": 3,'."\n"
.' "isLeaf": false'."\n"
.' },'."\n"
.' {'."\n"
.' "categoryId": 124222016,'."\n"
.' "name": "Whole chicken/Whole chicken products",'."\n"
.' "parentId": 50050667,'."\n"
.' "level": 4,'."\n"
.' "isLeaf": true'."\n"
.' }'."\n"
.' ],'."\n"
.' "bandName": "xxx",'."\n"
.' "canSell": true,'."\n"
.' "canNotSellReason": null,'."\n"
.' "tradeMode": "JingXiao",'."\n"
.' "credit": ['."\n"
.' "Credit90"'."\n"
.' ],'."\n"
.' "invoiceType": "HasInvoice",'."\n"
.' "taxRate": 0,'."\n"
.' "taxCode": "xxx",'."\n"
.' "gmtCreate": "2025-01-21 17:11:04",'."\n"
.' "inGroupTime": "2025-01-21 17:12:09",'."\n"
.' "gmtModified": "2025-01-21 17:11:04",'."\n"
.' "inGroup": true'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```',
'changeSet' => [
['createdAt' => '2025-04-03T02:27:54.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2025-02-19T02:53:12.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:SearchProducts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'SearchProducts'],
],
],
],
'SelectionGroupAddProduct' => [
'summary' => 'The distributor takes delivery of goods.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/selectionPool/selection-group/product/command/addProduct',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '263790',
'abilityTreeNodes' => ['FEATURElinkedmallMY1IED'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'Request body',
'type' => 'object',
'properties' => [
'purchaserId' => ['description' => 'Purchaser ID', 'type' => 'string', 'required' => true, 'example' => 'PIDxxxxx', 'title' => ''],
'productIds' => [
'description' => 'Collection of product IDs to add'."\n"
."\n"
.'> - You can add up to 30 products per call.',
'type' => 'array',
'items' => ['description' => 'Product ID', 'type' => 'string', 'required' => true, 'example' => 'xxxx', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Response from the add operation',
'type' => 'object',
'properties' => [
'productIds' => [
'description' => 'List of product IDs successfully added',
'type' => 'array',
'items' => ['description' => 'Product ID successfully added', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"productIds\\": [\\n \\"xxxx\\"\\n ]\\n}","type":"json"}]',
'title' => 'Warehousing Products from the Product Selection Pool ',
'description' => 'Distributors use this API to add products to their selection group.'."\n"
."\n"
.'> We recommend that distributors who onboard on or after January 1, 2025 use this API. For more information about adding products and the related impact, see the [product best practices](https://help.aliyun.com/zh/linkedmall/user-guide/product-interface-best-practices?spm=a2c4g.11186623.help-menu-88587.d_2_2_0_8_0.58122056oN3crP\\&scm=20140722.H_2869668._.OR_help-T_cn~zh-V_1#lFENl).',
'requestParamsDescription' => 'A product that is already in the inventory cannot be added.',
'responseParamsDescription' => 'The response includes only product IDs that were added successfully.',
'changeSet' => [
['createdAt' => '2025-02-19T02:53:12.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'linkedmall:SelectionGroupAddProduct',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'SelectionGroupAddProduct'],
],
],
],
'SelectionGroupRemoveProduct' => [
'summary' => 'Removes products from a distributor\'s stock.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/selectionPool/selection-group/product/command/removeProduct',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '263792',
'abilityTreeNodes' => ['FEATURElinkedmallMY1IED'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => 'The request body.',
'type' => 'object',
'properties' => [
'purchaserId' => ['description' => 'The ID of the purchaser.', 'type' => 'string', 'required' => true, 'example' => 'PIDxxxxx', 'title' => ''],
'productIds' => [
'description' => 'A list of IDs for the products to be removed from stock.'."\n"
."\n"
.'> - A single call supports a maximum of 30 products.',
'type' => 'array',
'items' => ['description' => 'The ID of the product to be removed from stock.', 'type' => 'string', 'required' => true, 'example' => 'xxxxxx', 'title' => ''],
'required' => true,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response from the removal operation.',
'type' => 'object',
'properties' => [
'productIds' => [
'description' => 'A collection of IDs for the products that were successfully removed.',
'type' => 'array',
'items' => ['description' => 'The ID of a product that was successfully removed.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"productIds\\": [\\n \\"xxxxx\\"\\n ]\\n}","type":"json"}]',
'title' => 'Product Outbound from Selection Pool ',
'description' => 'Distributors use this API to remove products from their stock.',
'requestParamsDescription' => 'Products that have already been removed are not removed again.',
'responseParamsDescription' => 'This operation returns only the list of IDs for successfully removed products.',
'changeSet' => [
['createdAt' => '2025-02-19T02:53:12.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'SelectionGroupRemoveProduct'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'linkedmall:SelectionGroupRemoveProduct',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SplitPurchaseOrder' => [
'summary' => 'Splits a purchase order and renders the resulting parent-child order structure. This API returns a list of items based on the final parent-child order structure. Distributors can use this response to render the final parent-child order layout, which simplifies receiving the purchase order creation success message and backfilling parent-child order information later.',
'path' => '/opensaas-s2b/opensaas-s2b-biz-trade/v2/purchaseOrders/commands/split',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'schema' => ['description' => 'Input parameters for splitting and rendering a purchase order', '$ref' => '#/components/schemas/PurchaseOrderRenderQuery', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => ['description' => 'Response from splitting and rendering a purchase order', '$ref' => '#/components/schemas/PurchaseOrderRenderResult', 'title' => '', 'example' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"addressList\\": [\\n {\\n \\"divisionCode\\": \\"330106\\",\\n \\"addressDetail\\": \\"陕西省西安市新城区xx街道xxx大厦xx室\\",\\n \\"receiverPhone\\": \\"182***5674\\",\\n \\"townDivisionCode\\": \\"330106109\\",\\n \\"receiver\\": \\"任先生\\",\\n \\"addressId\\": 0\\n }\\n ],\\n \\"canSell\\": true,\\n \\"requestId\\": \\"841471F6-5D61-1331-8C38-2****B55\\",\\n \\"orderList\\": [\\n {\\n \\"message\\": \\"库存为0\\",\\n \\"deliveryInfoList\\": [\\n {\\n \\"postFee\\": 0,\\n \\"serviceType\\": -4,\\n \\"id\\": \\"20\\",\\n \\"displayName\\": \\"快递 免邮\\"\\n }\\n ],\\n \\"canSell\\": true,\\n \\"productList\\": [\\n {\\n \\"productTitle\\": \\"儿童学习桌\\",\\n \\"features\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"skuTitle\\": \\"浅绿色\\",\\n \\"quantity\\": 1,\\n \\"productId\\": \\"6600****6736\\",\\n \\"canSell\\": true,\\n \\"price\\": 100,\\n \\"productPicUrl\\": \\"//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0\\",\\n \\"purchaserId\\": \\"PID56****2304\\",\\n \\"message\\": \\"库存为0\\",\\n \\"skuId\\": \\"6600****6737\\"\\n }\\n ],\\n \\"extInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"unsellableOrderList\\": [\\n {\\n \\"message\\": \\"库存为0\\",\\n \\"deliveryInfoList\\": [\\n {\\n \\"postFee\\": 0,\\n \\"serviceType\\": -4,\\n \\"id\\": \\"20\\",\\n \\"displayName\\": \\"快递 免邮\\"\\n }\\n ],\\n \\"canSell\\": true,\\n \\"productList\\": [\\n {\\n \\"productTitle\\": \\"儿童学习桌\\",\\n \\"features\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"skuTitle\\": \\"浅绿色\\",\\n \\"quantity\\": 1,\\n \\"productId\\": \\"6600****6736\\",\\n \\"canSell\\": true,\\n \\"price\\": 100,\\n \\"productPicUrl\\": \\"//img.alicdn.com/imgextra/i4/2216003305543/O1CN01bip3Un1qokG0\\",\\n \\"purchaserId\\": \\"PID56****2304\\",\\n \\"message\\": \\"库存为0\\",\\n \\"skuId\\": \\"6600****6737\\"\\n }\\n ],\\n \\"extInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"message\\": \\"库存为0\\",\\n \\"extInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]',
'title' => 'Render and Split Purchase Order ',
'description' => 'Call this API before creating a purchase order. It returns two lists: one for sellable items and one for unsellable items. The sellable items list follows the final parent-child order split structure.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'linkedmall:SplitPurchaseOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '250', 'countWindow' => 10, 'regionId' => '*', 'api' => 'SplitPurchaseOrder'],
],
],
],
],
'endpoints' => [
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkedmall.aliyuncs.com', 'endpoint' => 'linkedmall.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkedmall-distributor.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'linkedmall-distributor.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'linkedmall-distributor-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkedmall.cn-hangzhou.aliyuncs.com', 'endpoint' => 'linkedmall.cn-hangzhou.aliyuncs.com', 'vpc' => 'linkedmall.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'linkedmall.aliyuncs.com', 'endpoint' => 'linkedmall.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'ApplyReasonTextIdInvalid', 'message' => '无效的退款原因id', 'http_code' => 400, 'description' => ''],
['code' => 'AuthCompanyNotFind', 'message' => 'AK对应的主体不存在', 'http_code' => 404, 'description' => ''],
['code' => 'CpCodeInvalid', 'message' => '无法识别的快递公司代号 {}', 'http_code' => 400, 'description' => ''],
['code' => 'DisputeInSelleFundOnlyCanReturnAll', 'message' => '售中只能全部退', 'http_code' => 400, 'description' => ''],
['code' => 'DisputePolicyInvalid', 'message' => '无效的退款类型', 'http_code' => 400, 'description' => ''],
['code' => 'GoodStatusInvalid', 'message' => '无效的货品状态', 'http_code' => 400, 'description' => ''],
['code' => 'HasNoPrivilege', 'message' => 'NoPrivilege.', 'http_code' => 403, 'description' => 'No permission'],
['code' => 'linkedmall.errorcode.InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => ''],
['code' => 'MissingParameter', 'message' => 'You must specify the parameter.', 'http_code' => 500, 'description' => ''],
['code' => 'MissingParameter', 'message' => 'Required parameter \'{}\' is not found.', 'http_code' => 400, 'description' => ''],
['code' => 'OnlyRefundAndReturnCanSubmitShipping', 'message' => '只有退货退款才能提交退货物流信息', 'http_code' => 400, 'description' => ''],
['code' => 'OrderForbidden', 'message' => '{} 订单无访问权限', 'http_code' => 403, 'description' => ''],
['code' => 'OrderLineForbidden', 'message' => '{} 子订单无访问权限', 'http_code' => 403, 'description' => ''],
['code' => 'OrderLineNotFound', 'message' => '{} 子订单不存在', 'http_code' => 404, 'description' => ''],
['code' => 'OrderNotFound', 'message' => '订单不存在', 'http_code' => 404, 'description' => ''],
['code' => 'OuterPurchaseOrderIdExist', 'message' => '{} 外部采购单已经存在', 'http_code' => 500, 'description' => ''],
['code' => 'ParameterInvalid', 'message' => 'parameter {} invalid', 'http_code' => 400, 'description' => ''],
['code' => 'PurchaseOrderForbidden', 'message' => '采购单不存在或无访问权限', 'http_code' => 403, 'description' => ''],
['code' => 'PurchaseOrderIdOrOrderIdInvalid', 'message' => '分销交易号或者主订单号不正确', 'http_code' => 400, 'description' => ''],
['code' => 'PurchaseOrderNotFound', 'message' => '{} 采购单不存在', 'http_code' => 400, 'description' => ''],
['code' => 'RefundAmountMustLessThanOrder', 'message' => '退款金额不能大于订单金额', 'http_code' => 400, 'description' => ''],
['code' => 'RefundNotFound', 'message' => '退款单不存在', 'http_code' => 400, 'description' => ''],
['code' => 'RefundNumberMustLessThanOrder', 'message' => '退款数量不能大于订单数量', 'http_code' => 400, 'description' => ''],
['code' => 'SavePurchaseOrderError', 'message' => '保存采购单失败', 'http_code' => 500, 'description' => ''],
['code' => 'ShopForbidden', 'message' => '{} 店铺无访问权限', 'http_code' => 403, 'description' => ''],
['code' => 'ShopIdUnique', 'message' => '存在多个不同的shopId', 'http_code' => 404, 'description' => ''],
['code' => 'ShopNotFind', 'message' => '{} 店铺不存在', 'http_code' => 404, 'description' => ''],
['code' => 'ShopTypeInvalid', 'message' => 'skuId:{} 是经销集采的店铺商品无法下单', 'http_code' => 400, 'description' => ''],
['code' => 'SkuNotFind', 'message' => '{} sku不存在', 'http_code' => 404, 'description' => ''],
['code' => 'SkuPriceUnique', 'message' => 'skuId:{} sku价格不是最新的', 'http_code' => 400, 'description' => ''],
],
'changeSet' => [
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'SearchProducts'],
['description' => 'Request parameters changed', 'api' => 'SelectionGroupAddProduct'],
['description' => 'Request parameters changed', 'api' => 'SelectionGroupRemoveProduct'],
],
'createdAt' => '2025-02-19T02:53:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'GetSelectionProduct'],
],
'createdAt' => '2024-03-29T03:14:50.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ListPurchaserShops'],
],
'createdAt' => '2023-09-15T07:17:12.000Z',
'description' => '',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListSelectionSkuSaleInfos'],
['threshold' => '3500', 'countWindow' => 100, 'regionId' => '*', 'api' => 'CreatePurchaseOrder'],
['threshold' => '250', 'countWindow' => 10, 'regionId' => '*', 'api' => 'SplitPurchaseOrder'],
['threshold' => '100', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CancelRefundOrder'],
['threshold' => '500', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetSelectionProduct'],
['threshold' => '500', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetSelectionProductSaleInfo'],
['threshold' => '150', 'countWindow' => 10, 'regionId' => '*', 'api' => 'RenderRefundOrder'],
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'SelectionGroupRemoveProduct'],
['threshold' => '270', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetRefundOrder'],
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'QueryChildDivisionCode'],
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateGoodsShippingNotice'],
['threshold' => '200', 'countWindow' => 10, 'regionId' => '*', 'api' => 'QueryOrders'],
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListCategories'],
['threshold' => '130', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetPurchaseOrderStatus'],
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetPurchaserShop'],
['threshold' => '150', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ConfirmDisburse'],
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListSelectionProducts'],
['threshold' => '550', 'countWindow' => 10, 'regionId' => '*', 'api' => 'GetOrder'],
['threshold' => '250', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListLogisticsOrders'],
['threshold' => '250', 'countWindow' => 10, 'regionId' => '*', 'api' => 'RenderPurchaseOrder'],
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'SelectionGroupAddProduct'],
['threshold' => '200', 'countWindow' => 10, 'regionId' => '*', 'api' => 'ListSelectionProductSaleInfos'],
['threshold' => '50', 'countWindow' => 10, 'regionId' => '*', 'api' => 'SearchProducts'],
['threshold' => '100', 'countWindow' => 10, 'regionId' => '*', 'api' => 'CreateRefundOrder'],
['threshold' => '25', 'countWindow' => 5, 'regionId' => '*', 'api' => 'ListPurchaserShops'],
],
],
'ram' => [
'productCode' => 'Linkedmall',
'productName' => 'LinkedMall',
'ramCodes' => ['linkedmall', 'neuron'],
'ramLevel' => 'OPERATION',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'ListPurchaserShops',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListPurchaserShops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryChildDivisionCode',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:QueryChildDivisionCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SearchProducts',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:SearchProducts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetOrder',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPurchaseOrderStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetPurchaseOrderStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSelectionProductSaleInfos',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListSelectionProductSaleInfos',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCategories',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListCategories',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SelectionGroupAddProduct',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'linkedmall:SelectionGroupAddProduct',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSelectionProduct',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetSelectionProduct',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSelectionProductSaleInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetSelectionProductSaleInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateGoodsShippingNotice',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'linkedmall:CreateGoodsShippingNotice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSelectionSkuSaleInfos',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListSelectionSkuSaleInfos',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SplitPurchaseOrder',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'linkedmall:SplitPurchaseOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRefundOrder',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetRefundOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListLogisticsOrders',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListLogisticsOrders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ConfirmDisburse',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'linkedmall:ConfirmDisburse',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SelectionGroupRemoveProduct',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'linkedmall:SelectionGroupRemoveProduct',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenderPurchaseOrder',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'linkedmall:RenderPurchaseOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateRefundOrder',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'linkedmall:CreateRefundOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenderRefundOrder',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'linkedmall:RenderRefundOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSelectionProducts',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'linkedmall:ListSelectionProducts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryOrders',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'linkedmall:QueryOrders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPurchaserShop',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkedmall:GetPurchaserShop',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreatePurchaseOrder',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'linkedmall:CreatePurchaseOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelRefundOrder',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'linkedmall:CancelRefundOrder',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Linkedmall', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];