开放Api-待处理订单订单列表

Api描述：获取 待处理订单列表(待处理订单，指的是用户的已支付订单)

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

格式：json

方式：get

数据请求部分

1.Request Header 参数:

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

2.Request JSON Data(Body)：

参数名称 是否必须 类型 描述
pageNum 选填 String 每页的个数
pageSize 选填 String 第x页
search_key 选填 String 搜索字段-类型：详细参看下面的说明
search_val 选填 String 搜索字段-值（搜索字段-类型，对应的值）
order_processing_status 选填 String 订单处理状态，1代表待发货，2代表已发货，3代表已完成，4代表已归档
created_at_begin 选填 String 创建时间-开始
created_at_end 选填 String 创建时间-结束

搜索字段-类型：

  • 订单编号 order_number
  • 订单id order_id
  • 首次访问落地页URL fist_loading_url
  • 下单邮箱 customer_email
  • 下单手机号 customer_phone
  • 优惠码 coupon_code

譬如：search_key=order_number, search_val=DS2342341234 代表搜索订单编号为：DS2342341234的订单列表


数据返回部分

1.Response JSON Data(Body)：

格式：json

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

Response JSON Data(示例数据)：

{
    "code": 200,
    "data": {
        "list": [
            {
                "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,
                "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",
                "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",
                "fulfilled_at": 0,
                "post_saled_at": 0,
                "post_sale_status": 1,
                "over_sold_count": 0,
                "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": []
            },
            {
                "id": 1421,
                "shop_id": 15,
                "order_number": "B203143365575694",
                "client_type": 1,
                "order_status": 2,
                "payment_status": 2,
                "fulfillment_status": 1,
                "checkout_type": 2,
                "lang_code": "en",
                "items_count": 1,
                "currency_code": "USD",
                "base_currency_code": "USD",
                "order_to_base_rate": "1.00",
                "curr_subtotal": "21.00",
                "base_subtotal": "21.00",
                "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": "21.00",
                "base_grand_total": "21.00",
                "customer_type": 2,
                "customer_id": 77,
                "customer_email": "[email protected]",
                "customer_phone": "18661832866",
                "coupon_code": "",
                "discount_set": "",
                "payment_method": "cod",
                "shipping_method_name": "5555",
                "note": "",
                "cancelled_at": 0,
                "cancel_reason": 0,
                "payed_at": 0,
                "created_at": "2023-02-03 16:52:16",
                "updated_at": "2023-02-03 16:52:16",
                "fulfilled_at": 0,
                "post_saled_at": 0,
                "post_sale_status": 1,
                "over_sold_count": 1,
                "items": [
                    {
                        "id": 1791,
                        "shop_id": 15,
                        "order_id": 1421,
                        "product_id": 143,
                        "variant_id": 651,
                        "spu": "platform",
                        "sku": "platform-Black-S-1004518",
                        "variant_title": "Black / S",
                        "product_title": "Platform espadrille sandals",
                        "image": "https://cdn.fecmall.com/common/15/image/2022/11/07/4d2e643d046888979f77c87d3e16d526.webp",
                        "gram": "12000.00",
                        "base_price": "21.00",
                        "curr_price": "21.00",
                        "glasses_custom_base_price": "0.00",
                        "glasses_custom_curr_price": "0.00",
                        "glasses_customized": null,
                        "qty": 1,
                        "curr_row_price": "21.00",
                        "row_gram": "12000.00",
                        "base_row_price": "21.00",
                        "is_reviewed": 2,
                        "over_sold_count": 1
                    }
                ],
                "shippingAddress": {
                    "id": 1079,
                    "shop_id": 15,
                    "order_id": 1421,
                    "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": []
            },
            {
                "id": 1420,
                "shop_id": 15,
                "order_number": "B203141072295218",
                "client_type": 1,
                "order_status": 2,
                "payment_status": 2,
                "fulfillment_status": 1,
                "checkout_type": 2,
                "lang_code": "en",
                "items_count": 1,
                "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": 1,
                "customer_id": 110,
                "customer_email": "[email protected]",
                "customer_phone": "+355 5432535",
                "coupon_code": "",
                "discount_set": "",
                "payment_method": "cod",
                "shipping_method_name": "5555",
                "note": "",
                "cancelled_at": 0,
                "cancel_reason": 0,
                "payed_at": 0,
                "created_at": "2023-02-03 16:48:27",
                "updated_at": "2023-02-03 16:48:27",
                "fulfilled_at": 0,
                "post_saled_at": 0,
                "post_sale_status": 1,
                "over_sold_count": 0,
                "items": [
                    {
                        "id": 1790,
                        "shop_id": 15,
                        "order_id": 1420,
                        "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": 1078,
                    "shop_id": 15,
                    "order_id": 1420,
                    "first_name": "firstname",
                    "last_name": "lastname",
                    "phone": "+355 5432535",
                    "company": "",
                    "address_1": "street1",
                    "address_2": "street2",
                    "city": "长沙市",
                    "country_code": "AL",
                    "province_code": "",
                    "zip": "5432543"
                },
                "billingAddress": []
            },
            {
                "id": 1419,
                "shop_id": 15,
                "order_number": "B203139092409754",
                "client_type": 1,
                "order_status": 2,
                "payment_status": 2,
                "fulfillment_status": 1,
                "checkout_type": 2,
                "lang_code": "en",
                "items_count": 1,
                "currency_code": "USD",
                "base_currency_code": "USD",
                "order_to_base_rate": "1.00",
                "curr_subtotal": "12.42",
                "base_subtotal": "12.42",
                "curr_shipping_total": "44.00",
                "base_shipping_total": "44.00",
                "curr_subtotal_with_discount": "0.00",
                "base_subtotal_with_discount": "0.00",
                "curr_grand_total": "56.42",
                "base_grand_total": "56.42",
                "customer_type": 1,
                "customer_id": 13,
                "customer_email": "[email protected]",
                "customer_phone": "+244 432143243",
                "coupon_code": "",
                "discount_set": "",
                "payment_method": "cod",
                "shipping_method_name": "中国的",
                "note": "",
                "cancelled_at": 0,
                "cancel_reason": 0,
                "payed_at": 0,
                "created_at": "2023-02-03 16:45:09",
                "updated_at": "2023-02-03 16:45:09",
                "fulfilled_at": 0,
                "post_saled_at": 0,
                "post_sale_status": 1,
                "over_sold_count": 0,
                "items": [
                    {
                        "id": 1789,
                        "shop_id": 15,
                        "order_id": 1419,
                        "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": 1077,
                    "shop_id": 15,
                    "order_id": 1419,
                    "first_name": "Terry",
                    "last_name": "zhao",
                    "phone": "+244 432143243",
                    "company": "qingdao feimao keji",
                    "address_1": "chong qing zhong lu 227",
                    "address_2": "",
                    "city": "qingdao",
                    "country_code": "AO",
                    "province_code": "",
                    "zip": "2432"
                },
                "billingAddress": []
            }
        ],
        "total": 496,
        "pageSize": 20,
        "totalPage": 25
    },
    "message": "success"
}
Copyright © VanMall.vip 2023 all right reserved，powered by Gitbook该文件修订时间： 2023-02-08 21:41:58

results matching ""

    No results matching ""