Feeds Resource

All of the Feeds endpoints are supported by this SDK.

Calling the method for the endpoint will return a data transfer object from the Jasara\AmznSPA\DataTransferObjects\Responses\Feeds namespace. Read more about responses.

getFeeds

Usage

$response = $spa->feeds->getFeeds(
    feed_types: ['POST_PRODUCT_DATA'], 
    marketplace_ids: ['ATVPDKIKX0DER'],
); // GetFeedsResponse

Parameters

Parameter Type Examples Description
feed_types
Optional
array<string> ['JSON_LISTINGS_FEED'] A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.
marketplace_ids
Optional
array<string> ['ATVPDKIKX0DER'] A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.
page_size
Optional
integer 10 The maximum number of feeds to return in a single call.
processing_statuses
Optional
array<string> (enum) 10 A list of processing statuses used to filter feeds. See valid values.
created_since
Optional
CarbonImmutable CarbonImmutable::now()->subDays(10); The earliest feed creation date and time for feeds included in the response. The default is 90 days ago. Feeds are retained for a maximum of 90 days.
created_until
Optional
CarbonImmutable CarbonImmutable::now()->subDays(5); The latest feed creation date and time for feeds included in the response. The default is now.
next_token
Optional
string VGhpcyB0b2tlbiBpcyBvcGFxdWUgYW5kIGludGVudGlvbmFsbHkgb2JmdXNjYXRlZA A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.

Payload: feeds/GetFeedsResponse

Key Type Examples Description
feeds array<schema> FeedListSchema The feeds.
FeedListSchema.* array<schema> FeedSchema A list of feeds
FeedSchema.feed_id string FeedId1 The identifier for the feed. This identifier is unique only in combination with a seller ID.
FeedSchema.feed_type string POST_PRODUCT_DATA The feed type.
FeedSchema.marketplace_ids array<string> ['ATVPDKIKX0DER'] A list of identifiers for the marketplaces that the feed is applied to.
FeedSchema.created_time CarbonImmutable A CarbonImmutable instance The date and time when the feed was created
FeedSchema.processing_status string (enum) CANCELLED The processing status of the feed. See valid values.
FeedSchema.processing_start_time CarbonImmutable A CarbonImmutable instance The date and time when feed processing started
FeedSchema.processing_end_time CarbonImmutable A CarbonImmutable instance The date and time when feed processing completed
FeedSchema.result_feed_document_id string amzn1.tortuga.3.example-1234 The identifier for the feed document. This identifier is unique only in combination with a seller ID.
next_token string VGhpcyB0b2tlbiBpcyBvcGFxdWUgYW5kIGludGVudGlvbmFsbHkgb2JmdXNjYXRlZA Returned when the number of results exceeds pageSize. To get the next page of results, call the getFeeds operation with this token as the only parameter.