获取订单列表

1.1 请求连接:GET /order

1.2 请求参数

名称 类型 必填项 说明
rows int 每页显示条数最大值为120,默认为10
page int 当前页码
status int 订单状态0为未支付,1为成功支付,2为已经发货,3为已经预报
is_refund int 是否退款,默认0,1为退款
begin_time timestamp 起始时间戳,单位(秒s),过滤的是下单时间order_time
end_time timestamp 截止时间戳,单位(秒s),过滤的是下单时间order_time
time_type int 过滤时间类型,1为过滤支付时间,2为过滤下单时间(默认过滤支付时间)

1.2返回值

名称 类型 说明
data array 订单列表
current_page int 当前页数
first_page_url string 第一页url(不建议使用,没有携带具体参数)
from int 上次访问的页码
last_page int 最后一页页码
last_page_url string 最后一页url 不建议使用,没有携带具体参数
next_page_url string 下一页url 不建议使用,没有携带具体参数
path string 访问接口路由
per_page int 显示页码
prev_page_url string 上一页url
to int 订单列表
page int 页码(1,2,3......)

1.3 订单详情参数说明

名称 类型 说明
order_num string 订单列表
tracking_number string 追踪号
shop_url string 下单网址
from string 上次访问的页码
country string 国家(国家标准二字码)
first_name string 用户名字
last_name string 用户姓氏
full_name string 用户全名
company string 公司
province string 省份(地址第一级)
city string 城市(地址第二级)
district string 区县(地址第三级)
area string 街道区县(地址第三级)
address string 准确地址
address2 string 地址2(如果用户地址address太长,address2会储存一部分信息)
postcode string 邮编
email string 邮箱
phone string 电话
order_notes string 订单备注
status string 订单状态
order_price string 订单商品总价
off_price string 优化价格
currency string 货币
discount string 折扣
order_time string 下单时间戳(秒)
pay_time string 支付时间戳(秒)
shipping_time string 发货时间戳(秒)
shipping_type string 物流类型(1平邮,2快递)
shipping_money string 物流费用
payment_method string 支付类型
shipping_channel_type string 物流渠道类型
remind_payment string 提醒支付
shipping_channel_code string 物流渠道编码
is_diy string 是否是div商品
diy_img string div图片
service_status int 是否启用售后0为没有启用,1为启用
review_status string 是否评论,0为没有评论,1为评论了
paypal_payment_id string paypal交易号
paypal_status string paypal状态
remark string 备注
users_coupons_id string 用户使用的优惠券id
coupons_discount_price string 优惠券优惠价格
shipping_reminder string 提醒发货,1=已提醒发货,0=未提醒发货
paypal_sync_tracking int 是否同步追踪号到paypal 0为没有同步,1为已经同步
fee double 订单收取的手续费
is_refund int 订单是否发起退款 0为不是退款订单,1为退款订单
refund_type int 订单退款类型1退款中,2部分退款,3全部退款
order_goods array 订单商品

订单商品字段说明

名称 类型 说明
hs_code string 海关编码
discount string 折扣
goods_title string 商品标题
mask string 商品封面
s_desc string 商品简介
review_status string 该商品是否评论(0为没有评论,1为已经评论)
count string 购买数量
time string 购买时间戳
pro_params string 属性key
choose_spec string 属性名称
sku string sku产品属性标识
shop_url string 购买网站
is_normal string 是否是普货
goods_url string 商品详情链接
is_refund int 订单是否发起退款 0为不是退款商品,1为退款商品

1.4请求成功事例:


