开放Api-订单详情

Api描述:获取订单的详细信息

URL: /manager/api/apps/openapi/order/info

格式:json

方式:get

数据请求部分

1.Request Header 参数:

参数名称 是否必须 类型 描述
open-access-token 必须 String 在开放api插件中,创建权限后即可获取该token

2.Request JSON Data(Body):

参数名称 是否必须 类型 描述
order_number 必填 String 订单编号


数据返回部分

1.Response JSON Data(Body):

格式:json

参数名称 是否必须 类型 描述
code 必须 Number 200 代表成功
message 必须 String 执行结果的文字描述信息
data 必须 Array api获取的数据保存到data中
data > pay_txn_id 必须 string 订单支付交易号
data > order_info 必须 int 订单信息
data > order_info > id 必须 int 订单 id
data > order_info > shop_id 必须 int 店铺id
data > order_info > order_number 必须 string 订单编号
data > order_info > client_type 必须 int 客户端类型,1为pc,2为平板,3为手机,4为后台创建,5为外部导入
data > order_info > order_status 必须 int 订单状态,1代表checkout edit状态,2代表open状态,3代表归档状态,4代表取消状态
data > order_info > payment_status 必须 int 1代表支付状态-初始状态,2代表待支付,3代表已支付,4代表部分退款,5代表已全部退款
data > order_info > fulfillment_status 必须 int 发货状态(履行): 1代表初始状态,2代表未发货,3代表挂起,4代表部分履行发货,5代表已发货(已全部履行),6代表部分收货,7代表全部收货,8代表已经全部退货
data > order_info > checkout_type 必须 int 结账类型:1代表购物车结账,2代表产品页面点击立即购买结账,3代表后台创建结账
data > order_info > lang_code 必须 string 用户访问网站的语言(注意,不是浏览器语言,而是网站语言)
data > order_info > items_count 必须 int 订单产品总个数
data > order_info > gram 必须 int 订单总重量-克
data > order_info > currency_code 必须 string 订单当前货币
data > order_info > base_currency_code 必须 string 基础货币
data > order_info > order_to_base_rate 必须 string 当前货币和基础货币之间的汇率
data > order_info > curr_subtotal 必须 string 订单商品总额(当前货币)
data > order_info > base_subtotal 必须 string 订单商品总额(基础货币)
data > order_info > curr_shipping_total 必须 string 订单运费(当前货币)
data > order_info > base_shipping_total 必须 string 订单运费(基础货币)
data > order_info > curr_subtotal_with_discount 必须 string 订单折扣(当前货币)
data > order_info > base_subtotal_with_discount 必须 string 订单折扣(基础货币)
data > order_info > curr_grand_total 必须 string 订单总额(当前货币)
data > order_info > base_grand_total 必须 string 订单总额(基础货币)
data > order_info > customer_type 必须 string 客户类型,1代表游客,2代表注册用户
data > order_info > customer_id 必须 string 下单用户id
data > order_info > customer_email 必须 string 下单用户email
data > order_info > discount_set 必须 string 折扣信息,数组格式,优惠券,满减折等都可以写在这里,包括折扣信息以及折扣金额详细
data > order_info > payment_method 必须 string 支付方式
data > order_info > payment_fee 必须 string 支付服务费
data > order_info > shipping_method_id 必须 string 货运方式id
data > order_info > shipping_method_name 必须 string 货运方式名称
data > order_info > note 必须 string 订单备注
data > order_info > cancelled_at 必须 string 订单取消时间
data > order_info > cancel_reason 必须 int 订单取消原因,1用户取消,2后台取消
data > order_info > payed_at 必须 string 订单支付时间
data > order_info > created_at 必须 string 订单创建时间
data > order_info > updated_at 必须 string 订单更新时间
data > order_info > recall_status 必须 int 订单召回状态:1代表不可召回,譬如游客下单还没有填写地址,2代表可召回(填写了address email),3代表已召回(支付成功,货到付款支付类型除外)
data > order_info > fulfilled_at 必须 string 履行时间(发货时间),如果有多个包裹,那么该值为最后一个包裹的发货时间
data > order_info > post_saled_at 必须 string 售后时间
data > order_info > post_sale_status 必须 int 售后状态,1为初始状态,2为已发起售后,售后处理中,3为售后已完成
data > order_info > tags 必须 array 订单Tags
data > order_info > items 必须 array 订单产品
data > order_info > items > id 必须 int 订单编号
data > order_info > items > shop_id 必须 int 订单编号
data > order_info > items > order_id 必须 int 订单编号
data > order_info > items > product_id 必须 int 订单编号
data > order_info > items > variant_id 必须 int 订单产品-变种id(规格id)
data > order_info > items > sku 必须 string 订单产品-sku
data > order_info > items > variant_title 必须 string 订单产品-变体标题
data > order_info > items > product_title 必须 string 订单产品-产品标题
data > order_info > items > image 必须 string 订单产品-产品图片
data > order_info > items > gram 必须 float 订单产品-产品单重
data > order_info > items > base_price 必须 float 订单产品-产品单价(基础货币)
data > order_info > items > curr_price 必须 float 订单产品-产品单价(当前货币)
data > order_info > items > qty 必须 int 订单产品-产品个数
data > order_info > items > curr_row_price 必须 float 订单产品-产品金额小计(当前货币)(单价*个数)
data > order_info > items > row_gram 必须 int 订单产品-产品重量小计(单重*个数)
data > order_info > items > base_row_price 必须 float 订单产品-产品金额小计(基础货币)(单价*个数)
data > order_info > items > is_reviewed 必须 int 是否已评价,1代表已经评价,2代表未评价
data > order_info > shippingAddress 必须 array 收货地址
data > order_info > shippingAddress > id 必须 int 收货地址-id
data > order_info > shippingAddress > shop_id 必须 int 收货地址-店铺id
data > order_info > shippingAddress > order_id 必须 int 收货地址-订单id
data > order_info > shippingAddress > first_name 必须 string 收货地址-姓名-名
data > order_info > shippingAddress > last_name 必须 string 收货地址-姓名-姓
data > order_info > shippingAddress > phone 必须 string 收货地址-电话号码
data > order_info > shippingAddress > address_1 必须 string 收货地址-详细地址1
data > order_info > shippingAddress > address_2 必须 string 收货地址-详细地址2
data > order_info > shippingAddress > city 必须 string 收货地址-城市
data > order_info > shippingAddress > country_code 必须 string 收货地址-国家
data > order_info > shippingAddress > province_code 必须 string 收货地址-省
data > order_info > shippingAddress > zip 必须 string 收货地址-邮政编码
data > order_info > billingAddress 选填 array 账单地址
data > order_info > billingAddress > id 选填 int 账单地址-id
data > order_info > billingAddress > shop_id 选填 int 账单地址-店铺id
data > order_info > billingAddress > order_id 选填 int 账单地址-订单id
data > order_info > billingAddress > first_name 选填 string 账单地址-姓名-名
data > order_info > billingAddress > last_name 选填 string 账单地址-姓名-姓
data > order_info > billingAddress > address_1 选填 string 账单地址-详细地址1
data > order_info > billingAddress > address_2 选填 string 账单地址-详细地址2
data > order_info > billingAddress > city 选填 string 账单地址-城市
data > order_info > billingAddress > country_code 选填 string 账单地址-国家
data > order_info > billingAddress > province_code 选填 string 账单地址-省
data > order_info > billingAddress > zip 选填 string 账单地址-邮政编码

