Parsequerade / docs
Promoted Purchases
GET/promoted-purchases/{promotedPurchaseId}

Proposed · Extended read design · Adapter not implemented

Request

Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.

cURL
BASE='https://asc.example.com/v1/connections/conn_example'

curl --fail-with-body "$BASE/promoted-purchases/promoted_purchase_123" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

NameTypeDescription
promotedPurchaseIdRequiredstringThe selected resource’s ID.

Query parameters

NameTypeDescription
fieldsOptionalstringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.
ValuesvisibleForAllUsers, enabled, state

Response

One flat object for the selected resource.

200 · application/json
{
  "id": "promoted_purchase_123",
  "visibleForAllUsers": false,
  "enabled": false,
  "state": "PREPARE_FOR_SUBMISSION",
  "purchaseId": "purchase_123",
  "subscriptionId": "subscription_123"
}

Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.

Response fields

NameTypeDescription
idstringApple’s resource ID. Keep this string unchanged when addressing a resource.
visibleForAllUsersbooleanWhether Apple marks this resource as visible for all users.
enabledbooleanWhether Apple marks this resource as enabled.
statestringThe current state reported by Apple for this resource.
ValuesAPPROVED, IN_REVIEW, PREPARE_FOR_SUBMISSION, REJECTED
purchaseIdOptional linkagestring | nullID of the related purchase. Present only when Apple supplies linkage; related objects are not loaded automatically.
subscriptionIdOptional linkagestring | nullID of the related subscription. Present only when Apple supplies linkage; related objects are not loaded automatically.

Behavior

  • A nested resource must belong to the selected parent and the configured connection. The adapter validates ownership before returning data.

Errors

HTTPTypeDescription
400invalid_queryUnsupported filter, sort, limit, or cursor.
401unauthorizedMissing or invalid facade API key.
403forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource.
404resource_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope.
429rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned.
502–504upstream errorApple authentication, response parsing, availability, or timeout failure; this is not an empty result.

Apple mapping

Upstream route and translation

The adapter calls GET /v1/promotedPurchases/{id}. Read Apple’s original endpoint ↗

Flatten Apple’s attributes into each resource object. Expose supplied singleton linkage as IDs, with no automatic relationship traversal. Read access does not make these fields writable.

Facade parameterTypeDescription
fieldsqueryfields[promotedPurchases]

Reviewed 2026-10-14 · OpenAPI 4.5.1