/v2/publishers/{publisherId}/markets/{marketId}/products/search

POST

https://<pcm-domain>/v2/publishers/{publisherId}/markets/{marketId}/products/search

Retrieves filtered products for a publisher and market.

Omit the from attribute in the request body for retrieving the first set of products. The response includes a value for the next attribute whenever there are more products to retrieve. Use this next value as a value for the from attribute in the subsequent request in order to retrieve another set of products.

Filter fields:

GTIN - product id, exact match
BRAND - product brand, exact match
CATEGORY_ID - product category id, exact match
REMOVED - whether to include products being removed from the feed or not, true/false

Notes:

By default, products removed from the feed are not returned. Filtering allows including them explicitly. Pass both false and true as values in the filters.values JSON array in order to include both current and removed products.

Path Parameters

publisherIdinteger<int32>required
Format
int32
marketIdinteger<int32>required
Format
int32

Body Parameters

bodyProductSearchCursorRequestrequired
- filtersFilterValuesProductFilterField[]
  - fieldstring<GTIN | BRAND | CATEGORY_ID | REMOVED>
    Allowed
    GTINBRANDCATEGORY_IDREMOVED
  - valuesobject[]
- limitinteger<int32>required
  Format
  int32
  Minimum
  1
  Maximum
  10000
- fromstring
  Min Length
  0
  Max Length
  1000
  Pattern
  ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Responses

200OK

CursorResponseProductResponse
- detailedProductResponse[]
  - gtinstring
  - productGroupIdstring
  - titlestring
  - brandstring
  - imageUrlstring
  - pricenumber
  - priceSalenumber
  - priceCurrencystring
  - availabilitystring<IN_STOCK | IN_STOCK_REGIONAL | OUT_OF_STOCK | REMOVED>
    Allowed
    IN_STOCKIN_STOCK_REGIONALOUT_OF_STOCKREMOVED
  - productCategoriesIdNameResponse[]
    - idinteger<int32>
      Format
      int32
    - namestring
  - removedboolean
- nextstring

401Unauthorized

403Forbidden

404Not Found

ExceptionResponse
- messagesstring[]

422Unprocessable Entity

ExceptionResponse
- messagesstring[]

curl

curl --request POST \
     --url https://<pcm-domain>/v2/publishers/{publisherId}/markets/{marketId}/products/search \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "limit": 0
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "limit": 0
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://<pcm-domain>/v2/publishers/{publisherId}/markets/{marketId}/products/search", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://<pcm-domain>/v2/publishers/{publisherId}/markets/{marketId}/products/search")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "limit": 0
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://<pcm-domain>/v2/publishers/{publisherId}/markets/{marketId}/products/search"

payload = json.dumps({
   "limit": 0
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "detailed": [
    {
      "gtin": "",
      "productGroupId": "",
      "title": "",
      "brand": "",
      "imageUrl": "",
      "price": 0,
      "priceSale": 0,
      "priceCurrency": "",
      "availability": "",
      "productCategories": [
        {
          "id": "",
          "name": ""
        }
      ],
      "removed": false
    }
  ],
  "next": ""
}

401

// Unauthorized

403

// Forbidden

404

// Not Found
{
  "messages": [
    ""
  ]
}

422

// Unprocessable Entity
{
  "messages": [
    ""
  ]
}