openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/alibaba/trade/get/buyerView:
post:
summary: 查询订单详情
deprecated: false
description: 获取单个交易明细信息,仅限买家调用。
tags:
- 接口说明/1688 API/1688 订单管理
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
appKey:
type: string
description: 大吉平台appKey
appSecret:
type: string
description: 秘钥,仅调试使用,正式用sign签名
webSite:
type: string
description: 站点信息 1688
orderId:
type: bigint
description: 交易的订单ID
required:
- appKey
- appSecret
- webSite
- orderId
x-apifox-orders:
- appKey
- appSecret
- webSite
- orderId
example:
appKey: ''
appSecret: ''
webSite: '1688'
orderId: '2257164624870311973'
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: 返回码
message:
type: string
description: 消息
data:
type: object
properties:
guaranteesTerms:
type: object
properties:
assuranceInfo:
type: string
description: 保障条款
assuranceType:
type: string
description: 保障方式。国际站:TA(信保)
qualityAssuranceType:
type: string
description: 质量保证类型。国际站:pre_shipment(发货前),post_delivery(发货后)
required:
- assuranceInfo
- assuranceType
- qualityAssuranceType
x-apifox-orders:
- assuranceInfo
- assuranceType
- qualityAssuranceType
description: 保障条款
internationalLogistics:
type: 'null'
nativeLogistics:
type: object
properties:
address:
type: string
description: 详细地址
area:
type: string
description: 县,区
areaCode:
type: string
description: 省市区编码
city:
type: string
description: 城市
contactPerson:
type: string
description: 联系人姓名
fax:
type: 'null'
description: 传真
mobile:
type: string
description: 手机
province:
type: string
description: 省份
telephone:
type: string
description: 电话
zip:
type: string
description: 邮编
logisticsItems:
type: 'null'
description: 运单明细
townCode:
type: 'null'
description: 镇,街道地址码
town:
type: string
description: 镇,街道
caid:
type: 'null'
realLogisticsCompanyNo:
type: 'null'
required:
- address
- area
- areaCode
- city
- contactPerson
- fax
- mobile
- province
- telephone
- zip
- logisticsItems
- townCode
- town
- caid
- realLogisticsCompanyNo
x-apifox-orders:
- address
- area
- areaCode
- city
- contactPerson
- fax
- mobile
- province
- telephone
- zip
- logisticsItems
- townCode
- town
- caid
- realLogisticsCompanyNo
description: 中国收货信息
productItems:
type: array
items:
type: object
properties:
cargoNumber:
type: string
description: >-
指定单品货号,国际站无需关注。该字段不一定有值,仅仅在下单时才会把货号记录(如果卖家设置了单品货号的话)。别的订单类型的货号只能通过商品接口去获取。请注意:通过商品接口获取时的货号和下单时的货号可能不一致,因为下单完成后卖家可能修改商品信息,改变了货号。
description:
type: 'null'
description: 描述,1688无此信息
itemAmount:
type: number
description: 实付金额(单位为元)
name:
type: string
description: 商品名称
price:
type: number
description: 原始单价(单位为元)
productID:
type: integer
description: 产品ID
productImgUrl:
type: array
items:
type: string
description: 商品图片URL
productSnapshotUrl:
type: string
description: 产品快照url,交易订单产生时会自动记录下当时的商品快照,供后续纠纷时参考
quantity:
type: integer
description: 以unit为单位的数量,例如多少个、多少件、多少箱、多少吨
refund:
type: integer
description: 退款金额(单位为元)
skuID:
type: integer
description: 商品规格ID
sort:
type: 'null'
description: 排序字段,商品列表按此字段进行排序,从0开始,1688不提供
status:
type: string
description: 子订单状态
subItemID:
type: bigint
description: 子订单号,或商品明细条目ID
type:
type: string
description: 类型,国际站使用,供卖家标注商品所属类型
unit:
type: string
description: 售卖单位 例如:个、件、箱、吨
weight:
type: 'null'
description: 重量,按重量单位计算的重量,例如:100
weightUnit:
type: 'null'
description: 重量单位 例如:g,kg,t
guaranteesTerms:
type: array
items:
type: object
properties:
assuranceInfo:
type: string
description: 保障条款
assuranceType:
type: string
description: 保障方式,国际站:TA(信保)
qualityAssuranceType:
type: string
description: >-
质量保证类型,国际站:pre_shipment(发货前),post_delivery(发货后)
required:
- assuranceInfo
- assuranceType
- qualityAssuranceType
x-apifox-orders:
- assuranceInfo
- assuranceType
- qualityAssuranceType
description: 保障条款,此字段仅针对1688
productCargoNumber:
type: string
description: "指定商品货号,该字段不一定有值,在下单时才会把货号记录。别的订单类型的货号只能通过商品接口去获取。请注意:通过商品接口获取时的货号和下单时的货号可能不一致,因为下单完成后卖家可能修改商品信息,改变了货号。该字段和cargoNUmber的区别是:该字段是定义在商品级别上的货号,cargoNUmber是定义在单品级别的货号\t"
skuInfos:
type: array
items:
type: object
properties:
name:
type: string
description: 属性名
value:
type: string
description: 属性值
required:
- name
- value
x-apifox-orders:
- name
- value
entryDiscount:
type: integer
description: 订单明细涨价或降价的金额
specId:
type: string
description: 订单销售属性ID
quantityFactor:
type: integer
description: >-
以unit为单位的quantity精度系数,值为10的幂次,例如:quantityFactor=1000,unit=吨,那么quantity的最小精度为0.001吨
statusStr:
type: string
description: 子订单状态描述
refundStatus:
type: 'null'
description: >-
WAIT_SELLER_AGREE 等待卖家同意 REFUND_SUCCESS 退款成功
REFUND_CLOSED 退款关闭 WAIT_BUYER_MODIFY 待买家修改
WAIT_BUYER_SEND 等待买家退货 WAIT_SELLER_RECEIVE
等待卖家确认收货
closeReason:
type: string
description: 关闭原因
logisticsStatus:
type: integer
description: 1 未发货 2 已发货 3 已收货 4 已经退货 5 部分发货 8 还未创建物流订单
gmtCreate:
type: string
description: 创建时间
gmtModified:
type: string
description: 修改时间
gmtCompleted:
type: string
description: 明细完成时间
gmtPayExpireTime:
type: 'null'
description: 库存超时时间,格式为“yyyy-MM-dd HH:mm:ss”
refundId:
type: 'null'
description: 售中退款单号
subItemIDString:
type: string
description: >-
子订单号,或商品明细条目ID(字符串类型,由于Long类型的ID可能在JS和PHP中处理有问题,所以可以用字符串类型来处理)
refundIdForAs:
type: 'null'
description: 售后退款单号
erpMaterialCode:
type: 'null'
itemDiscountFee:
type: 'null'
cantSendReason:
type: 'null'
canSendGoods:
type: 'null'
barCode:
type: 'null'
permitLogisticsCpCode:
type: 'null'
deliverGoodsOverdueRisk:
type: 'null'
relatedCode:
type: 'null'
freeEntryServiceInfo:
type: 'null'
payEntryServiceInfo:
type: 'null'
x-apifox-orders:
- cargoNumber
- description
- itemAmount
- name
- price
- productID
- productImgUrl
- productSnapshotUrl
- quantity
- refund
- skuID
- sort
- status
- subItemID
- type
- unit
- weight
- weightUnit
- guaranteesTerms
- productCargoNumber
- skuInfos
- entryDiscount
- specId
- quantityFactor
- statusStr
- refundStatus
- closeReason
- logisticsStatus
- gmtCreate
- gmtModified
- gmtCompleted
- gmtPayExpireTime
- refundId
- subItemIDString
- refundIdForAs
- erpMaterialCode
- itemDiscountFee
- cantSendReason
- canSendGoods
- barCode
- permitLogisticsCpCode
- deliverGoodsOverdueRisk
- relatedCode
- freeEntryServiceInfo
- payEntryServiceInfo
description: 商品条目信息
tradeTerms:
type: array
items:
type: string
description: 交易条款
extAttributes:
type: array
items:
type: string
description: 订单扩展属性
orderRateInfo:
type: object
properties:
buyerRateStatus:
type: integer
description: 买家评价状态(4:已评论,5:未评论,6;不需要评论)
sellerRateStatus:
type: integer
description: 卖家评价状态(4:已评论,5:未评论,6;不需要评论)
buyerRateList:
type: 'null'
description: 卖家給买家的评价
sellerRateList:
type: 'null'
description: 买家給卖家的评价
required:
- buyerRateStatus
- sellerRateStatus
- buyerRateList
- sellerRateList
x-apifox-orders:
- buyerRateStatus
- sellerRateStatus
- buyerRateList
- sellerRateList
description: 订单评价信息
orderInvoiceInfo:
type: 'null'
description: 发票信息
customs:
type: 'null'
description: 跨境报关信息
overseasExtraAddress:
type: 'null'
description: 跨境地址扩展信息
baseInfo:
type: object
properties:
allDeliveredTime:
type: 'null'
businessType:
type: string
buyerID:
type: string
buyerMemo:
type: 'null'
completeTime:
type: string
createTime:
type: string
currency:
type: 'null'
id:
type: bigint
modifyTime:
type: string
payTime:
type: 'null'
receivingTime:
type: 'null'
refund:
type: integer
remark:
type: string
sellerID:
type: string
sellerMemo:
type: 'null'
shippingFee:
type: number
status:
type: string
totalAmount:
type: number
buyerRemarkIcon:
type: 'null'
sellerRemarkIcon:
type: 'null'
discount:
type: integer
buyerContact:
type: object
properties:
phone:
type: string
fax:
type: 'null'
email:
type: 'null'
imInPlatform:
type: string
name:
type: 'null'
mobile:
type: 'null'
companyName:
type: 'null'
required:
- phone
- fax
- email
- imInPlatform
- name
- mobile
- companyName
x-apifox-orders:
- phone
- fax
- email
- imInPlatform
- name
- mobile
- companyName
tradeType:
type: string
refundStatus:
type: 'null'
refundStatusForAs:
type: 'null'
refundPayment:
type: integer
idOfStr:
type: string
alipayTradeId:
type: string
receiverInfo:
type: object
properties:
toFullName:
type: string
toDivisionCode:
type: string
toMobile:
type: string
toPhone:
type: string
toPost:
type: string
toTownCode:
type: 'null'
toArea:
type: string
required:
- toFullName
- toDivisionCode
- toMobile
- toPhone
- toPost
- toTownCode
- toArea
x-apifox-orders:
- toFullName
- toDivisionCode
- toMobile
- toPhone
- toPost
- toTownCode
- toArea
buyerLoginId:
type: string
sellerLoginId:
type: string
buyerUserId:
type: 'null'
sellerUserId:
type: 'null'
buyerAlipayId:
type: 'null'
sellerAlipayId:
type: 'null'
confirmedTime:
type: 'null'
closeReason:
type: string
sumProductPayment:
type: number
stepOrderList:
type: 'null'
stepAgreementPath:
type: 'null'
stepPayAll:
type: boolean
buyerFeedback:
type: string
overSeaOrder:
type: boolean
subBuyerLoginId:
type: 'null'
sellerOrder:
type: boolean
preOrderId:
type: 'null'
refundId:
type: 'null'
flowTemplateCode:
type: string
buyerLevel:
type: 'null'
sellerCreditLevel:
type: 'null'
sellerContact:
type: object
properties:
phone:
type: string
fax:
type: 'null'
email:
type: 'null'
imInPlatform:
type: string
name:
type: string
mobile:
type: string
companyName:
type: string
wgSenderName:
type: 'null'
wgSenderPhone:
type: 'null'
required:
- phone
- fax
- email
- imInPlatform
- name
- mobile
- companyName
- wgSenderName
- wgSenderPhone
x-apifox-orders:
- phone
- fax
- email
- imInPlatform
- name
- mobile
- companyName
- wgSenderName
- wgSenderPhone
newStepOrderList:
type: 'null'
closeRemark:
type: string
closeOperateType:
type: string
couponFee:
type: integer
tradeTypeDesc:
type: string
payChannelList:
type: array
items:
type: string
tradeTypeCode:
type: string
payTimeout:
type: integer
payTimeoutType:
type: integer
payChannelCodeList:
type: array
items:
type: string
ccid:
type: 'null'
relatedCode:
type: 'null'
buyerOpenUid:
type: 'null'
buyerSubOpenUid:
type: 'null'
required:
- allDeliveredTime
- businessType
- buyerID
- buyerMemo
- completeTime
- createTime
- currency
- id
- modifyTime
- payTime
- receivingTime
- refund
- remark
- sellerID
- sellerMemo
- shippingFee
- status
- totalAmount
- buyerRemarkIcon
- sellerRemarkIcon
- discount
- buyerContact
- tradeType
- refundStatus
- refundStatusForAs
- refundPayment
- idOfStr
- alipayTradeId
- receiverInfo
- buyerLoginId
- sellerLoginId
- buyerUserId
- sellerUserId
- buyerAlipayId
- sellerAlipayId
- confirmedTime
- closeReason
- sumProductPayment
- stepOrderList
- stepAgreementPath
- stepPayAll
- buyerFeedback
- overSeaOrder
- subBuyerLoginId
- sellerOrder
- preOrderId
- refundId
- flowTemplateCode
- buyerLevel
- sellerCreditLevel
- sellerContact
- newStepOrderList
- closeRemark
- closeOperateType
- couponFee
- tradeTypeDesc
- payChannelList
- tradeTypeCode
- payTimeout
- payTimeoutType
- payChannelCodeList
- ccid
- relatedCode
- buyerOpenUid
- buyerSubOpenUid
x-apifox-orders:
- allDeliveredTime
- businessType
- buyerID
- buyerMemo
- completeTime
- createTime
- currency
- id
- modifyTime
- payTime
- receivingTime
- refund
- remark
- sellerID
- sellerMemo
- shippingFee
- status
- totalAmount
- buyerRemarkIcon
- sellerRemarkIcon
- discount
- buyerContact
- tradeType
- refundStatus
- refundStatusForAs
- refundPayment
- idOfStr
- alipayTradeId
- receiverInfo
- buyerLoginId
- sellerLoginId
- buyerUserId
- sellerUserId
- buyerAlipayId
- sellerAlipayId
- confirmedTime
- closeReason
- sumProductPayment
- stepOrderList
- stepAgreementPath
- stepPayAll
- buyerFeedback
- overSeaOrder
- subBuyerLoginId
- sellerOrder
- preOrderId
- refundId
- flowTemplateCode
- buyerLevel
- sellerCreditLevel
- sellerContact
- newStepOrderList
- closeRemark
- closeOperateType
- couponFee
- tradeTypeDesc
- payChannelList
- tradeTypeCode
- payTimeout
- payTimeoutType
- payChannelCodeList
- ccid
- relatedCode
- buyerOpenUid
- buyerSubOpenUid
description: 订单基础信息
orderBizInfo:
type: object
properties:
odsCyd:
type: boolean
accountPeriodTime:
type: 'null'
creditOrder:
type: boolean
creditOrderDetail:
type: 'null'
preOrderInfo:
type: 'null'
lstOrderInfo:
type: 'null'
erpBuyerUserId:
type: 'null'
erpOrderId:
type: 'null'
erpBuyerOrgId:
type: 'null'
isCz:
type: 'null'
isDz:
type: 'null'
dz:
type: 'null'
required:
- odsCyd
- accountPeriodTime
- creditOrder
- creditOrderDetail
- preOrderInfo
- lstOrderInfo
- erpBuyerUserId
- erpOrderId
- erpBuyerOrgId
- isCz
- isDz
- dz
x-apifox-orders:
- odsCyd
- accountPeriodTime
- creditOrder
- creditOrderDetail
- preOrderInfo
- lstOrderInfo
- erpBuyerUserId
- erpOrderId
- erpBuyerOrgId
- isCz
- isDz
- dz
description: 订单业务信息
quoteList:
type: 'null'
description: 采购单详情列表,为大企业采购订单独有域。
fromEncryptOrder:
type: 'null'
description: 是否下游脱敏信息创建的订单
encryptOutOrderInfo:
type: 'null'
description: 外部订单信息
outChannel:
type: 'null'
sendGoodsOverdueRisk:
type: 'null'
officialLogisticOrder:
type: 'null'
required:
- guaranteesTerms
- internationalLogistics
- nativeLogistics
- productItems
- tradeTerms
- extAttributes
- orderRateInfo
- orderInvoiceInfo
- customs
- overseasExtraAddress
- baseInfo
- orderBizInfo
- quoteList
- fromEncryptOrder
- encryptOutOrderInfo
- outChannel
- sendGoodsOverdueRisk
- officialLogisticOrder
x-apifox-orders:
- guaranteesTerms
- internationalLogistics
- nativeLogistics
- productItems
- tradeTerms
- extAttributes
- orderRateInfo
- orderInvoiceInfo
- customs
- overseasExtraAddress
- baseInfo
- orderBizInfo
- quoteList
- fromEncryptOrder
- encryptOutOrderInfo
- outChannel
- sendGoodsOverdueRisk
- officialLogisticOrder
description: 业务数据
timestamp:
type: integer
description: 时间戳
traceId:
type: string
description: traceId
required:
- code
- message
- data
- timestamp
- traceId
x-apifox-orders:
- code
- message
- data
- timestamp
- traceId
example:
code: 200
message: 操作成功
data:
guaranteesTerms:
assuranceInfo: 卖家承诺买家签收货物后7天内,在“商品完好”的情形下,向买家提供退货服务。
assuranceType: qtwlybt
qualityAssuranceType: 7天无理由退货
internationalLogistics: null
nativeLogistics:
address: 网商路699号
area: 普陀区
areaCode: '310107'
city: 上海市
contactPerson: 张三
fax: null
mobile: '18888888888'
province: 上海
telephone: '18888888888'
zip: '000000'
logisticsItems: null
townCode: null
town: 长河镇
caid: null
realLogisticsCompanyNo: null
productItems:
- cargoNumber: null
description: null
itemAmount: 8.96
name: 绘图画画考试2B铅笔小学生学习写字无铅毒铅笔不易断素描套装铅笔
price: 1.8
productID: 623686863670
productImgUrl:
- >-
http://cbu01.alicdn.com/img/ibank/O1CN01s3tVTC1Bs2xBEEkxv_!!0-0-cib.80x80.jpg
- >-
http://cbu01.alicdn.com/img/ibank/O1CN01s3tVTC1Bs2xBEEkxv_!!0-0-cib.jpg
productSnapshotUrl: >-
https://trade.1688.com/order/offer_snapshot.htm?order_entry_id=2257164624870311973
quantity: 5
refund: 0
skuID: 5403412737023
sort: null
status: cancel
subItemID: 2257164624870312000
type: common
unit: 盒
weight: null
weightUnit: null
guaranteesTerms:
- assuranceInfo: 卖家承诺买家签收货物后7天内,在“商品完好”的情形下,向买家提供退货服务。
assuranceType: qtwlybt
qualityAssuranceType: 7天无理由退货
- assuranceInfo: >-
卖家在承诺买家保障服务的基础上,向买家提供“48小时发货延必赔”的服务。在买家通过支付宝担保交易完成付款或通过货到付款下单成功后,卖家承诺在买家支付成功起48小时内发货。如卖家未履行前述承诺,买家可在指定期限内发起维权,并申请赔付。
assuranceType: ssbxsfh
qualityAssuranceType: 48小时发货
- assuranceInfo: “在符合一定的退款申请原因、时效和退款金额范围内,可享受0秒退款服务。
assuranceType: jstk_p
qualityAssuranceType: 极速退款
productCargoNumber: '344'
skuInfos:
- name: 铅芯颜色
value: 2B铅笔1盒
- name: 铅芯硬度
value: 2B
entryDiscount: 0
specId: 53a1eff0fa008b2b9f32a120b0a050f2
quantityFactor: 1
statusStr: 交易取消
refundStatus: null
closeReason: buyerCancel
logisticsStatus: 1
gmtCreate: '2024-08-14T07:10:38.000+00:00'
gmtModified: '2024-08-14T07:31:24.000+00:00'
gmtCompleted: '2024-08-14T07:31:24.000+00:00'
gmtPayExpireTime: null
refundId: null
subItemIDString: '2257164624870311973'
refundIdForAs: null
erpMaterialCode: null
itemDiscountFee: null
cantSendReason: null
canSendGoods: null
barCode: null
permitLogisticsCpCode: null
deliverGoodsOverdueRisk: null
relatedCode: null
freeEntryServiceInfo: null
payEntryServiceInfo: null
extAttributes: null
tradeTerms: []
extAttributes: []
orderRateInfo:
buyerRateStatus: 5
sellerRateStatus: 5
buyerRateList: null
sellerRateList: null
orderInvoiceInfo: null
customs: null
overseasExtraAddress: null
baseInfo:
allDeliveredTime: null
businessType: cb
buyerID: b2b-2215080317319ef258
buyerMemo: null
completeTime: '2024-08-14T07:31:24.000+00:00'
createTime: '2024-08-14T07:10:38.000+00:00'
currency: null
id: 2257164624870312000
modifyTime: '2024-08-14T07:31:24.000+00:00'
payTime: null
receivingTime: null
refund: 0
remark: 备注信息测试
sellerID: b2b-2208112041019eda4c
sellerMemo: null
shippingFee: 3
status: cancel
totalAmount: 11.96
buyerRemarkIcon: null
sellerRemarkIcon: null
discount: 0
buyerContact:
phone: ''
fax: null
email: null
imInPlatform: 半马日志
name: null
mobile: null
companyName: null
tradeType: '50060'
refundStatus: null
refundStatusForAs: null
refundPayment: 0
idOfStr: '2257164624870311973'
alipayTradeId: UNCREATED
receiverInfo:
toFullName: 张三
toDivisionCode: '310107'
toMobile: '18888888888'
toPhone: '18888888888'
toPost: '000000'
toTownCode: null
toArea: 上海 上海市 普陀区 镇文本 网商路699号
buyerLoginId: 半马日志
sellerLoginId: 义乌莎诗文具百货有限公司
buyerUserId: null
sellerUserId: null
buyerAlipayId: null
sellerAlipayId: null
confirmedTime: null
closeReason: buyerCancel
sumProductPayment: 9
stepOrderList: null
stepAgreementPath: null
stepPayAll: false
buyerFeedback: 备注信息测试
overSeaOrder: false
subBuyerLoginId: null
sellerOrder: false
preOrderId: null
refundId: null
flowTemplateCode: assureTrade
buyerLevel: null
sellerCreditLevel: null
sellerContact:
phone: 86-
fax: null
email: null
imInPlatform: 义乌莎诗文具百货有限公司
name: 蔡景雄
mobile: '18248548872'
companyName: 义乌市莎诗贸易有限公司
wgSenderName: null
wgSenderPhone: null
newStepOrderList:
- gmtStart: '2024-08-14T07:10:38.000+00:00'
gmtPay: null
gmtEnd: '2024-08-14T07:31:24.000+00:00'
stepNo: 1
lastStep: true
stepName: 全款交易
activeStatus: 1
payStatus: 8
logisticsStatus: 1
payFee: 11.96
paidFee: 0
goodsFee: null
adjustFee: 0
discountFee: 0.04
postFee: 3
paidPostFee: 0
closeRemark: 取消订单备注
closeOperateType: CLOSE_TRADE_BY_BUYER
couponFee: 0
tradeTypeDesc: 担保交易
payChannelList: []
tradeTypeCode: assureTrade
payTimeout: 432000
payTimeoutType: 0
payChannelCodeList: []
ccid: null
relatedCode: null
buyerOpenUid: null
buyerSubOpenUid: null
inventoryMode: null
outOrderId: T20240708002
orderBizInfo:
odsCyd: false
accountPeriodTime: null
creditOrder: false
creditOrderDetail: null
preOrderInfo: null
lstOrderInfo: null
erpBuyerUserId: null
erpOrderId: null
erpBuyerOrgId: null
isCz: null
isDz: null
dz: null
dropshipping: false
shippingInsurance: null
quoteList: null
fromEncryptOrder: false
encryptOutOrderInfo: null
outChannel: null
sendGoodsOverdueRisk: null
officialLogisticOrder: null
timestamp: 1723623607256
traceId: 7928f1cc7f35
headers: {}
x-apifox-name: 成功
security: []
x-apifox-folder: 接口说明/1688 API/1688 订单管理
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/4330288/apis/api-164891585-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://openapi.dajisaas.com
description: 正式环境
security: []