Reference
Response Format
Every response returned by the partner endpoints uses the standard PartnerAckRS XML structure. This simplifies client parser construction.
The success layout
If the transmission is processed without errors, the service replies with a 200 OK enclosing a clean success payload.
Success XML Structure
<?xml version="1.0" encoding="UTF-8"?>
<PartnerAckRS>
<Success/>
</PartnerAckRS>
The error layout
If a request fails validation, authorization, or run-time translation constraints, an Errors element containing one or more discrete Error elements is populated.
Error tags feature three core attributes:
| Attribute | Required | Definition / usage |
|---|---|---|
| Type | Optional | A general bucket classification, such as Validation, RateLimit, or Exception. |
| Code | Optional | Machine-readable string code to trigger client retry routines (e.g. UNAUTHORIZED, TOO_MANY_REQUESTS, PARTNER_MISMATCH, FORBIDDEN). |
| ShortText | Optional | A developer-friendly description clarifying the exact error context. |
Error XML Structure
<?xml version="1.0" encoding="UTF-8"?>
<PartnerAckRS>
<Errors>
<Error Type="[Category]" Code="[ERROR_ID]" ShortText="[Detailed human description]"/>
</Errors>
</PartnerAckRS>