Response format

Common response envelope and error handling guide

This document explains the common response format of the partner server API.

All responses are wrapped in a common envelope.

Success:

{"resultType": "SUCCESS", "success": { ... }}

Failure:

{"resultType": "FAIL", "success": null, "error": {"errorType": 0, "errorCode": "4010", "reason": "...", "data": {}, "title": null}}

Business errors are returned with HTTP 200. Check whether resultType is SUCCESS, and treat all values other than SUCCESS as failures. For request format errors (field validation failures), respond with HTTP 400, and for unclassified server errors, respond with HTTP 500. If the request limit is exceeded, errorCode: "4095" and error.data.retryAfterSeconds are returned with HTTP 200.