catalogFeed
Version 2024-04-01
Overview
Returns a CatalogFeed. Each catalog feed represents a bulk data import operation on Buy with Prime products.
Required scope(s)
Create and View Catalog Batches
Response
Return type CatalogFeed
Arguments
| Argument | Description |
|---|---|
catalogFeedId (String required) | Identifies an existing catalog feed to fetch. |
Examples
Query Catalog Feed In Progress
Request
query catalogFeed {
catalogFeed(catalogFeedId: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111") {
id
status
result {
signals {
code
signalMessage {
locale
message
}
impactSummary {
locale
message
}
reactionSummary {
locale
message
}
}
resultReport {
... on UploadedFile {
fileId
}
}
}
}
}
Response
{
"data": {
"catalogFeed": {
"id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"status": "IN_PROGRESS",
"result": {
"signals": null,
"resultReport": null
}
}
}
}
Query Catalog Feed Created
Request
query catalogFeed {
catalogFeed(catalogFeedId: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111") {
id
status
result {
signals {
code
signalMessage {
locale
message
}
impactSummary {
locale
message
}
reactionSummary {
locale
message
}
}
resultReport {
... on UploadedFile {
fileId
}
}
}
}
}
Response
{
"data": {
"catalogFeed": {
"id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"status": "CREATED",
"result": {
"signals": null,
"resultReport": null
}
}
}
}
Query Catalog Feed Completed
Request
query catalogFeed {
catalogFeed(catalogFeedId: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111") {
id
status
result {
signals {
code
signalMessage {
locale
message
}
impactSummary {
locale
message
}
reactionSummary {
locale
message
}
}
resultReport {
... on UploadedFile {
fileId
}
}
}
}
}
Response
{
"data": {
"catalogFeed": {
"id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"status": "COMPLETED",
"result": {
"signals": [],
"resultReport": {
"fileId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}
}
}
}
}
Query Catalog Feed
Request
query catalogFeed {
catalogFeed(catalogFeedId: "p65d7gks0ja3f9") {
id
status
result {
issues {
id
status
localizedMessage {
language
content
}
}
resultReport {
... on UploadedFile {
fileId
}
}
}
}
}
Response
{
"data": {
"catalogFeed": {
"id": "p65d7gks0ja3f9",
"status": "COMPLETED",
"result": {
"issues": [],
"resultReport": {
"fileId": "66d8bef0-726e-4c17-a8f1-87640116e9b2"
}
}
}
}
}
Query Catalog Feed Faulted
Request
query catalogFeed {
catalogFeed(catalogFeedId: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111") {
id
status
result {
signals {
code
signalMessage {
locale
message
}
impactSummary {
locale
message
}
reactionSummary {
locale
message
}
}
resultReport {
... on UploadedFile {
fileId
}
}
}
}
}
Response
{
"data": {
"catalogFeed": {
"id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"status": "FAULTED",
"result": {
"signals": [],
"resultReport": null
}
}
}
}
Query Catalog Feed Failed
Request
query catalogFeed {
catalogFeed(catalogFeedId: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111") {
id
status
result {
signals {
code
signalMessage {
locale
message
}
impactSummary {
locale
message
}
reactionSummary {
locale
message
}
}
resultReport {
... on UploadedFile {
fileId
}
}
}
}
}
Response
{
"data": {
"catalogFeed": {
"id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"status": "FAILED",
"result": {
"signals": [
{
"code": "MissingRequiredColumn",
"signalMessage": {
"locale": "en",
"message": "Missing required column for External ID."
},
"impactSummary": {
"locale": "en",
"message": "The catalog feed could not be imported."
},
"reactionSummary": {
"locale": "en",
"message": "Ensure that the file you uploaded is a CSV file that uses the correct CSV template. https://amazon-omni-cdn.com/static/catalog/CreateCatalogFeed-template.csv"
}
}
],
"resultReport": null
}
}
}
}
Updated 23 days ago