{"info":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","description":"

Welcome to the Plytix PIM API documentation.

What is Plytix PIM?

PIM stands for Product Information Management. It is a platform where you can centralize, optimize, distribute and analyze your product content. If you are interested in learning more about what a PIM is and what Plytix can do for you, we created this handy guide What is PIM.

What is Plytix PIM API for?

The Plytix Rest API allows you to integrate your PIM solution with third party tools. Using this API you will be able to manage different aspects of your PIM solution in an automated fashion.

This document lists the available operations and some examples on how to use this API.

API Limits

There is a limit to the number of requests which can be made for a client within a certain time interval. If this limit is reached, all subsequent requests to the API will return an 429 error code until the time interval expires.

Every single request counts as a 'hit' and the system will check if the following conditions are met:

Client has not reached 'requests per 10 seconds' limit
\n
Client has not reached 'request per hour' limit
\n

Plytix has different plan types with their corresponding rate limits for the API. All rate limits are applied based on your account plan. These limits are enforced on all the resources available in the API.

API limits are based on your account plan, you can check your limits at Plytix Pricing Page or contacting your account manager.

Authentication

The PIM API uses Bearer Token authentication to check user's credentials on each request, so a token must be provided in the header for all requests in order to use this API.

Credentials can be issued by any of your Plytix account administrators under the \"API\" tab of the account's Admin section.

To obtain a valid token you must supply your API credentials (API key and password) by sending a POST request to https://auth.plytix.com/auth/api/get-token. Every token has a life-time of 15 minutes and a new token must be obtained after that period.

If a token cannot be verified, a 401 error will be issued and a new token must be requested.

More info about using/managing tokens, error codes and formats can be found in the authentication section further down in this guide.

HTTP Status Codes

The API has been built around a small subset of standard HTTP status codes.
The current version of this interface is limited to codes shown in the table below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Comment
200 OK	The request has succeeded. Response body will usually contain a representation of the resource
201 CREATED	The request has succeeded and a resource has been created. Response body will usually contain a representation of the resource and its location will be available in the 'location' tag in the response header
202 ACCEPTED	Request has been accepted but will be finished at some point in the future
204 NO CONTENT	Request has been fulfilled. No Response
400 BAD REQUEST	Invalid syntax in the request
401 AUTH FAILED	Request has not been applied because it lacks valid authentication credentials for the target resource
403 FORBIDDEN	Server understood the request but refuses to authorize it
404 NOT FOUND	Requested resource has not been found in the server
405 METHOD NOT ALLOWED	HTTP method is not allowed in target resource
409 CONFLICT	Request was understood by the server but has no effect on the current status of the resource
422 UNPROCESSABLE ENTITY	Request is syntactically well formed but has semantic errors
428 Precondition Required	Request could not be processed because some conditions are not met
429 TOO MANY REQUESTS	API Rate limit has been exceeded
500 SERVER ERROR	Server wasn't able to fulfill the request. Client can repeat the request later.

Resources

Plytix API is built around resources, a resource defines its data, operations and relationships with other resources. This section contains an overview of the available resources in this version of the API. A more detailed description, including formats, parameters and examples can be found in each resource section.

All requests and responses in this API must use '''application/json''' format, so every request has to set appropiate headers like

Content-Type: application/json\nAccept: application/json\nAuthorization: Bearer {{your_token_value}}\n\n

Successful responses

Successful responses from the API are always wrapped in a result object.
A result object is compound of:

data: List of items returned from the API.
\n
pagination: Only in search operations
\n
attributes: When necessary, we must supply the column we want to be returned from API.
\n

When an operation returns no data, an empty list will be returned

Examples

1.- No result response: https://pim.plytix.com/api/v1/assets/000000000000000000000000

{\n    \"data\": []\n}\n\n

2.- Single result response: https://pim.plytix.com/api/v1/assets/123456789012345678901234

{\n    \"data\": [\n        {\n            \"file_size\": 30358,\n            \"file_type\": \"TEXTS\",\n            \"filename\": \"example.pdf\",\n            \"id\": \"123456789012345678901234\",\n            \"thumb\": \"https://static.plytix.com/static/pim/img/filetypes/filetype_pdf.png\",\n            \"url\": \"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/texts/28/c9/fa/5b/5bfac92851e7590001486762/example.pdf\"\n        }\n    ]\n}\n\n

3.- Multiple result response: https://pim.plytix.com/api/v1/assets/123456789012345678901234

{\n    \"data\": [\n        {\n            \"filename\": \"blue_mug.png\",\n            \"id\": \"5bfac7d851e7590001486761\",\n            \"thumbnail\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/blue_mug.png\",\n            \"url\": \"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/blue_mug.png\"\n        },\n        {\n            \"filename\": \"blue_mug_big.jpeg\",\n            \"id\": \"5bfaced551e7590001486763\",\n            \"thumbnail\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/blue_mug_big.jpeg\",\n            \"url\": \"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/blue_mug_big.jpeg\"\n        }\n    ]\n}\n\n

Handling Errors

Whenever an operation fails, an error object is returned.

An error object consists of:

msg: General error message
\n
errors : Optional array field containing detailed information of each error
\n
- field: Offending column, field, etc.
  \n
- msg: Detailed message, if any, of the error
  \n
\n

Examples

1.- Simple error message

{\n     \"error\": {\n        \"msg\": \"Missing Authorization Header\"\n     }\n}\n\n

2.- Detailed error

{\n    \"error\": {\n        \"msg\": \"product data validation failed\",\n        \"errors\": [\n            {\n                \"field\": \"some_non-existing_attribute_to_patch\",\n                \"msg\": \"label does not exist\"\n            },\n            {\n                \"field\": \"some_decimal_number_attribute_to_patch_using_wrong_number_format\",\n                \"msg\": \"Not a valid decimal value. Format must be: .\"\n            }\n        ]\n    }\n}\n\n

Assets

This resource deals with the creation, deletion or query to assets (files) in your account.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint	Description	Actions
/assets	Allows uploading of new assets to your account	POST
/assets/id	Operations on an specific asset	GET DELETE
/assets/search	Filter assets by multiple criteria	POST

Available Filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint	Description	Actions
/filters/asset	Available asset fields	GET
/filters/products	Available product fields	GET
/filters/relationships	Available relationships fields	GET

Endpoint	Description	Actions
/categories/file	Add new category	POST
/categories/file/id	Operations on subcategories of category id	POST PATCH DELETE
/categories/file/search	Filter categories by multiple criteria	POST

Endpoint	Description	Actions
/categories/product	Add new category	POST
/categories/product/id	Operations on subcategories of category id	POST PATCH DELETE
/categories/product/search	Filter categories by multiple criteria	POST

Products

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint	Description	Actions
/products	Creation of new products	POST
/products/id	Operations on an specific product	GET PATCH DELETE
/products/id/variants	List and creation of variants of a product.	GET POST
/products/id/variant/id	Operations on a specific variant	POST DELETE
/products/id/variants/resync	Resync variants attribute values	POST
/products/id/family	Assign family to a product	POST
/products/id/assets	Link of account assets to product	GET POST
/products/id/assets/id	Operations over linked assets	GET DELETE
/product/id/categories	Category assignment to product	GET POST
/products/id/categories/id	Operations on a specific category	GET DELETE
/products/id/relationships/id	Add related products to current product	POST
/products/id/relationships/id/unlink	Remove related products from current product	PATCH
/products/id/relationships/id/products/id	Operations on related product	PATCH
/products/search	Filter products by multiple criteria	POST

Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint	Description	Actions
/relationships	Creation of new relationships	POST
/relationships/id	Operations on an specific product	GET PATCH DELETE
/relationships/search	Filter relationships by multiple criteria	POST

Product families

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint	Description	Actions
/product_families	Creation of new product families	POST
/product_families/id	Operations on an specific product family	GET PATCH DELETE
/product_families/search	Filter product families by multiple criteria	POST
/product_families/id/attributes/link	Add new attributes to a family	POST
/product_families/id/attributes/unlink	Removes attributes from a family	POST
/product_families/id/attributes	Retrieves the product family attributes	GET
/product_families/id/all_attributes	Retrieves the product family attributes including system attributes	GET

Filtered searches

Advanced search is possible by means of the search resource.
Every search resource requires:

(Mandatory) Set of conditions that must be met; AND and OR filters are supported.
\n
Columns to be retrieved. Search filters are limited to 50 columns
\n
Pagination
\n

Filter Conditions

Simple filter

A simple filter is defined by three fields, two of which are mandatory.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Mandatory	Type
field	label of the field	YES	string
operator	operation to be performed	YES	string
value	value of the operation		String/Array/Object

Example
Search for products whose stock is over 10:

{\"field\": \"stock\", \"operator\": \"gt\", \"value\": 10}\n\n

Compound filter

A compound filter is a list of simple filters. Every filter in the list is treated as an AND condition

Example
Search products whose stock is over 10 AND from any vendor containing text \"ACME\"

[\n    {\"field\": \"stock\", \"operator\": \"gt\", \"value\": 10},\n    {\"field\": \"vendor\", \"operator\": \"like\", \"value\": \"ACME\"}\n]\n\n

Filter

A filter is a list of compound filters, every item in this list acts as an OR condition

Example

Search products that:

a) whose stock is over 10 AND from any vendor containing text \"ACME\"

b) customer is \"Wile E. Coyote\"

[\n    [  {\"field\": \"stock\", \"operator\": \"gt\", \"value\": 10} , {\"field\": \"vendor\", \"operator\": \"like\", \"value\": \"ACME\"}],\n    [  {\"field\": \"customer\", \"operator\": \"eq\", \"value\": \"Wile E. Coyote\"}  ]\n]\n\n

Standard filter operators

The common filter operators are detailed in the table below, keep in mind that some operators are not allowed on certain filters.
Certain filters can have additional operators which are detailed within in its own filters/resource section.

Note: Item used in the table below can refer to an attribute, property, field, etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operator	Arity	Type	Description
exists	Unary	-	Existence check. True when the item has its value defined
!exists	Unary	-	Non-existence check. True when the item has its value undefined
eq	Binary	value	Equality check. True if the item has the same value as the one provided When applied to a text value, the comparison is ignoring case
!eq	Binary	value	Inequality check. False if the item has the same value as the one provided When applied to a text value, the comparison ignores case
like	Binary	value	Contains check. Check if supplied string is contained within value
in	Binary	list	Match check. Determines if the value matches any of the values specified in the list Note: Multiselect and Dropdown attributes are case sensitive
!in	Binary	list	Do not match check. Determines if the value doesn't match any of the values specified in the list Note: Multiselect and Dropdown attributes are case sensitive
gt	Binary	value	Greater than. True if items' value is greater than provided
gte	Binary	value	Greater or equal than. True if items' value is greater or equal than provided
lt	Binary	value	Greater than. True if items' value is greater than provided
lte	Binary	value	Less or equal than. True if items' value is greater than provided
text_search	Binary	value	Text search Allows the user searching for text in several items Item list must be provided as \"field\" value

Pagination

The first page of a search is returned by default, it's possible to modify this behaviour including a pagination field in the search body

Pagination object is defined as

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Type
page	page number to retrieve	Integer
page_size	items per page	Integer
order	sort order of element	String

The \"Order\" field is a compound string in the form [ /-][ATTRIBUTE]. By default the order is ascending or if [-] then descending. The [ATTRIBUTE] is the Label of the column

Attributes

Search endpoints returns only a small subset of all available attributes by default, so in order to get desired attributes in searches,
they have to be specified in the attributes field of the filters.

There's a limit of 20 attributes that can be retrieved per search. If you need more than 20 attributes in the search result, we recommend you just get product IDs from the search and then iterate through each product to get more than 20 attributes.

Examples

1: Get default attributes and return default page (1) with default items per page (25) using default order (no order)

 {\n     \"filters\":[\n        [\n            {\"field\":\"modified\",\"operator\":\"gt\",\"value\":\"2018-11-01\"},\n            {\"field\":\"modified\",\"operator\":\"lt\",\"value\":\"2018-11-30\"}\n        ],\n        [\n            {\"field\":\"short_text\",\"operator\":\"like\",\"value\":\"unicorn\"}\n        ]\n     ]\n}\n\n

2: Return default attributes of page (1) with default items per page (25) using default order (no order) of product attributes SKU, Label and Stock

 {\n     \"attributes\":[\"sku\", \"label\", \"stock\"]\n }\n\n

3: Return page 3 of products modified [ between November the 1st AND November the 30th] OR [ contains the literal 'unicorn' ] ordered by SKU descending of the
following attributes: [\"modified\", \"stock\", \"description\", \"categories\"]

 {\n    \"filters\":[\n        [\n            {\"field\":\"modified\",\"operator\":\"gt\",\"value\":\"2018-11-01\"},\n            {\"field\":\"modified\",\"operator\":\"lt\",\"value\":\"2018-11-30\"}\n        ],\n        [\n            {\"field\":\"short_text\",\"operator\":\"like\",\"value\":\"unicorn\"}\n        ]\n    ],\n    \"pagination\":{\"order\":\"-sku\",\"page\":3,\"page_size\":25}},\n    \"attributes\":[\"modified\", \"stock\", \"description\", \"categories\"]\n}\n\n

Headers

Custom headers to give extra information in the response

\n\n\n\n\n\n\n\n\n\n\n\n\n

key	Description
X-Plytix-Deprecation	This header is sent in the response when the used endpoint is going to be deprecated soon.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"What is Plytix PIM?","slug":"what-is-plytix-pim"},{"content":"What is Plytix PIM API for?","slug":"what-is-plytix-pim-api-for"},{"content":"API Limits","slug":"api-limits"},{"content":"Authentication","slug":"authentication"},{"content":"HTTP Status Codes","slug":"http-status-codes"},{"content":"Resources","slug":"resources"}],"owner":"42465620","collectionId":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","publishedId":"2sBXijJrz3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-23T10:26:03.000Z"},"item":[{"name":"authentication","item":[{"name":"Retrieves an authentication token","id":"32e4c9a1-a303-44bd-ad6a-d02108ab95b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"your.api.key\",\n \"api_password\": \"your.secret.api.password\"\n}\n"},"url":"https://auth.plytix.com/auth/api/get-token","description":"

Plytix PIM API relies on {{vault:bearer-token}} to check a user's credentials, so a token must be provided in the header of requests in order to use this API.

Credentials can be issued by any of your Plytix account administrators, under the \"API\" tab of the account's admin section.

Then a POST request must be made to https://auth.plytix.com/auth/api/get-token using the following format:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Mandatory	Type
api_key	API key	YES	string
api_password	API password	YES	string

Upon a successful result, you can find your token in the data array. Then you must include it in the header section of every request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

CODE
200 OK	The request has succeeded. A valid token can be found in response body
400 BAD REQUEST	There was an error in the request, please check body request and try again
401 UNAUTHORIZED	Bad user name or password. If the problem persists contact help@plytix.com

Authorization: Bearer {{your_token_value}}\n

Please note that capitalization of Bearer must be respected and there is a space between your token and the literal Bearer

Request and response example.

POST /auth/api/get-token HTTP/1.1\nContent-Type: application/json\n{\n    \"api_key\": \"my_apy_key\" , \n    \"api_password\":\"my secret password\"\n}\n\n200 OK\n{\n  data: [\n            {  \"access_token\": \"token data\" } \n       ]\n}\n\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"9e2d9d59-7494-41be-b1b6-6b73fd2d29c6","id":"9e2d9d59-7494-41be-b1b6-6b73fd2d29c6","name":"authentication","type":"folder"}},"urlObject":{"protocol":"https","path":["auth","api","get-token"],"host":["auth","plytix","com"],"query":[],"variable":[]}},"response":[{"id":"557f1f7f-f17a-43a5-8e46-ca1159a5db79","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"}],"body":{"mode":"raw","raw":"{ \"api_key\": \"your.api.key\", \"api_password\": \"your.secret.api.password\" }\n"},"url":"https://auth.plytix.com/auth/api/get-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"access_token\": \"your access token. It expires after 15 minutes and a fresh one must be obtained. Note that 'Bearer 'literal (mind the space character after the word Bearer) IS NOT in your token and must be added by your application\"\n }\n ]\n}"},{"id":"23bc684c-ca33-4ec6-88b0-40267065cba9","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"your.api.key\",\n \"api_password\": \"your.secret.api.password\"\n}\n"},"url":"https://auth.plytix.com/auth/api/get-token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad api_key or api_password\"\n}"}],"_postman_id":"32e4c9a1-a303-44bd-ad6a-d02108ab95b5"}],"id":"9e2d9d59-7494-41be-b1b6-6b73fd2d29c6","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7f95a315-7f87-4930-9594-688289aea65b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2ac4faea-2488-4a76-9f65-f3b9eb27c0a8"}}],"_postman_id":"9e2d9d59-7494-41be-b1b6-6b73fd2d29c6","description":""},{"name":"accounts","item":[{"name":"Membership search","id":"f2a71761-c2ae-41e1-abf2-d8dbd5c88c4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [\n [\n {\"field\": \"role\", \"operator\": \"eq\", \"value\": \"ADMIN\"}\n ]\n ],\n \"attributes\": [\"username\", \"role\", \"name\", \"last_name\", \"legacy_id\"],\n \"pagination\": {\n \"page\": 1,\n \"page_size\": 5\n }\n}"},"url":"https://pim.plytix.com/api/v1/accounts/memberships/search","description":"

Filter memberships by multiple criteria

The filter structure and format are described in the Resources section of this guide. Sorting is not supported. The following fields can be used as attributes and filters. If no attributes are specified, all fields are returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
legacy_id	User ID in PIM
role	Membership role: one of ADMIN, OWNER and USER
email	User’s email address
username	Unique user identifier (e.g., name)
Name	User's first name
last_name	User's last name

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [\n [\n {\"field\": \"role\", \"operator\": \"eq\", \"value\": \"ADMIN\"}\n ]\n ],\n \"attributes\": [\"legacy_id\", \"name\", \"role\"],\n \"pagination\": {\n \"page\": 1,\n \"page_size\": 5\n }\n}"},"url":"https://pim.plytix.com/api/v1/accounts/api-credentials/search","description":"

Filter API credentials by multiple criteria

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
legacy_id	API Credential ID in PIM
role	User role: one of ADMIN, OWNER and USER
Name	API credential name

This section contains resources related to your account.

\n","_postman_id":"aa7be0dd-45d4-4ad0-9747-cbac46965a4d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"assets","item":[{"name":"asset","item":[{"name":"Modify selected attributes of an asset","id":"7d34846d-1e20-4865-962d-214fad4febc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filename\": \"new_asset_filename.png\",\n \"categories\": [\n {\n \"id\": \"5c3f6697d08a07000171c4de\"\n },\n {\n \"id\": \"5c489c15f4b8950001378041\"\n }\n ]\n}"},"url":"https://pim.plytix.com/api/v1/assets/:asset_id","description":"

Modifies attributes from asset and leaves the rest unchanged.

Current version supports the modification of the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
filename	string	New file name for the asset. File extension change is not allowed
categories	array	Array containing categories objects Each category is defined as follows { \"id\": category_id }

","urlObject":{"protocol":"https","path":["api","v1","assets",":asset_id"],"host":["pim","plytix","com"],"query":[],"variable":[{"type":"any","value":"{{asset_id}}","key":"asset_id"}]}},"response":[{"id":"6d6ee547-bf4e-40c6-9ff7-d595f7ecb21e","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filename\": \"new_asset_filename.png\",\n \"categories\": [\n {\n \"id\": \"5c3f6697d08a07000171c4de\"\n },\n {\n \"id\": \"5c489c15f4b8950001378041\"\n }\n ]\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/assets/:asset_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","assets",":asset_id"],"variable":[{"key":"asset_id","value":"{{asset_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"assigned\": true,\n \"categories\": [\n {\n \"id\": \"5c3f66add08a07000171c4e0\"\n },\n {\n \"id\": \"5c3f6697d08a07000171c4de\"\n },\n {\n \"id\": \"5c489c15f4b8950001378041\"\n }\n ],\n \"content_type\": \"image/png\",\n \"created\": \"2019-01-21T09:29:48.127000+00:00\",\n \"extension\": \"png\",\n \"file_modified\": \"2019-01-21T09:29:48.127000\",\n \"file_size\": 532360,\n \"file_type\": \"IMAGES\",\n \"filename\": \"new_asset_filename.png\",\n \"id\": \"5c45910c0a3d5c000155aa62\",\n \"modified\": \"2019-01-21T09:33:58.170000+00:00\",\n \"n_catalogs\": 1,\n \"n_products\": 115,\n \"status\": \"ACTIVE\",\n \"thumbnail\": \"https://files.plytix.com/api/v1.1/thumb/bird.png\",\n \"url\": \"https://files.plytix.com/api/v1.1/file/assets/bird.png\"\n }\n ]\n}"},{"id":"ee93ecd4-7a33-4f3a-a30e-7742a9ea9673","name":"400 Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"malformed_json\": true,\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/assets/:asset_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","assets",":asset_id"],"variable":[{"key":"asset_id","value":"{{asset_id}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"msg\": \"The browser sent a request that this server could not understand.\"\n }\n}"},{"id":"c8bb6e34-6892-4fb7-b62d-9390d333306a","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filename\": \"new_asset_filename.png\",\n \"categories\": [\n {\n \"id\": \"5c3f6697d08a07000171c4de\"\n },\n {\n \"id\": \"5c489c15f4b8950001378041\"\n }\n ]\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/assets/:asset_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","assets",":asset_id"],"variable":[{"key":"asset_id","value":"{{asset_id}}"}]}},"code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"errors\": [\n {\n \"field\": \"asset_id\",\n \"msg\": \"asset does not exist\"\n }\n ],\n \"msg\": \" No results found for 000000000000000000000000\"\n }\n}"},{"id":"59182dc8-73b4-4f5f-8f39-e2e25a013568","name":"422 Unprocessable Entity","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filename\": \"new_asset_filename.jpg\"\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/assets/:asset_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","assets",":asset_id"],"variable":[{"key":"asset_id","value":"{{asset_id}}"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"errors\": [\n {\n \"field\": \"filename\",\n \"msg\": \"Extension changes are not allowed\"\n }\n ],\n \"msg\": \"Extension changes are not allowed\"\n }\n}"}],"_postman_id":"7d34846d-1e20-4865-962d-214fad4febc8"},{"name":"Get account's asset","id":"c25db0b6-54f5-4079-a528-c5d9ac8f4a5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/assets/:asset_id","description":"

Get one asset from this account

\n","urlObject":{"protocol":"https","path":["api","v1","assets",":asset_id"],"host":["pim","plytix","com"],"query":[],"variable":[{"type":"any","value":"{{asset_id}}","key":"asset_id"}]}},"response":[{"id":"3c9e8b45-b8af-4675-b8c5-e4334063d770","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"url":{"raw":"https://pim.plytix.com/api/v1/assets/:asset_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","assets",":asset_id"],"variable":[{"key":"asset_id","value":"{{asset_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"assigned\": true,\n \"categories\": [\n {\n \"id\": \"5c3f66add08a07000171c4e0\"\n }\n ],\n \"content_type\": \"image/png\",\n \"created\": \"2019-01-21T09:29:48.127000+00:00\",\n \"extension\": \"png\",\n \"file_modified\": \"2019-01-21T09:29:48.127000\",\n \"file_size\": 532360,\n \"file_type\": \"IMAGES\",\n \"filename\": \"3536.png\",\n \"id\": \"5c45910c0a3d5c000155aa62\",\n \"modified\": \"2019-01-21T09:33:58.170000+00:00\",\n \"n_catalogs\": 1,\n \"n_products\": 115,\n \"status\": \"ACTIVE\",\n \"thumbnail\": \"https://files.plytix.com/api/v1.1/thumb/3536.jpg\",\n \"url\": \"https://files.plytix.com/api/v1.1/file/3536.jpg\"\n }\n ]\n}"},{"id":"8d08f10e-f862-4751-a009-edf4fc5fb577","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"url":{"raw":"https://pim.plytix.com/api/v1/assets/:asset_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","assets",":asset_id"],"variable":[{"key":"asset_id","value":"{{asset_id}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"msg\": \"The browser sent a request that this server could not understand.\"\n }\n}"},{"id":"140b39cf-1989-4f71-9f19-b6aafd97d4e6","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"url":{"raw":"https://pim.plytix.com/api/v1/assets/:asset_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","assets",":asset_id"],"variable":[{"key":"asset_id","value":"{{asset_id}}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"msg\": \" No results found for 000000000000000000000000\",\n \"errors\": [\n {\n \"msg\": \"asset does not exist\",\n \"field\": \"asset_id\"\n }\n ]\n }\n}"},{"id":"85bd66e8-92e8-47b2-b78e-297366dd7cb9","name":"422 Unprocessable Entity","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"url":{"raw":"https://pim.plytix.com/api/v1/assets/:asset_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","assets",":asset_id"],"variable":[{"key":"asset_id","value":"{{asset_id}}"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"msg\": \"There was an error loading this asset, please contact support\",\n \"errors\": [\n {\n \"msg\": \"validation error\",\n \"field\": \"asset\"\n }\n ]\n }\n}"}],"_postman_id":"c25db0b6-54f5-4079-a528-c5d9ac8f4a5a"},{"name":"Remove asset from account","id":"00ff49d5-6352-4a1e-be7e-0eb895ea25d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/assets/:asset_id","description":"

Removes an asset from this account

Here you can find all available requests related to an specific asset in your PIM.

\n","_postman_id":"f48783d1-22ce-4db5-950d-e6502c94ef51","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"Add new assets","id":"b780cb66-6716-43a8-ae5d-d906ec6140d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filename\": \"kettle_blue.jpg\",\n \"url\": \"https://www.plytix.com/hubfs/Kitchen%20and%20Home%20Products/Enjoy%20Mug%20-%20Blue.jpg\"\n}"},"url":"https://pim.plytix.com/api/v1/assets","description":"

Upload a new asset to your account

There are two methods for uploading assets to the system:

By specifying an url
By supplying the content of the asset

Both methods are described in this document

Upload an asset by url

This method allows you to specify an url, the system then tries to download it and\nadd it to your account.\nThere are a few issues that must be taken into account:

url must be publicly accessible
file must be one of the supported file types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory
*url*	string	yes
filename	string

If no filename is specified, the filename of the asset in the url will be used.

NOTE: This system DOES NOT convert files between formats and if different\nfile format of the requested url and filename are used there could be problems

Upload an asset by filename and content

This method allows you to upload an asset by sending its content (base64 format) in the body of the request.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory
*content*	string	yes
*filename*	string	yes

NOTE: Content field must contain only image data, stripping data:image/XXX;base64,

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [],\n \"attributes\": [\"modified\", \"filename\"],\n \"pagination\": {\n \"order\": \"modified\",\n \"page\": 1,\n \"page_size\": 5\n }\n}"},"url":"https://pim.plytix.com/api/v1/assets/search","description":"

Filter assets by multiple criteria

Filter structure and format is described under Resources section in this guide

Restrictions

Search filters will return a 428 status code if the filtered results include more than 10000 assets and the order field is filled.

This section contains resources related to Assets.

Each asset has the following structure:\nDepending on the operation, some of those parameters are mandatory or optional or not being returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
assigned	Indicates if this asset is used in products or catalogs
categories	Categories related to this asset
content_type	Media type of the resource
created	Creation date in ISO 8061 format
extension	File extension
filename	Name, including extension, of the file
file_size	Size in bytes of the file
file_type	type(s) of the file
has_custom_thumb	Boolean flag for non-image file types, indicates user-defined thumbnail instead of the autogenerated one
id	Asset identifier
modified	Last modification date in ISO 8061 format
n_catalogs	Show how many catalogs are linked this asset
n_products	Show how many products are linked to this asset
status	Active or inactive
thumbnail	Url to the asset thumbnail
type	Asset type*, multiple values are supported
url	url of this asset

Assets are grouped in the following types:

IMAGES : All supported image file formats
FEED_FILES : Feed files: .json, .xml
COMPRESSED : All supported compressed file formats
REPORTS : All supported report file formats
TEXTS : All supported text file formats
SOUNDS : All supported audio file formats
VIDEOS : All supported video file formats
OTHER : Other supported file formats

Note: an asset could belong to more than one group, for example CSV files is both a TEXT and REPORT file

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2d7ff379-1021-4e1c-908c-86ad88321093"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6ff33fed-9d8c-4248-bc70-e74009c8dd7f"}}],"_postman_id":"8fcbdce3-8586-437b-b1ea-6d04091b67e0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"available filters","item":[{"name":"Get available asset filters","id":"7df97add-68bf-4aac-b9ab-bfe6631c5656","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/filters/asset","description":"

Get a list of available asset filters

This endpoint lists the available search fields when filtering assets and operations that can be carried on each field.\nFor a description of every field returned from this endpoint, please check Asset section in this guide.

This endpoint DOES NOT support the use of the \"TEXT_SEARCH\" operator

A complete list of operators and their meanings is available in the main section of filters.

NOTE:The most up-to-date list of attributes and operations is always returned for this endpoint.

\n","urlObject":{"protocol":"https","path":["api","v1","filters","asset"],"host":["pim","plytix","com"],"query":[],"variable":[]}},"response":[{"id":"6a7bf4f8-6037-4967-b1bc-677d8d5b77e2","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"url":"https://pim.plytix.com/api/v1/filters/asset"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": [\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"status\",\n \"operators\": [\n \"like\",\n \"eq\",\n \"!eq\"\n ]\n },\n {\n \"filter_type\": \"MultiSelectAttribute\",\n \"key\": \"file_type\",\n \"operators\": [\n \"in\",\n \"!in\"\n ],\n \"options\": [\n \"IMAGES\",\n \"SOUNDS\",\n \"VIDEOS\",\n \"COMPRESSED\",\n \"REPORTS\",\n \"TEXTS\",\n \"OTHER\"\n ]\n },\n {\n \"filter_type\": \"BooleanAttribute\",\n \"key\": \"assigned\",\n \"operators\": [\n \"eq\"\n ]\n },\n {\n \"filter_type\": \"DecimalAttribute\",\n \"key\": \"file_size\",\n \"operators\": [\n \"eq\",\n \"!eq\",\n \"gt\",\n \"gte\",\n \"lt\",\n \"lte\"\n ]\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"id\",\n \"operators\": [\n \"eq\",\n \"!eq\",\n \"in\",\n \"!in\"\n ]\n },\n {\n \"filter_type\": \"HierarchyAttribute\",\n \"key\": \"categories\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"in\",\n \"!in\"\n ]\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"extension\",\n \"operators\": [\n \"like\",\n \"eq\",\n \"!eq\"\n ]\n },\n {\n \"filter_type\": \"DateAttribute\",\n \"key\": \"created\",\n \"operators\": [\n \"eq\",\n \"gt\",\n \"gte\",\n \"lt\",\n \"lte\"\n ]\n },\n {\n \"filter_type\": \"DateAttribute\",\n \"key\": \"modified\",\n \"operators\": [\n \"eq\",\n \"gt\",\n \"gte\",\n \"lt\",\n \"lte\"\n ]\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"filename\",\n \"operators\": [\n \"like\",\n \"eq\",\n \"!eq\"\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"7df97add-68bf-4aac-b9ab-bfe6631c5656"},{"name":"Get available product filters","id":"104b96c8-29a2-4422-933b-42f88d436a2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/filters/product","description":"

This endpoint lists the available search fields when filtering products and operations that can be carried on each field.
A complete list of operators and their meanings is available in the main section of filters.

System attributes

All products have a predefined set of system attributes shown below:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
created	Product creation date in ISO 8601 format
modified	Product last modification date in ISO 8601 format
sku	Product identifier
gtin	Global Trade Number (GTIN). This only accept valid GTIN formats
label	Product label
status	Available statuses: [Draft, Completed]
categories	Product category identifiers (id)
static_lists	Available product lists
assets	Assets related to this product
images	Images related to this product, always a subset of assets
thumbnail	Product thumbnail
product_level	The inheritance level of the product, commonly known as the product type. Choices (as integers): 0 (single), 1 (parent), 2 (variant) and 3 (sub-variant).

\n
\"sub-variant\" will only be available if the account has the variants level 3 feature enabled. Consult your account manager for more information.
\n

Custom attributes

User defined attributes are returned too by this endpoint, they can be easily identified as all user attribute is always
prefixed with the literal attributes..

For example, an attribute named color defined as multiselect with the following values Blue, Purple, White, Beige, and Orange will be returned as:

{ \n    \"filter_type\": \"MultiSelectAttribute\", \n    \"key\": \"attributes.color\", \n    \"operators\": [ \"exists\", \"!exists\", \"in\", \"!in\" ],\n    \"options\": [ \"Blue\", \"Purple\", \"White\", \"Beige\", \"Orange\" ]\n}\n\n

Available properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`_is_variation`	True if a product is a variant
`_has_variations`	True if a product is a base product

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","filters","product"],"host":["pim","plytix","com"],"query":[],"variable":[]}},"response":[{"id":"93056717-cf24-4296-ac2f-fae6900e7451","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"url":"https://pim.plytix.com/api/v1/filters/product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": [\n {\n \"filter_type\": \"DecimalAttribute\",\n \"key\": \"attributes.price_create_a_decimal_number_type_attribute\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"eq\",\n \"!eq\",\n \"gt\",\n \"gte\",\n \"lt\",\n \"lte\"\n ]\n },\n {\n \"filter_type\": \"DropdownAttribute\",\n \"key\": \"attributes.dropdown\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"eq\",\n \"!eq\",\n \"in\",\n \"!in\"\n ],\n \"options\": [\n \"1\",\n \"2\",\n \"3\",\n \"4\"\n ]\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"attributes.description_create_a_rich_text_type_attribute\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"like\",\n \"eq\",\n \"!eq\"\n ]\n },\n {\n \"filter_type\": \"MultiSelectAttribute\",\n \"key\": \"attributes.color_create_a_multiselect_type_attribute\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"in\",\n \"!in\"\n ],\n \"options\": [\n \"Blue\",\n \"Purple\",\n \"White\",\n \"Beige\",\n \"Orange\"\n ]\n },\n {\n \"filter_type\": \"MultiSelectAttribute\",\n \"key\": \"attributes.multiselect\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"in\",\n \"!in\"\n ],\n \"options\": [\n \"option 1\",\n \"option 2\",\n \"option 3\"\n ]\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"attributes.att_1\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"like\",\n \"eq\",\n \"!eq\"\n ]\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"attributes.17\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"like\",\n \"eq\",\n \"!eq\"\n ]\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"attributes.att20\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"like\",\n \"eq\",\n \"!eq\"\n ]\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"sku\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"like\",\n \"eq\",\n \"!eq\"\n ]\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"key\": \"label\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"like\",\n \"eq\",\n \"!eq\"\n ]\n },\n {\n \"filter_type\": \"MultiSelectAttribute\",\n \"key\": \"categories\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"in\",\n \"!in\"\n ],\n \"options\": []\n },\n {\n \"filter_type\": \"MultiSelectAttribute\",\n \"key\": \"static_lists\",\n \"operators\": [\n \"in\"\n ],\n \"options\": []\n },\n {\n \"filter_type\": \"MediaAttribute\",\n \"key\": \"assets\",\n \"operators\": [\n \"exists\",\n \"!exists\"\n ]\n },\n {\n \"filter_type\": \"MediaAttribute\",\n \"key\": \"images\",\n \"operators\": [\n \"exists\",\n \"!exists\"\n ]\n },\n {\n \"filter_type\": \"MediaAttribute\",\n \"key\": \"thumbnail\",\n \"operators\": [\n \"exists\",\n \"!exists\"\n ]\n },\n {\n \"filter_type\": \"DateAttribute\",\n \"key\": \"modified\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"eq\",\n \"gt\",\n \"gte\",\n \"lt\",\n \"lte\"\n ]\n },\n {\n \"filter_type\": \"DateAttribute\",\n \"key\": \"created\",\n \"operators\": [\n \"exists\",\n \"!exists\",\n \"eq\",\n \"gt\",\n \"gte\",\n \"lt\",\n \"lte\"\n ]\n },\n {\n \"filter_type\": \"DropdownAttribute\",\n \"key\": \"status\",\n \"operators\": [\n \"eq\",\n \"in\",\n \"!in\"\n ]\n }\n ],\n \"properties\": [\n {\n \"filter_type\": \"BooleanAttribute\",\n \"key\": \"_is_variation\",\n \"operators\": [\n \"eq\"\n ]\n },\n {\n \"filter_type\": \"BooleanAttribute\",\n \"key\": \"_has_variations\",\n \"operators\": [\n \"eq\"\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"104b96c8-29a2-4422-933b-42f88d436a2e"},{"name":"Get available relationships filters","id":"81f52ee7-28f6-4623-976d-b520c63a048e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://pim.plytix.com/api/v1/filters/relationships","description":"

Get a list of available relationship filters

This endpoint lists the available search fields when filtering relationships and operations that can be carried out in each field.\nFor a description of every field returned from this endpoint, please check the Relationships section in this guide.

This endpoint DOES NOT support the use of the \"TEXT_SEARCH\" operator

A complete list of operators and their meanings is available in the main section of filters.

NOTE: The most up-to-date list of attributes and operations is always returned for this endpoint.

This section contains resources related to filters.

Advanced searches must specify a set of filters (more on filters \ncan be found under Resources). A simple filter is defined by three fields, \ntwo of which are mandatory and the third one depends on the operator.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Mandatory	Type
key	label of the field	YES	string
operator	operation to be performed	YES	string
value	value of the operation		String/Array/Object

In order to be able to build such filters, fields and available operators for each field must be known and thats the \npoint of all resources listed in this section.

Standard filter operators

Common operators are shown in the table below, some operations are not allowed for every filter.

A complete list of available fields and allowed operations can be obtained by requesting a GET on\nits own filters/resource section.

Note: Item used in the table below can refer to an attribute, property, field, etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operator	Arity	Type	Description
exists	Unary	-	Existence check. True when the item has its value defined
!exists	Unary	-	Non-existence check. True when the item has its value undefined
eq	Binary	value	Equality check. True if the item has the same value as the one provided When applied to a text value, the comparison ignores case
!eq	Binary	value	Inequality check. False if the item has the same value as the one provided When applied to a text value, the comparison is ignoring case
like	Binary	value	Contains check. Check if supplied string is contained within value
in	Binary	list	Match check. Determines if the value matches any of the values specified in the list Note: Multiselect and Dropdown attributes are case sensitive
!in	Binary	list	Do not match check. Determines if the value doesn't match any of the values specified in the list Note: Multiselect and Dropdown attributes are case sensitive
gt	Binary	value	Greater than. True if items' value is greater than provided
gte	Binary	value	Greater or equal than. True if items' value is greater or equal than provided
lt	Binary	value	Greater than. True if items' value is greater than provided
lte	Binary	value	Less or equal than. True if items' value is greater than provided
text_search	Binary	value	Text search Allows the user to search for text in several items Item list must be provided as \"field\" value

Response structure

Suscessful responses from filter endpoints are always wrapped in a result data object :

data: List of items returned from the API:
- attributes: List of attributes objects.
- properties: List of meta properties objects
\n

Both attributes and properties objects share structure, which is compound of:

key: key of the field, this is what must be used in \"field\"
operators: List of available operators for this field
options: Optional, list allowed values for fields with a limited subset or values
filter_type: Type of the filter, mainly informative

You can find some response examples in each endpoint

Filter operator examples

This section shows a small example of each operator.

[exists] Get items whose thumbnail is defined

{\"filters\": [\n            [ {\"field\":\"thumbnail\",\"operator\":\"exists\"} ] \n          ]}\n

[!exists] Get items whose thumbnail is not defined

{\"filters\": [       \n            [ {\"field\":\"thumbnail\",\"operator\":\"!exists\"} ]\n          ]}\n

[eq] Get items whose sku is Sample - 001

{\"filters\": [ \n            [ \n                {\"field\":\"sku\",\"operator\":\"eq\", \"value\":\"Sample - 001\"}\n            ]\n          ]}\n

[!eq] Get items whose stock is not equal to 123

{\"filters\": [ \n            [ \n                {\"field\":\"attributes.stock\",\"operator\":\"!eq\", \"value\":123}\n            ]\n          ]}\n

[like] Get items whose name contains \"sample\" in any position

{\"filters\": [ \n            [ \n                {\"field\":\"attributes.name\",\"operator\":\"like\", \"value\":\"sample\"}\n            ]\n          ]}\n

[in] Get items belonging to, at least, one of the specified categories

{\"filters\": [ \n            [ \n                {\"field\":\"categories\", \"operator\":\"in\", \"value\":[\"5c4ed7f62f0985001c233277\",\"5c4ed7f62f0985001c233278\",\"5c4ed7f62f0985001c233279\"]}  \n            ]\n          ]}\n

[!in] Get items not having, at least, one of the specified values

{\"filters\": [ \n            [ \n                {\"field\": \"attributes.multiselect\", \"operator\": \"!in\", \"value\": [\"option 1\", \"option 3\"]}\n            ]\n          ]}\n

[gt] Get items whose price is greater than 120

{\"filters\": [ \n            [ \n                {\"field\": \"attributes.price\", \"operator\": \"gt\", \"value\": 120}\n            ]\n          ]}\n

[gte] Get items whose price is greater than or equal to 120

{\"filters\": [ \n            [ \n                {\"field\": \"price\", \"operator\": \"gte\", \"value\": 120}\n            ]\n          ]}\n

[lt] Get items whose price is less than 120

{\"filters\": [ \n            [ \n                {\"field\": \"attributes.price\", \"operator\": \"lt\", \"value\": 120}\n            ]\n          ]}\n

[lte] Get items whose price is less than or equal to 120

{\"filters\": [ \n            [ \n                {\"field\": \"attributes.price\", \"operator\": \"lte\", \"value\": 120}    \n            ]\n          ]}\n

Get items whose price is greater than or equal to 100 AND less than 120
We need a compound filter with an AND condition so:

{\"filters\": [ \n            [ \n                {\"field\": \"attributes.price\", \"operator\": \"gte\", \"value\": 100 },\n                {\"field\": \"attributes.price\", \"operator\": \"lt\", \"value\": 120}\n            ]\n          ]}\n

Get items whose \n a) price is greater than or equal to 100 AND less than 120\n OR b) sku is Sample - 001

{\"filters\": [ \n            [ \n                {\"field\": \"price\", \"operator\": \"gte\", \"value\": 100 },\n                {\"field\": \"price\", \"operator\": \"lt\", \"value\": 120}\n            ],\n            [\n                {\"field\":\"sku\",\"operator\":\"eq\", \"value\":\"Sample - 001\"}\n            ]\n          ]}\n

[text_search] Get items containing 'kettle' in any of 'sku' or 'label' fields

{\"filters\": [\n             [\n                {\"field\":[\"sku\",\"label\"],\"operator\":\"text_search\",\"value\":\"kettle\"}     \n              ]\n          ]}\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2459da24-ed8a-40c4-a2c0-03eeef175096"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3db7dc67-4e25-4c16-a03d-b9b6113627be"}}],"_postman_id":"33658a0c-1fa8-4332-a215-afd8cd77aaff","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"categories","item":[{"name":"assets","item":[{"name":"asset","item":[{"name":"Add new file subcategory","id":"3c66d169-608f-425d-94ba-fa5f762f57c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Kitchen Sinks\"\n}"},"url":"https://pim.plytix.com/api/v1/categories/file/:category_id","description":"

Add a new sub-category under an existing category

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/categories/file/:category_id","description":"

Using this verb you can change some of the properties of any category.

Allowed properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
name	Category name
parent_id	New parent category id. Use emtpy string to make it root category
sort_children	Reorder subcategories

Note: parent_id and sort_children are not allowed in the same request.

Moving Categories

Convert to root category (a.k.a first level categories)

You must issue a patch request to https://pim.plytix.com/api/v1/categories/file/categoryId (see examples) specifiying parent_id as empty string, i.e. {\"parent_id\": \"\"}

Move as subcategory of another category

You must issue a patch request to https://pim.plytix.com/api/v1/categories/file/categoryId (see examples) specifiying parent_id as new parent category id, i.e. {\"parent_id\": \"new parent category here\"}

Sorting Categories

Sorting Root Categories

When patching root categories (a.k.a first level categories) only reorder is allowed and must be done under the special endpoint https://pim.plytix.com/api/v1/categories/file/root, 200 status code is returned upon successful response and empty data array is returned.

Sorting Subcategories

A patch request must be issued to parent ID category including in its body a dictionary with ALL subcategories in desired order, you are not allowed to make partial orders or add new categories or this operations will return 422 error code.

{ 'sort_children': [ subcategory_ids ]\n

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","categories","file",":category_id"],"host":["pim","plytix","com"],"query":[],"variable":[{"type":"any","value":"{{category_id}}","key":"category_id"}]}},"response":[{"id":"69c0f150-6e9e-450e-9a3e-f72ddeecef84","name":"Change parent category","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"parent_id\": \"5cfa0ee53da03100019ba910\"\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/categories/file/:category_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","categories","file",":category_id"],"variable":[{"key":"category_id","value":"{{category_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa0c1e3da03100019ba90f\",\n \"modified\": \"2019-06-07T07:16:44.586830+00:00\",\n \"n_children\": 0,\n \"name\": \"Acme\",\n \"order\": \"1\",\n \"parents_ids\": [\n \"5cfa0ee53da03100019ba910\"\n ],\n \"path\": [\n \"Packshots\",\n \"Acme\"\n ],\n \"slug\": \"acme\"\n }\n ]\n}"},{"id":"bfeefbac-ea54-4392-a80d-d2e1567dd465","name":"Convert into root category","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"parent_id\": \"\"\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/categories/file/:category_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","categories","file",":category_id"],"variable":[{"key":"category_id","value":"{{category_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa0c1e3da03100019ba90f\",\n \"modified\": \"2019-06-07T07:18:53.490242+00:00\",\n \"n_children\": 0,\n \"name\": \"Packshots\",\n \"order\": \"7\",\n \"parents_ids\": [],\n \"path\": [\n \"Packshots\"\n ],\n \"slug\": \"packshots\"\n }\n ]\n}"},{"id":"f3ebfa6b-8942-4fad-83e6-604bc9d23178","name":"Change category name","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Packshots small\"\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/categories/file/:category_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","categories","file",":category_id"],"variable":[{"key":"category_id","value":"{{category_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa0c1e3da03100019ba90f\", \n \"modified\": \"2019-06-07T07:05:06.959196+00:00\", \n \"n_children\": 0, \n \"name\": \"Packshots small\", \n \"order\": \"1\", \n \"parents_ids\": [\n \"5cfa05273da03100019ba90e\"\n ], \n \"path\": [\n \"Packshots smalls\"\n ], \n \"slug\": \"packshots-small\"\n }\n ]\n}\n"},{"id":"9e7ad2d1-2f7f-4fb1-8ed4-aa44314971c2","name":"Sort root categories","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"sort_children\": [\n \"5cf69f4d568c1c001c039c76\",\n \"5cf4d55eb694740001006ed1\",\n \"5cf69f4d568c1c001c039c7a\",\n \"5cf9f06d53f18e0001006e6d\",\n \"5cfa05273da03100019ba90e\",\n \"5cfa0ee53da03100019ba910\",\n \"5cfa0c1e3da03100019ba90f\",\n \"5cfa10893da03100019ba911\"\n ]\n}"},"url":"https://pim.plytix.com/api/v1/categories/file/root"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {}\n ]\n}"},{"id":"b7e08e9d-fdc9-4dc5-a13d-c8aaaf602efa","name":"Sort subcategories","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"sort_children\": [\n \"5cfa10a13da03100019ba913\",\n \"5cfa10973da03100019ba912\",\n \"5cfa10a83da03100019ba914\"\n ]\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/categories/file/:category_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","categories","file",":category_id"],"variable":[{"key":"category_id","value":"{{category_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa10893da03100019ba911\",\n \"modified\": \"2019-06-07T07:21:45.967000+00:00\",\n \"n_children\": 3,\n \"name\": \"Marketing Logos\",\n \"order\": \"8\",\n \"parents_ids\": [],\n \"path\": [\n \"Marketing Logos\"\n ],\n \"slug\": \"marketing-logos\"\n }\n ]\n}"}],"_postman_id":"324b93e5-4ed4-4e34-8de2-c6de86b9864c"},{"name":"Delete category","id":"eb04c6ee-577e-4170-b97a-f722c349c013","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/categories/file/:category_id","description":"

Deletes a category and all its subcategories.

WARNING All subcategories will be removed too.

If you want to preserve some of the subcategories, it's mandatory you move them before deleting parent category.

A 204 response is returned upon success.

If category to be deleted, or any of its subcategories, is used as root category in some E-Catalog a 409 response code will be returned. Please look at https://help.plytix.com/designing-e-catalogs for more information on E-Catalogs and filters

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{ \n\t\"attributes\": [\n \"name\",\n \"n_children\"\n ],\n \"filters\": [\n [\n {\n \"field\": \"parent_id\",\n \"operator\": \"!exists\"\n }\n ]\n ],\n \"pagination\": {\n \"page_size\": 25,\n \"page\": 1,\n \"order\": \"order\"\n }\n}"},"url":"https://pim.plytix.com/api/v1/categories/file/search","description":"

Filter on available file categories by multiple criteria

Filter structure and format is described under Resources section in this guide

Current version of the API supports the following set of fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
id	Category id is always returned by default
name	Category friendly name
path	Category full path
parents_ids	Array of ordered parent categories
n_children	Number of subcategories in the current category
order	Position of current category in parent category

Restrictions

Search requests
- Search filters MUST include all necessary columns (except ID which is returned by default). If an attribute is not explicitly requested it won’t be returned by the API.\nAvailable attributes can be obtained by means of the available https://pim.plytix.com/api/v1/filters/ endpoint. “key” value is what MUST be used in requests.\nRequesting non-existing attributes will return a 422 error code\nYou are allowed to sort by columns not included in “attributes” field, however this attribute won’t be returned
  \n
- Search filters will return a 422 error code if any of the following conditions is met:\na) Field does not exist\nb) Operator is not allowed for the given field (available operators and fields can be obtained using /filters/{item} endpoint)\nc) Value has no meaning for the given operator. The arity of available operators can be found in API documentation
  \n
- Pagination: the number of items that can be requested (pagination.page_size) is limited to a maximum 100 items. \n A 422 code will be returned from API if this limit is exceeded. If pagination is omitted 25 items of the first page will be returned
  \n
\n

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Marketing logos\"\n}"},"url":"https://pim.plytix.com/api/v1/categories/file","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","categories","file"],"host":["pim","plytix","com"],"query":[],"variable":[]}},"response":[{"id":"94f227dc-b06a-4a4e-8bf0-d6cec0cf80ff","name":"Add duplicate name file category","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Marketing logos\"\n}"},"url":"https://pim.plytix.com/api/v1/categories/file"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"errors\": [\n {\n \"field\": \"name\",\n \"msg\": \"already exists\"\n }\n ],\n \"msg\": \"Marketing logos already exists\"\n }\n}"},{"id":"2f212177-a65a-4555-abf5-aa0124756b98","name":"Add new file first category","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Marketing logos\"\n}"},"url":"https://pim.plytix.com/api/v1/categories/file"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa05273da03100019ba90e\",\n \"modified\": \"2019-06-07T06:33:11.965893+00:00\",\n \"n_children\": 0,\n \"name\": \"Marketing logos\",\n \"order\": \"2\",\n \"parents_ids\": [],\n \"path\": [\n \"Marketing logos\"\n ],\n \"slug\": \"marketing-logos\"\n }\n ]\n}"}],"_postman_id":"915139eb-a5c9-4edc-9037-95eba4948578"}],"id":"c570ca14-6683-499a-a0ac-340638361728","_postman_id":"c570ca14-6683-499a-a0ac-340638361728","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"products","item":[{"name":"product","item":[{"name":"Add new product subcategory","id":"a23068d9-a656-4dbf-8e77-971981ef9f66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Kitchen Sinks\"\n}"},"url":"https://pim.plytix.com/api/v1/categories/product/:category_id","description":"

Add a new sub-category under an existing category

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/categories/product/:category_id","description":"

Using this verb you can change some of the properties of any category.

Allowed properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
name	Category name
parent_id	New parent category id. Use emtpy string to make it root category
sort_children	Reorder subcategories

Note: parent_id and sort_children are not allowed in the same request.

Moving Categories

Convert to root category (a.k.a first level categories)

You must issue a patch request to https://pim.plytix.com/api/v1/categories/product/categoryId (see examples) specifiying parent_id as empty string, i.e. {\"parent_id\": \"\"}

Move as subcategory of another category

You must issue a patch request to https://pim.plytix.com/api/v1/categories/product/categoryId (see examples) specifiying parent_id as new parent category id, i.e. {\"parent_id\": \"new parent category here\"}

Sorting Categories

Sorting Root Categories

When patching root categories (a.k.a first level categories) only reorder is allowed and must be done under the special endpoint https://pim.plytix.com/api/v1/categories/product/root, 200 status code is returned upon successful response and empty data array is returned.

Sorting Subcategories

{ 'sort_children': [ subcategory_ids ]\n

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","categories","product",":category_id"],"host":["pim","plytix","com"],"query":[],"variable":[{"type":"any","value":"{{category_id}}","key":"category_id"}]}},"response":[{"id":"5730c9c5-c065-4b87-a28c-c8c9a39efbc7","name":"Sort subcategories","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"sort_children\": [\n \"5cfa10a13da03100019ba913\",\n \"5cfa10973da03100019ba912\",\n \"5cfa10a83da03100019ba914\"\n ]\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/categories/product/:category_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","categories","product",":category_id"],"variable":[{"key":"category_id","value":"{{category_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa10893da03100019ba911\",\n \"modified\": \"2019-06-07T07:21:45.967000+00:00\",\n \"n_children\": 3,\n \"name\": \"Bathroom faucets\",\n \"order\": \"8\",\n \"parents_ids\": [],\n \"path\": [\n \"Bathroom faucets\"\n ],\n \"slug\": \"bathroom-faucets\"\n }\n ]\n}"},{"id":"d712f3a9-9657-484c-93ac-599fbde8e06e","name":"Convert into root category","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"parent_id\": \"\"\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/categories/product/:category_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","categories","product",":category_id"],"variable":[{"key":"category_id","value":"{{category_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa0c1e3da03100019ba90f\",\n \"modified\": \"2019-06-07T07:18:53.490242+00:00\",\n \"n_children\": 0,\n \"name\": \"Apron Bamboo\",\n \"order\": \"7\",\n \"parents_ids\": [],\n \"path\": [\n \"Apron Bamboo\"\n ],\n \"slug\": \"apron-bamboo\"\n }\n ]\n}"},{"id":"49e87c58-4301-41fe-a77a-13ee62996000","name":"Sort root categories","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"sort_children\": [\n \"5cf69f4d568c1c001c039c76\",\n \"5cf4d55eb694740001006ed1\",\n \"5cf69f4d568c1c001c039c7a\",\n \"5cf9f06d53f18e0001006e6d\",\n \"5cfa05273da03100019ba90e\",\n \"5cfa0ee53da03100019ba910\",\n \"5cfa0c1e3da03100019ba90f\",\n \"5cfa10893da03100019ba911\"\n ]\n}"},"url":"https://pim.plytix.com/api/v1/categories/product/root"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {}\n ]\n}"},{"id":"3793800e-ccf7-4d92-a7f0-73587ff67ebb","name":"Change parent category","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"parent_id\": \"5cfa0ee53da03100019ba910\"\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/categories/product/:category_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","categories","product",":category_id"],"variable":[{"key":"category_id","value":"{{category_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa0c1e3da03100019ba90f\",\n \"modified\": \"2019-06-07T07:16:44.586830+00:00\",\n \"n_children\": 0,\n \"name\": \"Apron Bamboo\",\n \"order\": \"1\",\n \"parents_ids\": [\n \"5cfa0ee53da03100019ba910\"\n ],\n \"path\": [\n \"Bamboo\",\n \"Apron Bamboo\"\n ],\n \"slug\": \"apron-bamboo\"\n }\n ]\n}"},{"id":"c132d27d-e3c4-4e56-9fc1-571ae07582aa","name":"Change category name","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Apron Bamboo\"\n}"},"url":{"raw":"https://pim.plytix.com/api/v1/categories/product/:category_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","categories","product",":category_id"],"variable":[{"key":"category_id","value":"{{category_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa0c1e3da03100019ba90f\", \n \"modified\": \"2019-06-07T07:05:06.959196+00:00\", \n \"n_children\": 0, \n \"name\": \"Apron Bamboo\", \n \"order\": \"1\", \n \"parents_ids\": [\n \"5cfa05273da03100019ba90e\"\n ], \n \"path\": [\n \"Kitchen Sinks\", \n \"Apron Bamboo\"\n ], \n \"slug\": \"apron-bamboo\"\n }\n ]\n}\n"}],"_postman_id":"b1c743f0-a351-4433-916f-af13d2aeb27b"},{"name":"Delete category","id":"91366765-49f7-407a-b0d0-fae7eb5a2532","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/categories/product/:category_id","description":"

Deletes a category and all its subcategories.

WARNING All subcategories will be removed too.

If you want to preserve some of the subcategories it's mandatory you move them before deleting parent category.

A 204 response is returned upon success.

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Kitchen Sinks\"\n}"},"url":"https://pim.plytix.com/api/v1/categories/product","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","categories","product"],"host":["pim","plytix","com"],"query":[],"variable":[]}},"response":[{"id":"59d8e1a1-939a-41f6-b232-25d3322684ff","name":"Add new product first category","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Kitchen Sinks\"\n}"},"url":"https://pim.plytix.com/api/v1/categories/product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5cfa05273da03100019ba90e\",\n \"modified\": \"2019-06-07T06:33:11.965893+00:00\",\n \"n_children\": 0,\n \"name\": \"Kitchen Sinks\",\n \"order\": \"5\",\n \"parents_ids\": [],\n \"path\": [\n \"Kitchen Sinks\"\n ],\n \"slug\": \"kitchen-sinks\"\n }\n ]\n}"},{"id":"399b39b7-1208-4d30-b829-cf42f63db4a7","name":"Add duplicate name product category","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Kitchen Sinks\"\n}"},"url":"https://pim.plytix.com/api/v1/categories/product"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"errors\": [\n {\n \"field\": \"name\",\n \"msg\": \"already exists\"\n }\n ],\n \"msg\": \"Category Kitchen Sinks already exists\"\n }\n}"}],"_postman_id":"698c2e44-186f-4fb8-8a59-32bd719babe0"},{"name":"Product categories search","id":"829f929e-527c-4d29-931a-e24037db4a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

Filter on available product categories by multiple criteria

Filter structure and format is described under Resources section in this guide

Current version of the API supports the following set of fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
id	Category id is always returned by default
name	Category friendly name
path	Category full path
parents_ids	Array of ordered parent categories
n_children	Number of subcategories in the current category
order	Position of current category in parent category

Restrictions

Search requests
- Search filters MUST include all necessary columns (except ID which is returned by default). If an attribute is not explicitly requested it won’t be returned by the API.\nAvailable attributes can be obtained by means of the available https://pim.plytix.com/api/v1/filters/ endpoint. “key” value is what MUST be used in requests.\nRequesting non-existing attributes will return a 422 error code\nYou are allowed to sort by columns not included in “attributes” field, however this attribute won’t be returned
  \n
- Search filters will return a 422 error code if any of the following conditions is met:\na) Field does not exist\nb) Operator is not allowed for the given field (available operators and fields can be obtained using /filters/{item} endpoint)\nc) Value has no meaning for the given operator. The arity of available operators can be found in API documentation
  \n
- Pagination: the number of items that can be requested (pagination.page_size) is limited to a maximum 100 items. \n A 422 code will be returned from API if this limit is exceeded. If paginations is omitted 25 items of the first page will be returned.
  \n
\n

Products and files can be categorized in order to make it easy to manage your items.

This section contains resources to manage Categories in PIM

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c4a28745-3a7b-4b68-b2f9-e4e5cf751b29"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ee1151a3-8229-4285-9350-d066d469aadd"}}],"_postman_id":"7cf75339-1346-4b33-8064-604276d56308","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"products","item":[{"name":"product","item":[{"name":"assets","item":[{"name":"asset","item":[{"name":"Unbind asset from product","id":"59d8354c-8539-4152-afd5-059f24594e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/products/:product_id/assets/:asset_id","description":"

Removes relationship between a product and an asset. Asset is not deleted

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/products/:product_id/assets/:asset_id","description":"

Gets a product's asset by id

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/products/:product_id/assets","description":"

Get all assets related to this product

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"5c4ed8002f0985001e233275\",\n \"attribute_label\": \"dummy_media_attribute\"\n}"},"url":"https://pim.plytix.com/api/v1/products/:product_id/assets","description":"

Link an existing asset to an existing media attribute of a product.

All parameters are mandatory:

id of the product.
id of the asset.
label of the attribute

Unknown parameters will be ignored from request data.

Note: This method does not allow the creation of new attributes, nor upload of new assets to your PIM.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Type	Mandatory
id	asset id	string	yes
attribute_label	media attribute label	string	yes

Assets can be linked to product thumbnail and product custom media attributes. Custom product attributes are located under “attributes” parameter.

Note: Assets linked to a single product are restricted to a limit of 300 assets per product.

Thumbnail and single media attribute linking

To link an existing asset to any of this kind of attribute, asset identifier and attribute_label are mandatory.
Caution: This action will replace existing asset in thumbnail or single media attribute if present.

Media gallery attribute linking

To link an existing asset to any of this kind of attribute, asset identifier and attribute_label are mandatory.
Attention: This action will add the asset to the media gallery attribute.

Example 1: link asset to thumbnail

POST /api/v1/products/6397116da02483ebd6dc76e0/assets

{\n   \"id\": \"5c4ed8002f0985001e233275\",\n   \"attribute_label\": \"thumbnail\"\n}\n\n

Example 2: link asset to custom attribute

POST /api/v1/products/6397116da02483ebd6dc76e0/assets

{\n   \"id\": \"5c4ed8002f0985001e233275\",\n   \"attribute_label\": \"dummy_media_gallery\"\n}\n\n

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/products/:product_id/categories/:category_id","description":"

Removes relationship between a product and category. Category is not deleted

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/products/:product_id/categories/:category_id","description":"

Gets a product's category by id

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/products/:product_id/categories","description":"

Get all categories related to this product

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"5c4ed7f62f0985001c233279\"\n}"},"url":"https://pim.plytix.com/api/v1/products/:product_id/categories","description":"

Link an existing category to this product.

Link an existing product as a variant of another product

variant_id will become a Variant of product_id

Product can be a Single product or a Parent product
\n
Variant must be a Single product
\n

Both product and variant must belong to the same Family or be Unassigned.

⚠️ The result of this operation may cause data loss

Removes relationship between a variant and its parent. Variant becomes a Single product.

⚠️ This action might cause data loss

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"variant\": {\n \"sku\": \"new variant from API\",\n \"label\": \"new variant label\",\n \"attributes\": {\n \"description_create_a_rich_text_type_attribute\": \"Variants can be created from the API\",\n \"price_create_a_decimal_number_type_attribute\": 23.99\n }\n }\n}"},"url":"https://pim.plytix.com/api/v1/products/:parent_product_id/variants","description":"

Add a new product as a variant of another product.

It's necessary to send a dictionary with the info of the new variant.

⚠️ Keep in mind that converting a Single product to a Parent might cause data loss

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	Mandatory	Description
variant	yes	Data for the new variant created. It is possible to add extra attributes information in this field, apart from the mandatory field 'sku'

Variant

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	Mandatory	Description
sku	yes	sku for the new product
label	no	label for the new product. Any other System attribute can be set at the same level
attributes	no	custom attribute values for the new products. If you add a parent-level attribute here it will be set as Overwritten

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"attribute_labels\": [\n \"attribute_label_1\",\n \"attribute_label_2\"\n ],\n \"variant_ids\": [\n \"\",\n \"\"\n ]\n}"},"url":"https://pim.plytix.com/api/v1/products/:parent_product_id/variants/resync","description":"

