Pinterest Items API is one of 117 APIs that Pinterest publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Item. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes
4 operations
across 3 paths,
and defines 82 schemas.
It is described by OpenAPI 3.2.0, at version 5.13.0.
Requests are made against a single base URL, https://api.pinterest.com/v5.
The identity and technical contract details declared by the specification.
CatalogsCreateCreativeAssetsItem
object
A creative assets item to be created.
3 properties
3 required
PinMedia
object
Pin media objects.
1 property
CatalogsUpdateCreativeAssetsItem
object
A creative assets item to be updated.
3 properties
3 required
CatalogsDeleteRetailItem
object
An item to be deleted
2 properties
2 required
ItemUpdateBatchRecord
object
Object describing an item batch record to update items
3 properties
CatalogsCreativeAssetsBatchRequest
object
Request object to update catalogs creative assets items
5 properties
4 required
PinMediaSourceImageBase64
object
Base64-encoded image media source
4 properties
3 required
CatalogsUpdatableHotelAttributes
object
17 properties
CatalogsRetailItemsFilter
object
3 properties
2 required
UpdatableItemAttributes
object
45 properties
CatalogsHotelBatchItem
object
Hotel batch item
CatalogsItems
object
Response object of catalogs items
1 property
Pin
objectnull
Pin
19 properties
CatalogsDeleteHotelItem
object
A hotel item to be deleted
2 properties
2 required
CatalogsUpdateHotelItem
object
Object describing an hotel item batch record
3 properties
3 required
CatalogsHotelGuestRatings
object
If specified, you must provide all properties
4 properties
CatalogsHotelItemErrorResponse
object
Object describing a hotel item error
3 properties
1 required
CatalogsHotelItemsBatch
object
Object describing the catalogs hotel items batch
6 properties
1 required
ItemProcessingRecord
object
Object describing an item processing record
4 properties
CatalogsItemsCreateBatchRequest
object
Request object to create catalogs items
4 properties
4 required
CatalogsVerticalBatchRequest
object
A request object that can have multiple operations on a single batch
CatalogsCreateHotelItem
object
A hotel item to be created.
3 properties
3 required
CatalogsHotelAttributes
object
CatalogsItemsUpsertBatchRequest
object
Request object to upsert catalogs items
4 properties
4 required
ItemAttributesRequest
object
CatalogsCreateRetailItem
object
An item to be created
3 properties
3 required
CatalogsItemsUpdateBatchRequest
object
Request object to update catalogs items
4 properties
4 required
CatalogsItemsDeleteDiscontinuedBatchRequest
object
Request object to discontinue catalogs items
4 properties
4 required
CatalogsHotelBatchRequest
object
Request object to update catalogs hotel items
5 properties
4 required
CatalogsCreativeAssetsBatchItem
object
Creative assets batch item
Country
string
Country ID from ISO 3166-1 alpha-2.
BatchOperationStatus
string
The status of the operation performed by the batch
CatalogsCreativeAssetsItemErrorResponse
object
Object describing a creative assets item error
3 properties
1 required
UpdateMaskFieldType
string
The field types supported by the update mask
CatalogsCreativeAssetsItemResponse
object
Object describing a hotel record
4 properties
1 required
CatalogsItemsBatch
object
Object describing the catalogs items batch
1 property
1 required
PinMediaSourcePinURL
object
Pin URL-based media source for product pin creation. Currently the field is only available to a list of beta users.
2 properties
1 required
CatalogsRetailItemsPostFilter
object
3 properties
2 required
CatalogsRetailItemsBatch
object
Object describing the catalogs retail items batch
6 properties
1 required
PinMediaSourceImagesURL
object
Multiple images urls-based media source
3 properties
1 required
CatalogsItemsDeleteBatchRequest
object
Request object to delete catalogs items
4 properties
4 required
CatalogsHotelAddress
object
5 properties
CatalogsUpsertHotelItem
object
A hotel item to be upserted.
3 properties
3 required
PinMediaSource
Pin media source.
CatalogsItemsFilters
object
1 property
1 required
CatalogsRetailBatchRequest
object
A request object that can have multiple operations on a single retail batch
4 properties
4 required
Error
object
2 properties
2 required
CatalogsUpdateRetailItem
object
An item to be updated
4 properties
3 required
Language
string
Language code, which is among the offical ISO 639-1 language list.
CatalogsItemsBatchRequest
object
Request object of catalogs items batch
PinMediaSourceImagesBase64
object
Multiple Base64-encoded images media source
3 properties
1 required
CatalogsDeleteCreativeAssetsItem
object
A creative assets item to be deleted
2 properties
2 required
CreativeAssetsProcessingRecord
object
Object describing an item processing record
4 properties
BatchOperation
string
The operation performed by the batch. The DELETEDISCONTINUED operation only updates availablity to "Out of Stock".
CatalogsRetailItemResponse
object
Object describing a retail item record
4 properties
1 required
CatalogsCreativeAssetsItemsPostFilter
object
3 properties
2 required
CatalogsRetailItemErrorResponse
object
Object describing a retail item error
3 properties
1 required
PinMediaSourceVideoID
object
Video ID-based media source
6 properties
2 required
CatalogsHotelItemsFilter
object
3 properties
2 required
ItemDeleteDiscontinuedBatchRecord
object
Object describing an item batch record to discontinue items
1 property
PinMediaSourceImageURL
object
Image URL-based media source
3 properties
2 required
ItemValidationEvent
object
Object describing an item validation event
3 properties
ItemCreateBatchRecord
object
Object describing an item batch record to create items
2 properties
CatalogsUpsertRetailItem
object
An item to be upserted
3 properties
3 required
CatalogsHotelItemsPostFilter
object
3 properties
2 required
ItemDeleteBatchRecord
object
Object describing an item batch record to delete items
1 property
CreativeType
string
Ad creative type enum. For update, only draft ads may update creative type. Note: SHOPTHEPIN has been deprecated. Please use COLLECTION instead.
ItemResponse
object
Object describing an item record
ItemProcessingStatus
string
The status of the item processing record
CatalogsCreativeAssetsItemsFilter
object
3 properties
2 required
CatalogsUpsertCreativeAssetsItem
object
A creative assets item to be upserted.
3 properties
3 required
CatalogsItemsPostFilters
object
1 property
1 required
CatalogsCreativeAssetsItemsBatch
object
Object describing the catalogs creative assets items batch
6 properties
1 required
CatalogsType
string
Type of the catalog entity.
CatalogsUpdatableCreativeAssetsAttributes
object
12 properties
CatalogsHotelItemResponse
object
Object describing a hotel record
4 properties
1 required
CatalogsCreativeAssetsAttributes
object
HotelProcessingRecord
object
Object describing an item processing record
4 properties
CatalogsItemsRequest
object
Request object of catalogs items
3 properties
3 required
BoardOwner
object
1 property
ItemUpsertBatchRecord
object
Object describing an item batch record to upsert items
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Pinterest publishes across the network.
