1. IP Orders
Nstdata Resell Service API
  • Nstdata Resell API
    • Zones
      • Get service zone list
    • Channels
      • Get channel usage statistics
      • Get total usage for all service channels
      • Create channel
      • Batch query channels
      • Batch query channel usage summary
      • Get channel detail
      • Update channel
      • Delete channel
    • IP Products
      • Get service IP product list
    • IP Orders
      • Get total purchased IP quantity
        GET
      • Batch query IP orders
        POST
      • Buy service IPs
        POST
      • Get purchased IP order detail
        GET
      • Renew IP order
        POST
    • Regions
      • Get country list
    • Proxies
      • Generate proxies
    • Schemas
      • SuccessResponse
      • ErrorResponse
      • ProxyType
      • RegionProxyType
      • IpOrderType
      • ProxyProtocol
      • Zone
      • Channel
      • CreateChannelRequest
      • UpdateChannelRequest
      • ChannelIdsRequest
      • ChannelUsageRequest
      • ChannelStatistics
      • UsageMetric
      • ChannelUsageTotal
      • ChannelUsageSummary
      • IpProduct
      • PurchaseTotalByType
      • PurchaseTotal
      • OrderIdsRequest
      • IpProxyItem
      • IpOrder
      • IpOrderDetail
      • CreateIpOrderProduct
      • CreateIpOrderRequest
      • ErrorProxyItem
      • CreateIpOrderResponse
      • RenewSuccessItem
      • RenewIpOrderResponse
      • Country
      • GenerateProxiesResponse
  • Cloud Browser Developer API
    • Automation Access
      • Get CDP Credentials for an Existing Session
    • Session Configuration
      • Get Available Options
      • Estimate Browser Runtime Cost
    • Session Management
      • Create Browser Session
      • List Browser Sessions
      • Get Session Details and Status
      • Rename Browser Session
      • Stop Browser Session
    • Connection Credentials
      • Get Live View Credentials
    • Configuration Details
      • Get Session Configuration
    • Usage and Costs
      • Get Session Usage and Costs
      • Get Costs for Multiple Sessions
      • Get All Session Statistics
      • Get Historical Session Statistics
    • Schemas
      • BrowserConnectionResponseDto
      • BrowserOptionsResponseDto
      • BrowserErrorDto
      • SharedStorageErrorDto
      • SharedHttpErrorDto
      • BrowserEstimateDto
      • BrowserQuoteResponseDto
      • CreateBrowserDto
      • BrowserSessionResponseDto
      • BrowserListResponseDto
      • RenameBrowserDto
      • BrowserNameResponseDto
      • BrowserLiveViewResponseDto
      • BrowserConfigurationResponseDto
      • BrowserCostsResponseDto
      • BrowserCostsBatchDto
      • BrowserCostsBatchResponseDto
      • BrowserStatisticsResponseDto
      • BrowserHistoryStatisticsResponseDto
      • BrowserOptionsDto
      • BrowserQuoteDto
      • BrowserExtensionDto
      • BrowserCaptchaSettingsDto
      • BrowserFingerprintDto
      • BrowserSessionDto
      • BrowserListDto
      • BrowserNameDto
      • BrowserConnectionDto
      • BrowserLiveViewDto
      • BrowserConfigurationDto
      • BrowserCostsDto
      • BrowserCostsBatchDataDto
      • BrowserStatisticsDto
      • BrowserHistoryStatisticsDto
      • BrowserScreenOptionsDto
      • BrowserRecordingOptionsDto
      • BrowserFingerprintPresetDto
      • BrowserProxyCountryOptionDto
      • BrowserResourceClassOptionDto
      • BrowserCaptchaTypesDto
      • BrowserResolutionOptionDto
      • BrowserRecordingAvailabilityDto
      • BrowserProviderObservationDto
      • BrowserCaptchaPublicDto
      • BrowserEffectiveConfigurationDto
      • BrowserRequestedConfigurationDto
      • BrowserResolvedConfigurationDto
      • BrowserRuntimeCostDto
      • BrowserProxyCostDto
      • BrowserCaptchaCostDto
      • BrowserScreenRangeDto
      • BrowserNetworkIdentityDto
      • BrowserEffectiveExtensionDto
      • BrowserEffectiveFingerprintDto
      • BrowserConfigurationExtensionDto
      • BrowserResolvedFingerprintDto
      • BrowserIpAlignmentDto
  1. IP Orders

