1. 退货单模块API

API URL

post {HTTP(S)地址}/api/{version}/returnOrder

1.1. 退货单创建接口

1.1.1. SERVICE_TYPE

CREATE_RETURN_ORDER

1.1.2. 请求参数

ReturnSku(退货SKU)

SkuCustomFieldValueVO(自定义栏位)

1.1.3. 返回参数

请求示例:

curl --location --request POST 'https://gerp-test1.800best.com/api/v1/returnOrder' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--form 'appId="TEST"' \
--form 'serviceType="CREATE_RETURN_ORDER"' \
--form 'bizParam="{
\"warehouse\":\"best warehouse（测试用）\",
\"shop\":\"测试1\",
\"returnSkuList\":[{
\"sku\":\"DP001\",
\"quantity\":1
}]
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="776505df88f4dd3cd6a4d76db75a9103"'

返回示例:

{
    "state": "success",
    "errorCode": "",
    "errorMsg": "",
    "bizContent": "{\"notSuccess\":false,\"result\":{\"createTime\":1757644953059,\"returnNumber\":\"B250912149639\",\"returnSkuList\":[{\"quantity\":1,\"selected\":1,\"sku\":\"DP001\"}],\"shop\":\"测试1\",\"status\":\"NEW\",\"type\":\"SALES_RETURN\",\"warehouse\":\"best warehouse（测试用）\",\"withoutType\":false},\"state\":\"success\"}",
    "requestId": "0b529993-a579-40ec-b6da-14c28a88b172"
}

1.2. 退货单关闭接口

1.2.1. SERVICE_TYPE

CLOSE_RETURN_ORDER

1.2.2. 请求参数

1.2.3. 返回参数

请求示例:

curl --location --request POST 'https://gerp-test1.800best.com/api/v1/returnOrder' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--form 'appId="TEST"' \
--form 'serviceType="CLOSE_RETURN_ORDER"' \
--form 'bizParam="{
\"returnNumber\":\"B250912149639\"
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="6e7c8da4cb35bf496f607745c3accd15"'

返回示例:

{
    "state": "success",
    "errorCode": "",
    "errorMsg": "",
    "bizContent": "{\"notSuccess\":false,\"state\":\"success\"}",
    "requestId": "2ffaa7df-073b-4e74-8aaa-02bf1bd45e18"
}

1.3. 退货单查询接口

1.3.1. SERVICE_TYPE

QUERY_RETURN_ORDER_LIST

1.3.2. 请求参数

1.3.3. 返回参数

ReturnOrder(退货单)

SkuCustomFieldValueVO(自定义栏位信息)

ReturnSku（退货SKU）

LocAndQuantity（returnSku关联入库单明细的收货信息）

请求示例:

curl --location --request POST 'https://gerp-test1.800best.com/api/v1/returnOrder' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_RETURN_ORDER_LIST"' \
--form 'bizParam="{
\"page\":1,
\"pageSize\":2
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="9b108435872826df205820d32e296be4"'

返回示例:

{
    "state": "success",
    "errorCode": "",
    "errorMsg": "",
    "bizContent": "{\"notSuccess\":false,\"result\":[{\"createTime\":1757642599000,\"isDeleted\":0,\"orderRefundAmount\":0,\"reason\":\"退款测试\",\"refundCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":5,\"columName\":\"网上订单号\",\"columType\":\"STRING\",\"customFieldId\":43,\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":43,\"isQuery\":1,\"isShow\":1,\"required\":1,\"value\":\"1234\"}],\"remark\":\"破损退货\",\"returnNumber\":\"B250912149637\",\"returnSkuList\":[{\"isDeleted\":0,\"itemRefundAmount\":0,\"quantity\":1,\"remark\":\"破损退货\",\"selected\":1,\"sku\":\"hmsku090901-1\",\"storageLocationCode\":\"SYS LOC\"}],\"shop\":\"shopee111PH\",\"status\":\"WAIT_STORAGE\",\"type\":\"SALES_RETURN\",\"updateTime\":1757642613000,\"warehouse\":\"best warehouse（测试用）\",\"warehouseEntryID\":46060,\"warehouseEntryNumber\":\"A250912149638\",\"withoutType\":false},{\"buyerId\":\"408\",\"carrier\":\"jt\",\"createTime\":1755853887000,\"currency\":\"VND\",\"customNumber\":\"801100620944\",\"finishTime\":1755854697000,\"isDeleted\":0,\"onlineOrderNumber\":\"2508071639020252990324083\",\"orderNumber\":\"S250807148097\",\"orderRefundAmount\":0,\"reason\":\"与商家协商一致\",\"refundCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":5,\"columName\":\"网上订单号\",\"columType\":\"STRING\",\"customFieldId\":43,\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":43,\"isQuery\":1,\"isShow\":1,\"required\":1}],\"remark\":\"\",\"returnNumber\":\"B250822148831\",\"returnSkuList\":[{\"badQuantity\":0,\"goodQuantity\":3,\"isDeleted\":0,\"itemRefundAmount\":0,\"locAndQuantityList\":[{\"receiveQuantity\":3,\"storageLocationCode\":\"SYS LOC\"}],\"orderSkuId\":92169604,\"quantity\":3,\"selected\":1,\"sku\":\"110015015005\",\"storageLocationCode\":\"SYS LOC\"},{\"badQuantity\":0,\"goodQuantity\":6,\"isDeleted\":0,\"itemRefundAmount\":0,\"locAndQuantityList\":[{\"receiveQuantity\":6,\"storageLocationCode\":\"SYS LOC\"}],\"orderSkuId\":92169605,\"quantity\":6,\"selected\":1,\"sku\":\"110015019002\",\"storageLocationCode\":\"SYS LOC\"}],\"shop\":\"Solaso-ERP\",\"status\":\"FINISH\",\"type\":\"SALES_RETURN\",\"updateTime\":1755854697000,\"warehouse\":\"solaso-huzhiming\",\"warehouseEntryID\":45838,\"warehouseEntryNumber\":\"A250822148832\",\"withoutType\":false}],\"state\":\"success\",\"total\":1089}",
    "requestId": "dda0be94-be73-4f20-b0d2-4c3fc414b3fb"
}

1.4. 退货单完成信息推送接口

1.4.1. SERVICE_TYPE

PUSH_RETURN_ORDER_INFO

1.4.2. 推送消息内容

ReturnSku(退货SKU)

JSON type：
{"serviceType":"PUSH_RETURN_ORDER_INFO","appId":"15167732016","sign":"b55826f1b417bd398aacf61aaa8abe23","bizParam":"{\"orderNumber\":\"THTZD000859\",\"returnSkuList\":[{\"orderSkuId\":45,\"quantity\":1,\"sku\":\"JCDF692024YH002\"}],\"onlineOrderNumber\":\"THTZD000859\",\"returnNumber\":\"B250801537077\",\"status\":\"WAIT_STORAGE\"}","timestamp":"1754033260116"}


FORM-DATA type：
{serviceType=PUSH_RETURN_ORDER_INFO,appId=15167732016,sign=b55826f1b417bd398aacf61aaa8abe23,bizParam={\"orderNumber\":\"THTZD000859\",\"returnSkuList\":[{\"orderSkuId\":45,\"quantity\":1,\"sku\":\"JCDF692024YH002\"}],\"onlineOrderNumber\":\"THTZD000859\",\"returnNumber\":\"B250801537077\",\"status\":\"WAIT_STORAGE\"},timestamp=1754033260116}