Browse Source

feat(yqn): 按 API 122 对接取消销售订单

- 路径 /saleorder/OrderCancel → /v1/saleOrder/cancel
- 入参只有 orderNo,没有 acceptCharge / cancelReason
- 响应只有 statusCode/status/code/message,没有 data

运去哪没有取消费概念,也没有取消预判。因此:
- cancel() 只发 orderNo,acceptCharge 在此仓不生效(字段保留给易达云那类
  有收费取消的仓)
- 仓拒绝取消(已拣货/已出库)时业务码非 200,统一映射为
  OutboundCancelBlockedException,而不是笼统的 PlatformBusinessException
- 删掉 toEligibility(),它依赖的 cancelType 字段在文档里不存在

CancelCommand 的注释同步说明 acceptCharge 只对有收费取消的仓有效。

Co-Authored-By: Claude <noreply@anthropic.com>
feature/supplier-lingxing
chenchuchuan 2 weeks ago
parent
commit
f144e26827
  1. 6
      warehouse-sdk-core/src/main/java/common/ecommerce/warehouse/model/CancelCommand.java
  2. 4
      warehouse-sdk-yqn/src/main/java/common/ecommerce/yqn/YqnConstants.java
  3. 55
      warehouse-sdk-yqn/src/main/java/common/ecommerce/yqn/adapter/YqnAdapter.java
  4. 18
      warehouse-sdk-yqn/src/main/java/common/ecommerce/yqn/adapter/YqnOutboundMapper.java
  5. 19
      warehouse-sdk-yqn/src/main/java/common/ecommerce/yqn/dto/YqnDtos.java
  6. 32
      warehouse-sdk-yqn/src/test/java/common/ecommerce/yqn/adapter/YqnAdapterTest.java

6
warehouse-sdk-core/src/main/java/common/ecommerce/warehouse/model/CancelCommand.java

