Contents

Get Metadata for a Catalog Book

Fetch metadata for a book from the catalog by using its identifier.

URL

GET https://api.ent.apple.com/v1/catalog/{storefront}/books/{id}

Path Parameters

NameTypeDescription
id Requiredstring

The unique identifier for the catalog book.

storefront Requiredstring

An iTunes Store territory that you specify with an ISO 3166 alpha-2 country code. The possible values are the id attributes of Storefrontobjects.

Query Parameters

NameTypeDescription
additionalPlatforms Optional[string]

Additional platforms the app supports that you want to get metadata for.

include Optional[string]

A list of relationship names to include for resources in the response.

Classifier (optional): A resource type to apply the parameter to, apps or books.

l Optionalstring

The localization to use, which you specify with a language tag. The possible values are in the supportedLanguageTags array belonging to the Storefront object that storefront specifies. Otherwise, the default is defaultLanguageTag in Storefront.

platform Requiredstring

The platform the user-facing app is running on. You use this to get metadata for the specified platform.

relate Optional[string]

A list of relationship names to relate for resources in the response.

Classifier (optional): A resource type to apply the parameter to, apps or books.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
BooksResponse

The request was successful.

401Unauthorized
Content-Type: application/json
UnauthorizedResponse

A response indicating an incorrect Authorization header.

500Internal Server Error
Content-Type: application/json
ErrorsResponse

A response indicating an error occurred on the server.

Discussion

Example Request and Response

Topics

Responses

See Also

App and book metadata