订单

诸如product_id、location_id等选项可以使用产品端点进行检索。

产品

获取多个订单

GET /orders

查询参数

名称类型描述可用选项

product_id

Integer

产品ID

page

Integer

页数

per_page

Integer

每页获取的订单数

location_id

Integer

位置ID

status

String

订单状态

unpaid
in-progress
confirmed
refunded
expired

note_search

String

要搜索的订单备注字段中的短语

order_ids

Array

目标订单的ID

响应案例:

curl -X GET "https://apid.iproyal.com/v1/reseller/orders?product_id=123&page=1&per_page=10&location_id=456&status=in-progress&note_search=example%20note&order_ids=789,1011" \
     -H "X-Access-Token: <your_access_token>" \
     -H "Content-Type: application/json"

响应示例:

{
    "data": [
        {
            "id": 420,
            "note": null,
            "product_name": "Static Residential",
            "plan_name": "30 Days",
            "expire_date": "2024-04-20 10:25:12",
            "status": "confirmed",
            "location": "United States",
            "quantity": 5,
            "questions_answers": [
                {
                    "question": "Extra requirements (if you have any):",
                    "answer": "I need 128.158.97"
                }
            ],
            "proxy_data": {
                "ports": {
                    "socks5": 12324,
                    "http|https": 12323
                },
                "proxies": []
            },
            "auto_extend_settings": null,
            "extended_history": []
        },
        ...
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "path": "https://apid.iproyal.com/v1/reseller/orders",
        "per_page": 10,
        "to": 10,
        "total": 14
    }
}

获取订单

GET /orders/{order_id}

响应案例:

curl -X GET "https://apid.iproyal.com/v1/reseller/orders/12345" \
     -H "X-Access-Token: <your_access_token>" \
     -H "Content-Type: application/json"

响应示例:

{
    "id": 420,
    "note": null,
    "product_name": "Static Residential",
    "plan_name": "30 Days",
    "expire_date": "2024-04-20 10:25:12",
    "status": "expired",
    "location": "Canada",
    "quantity": 5,
    "questions_answers": [],
    "proxy_data": {
        "ports": {
            "socks5": 12324,
            "http|https": 12323
        },
        "proxies": []
    },
    "auto_extend_settings": null,
    "extended_history": []
}

计算价格

GET /orders/calculate-pricing

查询参数

名称类型描述

product_id

整型

产品ID

product_plan_id

整型

产品套餐ID

product_location_id

整型

产品地理位置ID

quantity

整型

代理数量

coupon_code

字符串

优惠码

响应案例:

curl -X GET "https://apid.iproyal.com/v1/reseller/orders/calculate-pricing?product_id=123&product_plan_id=456&product_location_id=789&quantity=10&coupon_code=DISCOUNT2024" \
     -H "X-Access-Token: <your_access_token>" \
     -H "Content-Type: application/json"

示例响应:

{
    "pre_discount_price": 30,
    "price_with_vat": 30,
    "vat": null,
    "price": 30,
    "pre_discount_price_per_item": 3,
    "price_per_item": 3,
    "plan_discount_percent": 0,
    "location_discount_percent": 0,
    "coupon_discount_percent": 0,
    "quantity_discount_percent": 0,
    "total_discount_percent": 0,
    "quantity_required_for_next_discount": {
        "quantity": 90,
        "discount": 5
    },
    "message": null
}

创建订单

POST /orders

正文参数

名称类型描述

product_id

整型

产品ID

product_plan_id

整型

产品套餐ID

product_location_id

整型

产品地理位置ID

quantity

整型

代理数量

coupon_code

字符串

优惠码

auto_extend

布尔值

订单是否会自动续期

product_question_answers

数组

问题解答

{ question_id: answer, ... }

响应案例:

curl -X POST "https://apid.iproyal.com/v1/reseller/orders" \
     -H "X-Access-Token: <your_access_token>" \
     -H "Content-Type: application/json" \
     -d '{
           "product_id": 123,
           "product_plan_id": 456,
           "product_location_id": 789,
           "quantity": 10,
           "coupon_code": "DISCOUNT2024",
           "auto_extend": true,
           "product_question_answers": {
               "question_id_1": "answer_1",
               "question_id_2": "answer_2"
           }
         }'

响应示例:

{
    "id": 420,
    "note": null,
    "product_name": "Static Residential",
    "plan_name": "30 Days",
    "expire_date": "2024-04-20 10:25:12",
    "status": "expired",
    "location": "Canada",
    "quantity": 5,
    "questions_answers": [],
    "proxy_data": {
        "ports": {
            "socks5": 12324,
            "http|https": 12323
        },
        "proxies": []
    },
    "auto_extend_settings": null,
    "extended_history": []
}

续期订单

POST /orders/{order_id}/extend

正文参数

名称类型描述

product_plan_id

整型

产品套餐ID

响应示例:

curl -X POST "https://apid.iproyal.com/v1/reseller/orders/12345/extend" \
     -H "X-Access-Token: <your_access_token>" \
     -H "Content-Type: application/json" \
     -d '{
           "product_plan_id": 678
         }'

响应示例:

{
    "id": 420,
    "note": null,
    "product_name": "Static Residential",
    "plan_name": "30 Days",
    "expire_date": "2024-04-20 10:25:12",
    "status": "expired",
    "location": "Canada",
    "quantity": 5,
    "questions_answers": [],
    "proxy_data": {
        "ports": {
            "socks5": 12324,
            "http|https": 12323
        },
        "proxies": []
    },
    "auto_extend_settings": null,
    "extended_history": []
}

Last updated