1. Refound
API URL
post {HTTP(S)host} /api/{version}/returnOrder
1.1. create refound order
1.1.1. SERVICE_TYPE
CREATE_RETURN_ORDER
1.1.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| orderNumber | N | String | “S200305115680” | QERP System order number |
| warehouse | Y | String | “FBA美国” | Return warehouse, up to 50 characters |
| shop | Y | String | “测试 Shop ” | Refund Shopwith a maximum of 50 characters. If you fill in the orderNumber, the order must belong to the same shop as shop |
| expectArriveTime | N | String | “2020-03-06” | Estimated time of arrival yyyy-MM-dd |
| reason | N | String | “买错了” | The reason for the return, up to 512 characters |
| remark | N | String | Description | |
| carrier | N | String | carrierwith a maximum of 50 characters | |
| customNumber | N | String | Tracking numberwith a maximum of 50 characters | |
| autoCommit | N | Boolean | true / false | Whether it is submitted automatically, true: the user does not need to manually click submit in Qianyi ERP |
| returnSkuList | List<ReturnSku> | See ReturnSku | ||
| refundCustomFieldValueVOList | N | List<SkuCustomFieldValueVO> | Custom fields |
ReturnSku(refund details)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| orderSkuId | O | Number | 113 | The product ID of the sales order is obtained from the Order query interface. If it is a combination product, only the sub-product is taken. (Fill in orderSkuId or sku.) When the orderNumber is passed, the orderSkuId shall prevail) |
| sku | O | String | QERP sku(For the SKU of a single product, you can confirm the specific detail line) (orderSkuId and sku can be filled in, and orderSkuId shall prevail) (when the orderNumber is not passed, the sku must be passed and cannot be a combination) | |
| quantity | Y | Number | 1 | Number of returns |
| remark | N | String | Description |
SkuCustomFieldValueVO(Custom fields)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| customFieldId | Y | Long | 3 | CUSTOMER_FIELD_QUERY in SERVICE_TYPE Specifies the id returned by the interface |
| value | Y | String | “Zhang SAN” | Custom values for fields |
1.1.3. Reponse
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | Error Code |
| errorMsg | Y | String | “The input of Params is incorrect” | Business Error Messages |
| state | Y | String | success | Response State |
| result | Y | ReturnOrder | See ReturnOrder |
1.2. Cancel refound
1.2.1. SERVICE_TYPE
CLOSE_RETURN_ORDER
1.2.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| returnNumber | Y | String | “B200308115691” | refound order number |
1.2.3. Reponse
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | Error Code |
| errorMsg | Y | String | “The input of Params is incorrect” | Business Error Messages |
| state | Y | String | success | Response State |
1.3. Query refund order list
1.3.1. SERVICE_TYPE
QUERY_RETURN_ORDER_LIST
1.3.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| returnNumber | N | String | “S200222115613” | System return number, up to 50 characters |
| warehouse | N | String | Warehouse name,with a maximum of 50 characters | |
| status | N | String | Return order status | |
| fromCreateTime | N | String | “2020-03-04” | Begin of Creation time yyyy-MM-dd HH:mm:ss |
| toCreateTime | N | String | “2020-03-26” | End of Creation time yyyy-MM-dd HH:mm:ss |
| updateTimeFrom | N | String | 2021-08-01 | Refund Update time , accurate to the "day" |
| updateTimeTo | N | String | 2021-08-01 | Refund Update time , accurate to the "day" |
| finishTimeFrom | N | String | 2023-08-01 | Refund Completion time to the "hour, minute, second" |
| finishTimeTo | N | String | 2023-08-01 | Refund Completion time to the "hour, minute, second" |
| shopIdList | N | List<Long> | [1,2,3] | Shop id list |
| shopGroupIdList | N | List<Long> | [1,2,3] | ShopGroupId list |
| page | Y | Number | 1 | Page number, default 1 |
| pageSize | Y | Number | 50 | Number of records per page. no more than 200; Default is 100 |
| withoutType | N | Boolean | True | At the same time, the refund note, refund, and replacement invoice will be returned |
| withCommitTime | N | Boolean | True | The submission time is also returned |
1.3.3. Reponse
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | Error Code |
| errorMsg | Y | String | “The input of Params is incorrect” | Business Error Messages |
| state | Y | String | success | Response State |
| total | Y | Number | 100 | Total num |
| result | Y | List<ReturnOrder> | See ReturnOrder |
ReturnOrder(Refund )
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| returnNumber | Y | String | “B200305115684” | return number |
| createTime | Y | timestamp | 1583410532000 | Timestamp, in milliseconds |
| updateTime | Y | timestamp | 1583410532000 | Timestamp, in milliseconds |
| commitTime | N | timestamp | 1583410532000 | Timestamp, in milliseconds |
| finishTime | N | timestamp | 1583410532000 | Timestamp, in milliseconds |
| orderNumber | N | String | Sales Order number | |
| onlineOrderNumber | N | String | “DA200221115559” | online Order ，ref Order |
| buyerId | N | String | “user123” | Buyer ID |
| warehouse | Y | String | “GWMS” | warehouse |
| status | Y | String | “FINISH” | Refund order status |
| returnSkuList | Y | List<ReturnSku> | See refund SKU | |
| carrier | N | String | carrier | |
| customNumber | N | String | Tracking number | |
| reason | N | String | “Bought the wrong one” | Reason for return |
| shop | N | String | Shop name | |
| currency | N | String | CNY | Monetary unit |
| orderRefundAmount | N | String | Order The total amount refunded for the item | |
| asnNumber | N | String | Inbound order number | |
| asnId | N | String | Inbound order ID | |
| type | Y | String | RETURN（退款单）、SALES_RETURN（Refund ）、RESHIP（补发货单） | |
| refundCustomFieldValueVOList | N | List<SkuCustomFieldValueVO> |
SkuCustomFieldValueVO(Custom fields)
| 参数 | 是否必须 | 类型 | 示例 | 备注 |
|---|---|---|---|---|
| tableName | Y | String | SYS_REFUND | SYS_ITEM: system item custom field; SYS_ORDER: order custom field; SYS_ODO: custom field of the outbound ticket; SYS_ASN: custom field of entry ticket; SYS_REFUND: indicates after-sales management. |
| columType | Y | String | NUMBER | Filters custom fields for different fill types NUMBER: number; DATE: date; STRING: indicates a character string. SELECT: indicates the drop-down box. |
| columName | Y | String | Production date | User-defined field name |
| defaultValue | N | String | "1970/01/01"(unparalleled quotes) | Custom field defaults |
| candidateValue | N | String | ["1970/01/01","1970/01/02"] | The candidate value of the drop-down box |
| remark | N | String | The date of release is different from the date of delivery | remark |
| required | N | Integer | 1 | whether to check only the required columns 1:true;0:false |
| isQuery | N | Integer | 1 | Whether to query only the columns that support query 1:true;0:false |
| isShow | N | Integer | 1 | Whether to query only columns that support column configuration 1:true;0:false |
ReturnSku（refund sku details）
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| sku | Y | String | “abc” | sku |
| orderSkuId | Y | Number | orderSkuId | |
| quantity | Y | Number | 1 | The actual number of returns |
| itemRefundAmount | N | Number | The total amount refunded for the item | |
| selected | Y | Number | 1 | Whether the Refund details are visible on the page, 1: Visible, 0: Invisible |
1.4. Refund process info
1.4.1. SERVICE_TYPE
PUSH_RETURN_ORDER_INFO
1.4.2. request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| returnNumber | Y | String | “B200308115691” | refund order number |
| orderNumber | Y | String | “S200222115613” | sales Order number |
| onlineOrderNumber | Y | String | “DA200221115559” | ref online number |
| status | Y | String | “FINISH” | Refund order status |
| returnSkuList | Y | List<ReturnSku> | See ReturnSKU |
ReturnSku(refund sku details)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| sku | Y | String | “abc” | sku |
| orderSkuId | Y | Number | orderSkuId | |
| quantity | Y | Number | 1 | The actual number of returns |