We will sunset v2 of the Content API on March 29th, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible. For more information, see Migrating to v2.1.

REST Resource: collectionstatuses

Resource: CollectionStatus

The collectionstatus message.

JSON representation
{
  "id": string,
  "destinationStatuses": [
    {
      object (DestinationStatus)
    }
  ],
  "creationDate": string,
  "lastUpdateDate": string,
  "collectionLevelIssuses": [
    {
      object (ItemLevelIssue)
    }
  ]
}
Fields
id

string

Required. The ID of the collection for which status is reported.

destinationStatuses[]

object (DestinationStatus)

The intended destinations for the collection.

creationDate

string

Date on which the collection has been created in ISO 8601 format: Date, time, and offset, e.g. "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"

lastUpdateDate

string

Date on which the collection has been last updated in ISO 8601 format: Date, time, and offset, e.g. "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"

collectionLevelIssuses[]

object (ItemLevelIssue)

A list of all issues associated with the collection.

DestinationStatus

Destination status message.

JSON representation
{
  "destination": string,
  "status": string
}
Fields
destination

string

The name of the destination

status

string

The status for the specified destination.

ItemLevelIssue

Issue associated with the collection.

JSON representation
{
  "code": string,
  "servability": string,
  "resolution": string,
  "attributeName": string,
  "destination": string,
  "description": string,
  "detail": string,
  "documentation": string
}
Fields
code

string

The error code of the issue.

servability

string

How this issue affects the serving of the collection.

resolution

string

Whether the issue can be resolved by the merchant.

attributeName

string

The attribute's name, if the issue is caused by a single attribute.

destination

string

The destination the issue applies to.

description

string

A short issue description in English.

detail

string

A detailed issue description in English.

documentation

string

The URL of a web page to help with resolving this issue.

Methods

get

Gets the status of a collection from your Merchant Center account.

list

Lists the statuses of the collections in your Merchant Center account.