Restore the attributes at parent level of the variant with the value of the parent

It's necessary to send two list, one with the labels of the attributes and another with the ids of the variant products.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	Mandatory	Description
attribute_labels	yes	List of attribute labels to reset. These attributes must be at a parent level
variant_ids	yes	List of variant ids that are going to restore the value for the parent attributes. These ids must be variants of the parent product

A 200 OK is returned upon success.

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/products/:product_id/variants","description":"

Get related variants of a parent product

“Variants” is the new name given to what we previously knew as “variations.” The main difference is that Variants are added to products through a Product Family.

These variants have the ability to inherit values from the parent.
In this section, we will talk about 3 types of products:

Parents: those products with variants and therefore with a family.
\n
Variants: those products that are children of a parent and therefore have a family.
\n
Singles: those products that are neither parents nor variants, they can have a family assigned or not.
\n

\n","_postman_id":"0c61a7e8-6730-4ee6-96b5-7f02a80e1b74","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"relationships","item":[{"name":"Assign products to relationship","id":"35b49788-22de-4c7c-bf14-017a98363171","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All request must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n {\n \"quantity\": 1,\n \"product_id\": \"5d0baf07d4bf5513d190245f\"\n },\n {\n \"quantity\": 9,\n \"product_id\": \"5d0baf07d4bf5513d1902460\"\n },\n {\n \"quantity\": 6,\n \"product_id\": \"5d0baf07d4bf5513d1902461\"\n },\n {\n \"quantity\": 1,\n \"product_id\": \"5d0baf07d4bf5513d1902462\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pim.plytix.com/api/v1/products/:product_id/relationships/:relationship_id","description":"

Assign products to an existing relationship

Behaviour

If any of the given products already exists in the relationship, its quantity will be updated
If any of the given products does not exist in the relationship, it will be inserted

A 201 Created status code is returned upon success

A 200 OK status code is returned if no updates in the requested relationships were performed

Request format

To assing a product to any relationship, the id of the product to be related along with its quantity must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
product_relationships	Array of objects	list with product and quantities

A product_relationship object is defined by:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
product_id	string	product identifier
quantity	number	relationship quantity

Response format

Successful responses will be returned in \"data\" array and will be in the form:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
relationship_id	string	relationship identifier
relationship_label	string	relationship label
related_products	array of object	related products

A related_product object is defined by:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
product_id	string	related product identifier
quantity	number	current quantity
last_modified	date	last modification date

Example:

{\n    \"data\": [\n        {\n            \"related_products\": [\n                {\n                    \"last_modified\": \"2019-09-24T17:28:07.329000+00:00\",\n                    \"product_id\": \"5d6cfa8ae36dc76b0e5df8dd\",\n                    \"quantity\": 1\n                },\n                {\n                    \"last_modified\": \"2019-09-24T17:28:07.329000+00:00\",\n                    \"product_id\": \"5d6cfa8aedd44295ac5df8de\",\n                    \"quantity\": 3\n                }\n            ],\n            \"relationship_id\": \"5d8a50b547397aea2a603079\",\n            \"relationship_label\": \"contains\",\n        }\n    ]\n}\n\n

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","products",":product_id","relationships",":relationship_id"],"host":["pim","plytix","com"],"query":[],"variable":[{"type":"any","value":"{{product_id}}","key":"product_id"},{"type":"any","value":"{{relationship_id}}","key":"relationship_id"}]}},"response":[{"id":"61519cd6-9e30-47a7-860f-13254767e7ef","name":"Assign products to a relationship","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All request must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"all request are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n {\n \"quantity\": 1,\n \"product_id\": \"5d0baf07d4bf5513d190245f\"\n },\n {\n \"quantity\": 9,\n \"product_id\": \"5d0baf07d4bf5513d1902460\"\n },\n {\n \"quantity\": 6,\n \"product_id\": \"5d0baf07d4bf5513d1902461\"\n },\n {\n \"quantity\": 1,\n \"product_id\": \"5d0baf07d4bf5513d1902462\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pim.plytix.com/api/v1/products/:product_id/relationships/:relationship_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","products",":product_id","relationships",":relationship_id"],"variable":[{"key":"product_id","value":"{{product_id}}"},{"key":"relationship_id","value":"{{relationship_id}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"related_products\": [\n {\n \"last_modified\": \"2019-09-24T17:28:07.329000+00:00\",\n \"product_id\": \"5d0baf07d4bf5513d190245f\",\n \"quantity\": 1\n },\n {\n \"last_modified\": \"2019-09-24T17:28:07.329000+00:00\",\n \"product_id\": \"5d0baf07d4bf5513d1902460\",\n \"quantity\": 9\n },\n {\n \"last_modified\": \"2019-09-24T17:28:07.329000+00:00\",\n \"product_id\": \"5d0baf07d4bf5513d1902461\",\n \"quantity\": 6\n },\n {\n \"last_modified\": \"2019-09-24T17:28:07.329000+00:00\",\n \"product_id\": \"5d0baf07d4bf5513d1902462\",\n \"quantity\": 1\n }\n ],\n \"relationship_id\": \"5d8a50b547397aea2a603079\",\n \"relationship_label\": \"contains\"\n }\n ]\n}"},{"id":"a424cb54-11ea-418e-bb59-eee1dab1590c","name":"200 OK, no updates","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","description":"All request must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n {\n \"product_id\": \"64df58d393861834c7ffcacb\",\n \"quantity\": 1\n },\n {\n \"quantity\": 1,\n \"product_id\": \"64df58d34f8bba397effcacd\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pim.plytix.com/api/v1/products/:product_id/relationships/:relationship_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","products",":product_id","relationships",":relationship_id"],"variable":[{"key":"product_id","value":""},{"key":"relationship_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.4"},{"key":"Date","value":"Tue, 22 Aug 2023 10:23:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"491"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Account-Id","value":"64d20da5818c070001be3d91"},{"key":"X-User-Id","value":"5e678436cc9e97962c059bd7"},{"key":"X-User-Type","value":"PIM UI"},{"key":"Vary","value":"Cookie"},{"key":"X-Request-Id","value":"569af766adf0df6d88f326881ae1e9b5"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"related_products\": [\n {\n \"last_modified\": \"2023-08-22T10:06:56.535000+00:00\",\n \"product_id\": \"64df58d393861834c7ffcacb\",\n \"quantity\": 1\n },\n {\n \"last_modified\": \"2023-08-22T10:05:07.255000+00:00\",\n \"product_id\": \"64df58d34f8bba397effcacd\",\n \"quantity\": 1\n }\n ],\n \"relationship_id\": \"64e485f90fc35b27e41c2367\",\n \"relationship_label\": \"relationship\"\n }\n ]\n}"},{"id":"c27b2b01-6d50-4ffd-b962-dc62c5679382","name":"409 Conflict, no product id found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","description":"All request must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n {\n \"quantity\": 1,\n \"product_id\": \"64df58d34f8bba397effcacd\"\n },\n {\n \"quantity\": 1,\n \"product_id\": \"64e4875575a60446300615e8\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pim.plytix.com/api/v1/products/:product_id/relationships/:relationship_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","products",":product_id","relationships",":relationship_id"],"variable":[{"key":"product_id","value":""},{"key":"relationship_id","value":""}]}},"status":"CONFLICT","code":409,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.4"},{"key":"Date","value":"Tue, 22 Aug 2023 10:27:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"229"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Account-Id","value":"64d20da5818c070001be3d91"},{"key":"X-User-Id","value":"5e678436cc9e97962c059bd7"},{"key":"X-User-Type","value":"PIM UI"},{"key":"Vary","value":"Cookie"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"errors\": [\n {\n \"field\": \"product_id\",\n \"msg\": \"product does not exists\",\n \"value\": \"64e4875575a60446300615e8\"\n }\n ],\n \"msg\": \"relationship data validation failed\"\n }\n}"}],"_postman_id":"35b49788-22de-4c7c-bf14-017a98363171"},{"name":"Remove products from a relationship","id":"e03d5ca8-d9b4-4be3-9be7-cfa533391113","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All request must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n {\n \"product_id\": \"5d8cf9114b1830f2192eff0c\"\n },\n {\n \"product_id\": \"5d8cf911326dbd40982eff0c\"\n }\n ]\n}"},"url":"https://pim.plytix.com/api/v1/products/:product_id/relationships/:relationship_id/unlink","description":"