{
    "status": "success",
    "code": 200,
    "message": "",
    "data": {
        "current_page": 1,
        "data": [
            {
                "order_num": "asda-20200521-004",
                "tracking_number": null,
                "shop_url": "test.belment.online",
                "country": "HK",
                "first_name": "jiang",
                "last_name": "kai",
                "full_name": "kai jiang",
                "company": null,
                "address": "71566176 Sky E137 S",
                "province": "Libisia",
                "city": "Posta",
                "district": null,
                "postcode": "W185744",
                "email": "jiangkai@test.test",
                "phone": "9559713557",
                "order_notes": null,
                "status": 1,
                "order_price": "16.55",
                "off_price": "0.00",
                "currency": "USD",
                "discount": null,
                "order_time": 1590081530,
                "pay_time": 1590081771,
                "shipping_type": 1,
                "shipping_money": "5.99",
                "payment_method": "paypal",
                "shipping_channel_type": 0,
                "remind_payment": 0,
                "shipping_channel_code": null,
                "is_diy": null,
                "diy_img": null,
                "service_status": 0,
                "review_status": null,
                "paypal_id": "6J435060R3490362M",
                "paypal_payment_id": "0V265660M36915119",
                "paypal_status": "COMPLETED",
                "remark": null,
                "users_coupons_id": null,
                "coupons_discount_price": 0,
                "shipping_reminder": 0,
                "paypal_sync_tracking": 0,
                "area": null,
                "address2": null,
                "total": "0.00",
                "ip_country": 0,
                "fee": "0.00",
                "is_refund": 0,
                "refund_type": 0,
                "shipping_time": null,
                "refund_price": "0.00",
                "order_goods": [
                    {
                        "hs_code": null,
                        "discount": null,
                        "goods_title": "20 pcs/Bag 3 Layer Non-woven Dust Mask Thickened Disposable Mouth Mask Features as KF94 FFP2",
                        "mask": "http://cdn.belment.shop/goods/mask/495107501364863.jpg",
                        "s_desc": null,
                        "review_status": 0,
                        "count": 1,
                        "time": 1590081530,
                        "price": "16.55",
                        "pro_params": "[\"ak0\"]",
                        "choose_spec": "default",
                        "sku": "10000007559556972",
                        "shop_url": "test.belment.online",
                        "is_normal": null,
                        "is_refund": 0,
                        "goods_url": "test.belment.online/product/Mjk="
                    }
                ]
            },
            {
                "order_num": "asda-20200521-001",
                "tracking_number": null,
                "shop_url": "test.belment.online",
                "country": "AU",
                "first_name": "shi",
                "last_name": "yikang",
                "full_name": "shi yikang",
                "company": null,
                "address": "1 Cheeseman Ave Brighton East",
                "province": "Victoria",
                "city": "Melbourne",
                "district": null,
                "postcode": "3001",
                "email": "shiyikang@test.test",
                "phone": "0365814241",
                "order_notes": null,
                "status": 1,
                "order_price": "27.90",
                "off_price": "0.00",
                "currency": "USD",
                "discount": null,
                "order_time": 1590052403,
                "pay_time": 1590052445,
                "shipping_type": 1,
                "shipping_money": "0.00",
                "payment_method": "paypal",
                "shipping_channel_type": 0,
                "remind_payment": 0,
                "shipping_channel_code": null,
                "is_diy": null,
                "diy_img": null,
                "service_status": 0,
                "review_status": null,
                "paypal_id": "9A045621982736003",
                "paypal_payment_id": "5D5284538J2464904",
                "paypal_status": "COMPLETED",
                "remark": null,
                "users_coupons_id": null,
                "coupons_discount_price": 0,
                "shipping_reminder": 0,
                "paypal_sync_tracking": 0,
                "area": null,
                "address2": null,
                "total": "0.00",
                "ip_country": 0,
                "fee": "0.00",
                "is_refund": 0,
                "refund_type": 0,
                "shipping_time": null,
                "refund_price": "0.00",
                "order_goods": [
                    {
                        "hs_code": null,
                        "discount": null,
                        "goods_title": "New Arrival - Secret Hair Topper",
                        "mask": "https://cdn.belment.shop/undefined/985434443446872.jpg",
                        "s_desc": null,
                        "review_status": 0,
                        "count": 1,
                        "time": 1590052403,
                        "price": "27.90",
                        "pro_params": "[\"ak0\",\"bk10\"]",
                        "choose_spec": "8 inchCream Beige Balayage",
                        "sku": "RAF-002-08",
                        "shop_url": "test.belment.online",
                        "is_normal": null,
                        "is_refund": 0,
                        "goods_url": "test.belment.online/product/MjI="
                    }
                ]
            },
            {
                "order_num": "asda-20200520-001",
                "tracking_number": null,
                "shop_url": "test.belment.online",
                "country": "AU",
                "first_name": "shi",
                "last_name": "yikang",
                "full_name": "shi yikang",
                "company": null,
                "address": "1 Cheeseman Ave Brighton East",
                "province": "Victoria",
                "city": "Melbourne",
                "district": null,
                "postcode": "3001",
                "email": "shiyikang@test.test",
                "phone": "0365814241",
                "order_notes": null,
                "status": 1,
                "order_price": "16.55",
                "off_price": "0.00",
                "currency": "USD",
                "discount": null,
                "order_time": 1590036055,
                "pay_time": 1590036082,
                "shipping_type": 1,
                "shipping_money": "5.99",
                "payment_method": "paypal",
                "shipping_channel_type": 0,
                "remind_payment": 0,
                "shipping_channel_code": null,
                "is_diy": null,
                "diy_img": null,
                "service_status": 0,
                "review_status": null,
                "paypal_id": "6F611879YU3750628",
                "paypal_payment_id": "99G79853NX859004F",
                "paypal_status": "COMPLETED",
                "remark": null,
                "users_coupons_id": null,
                "coupons_discount_price": 0,
                "shipping_reminder": 0,
                "paypal_sync_tracking": 0,
                "area": null,
                "address2": null,
                "total": "22.54",
                "ip_country": 0,
                "fee": "0.00",
                "is_refund": 0,
                "refund_type": 0,
                "shipping_time": null,
                "refund_price": "0.00",
                "order_goods": [
                    {
                        "hs_code": null,
                        "discount": null,
                        "goods_title": "20 pcs/Bag 3 Layer Non-woven Dust Mask Thickened Disposable Mouth Mask Features as KF94 FFP2",
                        "mask": "http://cdn.belment.shop/goods/mask/495107501364863.jpg",
                        "s_desc": null,
                        "review_status": 0,
                        "count": 1,
                        "time": 1590036055,
                        "price": "16.55",
                        "pro_params": "[\"ak0\"]",
                        "choose_spec": "default",
                        "sku": "10000007559556972",
                        "shop_url": "test.belment.online",
                        "is_normal": null,
                        "is_refund": 0,
                        "goods_url": "test.belment.online/product/Mjk="
                    }
                ]
            }
        ],
        "first_page_url": "https://open.shoptima.shop/api/v1/order?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://open.shoptima.shop/api/v1/order?page=1",
        "next_page_url": null,
        "path": "https://open.shoptima.shop/api/v1/order",
        "per_page": 10,
        "prev_page_url": null,
        "to": 3,
        "total": 3
    }
}

