com.xforceplus.tower.order.api

Interface OrderApi

@Validated
public interface OrderApi

Method Summary

Modifier and Type	Method and Description
BaseResponse<OrderIdsData>	addOrderItems(Long tenantId, @NotNull Long appId, Long id, @Valid AddOrderItem addOrderItem) 对已存在订单新增订单明细
BaseResponse<OrderIdsData>	coverOrder(Long tenantId, @NotNull Long appId, Long id, @Valid @NotNull Order order) 修改订单信息，整个覆盖
BaseResponse<OrderIdsData>	createOrder(Long tenantId, @NotNull Long appId, @Valid @NotNull Order order) 新增订单
BaseResponse<String>	deleteOrder(Long tenantId, @NotNull Long appId, Long id) 删除订单以及明细信息 高
BaseResponse<String>	deleteOrderItem(Long tenantId, @NotNull Long appId, Long id, @Valid DeleteOrderItem deleteOrderItem) 删除订单明细信息 高
BaseResponse<String>	modifyOrder(Long tenantId, @NotNull Long appId, Long id, @Valid @NotNull UpdateOrder updateOrder) 修改订单信息
BaseResponse<QueryOrderResponse>	queryOrder(Long tenantId, @NotNull Long appId, Long id, String relationship) 根据id查询订单
BaseResponse<QueryOrderResponse>	queryOrderByOrderNo(Long tenantId, @NotNull Long appId, LocalDate orderDate, @NotEmpty String orderNo, String relationship)

Method Detail

createOrder

@RequestMapping(value="/{tenantId}/order/v1/orders",
                produces="application/json",
                method=POST)
BaseResponse<OrderIdsData> createOrder(@PathVariable(value="tenantId")
                                                                                                                                                                      Long tenantId,
                                                                                                                                                                      @NotNull @RequestParam(value="appId")
                                                                                                                                                                      @NotNull Long appId,
                                                                                                                                                                      @Valid @NotNull @RequestBody
                                                                                                                                                                      @Valid @NotNull Order order)

新增订单

modifyOrder

@RequestMapping(value="/{tenantId}/order/v1/orders/{id}",
                produces="application/json",
                method=PATCH)
BaseResponse<String> modifyOrder(@PathVariable(value="tenantId")
                                                                                                                                                                      Long tenantId,
                                                                                                                                                                      @NotNull @RequestParam(value="appId")
                                                                                                                                                                      @NotNull Long appId,
                                                                                                                                                                      @PathVariable
                                                                                                                                                                      Long id,
                                                                                                                                                                      @Valid @NotNull @RequestBody
                                                                                                                                                                      @Valid @NotNull UpdateOrder updateOrder)

修改订单信息

addOrderItems

@RequestMapping(value="/{tenantId}/order/v1/orders/{id}/items",
                produces="application/json",
                method=POST)
BaseResponse<OrderIdsData> addOrderItems(@PathVariable(value="tenantId")
                                                                                                                                                                                   Long tenantId,
                                                                                                                                                                                   @NotNull @RequestParam(value="appId")
                                                                                                                                                                                   @NotNull Long appId,
                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                   Long id,
                                                                                                                                                                                   @RequestBody @Valid
                                                                                                                                                                                   @Valid AddOrderItem addOrderItem)

对已存在订单新增订单明细

coverOrder

@RequestMapping(value="/{tenantId}/order/v1/orders/{id}",
                produces="application/json",
                method=PUT)
BaseResponse<OrderIdsData> coverOrder(@PathVariable(value="tenantId")
                                                                                                                                                                         Long tenantId,
                                                                                                                                                                         @NotNull @RequestParam(value="appId")
                                                                                                                                                                         @NotNull Long appId,
                                                                                                                                                                         @PathVariable
                                                                                                                                                                         Long id,
                                                                                                                                                                         @RequestBody @Valid @NotNull
                                                                                                                                                                         @Valid @NotNull Order order)

修改订单信息，整个覆盖

queryOrder

@RequestMapping(value="/{tenantId}/order/v1/orders/{id}",
                produces="application/json",
                method=GET)
BaseResponse<QueryOrderResponse> queryOrder(@PathVariable(value="tenantId")
                                                                                                                                                                               Long tenantId,
                                                                                                                                                                               @NotNull @RequestParam(value="appId")
                                                                                                                                                                               @NotNull Long appId,
                                                                                                                                                                               @PathVariable
                                                                                                                                                                               Long id,
                                                                                                                                                                               @RequestParam(required=false)
                                                                                                                                                                               String relationship)

根据id查询订单

queryOrderByOrderNo

@RequestMapping(value="/{tenantId}/order/v1/orders",
                produces="application/json",
                method=GET)
BaseResponse<QueryOrderResponse> queryOrderByOrderNo(@PathVariable(value="tenantId")
                                                                                                                                                                                   Long tenantId,
                                                                                                                                                                                   @NotNull @RequestParam(value="appId")
                                                                                                                                                                                   @NotNull Long appId,
                                                                                                                                                                                   @RequestParam(required=false) @DateTimeFormat(iso=DATE)
                                                                                                                                                                                   LocalDate orderDate,
                                                                                                                                                                                   @RequestParam @NotEmpty
                                                                                                                                                                                   @NotEmpty String orderNo,
                                                                                                                                                                                   @RequestParam(required=false)
                                                                                                                                                                                   String relationship)

deleteOrder

@RequestMapping(value="/{tenantId}/order/v1/orders/{id}",
                produces="application/json",
                method=DELETE)
BaseResponse<String> deleteOrder(@PathVariable(value="tenantId")
                                                                                                                                                                       Long tenantId,
                                                                                                                                                                       @NotNull @RequestParam(value="appId")
                                                                                                                                                                       @NotNull Long appId,
                                                                                                                                                                       @PathVariable
                                                                                                                                                                       Long id)

删除订单以及明细信息 高

deleteOrderItem

@RequestMapping(value="/{tenantId}/order/v1/orders/{id}/items",
                produces="application/json",
                method=DELETE)
BaseResponse<String> deleteOrderItem(@PathVariable(value="tenantId")
                                                                                                                                                                                 Long tenantId,
                                                                                                                                                                                 @NotNull @RequestParam(value="appId")
                                                                                                                                                                                 @NotNull Long appId,
                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                 Long id,
                                                                                                                                                                                 @RequestBody @Valid
                                                                                                                                                                                 @Valid DeleteOrderItem deleteOrderItem)

删除订单明细信息 高