Remove products from an existing relationship

A 204 No Content status code is returned upon success

Request format

Request format is the same used to assign products to a relationship except for the 'quantity' field, which is not necessary and will be ignored.

\n","urlObject":{"protocol":"https","path":["api","v1","products",":product_id","relationships",":relationship_id","unlink"],"host":["pim","plytix","com"],"query":[],"variable":[{"type":"any","value":"{{product_id}}","key":"product_id"},{"type":"any","value":"{{relationship_id}}","key":"relationship_id"}]}},"response":[{"id":"0d1d6a0f-9256-4f73-8258-3dff269ba030","name":"Remove products from a relationship","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All request must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"all request are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n {\n \"product_id\": \"5d8cf9114b1830f2192eff0c\"\n },\n {\n \"product_id\": \"5d8cf911326dbd40982eff0c\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pim.plytix.com/api/v1/products/:product_id/relationships/:relationship_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","products",":product_id","relationships",":relationship_id"],"variable":[{"key":"product_id","value":"{{product_id}}"},{"key":"relationship_id","value":"{{relationship_id}}"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e03d5ca8-d9b4-4be3-9be7-cfa533391113"},{"name":"Modify relationship attributes","id":"b5bb6075-6a8d-43b5-9479-724f2ae98b89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 10\n}","options":{"raw":{"language":"json"}}},"url":"https://pim.plytix.com/api/v1/products/:product_id/relationships/:relationship_id/product/:related_product_id","description":"

Modify selected relationship attributes

Current version of the API only allows the modification of the 'quantity' attribute.\nA 200 OK status code will be returned upon successful call

Request format

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
quantity	number	new value, must be a positive integer

Response format

Successful responses will be returned in \"data\" array and will be in the form:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
product_id	string	related product identifier
quantity	number	current quantity
last_modified	date	last modification date

Example Request and Response:

Request:\n{\n    \"quantity\":11\n}\n\nResponse\n{\n  \"data\": [\n    {\n      \"last_modified\": \"2019-09-27T06:50:07.851682+00:00\", \n      \"product_id\": \"5d8cf911bde76bea4e2eff13\", \n      \"quantity\": 11\n    }\n  ]\n}\n

This section contains resources to assign, remove or update related products to the selected product.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8bdac958-8035-44f1-93b0-ab9a88aa121a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"803d7baf-6199-430a-aedf-811b15ede03c"}}],"_postman_id":"a01a9df6-9a53-4f92-8b1c-e4be7145016e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"Removes product from the system","id":"ac0f6a1c-fd4e-43ba-ab0b-c60720b4fdbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/products/:product_id","description":"

Removes a product from the PIM

WARNING: All variants linked to this product will be removed.

If there are any variants you do not want to delete,
they must be unlinked from the parent first, which will turn them into single products.

204 code is returned upon success

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/products/:product_id","description":"

Gets product attributes

This verb accepts a query parameter named all_attributes which allows to specify if empty attributes should be included on response as null.

200 code is returned upon success

Params

\n\n\n\n\n\n\n\n\n\n\n\n\n

Param

Options

all_attributes

