List Static Proxy Purchase Orders

GET /open-api/v1/static/purchase-orders

Base URL: https://api.ipfbs.com/gin.

Authentication

Send your key in the X-API-Key request header.

Path and query parameters

Field	In	Type	Required	Constraints	Meaning
order_no	query	string	No	—	Order no.
status	query	string	No	enum: UNFULFILLED, PROCESSING, SUCCESS, PARTIAL_SUCCESS, FAILED	Current status of this resource or order.
create_time_start	query	string	No	format: date-time	Create time start.
create_time_end	query	string	No	format: date-time	Create time end.
page_no	query	integer	No	format: int64; minimum: 1	Page no.
page_size	query	integer	No	format: int64; minimum: 1; maximum: 100	Page size.

Request example

curl --request GET \
  --url 'https://api.ipfbs.com/gin/open-api/v1/static/purchase-orders' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>'

Success response data

Responses use code, msg, data, and next. HTTP 200 can also contain a nonzero business error code; check code first.

Field	Type	Required	Constraints	Meaning
data.list	object[]	No	—	List.
data.list[].order_no	string	No	—	Order no.
data.list[].status	string	No	enum: UNFULFILLED, PROCESSING, SUCCESS, PARTIAL_SUCCESS, FAILED	Current status of this resource or order.
data.list[].static_type	string	No	enum: ISP, ISP_NATIVE, ISP_CARRIER_NATIVE	Static proxy product type.
data.list[].duration_days	integer	No	format: int32; minimum: 1	Duration in days. Use a positive integer supported by the active price catalog.
data.list[].quantity	integer	No	format: int32; minimum: 1	Quantity for this region or the whole order, as indicated by the field path.
data.list[].fulfilled_quantity	integer	No	format: int32; minimum: 0	Fulfilled quantity.
data.list[].order_amount	string	No	—	Order or quote amount as a decimal string.
data.list[].currency	string	No	—	Currency.
data.list[].create_time	string	No	format: date-time	Create time.
data.list[].finish_time	string	No	format: date-time	Finish time.
data.list[].regions	object[]	No	—	One or more purchase regions; each region appears once.
data.list[].regions[].region_code	string	No	—	Region code returned by the regions endpoint.
data.list[].regions[].quantity	integer	No	format: int32	Quantity for this region or the whole order, as indicated by the field path.
data.list[].regions[].fulfilled_quantity	integer	No	format: int32	Fulfilled quantity.
data.list[].regions[].order_amount	string	No	—	Order or quote amount as a decimal string.
data.list[].regions[].status	string	No	—	Current status of this resource or order.
data.total	integer	No	format: int64	Total.
data.page_no	integer	No	format: int64; minimum: 1	Page no.
data.page_size	integer	No	format: int64; minimum: 1; maximum: 100	Page size.

Related conventions

Request conventions · Response structure · Error codes · API reference index