请求失败:

{
   "status": "error",
   "code": 500,
   "message": "服务器错误,请刷新后重试"
}

批量修改订单状态

2.1 请求连接:PATCH /order/updateStatus

2.2 请求参数

名称 必填项 说明
status 修改后订单状态,0为未支付,1为成功支付,2为已经发货,3为已经预报
order_nums array 订单号(数组)

例子:

{
"status":3,
"order_nums":
    [
        "TEST-20200225-005",
        "TEST-20200225-006"
    ]
}

2.3返回值

成功例子:

 {
     "status": "success",
     "code": 200,
     "message": "修改订单数为2条"
 }

失败例子:

{
    "status": "error",
    "code": 400,
    "message": "修改失败"
}

3.批量修改订单信息

3.1 请求连接:PATCH /order/batchUpdateOrder

3.2 请求参数

名称 类型 必填项 说明
tracking_number string 物流追踪号
province string 省份(地址第一级)
city string 城市(地址第二级)
district string 区县(地址第三级)
area string 街道区县(地址第三级)
address string 准确地址
address2 string 地址2(如果用户地址address太长,address2会储存一部分信息)
postcode string 邮编
email string 邮箱
phone string 电话

例子:

{
    "TEST-20200202001": {
        "tracking_number": null,
        "status": 1,
        "country": "US",
        "province": "CA",
        "city": "San Jose",
        "district": null,
        "area": null,
        "postcode": "95131",
        "address": "1 Main St",
        "address2": null,
        "shipping_channel_type": 0,
        "shipping_channel_code": null
    }
}

3.3返回值

成功例子

{
    "status": "success",
    "code": 200,
    "message": "成功修改1条数据",
    "data": {
        "errorOrderNums": []
    }
}

失败例子