Value	Descripcion
false	Do not include empty attributes. THIS IS THE DEFAULT VALUE
true	Include all defined attributes. Empty attributes will be returned as null

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","products",":product_id"],"host":["pim","plytix","com"],"query":[],"variable":[{"type":"any","value":"{{product_id}}","key":"product_id"}]}},"response":[{"id":"2b6b325b-2621-4cb2-8f03-5d3c921924cd","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"url":{"raw":"https://pim.plytix.com/api/v1/products/:product_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","products",":product_id"],"variable":[{"key":"product_id","value":"{{product_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"assets\": [\n {\n \"filename\": \"content_1.png\",\n \"id\": \"5bfac7d851e7590001486761\",\n \"thumbnail\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/content_1.png\",\n \"url\": \"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/content_1.png\"\n },\n {\n \"filename\": \"1.jpeg\",\n \"id\": \"5bfaced551e7590001486763\",\n \"thumbnail\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/1.jpeg\",\n \"url\": \"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/1.jpeg\"\n },\n {\n \"filename\": \"2.jpeg\",\n \"id\": \"5bfaced551e7590001486764\",\n \"thumbnail\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486764/2.jpeg\",\n \"url\": \"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486764/2.jpeg\"\n },\n {\n \"filename\": \"3.jpeg\",\n \"id\": \"5bfaced551e7590001486765\",\n \"thumbnail\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486765/3.jpeg\",\n \"url\": \"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486765/3.jpeg\"\n }\n ],\n \"attributes\": {\n \"boolean_attribute\": false,\n \"completeness_all_attributes\": 80,\n \"completeness_boolean_mediasingle1_label\": 100,\n \"date_attribute\": \"2018-12-31\",\n \"decimal_number\": \"\",\n \"dropdown_attribute\": \"Option 2\",\n \"integer_number\": \"123456\",\n \"media_gallery\": [\n {\n \"filename\": \"1.jpeg\",\n \"id\": \"5bfaced551e7590001486763\",\n \"thumb\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/1.jpeg\",\n \"url\": \"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/1.jpeg\"\n },\n {\n \"filename\": \"2.jpeg\",\n \"id\": \"5bfaced551e7590001486764\",\n \"thumb\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486764/2.jpeg\",\n \"url\": \"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486764/2.jpeg\"\n }\n ],\n \"media_single_1\": {\n \"filename\": \"3.jpeg\",\n \"id\": \"5bfaced551e7590001486765\",\n \"path\": \"assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486765/3.jpeg\",\n \"thumb\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486765/3.jpeg\"\n },\n \"multiselect_attribute\": [\n \"select 1\",\n \"select 2\"\n ],\n \"paragraph\": \"Lorem ipsum dolor sit amet, consectetur. \\n\\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\",\n \"rich_text\": \"

Bold Heading

Lorem ipsum dolor sit amet, consectetur.

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

\",\n \"url\": \"https://www.plytix.com/index/pricing\"\n },\n \"categories\": [\n {\n \"id\": \"5bfa91ab8544120001bd9078\",\n \"name\": \"Category 1\",\n \"path\": [\n \"Category 1\"\n ]\n },\n {\n \"id\": \"5bfa91be8544120001bd907a\",\n \"name\": \"Category 3\",\n \"path\": [\n \"Category 3\"\n ]\n },\n {\n \"id\": \"5bfa91ea8544120001bd907d\",\n \"name\": \"Category 1-3\",\n \"path\": [\n \"Category 1\",\n \"Category 1-3\"\n ]\n },\n {\n \"id\": \"5bfa91f88544120001bd907e\",\n \"name\": \"Category 2-1\",\n \"path\": [\n \"Category 2\",\n \"Category 2-1\"\n ]\n }\n ],\n \"created\": \"2018-11-25T12:04:10.045000+00:00\",\n \"id\": \"5bfa8fba8544120001bd9073\",\n \"label\": \"Product ~ 1\",\n \"modified\": \"2018-11-26T16:08:47.488000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"Product 1\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"filename\": \"assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/content_1.png\",\n \"id\": \"5bfac7d851e7590001486761\",\n \"thumb\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/content_1.png\",\n \"url\": \"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/content_1.png\"\n }\n }\n ]\n}"},{"id":"d6b65f5b-5f2e-4072-b4e4-a58e393efb21","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"url":{"raw":"https://pim.plytix.com/api/v1/products/:product_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","products",":product_id"],"variable":[{"key":"product_id","value":"{{product_id}}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"errors\": [\n {\n \"field\": \"id\",\n \"msg\": \"product does not exist\"\n }\n ],\n \"msg\": \" No results found for 5c4ec5afb3bfd10001e45603\"\n }\n}"},{"id":"5e2c5307-002b-46d3-9676-1b7d498e6cb3","name":"Get product data with all attributes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"url":{"raw":"https://pim.plytix.com/api/v1/products/:product_id?all_attributes=true","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","products",":product_id"],"query":[{"key":"all_attributes","value":"true"}],"variable":[{"key":"product_id","value":"{{product_id}}"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"_parent_id\": null,\n \"assets\": [],\n \"attributes\": {\n \"application_place\": null,\n \"basic_info_complete\": 100,\n \"bowl_depth_mm\": \"455\",\n \"bowl_length_mm\": \"160\",\n \"bowl_position\": \"Central\",\n \"bowl_width_mm\": null,\n \"brand\": \"Plytix\",\n \"collection\": \"2019\",\n \"color\": \"Glass\",\n \"description\": \"The frosted black glass vessel sink is manufactured using fully tempered glass. This allows for higher temperatures to come in contact with your sink without any damage. Glass is more sanitary than other materials because it is non-porous, will not absorb stains or odors and is easy to clean. The silky black surface of the sink, along with the soft wavy edges, creates a blissful look that will bring comfort and relaxation to any bathroom. A matching glass waterfall faucet is available to correspond with this sink. The overall dimensions for the G12 are 17\\\" x 17\\\" x 7\\\" and an 18\\\" minimum cabinet size is required. As always, our glass sinks are covered under a limited lifetime warranty for as long as you own the sink.\",\n \"eta_stock_date\": null,\n \"faucets_finish\": null,\n \"feature_description\": \"Best practices\\nDo not submit a headline without text, or vice versa.\\nDo not use the same image for each feature description [feature_description].\\nEnsure that grammar, capitalization, and punctuations are complete and consistent within headlines and text. \\nDo not add manufacturer- or merchant-specific details, such as links, phone numbers, company information or promotional text.\\nAvoid stock values, such as \\\"n/a\\\".\\nHeadlines should not repeat the title [title] attribute.\",\n \"fixing_kit\": null,\n \"gtin\": \"3234567890126\",\n \"handle_position\": null,\n \"in_stock\": true,\n \"installation_type\": null,\n \"installation_type_bowls\": null,\n \"packed_product_height_mm\": \"198\",\n \"packed_product_length_mm\": \"167\",\n \"packed_product_weight_kg\": 4.75,\n \"packed_product_width_mm\": \"256\",\n \"plug_and_waste\": null,\n \"product_height_mm\": \"175\",\n \"product_length_mm\": \"148\",\n \"product_lifecycle_stage\": null,\n \"product_owner\": \"Jon\",\n \"product_type\": \"Bathroom Sink\",\n \"product_weight_kg\": 3.23,\n \"product_width_mm\": \"241\",\n \"rich_info_complete\": 90.9090909090909,\n \"suggested_retail_price\": 310.24,\n \"taphole_configuration\": null,\n \"test_date\": null,\n \"test_multiselect\": null,\n \"title\": \"Black Wavy Frost Glass Vessel Bowl\",\n \"type\": \"Vessel Bowl\",\n \"type_of_cartridge\": null,\n \"video_url\": null,\n \"washbasin_capacity_l\": null\n },\n \"categories\": [],\n \"created\": \"2019-03-25T16:10:45.312000+00:00\",\n \"id\": \"5c98ef754a6c252c96793574\",\n \"label\": \"Black Wavy Frost Glass Vessel Bowl\",\n \"modified\": \"2019-06-04T09:58:17.746000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1001\",\n \"status\": \"Completed\",\n \"thumbnail\": null\n }\n ]\n}"}],"_postman_id":"43d13568-e73d-410b-a4d3-ad0a8e6d6df7"},{"name":"Modify selected attributes of a product","id":"17dd4bc2-1100-417c-a936-3a1271ccae84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"attributes\": {\n \"color_create_a_multiselect_type_attribute\": [\n \"Blue\"\n ],\n \"description_create_a_rich_text_type_attribute\": \"Try making the description a Rich Text attribute so that you can format the text however you'd like.\",\n \"price_create_a_decimal_number_type_attribute\": null\n },\n \"label\": \"Product ~ 1 - patch example\",\n \"status\": \"Completed\"\n}"},"url":"https://pim.plytix.com/api/v1/products/:product_id","description":"

Modifies attributes from product, leaving the rest unchanged.

Assign family to a product

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameter	description	mandatory
product_family_id	id of the product family that is going to be assigned to the product	yes

Important notes:

Changing product family might cause data loss
Product families cannot be assigned to Variant products
Changing the product family will change the same fields of the variants

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"Product data"},"url":"https://pim.plytix.com/api/v1/products","description":"

Creates a product

There's only a mandatory parameter, sku of the product. Readonly and unknown parameters will be
ignored from request data.

Note: This method does not allow the creation of new attributes, categories or assets.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory
sku	string	yes

Custom product attributes are located under “attributes” parameter. Thumbnail, assets, categories, media and media galleries
can be linked to a product.

Upon successful creation, a 201 http status code will be returned, the new product
will be in the response body of the request and it resource identifier could be found
in response headers.

Thumbnail, assets and media attribute linking

You are not allowed to upload any new assets to your PIM account using this resource, thats Asset's endpoint business, but
you are allowed to link existing assets into your product.
To link an existing asset to any of this kind of attribute, only asset identifier is mandatory

Media gallery

Media gallery contains a collection of medias, so in this case you need to indicate an array of asset objects.
All constraints described in asset linking section apply.

Categories linking

All constrains described in asset linking section apply to categories. Only id of the category is mandatory.

Example 1. Product creation

POST /api/v1/products/

{\n   \"sku\": \"blue adventure mug S023\",\n   \"label\": \"Adventure mug\",\n   \"attributes\" : {\n          \"stock\" : 123,\n          \"vendor_url\": \"http://acme.com\",\n          \"since\": \"2015-03-28\",\n          \"Media_gallery\":[\n                {\"id\":\"5bfaced551e7590001486763\"},\n                {\"id\":\"5bfaced551e7590001486765\"}\n          ],\n            \"media_single_1\": {\"id\":\"5bfaced551e7590001486764\"},\n      },\n    \"categories\": [\n           {\n               \"id\": \"5bfa91ab8544120001bd9078\"\n           }\n    ]\n}\n\n

201 CREATED\nHEADER\nLocation →https://pim.plytix.com/api/v1/products/5bfad5ca5b84b100017a8f5a\nBODY\n{\n    \"data\": [\n        {\n            \"assets\": [],\n            \"attributes\": {\n              \"since\": \"2015-03-28\",\n              \"stock\" : \"123\",\n              \"vendor_url\": \"http://acme.com\",\n              \"media_gallery\": [\n                    {\n                        \"filename\": \"1.jpeg\",\n                        \"id\": \"5bfaced551e7590001486763\",\n                        \"thumb\": \"https://files.plytix.com/api/v1.0/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/1.jpeg\",\n                        \"url\": \"https://files.plytix.com/api/v1.0/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/1.jpeg\"\n                    },\n                    {\n                        \"filename\": \"3.jpeg\",\n                        \"id\": \"5bfaced551e7590001486765\",\n                        \"thumb\": \"https://files.plytix.com/api/v1.0/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486765/3.jpeg\",\n                        \"url\": \"https://files.plytix.com/api/v1.0/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486765/3.jpeg\"\n                    }\n                ],\n                \"media_single_1\": {\n                    \"filename\": \"2.jpeg\",\n                    \"id\": \"5bfaced551e7590001486764\",\n                    \"path\": \"assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486764/2.jpeg\",\n                    \"thumb\": \"https://files.plytix.com/api/v1.0/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486764/2.jpeg\"\n                },\n            },\n            \"categories\": [\n                   {\n                       \"id\": \"5bfa91ab8544120001bd9078\",\n                       \"name\" : \"Mugs\",\n                       \"path\": [ \"Mugs\" , \"Ceramic\"  ]\n                   }\n            ],\n            \"id\": \"5bfad5ca5b84b100017a8f5a\",\n            \"created\": \"2018-11-25T17:03:06.596000+00:00\",\n            \"modified\": \"2018-11-25T17:03:06.628000+00:00\",\n            \"sku\": \" blue adventure mug S023\",\n            \"label\": \"Adventure mug\",\n            \"status\": \"Draft\",\n            \"num_variations\": 0,\n            \"thumbnail\": null,\n            \"assets\": [ { \"id\":\"...\" }, { \"id\":\"...\" }]\n        }\n    ]\n}\n\n

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [\n [\n {\n \"field\": \"status\",\n \"operator\": \"eq\",\n \"value\": \"Draft\"\n },\n {\n \"field\": \"categories\",\n \"operator\": \"in\",\n \"value\": [\n \"5c4ed7f62f0985001c233274\"\n ]\n }\n ],\n [\n {\n \"field\": \"categories\",\n \"operator\": \"!exists\",\n \"value\": null\n }\n ]\n ],\n \"attributes\": [\n \"thumbnail\",\n \"assets\",\n \"label\",\n \"categories\",\n \"modified\",\n \"created\",\n \"status\"\n ],\n \"pagination\": {\n \"order\": \"sku\",\n \"page\": 1,\n \"page_size\": 25\n }\n}"},"url":"https://pim.plytix.com/api/v1/products/search","description":"

Filter product by multiple criteria

Filter structure and format is described under Resources section in this guide

Product search has also support to filter products based on relationship properties. Relationship filter structure and format is described later in this document.

Please take notice of the use of attribute labels instead of attribute names in the request (see more examples below)

Restrictions

Search requests
\n
- Requests are limited to 50 attributes (plus ID and SKU which are always returned). Attributes (both system and user) and properties count in this limit. Requests having more than 50 attributes will be rejected and a 422 code will be returned from API
  \n
- User attributes MUST be prefixed with “attributes.” (including the dot at the end) + the label of the attribute . So for example, if there is an attribute named “In Stock” and labeled as \"in_stock\" we MUST add it to the request as “attributes.in_stock”. Attribute names and labels can be obtained by
  means of the filters/product endpoint
  \n
- Relationship columns can also be requested. These MUST be prefixed with “relationships.” (including the dot at the end) + the label of the relationship (response is described in later in this section). Examples:
  \n
  - relationships.gift_basket
  - relationships.recommended_products
  \n
- Search filters MUST include all necessary columns. If an attribute is not explicitly requested it won’t be returned by the API.
  Available attributes can be obtained by means of the available https://pim.plytix.com/api/v1/filters/ endpoint. “key” value is what MUST be used in requests.
  Requesting non-existing attributes will return a 422 error code
  You are allowed to sort by columns not included in “attributes” field however this attribute won’t be returned User attributes MUST be prefixed with “attributes.” (including the dot at the end) + the label of the attribute
  \n
- Search filters will return a 422 error code if any of the following conditions are met:
  a) The field does not exist
  b) Operator is not allowed for the given field (available operators and fields can be obtained using /filters/{item} endpoint)
  c) Value has no meaning for the given operator. The arity of available operators can be found in API documentation
  \n
- Search filters will return a 428 status code if the filtered results include more than 10000 products and the order field is filled.
  \n
- Pagination: the number of items that can be requested (pagination.page_size) is limited to a maximum of 100 items. A 422 code will be returned from API if this limit is exceeded. If pagination is omitted 25 items of the first page will be returned
  \n
- Only one relationship can be selected in filters
  \n
\n

Relationship information in responses

When relationship columns are requested, product response will include a new field named ‘relationships’ with the following structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Type
relationships	relationship array	array of relationship information

Relationship information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Type
relationship_id	relationship id	string
label	relationship label	string
related_products	related products	Array of product relationship data

Relationship Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Type
product_id	product ID	string
quantity	quantity	number

Attributes: [\"categories\", \"label\", \"attributes.color\", \"relationships.gift_basket\"]\n{\n     \"id\": \"5d8200527313382d939838c4\",\n     \"sku\": \"1234567890\",\n     \"categories\": [],\n     \"label\": \"Strawberry_soap\",\n     \"attributes\": {\n         \"color\": \"red\" \n     },\n     \"relationships\": [\n       {\n         \"relationship_id\": \"5ddbf89efbe0f86e3c1574c6\",\n         \"label\": \"gift_basket\",\n         \"related_products\": [\n           {\n             \"product_id\": \"5c98ef754a6c252c96793574\",\n             \"quantity\": 1\n           }\n         ]\n       }\n     ],\n   }\n\n

Relationship filters

This section describes the structure and format for relationship filters. A Relationship filter is compound of several fields, some of them are mandatory while others depend on the values and options selected.

Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Mandatory	Type
relationship_id	relationship Identifier	YES	string
operator	only ‘exists’ and ‘!exists’ are supported	YES	string
product_ids	list of product constraints	NO	Array of object (only for “exists” operator)

Complex filters can be built defining additional constraints on relationship quantity operator when relationship “exists” operator is selected. Please check the examples section.

Product_ids structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Mandatory	Type
id	product id	YES	string
qty_operator	quantity operator	YES	string
value	filter value	string	array of integer

Available operators:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operator	Arity	Type	Description
exists	Unary	-	Existence check. True when the item has its value defined
!exists	Unary	-	Non-existence check. True when the item has its value undefined
eq	Binary	value	Equality check. True if the item has the same value as the one provided When applied to a text value, the comparison ignores case
in	Binary	list	Match check. Determines if the value matches any of the values specified in the list Note: Multiselect and Dropdown attributes are case sensitive
gt	Binary	value	Greater than. True if items' value is greater than provided
gte	Binary	value	Greater than or equal to. True if item's value is greater than or equal to provided
lt	Binary	value	Less than. True if item's value is less than provided
lte	Binary	value	Less than or equal to. True if item's value is less than or equal to provided
bte	Binary	value	Between. Requires two values True if item's value is between provided values
last_days	Unary	value	Date is greater than the given days check. The filter will only take into account full days (current time is dismissed)

Examples

1.- Return default page (1) with default items per page (25) using default order (no order)
Note that this query will return just ID and SKU as no attributes have been provided

 {\n     \"filters\":[\n        [\n            {\"field\":\"modified\",\"operator\":\"gt\",\"value\":\"2018-11-01\"},\n            {\"field\":\"modified\",\"operator\":\"lt\",\"value\":\"2018-11-30\"}\n        ],\n        [\n            {\"field\":\"attributes.name\",\"operator\":\"like\",\"value\":\"unicorn\"}\n        ]\n        ]\n }\n\n

2.- Return default page (1) with default items per page (25) using default order (no order) of product attributes SKU, Label and user attributes \"In Stock\" and \"Volumen (liters)\". Please take notice of the the use of attribute labels instead of attribute names in the request

 {\n     \"attributes\":[\"sku\", \"label\", \"attributes.in_stock\", \"attributes.volume_liters\"]\n }\n\n

3.- Return page 3 of products modified [ between November the 1st AND November the 30th] OR [ contains the literal 'unicorn' ] ordered by SKU descending
returning system_attributes: id, sku, created, and user attribute \"In Stock\", \"Product name\", \"Quantity\" (labels: in_stock, name, qty)

 {\n    \"filters\":[\n        [\n            {\"field\":\"modified\",\"operator\":\"gt\",\"value\":\"2018-11-01\"},\n            {\"field\":\"modified\",\"operator\":\"lt\",\"value\":\"2018-11-30\"}\n        ],\n        [\n            {\"field\":\"attributes.name\",\"operator\":\"like\",\"value\":\"unicorn\"}\n        ]\n        ],\n    \"pagination\":{\"order\":\"-sku\",\"page\":3,\"page_size\":25},\n    \"attributes\":[\"created\", \"attributes.in_stock\", \"attributes.name\", \"attributes.qty\"]\n}\n\n

Relationship filter examples

The following examples assume that:

There is a Symmetrical relationship named ‘Recommended products’.RP-001 is recommended with RP-002 (quantity 2) and RP-003 (quantity 3).
So RP-002 is recommended with RP-001, and RP-003 is recommended with RP-001, however RP-002 is not related to RP-003.
There is an Asymmetrical relationship named “Gift basket”.
Product GF-Basket ‘includes’ GF-Wine (2 bottles), GF-Chocolates (3 packs), GF-Emmental (1 piece)

Find products where the “recommended products” relationship is defined (exists).

 {\n  \"attributes\":[\"relationships.recommended_products\"],\n  \"filters\":[],\n  \"relationship_filters\":[[\n    {\n      \"relationship_id\":\"5d89c6c696c8f4a322df4bbc\",\n      \"operator\":\"exists\",\n      \"product_ids\":[],\n    }]],\n  \"pagination\": {\n    \"order\":\"\",\n    \"page\":1,\n    \"page_size\":25\n  }\n }\n\n

The response should include RP-001, RP-002, and RP-003

Find products where “recommended products” is not defined (!exists).

 {\n  \"attributes\":[\"relationships.recommended_products\"],\n  \"filters\":[],\n  \"relationship_filters\":[[\n    {\n      \"relationship_id\":\"5d89c6c696c8f4a322df4bbc\",\n      \"operator\":\"!exists\",\n      \"product_ids\":[]\n    }]],\n    \"pagination\":{\n      \"order\":\"\",\n      \"page\":1,\n      \"page_size\":25\n    }\n }\n\n

The response should not include RP-001, RP-002 or RP-003

Find the products for which the “recommended products” relationship is defined (a.k.a exists) with the RP-002 product

 {\n  \"filters\":[],\n  \"attributes\":[\"relationships.recommended_products\"],\n  \"relationship_filters\":[[\n    {\n      \"product_ids\":[\n      {\n        \"id\":\"5d89c68596c8f4a322df4bb9\",\n        \"qty_operator\":\"exists\",\n        \"value\":null\n      }],\n      \"relationship_id\":\"5d89c6c696c8f4a322df4bbc\",\n      \"operator\":\"exists\"\n    }]],\n  \"pagination\": {\n    \"order\":null,\n    \"page\":1,\n    \"page_size\":25\n  }\n }\n\n

Response should include RP-001

 {\n  \"data\": [\n    {\n      \"attributes\": {},\n      \"id\": \"5d89c67796c8f4a322df4bb8\",\n      \"sku\": \"RP-001\",\n      \"relationships\": [\n         {\n             \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n             \"label\": \"recommended_products\",\n             \"related_products\": [\n                 {\n                     \"product_id\": \"5d89c68596c8f4a322df4bb9\",\n                     \"quantity: \"2\"\n                 },\n                 {\n                     \"product_id\": \"5d89c69496c8f4a322df4bba\",\n                     \"quantity: \"3\"\n                 }\n             ]\n         }\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"count\": 1,\n    \"order\": null,\n    \"page\": 1,\n    \"page_size\": 25,\n    \"total_count\": 3\n  }\n }\n\n

Filter the products for which the relationship with the product RP-001 is defined and whose quantity is greater than 2Please, note that the \"value\" field is an array of one element

 {\n    \"filters\": [],\n    \"attributes\": [\n        \"relationships.recommended_products\"\n    ],\n    \"relationship_filters\": [\n        [\n            {\n                \"product_ids\": [\n                    {\n                        \"id\": \"5d89c67796c8f4a322df4bb8\",\n                        \"qty_operator\": \"gt\",\n                        \"value\": [\n                            2\n                        ]\n                    }\n                ],\n                \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n                \"operator\": \"exists\"\n            }\n        ]\n    ],\n    \"pagination\": {\n        \"order\": null,\n        \"page\": 1,\n        \"page_size\": 25\n    }\n }\n\n

Response should exclude RP-002, due to its quantity being 2, and include RP-003

 {\n  \"data\": [\n    {\n      \"attributes\": {},\n      \"id\": \"5d89c69496c8f4a322df4bba\",\n      \"sku\": \"RP-003\",\n      \"relationships\": [\n         {\n             \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n             \"label\": \"recommended_products\",\n             \"related_products\": [\n                 {\n                     \"product_id\": \"5d89c67796c8f4a322df4bb8\",\n                     \"quantity: \"3\"\n                 }\n             ]\n         }\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"count\": 1,\n    \"order\": null,\n    \"page\": 1,\n    \"page_size\": 25,\n    \"total_count\": 3\n  }\n }\n\n

Filter the products for which the relationship is defined with the product RP-001 and whose quantity is between 1 and 2Please, notice that the \"value\" field in this case, value array must include both values, i.e. [1, 2]

 {\n    \"filters\": [],\n    \"attributes\": [\n        \"relationships.recommended_products\"\n    ],\n    \"relationship_filters\": [\n        [\n            {\n                \"product_ids\": [\n                    {\n                        \"id\": \"5d89c67796c8f4a322df4bb8\",\n                        \"qty_operator\": \"bte\",\n                        \"value\": [\n                            1,\n                            2\n                        ]\n                    }\n                ],\n                \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n                \"operator\": \"exists\"\n            }\n        ]\n    ],\n    \"pagination\": {\n        \"order\": null,\n        \"page\": 1,\n        \"page_size\": 25\n    }\n }\n\n

Response should exclude RP-003, which has a quantity of 3, and include RP-002

 {\n  \"data\": [\n    {\n      \"attributes\": {},\n      \"id\": \"5d89c68596c8f4a322df4bb9\",\n      \"sku\": \"RP-002\",\n      \"relationships\": [\n         {\n             \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n             \"label\": \"recommended_products\",\n             \"related_products\": [\n                 {\n                     \"product_id\": \"5d89c68596c8f4a322df4bb9\",\n                     \"quantity: \"2\"\n                 }\n             ]\n         }\n      ]         \n    }\n  ],\n  \"pagination\": {\n    \"order\": null,\n    \"page\": 1,\n    \"page_size\": 25,\n  }\n }\n\n

Find all products where ‘Gift basket’ is defined

 {\n    \"filters\": [],\n    \"attributes\": [\n        \"relationships.gift_basket\"\n    ],\n    \"relationship_filters\": [\n        [\n            {\n                \"product_ids\": [],\n                \"relationship_id\": \"5d89d4fd96c8f4a322df4bc0\",\n                \"operator\": \"exists\"\n            }\n        ]\n    ],\n    \"pagination\": {\n        \"order\": null,\n        \"page\": 1,\n        \"page_size\": 25\n    }\n }\n\n

The response should include 'GF-Basket' product.

 {\n    \"data\": [\n        {\n            \"attributes\": {},\n            \"id\": \"5d89d51a96c8f4a322df4bc1\",\n            \"sku\": \"GF-Basket\",\n            \"relationships\": [\n                 {\n                     \"relationship_id\": \"5d89d4fd96c8f4a322df4bc0\",\n                     \"label\": \"gift_basket\",\n                     \"related_products\": [\n                         {\n                             \"product_id\": \"5d89d51a96c8f4a322df4bc2\",\n                             \"quantity: \"2\"\n                         },\n                         {\n                             \"product_id\": \"5d89d52f96c8f4a322df4bc3\",\n                             \"quantity: \"3\"\n                         },\n                         {\n                             \"product_id\": \"5d89d54396c8f4a322df4bc4\",\n                             \"quantity: \"1\"\n                         }                            \n                     ]\n                 }\n             ]               \n        }\n    ],\n    \"pagination\": {\n        \"count\": 1,\n        \"order\": null,\n        \"page\": 1,\n        \"page_size\": 25,\n        \"total_count\": 7\n    }\n }\n\n

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01T00:00:00\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe68dfba44f77d7c75f9d0\"\n },\n {\n \"id\": \"5ebe68e0ba44f77d7c75f9d2\"\n },\n {\n \"id\": \"5ebe68e1ba44f77d7c75f9d4\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d6\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383adf18d516fbbac718d\",\n \"label\": \"Backpack Venice - Coco\",\n \"modified\": \"2020-05-19T07:03:05.787000+00:00\",\n \"num_variations\": 5,\n \"sku\": \"1013\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe68e1ba44f77d7c75f9d4\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf18d516fbbac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Black Rose\"\n ],\n \"discontinued\": false,\n \"features_html\": \"

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01T00:00:00\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe690465931c704d75f9f4\"\n },\n {\n \"id\": \"5ebe690565931c704d75f9f6\"\n },\n {\n \"id\": \"5ebe690565931c704d75f9f8\"\n },\n {\n \"id\": \"5ebe690665931c704d75f9fa\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383c6421a5e26d9ac71b1\",\n \"label\": \"Backpack Venice - Black Rose\",\n \"modified\": \"2020-05-19T07:03:29.937000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1016\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe690565931c704d75f9f8\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf18d516fbbac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Almond\"\n ],\n \"discontinued\": false,\n \"features_html\": \"

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01T00:00:00\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe690765931c704d75f9fe\"\n },\n {\n \"id\": \"5ebe690865931c704d75fa00\"\n },\n {\n \"id\": \"5ebe690965931c704d75fa02\"\n },\n {\n \"id\": \"5ebe690a65931c704d75fa04\"\n },\n {\n \"id\": \"5ebe690c65931c704d75fa06\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383c8421a5e26d9ac71bb\",\n \"label\": \"Backpack Venice - Almond\",\n \"modified\": \"2020-05-19T07:03:35.905000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1017\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe690a65931c704d75fa04\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf18d516fbbac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Black Noise\"\n ],\n \"discontinued\": true,\n \"features_html\": \"

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01T00:00:00\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe690d65931c704d75fa0a\"\n },\n {\n \"id\": \"5ebe690e65931c704d75fa0c\"\n },\n {\n \"id\": \"5ebe690f65931c704d75fa0e\"\n },\n {\n \"id\": \"5ebe691065931c704d75fa10\"\n },\n {\n \"id\": \"5ebe691265931c704d75fa12\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383cd421a5e26d9ac71c7\",\n \"label\": \"Backpack Venice - Black Noise\",\n \"modified\": \"2020-05-19T07:03:41.404000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1018\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe691065931c704d75fa10\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf18d516fbbac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Morning Mist\"\n ],\n \"discontinued\": false,\n \"features_html\": \"

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01T00:00:00\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe6912b8b8d47fc575f9ea\"\n },\n {\n \"id\": \"5ebe6914b8b8d47fc575f9ec\"\n },\n {\n \"id\": \"5ebe6915b8b8d47fc575f9ee\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383d17c936bcce4ac71a6\",\n \"label\": \"Backpack Venice - Morning Mist\",\n \"modified\": \"2020-05-19T07:03:41.582000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1014\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe6914b8b8d47fc575f9ec\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf28c84a676ac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Dead Flower\"\n ],\n \"discontinued\": true,\n \"features_html\": \"

Urban mobility bag with roll-top closure
Large, size adjustable main compartment with internal zip pocket
Padded 15” laptop pocket with external access
Quick-access travel-doc pocket
Front zip organizer pocket
Side handle
Padded ergo straps with adjustable chest straps
Soft padded mesh back panel
Gear loops

Urban mobility bag with roll-top closure
Large, size adjustable main compartment with internal zip pocket
Padded 15” laptop pocket with external access
Quick-access travel-doc pocket
Front zip organizer pocket
Side handle
Padded ergo straps with adjustable chest straps
Soft padded mesh back panel
Gear loops

Urban mobility bag with roll-top closure
Large, size adjustable main compartment with internal zip pocket
Padded 15” laptop pocket with external access
Quick-access travel-doc pocket
Front zip organizer pocket
Side handle
Padded ergo straps with adjustable chest straps
Soft padded mesh back panel
Gear loops

\",\n \"launch_date\": \"2020-06-01T00:00:00\",\n \"long_description\": \"Designed to be well-equipped for calculated city missions and last minute adventures into uncharted terrain, the Scrambler backpack combines durable adventure solutions into a sleek urban style. The ergonomically fitted backpack straps allow you to comfortably carry your required accessaries for your next mission, while the side handle allows for easy handling and a professional look during you daily routine. The roll-top closure will allow for more space in the main compartment if needed, and adjust to fit your required space perfectly for the day. The 15” laptop pocket with external access and quick-access travel pocket will allow you to get to your computer and documents without having to dig through the main compartment if you are in a hurry. If you are looking for a versatile bag for daily usages in and out of the city in a beautiful classic silhouette, than the Scrambler was built for you.\",\n \"price_store\": 130.76,\n \"product_gallery\": [\n {\n \"id\": \"5ebe6903b8b8d47fc575f9d0\"\n },\n {\n \"id\": \"5ebe6926df2179290375fa22\"\n },\n {\n \"id\": \"5ebe6927df2179290375fa24\"\n },\n {\n \"id\": \"5ebe6928df2179290375fa26\"\n },\n {\n \"id\": \"5ebe6928df2179290375fa28\"\n },\n {\n \"id\": \"5ebe6929df2179290375fa2a\"\n },\n {\n \"id\": \"5ebe692adf2179290375fa2c\"\n },\n {\n \"id\": \"5ebe692bdf2179290375fa2e\"\n },\n {\n \"id\": \"5ebe692cdf2179290375fa30\"\n },\n {\n \"id\": \"5ebe692ddf2179290375fa32\"\n },\n {\n \"id\": \"5ebe692ddf2179290375fa34\"\n },\n {\n \"id\": \"5ebe692edf2179290375fa36\"\n },\n {\n \"id\": \"5ebe692edf2179290375fa38\"\n },\n {\n \"id\": \"5ebe692fdf2179290375fa3a\"\n },\n {\n \"id\": \"5ebe6930df2179290375fa3c\"\n },\n {\n \"id\": \"5ebe6930df2179290375fa3e\"\n },\n {\n \"id\": \"5ebe6931df2179290375fa40\"\n },\n {\n \"id\": \"5ebe6931df2179290375fa42\"\n },\n {\n \"id\": \"5ebe6932df2179290375fa44\"\n },\n {\n \"id\": \"5ebe6932df2179290375fa46\"\n }\n ],\n \"short_description\": \"Built For Endless Possibilities\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"30\"\n },\n \"id\": \"5ec383de34f631942dac71dd\",\n \"label\": \"Backpack Scrambler - Black Noise\",\n \"modified\": \"2020-05-19T07:03:58.533000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1011\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe6931df2179290375fa40\"\n }\n }\n ],\n \"pagination\": {\n \"count\": 8,\n \"order\": \"attributes.price_store\",\n \"page\": 1,\n \"page_size\": 25,\n \"total_count\": 18\n }\n}"},{"id":"41b1fccb-0a4a-4637-b6d4-c8a27ae35a9a","name":"200 Minimum search query","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://pim.plytix.com/api/v1/products/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001d233274\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 002\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f09850020233274\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 003\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001e233275\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 001\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001f233274\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 004\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001a233274\",\n \"num_variations\": 5,\n \"sku\": \"Sample - 005\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001b233274\",\n \"num_variations\": 2,\n \"sku\": \"Sample - 009\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f0985001a23327e\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 008\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f0985001e233279\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 007\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f0985001b23327a\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 006\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001b233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f0985001d233278\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 011\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001b233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f09850021233275\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 010\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4eeb97050d860001717698\",\n \"num_variations\": 0,\n \"sku\": \"new variant from API\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4eec84908d2d00011c8e0b\",\n \"num_variations\": 0,\n \"sku\": \"new variant from APId\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef0c59311990001fc3db0\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef1709311990001fc3db1\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle_1\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef29d9311990001fc3db2\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle_11\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef3829311990001fc3db3\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle_111\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef3a9bedb5e000189befc\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle_1111\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef7f7bedb5e000189befd\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle111111\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef836bedb5e000189befe\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle111111111\"\n }\n ],\n \"pagination\": {\n \"count\": 20,\n \"order\": null,\n \"page\": 1,\n \"page_size\": 25,\n \"total_count\": 20\n }\n}"},{"id":"556b5352-fd78-4b73-b4ec-b07f68886ada","name":"422 Column limit exceeded","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"attributes\": [\"attributes.att_1\",\"attributes.att_2\",\"attributes.att_3\",\"attributes.att_4\",\"attributes.att_5\",\"attributes.att_6\",\"attributes.att_7\",\"attributes.att_8\",\"attributes.att_9\",\"attributes.att_10\",\"attributes.att_11\",\"attributes.att_12\",\"attributes.att_13\",\"attributes.att_14\",\"attributes.att_15\",\"attributes.att_16\",\"attributes.att_17\",\"attributes.att_18\",\"attributes.att_19\",\"attributes.att_20\", \"attributes.att_21\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://pim.plytix.com/api/v1/products/search"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"errors\": [\n {\n \"field\": \"schema\",\n \"msg\": \"columns limit exceeded, current limit is 20\"\n }\n ],\n \"msg\": \"Schema validation error\"\n }\n}"}],"_postman_id":"5b994809-7729-4c1a-87bb-b08c77631b5c"}],"id":"4bf9d65b-2e12-4586-b61e-076a42a4fcac","description":"

This section contains resources related to Products.

Every product has two sets of attributes, first set is always returned when you GET a
product and its formed by attributes shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Readonly	Mandatory
sku	string		yes
label	string
gtin	string
id	string	yes
created	date	yes
modified	date	yes
num_variations * Number of variants connected to the product	integer	yes
status	string
assets	object array
categories	object array
thumbnail	object
attributes	object
product_family_id	string	yes

The second set of attributes is formed by custom product attributes and only will be returned if they are set. Empty attributes will be stripped from the output.

This API version supports the following set of custom attributes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
Short text	string
Paragraph	string
Rich text	string
Integer number	integer
Decimal number	decimal
Dropdown	string
Multiselect	string array
URL	string
Media	Object
Media Gallery	Object array
Boolean	bool
Date	String date ISO 8601 Format

You can read out more
about parameters at attribute types

Note: Some attributes have a custom structure that must be honored

Assets parameter

This parameter stores all assets linked to a product. Each asset has the following structure:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
id	string	Asset identifier
filename	string	Name, including extension, of the file
file_size	integer	Size (in bytes) of the file
thumbnail	string	Url to the asset thumbnail
url	string	Url to the asset

For example:

{\n  \"id\": \"5bfaced551e7590001486763\",\n  \"file_size\": 78213,\n  \"filename\": \"mug.jpeg\",\n  \"thumbnail\": \"https://files.plytix.com/api/v1.0/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/mug.jpeg\",\n  \"url\": \"https://files.plytix.com/api/v1.0/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d5/ce/fa/5b/5bfaced551e7590001486763/mug.jpeg\"\n}\n\n

When posting data to the API only asset ID is required (see examples in POST section).

Thumbnail parameter

This parameter share structure and constraints as asset parameter described above

Media parameter

This parameter shares the same structure and constraints as asset parameter described above

Media Gallery Parameter

A Media Gallery is formed by a list of media parameters, each Media shares structure and constraints of asset parameters described above.

Categories parameter

This parameter shows product categories. Each category has the following structure:

ID: category identifier (string)
\n
name: name of the category (string)
\n
path: ordered string list, showing the path from this category to root level
\n

You can assign products to multiple categories.

For example

{\n  \"id\": \"5bfa91f88544120001bd907e\",\n  \"name\": \"Grandchild of Root Category\",\n  \"path\": [\n            \"Root Category\",\n            \"Child of Root Category\",\n            \"Grandchild of Root Category\",\n          ]\n}\n\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"c53a3e1c-b47a-42bf-b9d2-646b576a3174"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0fb430c1-8694-41c5-978f-0f08e4a84add"}}],"_postman_id":"4bf9d65b-2e12-4586-b61e-076a42a4fcac","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"🆕 products V2 BETA","item":[{"name":"product","item":[{"name":"assets","item":[{"name":"asset","item":[{"name":"Unbind asset from product","id":"be206b0a-9d3a-4e57-b6a1-50ed378c1d39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v2/products/:product_id/assets/:asset_id","description":"

Removes relationship between a product and an asset. Asset is not deleted

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v2/products/:product_id/assets","description":"

Get all assets related to this product

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

Link an existing asset to an existing media attribute of a product.

All parameters are mandatory:

id of the product.
\n
id of the asset.
\n
label of the attribute
\n

Unknown parameters will be ignored from request data.

Note: This method does not allow the creation of new attributes, nor upload of new assets to your PIM.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Type	Mandatory
id	asset id	string	yes
attribute_label	media attribute label	string	yes

Assets can be linked to product thumbnail and product custom media attributes. Custom product attributes are located under “attributes” parameter.

Note: Assets linked to a single product are restricted to a limit of 300 assets per product.

Thumbnail and single media attribute linking

Media gallery attribute linking

To link an existing asset to any of this kind of attribute, asset identifier and attribute_label are mandatory.
Attention: This action will add the asset to the media gallery attribute.

Example 1: link asset to thumbnail

POST /api/v2/products/6397116da02483ebd6dc76e0/assets

{\n   \"id\": \"5c4ed8002f0985001e233275\",\n   \"attribute_label\": \"thumbnail\"\n}\n\n

Example 2: link asset to custom attribute

POST /api/v2/products/6397116da02483ebd6dc76e0/assets

{\n   \"id\": \"5c4ed8002f0985001e233275\",\n   \"attribute_label\": \"dummy_media_gallery\"\n}\n\n

This section contains resources to get, assign and remove assets to the selected product.

\n","_postman_id":"fbbf7061-8c27-43cc-beaf-89fd1e8fbb77","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"categories","item":[{"name":"category","item":[{"name":"Unbind category from product","id":"01492542-8732-4213-81ff-a062bda8a01f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v2/products/:product_id/categories/:category_id","description":"

Removes relationship between a product and category. Category is not deleted

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v2/products/:product_id/categories","description":"

Get all categories related to this product

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"5c4ed7f62f0985001c233279\"\n}"},"url":"https://pim.plytix.com/api/v2/products/:product_id/categories","description":"

Link an existing category to this product.

This section contains resources to get, assign or remove categories to the selected product.

\n","_postman_id":"4cdf00da-fd32-416a-90b6-d9f55348b5b5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"variants","item":[{"name":"variant","item":[{"name":"Link variant to a product","id":"d134d646-9acd-4b5b-8be4-f5b64dad5e94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://pim.plytix.com/api/v2/products/:product_id/variant/:variant_id","description":"

Link an existing product as a variant of another product

variant_id will become a Variant of product_id

Product can be a Single product or a Parent product
\n
Variant must be a Single product
\n

Both product and variant must belong to the same Family or be Unassigned.

It will return a 204 NO CONTENT upon success.

⚠️ The result of this operation may cause data loss

Removes relationship between a variant and its parent. Variant becomes a Single product.

⚠️ This action might cause data loss

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"sku\": \"new variant from API\",\n \"label\": \"new variant label\",\n \"attributes\": {\n \"description_create_a_rich_text_type_attribute\": \"Variants can be created from the API\",\n \"price_create_a_decimal_number_type_attribute\": 23.99\n }\n}"},"url":"https://pim.plytix.com/api/v2/products/:parent_product_id/variants","description":"

Add a new product as a variant of another product.

It's necessary to send a dictionary with the info of the new variant.

It returns the id of the new product created.

⚠️ Keep in mind that converting a Single product to a Parent might cause data loss

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	Mandatory	Description
sku	yes	sku for the new product
label	no	label for the new product. Any other System attribute can be set at the same level
attributes	no	custom attribute values for the new products. If you add a parent-level attribute here it will be set as Overwritten

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"attribute_labels\": [\n \"attribute_label_1\",\n \"attribute_label_2\"\n ],\n \"variant_ids\": [\n \"\",\n \"\"\n ]\n}"},"url":"https://pim.plytix.com/api/v2/products/:parent_product_id/variants/resync","description":"

Restore the attributes at parent level of the variant with the value of the parent

It's necessary to send two list, one with the labels of the attributes and another with the ids of the variant products.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	Mandatory	Description
attribute_labels	yes	List of attribute labels to reset. These attributes must be at a parent level
variant_ids	yes	List of variant ids that are going to restore the value for the parent attributes. These ids must be variants of the parent product

A 200 OK is returned upon success.

This section contains resources to assign, create, remove or update variants to the selected product.

In this section, we will talk about 3 types of products:

Parents: those products with variants.
\n
Variants: those products that are children of a parent.
\n
Sub-variants: those products that are children of a variant.
\n
Singles: those products that are neither parents nor variants.
\n

Note that if the product has a family with attribute inheritance enabled, those attributes will be inherited from their specified level.

\n","_postman_id":"9a50dbf3-cbe3-4b79-bc20-87ff17f4c539","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"relationships","item":[{"name":"Assign products to relationship","id":"a1d6047f-e758-418c-9303-b0509f7c46cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All request must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n {\n \"quantity\": 1,\n \"product_id\": \"5d0baf07d4bf5513d190245f\"\n },\n {\n \"quantity\": 9,\n \"product_id\": \"5d0baf07d4bf5513d1902460\"\n },\n {\n \"quantity\": 6,\n \"product_id\": \"5d0baf07d4bf5513d1902461\"\n },\n {\n \"quantity\": 1,\n \"product_id\": \"5d0baf07d4bf5513d1902462\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pim.plytix.com/api/v2/products/:product_id/relationships/:relationship_id","description":"

Assign products to an existing relationship

Note: If the payload includes a product that doesn't exist or has already been added, it will be silently ignored. No error will be returned, as the system avoids extra processing to check for product validity.

A 200 OK status code is returned upon success

Request format

To assing a product to any relationship, the id of the product to be related along with its quantity must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
product_relationships	Array of objects	list with product and quantities

A product_relationship object is defined by:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
product_id	string	product identifier
quantity	number	relationship quantity

All request must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n \"671b9614919135f2b585e0z2\", \"671b9614919135f2b585e0c3\"\n ]\n}"},"url":"https://pim.plytix.com/api/v2/products/:product_id/relationships/:relationship_id","description":"

Remove products from an existing relationship

Note: If the payload includes a product that doesn't exist or is not linked to the product, it will be silently ignored. No error will be returned, as the system avoids extra processing to check for product validity.

A 204 No Content status code is returned upon success

Request format

Request format is a dictionary with \"product_relationships\" as key, and a list of relatiosnhips to unlik as value.
Ids that does not belong the relationship in that product will be ignored

\n","urlObject":{"protocol":"https","path":["api","v2","products",":product_id","relationships",":relationship_id"],"host":["pim","plytix","com"],"query":[],"variable":[{"type":"any","value":"","key":"product_id"},{"type":"any","value":"","key":"relationship_id"}]}},"response":[{"id":"26343a24-cbd1-482a-a3bd-5a4e647d54e8","name":"Remove products from a relationship","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All request must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all request are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n \"671b9614919135f2b585e0z2\", \"671b9614919135f2b585e0c3\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pim.plytix.com/api/v2/products/:product_id/relationships/:relationship_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v2","products",":product_id","relationships",":relationship_id"],"variable":[{"key":"product_id","value":""},{"key":"relationship_id","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"7b466601-7f49-47f3-88cb-34730a5f19f9"},{"name":"Modify relationship attributes","id":"dac777ca-35a3-4f52-954a-0158172845ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_relationships\": [\n {\n \"quantity\": 1,\n \"product_id\": \"5d0baf07d4bf5513d190245f\"\n },\n {\n \"quantity\": 9,\n \"product_id\": \"5d0baf07d4bf5513d1902460\"\n },\n {\n \"quantity\": 6,\n \"product_id\": \"5d0baf07d4bf5513d1902461\"\n },\n {\n \"quantity\": 1,\n \"product_id\": \"5d0baf07d4bf5513d1902462\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pim.plytix.com/api/v2/products/:product_id/relationships/:relationship_id","description":"

Modify selected relationship attributes

Modify the quantity of the related products.

A 200 OK status code will be returned upon successful call

Request format

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
product_relationships	Array of objects	list with product and quantities

A product_relationship object is defined by:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
product_id	string	product identifier
quantity	number	relationship quantity

This section contains resources to assign, remove or update related products to the selected product.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1de87714-d314-4b23-8143-c6e73daaed81"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a30a55e3-fb26-45c6-8737-acefbe327365"}}],"_postman_id":"5af32877-11cd-422e-894d-e0fee3538be7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"Removes product from the system","id":"95b67a94-b7a1-42b7-a022-d515b699e52b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v2/products/:product_id","description":"

Removes a product from the PIM

WARNING: All variants linked to this product will be removed.

If there are any variants you do not want to delete,
they must be unlinked from the parent first, which will turn them into single products.

204 code is returned upon success

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v2/products/:product_id","description":"

Gets product attributes

Every product has two sets of attributes, first set is always returned when you GET a
product and its formed by attributes shown in the following table.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Readonly	Mandatory
sku	string		yes
label	string
gtin	string
id	string	yes
created	date	yes
modified	date	yes
num_variations * Number of variants connected to the product	integer	yes
status	string
asset_ids	string array
category_ids	string array
thumbnail	string array
attributes	object
product_family_id	string	yes
overwritten_attributes	string array	yes
product_type	string	yes

The second set of attributes is formed by custom product attributes and only will be returned if they are set. Empty attributes will be stripped from the output.

This API version supports the following set of custom attributes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
Short text	string
Paragraph	string
Rich text	string
Integer number	integer
Decimal number	decimal
Dropdown	string
Multiselect	string array
URL	string
Media	string array
Media Gallery	string array
Boolean	bool
Date	String date ISO 8601 Format

Notice that this endpoint will not return the media or categories structure. To get that endpoints you have to make another request with the specific endpoint

200 code is returned upon success

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

Modifies attributes from product, leaving the rest unchanged. It will return the id of the product updated.

Assign family to a product. It will return the id of the product and the modification date.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameter	description	mandatory
product_family_id	id of the product family that is going to be assigned to the product	yes

Important notes:

Changing product family might cause data loss
\n
Product families cannot be assigned to Variant products
\n
Changing the product family will change the same fields of the variants
\n

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_data\": \"your_product_data\"\n}"},"url":"https://pim.plytix.com/api/v2/products","description":"

Creates a product

There's only a mandatory parameter, sku of the product. Readonly and unknown parameters will be
ignored from request data.

Note: This method does not allow the creation of new attributes, categories or assets.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory
sku	string	yes

Custom product attributes are located under “attributes” parameter. Thumbnail, assets, categories, media and media galleries
can be linked to a product.

Upon successful creation, a 201 http status code will be returned. The id of the new product will be included in the response.

Thumbnail, assets and media attribute linking

Media gallery

Media gallery contains a collection of medias, so in this case you need to indicate an array of asset objects.
All constraints described in asset linking section apply.

Categories linking

All constrains described in asset linking section apply to categories. Only id of the category is mandatory.

Example 1. Product creation

POST /api/v2/products/

{\n   \"sku\": \"blue adventure mug S023\",\n   \"label\": \"Adventure mug\",\n   \"attributes\" : {\n          \"stock\" : 123,\n          \"vendor_url\": \"http://acme.com\",\n          \"since\": \"2015-03-28\",\n          \"Media_gallery\":[\n                {\"id\":\"5bfaced551e7590001486763\"},\n                {\"id\":\"5bfaced551e7590001486765\"}\n          ],\n            \"media_single_1\": {\"id\":\"5bfaced551e7590001486764\"},\n      },\n    \"categories\": [\n           {\n               \"id\": \"5bfa91ab8544120001bd9078\"\n           }\n    ]\n}\n\n

201 CREATED\nBODY\n{\n    \"data\": [\n        {\n            \"id\": \"5bfad5ca5b84b100017a8f5a\",\n            \"created\": \"2018-11-25T17:03:06.596000+00:00\",\n            \"modified\": \"2018-11-25T17:03:06.628000+00:00\",\n            \"created_user_audit\": {\n                \"type\": \"API\",\n                \"user_email\": \"api\",\n                \"user_id\": \"67191ed7d6e8e300016f1414\",\n                \"user_name\": \"api\"\n            },\n            \"modified_user_audit\": {\n                \"type\": \"API\",\n                \"user_email\": \"api\",\n                \"user_id\": \"67191ed7d6e8e300016f1414\",\n                \"user_name\": \"api\"\n            },\n        }\n    ]\n}\n\n

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

Filter product by multiple criteria

Filter structure and format is described under Resources section in this guide

Product search has also support to filter products based on relationship properties. Relationship filter structure and format is described later in this document.

Please take notice of the use of attribute labels instead of attribute names in the request (see more examples below)

Also take into account that the response now will not return the media or categories structure. To get that info, you have to use the specific endpoints for that

Restrictions

Search requests
\n
- Requests are limited to 50 attributes (plus ID and SKU which are always returned). Attributes (both system and user) and properties count in this limit. Requests having more than 50 attributes will be rejected and a 422 code will be returned from API
  \n
- User attributes MUST be prefixed with “attributes.” (including the dot at the end) + the label of the attribute . So for example, if there is an attribute named “In Stock” and labeled as \"in_stock\" we MUST add it to the request as “attributes.in_stock”. Attribute names and labels can be obtained by
  means of the filters/product endpoint
  \n
- Relationship columns can also be requested. These MUST be prefixed with “relationships.” (including the dot at the end) + the label of the relationship (response is described in later in this section). Examples:
  \n
  - relationships.gift_basket
    \n
  - relationships.recommended_products
    \n
  \n
- Search filters MUST include all necessary columns. If an attribute is not explicitly requested it won’t be returned by the API.
  Available attributes can be obtained by means of the available https://pim.plytix.com/api/v1/filters/ endpoint. “key” value is what MUST be used in requests.
  Requesting non-existing attributes will return a 422 error code
  You are allowed to sort by columns not included in “attributes” field however this attribute won’t be returned User attributes MUST be prefixed with “attributes.” (including the dot at the end) + the label of the attribute
  \n
- Search filters will return a 422 error code if any of the following conditions are met:
  a) The field does not exist
  b) Operator is not allowed for the given field (available operators and fields can be obtained using /filters/{item} endpoint)
  c) Value has no meaning for the given operator. The arity of available operators can be found in API documentation
  \n
- Search filters will return a 428 status code if the filtered results include more than 10000 products and the order field is filled.
  \n
- Pagination: the number of items that can be requested (pagination.page_size) is limited to a maximum of 100 items. A 422 code will be returned from API if this limit is exceeded. If pagination is omitted 25 items of the first page will be returned
  \n
- Only one relationship can be selected in filters
  \n
\n

Relationship information in responses

When relationship columns are requested, product response will include a new field named ‘relationships’ with the following structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Type
relationships	relationship array	array of relationship information

Relationship information

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Type
relationship_id	relationship id	string
label	relationship label	string
related_products	related products	Array of product relationship data

Relationship Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Type
product_id	product ID	string
quantity	quantity	number

Attributes: [\"categories\", \"label\", \"attributes.color\", \"relationships.gift_basket\"]\n{\n     \"id\": \"5d8200527313382d939838c4\",\n     \"sku\": \"1234567890\",\n     \"categories\": [],\n     \"label\": \"Strawberry_soap\",\n     \"attributes\": {\n         \"color\": \"red\" \n     },\n     \"relationships\": [\n       {\n         \"relationship_id\": \"5ddbf89efbe0f86e3c1574c6\",\n         \"label\": \"gift_basket\",\n         \"related_products\": [\n           {\n             \"product_id\": \"5c98ef754a6c252c96793574\",\n             \"quantity\": 1\n           }\n         ]\n       }\n     ],\n   }\n\n

Relationship filters

Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Mandatory	Type
relationship_id	relationship Identifier	YES	string
operator	only ‘exists’ and ‘!exists’ are supported	YES	string
product_ids	list of product constraints	NO	Array of object (only for “exists” operator)

Complex filters can be built defining additional constraints on relationship quantity operator when relationship “exists” operator is selected. Please check the examples section.

Product_ids structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Mandatory	Type
id	product id	YES	string
qty_operator	quantity operator	YES	string
value	filter value	string	array of integer

Available operators:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operator	Arity	Type	Description
exists	Unary	-	Existence check. True when the item has its value defined
!exists	Unary	-	Non-existence check. True when the item has its value undefined
eq	Binary	value	Equality check. True if the item has the same value as the one provided When applied to a text value, the comparison ignores case
in	Binary	list	Match check. Determines if the value matches any of the values specified in the list Note: Multiselect and Dropdown attributes are case sensitive
gt	Binary	value	Greater than. True if items' value is greater than provided
gte	Binary	value	Greater than or equal to. True if item's value is greater than or equal to provided
lt	Binary	value	Less than. True if item's value is less than provided
lte	Binary	value	Less than or equal to. True if item's value is less than or equal to provided
bte	Binary	value	Between. Requires two values True if item's value is between provided values
last_days	Unary	value	Date is greater than the given days check. The filter will only take into account full days (current time is dismissed)

Examples

1.- Return default page (1) with default items per page (25) using default order (no order)
Note that this query will return just ID and SKU as no attributes have been provided

 {\n     \"filters\":[\n        [\n            {\"field\":\"modified\",\"operator\":\"gt\",\"value\":\"2018-11-01\"},\n            {\"field\":\"modified\",\"operator\":\"lt\",\"value\":\"2018-11-30\"}\n        ],\n        [\n            {\"field\":\"attributes.name\",\"operator\":\"like\",\"value\":\"unicorn\"}\n        ]\n        ]\n }\n\n

 {\n     \"attributes\":[\"sku\", \"label\", \"attributes.in_stock\", \"attributes.volume_liters\"]\n }\n\n

 {\n    \"filters\":[\n        [\n            {\"field\":\"modified\",\"operator\":\"gt\",\"value\":\"2018-11-01\"},\n            {\"field\":\"modified\",\"operator\":\"lt\",\"value\":\"2018-11-30\"}\n        ],\n        [\n            {\"field\":\"attributes.name\",\"operator\":\"like\",\"value\":\"unicorn\"}\n        ]\n        ],\n    \"pagination\":{\"order\":\"-sku\",\"page\":3,\"page_size\":25},\n    \"attributes\":[\"created\", \"attributes.in_stock\", \"attributes.name\", \"attributes.qty\"]\n}\n\n

Relationship filter examples

The following examples assume that:

There is a Symmetrical relationship named ‘Recommended products’.RP-001 is recommended with RP-002 (quantity 2) and RP-003 (quantity 3).
So RP-002 is recommended with RP-001, and RP-003 is recommended with RP-001, however RP-002 is not related to RP-003.
\n
There is an Asymmetrical relationship named “Gift basket”.
Product GF-Basket ‘includes’ GF-Wine (2 bottles), GF-Chocolates (3 packs), GF-Emmental (1 piece)
\n

Find products where the “recommended products” relationship is defined (exists).

      {\n       \"attributes\":[\"relationships.recommended_products\"],\n       \"filters\":[],\n       \"relationship_filters\":[[\n         {\n           \"relationship_id\":\"5d89c6c696c8f4a322df4bbc\",\n           \"operator\":\"exists\",\n           \"product_ids\":[],\n         }]],\n       \"pagination\": {\n         \"order\":\"\",\n         \"page\":1,\n         \"page_size\":25\n       }\n      }\n\n

The response should include RP-001, RP-002, and RP-003

Find products where “recommended products” is not defined (!exists).

      {\n       \"attributes\":[\"relationships.recommended_products\"],\n       \"filters\":[],\n       \"relationship_filters\":[[\n         {\n           \"relationship_id\":\"5d89c6c696c8f4a322df4bbc\",\n           \"operator\":\"!exists\",\n           \"product_ids\":[]\n         }]],\n         \"pagination\":{\n           \"order\":\"\",\n           \"page\":1,\n           \"page_size\":25\n         }\n      }\n\n

The response should not include RP-001, RP-002 or RP-003

Find the products for which the “recommended products” relationship is defined (a.k.a exists) with the RP-002 product

      {\n       \"filters\":[],\n       \"attributes\":[\"relationships.recommended_products\"],\n       \"relationship_filters\":[[\n         {\n           \"product_ids\":[\n           {\n             \"id\":\"5d89c68596c8f4a322df4bb9\",\n             \"qty_operator\":\"exists\",\n             \"value\":null\n           }],\n           \"relationship_id\":\"5d89c6c696c8f4a322df4bbc\",\n           \"operator\":\"exists\"\n         }]],\n       \"pagination\": {\n         \"order\":null,\n         \"page\":1,\n         \"page_size\":25\n       }\n      }\n\n

Response should include RP-001

      {\n       \"data\": [\n         {\n           \"attributes\": {},\n           \"id\": \"5d89c67796c8f4a322df4bb8\",\n           \"sku\": \"RP-001\",\n           \"relationships\": [\n              {\n                  \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n                  \"label\": \"recommended_products\",\n                  \"related_products\": [\n                      {\n                          \"product_id\": \"5d89c68596c8f4a322df4bb9\",\n                          \"quantity: \"2\"\n                      },\n                      {\n                          \"product_id\": \"5d89c69496c8f4a322df4bba\",\n                          \"quantity: \"3\"\n                      }\n                  ]\n              }\n           ]\n         }\n       ],\n       \"pagination\": {\n         \"count\": 1,\n         \"order\": null,\n         \"page\": 1,\n         \"page_size\": 25,\n         \"total_count\": 3\n       }\n      }\n\n

Filter the products for which the relationship with the product RP-001 is defined and whose quantity is greater than 2Please, note that the \"value\" field is an array of one element

      {\n         \"filters\": [],\n         \"attributes\": [\n             \"relationships.recommended_products\"\n         ],\n         \"relationship_filters\": [\n             [\n                 {\n                     \"product_ids\": [\n                         {\n                             \"id\": \"5d89c67796c8f4a322df4bb8\",\n                             \"qty_operator\": \"gt\",\n                             \"value\": [\n                                 2\n                             ]\n                         }\n                     ],\n                     \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n                     \"operator\": \"exists\"\n                 }\n             ]\n         ],\n         \"pagination\": {\n             \"order\": null,\n             \"page\": 1,\n             \"page_size\": 25\n         }\n      }\n\n

Response should exclude RP-002, due to its quantity being 2, and include RP-003

      {\n       \"data\": [\n         {\n           \"attributes\": {},\n           \"id\": \"5d89c69496c8f4a322df4bba\",\n           \"sku\": \"RP-003\",\n           \"relationships\": [\n              {\n                  \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n                  \"label\": \"recommended_products\",\n                  \"related_products\": [\n                      {\n                          \"product_id\": \"5d89c67796c8f4a322df4bb8\",\n                          \"quantity: \"3\"\n                      }\n                  ]\n              }\n           ]\n         }\n       ],\n       \"pagination\": {\n         \"count\": 1,\n         \"order\": null,\n         \"page\": 1,\n         \"page_size\": 25,\n         \"total_count\": 3\n       }\n      }\n\n

      {\n         \"filters\": [],\n         \"attributes\": [\n             \"relationships.recommended_products\"\n         ],\n         \"relationship_filters\": [\n             [\n                 {\n                     \"product_ids\": [\n                         {\n                             \"id\": \"5d89c67796c8f4a322df4bb8\",\n                             \"qty_operator\": \"bte\",\n                             \"value\": [\n                                 1,\n                                 2\n                             ]\n                         }\n                     ],\n                     \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n                     \"operator\": \"exists\"\n                 }\n             ]\n         ],\n         \"pagination\": {\n             \"order\": null,\n             \"page\": 1,\n             \"page_size\": 25\n         }\n      }\n\n

Response should exclude RP-003, which has a quantity of 3, and include RP-002

      {\n       \"data\": [\n         {\n           \"attributes\": {},\n           \"id\": \"5d89c68596c8f4a322df4bb9\",\n           \"sku\": \"RP-002\",\n           \"relationships\": [\n              {\n                  \"relationship_id\": \"5d89c6c696c8f4a322df4bbc\",\n                  \"label\": \"recommended_products\",\n                  \"related_products\": [\n                      {\n                          \"product_id\": \"5d89c68596c8f4a322df4bb9\",\n                          \"quantity: \"2\"\n                      }\n                  ]\n              }\n           ]         \n         }\n       ],\n       \"pagination\": {\n         \"order\": null,\n         \"page\": 1,\n         \"page_size\": 25,\n       }\n      }\n\n

Find all products where ‘Gift basket’ is defined

      {\n         \"filters\": [],\n         \"attributes\": [\n             \"relationships.gift_basket\"\n         ],\n         \"relationship_filters\": [\n             [\n                 {\n                     \"product_ids\": [],\n                     \"relationship_id\": \"5d89d4fd96c8f4a322df4bc0\",\n                     \"operator\": \"exists\"\n                 }\n             ]\n         ],\n         \"pagination\": {\n             \"order\": null,\n             \"page\": 1,\n             \"page_size\": 25\n         }\n      }\n\n

The response should include 'GF-Basket' product.

      {\n         \"data\": [\n             {\n                 \"attributes\": {},\n                 \"id\": \"5d89d51a96c8f4a322df4bc1\",\n                 \"sku\": \"GF-Basket\",\n                 \"relationships\": [\n                      {\n                          \"relationship_id\": \"5d89d4fd96c8f4a322df4bc0\",\n                          \"label\": \"gift_basket\",\n                          \"related_products\": [\n                              {\n                                  \"product_id\": \"5d89d51a96c8f4a322df4bc2\",\n                                  \"quantity: \"2\"\n                              },\n                              {\n                                  \"product_id\": \"5d89d52f96c8f4a322df4bc3\",\n                                  \"quantity: \"3\"\n                              },\n                              {\n                                  \"product_id\": \"5d89d54396c8f4a322df4bc4\",\n                                  \"quantity: \"1\"\n                              }                            \n                          ]\n                      }\n                  ]               \n             }\n         ],\n         \"pagination\": {\n             \"count\": 1,\n             \"order\": null,\n             \"page\": 1,\n             \"page_size\": 25,\n             \"total_count\": 7\n         }\n      }\n\n

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe68dfba44f77d7c75f9d0\"\n },\n {\n \"id\": \"5ebe68e0ba44f77d7c75f9d2\"\n },\n {\n \"id\": \"5ebe68e1ba44f77d7c75f9d4\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d6\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383adf18d516fbbac718d\",\n \"label\": \"Backpack Venice - Coco\",\n \"modified\": \"2020-05-19T07:03:05.787000+00:00\",\n \"num_variations\": 5,\n \"sku\": \"1013\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe68e1ba44f77d7c75f9d4\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf18d516fbbac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Black Rose\"\n ],\n \"discontinued\": false,\n \"features_html\": \"

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe690465931c704d75f9f4\"\n },\n {\n \"id\": \"5ebe690565931c704d75f9f6\"\n },\n {\n \"id\": \"5ebe690565931c704d75f9f8\"\n },\n {\n \"id\": \"5ebe690665931c704d75f9fa\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383c6421a5e26d9ac71b1\",\n \"label\": \"Backpack Venice - Black Rose\",\n \"modified\": \"2020-05-19T07:03:29.937000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1016\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe690565931c704d75f9f8\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf18d516fbbac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Almond\"\n ],\n \"discontinued\": false,\n \"features_html\": \"

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe690765931c704d75f9fe\"\n },\n {\n \"id\": \"5ebe690865931c704d75fa00\"\n },\n {\n \"id\": \"5ebe690965931c704d75fa02\"\n },\n {\n \"id\": \"5ebe690a65931c704d75fa04\"\n },\n {\n \"id\": \"5ebe690c65931c704d75fa06\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383c8421a5e26d9ac71bb\",\n \"label\": \"Backpack Venice - Almond\",\n \"modified\": \"2020-05-19T07:03:35.905000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1017\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe690a65931c704d75fa04\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf18d516fbbac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Black Noise\"\n ],\n \"discontinued\": true,\n \"features_html\": \"

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe690d65931c704d75fa0a\"\n },\n {\n \"id\": \"5ebe690e65931c704d75fa0c\"\n },\n {\n \"id\": \"5ebe690f65931c704d75fa0e\"\n },\n {\n \"id\": \"5ebe691065931c704d75fa10\"\n },\n {\n \"id\": \"5ebe691265931c704d75fa12\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383cd421a5e26d9ac71c7\",\n \"label\": \"Backpack Venice - Black Noise\",\n \"modified\": \"2020-05-19T07:03:41.404000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1018\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe691065931c704d75fa10\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf18d516fbbac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Morning Mist\"\n ],\n \"discontinued\": false,\n \"features_html\": \"

Internal 15” padded laptop sleeve
Padded tablet sleeve
Large main compartment with string cord closure
Magnet closures on the flap
Flap pocket with keyring
Premium urban fashion fabric
Comfort straps with metal buckles
Quilted back panel

\",\n \"launch_date\": \"2019-12-01\",\n \"long_description\": \"Classic minimalist look meets modern conveniences. This classical looking bag looks simple from the outside, but once you take a closer look you will find that is has organizational compartments for your everyday travel like the Quick-access “15 Padded Laptop Sleeve and iPod compartment, and 28L volume.\",\n \"price_store\": 97.43,\n \"product_gallery\": [\n {\n \"id\": \"5ebe6912b8b8d47fc575f9ea\"\n },\n {\n \"id\": \"5ebe6914b8b8d47fc575f9ec\"\n },\n {\n \"id\": \"5ebe6915b8b8d47fc575f9ee\"\n },\n {\n \"id\": \"5ebe68e3ba44f77d7c75f9d8\"\n }\n ],\n \"short_description\": \"Minimalist look meets modern conveniences\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"26\"\n },\n \"id\": \"5ec383d17c936bcce4ac71a6\",\n \"label\": \"Backpack Venice - Morning Mist\",\n \"modified\": \"2020-05-19T07:03:41.582000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1014\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe6914b8b8d47fc575f9ec\"\n }\n },\n {\n \"_parent_id\": \"5ec383adf28c84a676ac718d\",\n \"attributes\": {\n \"colorways\": [\n \"Dead Flower\"\n ],\n \"discontinued\": true,\n \"features_html\": \"

Urban mobility bag with roll-top closure
Large, size adjustable main compartment with internal zip pocket
Padded 15” laptop pocket with external access
Quick-access travel-doc pocket
Front zip organizer pocket
Side handle
Padded ergo straps with adjustable chest straps
Soft padded mesh back panel
Gear loops

Urban mobility bag with roll-top closure
Large, size adjustable main compartment with internal zip pocket
Padded 15” laptop pocket with external access
Quick-access travel-doc pocket
Front zip organizer pocket
Side handle
Padded ergo straps with adjustable chest straps
Soft padded mesh back panel
Gear loops

Urban mobility bag with roll-top closure
Large, size adjustable main compartment with internal zip pocket
Padded 15” laptop pocket with external access
Quick-access travel-doc pocket
Front zip organizer pocket
Side handle
Padded ergo straps with adjustable chest straps
Soft padded mesh back panel
Gear loops

\",\n \"launch_date\": \"2020-06-01\",\n \"long_description\": \"Designed to be well-equipped for calculated city missions and last minute adventures into uncharted terrain, the Scrambler backpack combines durable adventure solutions into a sleek urban style. The ergonomically fitted backpack straps allow you to comfortably carry your required accessaries for your next mission, while the side handle allows for easy handling and a professional look during you daily routine. The roll-top closure will allow for more space in the main compartment if needed, and adjust to fit your required space perfectly for the day. The 15” laptop pocket with external access and quick-access travel pocket will allow you to get to your computer and documents without having to dig through the main compartment if you are in a hurry. If you are looking for a versatile bag for daily usages in and out of the city in a beautiful classic silhouette, than the Scrambler was built for you.\",\n \"price_store\": 130.76,\n \"product_gallery\": [\n {\n \"id\": \"5ebe6903b8b8d47fc575f9d0\"\n },\n {\n \"id\": \"5ebe6926df2179290375fa22\"\n },\n {\n \"id\": \"5ebe6927df2179290375fa24\"\n },\n {\n \"id\": \"5ebe6928df2179290375fa26\"\n },\n {\n \"id\": \"5ebe6928df2179290375fa28\"\n },\n {\n \"id\": \"5ebe6929df2179290375fa2a\"\n },\n {\n \"id\": \"5ebe692adf2179290375fa2c\"\n },\n {\n \"id\": \"5ebe692bdf2179290375fa2e\"\n },\n {\n \"id\": \"5ebe692cdf2179290375fa30\"\n },\n {\n \"id\": \"5ebe692ddf2179290375fa32\"\n },\n {\n \"id\": \"5ebe692ddf2179290375fa34\"\n },\n {\n \"id\": \"5ebe692edf2179290375fa36\"\n },\n {\n \"id\": \"5ebe692edf2179290375fa38\"\n },\n {\n \"id\": \"5ebe692fdf2179290375fa3a\"\n },\n {\n \"id\": \"5ebe6930df2179290375fa3c\"\n },\n {\n \"id\": \"5ebe6930df2179290375fa3e\"\n },\n {\n \"id\": \"5ebe6931df2179290375fa40\"\n },\n {\n \"id\": \"5ebe6931df2179290375fa42\"\n },\n {\n \"id\": \"5ebe6932df2179290375fa44\"\n },\n {\n \"id\": \"5ebe6932df2179290375fa46\"\n }\n ],\n \"short_description\": \"Built For Endless Possibilities\",\n \"video_url\": \"https://www.youtube.com/channel/UC2dNxluXutX8vabK_eO1k5Q/featured\",\n \"volume_liters\": \"30\"\n },\n \"id\": \"5ec383de34f631942dac71dd\",\n \"label\": \"Backpack Scrambler - Black Noise\",\n \"modified\": \"2020-05-19T07:03:58.533000+00:00\",\n \"num_variations\": 0,\n \"sku\": \"1011\",\n \"status\": \"Draft\",\n \"thumbnail\": {\n \"id\": \"5ebe6931df2179290375fa40\"\n }\n }\n ],\n \"pagination\": {\n \"count\": 8,\n \"order\": \"attributes.price_store\",\n \"page\": 1,\n \"page_size\": 25,\n \"total_count\": 18\n }\n}"},{"id":"e5ec1f33-7d45-42c4-94cd-eada21dc9c51","name":"200 Minimum search query","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n}"},"url":"https://pim.plytix.com/api/v2/products/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001d233274\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 002\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f09850020233274\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 003\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001e233275\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 001\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001f233274\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 004\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001a233274\",\n \"num_variations\": 5,\n \"sku\": \"Sample - 005\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ed8002f0985001b233274\",\n \"num_variations\": 2,\n \"sku\": \"Sample - 009\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f0985001a23327e\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 008\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f0985001e233279\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 007\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f0985001b23327a\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 006\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001b233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f0985001d233278\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 011\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001b233274\",\n \"attributes\": {},\n \"id\": \"5c4ed80c2f09850021233275\",\n \"num_variations\": 0,\n \"sku\": \"Sample - 010\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4eeb97050d860001717698\",\n \"num_variations\": 0,\n \"sku\": \"new variant from API\"\n },\n {\n \"_parent_id\": \"5c4ed8002f0985001a233274\",\n \"attributes\": {},\n \"id\": \"5c4eec84908d2d00011c8e0b\",\n \"num_variations\": 0,\n \"sku\": \"new variant from APId\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef0c59311990001fc3db0\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef1709311990001fc3db1\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle_1\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef29d9311990001fc3db2\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle_11\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef3829311990001fc3db3\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle_111\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef3a9bedb5e000189befc\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle_1111\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef7f7bedb5e000189befd\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle111111\"\n },\n {\n \"attributes\": {},\n \"id\": \"5c4ef836bedb5e000189befe\",\n \"num_variations\": 0,\n \"sku\": \"Black Kettle111111111\"\n }\n ],\n \"pagination\": {\n \"count\": 20,\n \"order\": null,\n \"page\": 1,\n \"page_size\": 25,\n \"total_count\": 20\n }\n}"},{"id":"c0746dc3-3f4f-446c-9700-eb81b08babde","name":"422 Column limit exceeded","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"attributes\": [\"attributes.att_1\", \"attributes.att_2\", \"attributes.att_3\", \"attributes.att_4\", \"attributes.att_5\", \"attributes.att_6\", \"attributes.att_7\", \"attributes.att_8\", \"attributes.att_9\", \"attributes.att_10\", \"attributes.att_11\", \"attributes.att_12\", \"attributes.att_13\", \"attributes.att_14\", \"attributes.att_15\", \"attributes.att_16\", \"attributes.att_17\", \"attributes.att_18\", \"attributes.att_19\", \"attributes.att_20\", \"attributes.att_21\", \"attributes.att_22\", \"attributes.att_23\", \"attributes.att_24\", \"attributes.att_25\", \"attributes.att_26\", \"attributes.att_27\", \"attributes.att_28\", \"attributes.att_29\", \"attributes.att_30\", \"attributes.att_31\", \"attributes.att_32\", \"attributes.att_33\", \"attributes.att_34\", \"attributes.att_35\", \"attributes.att_36\", \"attributes.att_37\", \"attributes.att_38\", \"attributes.att_39\", \"attributes.att_40\", \"attributes.att_41\", \"attributes.att_42\", \"attributes.att_43\", \"attributes.att_44\", \"attributes.att_45\", \"attributes.att_46\", \"attributes.att_47\", \"attributes.att_48\", \"attributes.att_49\", \"attributes.att_50\", \"attributes.att_51\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://pim.plytix.com/api/v2/products/search"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"errors\": [\n {\n \"field\": \"schema\",\n \"msg\": \"columns limit exceeded, current limit is 50\"\n }\n ],\n \"msg\": \"Schema validation error\"\n }\n}"}],"_postman_id":"1cdf025d-9784-4881-9dbc-3a49c5291a3a"}],"id":"c616a27a-2ee0-4561-8acb-f950b259d052","description":"

We recently launched our API v2 open beta, which is publicly available to all Plytix accounts. Throughout the beta process, we’ll be adding more features, improving performance, and expanding documentation.

We appreciate your involvement and invite you to share with us your feedback. If you have any questions or need assistance, feel free to reach out to our support team.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"317ec7a5-4e54-4b89-8381-dd36a1acea0e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c7a21d2a-1850-4d57-bcf0-85130e77802c"}}],"_postman_id":"c616a27a-2ee0-4561-8acb-f950b259d052","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"product attributes","item":[{"name":"product attribute","item":[{"name":"Get product attribute","id":"d5b9477f-77db-42dc-8894-14312da9e5e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://pim.plytix.com/api/v1/attributes/product/:product_attribute_id","description":"

Retrieves a product attribute by id

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/attributes/product/:product_attribute_id","description":"

This resource allows you to modify some properties of existing attributes.

All attributes can patch name and description fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
name	string	friendly name for the attribute
description	string	to help other users to understand what kind of information this attribute holds

DropdownAttribute and MultiselecAttributes can also patch available options. NOTE options will replace existing ones
\n
CompletenessAttribute can patch its \"attributes\".
\n

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/attributes/product/:product_attribute_id","description":"

Deletes an attribute. An empty response and 202 code is returned upon successful call.

You are not allowed to delete any attribute used in some E-Catalog, Channel or Pdf-Catalog and a 409 CONFLICT response code will be returned and some information on where this attribue is used.

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://pim.plytix.com/api/v1/attributes/product/search","description":"

Filter product attributes by multiple criteria

Filter structure and format is described under Resources section in this guide.

Restrictions

Search requests
\n
- Search filters MUST include all necessary columns. If an attribute is not explicitly requested it won’t be returned by the API. Available attributes can be found later in this section. \n Requesting non-existing attributes will return a 422 error code.\n You are allowed to sort by columns not included in “attributes” field, however this attribute won’t be returned
\n

Response Format

Endpoint successful responses are wrapped in { data: [ ...] } object as in any other search endpoint. You can read more about response format in Resources section in this guide.

All attributes share a set of common fields while some attributes also have some custom attributes, current version supports the following attributes*.

Please ** DO NOT ** rely in any other attribute returned by endpoints as they can dissapear in future releases of the API

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Attribute type
id	Attribute unique identifier	ALL
name	Attribute name, usually contains some human friendly name	ALL
label	Attribute unique label, generated by PIM and used in searches, etc.	ALL
type_class	Attribute class identifier, you can check available values in Product Attributes main section in this guide	ALL
groups	Array of group identifiers where this attribute belongs to	ALL
options	Array of available values for attribute	MultiSelectAttribute, DropdownAttribute
attributes	Array of objects of the form {'id': ..., 'label': ...}	CompletenessAttribute

Basic Example

Complex examples can be found in code examples

1.- Search for all product attributes and all fields (a.k.a no-filters) 100 items max.

Formatted JSON Data\n{  \n   \"filters\":[],\n   \"attributes\":[  \n      \"name\",\n      \"label\",\n      \"attributes\",\n      \"groups\",\n      \"type_class\",\n      \"options\"\n   ],\n   \"pagination\":{  \n      \"page_size\":100,\n      \"page\":1,\n      \"order\":\"\"\n   }\n}\n

Response

Formatted JSON Data\n{  \n   \"data\":[\n       {\n            \"id\": \"5d00ae1aebd6f0000170c3d5\", \n            \"label\": \"in_stock\", \n            \"name\": \"In Stock\", \n            \"type_class\": \"BooleanAttribute\",\n            \"groups\": [\n                \"5d00d00fc3ddd200018d92f4\"\n             ] \n        },\n        {\n            \"id\": \"5d0384c339d49f0001391965\", \n            \"name\": \"color\", \n            \"label\": \"color\", \n            \"groups\": [], \n            \"options\": [\n                \"blue\",\n                \"black\", \n                \"green\", \n                \"red\"\n            ], \n            \"type_class\": \"MultiSelectAttribute\"\n        }\n   ],\n   \"pagination\":{\n     \"count\": 2, \n     \"order\": \"\", \n     \"page\": 1, \n     \"page_size\": 100, \n     \"total_count\": 2\n   }\n}\n

2.- Search for \"Rich info complete\" completeness attribute. This completeness attribute is formed by System attributes: 'sku' and 'label' and product attribute 'Additional Image Gallery'

Formatted JSON Data\n{  \n   \"filters\":[[{\"field\":\"name\",\"operator\":\"like\",\"value\":\"RiCh InFo\"}]],\n   \"attributes\":[  \n      \"name\",\n      \"label\",\n      \"attributes\",\n      \"type_class\",\n   ],\n   \"pagination\":{  \n      \"page_size\":25,\n      \"page\":1,\n      \"order\":\"\"\n   }\n}\n\n

Response

Formatted JSON Data\n{\n  \"data\": [\n    {\n      \"attributes\": [\n        {\n          \"id\": null, \n          \"label\": \"sku\"\n        }, \n        {\n          \"id\": null, \n          \"label\": \"label\"\n        }, \n        {\n          \"id\": \"5c582c9c9e877f04666c64ac\", \n          \"label\": \"additional_image_gallery\"\n        }\n      ], \n      \"id\": \"5c766b364931b805abd334a0\", \n      \"label\": \"rich_info_complete\", \n      \"name\": \"Rich Info Complete \", \n      \"type_class\": \"CompletenessAttribute\"\n    }\n  ], \n  \"pagination\": {\n    \"count\": 1, \n    \"order\": null, \n    \"page\": 1, \n    \"page_size\": 25, \n    \"total_count\": 82\n  }\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","attributes","product","search"],"host":["pim","plytix","com"],"query":[],"variable":[]}},"response":[{"id":"b01bdc28-93d0-414f-8ef1-7f20354b8fe1","name":"Search by type","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [\n [\n {\n \"field\": \"type_class\",\n \"operator\": \"eq\",\n \"value\": \"MultilineAttribute\"\n }\n ]\n ],\n \"pagination\": {\n \"count\": 10,\n \"order\": null,\n \"page\": 1,\n \"page_size\": 25,\n \"total_count\": 82\n },\n \"attributes\": [\n \"id\",\n \"name\",\n \"label\",\n \"attributes\",\n \"groups\",\n \"type_class\",\n \"options\"\n ]\n}"},"url":"https://pim.plytix.com/api/v1/attributes/product/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ],\n \"id\": \"5c19ffda0b64d40460c50d1e\",\n \"label\": \"description\",\n \"name\": \"Description\",\n \"type_class\": \"MultilineAttribute\"\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ],\n \"id\": \"5c582c819e877f04666c64a8\",\n \"label\": \"feature_description\",\n \"name\": \"Feature Description\",\n \"type_class\": \"MultilineAttribute\"\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c59ad3d9e877f04655791c2\"\n ],\n \"id\": \"5c59ad8a9e877f04666c676c\",\n \"label\": \"description_de\",\n \"name\": \"Description DE\",\n \"type_class\": \"MultilineAttribute\"\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c59ad4e9e877f04655791c3\"\n ],\n \"id\": \"5c59ad929e877f04666c676e\",\n \"label\": \"description_it\",\n \"name\": \"Description IT\",\n \"type_class\": \"MultilineAttribute\"\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c59ad5a9e877f0467b57c6a\"\n ],\n \"id\": \"5c59ad9d9e877f04655791c6\",\n \"label\": \"description_es\",\n \"name\": \"Description ES\",\n \"type_class\": \"MultilineAttribute\"\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c59ad639e877f04655791c4\"\n ],\n \"id\": \"5c59ada39e877f04655791c8\",\n \"label\": \"description_dk\",\n \"name\": \"Description DK\",\n \"type_class\": \"MultilineAttribute\"\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c59ad3d9e877f04655791c2\"\n ],\n \"id\": \"5c59adb79e877f04666c6770\",\n \"label\": \"feature_description_de\",\n \"name\": \"Feature Description DE\",\n \"type_class\": \"MultilineAttribute\"\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c59ad4e9e877f04655791c3\"\n ],\n \"id\": \"5c59adbc9e877f04666c6772\",\n \"label\": \"feature_description_it\",\n \"name\": \"Feature Description IT\",\n \"type_class\": \"MultilineAttribute\"\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c59ad5a9e877f0467b57c6a\"\n ],\n \"id\": \"5c59adc39e877f04666c6774\",\n \"label\": \"feature_description_es\",\n \"name\": \"Feature Description ES\",\n \"type_class\": \"MultilineAttribute\"\n },\n {\n \"filter_type\": \"TextAttribute\",\n \"groups\": [\n \"5c59ad639e877f04655791c4\"\n ],\n \"id\": \"5c59adca9e877f0467b57c6e\",\n \"label\": \"feature_description_dk\",\n \"name\": \"Feature Description DK\",\n \"type_class\": \"MultilineAttribute\"\n }\n ],\n \"pagination\": {\n \"count\": 10,\n \"order\": null,\n \"page\": 1,\n \"page_size\": 25,\n \"total_count\": 82\n }\n}"},{"id":"2194b6b0-1ec9-4f39-8a9e-fc4ae8737838","name":"Search product attributes with no filter","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [[]],\n \"attributes\": [\n \"name\",\n \"label\",\n \"options\",\n \"attributes\",\n \"groups\",\n \"type_class\"\n ],\n \"pagination\": {\n \"page_size\": 100,\n \"page\": 1,\n \"order\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pim.plytix.com/api/v1/attributes/product/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"filter_type\": \"MediaGalleryAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c582c9c9e877f04666c64ac\", \n \"label\": \"additional_image_galery\", \n \"name\": \"additional image galery\", \n \"type_class\": \"MediaGalleryAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf227264792045ec5e57d\", \n \"label\": \"amazon_1000_image\", \n \"name\": \"amazon_1000_image\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf22b7eda920463fda679\", \n \"label\": \"amazon_110_image\", \n \"name\": \"amazon_110_image\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf231264792045d16e6d8\", \n \"label\": \"amazon_other_image_1\", \n \"name\": \"amazon_other_image_1\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf235264792045d16e6da\", \n \"label\": \"amazon_other_image_2\", \n \"name\": \"amazon_other_image_2\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf2387eda920462da36c7\", \n \"label\": \"amazon_other_image_3\", \n \"name\": \"amazon_other_image_3\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf23b7eda920462da36c9\", \n \"label\": \"amazon_other_image_4\", \n \"name\": \"amazon_other_image_4\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf23f264792045ec5e57f\", \n \"label\": \"amazon_other_image_5\", \n \"name\": \"amazon_other_image_5\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf243264792045d16e6dc\", \n \"label\": \"amazon_other_image_6\", \n \"name\": \"amazon_other_image_6\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf247264792045cd5a743\", \n \"label\": \"amazon_other_image_7\", \n \"name\": \"amazon_other_image_7\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5e39e877f0467b57c81\"\n ], \n \"id\": \"5c59b6ba9e877f0467b57c83\", \n \"label\": \"application_place\", \n \"name\": \"Application place\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c9a59a76112fe04618d71e1\", \n \"label\": \"availability\", \n \"name\": \"availability\", \n \"options\": [\n \"in stock\", \n \"out of stock\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"attributes\": [\n {\n \"id\": \"5c582c419e877f04666c64a4\", \n \"label\": \"gtin\"\n }, \n {\n \"id\": \"5c582c269e877f04666c64a1\", \n \"label\": \"brand\"\n }, \n {\n \"id\": \"5c582c6e9e877f04666c64a6\", \n \"label\": \"title\"\n }\n ], \n \"filter_type\": \"DecimalAttribute\", \n \"groups\": [\n \"5c582a769e877f0467b57ab5\"\n ], \n \"id\": \"5c59b93e9e877f04666c67a3\", \n \"label\": \"basic_info_complete\", \n \"name\": \"Basic Info Complete \", \n \"type_class\": \"CompletenessAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c6165c2e4db4e0461c9bfba\", \n \"label\": \"bathroom_picture\", \n \"name\": \"Display Picture\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5d99e877f0467b57c80\"\n ], \n \"id\": \"5c59b7879e877f0467b57c89\", \n \"label\": \"bowl_depth_mm\", \n \"name\": \"Bowl depth (mm)\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5d99e877f0467b57c80\"\n ], \n \"id\": \"5c59b7919e877f0467b57c8b\", \n \"label\": \"bowl_length_mm\", \n \"name\": \"Bowl length (mm)\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5d99e877f0467b57c80\"\n ], \n \"id\": \"5c59b79c9e877f04655791f1\", \n \"label\": \"bowl_position\", \n \"name\": \"Bowl position\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5d99e877f0467b57c80\"\n ], \n \"id\": \"5c59b7a99e877f0467b57c8d\", \n \"label\": \"bowl_width_mm\", \n \"name\": \"Bowl width (mm)\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5c582a769e877f0467b57ab5\"\n ], \n \"id\": \"5c582c269e877f04666c64a1\", \n \"label\": \"brand\", \n \"name\": \"Brand\", \n \"options\": [\n \"Plytix\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1f4264792045d16e6d0\", \n \"label\": \"bullet_1\", \n \"name\": \"bullet_1\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1f7264792045d16e6d2\", \n \"label\": \"bullet_2\", \n \"name\": \"bullet_2\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1fa264792045cd5a741\", \n \"label\": \"bullet_3\", \n \"name\": \"bullet_3\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1fd264792045ec5e577\", \n \"label\": \"bullet_4\", \n \"name\": \"bullet_4\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf2017eda920463fda671\", \n \"label\": \"bullet_5\", \n \"name\": \"bullet_5\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c617428e4db4e0461c9bffd\", \n \"label\": \"collection\", \n \"name\": \"Collection \", \n \"options\": [\n \"2019\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c19ffd30b64d40460c50d1c\", \n \"label\": \"color\", \n \"name\": \"Color\", \n \"options\": [\n \"Stone\", \n \"Chrome\", \n \"Brushed Nickel\", \n \"Black\", \n \"Beige\", \n \"White\", \n \"Antique Bronze\", \n \"Bamboo\", \n \"Bisque\", \n \"Copper\", \n \"Natural Wood\", \n \"Slate\", \n \"Mocha\", \n \"Glass\", \n \"Silver\", \n \"Bronze\", \n \"Stainless Steel\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c9a5a2f6112fe0462038617\", \n \"label\": \"condition\", \n \"name\": \"condition\", \n \"options\": [\n \"new\", \n \"used\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c19ffda0b64d40460c50d1e\", \n \"label\": \"description\", \n \"name\": \"Description\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59ad3d9e877f04655791c2\"\n ], \n \"id\": \"5c59ad8a9e877f04666c676c\", \n \"label\": \"description_de\", \n \"name\": \"Description DE\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59ad639e877f04655791c4\"\n ], \n \"id\": \"5c59ada39e877f04655791c8\", \n \"label\": \"description_dk\", \n \"name\": \"Description DK\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59ad5a9e877f0467b57c6a\"\n ], \n \"id\": \"5c59ad9d9e877f04655791c6\", \n \"label\": \"description_es\", \n \"name\": \"Description ES\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59ad4e9e877f04655791c3\"\n ], \n \"id\": \"5c59ad929e877f04666c676e\", \n \"label\": \"description_it\", \n \"name\": \"Description IT\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1f0264792045ec5e575\", \n \"label\": \"display_dimensions_unit_of_measure\", \n \"name\": \"display_dimensions_unit_of_measure\", \n \"options\": [\n \"cm\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c5837619e877f0465578ea4\"\n ], \n \"id\": \"5c19fff00b64d40460c50d20\", \n \"label\": \"eta_stock_date\", \n \"name\": \"ETA Stock Date\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5e39e877f0467b57c81\"\n ], \n \"id\": \"5c59b6e69e877f04666c679a\", \n \"label\": \"faucets_finish\", \n \"name\": \"Faucets Finish \", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c582c819e877f04666c64a8\", \n \"label\": \"feature_description\", \n \"name\": \"Feature Description\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59ad3d9e877f04655791c2\"\n ], \n \"id\": \"5c59adb79e877f04666c6770\", \n \"label\": \"feature_description_de\", \n \"name\": \"Feature Description DE\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59ad639e877f04655791c4\"\n ], \n \"id\": \"5c59adca9e877f0467b57c6e\", \n \"label\": \"feature_description_dk\", \n \"name\": \"Feature Description DK\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59ad5a9e877f0467b57c6a\"\n ], \n \"id\": \"5c59adc39e877f04666c6774\", \n \"label\": \"feature_description_es\", \n \"name\": \"Feature Description ES\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59ad4e9e877f04655791c3\"\n ], \n \"id\": \"5c59adbc9e877f04666c6772\", \n \"label\": \"feature_description_it\", \n \"name\": \"Feature Description IT\", \n \"type_class\": \"MultilineAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5d99e877f0467b57c80\"\n ], \n \"id\": \"5c59b7b89e877f0467b57c8f\", \n \"label\": \"fixing_kit\", \n \"name\": \"Fixing kit\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"IntAttribute\", \n \"groups\": [\n \"5c582a769e877f0467b57ab5\"\n ], \n \"id\": \"5c582c419e877f04666c64a4\", \n \"label\": \"gtin\", \n \"name\": \"GTIN\", \n \"type_class\": \"IntAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5e39e877f0467b57c81\"\n ], \n \"id\": \"5c59b6f79e877f04655791e9\", \n \"label\": \"handle_position\", \n \"name\": \"Handle position\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"MediaAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c582c8f9e877f04666c64aa\", \n \"label\": \"hero_image\", \n \"name\": \"Hero Image\", \n \"type_class\": \"MediaAttribute\"\n }, \n {\n \"filter_type\": \"BooleanAttribute\", \n \"groups\": [\n \"5c5837619e877f0465578ea4\"\n ], \n \"id\": \"5c19fffa0b64d40461359457\", \n \"label\": \"in_stock\", \n \"name\": \"In Stock\", \n \"type_class\": \"BooleanAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5e39e877f0467b57c81\"\n ], \n \"id\": \"5c59b7039e877f0467b57c86\", \n \"label\": \"installation_type\", \n \"name\": \"Installation type\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5d99e877f0467b57c80\"\n ], \n \"id\": \"5c59b7d89e877f04655791f4\", \n \"label\": \"installation_type_bowls\", \n \"name\": \"Installation type Bowls\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"MediaGalleryAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5cde82fecd91d60469de0323\", \n \"label\": \"new_images_gallery\", \n \"name\": \"New Images Gallery \", \n \"type_class\": \"MediaGalleryAttribute\"\n }, \n {\n \"filter_type\": \"IntAttribute\", \n \"groups\": [\n \"5c5836f59e877f0465578ea3\"\n ], \n \"id\": \"5c5836be9e877f0467b57acf\", \n \"label\": \"packed_product_height_mm\", \n \"name\": \"Packed product height (mm)\", \n \"type_class\": \"IntAttribute\"\n }, \n {\n \"filter_type\": \"IntAttribute\", \n \"groups\": [\n \"5c5836f59e877f0465578ea3\"\n ], \n \"id\": \"5c5836aa9e877f04666c64d3\", \n \"label\": \"packed_product_length_mm\", \n \"name\": \"Packed product length (mm)\", \n \"type_class\": \"IntAttribute\"\n }, \n {\n \"filter_type\": \"DecimalAttribute\", \n \"groups\": [\n \"5c5836f59e877f0465578ea3\"\n ], \n \"id\": \"5c5836a39e877f04666c64d1\", \n \"label\": \"packed_product_weight_kg\", \n \"name\": \"Packed product weight (kg)\", \n \"type_class\": \"DecimalAttribute\"\n }, \n {\n \"filter_type\": \"IntAttribute\", \n \"groups\": [\n \"5c5836f59e877f0465578ea3\"\n ], \n \"id\": \"5c5836b49e877f04666c64d5\", \n \"label\": \"packed_product_width_mm\", \n \"name\": \"Packed product width (mm)\", \n \"type_class\": \"IntAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf24a264792045d16e6de\", \n \"label\": \"parent_child\", \n \"name\": \"parent_child\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5d99e877f0467b57c80\"\n ], \n \"id\": \"5c59b7ea9e877f04655791f6\", \n \"label\": \"plug_and_waste\", \n \"name\": \"Plug and Waste\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"IntAttribute\", \n \"groups\": [\n \"5c5836f59e877f0465578ea3\"\n ], \n \"id\": \"5c58369c9e877f04666c64cf\", \n \"label\": \"product_height_mm\", \n \"name\": \"Product height (mm)\", \n \"type_class\": \"IntAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1db7eda920461360afc\", \n \"label\": \"product_id_type\", \n \"name\": \"product_id_type\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"IntAttribute\", \n \"groups\": [\n \"5c5836f59e877f0465578ea3\"\n ], \n \"id\": \"5c58368f9e877f04666c64cb\", \n \"label\": \"product_length_mm\", \n \"name\": \"Product length (mm)\", \n \"type_class\": \"IntAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5c5837619e877f0465578ea4\"\n ], \n \"id\": \"5c6c072df7195104605a7aae\", \n \"label\": \"product_lifecycle_stage\", \n \"name\": \"Product Lifecycle Stage\", \n \"options\": [\n \"Dev\", \n \"Marketing\", \n \"Active\", \n \"Inactive\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5c5837619e877f0465578ea4\"\n ], \n \"id\": \"5c6c06eef71951045ed9d3b9\", \n \"label\": \"product_owner\", \n \"name\": \"Product Owner\", \n \"options\": [\n \"Jon\", \n \"Tim\", \n \"Kevin\", \n \"Pili\", \n \"Kresten\", \n \"Peter\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1df7eda920463fda66f\", \n \"label\": \"product_tax_code\", \n \"name\": \"product_tax_code\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c19fff45e9b0f045e7d2f2d\", \n \"label\": \"product_type\", \n \"name\": \"Product Type\", \n \"options\": [\n \"Bath Fixture\", \n \"Kitchen Faucet\", \n \"Kitchen Sink\", \n \"Shower Fixture\", \n \"Kitchen Fixture\", \n \"Bathroom Faucet\", \n \"Bathroom Sink\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1d6264792045cd5a73d\", \n \"label\": \"product_type_amazon\", \n \"name\": \"product_type_amazon\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"DecimalAttribute\", \n \"groups\": [\n \"5c5836f59e877f0465578ea3\"\n ], \n \"id\": \"5c5836889e877f04666c64c9\", \n \"label\": \"product_weight_kg\", \n \"name\": \"Product weight (kg)\", \n \"type_class\": \"DecimalAttribute\"\n }, \n {\n \"filter_type\": \"IntAttribute\", \n \"groups\": [\n \"5c5836f59e877f0465578ea3\"\n ], \n \"id\": \"5c5836969e877f04666c64cd\", \n \"label\": \"product_width_mm\", \n \"name\": \"Product width (mm)\", \n \"type_class\": \"IntAttribute\"\n }, \n {\n \"attributes\": [\n {\n \"id\": \"5c582c9c9e877f04666c64ac\", \n \"label\": \"additional_image_galery\"\n }, \n {\n \"id\": \"5c19ffd30b64d40460c50d1c\", \n \"label\": \"color\"\n }, \n {\n \"id\": \"5c19ffda0b64d40460c50d1e\", \n \"label\": \"description\"\n }, \n {\n \"id\": \"5c582c819e877f04666c64a8\", \n \"label\": \"feature_description\"\n }, \n {\n \"id\": \"5c582c8f9e877f04666c64aa\", \n \"label\": \"hero_image\"\n }, \n {\n \"id\": \"5c19fff45e9b0f045e7d2f2d\", \n \"label\": \"product_type\"\n }, \n {\n \"id\": \"5c582cc79e877f0465578e81\", \n \"label\": \"suggested_retail_price\"\n }, \n {\n \"id\": \"5c19ffeb0b64d404624d3bcc\", \n \"label\": \"type\"\n }, \n {\n \"id\": \"5c582cb89e877f0465578e7e\", \n \"label\": \"video_url\"\n }, \n {\n \"id\": \"5c6165c2e4db4e0461c9bfba\", \n \"label\": \"bathroom_picture\"\n }, \n {\n \"id\": \"5c617428e4db4e0461c9bffd\", \n \"label\": \"collection\"\n }\n ], \n \"filter_type\": \"DecimalAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c766b364931b805abd334a0\", \n \"label\": \"rich_info_complete\", \n \"name\": \"Rich Info Complete\", \n \"type_class\": \"CompletenessAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf2177eda920463fda675\", \n \"label\": \"search_terms1\", \n \"name\": \"search_terms1\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf21a7eda920462da36c5\", \n \"label\": \"search_terms2\", \n \"name\": \"search_terms2\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf21d264792045ec5e57b\", \n \"label\": \"search_terms3\", \n \"name\": \"search_terms3\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf220264792045d16e6d6\", \n \"label\": \"search_terms4\", \n \"name\": \"search_terms4\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf2247eda920463fda677\", \n \"label\": \"search_terms5\", \n \"name\": \"search_terms5\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1ec264792045ec5e573\", \n \"label\": \"shipping_template\", \n \"name\": \"shipping_template\", \n \"options\": [\n \"Migrated Template\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"DecimalAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf1e6264792045cd5a73f\", \n \"label\": \"store_price\", \n \"name\": \"store_price\", \n \"type_class\": \"DecimalAttribute\"\n }, \n {\n \"filter_type\": \"DecimalAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c582cc79e877f0465578e81\", \n \"label\": \"suggested_retail_price\", \n \"name\": \"Suggested retail price\", \n \"type_class\": \"DecimalAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5d99e877f0467b57c80\"\n ], \n \"id\": \"5c59b7f89e877f04666c679f\", \n \"label\": \"taphole_configuration\", \n \"name\": \"Taphole configuration\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf20a264792045ec5e579\", \n \"label\": \"target_audience1\", \n \"name\": \"target_audience1\", \n \"options\": [\n \"women\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf20e264792045d16e6d4\", \n \"label\": \"target_audience2\", \n \"name\": \"target_audience2\", \n \"options\": [\n \"men\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5cecf30b7eda920462da36ca\"\n ], \n \"id\": \"5cecf2117eda920463fda673\", \n \"label\": \"target_audience3\", \n \"name\": \"target_audience3\", \n \"options\": [\n \"unisex\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c582a769e877f0467b57ab5\"\n ], \n \"id\": \"5c582c6e9e877f04666c64a6\", \n \"label\": \"title\", \n \"name\": \"Title\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"DropdownAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c19ffeb0b64d404624d3bcc\", \n \"label\": \"type\", \n \"name\": \"Type\", \n \"options\": [\n \"Handcrafted 90 Degree\", \n \"Solid Surface\", \n \"Handcrafted Tight Radius\", \n \"3 Hole Kitchen Faucet\", \n \"1 Hole Faucet Kitchen\", \n \"Shower Fixture\", \n \"Kitchen Faucets\", \n \"Bamboo\", \n \"Accessory\", \n \"Under Mount\", \n \"4\\\" Centerset Lav Faucet\", \n \"Quartzite\", \n \"Copper\", \n \"Wide Spread 8\\\" Centerset Lav Faucet\", \n \"Vessel Bowl\", \n \"Porcelain\", \n \"4 Hole Kitchen Faucet\", \n \"1 Hole Lav Faucet\", \n \"Standard\", \n \"Top Mount\"\n ], \n \"type_class\": \"DropdownAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5e39e877f0467b57c81\"\n ], \n \"id\": \"5c59b70e9e877f04655791ec\", \n \"label\": \"type_of_cartridge\", \n \"name\": \"Type of cartridge\", \n \"type_class\": \"TextAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c582cb89e877f0465578e7e\", \n \"label\": \"video_url\", \n \"name\": \"Video URL\", \n \"type_class\": \"UrlAttribute\"\n }, \n {\n \"filter_type\": \"TextAttribute\", \n \"groups\": [\n \"5c59b5d99e877f0467b57c80\"\n ], \n \"id\": \"5c59b80f9e877f0467b57c91\", \n \"label\": \"washbasin_capacity_l\", \n \"name\": \"Washbasin capacity (l)\", \n \"type_class\": \"TextAttribute\"\n }\n ], \n \"pagination\": {\n \"count\": 82, \n \"order\": null, \n \"page\": 1, \n \"page_size\": 1000, \n \"total_count\": 82\n }\n}\n"},{"id":"28837947-6b05-4d76-80f9-53811da5518f","name":"Completeness example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All requests must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all requests are in json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [\n [\n {\n \"field\": \"type_class\",\n \"operator\": \"eq\",\n \"value\": \"CompletenessAttribute\"\n }\n ]\n ],\n \"pagination\": {\n \"order\": \"\",\n \"page\": 1,\n \"page_size\": 25\n },\n \"attributes\": [\n \"id\",\n \"name\",\n \"label\",\n \"attributes\",\n \"groups\",\n \"type_class\",\n \"options\"\n ]\n}"},"url":"https://pim.plytix.com/api/v1/attributes/product/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"5c582c419e877f04666c64a4\", \n \"label\": \"gtin\"\n }, \n {\n \"id\": \"5c582c269e877f04666c64a1\", \n \"label\": \"brand\"\n }, \n {\n \"id\": \"5c582c6e9e877f04666c64a6\", \n \"label\": \"title\"\n }\n ], \n \"filter_type\": \"DecimalAttribute\", \n \"groups\": [\n \"5c582a769e877f0467b57ab5\"\n ], \n \"id\": \"5c59b93e9e877f04666c67a3\", \n \"label\": \"basic_info_complete\", \n \"name\": \"Basic Info Complete \", \n \"type_class\": \"CompletenessAttribute\"\n }, \n {\n \"attributes\": [\n {\n \"id\": \"5c582c9c9e877f04666c64ac\", \n \"label\": \"additional_image_galery\"\n }, \n {\n \"id\": \"5c19ffd30b64d40460c50d1c\", \n \"label\": \"color\"\n }, \n {\n \"id\": \"5c19ffda0b64d40460c50d1e\", \n \"label\": \"description\"\n }, \n {\n \"id\": \"5c582c819e877f04666c64a8\", \n \"label\": \"feature_description\"\n }, \n {\n \"id\": \"5c582c8f9e877f04666c64aa\", \n \"label\": \"hero_image\"\n }, \n {\n \"id\": \"5c19fff45e9b0f045e7d2f2d\", \n \"label\": \"product_type\"\n }, \n {\n \"id\": \"5c582cc79e877f0465578e81\", \n \"label\": \"suggested_retail_price\"\n }, \n {\n \"id\": \"5c19ffeb0b64d404624d3bcc\", \n \"label\": \"type\"\n }, \n {\n \"id\": \"5c582cb89e877f0465578e7e\", \n \"label\": \"video_url\"\n }, \n {\n \"id\": \"5c6165c2e4db4e0461c9bfba\", \n \"label\": \"bathroom_picture\"\n }, \n {\n \"id\": \"5c617428e4db4e0461c9bffd\", \n \"label\": \"collection\"\n }\n ], \n \"filter_type\": \"DecimalAttribute\", \n \"groups\": [\n \"5c582a979e877f04666c649c\"\n ], \n \"id\": \"5c766b364931b805abd334a0\", \n \"label\": \"rich_info_complete\", \n \"name\": \"Rich Info Complete\", \n \"type_class\": \"CompletenessAttribute\"\n }\n ], \n \"pagination\": {\n \"count\": 2, \n \"order\": \"\", \n \"page\": 1, \n \"page_size\": 25, \n \"total_count\": 82\n }\n}\n"}],"_postman_id":"6303cb66-4f3b-4361-b4ac-59adc822c8d3"},{"name":"Add new product attribute","id":"df874010-fea6-4d11-a93f-945921d24a3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"In Stock\",\n \"type_class\": \"BooleanAttribute\",\n \"description\": \"this attribute is used to indicate when a producto is in stock or not\"\n}"},"url":"https://pim.plytix.com/api/v1/attributes/product","description":"

Create a new product attribute.

Upon successful creation, a 201 CREATED status code is returned and product attribute can be found in response body.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Mandatory	Description	Applies to	Example
name	YES	product attribute friendly name	ALL	\"name\": \"In stock\"
type_class	YES	product attribute type (see available types at the begining of this section)	ALL	\"type_class\": \"BooleanAttribute\"
description		product attribute description	ALL	\"description\": \"this attribute is used to indicate when a proudct is in stock or not\"
product_families * (extra information given right under this table)		list of product families that will contain the new attribute. It's also possible to indicate at what level of the family the attribute will be placed	ALL	\"product_families\": [{\"id\": \"6422dd98d732cac61a58431e\", \"attribute_level\": \"parent_level\"}, {\"id\": \"6422dd98d732cac61a58431f\", \"attribute_level\": \"variant_level\"}]
options		array of available options	MultiselectAttribute, DropdownAttribute	\"options\": [\"red\", \"blue\", \"white\"]
manual_sorting		Boolean. When true, options will respect options array order, when false options will be sorted alphabetically using english rules. Default value is manual_sorting = true	MultiselectAttribute, DropdownAttribute	\"manual_sorting\": false
sort_ascending		Boolean. Options values will be sorted in ascending (true) or descending (false) order. Default value is sort_ascending = true. If manual_sorting = true this option has no effect	MultiselectAttribute, DropdownAttribute	\"manual_sorting\": false
attributes		array of attributes related to a completeness attribute	CompletenessAttribute	[ {\"id\": null, \"label\": \"sku\"} , {\"id\": \"...\", \"label\": \"in_stock\"} ]

product_families field

This field is a list of dictionaries. These dictionaries must follow the following fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	mandatory	description
id	yes	id of the Product Family that the attribute is going to belong to.
attribute_level	no	To indicate whether the attributes will not be inherited (\"no_level\"), inherited from level 1 (\"parent_level\") or from level 2 (\"variant_level\"). Default: \"no_level\".

\n
The \"parent_level\" and \"variant_level\" options are available only when automatic inheritance is active on the account. Contact your account manager for more information.
\n

Example

More examples can be found in example requests

1.- Create new True/ False (Boolean) attribute named \"In Stock\"

Formatted JSON Data\n{\n    \"name\":\"In Stock\",\n    \"type_class\":\"BooleanAttribute\"\n}\n\n

Response

Formatted JSON Data\n{\n  \"data\": [\n    {\n      \"id\": \"5d0b4ea525abd700016fc037\", \n      \"label\": \"in_stock\", \n      \"name\": \"In Stock\", \n      \"groups\": [], \n      \"type_class\": \"BooleanAttribute\"\n    }\n  ]\n}\n\n

This section contains resources related to Product Attributes

You can choose from a selection of attribute types to fit the type of data you're looking to store for your products.

Available attribute types

Current version support the following types of attributes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	PIM Name	Description
TextAttribute	Short Text	Names, identifiers with letters, and other short values of text
MultilineAttribute	Paragraph	Longer pieces of plain text, ie. description, instructions and warranty content
HtmlAttribute	Rich Text	Content that uses any styling, and outputs in HTML format
IntAttribute	Integer Number	Quantities, numerical identifiers, i.e. weight in grams, volume in ml
DecimalAttribute	Decimal Number	Prices, measurements - any numerical values separated by a . or ,
DropdownAttribute	Dropdown	For a set of options where only one option can apply at the time, i.e. a color'
MultiSelectAttribute	MultiSelect	For a set options where multiple options can apply simultaneously, i.e. colors'
DateAttribute	Date	Fairly self-explanatory, some examples are Launch dates, end of life dates...
UrlAttribute	Url	Clickable link to an external resource ie. YouTube or external documentation
BooleanAttribute	Boolean	All yes and no questions for your products ie. Dishwasher Safe or Discontinued
MediaAttribute	Media	Encapsulate a linked file for a product ie. main image or instruction booklet
MediaGalleryAttribute	MediaGallery	Encapsulate multiple linked files ie. packshots, specifications, firmware updates
CompletenessAttribute	Completeness	Pick essential attributes, and track how complete a product's information is

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a81aa432-60e6-4cfe-8137-b558e909349c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e0054b9a-67d2-4ebb-9eb4-091e49763c36"}}],"_postman_id":"9e305324-e96f-4875-953c-df98ad74489e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"product attribute groups","item":[{"name":"product attribute group","item":[{"name":"Modify attribute group","id":"92708ba1-5e5c-43e1-af37-9dd9bcd86858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"attribute_labels\": [\n \"basic_info_complete\",\n \"brand\",\n \"color\",\n \"colors\",\n \"decimal\",\n \"description\",\n \"gallery\",\n \"gtin\"\n ],\n \"name\": \"Dimensions\",\n \"order\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://pim.plytix.com/api/v1/attribute-groups/product/:attribute_group_id","description":"

Using this verb you can change some of the properties of any group.

Allowed properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
name	string	product attribute group friendly-name
attribute_labels	array of strings	array of user attribute labels. NOTE that attribute labels MUST NOT contain \"attributes.\"
order	number	position of this group using zero-based numbering, so the first group will be ordered starting with 0

A 200 OK is returned upon successful request

order: if group order is greater than the number of existing groups, group will be moved to the last position
attribute_labels: If present, group will be modified. Please note that a request like 'attribute_labels': null will remove ALL attributes from this group

Remove a group from the system

This section contains resources to manage any existing product attribute group

\n","_postman_id":"ece3e4aa-afb4-453b-8a85-26bec7736da3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"Product attribute groups search","id":"614601ff-c7ac-4441-9a58-5bd6cb24e1a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\": [\n ],\n \"attributes\": [\n \"name\",\n \"label\",\n \"attribute_labels\",\n \"order\"\n ],\n \"pagination\": {\n \"page_size\": 100,\n \"page\": 1,\n \"order\": \"order\"\n }\n}"},"url":"https://pim.plytix.com/api/v1/attribute-groups/product/search","description":"

Filter product attribute groups by multiple criteria

Filter structure and format is described under the Resources section in this guide.

Restrictions

Search requests
\n
- Search filters MUST include all necessary columns. If an attribute is not explicitly requested it won’t be returned by the API. Available attributes can be found later in this section. \n Requesting non-existing attributes will return a 422 error code.\n You are allowed to sort by columns not included in the “attributes” field, however, this attribute won’t be returned
\n

Response Format

Endpoint successful responses are wrapped in { data: [ ...] } object as in any other search endpoint.\nYou can read more about response format in the Resources section in this guide.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description	Type
id	Group unique identifier	string
name	Group name usually contains a human-friendly name	string
attribute_labels	Array with attribute labels belonging this group Attributes are not prefixed with \"attributes.\"	array of strings
order	Position of this group in groups sequence using zero-based numbering, so the first group will be ordered starting with 0

Basic Example

1.- Search for all product groups and all fields (a.k.a no-filters) 100 items max.

Formatted JSON Data\n{  \n   \"filters\":[],\n   \"attributes\":[  \n      \"name\",\n      \"order\",\n      \"attribute_labels\",\n   ],\n   \"pagination\":{  \n      \"page_size\":100,\n      \"page\":1,\n      \"order\":\"\"\n   }\n}\n

Response

Formatted JSON Data\n{\n    \"data\": [\n        {\n            \"order\": 0,\n            \"name\": \"Basic Information\",\n            \"id\": \"5d0baf02d4bf5513d19023f3\",\n            \"attribute_labels\": [\n                \"gtin\",\n                \"brand\",\n                \"title\",\n                \"basic_info_complete\"\n            ]\n        },\n        {\n            \"order\": 2,\n            \"name\": \"Rich Information\",\n            \"id\": \"5d0baf02d4bf5513d19023f4\",\n            \"attribute_labels\": [\n                \"gtin\",\n                \"brand\",\n                \"title\",\n                \"new_images_gallery\",\n                \"description\",\n                \"feature_description\",\n                \"hero_image\",\n                \"additional_image_galery\",\n                \"video_url\",\n                \"suggested_retail_price\",\n                \"type\",\n                \"product_type\",\n                \"color\",\n                \"rich_info_complete\",\n                \"bathroom_picture\",\n                \"collection\",\n                \"availability\",\n                \"condition\"\n            ]\n        },\n        {\n            \"attribute_labels\": [\n                \"product_weight_kg\",\n                \"product_length_mm\",\n                \"product_width_mm\",\n                \"product_height_mm\",\n                \"packed_product_weight_kg\",\n                \"packed_product_length_mm\",\n                \"packed_product_width_mm\",\n                \"packed_product_height_mm\"\n            ],\n            \"order\": 1,\n            \"name\": \"Dimensions\",\n            \"id\": \"5d0baf02d4bf5513d19023f5\"\n        }\n    ],\n    \"pagination\": {\n        \"count\": 3,\n        \"total_count\": 3,\n        \"page\": 1,\n        \"page_size\": 100,\n        \"order\": \"\"\n    },\n\n}\n

2.- Search for \"Rich info complete\" group.

Formatted JSON Data\n{  \n   \"filters\":[[{\"field\":\"name\",\"operator\":\"like\",\"value\":\"RiCh InFo\"}]],\n   \"attributes\":[  \n      \"name\",\n      \"order\",\n      \"attribute_labels\"\n   ],\n   \"pagination\":{  \n      \"page_size\":25,\n      \"page\":1,\n      \"order\":\"\"\n   }\n}\n\n

Response

Formatted JSON Data\n{\n  \"data\": [\n        {\n            \"order\": 2,\n            \"name\": \"Rich Information\",\n            \"id\": \"5d0baf02d4bf5513d19023f4\",\n            \"attribute_labels\": [\n                \"gtin\",\n                \"brand\",\n                \"title\",\n                \"new_images_gallery\",\n                \"description\",\n                \"feature_description\",\n                \"hero_image\",\n                \"additional_image_galery\",\n                \"video_url\",\n                \"suggested_retail_price\",\n                \"type\",\n                \"product_type\",\n                \"color\",\n                \"rich_info_complete\",\n                \"bathroom_picture\",\n                \"collection\",\n                \"availability\",\n                \"condition\"\n            ]\n        }\n  ], \n  \"pagination\": {\n    \"count\": 1, \n    \"order\": null, \n    \"page\": 1, \n    \"page_size\": 25, \n    \"total_count\": 3\n  }\n}\n\n

Upon successful creation, a 201 CREATED status code is returned and product attribute group data can be found in response body.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Mandatory	Description
name	string	YES	product attribute group friendly-name
attribute_labels	array of strings		array of user attribute labels. NOTE that attribute labels MUST NOT contain \"attributes.\"
order	number		position of this group using zero-based numbering, so the first group will be ordered starting with 0

Example

More examples can be found in example requests

1.- Create new group named \"Dimensions\"

Formatted JSON Data\n{\n    \"name\":\"Dimensions\",\n}\n

Response

Formatted JSON Data\n{\n    \"attribute_labels\": [\n        \"product_weight_kg\",\n        \"product_length_mm\",\n        \"product_width_mm\",\n        \"product_height_mm\",\n        \"packed_product_weight_kg\",\n        \"packed_product_length_mm\",\n        \"packed_product_width_mm\",\n        \"packed_product_height_mm\"\n        ],\n        \"order\": 1,\n        \"name\": \"Dimensions\",\n        \"id\": \"5d0baf02d4bf5513d19023f5\"\n}\n

This section contains resources related to product attribute group management

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1f615705-92ec-4fdb-b5c6-5e8234d8447a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cd3a0efd-128a-48d9-8c37-60985a28a3a5"}}],"_postman_id":"19c1b58c-6a21-4d1b-acd4-82445e0df5b1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"relationships","item":[{"name":"relationship","item":[{"name":"Get relationship data","id":"09710d8c-027a-4519-897b-4bb251bb31db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All request must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/relationships/:relationship_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","relationships",":relationship_id"],"host":["pim","plytix","com"],"query":[],"variable":[{"type":"any","value":"{{relationship_id}}","key":"relationship_id"}]}},"response":[{"id":"eaa99f11-b04f-440f-b0a6-ccb089e1804e","name":"Get relationship data","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"All request must include Bearer+space+your token value","type":"text"},{"key":"Content-Type","value":"application/json","description":"all request are in json","type":"text"}],"url":{"raw":"https://pim.plytix.com/api/v1/relationships/:relationship_id","protocol":"https","host":["pim","plytix","com"],"path":["api","v1","relationships",":relationship_id"],"variable":[{"key":"relationship_id","value":"{{relationship_id}}"}]}},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"5d8362c226387abb39cddb88\",\n \"created_at\": \"2019-09-19T00:00:00.000000+00:00\",\n \"modified\": \"2019-09-19T00:00:00.000008+00:00\",\n \"name\": \"Gift basket\",\n \"label\": \"gift_basket\"\n }\n ]\n}"}],"_postman_id":"09710d8c-027a-4519-897b-4bb251bb31db"},{"name":"Modify attributes of a relationship","id":"26068e1f-d0d4-4d12-b47d-9c272998a469","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All request must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"new name\"\n}"},"url":"https://pim.plytix.com/api/v1/relationships/:relationship_id","description":"

Current version of the API supports the following attributes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	description
name	string	human-friendly name

any other attributes will be ignored

Remove a relationship from user’s account.

If the relationship is in use in an ecatalog, channel or pdf-template a 409 status code is returned along with elements where this relationship is being used.

A 204 No content is returned upon success

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Recommended products\"\n}"},"url":"https://pim.plytix.com/api/v1/relationships","description":"

Create a new relationship.

Each product can have a maximum of 300 products related to it per relationship.

Upon successful creation, a 201 http status code will be returned.

All request must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"attributes\": [\n \"id\",\n \"modified\",\n \"name\",\n \"symmetrical\"\n ],\n \"filters\": [\n [\n {\n \"field\": \"name\",\n \"operator\": \"like\",\n \"value\": \"free\"\n },\n {\n \"field\": \"symmetrical\",\n \"operator\": \"eq\",\n \"value\": true\n }\n ]\n ],\n \"relationship_filters\": [],\n \"pagination\": {\n \"count\": 4,\n \"order\": \"name\",\n \"page\": 1\n }\n}"},"url":"https://pim.plytix.com/api/v1/relationships/search","description":"

Filter relationships by multiple criteria.

Filter structure and format is described under the Resources section in this guide, available fields can be queried using relationship filters endpoint

Add attributes to an existing product family

The attributes that do not belong to the product familly will be added
\n
Existing attributes will change their inheritance levels (inheritance ON from level 1 / level 2 or inheritance OFF)
\n

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
attributes	list	yes	List of attribute IDs
attributes_level	string	no	To indicate whether the attributes will not be inherited (\"no_level\"), inherited from level 1 (\"parent_level\") or from level 2 (\"variant_level\"). Default: \"no_level\".

A 202 ACCEPTED status code is returned upon success.

\n
The \"parent_level\" and \"variant_level\" options are available only when automatic inheritance is active on the account. Contact your account manager for more information.
\n

Edit product family attributes inheritance. Only the attributes included will be modified

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
parent_level	list	no	List of attribute labels for which you want to set the level 1 inheritance ON
variant_level	list	no	List of attribute labels for which you want to set the level 2 inheritance ON
no_level	list	no	List of attribute labels for which you want to set the inheritance OFF

A 202 ACCEPTED status code is returned upon success.

\n
The \"parent_level\" and \"variant_level\" options are available only when automatic inheritance is active on the account. Contact your account manager for more information.
\n

Edits the inheritance configuration of product family attributes, including system attributes. Only the attributes included in the request will be updated.

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
parent_level	list	no	List of attribute labels for which you want to set the level 1 inheritance ON
variant_level	list	no	List of attribute labels for which you want to set the level 2 inheritance ON
no_level	list	no	List of attribute labels for which you want to set the inheritance OFF

\n
Custom attributes must be prefixed with attributes. followed by the attribute label (e.g., attributes.my_attribute).
\n

Inheritable system attributes

The following system attributes can be included without any prefix:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`label`	Product label
`thumbnail`	Product thumbnail
`status`	Product status
`categories`	Product categories

A 202 ACCEPTED status code is returned upon success.

\n
The \"parent_level\" and \"variant_level\" options are available only when automatic inheritance is active on the account. Contact your account manager for more information.
\n

Unlink attributes from an existing product family

* The given attributes that belong to the family will be unlinked

This action may cause data loss

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
attributes	list	yes	list of attributes ids

A 202 ACCEPTED status code is returned upon success.

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/product_families/:product_family_id/attributes","description":"

Retrieves the product family attributes and for each one, whether it is set with level 1 inheritance (“parent_level”), level 2 inheritance (“variant_level”) or OFF (“no_level”).

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/product_families/:product_family_id/all_attributes","description":"

Retrieves all product family attributes, including system attributes, and indicates for each whether it has inheritance set to Level 1 (“parent_level”), Level 2 (“variant_level”) or OFF (“no_level”).

This section contains resources to link and unlink attributes to/from a product family in the PIM.

\n","_postman_id":"9e8b71d5-1f4e-4dbc-8517-4b5c3c94a42b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}},{"name":"Add new family","id":"93229d03-c51d-4583-8ba2-cd993eea0386","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer Your.Token.Value","description":"

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\":\"product_family_name\",\n \"attributes\":[\"attribute1_id\",\"attribute2_id\",\"attribute3_id\"],\n \"parent_attributes\":[\"attribute4_id\",\"attribute5_id\"],\n \"variant_attributes\":[\"attribute6_id\",\"attribute7_id\"]\n}"},"url":"https://pim.plytix.com/api/v1/product_families","description":"

Create a new product family.

Upon successful creation, a 201 CREATED status code is returned and product family can be found in response body.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
name	string	yes	human friendly name
attributes	list	no	List of attribute IDs or objects that include a label and, optionally, an id. *attributes with inheritance OFF
parent_attributes	list	no	List of attribute IDs or objects that include a label and, optionally, an id. *attributes with level 1 inheritance ON
variant_attributes	list	no	List of attribute IDs or objects that include a label and, optionally, an id. *attributes with level 2 inheritance ON

\n
\"attributes\", \"parent_attributes\", and \"variant_attributes\" can each be provided as either a list of IDs or a list of objects containing a label and, optionally, an id. You cannot mix IDs and objects within the same request. Attributes can also be sent as objects to define the inheritance level for system attributes.
\n

\n
The \"parent_attributes\" and \"variant_attributes\" options are available only when automatic inheritance is active on the account. Contact your account manager for more information.
\n

All request must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\":[],\n \"relationship_filters\":[],\n \"pagination\":\n {\n \"page\":1,\n \"order\":\"name\"\n },\n \"attributes\":[\"name\",\"total_products\",\"total_attributes\", \"total_models\",\"_created_at\",\"modified\",\"created_user_audit\",\"modified_user_audit\"]\n}"},"url":"https://pim.plytix.com/api/v1/product_families/search","description":"

Search existing product families.

Filter structure and format is described under the Resources section in this guide.

Comments:

Search filters MUST include all necessary columns. If an attribute is not explicitly requested it won’t be returned by the API. Available attributes can be found later in this section.
\n
Requesting non-existing attributes will return a 422 error
\n
You are allowed to sort by columns not included in the “attributes” field. However, those attributes won’t be returned.
\n

All requests must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"url":"https://pim.plytix.com/api/v1/product_families/:product_family_id","description":"

Retrieves a product family by the family id.

All request must include Bearer+space+your token value

\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"

all requests are in json

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"new name\"\n}"},"url":"https://pim.plytix.com/api/v1/product_families/:product_family_id","description":"

Edit product family name.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	type	mandatory	description
name	string	yes	human-friendly name

Any other attributes will be ignored.

Remove a product family from user’s account.

⚠️ If the family is assigned to a Parent product this action might cause data loss

A 202 ACCEPTED status code is returned upon success.

Product Families are a way for you to assign attributes to products of the same type so that you can see only relevant attributes for each family. Product Families are especially useful if you have a variety of products in your catalog that share only a specific set of attributes.

This section contains resources to manage Product Families in PIM.

\n","_postman_id":"6e9045b0-7a35-4089-ac44-191093f300a8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":true,"source":{"_postman_id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","id":"9c8e4c8c-aa56-4cc0-8f20-c987f723024b","name":"Plytix Api V1","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"00806e8d-774c-43b0-bedc-2bd3f8f3ddb7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"41cadae5-74e7-4e55-af3b-708bf8112e91"}}]}