Skip to content

With stock, you can order up to the available stock; without stock (pre-order), you must order at least 250. The sufficient field tells you whether the quantity you asked for can be met.

If you don't pass target_url, the stock for all-sites mode is returned; this is the same number as in the GET /locations response. target_url must be one of the supported targets (GET /target-urls); otherwise, like the order endpoint, it returns 400 and details.unsupported_targets.

An unknown location_id returns 400. If the service type is under maintenance, you get maintenance: true and sufficient: false.

Authorization

Authorizationstringrequired

Sent as Bearer <token>. This endpoint needs the orders:read (Service information) scope; a token without it gets 403.

Query parameters

typeenum<string>required

Service type.

location_idintegerrequired

Location ID. Get it from the GET /locations endpoint.

quantityinteger

Number of IPs (1-1000).

target_urlstring

Target domain for a targeted order; stock is calculated for that target.

Response

200
application/json
dataobject