{

    "status": "success",

    "code": 200,

    "message": "成功修改0条数据",

    "data": {

        "errorOrderNums": [
            "EST-20200225-005"
        ]
    }
}

4 获取单个订单详情

4.1 请求连接:GET /order/{order_num}/detail

4.2 路由参数

名称 类型 必填项 说明
order_num string 订单号

4.3返回值

成功例子:

{
    "status": "success",
    "code": 200,
    "message": "",
    "data": {
        "order_num": "asda-20200521-003",
        "tracking_number": null,
        "shop_url": "test.belment.online",
        "country": null,
        "first_name": null,
        "last_name": null,
        "full_name": null,
        "company": null,
        "address": null,
        "province": null,
        "city": null,
        "district": null,
        "postcode": null,
        "email": null,
        "phone": null,
        "order_notes": null,
        "status": 0,
        "order_price": "73.90",
        "off_price": "0.00",
        "currency": null,
        "discount": null,
        "order_time": 1590053155,
        "pay_time": null,
        "fahuo_time": null,
        "shipping_type": 1,
        "shipping_money": "0.00",
        "payment_method": "paypal",
        "shipping_channel_type": 0,
        "remind_payment": 0,
        "shipping_channel_code": null,
        "is_diy": null,
        "diy_img": null,
        "service_status": 0,
        "review_status": null,
        "paypal_id": "9TT16413AL614435B",
        "paypal_payment_id": null,
        "paypal_status": null,
        "remark": null,
        "users_coupons_id": null,
        "coupons_discount_price": 0,
        "shipping_reminder": 0,
        "paypal_sync_tracking": 0,
        "area": null,
        "address2": null,
        "total": "0.00",
        "ip_country": 0,
        "fee": "0.00",
        "order_goods": [
            {
                "hs_code": null,
                "discount": null,
                "goods_title": "50% OFF Blonde Wavy Lace Front Wigs | 3 Colors Available",
                "mask": "https://cdn.belment.shop/undefined/082609723493255.jpg",
                "s_desc": null,
                "review_status": 0,
                "count": 1,
                "time": 1590053155,
                "price": "46.00",
                "pro_params": "[\"ak0\"]",
                "choose_spec": "Blonde",
                "sku": "BL-WIG",
                "shop_url": "test.belment.online",
                "is_normal": null,
                "goods_url": "test.belment.online/product/MjM="
            },
            {
                "hs_code": null,
                "discount": null,
                "goods_title": "New Arrival - Secret Hair Topper",
                "mask": "https://cdn.belment.shop/undefined/985434443446872.jpg",
                "s_desc": null,
                "review_status": 0,
                "count": 1,
                "time": 1590053155,
                "price": "27.90",
                "pro_params": "[\"ak0\",\"bk10\"]",
                "choose_spec": "8 inchCream Beige Balayage",
                "sku": "RAF-002-08",
                "shop_url": "test.belment.online",
                "is_normal": null,
                "goods_url": "test.belment.online/product/MjI="
            }
        ]
    }
}

失败例子:

{
    "status": "error",
    "code": 401,
    "message": "没有找到订单"
}

5.批量发货

5.1 请求连接:POST /order/shippingOrders

5.2 请求参数

名称 类型 必填项 说明
order_num string 订单号
tracking_number string 物流追踪号
shipping_channel_code string 物流渠道编码

请求事例


[
    {
    "order_num":"asda-20200519-00sdf3",
    "tracking_number":"test_tracking_number1",
    "shipping_channel_code":"SF"
    },
    {
    "order_num":"asda-20200519-004",
    "tracking_number":"test_tracking_number2",
    "shipping_channel_code":"SF"
    }
]

5.3返回值

成功例子:

{
    "status": "success",
    "code": 200,
    "message": "发货成功",
    "data": {
        "error": [
             {
                "order_number":"asda-20200519-00sdf3",    
                "message": "没有找到订单",
                "code": 404
            },
            {
                "order_number":"asda-20200519-00sdf3",    
                "message": "没有找到订单",
                "code": 404
            },
        ],
        "success": [
            {
                "order_number":"asda-20200519-00sdf3",    
                "message": "发货成功",
                "code": 200
            },
        ]
    }
}

失败例子:

{
    "status": "error",
    "code": 400,
    "message": "发货失败,检查数据是否正确"
}