SmartProxy OpenAPI Doc

Order List

GET

/pub/order/list

Request Parameters

Name	Location	Type	Required	Description
page_no	query	integer	No	none
page_size	query	integer	No	none
trade_no	query	string	No	Order number
status	query	integer	No	Order status
product_type	query	integer	No	Product type

Detailed Description

status: Order status

Status	Description
0	Pending payment
1	Paid
2	Canceled due to payment timeout
3	Refunded

product_type: Product type | Product Type | Description | |---|---| |3|Balance recharge| |9|Dynamic traffic package| |11|Dynamic global time-based package V2| |12|Long-term IDC traffic package| |13|Residential static IP traffic package| |14|Datacenter static IP package| |15|Long-term ISP traffic package| |16|Static traffic package| |17|Dynamic IP quantity package| |18|web-scraper| |19|Static IP renewal| |20|Static IP replacement quota| |21|Static traffic package v2| |24|Static traffic add-on package| |25|Residential static IP package| |26|Additional payment - Some payment channels require users to manually fill in the amount, such as cryptocurrency. If there is a shortfall, contact customer service to make additional payment through this product| |27|Serp| |28|Video|

Enumeration Values

Property	Value
status	0
status	1
status	2
status	3
product_type	3
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	17
product_type	18
product_type	19
product_type	21
product_type	24
product_type	25
product_type	26
product_type	27
product_type	28

Response Example

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"list": [
			{
				"id": 0,
				"trade_no": "string",
				"product_id": 0,
				"product_name": "string",
				"total_fee": 0.1,
				"pay_fee": 0.1,
				"status": 0,
				"created_at": "2019-08-24T14:15:22Z"
			}
		],
		"pagination": {
			"total": 0,
			"page_no": 0,
			"page_size": 0,
			"total_pages": 0
		}
	}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Success	Inline

Response Data Structure

Create Order

POST

/pub/order/create

Due to the variety of packages and different configurations for each package, please fill in the parameters according to the actual situation. Improper parameter filling may result in order creation failure.

examples:

Renew static IP

{
    "pid": x, // Contact customer service to obtain
    "upids": "1,2,3,4,5,6", // Get the corresponding ID from /pub/ip/get-static-ip
    "pm_id": 1 // Get from /pub/payment/list
    "coupon_sn: "xxx", // Optional coupon
  }

Body Request Parameters

{
	"pid": 0,
	"upids": "string",
	"amount": 0,
	"pm_id": 0,
	"region_list": "string",
	"coupon_sn": "string",
	"use_invitation_registration_discount": true,
	"renew_duration": 0,
	"product_sku_bandwidth_id": 0,
	"product_sku_concurrency_id": 0,
	"recharge_amount": 0
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	Yes	none
» pid	body	integer	Yes	Package ID
» upids	body	string	No	Renewal package ID list
» amount	body	number	No	New purchase quantity
» pm_id	body	integer	Yes	Payment method ID
» region_list	body	string	No	Specify region + quantity when purchasing static IP
» coupon_sn	body	string	No	Coupon code
» use_invitation_registration_discount	body	boolean	No	Whether to use invitation registration discount
» renew_duration	body	integer	No	Renewal duration - optional for static IP
» product_sku_bandwidth_id	body	integer	No	Package 11: Bandwidth package ID
» product_sku_concurrency_id	body	integer	No	Package 11: Concurrency package ID
» recharge_amount	body	integer	No	Package 3: Recharge amount

Response Example

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {
		"id": 0,
		"trade_no": "string",
		"product_id": 0,
		"product_name": "string",
		"total_fee": 0.1,
		"pay_fee": 0.1,
		"status": 0,
		"created_at": "2019-08-24T14:15:22Z"
	}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Created successfully	Inline

Response Data Structure

Cancel Order

POST

/pub/order/close

Body Request Parameters

{
	"trade_no": "string"
}

Request Parameters

Name	Location	Type	Required	Description
body	body	object	Yes	none
» trade_no	body	string	Yes	none

Response Example

200 Response

{
	"code": 0,
	"message": "Operation successful",
	"data": {}
}

Response Result

Status Code	Status Code Meaning	Description	Data Model
200	OK	Operation successful	SuccessResponse