{"openapi":"3.1.0","info":{"title":"Orphilia public reseller API","version":"1.0.0","description":"Customer-scoped server integrations only. Base URL uses the destination storefront domain. Hosted provider acceptance and domain cutover are separate. 60 stock / 20 service requests per credential/minute; shared 120 requests per IP/minute. No automatic retries of uncertain mutations."},"servers":[{"url":"https://orphilia.com"}],"paths":{"/api/v3/re/stocks":{"get":{"operationId":"listResellerStock","summary":"listResellerStock","security":[{"resellerApiKey":[]}],"responses":{"200":{"description":"Successful read or accepted request. Inspect the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockResult"}}}},"400":{"description":"Invalid fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked credential or disabled group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Insufficient scope or blocked browser origin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Missing country or missing/out-of-group key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Key operation in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Request rejected or incomplete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait."}}},"502":{"description":"Invalid provider response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Integration unavailable; mutation outcome may be uncertain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"parameters":[{"name":"country_code","in":"query","required":false,"schema":{"type":"string","pattern":"^[A-Za-z]{2}$"}},{"name":"min_slots","in":"query","required":false,"schema":{"type":"integer","minimum":0}},{"name":"max_slots","in":"query","required":false,"schema":{"type":"integer","minimum":0}},{"name":"save_to_db","in":"query","required":false,"schema":{"type":"string","enum":["true","false"],"default":"true"}}]}},"/api/v3/re/stocks/country/{countryCode}":{"get":{"operationId":"resellerCountryStock","summary":"resellerCountryStock","security":[{"resellerApiKey":[]}],"responses":{"200":{"description":"Successful read or accepted request. Inspect the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountryResult"}}}},"400":{"description":"Invalid fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked credential or disabled group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Insufficient scope or blocked browser origin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Missing country or missing/out-of-group key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Key operation in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Request rejected or incomplete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait."}}},"502":{"description":"Invalid provider response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Integration unavailable; mutation outcome may be uncertain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"parameters":[{"name":"countryCode","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z]{2}$"}}]}},"/api/v3/re/stocks/stats":{"get":{"operationId":"resellerStockStatistics","summary":"resellerStockStatistics","security":[{"resellerApiKey":[]}],"responses":{"200":{"description":"Successful read or accepted request. Inspect the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsResult"}}}},"400":{"description":"Invalid fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked credential or disabled group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Insufficient scope or blocked browser origin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Missing country or missing/out-of-group key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Key operation in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Request rejected or incomplete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait."}}},"502":{"description":"Invalid provider response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Integration unavailable; mutation outcome may be uncertain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v3/re/keyInfo":{"post":{"operationId":"inspectResellerKey","summary":"inspectResellerKey","security":[{"resellerApiKey":[]}],"responses":{"200":{"description":"Successful read or accepted request. Inspect the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyResult"}}}},"400":{"description":"Invalid fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked credential or disabled group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Insufficient scope or blocked browser origin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Missing country or missing/out-of-group key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Key operation in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Request rejected or incomplete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait."}}},"502":{"description":"Invalid provider response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Integration unavailable; mutation outcome may be uncertain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyRequest"}}}}},"get":{"operationId":"inspectResellerKeyCompatibility","summary":"inspectResellerKeyCompatibility","security":[{"resellerApiKey":[]}],"responses":{"200":{"description":"Successful read or accepted request. Inspect the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyResult"}}}},"400":{"description":"Invalid fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked credential or disabled group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Insufficient scope or blocked browser origin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Missing country or missing/out-of-group key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Key operation in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Request rejected or incomplete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait."}}},"502":{"description":"Invalid provider response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Integration unavailable; mutation outcome may be uncertain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"parameters":[{"name":"orphkey","in":"query","required":true,"schema":{"type":"string","minLength":4,"maxLength":4096,"description":"Customer alias from this credential’s reseller group. No whitespace."}}],"description":"Prefer POST to keep the customer key out of URL logs."}},"/api/v3/re/upgrade":{"post":{"operationId":"upgradeResellerKey","summary":"upgradeResellerKey","security":[{"resellerApiKey":[]}],"responses":{"200":{"description":"Successful read or accepted request. Inspect the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResult"}}}},"400":{"description":"Invalid fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked credential or disabled group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Insufficient scope or blocked browser origin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Missing country or missing/out-of-group key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Key operation in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Request rejected or incomplete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait."}}},"502":{"description":"Invalid provider response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Integration unavailable; mutation outcome may be uncertain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeRequest"}}}}},"get":{"operationId":"upgradeInstructions","summary":"upgradeInstructions","security":[],"responses":{"200":{"description":"Successful read or accepted request. Inspect the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instructions"}}}}}}},"/api/v3/re/renew":{"post":{"operationId":"renewResellerKey","summary":"renewResellerKey","security":[{"resellerApiKey":[]}],"responses":{"200":{"description":"Successful read or accepted request. Inspect the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceResult"}}}},"400":{"description":"Invalid fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, invalid, revoked credential or disabled group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Insufficient scope or blocked browser origin.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Missing country or missing/out-of-group key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Key operation in progress.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Request rejected or incomplete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited; respect Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Retry-After":{"schema":{"type":"string"},"description":"Seconds to wait."}}},"502":{"description":"Invalid provider response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Integration unavailable; mutation outcome may be uncertain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceRequest"}}}}},"get":{"operationId":"renewalInstructions","summary":"renewalInstructions","security":[],"responses":{"200":{"description":"Successful read or accepted request. Inspect the response status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Instructions"}}}}}}}},"components":{"securitySchemes":{"resellerApiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Issued, hash-registered, unrevoked credential for an enabled reseller group and required scope. Obtain from staff; never embed in browser code."}},"schemas":{"KeyRequest":{"type":"object","properties":{"orphkey":{"type":"string","minLength":4,"maxLength":4096,"description":"Customer alias from this credential’s reseller group. No whitespace."}},"required":["orphkey"]},"ServiceRequest":{"type":"object","properties":{"orphkey":{"type":"string","minLength":4,"maxLength":4096,"description":"Customer alias from this credential’s reseller group. No whitespace."},"sp_dc":{"type":"string","minLength":50,"maxLength":300,"pattern":"^[A-Za-z0-9_=-]{50,300}$"},"sp_doc":{"type":"string","minLength":50,"maxLength":300,"pattern":"^[A-Za-z0-9_=-]{50,300}$"},"login":{"type":"string","minLength":1,"maxLength":254},"password":{"type":"string","minLength":6,"maxLength":256},"country":{"type":"string","pattern":"^[A-Za-z]{2}$"},"newEmail":{"type":"string","format":"email","maxLength":254},"newemail":{"type":"string","format":"email","maxLength":254}},"required":["orphkey"],"description":"Provide sp_dc/sp_doc OR login and password. Upgrade requires country. Email changes require password; omit unused fields. No idempotency key.","anyOf":[{"required":["sp_dc"]},{"required":["sp_doc"]},{"required":["login","password"]}],"dependentRequired":{"newEmail":["password"],"newemail":["password"]}},"Error":{"type":"object","properties":{"success":{"const":false},"status":{"const":"error"},"message":{"type":"string"},"reference":{"type":"string"}},"required":["success","status","message","reference"]},"Reseller":{"type":"object","properties":{"authenticated":{"const":true},"apiKeyType":{"const":"reseller"},"apiKey":{"type":"string","description":"Masked label, never the complete credential."}},"required":["authenticated","apiKeyType","apiKey"]},"Country":{"type":"object","properties":{"country":{"type":"string"},"country_code":{"type":"string","pattern":"^[A-Z]{2}$"},"slots":{"type":"integer","minimum":0}},"required":["country","country_code","slots"]},"ServiceResult":{"type":"object","properties":{"status":{"type":"string","description":"Inspect status, not just HTTP 200. queued/pending/unknown are not completion."},"message":{"type":"string"},"reseller":{"$ref":"#/components/schemas/Reseller"}},"required":["status","message","reseller"]},"KeyResult":{"type":"object","properties":{"id":{"type":"string"},"orphkey":{"type":"string"},"status":{"type":"string"},"message":{"type":["string","null"]},"used":{"type":"boolean"},"username":{"type":["string","null"]},"used_date":{"type":["string","null"]},"purchase_date":{"type":["string","null"]},"verify_address":{"type":["string","null"]},"response_time_ms":{"type":"integer","minimum":0},"created_at":{"type":"string","format":"date-time"},"reseller":{"$ref":"#/components/schemas/Reseller"}},"required":["orphkey","status","used","reseller"]},"StockResult":{"type":"object","properties":{"success":{"const":true},"timestamp":{"type":"string","format":"date-time"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Country"}},"total_countries":{"type":"integer","minimum":0},"total_slots":{"type":"integer","minimum":0},"filters_applied":{"type":"object"},"saved_to_db":{"type":"boolean"},"reseller":{"$ref":"#/components/schemas/Reseller"}},"required":["success","data","reseller"]},"CountryResult":{"type":"object","properties":{"success":{"const":true},"timestamp":{"type":"string","format":"date-time"},"data":{"$ref":"#/components/schemas/Country"},"reseller":{"$ref":"#/components/schemas/Reseller"}},"required":["success","data","reseller"]},"StatsResult":{"type":"object","properties":{"success":{"const":true},"timestamp":{"type":"string","format":"date-time"},"statistics":{"type":"object","properties":{"total_countries":{"type":"integer","minimum":0},"total_slots":{"type":"integer","minimum":0},"average_slots_per_country":{"type":"integer","minimum":0},"top_5_countries":{"type":"array","items":{"$ref":"#/components/schemas/Country"}},"bottom_5_countries":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}},"required":[]},"reseller":{"$ref":"#/components/schemas/Reseller"}},"required":["success","statistics","reseller"]},"Instructions":{"type":"object","properties":{"status":{"type":"string"},"endpoint":{"type":"string"},"method":{"const":"POST"},"authentication":{"type":"string"},"request":{"type":"object"},"modes":{"type":"string"}},"required":["status","endpoint","method","request"]},"UpgradeRequest":{"allOf":[{"$ref":"#/components/schemas/ServiceRequest"},{"type":"object","required":["country"]}]}}}}