ProductStatuses Resource

Article
11/13/2024

Note

The Store resource is available to closed-beta participants only. For information about participating in the closed-beta or open-beta program, please contact your account manager.

All Store programming elements and documentation are subject to change during the beta.

Use the ProductStatuses resource to get the status of product offers in a store.

Base URI

The following is the base URI that you append the templates to.

https://content.api.ads.microsoft.com/v9.1/bmc

For example, to get a summary view of the status of product offers in a store, use the following endpoint:

https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary

Templates

These are the templates that you append to the base URI to create an HTTP endpoint.

/stores/{merchantId}/productstatusessummary

HTTP Verb	Description	Resource
Get	Gets a summary view of the status of product offers in a store. The service returns the number of offers that are approved, disapproved, and expiring in the store. Set `{merchantId}` to the ID of the store to get the statuses from. It may take up to two hours from the time an offer's status changes to the time it's reflected in the summary view.	Request: N/A Response: ProductStatusesSummary

/stores/{merchantId}/productstatuses

HTTP Verb	Description	Resource
Get	Gets a detail view of the status of product offers in a store. Details are returned only for products with a status of Disapproved or Warning. Set `{merchantId}` to the ID of the store that you want to get the statuses from. The max-results query parameter determines the number of offers that the service returns. To page through all offers, use the continuation-token query parameter.	Request: N/A Response: ProductStatuses

Query parameters

The request may include the following query parameters:

Parameter Description

max-results Optional. Use to specify the maximum number of items to return in a List request such as /stores/{merchantId}/productstatuses. The maximum value that you may specify is 250. The default is 25.

continuation-token Optional. Use to page through a store's list of product statuses. The token identifies the next page of product statuses to return. Do not specify this parameter in the first List request. If the store contains more than the requested number of products (see the max-results query parameter), the response includes the nextPageToken field. In the next request, set continuation-token to the token value in nextPageToken.

Parameter	Description
max-results	Optional. Use to specify the maximum number of items to return in a List request such as `/stores/{merchantId}/productstatuses`. The maximum value that you may specify is 250. The default is 25.
continuation-token	Optional. Use to page through a store's list of product statuses. The token identifies the next page of product statuses to return. Do not specify this parameter in the first List request. If the store contains more than the requested number of products (see the max-results query parameter), the response includes the `nextPageToken` field. In the next request, set continuation-token to the token value in `nextPageToken`.

Headers

The following are the request and response headers.

Header	Description
AuthenticationToken	Request header. Set this header to an OAuth access token. For information about getting an access token, see Authenticating your credentials.
Content-Type	Request header. All POST requests must specify this header and it must be set to `application/json`.
CustomerAccountId	Request header. The account ID of any account that you manage on behalf of the customer specified in the `CustomerId` header. It doesn't matter which account you specify. Specify this header only if you manage an account on behalf of the customer.
CustomerId	Request header. The customer ID of the customer whose store you manage. Specify this header only if you manage the store on behalf of the customer. If you set this header, you must also set the `CustomerAccountId` header.
DeveloperToken	Request header. The client application's developer token. Each request must include this header. For information about getting a token, see Do you have your Microsoft Advertising credentials and developer token?
WebRequestActivityId	Response header. The ID of the log entry that contains details of the request. You should always capture this ID if an error occurs. If you are not able to determine and resolve the issue, include this ID along with the other information that you provide the Support team.

Request and response objects

The following are the request and response objects used by the API.

Object	Description
Error	Defines an error.
ErrorResponse	Defines the top-level error object.
ProductStatus	Defines a product offer's status.
ProductStatuses	Defines a list of the product offers that have issues.
ProductStatusesSummary	Defines a summary view of the status of product offers in a store.
ProductStatusItemLevelIssue	Defines an issue with the product offer.

Error

Defines an error.

Name	Value	Type
code	The reason why the request failed.	String
message	A description of the error.	String

ErrorResponse

Defines the top-level error object.

Name	Value	Type
errors	A list of errors that occurred while processing the request.	Error[]

ProductStatus

Defines a product offer's status.

Name	Value	Type
creationDate	The date and time when the product offer was created.	DateTime
expirationDate	The date and time when the product offer is set to expire.	DateTime
itemLevelIssues	The list of issues with the product offer.	ProductStatusItemLevelIssue[]
lastUpdateDate	The date and time when the product offer was last updated.	DateTime
productId	The product's ID.	String
status	The product's approval status. Possible values are: Disapproved Warning Disapproved products are not served. Warnings indicate that the product has issues that you should address but they don't prevent the product offer from serving. You should fix the issues and resubmit the product offer.	String
title	The product's title	String