@ -3,9 +3,9 @@ package common.ecommerce.warehouse.model;
/** /**
* 取消命令。 * 取消命令。
* *
* <p>{@link #acceptCharge()} 必须显式传 true 才会执行收费取消; * <p>{@link #acceptCharge()} 只对<b>报了收费取消</b>的仓有效(如易达云):
* 仓返回 {@code CHARGED} 而这里是 false 时抛 * 那类仓返回 {@code CHARGED} 而这里为 false 时抛
* {@code OutboundCancelChargeRequiredException}。</p> * {@code OutboundCancelChargeRequiredException}。运去哪没有取消费概念,该字段被忽略。</p>
*/ */
public final class CancelCommand { public final class CancelCommand {

4
warehouse-sdk-yqn/src/main/java/common/ecommerce/yqn/YqnConstants.java

@ -30,8 +30,8 @@ public final class YqnConstants {
public static final String PATH_ORDER_CREATE = "/v1/saleOrder/create"; public static final String PATH_ORDER_CREATE = "/v1/saleOrder/create";
/** 订单详情(API 128):按来源单号查完整订单。 */ /** 订单详情(API 128):按来源单号查完整订单。 */
public static final String PATH_ORDER_FIND_ONE = "/v1/saleOrder/findOne"; public static final String PATH_ORDER_FIND_ONE = "/v1/saleOrder/findOne";
/** 出库单取消。 */ /** 取消销售订单(API 122)。 */
public static final String PATH_ORDER_CANCEL = "/saleorder/OrderCancel"; public static final String PATH_ORDER_CANCEL = "/v1/saleOrder/cancel";
/** 批量库存查询。 */ /** 批量库存查询。 */
public static final String PATH_INVENTORY_BATCH = "/inventory/BatchQueryInventory"; public static final String PATH_INVENTORY_BATCH = "/inventory/BatchQueryInventory";
/** 库存调拨出库计划。 */ /** 库存调拨出库计划。 */

55
warehouse-sdk-yqn/src/main/java/common/ecommerce/yqn/adapter/YqnAdapter.java

@ -4,6 +4,7 @@ import common.ecommerce.http.HttpRequest;
import common.ecommerce.http.HttpResponse; import common.ecommerce.http.HttpResponse;
import common.ecommerce.http.HttpTransport; import common.ecommerce.http.HttpTransport;
import common.ecommerce.http.JacksonJsonCodec; import common.ecommerce.http.JacksonJsonCodec;
import common.ecommerce.shared.error.PlatformBusinessException;
import common.ecommerce.shared.support.Page; import common.ecommerce.shared.support.Page;
import common.ecommerce.warehouse.WarehouseCapability; import common.ecommerce.warehouse.WarehouseCapability;
import common.ecommerce.warehouse.WarehouseProvider; import common.ecommerce.warehouse.WarehouseProvider;
@ -11,7 +12,6 @@ import common.ecommerce.warehouse.capability.OutboundCapable;
import common.ecommerce.warehouse.capability.WarehouseProduct; import common.ecommerce.warehouse.capability.WarehouseProduct;
import common.ecommerce.warehouse.capability.WarehouseProductCapable; import common.ecommerce.warehouse.capability.WarehouseProductCapable;
import common.ecommerce.warehouse.error.OutboundCancelBlockedException; import common.ecommerce.warehouse.error.OutboundCancelBlockedException;
import common.ecommerce.warehouse.error.OutboundCancelChargeRequiredException;
import common.ecommerce.warehouse.error.WarehouseException; import common.ecommerce.warehouse.error.WarehouseException;
import common.ecommerce.warehouse.model.CancelCommand; import common.ecommerce.warehouse.model.CancelCommand;
import common.ecommerce.warehouse.model.CancelEligibility; import common.ecommerce.warehouse.model.CancelEligibility;
@ -201,45 +201,54 @@ public final class YqnAdapter implements OutboundCapable, WarehouseProductCapabl
} }
} }
/**
* 取消销售订单(API 122)。
*
* <p>运去哪没有收费取消的概念,也没有取消费预判:入参只有 {@code orderNo},
* 响应只有 {@code code/message}。因此 {@link CancelCommand#acceptCharge()} 在这里
* 不生效;仓判定为不可取消(已拣货 / 已出库)时返回非 200 业务码。</p>
*
* <p>「不可取消」按 {@link OutboundCancelBlockedException} 抛出,
* 而不是笼统的业务异常,方便调用方区分「状态不对」与「参数错」。</p>
*/
@Override @Override
public CancelResult cancel(WarehouseContext ctx, CancelCommand cmd) { public CancelResult cancel(WarehouseContext ctx, CancelCommand cmd) {
YqnDtos.CancelOrderRequest body = new YqnDtos.CancelOrderRequest(); YqnDtos.CancelOrderRequest body = new YqnDtos.CancelOrderRequest();
body.orderNo = cmd.providerOrderId(); body.orderNo = orderNoOf(cmd);
body.customerOrderNo = cmd.outboundRequestNo();
body.acceptCharge = cmd.acceptCharge();
body.cancelReason = cmd.reason();
String raw = execute(ctx, YqnConstants.PATH_ORDER_CANCEL, body, "warehouse.outbound.cancel"); String raw;
String cancelType = json.stringAt(raw, "data.cancelType"); try {
CancelEligibility eligibility = YqnOutboundMapper.toEligibility(cancelType); raw = execute(ctx, YqnConstants.PATH_ORDER_CANCEL, body, "warehouse.outbound.cancel");
} catch (PlatformBusinessException e) {
if (eligibility == CancelEligibility.BLOCKED) { // API 122 的失败原因只有 message,无法细分;取消场景统一按「不可取消」表达
throw new OutboundCancelBlockedException(WarehouseException.builder() throw new OutboundCancelBlockedException(WarehouseException.builder()
.message("yqn refused cancellation: " + safeRelay(raw)) .message("yqn refused cancellation: " + e.getMessage())
.operation("warehouse.outbound.cancel") .operation("warehouse.outbound.cancel")
.warehouseCode(ctx.warehouseCode()) .warehouseCode(ctx.warehouseCode())
.provider(provider().name()) .provider(provider().name())
.requestId(ctx.requestId()) .requestId(ctx.requestId())
.rawResponse(safeRelay(raw))); .platformCode(e.platformCode())
} .rawResponse(e.rawResponse())
if (eligibility == CancelEligibility.CHARGED && !cmd.acceptCharge()) { .retryable(false));
throw new OutboundCancelChargeRequiredException(WarehouseException.builder()
.message("yqn cancellation is charged, acceptCharge required")
.operation("warehouse.outbound.cancel")
.warehouseCode(ctx.warehouseCode())
.provider(provider().name())
.requestId(ctx.requestId()),
json.stringAt(raw, "data.cancelFee"), json.stringAt(raw, "data.currency"));
} }
return CancelResult.builder() return CancelResult.builder()
.outboundRequestNo(cmd.outboundRequestNo()) .outboundRequestNo(cmd.outboundRequestNo())
.providerOrderId(cmd.providerOrderId()) .providerOrderId(cmd.providerOrderId())
.eligibility(eligibility) .eligibility(CancelEligibility.FREE)
.cancelled(true) .cancelled(true)
.rawStatus(cancelType) .rawStatus(json.stringAt(raw, "message"))
.build(); .build();
} }
/** 取消命令 → 运去哪订单号:优先来源单号,其次仓单号。 */
private static String orderNoOf(CancelCommand cmd) {
String orderNo = firstNonBlank(cmd.outboundRequestNo(), cmd.providerOrderId());
if (orderNo == null) {
throw new IllegalArgumentException("yqn needs outboundRequestNo to cancel an order");
}
return orderNo;
}
@Override @Override
public List<PackageResult> packages(WarehouseContext ctx, OutboundRef ref) { public List<PackageResult> packages(WarehouseContext ctx, OutboundRef ref) {
YqnDtos.OrderDetail detail = findOne(ctx, orderNoOf(ref), "warehouse.outbound.packages"); YqnDtos.OrderDetail detail = findOne(ctx, orderNoOf(ref), "warehouse.outbound.packages");

18
warehouse-sdk-yqn/src/main/java/common/ecommerce/yqn/adapter/YqnOutboundMapper.java

@ -375,24 +375,6 @@ public final class YqnOutboundMapper {
return OutboundStatus.SUBMITTED; return OutboundStatus.SUBMITTED;
} }
/** 运去哪取消类型 → 统一三态;未知按 BLOCKED,宁可拦住也不误放行。 */
public static CancelEligibility toEligibility(String cancelType) {
if (cancelType == null) {
return CancelEligibility.BLOCKED;
}
String s = cancelType.trim().toUpperCase();
if (s.contains("FREE")) {
return CancelEligibility.FREE;
}
if (s.contains("CHARGE")) {
return CancelEligibility.CHARGED;
}
if (s.contains("BLOCK")) {
return CancelEligibility.BLOCKED;
}
return CancelEligibility.BLOCKED;
}
/** 解析运去哪时间;失败返回 null,不因时间格式阻断业务。 */ /** 解析运去哪时间;失败返回 null,不因时间格式阻断业务。 */
static Instant parseTime(String value, ZoneId zone) { static Instant parseTime(String value, ZoneId zone) {
if (value == null || value.trim().isEmpty()) { if (value == null || value.trim().isEmpty()) {

19
warehouse-sdk-yqn/src/main/java/common/ecommerce/yqn/dto/YqnDtos.java

@ -320,24 +320,13 @@ public final class YqnDtos {
} }
} }
/** 取消请求。 */ /**
* 取消销售订单请求(API 122):只有 {@code orderNo}。
*/
public static final class CancelOrderRequest { public static final class CancelOrderRequest {
/** 订单号,即下单时的来源单号。 */
public String orderNo; public String orderNo;
public String customerOrderNo;
/** 是否接受取消费用。 */
public boolean acceptCharge;
public String cancelReason;
}
/** 取消响应。 */
public static final class CancelOrderResponse {
public String orderNo;
/** FREE / CHARGED / BLOCKED。 */
public String cancelType;
public String cancelFee;
public String currency;
} }
/** /**

32
warehouse-sdk-yqn/src/test/java/common/ecommerce/yqn/adapter/YqnAdapterTest.java

@ -154,22 +154,34 @@ class YqnAdapterTest {
} }
@Test @Test
void cancelChargedWithoutAcceptThrows() { void cancelSendsOnlyOrderNoAndSucceeds() {
RecordingTransport transport = RecordingTransport.create() RecordingTransport transport = RecordingTransport.create()
.route(YqnConstants.PATH_ORDER_CANCEL, req -> Responses.ok( .route(YqnConstants.PATH_ORDER_CANCEL, req -> Responses.ok(
"{\"statusCode\":200,\"status\":0,\"code\":200,\"data\":{\"cancelType\":\"CHARGED\"," "{\"statusCode\":200,\"status\":0,\"code\":\"200\",\"message\":\"取消成功\"}"));
+ "\"cancelFee\":\"5.00\",\"currency\":\"USD\"}}"));
YqnAdapter adapter = new YqnAdapter(transport, new JacksonJsonCodec()); YqnAdapter adapter = new YqnAdapter(transport, new JacksonJsonCodec());
common.ecommerce.warehouse.model.CancelCommand cmd = common.ecommerce.warehouse.model.CancelResult result =
common.ecommerce.warehouse.model.CancelCommand.builder() adapter.cancel(ctx(), common.ecommerce.warehouse.model.CancelCommand.builder()
.outboundRequestNo("OB-5").acceptCharge(false).build(); .outboundRequestNo("OB-5").acceptCharge(true).build());
common.ecommerce.warehouse.error.OutboundCancelChargeRequiredException ex = assertTrue(result.cancelled());
assertEquals(CancelEligibility.FREE, result.eligibility());
assertEquals("{\"orderNo\":\"OB-5\"}", transport.lastDataRequest().body());
}
@Test
void cancelRefusedBecomesBlocked() {
RecordingTransport transport = RecordingTransport.create()
.route(YqnConstants.PATH_ORDER_CANCEL, req -> Responses.ok(
"{\"statusCode\":200,\"status\":0,\"code\":\"500\",\"message\":\"订单已出库不可取消\"}"));
YqnAdapter adapter = new YqnAdapter(transport, new JacksonJsonCodec());
common.ecommerce.warehouse.error.OutboundCancelBlockedException ex =
org.junit.jupiter.api.Assertions.assertThrows( org.junit.jupiter.api.Assertions.assertThrows(
common.ecommerce.warehouse.error.OutboundCancelChargeRequiredException.class, common.ecommerce.warehouse.error.OutboundCancelBlockedException.class,
() -> adapter.cancel(ctx(), cmd)); () -> adapter.cancel(ctx(), common.ecommerce.warehouse.model.CancelCommand.builder()
assertEquals("5.00", ex.cancelFee()); .outboundRequestNo("OB-5").build()));
assertTrue(ex.getMessage().contains("不可取消"), ex.getMessage());
} }
@Test @Test

Loading…
Cancel
Save