Static proxy
Static proxy

Get Static Proxy Purchase Order Details

GET /open-api/v1/static/purchase-orders/{order_no} endpoint reference.

Get Static Proxy Purchase Order Details

GET /open-api/v1/static/purchase-orders/{order_no}

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 path string Yes — Order no.

Request example

curl --request GET \
  --url 'https://api.ipfbs.com/gin/open-api/v1/static/purchase-orders/PO1912345678901234567' \
  --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.order_no string No — Order no.
data.status string No enum: UNFULFILLED, PROCESSING, SUCCESS, PARTIAL_SUCCESS, FAILED Current status of this resource or order.
data.static_type string No enum: ISP, ISP_NATIVE, ISP_CARRIER_NATIVE Static proxy product type.
data.duration_days integer No format: int32; minimum: 1 Duration in days. Use a positive integer supported by the active price catalog.
data.quantity integer No format: int32; minimum: 1 Quantity for this region or the whole order, as indicated by the field path.
data.fulfilled_quantity integer No format: int32; minimum: 0 Fulfilled quantity.
data.order_amount string No — Order or quote amount as a decimal string.
data.currency string No — Currency.
data.create_time string No format: date-time Create time.
data.finish_time string No format: date-time Finish time.
data.regions object[] No — One or more purchase regions; each region appears once.
data.regions[].region_code string No — Region code returned by the regions endpoint.
data.regions[].quantity integer No format: int32 Quantity for this region or the whole order, as indicated by the field path.
data.regions[].fulfilled_quantity integer No format: int32 Fulfilled quantity.
data.regions[].order_amount string No — Order or quote amount as a decimal string.
data.regions[].status string No — Current status of this resource or order.
data.regions[].resources object[] No — Resources.
data.regions[].resources[].id string No — Id.
data.regions[].resources[].static_type string No enum: ISP, ISP_NATIVE, ISP_CARRIER_NATIVE Static proxy product type.
data.regions[].resources[].region_code string No — Region code returned by the regions endpoint.
data.regions[].resources[].region_name string No — Region name.
data.regions[].resources[].host string No — Host.
data.regions[].resources[].ip string No — Ip.
data.regions[].resources[].port integer No format: int32 Port.
data.regions[].resources[].account string No — Account.
data.regions[].resources[].password string No — Password.
data.regions[].resources[].protocol string No enum: HTTP Protocol.
data.regions[].resources[].resource_status string No enum: ACTIVE, EXPIRED Resource status.
data.regions[].resources[].buy_time string No format: date-time Buy time.
data.regions[].resources[].expire_time string No format: date-time Expire time.
data.regions[].resources[].create_time string No format: date-time Create time.
data.regions[].resources[].update_time string No format: date-time Update time.

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

On this page

Get Static Proxy Purchase Order Details