Buy service IPs

POST
/api/v1/service/purchase/ip

Insufficient inventory (PRODUCT_OOS)#

HTTP statusBusiness error codeDescription
400PRODUCT_OOSInsufficient inventory. The purchase cannot be completed. Retry later or reduce the requested quantity.
Check the top-level code for PRODUCT_OOS. The PRODUCT_OOS response example is illustrative; the msg text may vary. This business error code is separate from the order lifecycle status (data.status).

Order status (data.status)#

ValueNameMeaning
0IdleNot activated. This is not a payment or purchase-failure status.
1ActivatedThe order is activated.
2ExpiredThe order has expired. Expired orders cannot be renewed; purchase a new order.
3DeletedThe order has been soft-deleted.

Complete and partial purchases#

A successful response from this endpoint returns data.status = 1, including when only part of the requested purchase succeeds. Inspect both data.proxies and data.errProxies: an empty errProxies array means no purchase items were reported as failed; a non-empty array identifies the failed items in a partially successful purchase. proxies contains the successfully purchased proxies. There is no separate numeric order status for partial success.
If all purchase attempts fail, the endpoint returns an error instead of a successful order response. The top-level code is the response code; it is not the order lifecycle status.
Order status values are distinct from channel status values and IP product status values.

Response example provenance#

Examples were generated through local testing on 2026-09-15 using synthetic, nonfunctional test values for identifiers, proxy addresses and credentials. They illustrate the response format and are not production response captures. Amounts, stock and dates are illustrative, not live quotations or availability.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Success
Bodyapplication/json

🟠400BadRequestError
🟠401UnauthorizedError
🟠400PRODUCT_OOS
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/service/purchase/ip' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "type": "ISP",
    "products": [
        {
            "productId": "product_xxx",
            "quantity": 10
        }
    ],
    "name": "service-isp-order",
    "channelName": "service-isp-order",
    "tag": "crawler"
}'
Response Response Example
200 - Complete purchase — verified test data
Examples were generated through local testing on 2026-09-15 using synthetic, nonfunctional test values for identifiers, proxy addresses and credentials. They illustrate the response format and are not production response captures. Amounts, stock and dates are illustrative, not live quotations or availability. Request: {"type":"ISP","products":[{"productId":"product_example_us_001","quantity":2}],"name":"Example ISP Order"}. Both requested IPs succeeded: status is 1 and errProxies is empty.
{
    "data": {
        "errProxies": [],
        "orderId": "22222222-2222-4222-8222-222222222222",
        "totalPrice": 6,
        "discount": 1,
        "number": 2,
        "period": 30,
        "expireAt": "2026-10-15T02:00:00.000Z",
        "status": 1,
        "name": "Example ISP Order",
        "proxies": [
            {
                "subOrderId": "11111111-1111-4111-8111-111111111111",
                "productId": "product_example_us_001",
                "basePrice": 3,
                "region": "US",
                "scene": "general",
                "proxy": "192.0.2.10:8000:exampleuser:ExamplePass001",
                "city": "New York",
                "expireAt": "2026-10-15T02:00:00.000Z"
            },
            {
                "subOrderId": "11111111-1111-4111-8111-111111111111",
                "productId": "product_example_us_001",
                "basePrice": 3,
                "region": "US",
                "scene": "general",
                "proxy": "192.0.2.11:8000:exampleuser:ExamplePass001",
                "city": "New York",
                "expireAt": "2026-10-15T02:00:00.000Z"
            }
        ]
    },
    "err": false,
    "msg": "SUCCESS",
    "code": 200
}
Modified at 2026-10-16 02:13:57
Previous
Batch query IP orders
Next
Get purchased IP order detail
Built with