Response JSON Data(示例数据):

{
    "code": 200,
    "data": {
        "order_info": {
            "id": 1422,
            "shop_id": 15,
            "order_number": "B203153596224752",
            "client_type": 1,
            "order_status": 2,
            "payment_status": 2,
            "fulfillment_status": 1,
            "checkout_type": 2,
            "lang_code": "en",
            "items_count": 1,
            "gram": "111000.00",
            "currency_code": "USD",
            "base_currency_code": "USD",
            "order_to_base_rate": "1.00",
            "curr_subtotal": "12.42",
            "base_subtotal": "12.42",
            "curr_shipping_total": "0.00",
            "base_shipping_total": "0.00",
            "curr_subtotal_with_discount": "0.00",
            "base_subtotal_with_discount": "0.00",
            "curr_grand_total": "12.42",
            "base_grand_total": "12.42",
            "customer_type": 2,
            "customer_id": 77,
            "customer_email": "[email protected]",
            "customer_phone": "18661832866",
            "coupon_code": "",
            "discount_set": [],
            "payment_method": "cod",
            "payment_position_type": 1,
            "payment_fee": "0.00",
            "shipping_method_id": 24,
            "shipping_method_name": "5555",
            "note": "",
            "cancelled_at": 0,
            "cancel_reason": 0,
            "payed_at": 0,
            "created_at": "2023-02-03 17:09:19",
            "updated_at": "2023-02-03 17:09:19",
            "billing_is_use_shipping_address": 1,
            "step": 6,
            "recall_status": 3,
            "recalled_at": 1675415367,
            "recall_send_email_count": 0,
            "recall_send_email_time": 0,
            "fulfilled_at": 0,
            "post_saled_at": 0,
            "post_sale_status": 1,
            "tags": null,
            "over_sold_count": 0,
            "is_stock_deducted": 1,
            "fist_loading_url": "https://diydomain.fecmall.cn/",
            "affiliate_tracking_id": "",
            "items": [
                {
                    "id": 1792,
                    "shop_id": 15,
                    "order_id": 1422,
                    "product_id": 145,
                    "variant_id": 1145,
                    "spu": "high",
                    "sku": "high-Dark Blue-1004665",
                    "variant_title": "Dark Blue",
                    "product_title": "High Ankle Jeans",
                    "image": "https://cdn.fecmall.com/common/15/image/2022/11/07/68a50f28fe05142cf51f6b08963ea7ec.webp",
                    "gram": "111000.00",
                    "base_price": "12.42",
                    "curr_price": "12.42",
                    "glasses_custom_base_price": "0.00",
                    "glasses_custom_curr_price": "0.00",
                    "glasses_customized": null,
                    "qty": 1,
                    "curr_row_price": "12.42",
                    "row_gram": "111000.00",
                    "base_row_price": "12.42",
                    "is_reviewed": 2,
                    "over_sold_count": 0
                }
            ],
            "shippingAddress": {
                "id": 1080,
                "shop_id": 15,
                "order_id": 1422,
                "first_name": "dfaffa",
                "last_name": "Doe3",
                "phone": "18661832866",
                "company": "",
                "address_1": "82 I Street Southeast",
                "address_2": "4-4-403",
                "city": "tianjin",
                "country_code": "CN",
                "province_code": "TJ",
                "zip": "343341"
            },
            "billingAddress": []
        },
        "pay_txn_id": ""
    },
    "message": "success"
}
Copyright © VanMall.vip 2023 all right reserved,powered by Gitbook该文件修订时间: 2023-02-08 22:00:36

results matching ""

    No results matching ""