Open-Agent-Api
  1. 订单
Open-Agent-Api
  • 授权
    • 获取AccessToken
      POST
    • 刷新AccessToken
      POST
  • 商品
    • 4.10 获取商品是否可售
      GET
    • 4.1 获取商品标识列表
      GET
    • 4.2 获取商品信息
      GET
    • 4.3 获取商品详情
      GET
    • 4.4 获取商品图片
      GET
    • 4.5 获取商品上下架状态
      GET
    • 4.6 商品可售区域查询
      GET
    • 4.7 获取商品可配送区域
      GET
    • 4.8 商品可选配送时间查询
      GET
    • 4.9 商品附属信息查询
      GET
  • 地址
    • 5.1 获取省市区列表
      GET
  • 价格
    • 6.1 获取商品价格
      GET
  • 库存
    • 7.1 获取商品库存
      GET
  • 订单
    • 8.1 订单创建
      POST
    • 8.2 订单确认
      POST
    • 8.3 取消订单
      POST
    • 8.4 订单查询
      GET
    • 8.5 出库单查询
      GET
    • 8.6 包裹单查询
      GET
  • 售后
    • 9.1 售后单申请
      POST
    • 9.2 获取可申请售后商品
      GET
    • 9.3 获取售后单
      GET
    • 9.4 获取出库单所属售后单列表
      GET
    • 9.5 取消售后单
      POST
    • 9.6 获取售后包裹单明细
      GET
  • 物流
    • 10.2 获取运费规则
    • 10.1 获取物流日志
  • 发票
    • 12.1 发票申请
    • 12.2 发票查询
  • 类目
    • 13.1 获取大类列表
    • 13.2 获取中类列表
    • 13.3 获取小类列表
  • 员工
    • 1.1 创建用户
    • 1.3 处理用户变更
  • 数据模型
    • Schemas
      • Benlai.Open.Models.AfterSale.CreateProductInfo
      • Benlai.Open.Models.Area.AreaModel
      • Benlai.Open.Models.AfterSale.CreateInfo
      • Benlai.Open.Models.AfterSale.CreateResult
      • Benlai.Open.Models.AfterSale.AvailableProductResult
      • Benlai.Open.Models.AfterSale.AvailableResult
      • Benlai.Open.Models.AfterSale.GetListProductDetailResult
      • Benlai.Open.Models.AfterSale.GetListRMAResult
      • Benlai.Open.Models.AfterSale.GetListResult
      • Benlai.Open.Models.AfterSale.GetRMAProductDetailResult
      • Benlai.Open.Models.AfterSale.GetRMAResult
      • Benlai.Open.Models.AfterSale.CancelInfo
      • Benlai.Open.Models.AfterSale.CancelResult
      • Benlai.Open.Models.Wms.PackageListDto
      • Benlai.Open.Models.Wms.RMAPackageDetailDto
      • Benlai.Open.Models.Area.AreaResult
      • Benlai.Open.Models.Product.categoryInfo
      • Benlai.Open.Models.Product.categoryResult
      • Benlai.Open.Models.Product.CategoryInfo
      • Benlai.Open.Models.Employee.Request.EmployeeCreateInput
      • Benlai.Open.Models.Product.CategoryResult
      • Benlai.Open.Models.Employee.Response.EmployeeCreateResponse
      • Benlai.Open.Models.Employee.Base.EmployeeInfo
      • Benlai.Open.Models.Employee.Request.EmployeeChangedInput
      • Benlai.Open.Models.Employee.Response.EmployeeChangeResponse
      • Benlai.Open.Models.Invoice.BillInfo
      • Benlai.Open.Models.Invoice.InvoiceCreateInfo
      • Benlai.Open.Models.Invoice.InvoiceCreateResult
      • Benlai.Open.Models.Invoice.InvoiceDto
      • Benlai.Open.Models.Invoice.InvoiceGetResult
      • Benlai.Open.Models.Inventory.SOInvoiceByEpecCreateReq
      • Benlai.Open.Models.Inventory.CreateByEpecResult
      • Benlai.Open.Models.Inventory.SOInvoiceByEpecGetInfo
      • Benlai.Open.Models.Wms.logisticsDetailResponse
      • Benlai.Open.Models.Wms.logisticsResponse
      • Benlai.Open.Models.Wms.DoLogListResponse
      • Benlai.Open.Models.Freight.FreightResult
      • Benlai.Open.Services.Model.CreateItemInfo
      • Benlai.Open.Services.Model.CreateInvoiceInfo
      • Benlai.Open.Services.Model.CreateInfo
      • Benlai.Open.Services.Model.CreateResult
      • Benlai.Open.Models.Order.ConfirmInfo
      • Benlai.Open.Models.Order.ConfirmResult
      • Benlai.Open.Models.Order.cancelInfo
      • Benlai.Open.Models.Order.cancelResult
      • Benlai.Open.Models.Order.orderDetailModel
      • Benlai.Open.Models.Order.orderInvoiceModel
      • Benlai.Open.Models.Order.QueryResult
      • Benlai.Open.Models.Order.DODetailDto
      • Benlai.Open.Models.Order.QueryDOResult
      • Benlai.Open.Models.Wms.ProductDetail
      • Benlai.Open.Models.Wms.PackageInfoRes
      • Benlai.Open.Models.Product.IdsResult
      • Benlai.Open.Models.Order.BoxProductDetailDto
      • Benlai.Open.Models.Product.ProductDeliveryAreaModel
      • Benlai.Open.Models.Order.QueryBoxResponse
      • Benlai.Open.Models.Product.ProductInfo
      • Benlai.Open.Models.Product.ProductResult
      • Benlai.Open.Models.Product.ProductImageDto
      • Benlai.Open.Models.Product.ProductImageResult
      • Benlai.Open.Models.Product.DetailItemResult
      • Benlai.Open.Models.Product.DetailStepResult
      • Benlai.Open.Models.Product.ProductDetailResult
      • Benlai.Open.Models.Product.ReportImageDto
      • Benlai.Open.Models.Product.ImageModuleDto
      • Benlai.Open.Models.Product.ProductExtraResult
      • Benlai.Open.Models.Inventory.InventoryDto
      • Benlai.Open.Models.Inventory.InventoryResult
      • Benlai.Open.Models.Product.poductupdownstatusDto
      • Benlai.Open.Models.Product.updownstatusResult
      • Benlai.Open.Models.Product.SaleAreaDto
      • Benlai.Open.Models.Product.checkareaResult
      • Benlai.Open.Models.Product.ProductPriceDto
      • Benlai.Open.Models.Product.getPriceResult
      • Benlai.Open.Models.Product.deliveryAreaResult
      • Benlai.Open.Models.Product.DeliveryDateDto
      • Benlai.Open.Models.Product.DeliveryDateResult
  1. 订单

8.3 取消订单

POST
/api/v2/Order/cancel
取消订单, 支持订单状态在待出库前取消

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Header 参数

Body 参数application/json

示例
{
    "out_trade_no": "OT177886655443399544"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open-agent-branch.benlai.com/api/v2/Order/cancel' \
--header 'channel: benlai' \
--header 'shopId: 123' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "out_trade_no": "OT177886655443399544"
}'

返回响应

🟢200成功
text/plain
Success
Body

示例
{
    "code": 0,
    "msg": "success",
    "value": {
        "isClose": true
    }
}
修改于 2025-04-29 01:26:28
上一页
8.2 订单确认
下一页
8.4 订单查询
Built with