Developers
API referenceBusiness sign in

Returns

The return policy in force

GET/returns/policy

Scope returns.read

The return policy in force

Request

Query parameters

Query parameters
NameInTypeDescription
storeIdOptionalquerystringA store's own policy, when it has one.Pattern ^(?:QD-STR-[A-F0-9]{24}|QDSTR[A-Z0-9]{3,31})$

Response

Success responses
StatusMeaning
200The policy

The body is { "status": "success", "data": … }. Fields of data (ReturnPolicyResult):

Response data
FieldTypeDescription
policyRequiredReturnPolicyThe return policy in force (store, else Business, else default), after any contract terms.

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
404Not found for this Business and environment. IDs from another Business or environment are always 404. Not found for this Business and environment. IDs from another Business or the other environment are always 404.
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.