younifyd
Menu

Post Products Uuid Search

Search list of products

POST/api/rest/v1/products-uuid/search

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Post Products Uuid Search action (under Product [uuid]).
  3. Fill in the fields below, then reference the result from later steps as {{postProductsUuidSearch.response.data}}.

Request

Query parameters

pagination_typestring

Specify which pagination method to use for navigating through large datasets. It is useful for choosing between different pagination strategies based on your specific use case and performance requirements. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

One ofpagesearch_afterDefault "page"

pageinteger

Specify which page of results to retrieve when using pagination. It is useful for navigating through large datasets by breaking them into smaller, manageable pages. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default 1

search_afterstring

Cursor when using the `search_after` pagination method type. It is essential for navigating through pages in cursor-based pagination, providing more efficient pagination for large datasets. Should never be set manually, see [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default "cursor to the first page"

limitinteger

Specify the maximum number of results to return per page. It is useful for controlling the amount of data returned in a single request, especially when dealing with large datasets. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default 10

with_countboolean

Return the count of items in the response. Be careful with that, on a big catalog, it can decrease performance in a significant way. It is useful for understanding the size of the dataset being returned, especially when dealing with large collections. Use it judiciously to avoid performance issues.

Default false

Request body

Enter the body as JSON in the step's Body field.

searchstring

Stringified JSON to filter products, for more details see the [Filters](https://api.akeneo.com/documentation/filter.html) section.

scopestring

Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the [Filter product values via channel](https://api.akeneo.com/documentation/filter.html#via-channel) section.

localesstring

Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the [Filter product values via locale](https://api.akeneo.com/documentation/filter.html#via-locale) section.

attributesstring

Filter product values to only return those concerning the given attributes, for more details see the [Filter product values via attributes](https://api.akeneo.com/documentation/filter.html#via-attributes) section.

convert_measurementsboolean

Convert measurement attribute values to the appropriate unit for the channel provided by the "scope" parameter.

Default false

with_attribute_optionsboolean

Return labels of attribute options in the response. See [the `linked_data` format](https://api.akeneo.com/concepts/products.html#the-linked_data-format) section for more details.

with_asset_share_linksboolean

Whether to return asset collection share link URLs in the response. See [the `linked_data` format](https://api.akeneo.com/concepts/products.html#the-linked_data-format) for more details.

with_quality_scores__productsboolean

Return product quality scores in the response

with_readinessstring

Return product readiness in the response. `scores_only` returns percentage scores only; `detailed` also returns unmet requirements. Readiness is currently in beta and is available by request only. If you would like to participate, please reach out to your Customer Success Manager.

One ofscores_onlydetailed

with_completenessesboolean

Return product completenesses in the response

with_workflow_execution_statusesboolean

Return an array of workflow_execution_statuses in the response

json
{
  "search": "{\"completeness\":[{\"operator\": \"=\", \"value\": 100, \"scope\":\"ecommerce\"}]}",
  "scope": "ecommerce",
  "locales": "en_US,fr_FR",
  "attributes": "name,description",
  "convert_measurements": true,
  "with_attribute_options": true,
  "with_asset_share_links": true,
  "with_quality_scores__products": true,
  "with_readiness": "detailed",
  "with_completenesses": true,
  "with_workflow_execution_statuses": true
}

Response

Returns 200 with an object. Read it in later steps with {{postProductsUuidSearch.response.data.<field>}}.

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.