13. Test Environment IP Whitelist Management

These services allow you to list IP whitelist records for your seller account to access the STAGE environment, add new IPv4 addresses, and delete an existing IP record. Stage integration access is managed through IPs defined in the whitelist.

Service Rules

• This service is used to provide IP authorization for access to the stage environment.
• You need to send storefrontcode in the Header parameter.
• All endpoints must be called with Basic Authentication.
• The sellerId in the path is the seller ID information from the seller panel and is mandatory.
• Only IPv4 addresses are supported (e.g., 203.0.113.10). IPv6 is not accepted.
• A maximum of 7 IP addresses can be added to the whitelist.
• A maximum of 7 IP creation (addition) requests can be sent per day.
• The system generates an expiration date (expiresAt) for added IPs; the record becomes invalid when the period expires.
• Returns 429 when operation or defined IP count limit is exceeded.
  

1-IP Whitelist Listing

Lists active IP whitelist records defined for the seller for stage environment access.

• There are no query parameters; all whitelist records for the seller are returned.
• For each record, the IP address and expiration date (expiresAt) are returned.
• If there are no records, the ips array can be returned empty.
• A maximum of 7 IPs can exist in the whitelist at the same time

GET ip-whitelists

Service Parameter

Example Service Response

{
"sellerId": "123456",
"ips": [
{
"ip": "203.0.113.10",
"expiresAt": "2026-08-16T08:19:53.084130217Z"
}
]
}

Field Descriptions (Response)

Error Scenarios

2-IP Whitelist Addition

Adds a new IPv4 address to the seller's whitelist for stage environment access.

Service Rules

• Only the ip field is sent in the request body.
• IP is mandatory and must be a valid IPv4.
• A maximum of 7 IPs can be maintained in the whitelist; requests are rejected if this limit is exceeded.
• A maximum of 7 IP creation requests can be sent per day; requests are rejected if the daily limit is exceeded.
• Returns 409 if the same IP is already active.
• Returns 422 if security check fails.
• Returns 429 when limit is exceeded (max. 7 IPs or 7 additions per day).
• On successful operation, returns HTTP 201 and the expiresAt information of the added record.

POST ip-whitelists

Service Parameter

Example Service Request

{
  "ip": "1.1.1.1"
}

Field Descriptions (Request)

Example Service Response HTTP 201

{
  "sellerId": "123456",
  "ip": "203.0.113.10",
  "expiresAt": "2026-08-16T08:19:53.084130217Z"
}

Field Descriptions (Response)

Error Scenarios

3- IP Whitelist Deletion

Deletes the specified IPv4 address from the seller's whitelist; stage access authorization is removed for that IP.

• The IP to be deleted is sent as a path parameter.
• Returns HTTP 204 on successful deletion; there is no response body.
• Returns 404 if the IP to be deleted is not found.
• Returns 429 when limit is exceeded.
• The deleted IP frees up space in the maximum 7 IP quota; the daily creation limit (7/day) is not reset by deletion.

DELETE ip-whitelist

Service Parameter

Error Scenarios