Contents

Retrieve External Purchase Report

Get an external purchase report by providing its request identifier.

URL

GET https://api.storekit.apple.com/externalPurchase/v1/reports/{requestIdentifier}

Sandbox URL

GET https://api.storekit-sandbox.apple.com/externalPurchase/v1/reports/{requestIdentifier}

Path Parameters

NameTypeDescription
requestIdentifier RequiredrequestIdentifier

The UUID that identifies the external purchase report you’re requesting.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
RetrieveReportSuccessResponse

Success. The RetrieveReportSuccessResponse object contains your report.

400Bad Request
Content-Type: application/json
NotFoundError

The request returned an error. Check the requestIdentifier parameter to ensure it’s a valid identifer for a report that you successfully submitted.

401Unauthorized

The JSON Web Token (JWT) in the authorization header is invalid.

429

Rate limit exceeded.

500Internal Server Error

Server error. Try again later.

Discussion

Call this endpoint to retrieve an external purchase report that you successfully sent to Apple. This endpoint takes the requestIdentifier that you create when you call Send External Purchase Report, for reports that were successfully submitted.

Topics

Data types

See Also

External purchase report retrieval