Dynamic traffic
Dynamic traffic

Get Dynamic Traffic Order Details

GET /open-api/v1/dynamic/traffic/orders/{order_no} endpoint reference.

Get Dynamic Traffic Order Details

GET /open-api/v1/dynamic/traffic/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/dynamic/traffic/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: PROCESSING, COMPLETED, FAILED Current status of this resource or order.
data.product_code string No — Product code returned by the products endpoint.
data.traffic_gb string No — Traffic amount in GB as a decimal string.
data.order_amount string No — Order or quote amount as a decimal string.
data.currency string No — Currency.
data.traffic_lot_id string No — Traffic lot id.
data.finish_time string No format: date-time Finish time.
data.create_time string No format: date-time Create time.
data.valid_days integer No format: int32 Valid days.
data.traffic_lot object No — Traffic lot.
data.traffic_lot.id string No — Id.
data.traffic_lot.purchased_traffic_gb string No — Purchased traffic gb.
data.traffic_lot.consumed_traffic_gb string No — Consumed traffic gb.
data.traffic_lot.expired_traffic_gb string No — Expired traffic gb.
data.traffic_lot.remaining_traffic_gb string No — Remaining traffic gb.
data.traffic_lot.status string No — Current status of this resource or order.
data.traffic_lot.effective_time string No format: date-time Effective time.
data.traffic_lot.expire_time string No format: date-time Expire time.
data.traffic_lot.create_time string No format: date-time Create time.

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

On this page

Get Dynamic Traffic Order Details