bc:T672,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. | 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 ``` json { "id": "5c4ed8002f0985001e233275", "attribute_label": "thumbnail" } ``` ### Example 2: link asset to custom attribute POST /api/v1/products/6397116da02483ebd6dc76e0/assets ``` json { "id": "5c4ed8002f0985001e233275", "attribute_label": "dummy_media_gallery" } ```bd:T80d,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. | _field_ | _type_ | _description_ | | --- | --- | --- | | product_relationships | Array of objects | list with product and quantities | A _product_relationship_ object is defined by: | _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: | _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: | _field_ | _type_ | _description_ | | --- | --- | --- | | product_id | string | related product identifier | | quantity | number | current quantity | | last_modified | date | last modification date | Example: ``` { "data": [ { "related_products": [ { "last_modified": "2019-09-24T17:28:07.329000+00:00", "product_id": "5d6cfa8ae36dc76b0e5df8dd", "quantity": 1 }, { "last_modified": "2019-09-24T17:28:07.329000+00:00", "product_id": "5d6cfa8aedd44295ac5df8de", "quantity": 3 } ], "relationship_id": "5d8a50b547397aea2a603079", "relationship_label": "contains" } ] } ```be:T9fd,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. | 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 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/v2/products/ ``` json { "sku": "blue adventure mug S023", "label": "Adventure mug", "attributes" : { "stock" : 123, "vendor_url": "http://acme.com", "since": "2015-03-28", "Media_gallery":[ {"id":"5bfaced551e7590001486763"}, {"id":"5bfaced551e7590001486765"} ], "media_single_1": {"id":"5bfaced551e7590001486764"} }, "categories": [ { "id": "5bfa91ab8544120001bd9078" } ] } ``` A successful request returns `201 CREATED` with this body: ```json { "data": [ { "id": "5bfad5ca5b84b100017a8f5a", "created": "2018-11-25T17:03:06.596000+00:00", "modified": "2018-11-25T17:03:06.628000+00:00", "created_user_audit": { "type": "API", "user_email": "api", "user_id": "67191ed7d6e8e300016f1414", "user_name": "api" }, "modified_user_audit": { "type": "API", "user_email": "api", "user_id": "67191ed7d6e8e300016f1414", "user_name": "api" } } ] } ```bf:T47f6,Filter product by multiple criteria Filter structure and format is described under [Resources](#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 - 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 - **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 - **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: - relationships.gift_basket - relationships.recommended_products - 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/](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** - 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 - Search filters will return a 428 status code if the filtered results include more than 10000 products and the order field is filled. - 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 - Only one relationship can be selected in filters # Relationship information in responses When relationship columns are requested, product response will include a new field named ‘relationships’ with the following structure | **Field** | **Description** | **Type** | | --- | --- | --- | | relationships | relationship array | array of relationship information | Relationship information | **Field** | **Description** | **Type** | | --- | --- | --- | | relationship_id | relationship id | string | | label | relationship label | string | | related_products | related products | Array of product relationship data | Relationship Data | **Field** | **Description** | **Type** | | --- | --- | --- | | product_id | product ID | string | | quantity | quantity | number | Requesting the attributes `["categories", "label", "attributes.color", "relationships.gift_basket"]` returns products shaped like this: ```json { "id": "5d8200527313382d939838c4", "sku": "1234567890", "categories": [], "label": "Strawberry_soap", "attributes": { "color": "red" }, "relationships": [ { "relationship_id": "5ddbf89efbe0f86e3c1574c6", "label": "gift_basket", "related_products": [ { "product_id": "5c98ef754a6c252c96793574", "quantity": 1 } ] } ] } ``` # 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 | **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 | **Field** | **Description** | **Mandatory** | **Type** | | --- | --- | --- | --- | | id | product id | YES | string | | qty_operator | quantity operator | YES | string | | value | filter value | string | array of integer | Available operators: | 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 ``` json { "filters":[ [ {"field":"modified","operator":"gt","value":"2018-11-01"}, {"field":"modified","operator":"lt","value":"2018-11-30"} ], [ {"field":"attributes.name","operator":"like","value":"unicorn"} ] ] } ``` 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** ``` json { "attributes":["sku", "label", "attributes.in_stock", "attributes.volume_liters"] } ``` 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) ``` json { "filters":[ [ {"field":"modified","operator":"gt","value":"2018-11-01"}, {"field":"modified","operator":"lt","value":"2018-11-30"} ], [ {"field":"attributes.name","operator":"like","value":"unicorn"} ] ], "pagination":{"order":"-sku","page":3,"page_size":25}, "attributes":["created", "attributes.in_stock", "attributes.name", "attributes.qty"] } ``` # 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) 1. Find products where the “recommended products” relationship is defined (exists). ``` { "attributes":["relationships.recommended_products"], "filters":[], "relationship_filters":[[ { "relationship_id":"5d89c6c696c8f4a322df4bbc", "operator":"exists", "product_ids":[] }]], "pagination": { "order":"", "page":1, "page_size":25 } } ``` The response should include RP-001, RP-002, and RP-003 2. Find products where “recommended products” is not defined (!exists). ``` { "attributes":["relationships.recommended_products"], "filters":[], "relationship_filters":[[ { "relationship_id":"5d89c6c696c8f4a322df4bbc", "operator":"!exists", "product_ids":[] }]], "pagination":{ "order":"", "page":1, "page_size":25 } } ``` The response should not include RP-001, RP-002 or RP-003 3. Find the products for which the “recommended products” relationship is defined (a.k.a exists) with the RP-002 product ``` { "filters":[], "attributes":["relationships.recommended_products"], "relationship_filters":[[ { "product_ids":[ { "id":"5d89c68596c8f4a322df4bb9", "qty_operator":"exists", "value":null }], "relationship_id":"5d89c6c696c8f4a322df4bbc", "operator":"exists" }]], "pagination": { "order":null, "page":1, "page_size":25 } } ``` Response should include RP-001 ``` { "data": [ { "attributes": {}, "id": "5d89c67796c8f4a322df4bb8", "sku": "RP-001", "relationships": [ { "relationship_id": "5d89c6c696c8f4a322df4bbc", "label": "recommended_products", "related_products": [ { "product_id": "5d89c68596c8f4a322df4bb9", "quantity": "2" }, { "product_id": "5d89c69496c8f4a322df4bba", "quantity": "3" } ] } ] } ], "pagination": { "count": 1, "order": null, "page": 1, "page_size": 25, "total_count": 3 } } ``` 4. 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 ``` { "filters": [], "attributes": [ "relationships.recommended_products" ], "relationship_filters": [ [ { "product_ids": [ { "id": "5d89c67796c8f4a322df4bb8", "qty_operator": "gt", "value": [ 2 ] } ], "relationship_id": "5d89c6c696c8f4a322df4bbc", "operator": "exists" } ] ], "pagination": { "order": null, "page": 1, "page_size": 25 } } ``` Response should exclude RP-002, due to its quantity being 2, and include RP-003 ``` { "data": [ { "attributes": {}, "id": "5d89c69496c8f4a322df4bba", "sku": "RP-003", "relationships": [ { "relationship_id": "5d89c6c696c8f4a322df4bbc", "label": "recommended_products", "related_products": [ { "product_id": "5d89c67796c8f4a322df4bb8", "quantity": "3" } ] } ] } ], "pagination": { "count": 1, "order": null, "page": 1, "page_size": 25, "total_count": 3 } } ``` 5. 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\] ``` { "filters": [], "attributes": [ "relationships.recommended_products" ], "relationship_filters": [ [ { "product_ids": [ { "id": "5d89c67796c8f4a322df4bb8", "qty_operator": "bte", "value": [ 1, 2 ] } ], "relationship_id": "5d89c6c696c8f4a322df4bbc", "operator": "exists" } ] ], "pagination": { "order": null, "page": 1, "page_size": 25 } } ``` Response should exclude RP-003, which has a quantity of 3, and include RP-002 ``` { "data": [ { "attributes": {}, "id": "5d89c68596c8f4a322df4bb9", "sku": "RP-002", "relationships": [ { "relationship_id": "5d89c6c696c8f4a322df4bbc", "label": "recommended_products", "related_products": [ { "product_id": "5d89c68596c8f4a322df4bb9", "quantity": "2" } ] } ] } ], "pagination": { "order": null, "page": 1, "page_size": 25 } } ``` 6. Find all products where ‘Gift basket’ is defined ``` { "filters": [], "attributes": [ "relationships.gift_basket" ], "relationship_filters": [ [ { "product_ids": [], "relationship_id": "5d89d4fd96c8f4a322df4bc0", "operator": "exists" } ] ], "pagination": { "order": null, "page": 1, "page_size": 25 } } ``` The response should include 'GF-Basket' product. ``` { "data": [ { "attributes": {}, "id": "5d89d51a96c8f4a322df4bc1", "sku": "GF-Basket", "relationships": [ { "relationship_id": "5d89d4fd96c8f4a322df4bc0", "label": "gift_basket", "related_products": [ { "product_id": "5d89d51a96c8f4a322df4bc2", "quantity": "2" }, { "product_id": "5d89d52f96c8f4a322df4bc3", "quantity": "3" }, { "product_id": "5d89d54396c8f4a322df4bc4", "quantity": "1" } ] } ] } ], "pagination": { "count": 1, "order": null, "page": 1, "page_size": 25, "total_count": 7 } } ```c0:T651,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. | 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: | 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 successc1:T67e,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. | 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/v2/products/6397116da02483ebd6dc76e0/assets ``` json { "id": "5c4ed8002f0985001e233275", "attribute_label": "thumbnail" } ``` ### Example 2: link asset to custom attribute POST /api/v2/products/6397116da02483ebd6dc76e0/assets ``` json { "id": "5c4ed8002f0985001e233275", "attribute_label": "dummy_media_gallery" } ```c2:T619,Plytix PIM API relies on Bearer authentication 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: | 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 | 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}} ``` 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 Send a `POST` request to `/auth/api/get-token` with a `Content-Type: application/json` header and this body: ```json { "api_key": "my_api_key", "api_password": "my secret password" } ``` A successful request returns `200 OK` with the token in the `data` array: ```json { "data": [ { "access_token": "token data" } ] } ``` 89:["$","$La9",null,{"toc":[],"full":true,"children":[["$","$Laa",null,{"children":"Get a product family"}],["$","div",null,{"className":"flex flex-row gap-2 items-center pb-4","children":[["$","$Lab",null,{"markdownUrl":"/llms.mdx/docs/reference/v1-v2/product-families/get-product-family/content.md"}],["$","$Lac",null,{"className":"plytix-pill-button","markdownUrl":"/llms.mdx/docs/reference/v1-v2/product-families/get-product-family/content.md"}]]}],["$","$Lad",null,{"children":[null,["$undefined",["$","$Lae",null,{"document":"./openapi-v1v2.json","operations":[{"path":"/api/v1/product_families/{product_family_id}","method":"get"}],"showDescription":true,"preloaded":{"docs":{"./openapi-v1v2.json":{"openapi":"3.2.0","info":{"title":"Plytix PIM API v1","version":"1.0.0","description":"Converted from the Plytix PIM API V1 Postman collection (materials/api-references/Plytix_pimv1.postman_collection.json). Endpoint shapes, request/response schemas, and examples were inferred from the collection's saved example bodies/responses and have not been independently verified against the live API; cross-check with endpoint-tester before treating as ground truth."},"servers":[{"url":"https://pim.plytix.com","description":"Plytix PIM API (V1 under /api/v1, V2-beta endpoints under /api/v2)"},{"url":"https://auth.plytix.com","description":"Plytix authentication service"}],"tags":[{"name":"authentication"},{"name":"accounts"},{"name":"assets"},{"name":"available filters"},{"name":"categories"},{"name":"products"},{"name":"products V2 BETA"},{"name":"product attributes"},{"name":"product attribute groups"},{"name":"relationships"},{"name":"product families"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Obtain a token via POST /auth/api/get-token (15 minute lifetime), then send it as `Authorization: Bearer `."}}},"security":[{"bearerAuth":[]}],"paths":{"/api/v1/accounts/api-credentials/search":{"post":{"tags":["accounts"],"summary":"Search API credentials","operationId":"apiCredentialSearch_api_v1_accounts_api_credentials_search_post","description":"Filter API credentials by multiple criteria\n\nThe filter structure and format are described in the [Resources](#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| Field | Description |\n| --- | --- |\n| legacy_id | API Credential ID in PIM |\n| role | User role: one of _ADMIN_, _OWNER_ and _USER_ |\n| Name | API credential name |","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}},"attributes":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}}}}},"examples":{"default":{"value":{"filters":[[{"field":"role","operator":"eq","value":"ADMIN"}]],"attributes":["legacy_id","name","role"],"pagination":{"page":1,"page_size":5}}}}}}},"responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"legacy_id":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"page_size":{"type":"integer"},"order":{"type":"string"},"count":{"type":"integer"},"total_count":{"type":"integer"}}}}},"examples":{"default":{"value":{"data":[{"legacy_id":"cccccccccccccccccccccccc","name":"API","role":"ADMIN"}],"pagination":{"page":1,"page_size":5,"order":"","count":1,"total_count":1}}}}}}},"400":{"description":"400 Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"loc":{"type":"array","items":{"type":"string"}},"msg":{"type":"string"},"input":{"type":"object","properties":{}},"ctx":{"type":"object","properties":{"error":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"detail":[{"type":"json_invalid","loc":["body",30],"msg":"JSON decode error","input":{},"ctx":{"error":"Expecting property name enclosed in double quotes"}}]}}}}}},"422":{"description":"422 Unprocessable entity","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}},"examples":{"default":{"value":{"detail":"One or more filter fields are not valid."}}}}}}}}},"/api/v1/accounts/memberships/search":{"post":{"tags":["accounts"],"summary":"Search memberships","operationId":"membershipSearch_api_v1_accounts_memberships_search_post","description":"Filter memberships by multiple criteria\n\nThe filter structure and format are described in the [Resources](#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| Field | Description |\n| --- | --- |\n| legacy_id | User ID in PIM |\n| role | Membership role: one of _ADMIN_, _OWNER_ and _USER_ |\n| email | User’s email address |\n| username | Unique user identifier (e.g., name) |\n| Name | User's first name |\n| last_name | User's last name |","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}},"attributes":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}}}}},"examples":{"default":{"value":{"filters":[[{"field":"role","operator":"eq","value":"ADMIN"}]],"attributes":["username","role","name","last_name","legacy_id"],"pagination":{"page":1,"page_size":5}}}}}}},"responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"legacy_id":{"type":"string"},"role":{"type":"string"},"username":{"type":"string"},"name":{"type":"string"},"last_name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"page_size":{"type":"integer"},"order":{"type":"string"},"count":{"type":"integer"},"total_count":{"type":"integer"}}}}},"examples":{"default":{"value":{"data":[{"legacy_id":"aaaaaaaaaaaaaaaaaaaaaaaa","role":"ADMIN","username":"alice","name":"Alice","last_name":"Anderson"},{"legacy_id":"bbbbbbbbbbbbbbbbbbbbbbbb","role":"ADMIN","username":"bob","name":"Bob","last_name":"Brown"}],"pagination":{"page":1,"page_size":5,"order":"","count":2,"total_count":3}}}}}}},"400":{"description":"400 Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"loc":{"type":"array","items":{"type":"string"}},"msg":{"type":"string"},"input":{"type":"object","properties":{}},"ctx":{"type":"object","properties":{"error":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"detail":[{"type":"json_invalid","loc":["body",30],"msg":"JSON decode error","input":{},"ctx":{"error":"Expecting property name enclosed in double quotes"}}]}}}}}},"422":{"description":"422 Unprocessable entity","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}},"examples":{"default":{"value":{"detail":"One or more filter fields are not valid."}}}}}}}}},"/api/v1/assets":{"post":{"tags":["assets"],"summary":"Create an asset","operationId":"addNewAssets_api_v1_assets_post","description":"$af","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string"},"url":{"type":"string"}}},"examples":{"default":{"value":{"filename":"kettle_blue.jpg","url":"https://www.plytix.com/hubfs/Kitchen%20and%20Home%20Products/Enjoy%20Mug%20-%20Blue.jpg"}}}}}},"responses":{"201":{"description":"201 OK - Upload by url","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"assigned":{"type":"boolean"},"categories":{"type":"array","items":{}},"content_type":{"type":"string"},"created":{"type":"string"},"extension":{"type":"string"},"file_modified":{"type":"string"},"file_size":{"type":"integer"},"file_type":{"type":"string"},"filename":{"type":"string"},"id":{"type":"string"},"modified":{"type":"string"},"n_catalogs":{"type":"integer"},"n_products":{"type":"integer"},"status":{"type":"string"},"thumbnail":{"type":"string"},"url":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"assigned":false,"categories":[],"content_type":"image/jpeg","created":"2019-01-26T14:26:24.826240+00:00","extension":"jpg","file_modified":"2019-01-26T14:26:24.826306","file_size":31885,"file_type":"IMAGES","filename":"kettle_blue.jpg","id":"5c4c6e10ca59f4061b800ffa","modified":"2019-01-26T14:26:24.827123+00:00","n_catalogs":0,"n_products":0,"status":"ACTIVE","thumbnail":"https://files.plytix.com/api/v1.1/thumb/kettle_blue.jpg","url":"https://files.plytix.com/api/v1.1/file/public_files/assets/kettle_blue.jpg"}]}}}}}},"400":{"description":"400 Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"The browser sent a request that this server could not understand."}}}}}}},"409":{"description":"409 - Asset already exists","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset.id","msg":"5c4c6e10ca59f4061b800ffa"}],"msg":"Asset already exists"}}}}}}},"422":{"description":"422 Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"filename","msg":"filename field is mandatory when uploading from content"}],"msg":"Schema validation error"}}}}}}}}}},"/api/v1/assets/search":{"post":{"tags":["assets"],"summary":"Search assets","operationId":"assetSearch_api_v1_assets_search_post","description":"Filter assets by multiple criteria\n\nFilter structure and format is described under [Resources](#resources) section in this guide\n\n## Restrictions\n\n- Search filters will return a 428 status code if the filtered results include more than 10000 assets and the order field is filled.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{}},"attributes":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"order":{"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"}}}}},"examples":{"default":{"value":{"filters":[],"attributes":["modified","filename"],"pagination":{"order":"modified","page":1,"page_size":5}}}}}}},"responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string"},"id":{"type":"string"},"modified":{"type":"string"}}}},"pagination":{"type":"object","properties":{"count":{"type":"integer"},"order":{"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"}}}}},"examples":{"default":{"value":{"data":[{"filename":"k9189-1.jpg","id":"5c483ee8eb9139000154dd5e","modified":"2019-01-23T10:16:08.122000+00:00"},{"filename":"naranja.png","id":"5c483f08eb9139000154dd61","modified":"2019-01-23T10:16:40.850000+00:00"},{"filename":"dos_naranjas.jpeg","id":"5c483fbaeb9139000154dd64","modified":"2019-01-23T10:19:38.335000+00:00"},{"filename":"naranja.jpeg","id":"5c483fbaeb9139000154dd66","modified":"2019-01-23T10:19:38.446000+00:00"},{"filename":"rrh_1.png","id":"5c483fbaeb9139000154dd67","modified":"2019-01-23T10:19:38.491000+00:00"}],"pagination":{"count":2241,"order":"modified","page":1,"page_size":5,"total_count":2241}}}}}}},"400":{"description":"400 Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"integer"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"http_status_code","msg":400}],"msg":"Failed to decode JSON object: Expecting property name enclosed in double quotes: line 3 column 1 (char 46)"}}}}}}},"422":{"description":"422 Unprocessable entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"eq","msg":"unknown field"},{"field":"filters","msg":"Unable to decode filters properly"}],"msg":"Schema validation error"}}}}}}}}}},"/api/v1/assets/{asset_id}":{"patch":{"tags":["assets"],"summary":"Update an asset","operationId":"modifySelectedAttributesOfAnAsset_api_v1_assets_asset_id_patch","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Modifies attributes from asset and leaves the rest unchanged. \n\nCurrent version supports the modification of the following fields:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| filename | string | New file name for the asset.
File extension change is not allowed |\n| categories | array | Array containing categories objects
Each category is defined as follows
{ \"id\": category_id } |\n ","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}},"examples":{"default":{"value":{"filename":"new_asset_filename.png","categories":[{"id":"5c3f6697d08a07000171c4de"},{"id":"5c489c15f4b8950001378041"}]}}}}}},"responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"assigned":{"type":"boolean"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}},"content_type":{"type":"string"},"created":{"type":"string"},"extension":{"type":"string"},"file_modified":{"type":"string"},"file_size":{"type":"integer"},"file_type":{"type":"string"},"filename":{"type":"string"},"id":{"type":"string"},"modified":{"type":"string"},"n_catalogs":{"type":"integer"},"n_products":{"type":"integer"},"status":{"type":"string"},"thumbnail":{"type":"string"},"url":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"assigned":true,"categories":[{"id":"5c3f66add08a07000171c4e0"},{"id":"5c3f6697d08a07000171c4de"},{"id":"5c489c15f4b8950001378041"}],"content_type":"image/png","created":"2019-01-21T09:29:48.127000+00:00","extension":"png","file_modified":"2019-01-21T09:29:48.127000","file_size":532360,"file_type":"IMAGES","filename":"new_asset_filename.png","id":"5c45910c0a3d5c000155aa62","modified":"2019-01-21T09:33:58.170000+00:00","n_catalogs":1,"n_products":115,"status":"ACTIVE","thumbnail":"https://files.plytix.com/api/v1.1/thumb/bird.png","url":"https://files.plytix.com/api/v1.1/file/assets/bird.png"}]}}}}}},"400":{"description":"400 Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"The browser sent a request that this server could not understand."}}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset_id","msg":"asset does not exist"}],"msg":" No results found for 000000000000000000000000"}}}}}}},"422":{"description":"422 Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"filename","msg":"Extension changes are not allowed"}],"msg":"Extension changes are not allowed"}}}}}}}}},"get":{"tags":["assets"],"summary":"Get an asset","operationId":"getAccountSAsset_api_v1_assets_asset_id_get","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Get one asset from this account","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"assigned":{"type":"boolean"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}},"content_type":{"type":"string"},"created":{"type":"string"},"extension":{"type":"string"},"file_modified":{"type":"string"},"file_size":{"type":"integer"},"file_type":{"type":"string"},"filename":{"type":"string"},"id":{"type":"string"},"modified":{"type":"string"},"n_catalogs":{"type":"integer"},"n_products":{"type":"integer"},"status":{"type":"string"},"thumbnail":{"type":"string"},"url":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"assigned":true,"categories":[{"id":"5c3f66add08a07000171c4e0"}],"content_type":"image/png","created":"2019-01-21T09:29:48.127000+00:00","extension":"png","file_modified":"2019-01-21T09:29:48.127000","file_size":532360,"file_type":"IMAGES","filename":"3536.png","id":"5c45910c0a3d5c000155aa62","modified":"2019-01-21T09:33:58.170000+00:00","n_catalogs":1,"n_products":115,"status":"ACTIVE","thumbnail":"https://files.plytix.com/api/v1.1/thumb/3536.jpg","url":"https://files.plytix.com/api/v1.1/file/3536.jpg"}]}}}}}},"400":{"description":"400 Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"The browser sent a request that this server could not understand."}}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"msg":{"type":"string"},"field":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"error":{"msg":" No results found for 000000000000000000000000","errors":[{"msg":"asset does not exist","field":"asset_id"}]}}}}}}},"422":{"description":"422 Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"msg":{"type":"string"},"field":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"error":{"msg":"There was an error loading this asset, please contact support","errors":[{"msg":"validation error","field":"asset"}]}}}}}}}}},"delete":{"tags":["assets"],"summary":"Delete an asset","operationId":"removeAssetFromAccount_api_v1_assets_asset_id_delete","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Removes an asset from this account","responses":{"204":{"description":"204 Success"},"400":{"description":"400 Malformed Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"The browser sent a request that this server could not understand."}}}}}}},"403":{"description":"403 Permission error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"Permission denied."}}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"msg":{"type":"string"},"field":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"error":{"msg":" No results found for 000000000000000000000000","errors":[{"msg":"asset does not exist","field":"asset_id"}]}}}}}}},"422":{"description":"422 Unprocessable entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"Schema validation error"}}}}}}}}}},"/api/v1/assets/{asset_id}/content":{"put":{"tags":["assets"],"summary":"Replace an asset's content","operationId":"replaceAssetContent_api_v1_assets_asset_id_content_put","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","contentMediaType":"application/octet-stream"}},"required":["file"]}}}},"responses":{"202":{"description":"202 Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"assigned":{"type":"boolean"},"categories":{"type":"array","items":{}},"content_type":{"type":"string"},"created":{"type":"string"},"created_user_audit":{"type":"object","properties":{"avatar_color":{"type":["string","null"]},"type":{"type":"string"},"user_display_name":{"type":["string","null"]},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_last_name":{"type":"string"},"user_name":{"type":"string"},"user_thumb":{"type":"string"},"username":{"type":"string"}}},"extension":{"type":"string"},"file_modified":{"type":"string"},"file_size":{"type":"integer"},"file_type":{"type":"string"},"filename":{"type":"string"},"has_custom_thumb":{"type":"boolean"},"id":{"type":"string"},"modified":{"type":"string"},"modified_user_audit":{"type":"object","properties":{"avatar_color":{"type":["string","null"]},"type":{"type":"string"},"user_display_name":{"type":["string","null"]},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_last_name":{"type":"string"},"user_name":{"type":"string"},"user_thumb":{"type":"string"},"username":{"type":"string"}}},"n_catalogs":{"type":"integer"},"n_products":{"type":"integer"},"status":{"type":"string"},"thumbnail":{"type":"string"},"url":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"assigned":true,"categories":[],"content_type":"image/png","created":"2023-05-17T11:22:36.671000+00:00","created_user_audit":{"avatar_color":null,"type":"USER","user_display_name":null,"user_email":"USER@plytix.com","user_id":"5e678436cc9e97962c059bd7","user_last_name":"God","user_name":"The Owner","user_thumb":"https://static.plytix.com/template/dev/img/user-default-image.png","username":"5e678436cc9e97962c059bd7"},"extension":"png","file_modified":"2023-05-19T12:27:19.943966","file_size":18696,"file_type":"IMAGES","filename":"2023-05-03_08-42_1.png","has_custom_thumb":false,"id":"6464b8fcb1779cd56c3cac87","modified":"2023-05-19T12:27:19.944188+00:00","modified_user_audit":{"avatar_color":null,"type":"USER","user_display_name":null,"user_email":"USER@plytix.com","user_id":"5e678436cc9e97962c059bd7","user_last_name":"God","user_name":"The Owner","user_thumb":"https://static.plytix.com/template/dev/img/user-default-image.png","username":"5e678436cc9e97962c059bd7"},"n_catalogs":0,"n_products":1,"status":"ACTIVE","thumbnail":"http://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/e3/4b/4a/64/644a4be3a83d8b00089da29f/images/fc/b8/64/64/6464b8fcb1779cd56c3cac87/2023-05-03_08-42_1.png","url":"http://files.plytix.com/api/v1.1/file/public_files/pim/assets/e3/4b/4a/64/644a4be3a83d8b00089da29f/images/fc/b8/64/64/6464b8fcb1779cd56c3cac87/2023-05-03_08-42_1.png"}]}}}}}},"400":{"description":"400 Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"content_type","msg":"You cannot change the format type of the asset."}],"msg":"You cannot change the format type of the asset."}}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"asset does not exist"}],"msg":" No results found for 64512de1f15dafa58db1ac73"}}}}}}}}}},"/api/v1/attribute-groups/product":{"post":{"tags":["product attribute groups"],"summary":"Create a product attribute group","operationId":"addNewProductAttributeGroup_api_v1_attribute_groups_product_post","description":"Upon successful creation, a 201 CREATED status code is returned and product attribute group data can be found in response body.\n\n\n| Field | Type | Mandatory | Description |\n| --- | --- | --- | --- | \n| name | string | YES | product attribute group friendly-name |\n| attribute_labels | array of strings | | array of user attribute labels. *NOTE* that attribute labels *MUST NOT* contain \"attributes.\" |\n| order | number | | position of this group **using zero-based numbering**, so the first group will be ordered starting with 0 |\n\n\n# Example\n\nMore examples can be found in example requests\n\n1.- Create new group named \"Dimensions\"\n```json\n{\n\t\"name\":\"Dimensions\"\n}\n ```\nResponse\n```json\n{\n\t\"attribute_labels\": [\n\t\t\"product_weight_kg\",\n\t\t\"product_length_mm\",\n\t\t\"product_width_mm\",\n\t\t\"product_height_mm\",\n\t\t\"packed_product_weight_kg\",\n\t\t\"packed_product_length_mm\",\n\t\t\"packed_product_width_mm\",\n\t\t\"packed_product_height_mm\"\n\t\t],\n\t\t\"order\": 1,\n\t\t\"name\": \"Dimensions\",\n\t\t\"id\": \"5d0baf02d4bf5513d19023f5\"\n}\n ```","responses":{"200":{"description":"OK"}}}},"/api/v1/attribute-groups/product/search":{"post":{"tags":["product attribute groups"],"summary":"Search product attribute groups","operationId":"productAttributeGroupsSearch_api_v1_attribute_groups_product_search_post","description":"$b0","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{}},"attributes":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"page_size":{"type":"integer"},"page":{"type":"integer"},"order":{"type":"string"}}}}},"examples":{"default":{"value":{"filters":[],"attributes":["name","label","attribute_labels","order"],"pagination":{"page_size":100,"page":1,"order":"order"}}}}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/attribute-groups/product/{attribute_group_id}":{"patch":{"tags":["product attribute groups"],"summary":"Update a product attribute group","operationId":"modifyAttributeGroup_api_v1_attribute_groups_product_attribute_group_id_patch","parameters":[{"name":"attribute_group_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Using this verb you can change some of the properties of any group.\n\nAllowed properties:\n\n| Field | Type | Description |\n| --- | --- | --- | \n| name | string | product attribute group friendly-name |\n| attribute_labels | array of strings | array of user attribute labels. *NOTE* that attribute labels *MUST NOT* contain \"attributes.\" |\n| order | number | position of this group **using zero-based numbering**, so the first group will be ordered starting with 0 |\n\nA 200 OK is returned upon successful request\n\n* order: if group order is greater than the number of existing groups, group will be moved to the last position\n* attribute_labels: If present, group will be modified. Please note that a request like 'attribute_labels': null will remove ALL attributes from this group","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_labels":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"attribute_labels":["basic_info_complete","brand","color","colors","decimal","description","gallery","gtin"],"name":"Dimensions","order":2}}}}}},"responses":{"200":{"description":"Remove all attribute labels","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attribute_labels":{"type":"array","items":{}},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer"}}}}}},"examples":{"default":{"value":{"data":[{"attribute_labels":[],"id":"5d9993554a275f16fb01b246","name":"Dimensions","order":2}]}}}}}}}},"delete":{"tags":["product attribute groups"],"summary":"Delete a product attribute group","operationId":"removeGroup_api_v1_attribute_groups_product_attribute_group_id_delete","parameters":[{"name":"attribute_group_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Remove a group from the system","responses":{"200":{"description":"OK"}}}},"/api/v1/attributes/product":{"post":{"tags":["product attributes"],"summary":"Create a product attribute","operationId":"addNewProductAttribute_api_v1_attributes_product_post","description":"$b1","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"type_class":{"type":"string"},"description":{"type":"string"}}},"examples":{"default":{"value":{"name":"In Stock","type_class":"BooleanAttribute","description":"this attribute is used to indicate when a producto is in stock or not"}}}}}},"responses":{"200":{"description":"Create attribute assigned to a Family","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"groups":{"type":"array","items":{}},"type_class":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5d0b4ea525abd700016fc037","label":"in_stock","name":"In Stock","groups":[],"type_class":"BooleanAttribute"}]}}}}}},"201":{"description":"Add multiselect attribute sorted by name, descending","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"filter_type":{"type":"string"},"groups":{"type":"array","items":{}},"id":{"type":"string"},"label":{"type":"string"},"manual_sorting":{"type":"boolean"},"name":{"type":"string"},"options":{"type":"array","items":{"type":"string"}},"sort_ascending":{"type":"boolean"},"type_class":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"filter_type":"MultiSelectAttribute","groups":[],"id":"5e60ad6e2526f346c0894f7c","label":"locations","manual_sorting":false,"name":"Locations","options":["R'lyeh","Metropolis","Lagado","Hill Valley","Arkham"],"sort_ascending":false,"type_class":"MultiSelectAttribute"}]}}}}}},"422":{"description":"Product Already exist","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"a product attribute with same name already exists"}}}}}}}}}},"/api/v1/attributes/product/search":{"post":{"tags":["product attributes"],"summary":"Search product attributes","operationId":"productAttributeSearch_api_v1_attributes_product_search_post","description":"$b2","responses":{"200":{"description":"Completeness example","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}},"filter_type":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"type_class":{"type":"string"}}}},"pagination":{"type":"object","properties":{"count":{"type":"integer"},"order":{"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"}}}}},"examples":{"default":{"value":{"data":[{"attributes":[{"id":"5c582c419e877f04666c64a4","label":"gtin"},{"id":"5c582c269e877f04666c64a1","label":"brand"},{"id":"5c582c6e9e877f04666c64a6","label":"title"}],"filter_type":"DecimalAttribute","groups":["5c582a769e877f0467b57ab5"],"id":"5c59b93e9e877f04666c67a3","label":"basic_info_complete","name":"Basic Info Complete ","type_class":"CompletenessAttribute"},{"attributes":[{"id":"5c582c9c9e877f04666c64ac","label":"additional_image_galery"},{"id":"5c19ffd30b64d40460c50d1c","label":"color"},{"id":"5c19ffda0b64d40460c50d1e","label":"description"},{"id":"5c582c819e877f04666c64a8","label":"feature_description"},{"id":"5c582c8f9e877f04666c64aa","label":"hero_image"},{"id":"5c19fff45e9b0f045e7d2f2d","label":"product_type"},{"id":"5c582cc79e877f0465578e81","label":"suggested_retail_price"},{"id":"5c19ffeb0b64d404624d3bcc","label":"type"},{"id":"5c582cb89e877f0465578e7e","label":"video_url"},{"id":"5c6165c2e4db4e0461c9bfba","label":"bathroom_picture"},{"id":"5c617428e4db4e0461c9bffd","label":"collection"}],"filter_type":"DecimalAttribute","groups":["5c582a979e877f04666c649c"],"id":"5c766b364931b805abd334a0","label":"rich_info_complete","name":"Rich Info Complete","type_class":"CompletenessAttribute"}],"pagination":{"count":2,"order":"","page":1,"page_size":25,"total_count":82}}}}}}}}}},"/api/v1/attributes/product/{product_attribute_id}":{"get":{"tags":["product attributes"],"summary":"Get a product attribute","operationId":"getProductAttribute_api_v1_attributes_product_product_attribute_id_get","parameters":[{"name":"product_attribute_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Retrieves a product attribute by id","responses":{"200":{"description":"Get product attribute","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"groups":{"type":"array","items":{}},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"type_class":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"groups":[],"id":"5d0b4ea525abd700016fc037","label":"in_stock","name":"In Stock","type_class":"BooleanAttribute"}]}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"id does not exist"}],"msg":" No results found for 6d0b4ea525abd700016fc037"}}}}}}}}},"patch":{"tags":["product attributes"],"summary":"Update a product attribute","operationId":"modifyAttribute_api_v1_attributes_product_product_attribute_id_patch","parameters":[{"name":"product_attribute_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"This resource allows you to modify some properties of existing attributes.\n\n- All attributes can patch name and description fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| name | string | friendly name for the attribute |\n| description | string | to help other users to understand what kind of information this attribute holds |\n\n\n- DropdownAttribute and MultiselecAttributes can also patch available options. *NOTE* options will replace existing ones\n\n- CompletenessAttribute can patch its \"attributes\".","responses":{"200":{"description":"Patch completeness attribute","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}}},"groups":{"type":"array","items":{}},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"type_class":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"attributes":[{"id":"5d0b50f525abd700016fc03b","label":"size"}],"groups":[],"id":"5d0b51a925abd700016fc03f","label":"ready_to_ship","name":"Ready to ship","type_class":"CompletenessAttribute"}]}}}}}}}},"delete":{"tags":["product attributes"],"summary":"Delete a product attribute","operationId":"deleteProductAttribute_api_v1_attributes_product_product_attribute_id_delete","parameters":[{"name":"product_attribute_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Deletes an attribute. An empty response and 202 code is returned upon successful call.\n\nYou 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.","responses":{"202":{"description":"Delete UNUSED product attribute"},"409":{"description":"Delete product attribute used in ecatalog","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"object","properties":{"channels":{"type":"array","items":{}},"ecatalogs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"pdfcatalogs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"usages","msg":{"channels":[],"ecatalogs":[{"id":"5d00be27ebd6f0000170c3dd","name":"Europe 2019 catalog"}],"pdfcatalogs":[{"id":"5d03879a39d49f0001391973","name":"2019 template"},{"id":"5d03629a7048e9000142d970","name":"2019 full template"}]}}],"msg":"Error deleting 5d0384a939d49f0001391961 attribute"}}}}}}}}}},"/api/v1/categories/file":{"post":{"tags":["categories"],"summary":"Create an asset category","operationId":"addNewFileCategory_api_v1_categories_file_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}},"examples":{"default":{"value":{"name":"Marketing logos"}}}}}},"responses":{"200":{"description":"Add new file first category","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"modified":{"type":"string"},"n_children":{"type":"integer"},"name":{"type":"string"},"order":{"type":"string"},"parents_ids":{"type":"array","items":{}},"path":{"type":"array","items":{"type":"string"}},"slug":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5cfa05273da03100019ba90e","modified":"2019-06-07T06:33:11.965893+00:00","n_children":0,"name":"Marketing logos","order":"2","parents_ids":[],"path":["Marketing logos"],"slug":"marketing-logos"}]}}}}}},"422":{"description":"Add duplicate name file category","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"name","msg":"already exists"}],"msg":"Marketing logos already exists"}}}}}}}}}},"/api/v1/categories/file/search":{"post":{"tags":["categories"],"summary":"Search asset categories","operationId":"assetCategoriesSearch_api_v1_categories_file_search_post","description":"$b3","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"string"}},"filters":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"}}}}},"pagination":{"type":"object","properties":{"page_size":{"type":"integer"},"page":{"type":"integer"},"order":{"type":"string"}}}}},"examples":{"default":{"value":{"attributes":["name","n_children"],"filters":[[{"field":"parent_id","operator":"!exists"}]],"pagination":{"page_size":25,"page":1,"order":"order"}}}}}}},"responses":{"200":{"description":"Get parent categories","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"n_children":{"type":"integer"},"name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"count":{"type":"integer"},"order":{"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"}}}}},"examples":{"default":{"value":{"data":[{"id":"5ceea1df264792045ec5e8ef","n_children":1,"name":"Packshots"},{"id":"5ceea1eb264792045cd5a88d","n_children":0,"name":"Specificationss"},{"id":"5ceea1f7264792045d16e986","n_children":0,"name":"Marketing Material"}],"pagination":{"count":3,"order":"order","page":1,"page_size":25,"total_count":4}}}}}}}}}},"/api/v1/categories/file/{category_id}":{"post":{"tags":["categories"],"summary":"Create an asset subcategory","operationId":"addNewFileSubcategory_api_v1_categories_file_category_id_post","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Add a new sub-category under an existing category","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}},"examples":{"default":{"value":{"name":"Kitchen Sinks"}}}}}},"responses":{"200":{"description":"Add new file subcategory","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"modified":{"type":"string"},"n_children":{"type":"integer"},"name":{"type":"string"},"order":{"type":"string"},"parents_ids":{"type":"array","items":{"type":"string"}},"path":{"type":"array","items":{"type":"string"}},"slug":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5cfa0c1e3da03100019ba90f","modified":"2019-06-07T07:02:54.817539+00:00","n_children":0,"name":"Marketing logos","order":"1","parents_ids":["5cfa05273da03100019ba90e"],"path":["Logos","Marketing logos"],"slug":"marketing-logos"}]}}}}}},"422":{"description":"Add duplicate name file category","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"name","msg":"already exists"}],"msg":"Category Marketing logos already exist"}}}}}}}}},"patch":{"tags":["categories"],"summary":"Update an asset category","operationId":"modifyCategoryAttributes_api_v1_categories_file_category_id_patch","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"$b4","responses":{"200":{"description":"Sort subcategories","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"modified":{"type":"string"},"n_children":{"type":"integer"},"name":{"type":"string"},"order":{"type":"string"},"parents_ids":{"type":"array","items":{}},"path":{"type":"array","items":{"type":"string"}},"slug":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5cfa10893da03100019ba911","modified":"2019-06-07T07:21:45.967000+00:00","n_children":3,"name":"Marketing Logos","order":"8","parents_ids":[],"path":["Marketing Logos"],"slug":"marketing-logos"}]}}}}}}}},"delete":{"tags":["categories"],"summary":"Delete an asset category","operationId":"deleteCategory_api_v1_categories_file_category_id_delete","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Deletes a category and all its subcategories.\n\n**WARNING** All subcategories will be removed too.\n\nIf you want to preserve some of the subcategories, it's mandatory you move them before deleting parent category.\n\nA 204 response is returned upon success.\n\nIf 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","responses":{"204":{"description":"Delete category"}}}},"/api/v1/categories/product":{"post":{"tags":["categories"],"summary":"Create a product category","operationId":"addNewProductCategory_api_v1_categories_product_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}},"examples":{"default":{"value":{"name":"Kitchen Sinks"}}}}}},"responses":{"200":{"description":"Add new product first category","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"modified":{"type":"string"},"n_children":{"type":"integer"},"name":{"type":"string"},"order":{"type":"string"},"parents_ids":{"type":"array","items":{}},"path":{"type":"array","items":{"type":"string"}},"slug":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5cfa05273da03100019ba90e","modified":"2019-06-07T06:33:11.965893+00:00","n_children":0,"name":"Kitchen Sinks","order":"5","parents_ids":[],"path":["Kitchen Sinks"],"slug":"kitchen-sinks"}]}}}}}},"422":{"description":"Add duplicate name product category","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"name","msg":"already exists"}],"msg":"Category Kitchen Sinks already exists"}}}}}}}}}},"/api/v1/categories/product/search":{"post":{"tags":["categories"],"summary":"Search product categories","operationId":"productCategoriesSearch_api_v1_categories_product_search_post","description":"$b5","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"string"}},"filters":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"}}}}},"pagination":{"type":"object","properties":{"page_size":{"type":"integer"},"page":{"type":"integer"},"order":{"type":"string"}}}}},"examples":{"default":{"value":{"attributes":["name","n_children"],"filters":[[{"field":"parent_id","operator":"!exists"}]],"pagination":{"page_size":25,"page":1,"order":"order"}}}}}}},"responses":{"200":{"description":"Get parent categories","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"n_children":{"type":"integer"},"name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"count":{"type":"integer"},"order":{"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"}}}}},"examples":{"default":{"value":{"data":[{"id":"5cf4d55eb694740001006ed1","n_children":1,"name":"Kitchen Sinks"},{"id":"5cf4d561b694740001006ed2","n_children":3,"name":"Kitchen Faucets"},{"id":"5cf69f4d568c1c001c039c76","n_children":2,"name":"Bathroom Faucets"}],"pagination":{"count":3,"order":"order","page":1,"page_size":25,"total_count":11}}}}}}}}}},"/api/v1/categories/product/{category_id}":{"post":{"tags":["categories"],"summary":"Create a product subcategory","operationId":"addNewProductSubcategory_api_v1_categories_product_category_id_post","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Add a new sub-category under an existing category","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}},"examples":{"default":{"value":{"name":"Kitchen Sinks"}}}}}},"responses":{"200":{"description":"Add new product subcategory","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"modified":{"type":"string"},"n_children":{"type":"integer"},"name":{"type":"string"},"order":{"type":"string"},"parents_ids":{"type":"array","items":{"type":"string"}},"path":{"type":"array","items":{"type":"string"}},"slug":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5cfa0c1e3da03100019ba90f","modified":"2019-06-07T07:02:54.817539+00:00","n_children":0,"name":"Apron","order":"1","parents_ids":["5cfa05273da03100019ba90e"],"path":["Kitchen Sinks","Apron"],"slug":"apron"}]}}}}}},"422":{"description":"Add duplicate name product category","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"name","msg":"already exists"}],"msg":"Category Apron already exists"}}}}}}}}},"patch":{"tags":["categories"],"summary":"Update a product category","operationId":"modifyCategoryAttributes_api_v1_categories_product_category_id_patch","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"$b6","responses":{"200":{"description":"Change category name","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"modified":{"type":"string"},"n_children":{"type":"integer"},"name":{"type":"string"},"order":{"type":"string"},"parents_ids":{"type":"array","items":{"type":"string"}},"path":{"type":"array","items":{"type":"string"}},"slug":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5cfa0c1e3da03100019ba90f","modified":"2019-06-07T07:05:06.959196+00:00","n_children":0,"name":"Apron Bamboo","order":"1","parents_ids":["5cfa05273da03100019ba90e"],"path":["Kitchen Sinks","Apron Bamboo"],"slug":"apron-bamboo"}]}}}}}}}},"delete":{"tags":["categories"],"summary":"Delete a product category","operationId":"deleteCategory_api_v1_categories_product_category_id_delete","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Deletes a category and all its subcategories.\n\n**WARNING** All subcategories will be removed too.\n\nIf you want to preserve some of the subcategories it's mandatory you move them before deleting parent category.\n\nA 204 response is returned upon success.\n\nIf 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","responses":{"204":{"description":"Delete category"}}}},"/api/v1/filters/asset":{"get":{"tags":["available filters"],"summary":"Get available asset filters","operationId":"getAvailableAssetFilters_api_v1_filters_asset_get","description":"Get a list of available asset filters\n\nThis 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. \n\nThis endpoint **DOES NOT** support the use of the \"TEXT_SEARCH\" operator\n\nA complete list of operators and their meanings is available in the main section of _filters_.\n\n__NOTE__:The most up-to-date list of attributes and operations is always returned for this endpoint.","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"filter_type":{"type":"string"},"key":{"type":"string"},"operators":{"type":"array","items":{"type":"string"}}}}}}}}}},"examples":{"default":{"value":{"data":[{"attributes":[{"filter_type":"TextAttribute","key":"status","operators":["like","eq","!eq"]},{"filter_type":"MultiSelectAttribute","key":"file_type","operators":["in","!in"],"options":["IMAGES","SOUNDS","VIDEOS","COMPRESSED","REPORTS","TEXTS","OTHER"]},{"filter_type":"BooleanAttribute","key":"assigned","operators":["eq"]},{"filter_type":"DecimalAttribute","key":"file_size","operators":["eq","!eq","gt","gte","lt","lte"]},{"filter_type":"TextAttribute","key":"id","operators":["eq","!eq","in","!in"]},{"filter_type":"HierarchyAttribute","key":"categories","operators":["exists","!exists","in","!in"]},{"filter_type":"TextAttribute","key":"extension","operators":["like","eq","!eq"]},{"filter_type":"DateAttribute","key":"created","operators":["eq","gt","gte","lt","lte"]},{"filter_type":"DateAttribute","key":"modified","operators":["eq","gt","gte","lt","lte"]},{"filter_type":"TextAttribute","key":"filename","operators":["like","eq","!eq"]}]}]}}}}}}}}},"/api/v1/filters/product":{"get":{"tags":["available filters"],"summary":"Get available product filters","operationId":"getAvailableProductFilters_api_v1_filters_product_get","description":"$b7","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"filter_type":{"type":"string"},"key":{"type":"string"},"operators":{"type":"array","items":{"type":"string"}}}}},"properties":{"type":"array","items":{"type":"object","properties":{"filter_type":{"type":"string"},"key":{"type":"string"},"operators":{"type":"array","items":{"type":"string"}}}}}}}}}},"examples":{"default":{"value":{"data":[{"attributes":[{"filter_type":"DecimalAttribute","key":"attributes.price_create_a_decimal_number_type_attribute","operators":["exists","!exists","eq","!eq","gt","gte","lt","lte"]},{"filter_type":"DropdownAttribute","key":"attributes.dropdown","operators":["exists","!exists","eq","!eq","in","!in"],"options":["1","2","3","4"]},{"filter_type":"TextAttribute","key":"attributes.description_create_a_rich_text_type_attribute","operators":["exists","!exists","like","eq","!eq"]},{"filter_type":"MultiSelectAttribute","key":"attributes.color_create_a_multiselect_type_attribute","operators":["exists","!exists","in","!in"],"options":["Blue","Purple","White","Beige","Orange"]},{"filter_type":"MultiSelectAttribute","key":"attributes.multiselect","operators":["exists","!exists","in","!in"],"options":["option 1","option 2","option 3"]},{"filter_type":"TextAttribute","key":"attributes.att_1","operators":["exists","!exists","like","eq","!eq"]},{"filter_type":"TextAttribute","key":"attributes.17","operators":["exists","!exists","like","eq","!eq"]},{"filter_type":"TextAttribute","key":"attributes.att20","operators":["exists","!exists","like","eq","!eq"]},{"filter_type":"TextAttribute","key":"sku","operators":["exists","!exists","like","eq","!eq"]},{"filter_type":"TextAttribute","key":"label","operators":["exists","!exists","like","eq","!eq"]},{"filter_type":"MultiSelectAttribute","key":"categories","operators":["exists","!exists","in","!in"],"options":[]},{"filter_type":"MultiSelectAttribute","key":"static_lists","operators":["in"],"options":[]},{"filter_type":"MediaAttribute","key":"assets","operators":["exists","!exists"]},{"filter_type":"MediaAttribute","key":"images","operators":["exists","!exists"]},{"filter_type":"MediaAttribute","key":"thumbnail","operators":["exists","!exists"]},{"filter_type":"DateAttribute","key":"modified","operators":["exists","!exists","eq","gt","gte","lt","lte"]},{"filter_type":"DateAttribute","key":"created","operators":["exists","!exists","eq","gt","gte","lt","lte"]},{"filter_type":"DropdownAttribute","key":"status","operators":["eq","in","!in"]}],"properties":[{"filter_type":"BooleanAttribute","key":"_is_variation","operators":["eq"]},{"filter_type":"BooleanAttribute","key":"_has_variations","operators":["eq"]}]}]}}}}}}}}},"/api/v1/filters/relationships":{"get":{"tags":["available filters"],"summary":"Get available relationship filters","operationId":"getAvailableRelationshipsFilters_api_v1_filters_relationships_get","description":"Get a list of available relationship filters\n\nThis 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. \n\nThis endpoint **DOES NOT** support the use of the \"TEXT_SEARCH\" operator\n\nA complete list of operators and their meanings is available in the main section of _filters_.\n\n__NOTE__: The most up-to-date list of attributes and operations is always returned for this endpoint.","responses":{"200":{"description":"Get available relationships filters","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"filter_type":{"type":"string"},"key":{"type":"string"},"operators":{"type":"array","items":{"type":"string"}}}}}}}}}},"examples":{"default":{"value":{"data":[{"attributes":[{"filter_type":"TextAttribute","key":"label","operators":["exists","!exists","like","eq","!eq"]},{"filter_type":"TextAttribute","key":"name","operators":["exists","!exists","like","eq","!eq"]},{"filter_type":"DateAttribute","key":"created","operators":["exists","!exists","eq","gt","gte","lt","lte"]},{"filter_type":"BooleanAttribute","key":"symmetrical","operators":["exists","!exists","eq"]},{"filter_type":"TextAttribute","key":"id","operators":["like","eq","!eq"]},{"filter_type":"DateAttribute","key":"modified","operators":["exists","!exists","eq","gt","gte","lt","lte"]}]}]}}}}}}}}},"/api/v1/product_families":{"post":{"tags":["product families"],"summary":"Create a product family","operationId":"addNewFamily_api_v1_product_families_post","description":"$b8","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"parent_attributes":{"type":"array","items":{"type":"string"}},"variant_attributes":{"type":"array","items":{"type":"string"}}}},"examples":{"default":{"value":{"name":"product_family_name","attributes":["attribute1_id","attribute2_id","attribute3_id"],"parent_attributes":["attribute4_id","attribute5_id"],"variant_attributes":["attribute6_id","attribute7_id"]}}}}}},"responses":{"201":{"description":"201 Created including a system attribute","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"created":{"type":"string"},"created_at":{"type":"string"},"id":{"type":"string"},"modified":{"type":"string"},"name":{"type":"string"},"total_attributes":{"type":"integer"},"total_models":{"type":"integer"},"total_products":{"type":"integer"}}}}}},"examples":{"default":{"value":{"data":[{"created":"2023-03-27T07:39:28.167000+00:00","created_at":"2023-03-27T07:39:28.167000+00:00","id":"64214830d9a5d3244f24ce97","modified":"2023-03-27T07:39:28.245000+00:00","name":"product_family_name","total_attributes":5,"total_models":0,"total_products":0}]}}}}}}}}},"/api/v1/product_families/search":{"post":{"tags":["product families"],"summary":"Search product families","operationId":"searchFamilies_api_v1_product_families_search_post","description":"Search existing product families.\n\nFilter structure and format is described under the [Resources](#resources) section in this guide.\n\n###### Comments:\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 found later in this section.\n \n- Requesting non-existing attributes will return a 422 error\n \n- You are allowed to sort by columns not included in the “attributes” field. However, those attributes won’t be returned.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{}},"relationship_filters":{"type":"array","items":{}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"order":{"type":"string"}}},"attributes":{"type":"array","items":{"type":"string"}}}},"examples":{"default":{"value":{"filters":[],"relationship_filters":[],"pagination":{"page":1,"order":"name"},"attributes":["name","total_products","total_attributes","total_models","_created_at","modified","created_user_audit","modified_user_audit"]}}}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/product_families/{product_family_id}":{"get":{"tags":["product families"],"summary":"Get a product family","operationId":"getFamilyData_api_v1_product_families_product_family_id_get","parameters":[{"name":"product_family_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Retrieves a product family by the family id.","responses":{"200":{"description":"OK"}}},"patch":{"tags":["product families"],"summary":"Rename a product family","operationId":"editFamilyName_api_v1_product_families_product_family_id_patch","parameters":[{"name":"product_family_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Edit product family name.\n\n| _field_ | _type_ | _mandatory_ | _description_ |\n| --- | --- | --- | --- |\n| name | string | yes | human-friendly name |\n\nAny other attributes will be ignored.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}},"examples":{"default":{"value":{"name":"new name"}}}}}},"responses":{"200":{"description":"OK"}}},"delete":{"tags":["product families"],"summary":"Delete a product family","operationId":"removeFamily_api_v1_product_families_product_family_id_delete","parameters":[{"name":"product_family_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Remove a product family from user’s account.\n\n⚠️ **If the family is assigned to a Parent product this action might cause data loss**\n\nA 202 ACCEPTED status code is returned upon success.","responses":{"200":{"description":"OK"}}}},"/api/v1/product_families/{product_family_id}/all_attributes":{"get":{"tags":["product families"],"summary":"List a family's attributes, including system attributes","operationId":"getFamilyAttributesIncludingSystemAttributes_api_v1_product_families_product_family_id_all_attributes_get","parameters":[{"name":"product_family_id","in":"path","required":true,"schema":{"type":"string"}}],"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”).","responses":{"200":{"description":"OK"}}}},"/api/v1/product_families/{product_family_id}/all_attributes/edit":{"post":{"tags":["product families"],"summary":"Edit family attributes, including system attributes","operationId":"editProductFamilyAttributesIncludingSystemAttributes_api_v1_product_families_product_family_id_all_attributes_edit_post","parameters":[{"name":"product_family_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"$b9","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parent_level":{"type":"array","items":{"type":"string"}},"variant_level":{"type":"array","items":{"type":"string"}},"no_level":{"type":"array","items":{"type":"string"}}}},"examples":{"default":{"value":{"parent_level":["label","attributes.attribute1_label"],"variant_level":["thumbnail","attributes.attribute2_label"],"no_level":["status","categories","attributes.attribute3_label"]}}}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/product_families/{product_family_id}/attributes":{"get":{"tags":["product families"],"summary":"List a family's attributes","operationId":"getFamilyAttributes_api_v1_product_families_product_family_id_attributes_get","parameters":[{"name":"product_family_id","in":"path","required":true,"schema":{"type":"string"}}],"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”).","responses":{"200":{"description":"OK"}}}},"/api/v1/product_families/{product_family_id}/attributes/edit":{"post":{"tags":["product families"],"summary":"Edit family attribute inheritance","operationId":"editProductFamilyAttributesInheritance_api_v1_product_families_product_family_id_attributes_edit_post","parameters":[{"name":"product_family_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Edit product family attributes inheritance. Only the attributes included will be modified\n\n### Body\n\n| Parameter | Type | Mandatory | Description |\n| --- | --- | --- | --- |\n| parent_level | list | no | List of attribute labels for which you want to set the level 1 inheritance ON |\n| variant_level | list | no | List of attribute labels for which you want to set the level 2 inheritance ON |\n| no_level | list | no | List of attribute labels for which you want to set the inheritance OFF |\n\nA 202 ACCEPTED status code is returned upon success.\n\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.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parent_level":{"type":"array","items":{"type":"string"}},"variant_level":{"type":"array","items":{"type":"string"}},"no_level":{"type":"array","items":{"type":"string"}}}},"examples":{"default":{"value":{"parent_level":["attribute1_label","attribute2_label"],"variant_level":["attribute3_label","attribute4_label"],"no_level":["attribute5_label","attribute6_label"]}}}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/product_families/{product_family_id}/attributes/link":{"post":{"tags":["product families"],"summary":"Link an attribute to a family","operationId":"addAttributeToProductFamily_api_v1_product_families_product_family_id_attributes_link_post","parameters":[{"name":"product_family_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Add attributes to an existing product family\n\n- The attributes that do not belong to the product familly will be added\n \n- **Existing attributes will change their inheritance levels (inheritance ON from level 1 / level 2 or inheritance OFF)**\n \n\n### Body\n\n| Parameter | Type | Mandatory | Description |\n| --- | --- | --- | --- |\n| attributes | list | **yes** | List of attribute IDs |\n| 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\". |\n\nA 202 ACCEPTED status code is returned upon success.\n\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.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"string"}},"attributes_level":{"type":"string"}}},"examples":{"default":{"value":{"attributes":["attribute1_id","attribute2_id"],"attributes_level":"parent_level"}}}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/product_families/{product_family_id}/attributes/unlink":{"post":{"tags":["product families"],"summary":"Unlink an attribute from a family","operationId":"unlinkAttributeFromProductFamily_api_v1_product_families_product_family_id_attributes_unlink_post","parameters":[{"name":"product_family_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Unlink attributes from an existing product family\n\n\\* The given attributes that belong to the family will be unlinked\n\n**This action may cause data loss**\n\n### Body\n\n| Parameter | Type | Mandatory | Description |\n| --- | --- | --- | --- |\n| attributes | list | **yes** | list of attributes ids |\n\nA 202 ACCEPTED status code is returned upon success.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"string"}}}},"examples":{"default":{"value":{"attributes":["attribute1_id"]}}}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/products":{"post":{"tags":["products"],"summary":"Create a product","operationId":"addNewProducts_api_v1_products_post","description":"$ba","responses":{"201":{"description":"201 Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"_parent_id":{"type":["string","null"]},"assets":{"type":"array","items":{}},"attributes":{"type":"object","properties":{"color_create_a_multiselect_type_attribute":{"type":"array","items":{"type":"string"}},"description_create_a_rich_text_type_attribute":{"type":"string"}}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}}}},"created":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"modified":{"type":"string"},"num_variations":{"type":"integer"},"sku":{"type":"string"},"status":{"type":"string"},"thumbnail":{"type":["string","null"]}}}}}},"examples":{"default":{"value":{"data":[{"_parent_id":null,"assets":[],"attributes":{"color_create_a_multiselect_type_attribute":["Blue"],"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."},"categories":[{"id":"5c4ed7f62f0985001c233276","name":"Ground Coffee","path":["Sample Categories","Coffee & Tea","Ground Coffee"]},{"id":"5c4ed7f62f0985001c233278","name":"Drinkware","path":["Sample Categories","Drinkware"]},{"id":"5c4ed7f62f0985001c233279","name":"Kettles & Teapots","path":["Sample Categories","Kettles & Teapots"]}],"created":"2019-01-28T12:20:57.341000+00:00","id":"5c4ef3a9bedb5e000189befc","label":"Black Kettle","modified":"2019-01-28T12:20:57.437000+00:00","num_variations":0,"sku":"Black Kettle_1111","status":"Completed","thumbnail":null}]}}}}}},"400":{"description":"400 Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"integer"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"http_status_code","msg":400}],"msg":"Failed to decode JSON object: Expecting property name enclosed in double quotes: line 2 column 5 (char 6)"}}}}}}},"422":{"description":"422 Unprocessable entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"status","msg":"Value is not valid, valid values are [Draft, Completed, Archived]"}],"msg":"product data validation failed"}}}}}}}}}},"/api/v1/products/search":{"post":{"tags":["products"],"summary":"Search products","operationId":"productSearch_api_v1_products_search_post","description":"$bb","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}},"attributes":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"order":{"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"}}}}},"examples":{"default":{"value":{"filters":[[{"field":"status","operator":"eq","value":"Draft"},{"field":"categories","operator":"in","value":["5c4ed7f62f0985001c233274"]}],[{"field":"categories","operator":"!exists","value":null}]],"attributes":["thumbnail","assets","label","categories","modified","created","status"],"pagination":{"order":"sku","page":1,"page_size":25}}}}}}},"responses":{"200":{"description":"200 Minimum search query","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"object","properties":{}},"id":{"type":"string"},"num_variations":{"type":"integer"},"sku":{"type":"string"}}}},"pagination":{"type":"object","properties":{"count":{"type":"integer"},"order":{"type":["string","null"]},"page":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"}}}}},"examples":{"default":{"value":{"data":[{"attributes":{},"id":"5c4ed8002f0985001d233274","num_variations":0,"sku":"Sample - 002"},{"attributes":{},"id":"5c4ed8002f09850020233274","num_variations":0,"sku":"Sample - 003"},{"attributes":{},"id":"5c4ed8002f0985001e233275","num_variations":0,"sku":"Sample - 001"},{"attributes":{},"id":"5c4ed8002f0985001f233274","num_variations":0,"sku":"Sample - 004"},{"attributes":{},"id":"5c4ed8002f0985001a233274","num_variations":5,"sku":"Sample - 005"},{"attributes":{},"id":"5c4ed8002f0985001b233274","num_variations":2,"sku":"Sample - 009"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4ed80c2f0985001a23327e","num_variations":0,"sku":"Sample - 008"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4ed80c2f0985001e233279","num_variations":0,"sku":"Sample - 007"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4ed80c2f0985001b23327a","num_variations":0,"sku":"Sample - 006"},{"_parent_id":"5c4ed8002f0985001b233274","attributes":{},"id":"5c4ed80c2f0985001d233278","num_variations":0,"sku":"Sample - 011"},{"_parent_id":"5c4ed8002f0985001b233274","attributes":{},"id":"5c4ed80c2f09850021233275","num_variations":0,"sku":"Sample - 010"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4eeb97050d860001717698","num_variations":0,"sku":"new variant from API"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4eec84908d2d00011c8e0b","num_variations":0,"sku":"new variant from APId"},{"attributes":{},"id":"5c4ef0c59311990001fc3db0","num_variations":0,"sku":"Black Kettle"},{"attributes":{},"id":"5c4ef1709311990001fc3db1","num_variations":0,"sku":"Black Kettle_1"},{"attributes":{},"id":"5c4ef29d9311990001fc3db2","num_variations":0,"sku":"Black Kettle_11"},{"attributes":{},"id":"5c4ef3829311990001fc3db3","num_variations":0,"sku":"Black Kettle_111"},{"attributes":{},"id":"5c4ef3a9bedb5e000189befc","num_variations":0,"sku":"Black Kettle_1111"},{"attributes":{},"id":"5c4ef7f7bedb5e000189befd","num_variations":0,"sku":"Black Kettle111111"},{"attributes":{},"id":"5c4ef836bedb5e000189befe","num_variations":0,"sku":"Black Kettle111111111"}],"pagination":{"count":20,"order":null,"page":1,"page_size":25,"total_count":20}}}}}}},"422":{"description":"422 Column limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"schema","msg":"columns limit exceeded, current limit is 20"}],"msg":"Schema validation error"}}}}}}}}}},"/api/v1/products/{parent_product_id}/variant/{variant_id}":{"delete":{"tags":["products"],"summary":"Unlink a variant","operationId":"unlinkAVariantOfAProduct_api_v1_products_parent_product_id_variant_variant_id_delete","parameters":[{"name":"parent_product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"variant_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Removes relationship between a variant and its parent. Variant becomes a Single product.\n\n**⚠️ This action might cause data loss**","responses":{"200":{"description":"OK"}}}},"/api/v1/products/{parent_product_id}/variants":{"post":{"tags":["products"],"summary":"Add a variant","operationId":"addAVariantOfAProduct_api_v1_products_parent_product_id_variants_post","parameters":[{"name":"parent_product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Add a new product as a variant of another product.\n\nIt's necessary to send a dictionary with the info of the new variant.\n\n**⚠️ Keep in mind that converting a Single product to a Parent might cause data loss**\n\n| **field** | **Mandatory** | **Description** |\n| --- | --- | --- |\n| 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' |\n\n**Variant**\n\n| **field** | **Mandatory** | **Description** |\n| --- | --- | --- |\n| sku | yes | sku for the new product |\n| label | no | label for the new product. Any other System attribute can be set at the same level |\n| attributes | no | custom attribute values for the new products. If you add a parent-level attribute here it will be set as Overwritten |","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"variant":{"type":"object","properties":{"sku":{"type":"string"},"label":{"type":"string"},"attributes":{"type":"object","properties":{"description_create_a_rich_text_type_attribute":{"type":"string"},"price_create_a_decimal_number_type_attribute":{"type":"number"}}}}}}},"examples":{"default":{"value":{"variant":{"sku":"new variant from API","label":"new variant label","attributes":{"description_create_a_rich_text_type_attribute":"Variants can be created from the API","price_create_a_decimal_number_type_attribute":23.99}}}}}}}},"responses":{"201":{"description":"201 Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"_parent_id":{"type":"string"},"assets":{"type":"array","items":{}},"attributes":{"type":"object","properties":{}},"categories":{"type":"array","items":{}},"created":{"type":"string"},"gtin":{"type":["string","null"]},"id":{"type":"string"},"label":{"type":"string"},"modified":{"type":"string"},"num_variations":{"type":"integer"},"overwritten_attributes":{"type":"array","items":{}},"product_family_id":{"type":"string"},"product_family_model_id":{"type":"string"},"product_type":{"type":"string"},"relationships":{"type":"array","items":{}},"sku":{"type":"string"},"status":{"type":"string"},"thumbnail":{"type":["string","null"]}}}}}},"examples":{"default":{"value":{"data":[{"_parent_id":"","assets":[],"attributes":{},"categories":[],"created":"2023-03-16T11:10:37.599000+00:00","gtin":null,"id":"6412f92da3438ee01ab81d38","label":"new variant label","modified":"2023-03-16T11:10:37.634000+00:00","num_variations":0,"overwritten_attributes":[],"product_family_id":"6405f5ce7288e165f149eb3c","product_family_model_id":"6405f74a7288e165f149eb47","product_type":"VARIANT","relationships":[],"sku":"new variant from API","status":"Draft","thumbnail":null}]}}}}}},"409":{"description":"409 Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"sku","msg":"A product with the same SKU already exists"}],"msg":"product data validation failed"}}}}}}}}}},"/api/v1/products/{parent_product_id}/variants/resync":{"post":{"tags":["products"],"summary":"Resync variants","operationId":"resyncVariants_api_v1_products_parent_product_id_variants_resync_post","parameters":[{"name":"parent_product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Restore the attributes at parent level of the variant with the value of the parent\n\nIt's necessary to send two list, one with the labels of the attributes and another with the ids of the variant products.\n\n| **field** | **Mandatory** | **Description** |\n| --- | --- | --- |\n| attribute_labels | yes | List of attribute labels to reset. These attributes must be at a parent level |\n| 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 |\n\nA 200 OK is returned upon success.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_labels":{"type":"array","items":{"type":"string"}},"variant_ids":{"type":"array","items":{"type":"string"}}}},"examples":{"default":{"value":{"attribute_labels":["attribute_label_1","attribute_label_2"],"variant_ids":["",""]}}}}}},"responses":{"200":{"description":"200 Ok"},"400":{"description":"400 Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"attribute_labels","msg":"attributes.attribute_at_variant_level not a parent attribute from family model"}],"msg":"You must only supply attributes from parent product when accessing this resource"}}}}}}}}}},"/api/v1/products/{product_id}":{"delete":{"tags":["products"],"summary":"Delete a product","operationId":"removesProductFromTheSystem_api_v1_products_product_id_delete","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Removes a product from the PIM\n\n**WARNING**: All variants linked to this product will be removed.\n\nIf there are any variants you do not want to delete, \nthey must be unlinked from the parent first, which will turn them into single products.\n\n204 code is returned upon success","responses":{"204":{"description":"204 OK"},"404":{"description":"404 Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":"No results found for 5c4ad0e1575fae0020dd7eef"}}}}}}}}},"get":{"tags":["products"],"summary":"Get a product","operationId":"getProductData_api_v1_products_product_id_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Gets product attributes\n\nThis verb accepts a query parameter named __all_attributes__ which allows to specify if empty attributes should be included on response as null.\n \n200 code is returned upon success\n\n**Params**\n\n| Param | Options |\n| --- | --- |\n| 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

|","responses":{"200":{"description":"Get product data with all attributes","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"_parent_id":{"type":["string","null"]},"assets":{"type":"array","items":{}},"attributes":{"type":"object","properties":{"application_place":{"type":["string","null"]},"basic_info_complete":{"type":"integer"},"bowl_depth_mm":{"type":"string"},"bowl_length_mm":{"type":"string"},"bowl_position":{"type":"string"},"bowl_width_mm":{"type":["string","null"]},"brand":{"type":"string"},"collection":{"type":"string"},"color":{"type":"string"},"description":{"type":"string"},"eta_stock_date":{"type":["string","null"]},"faucets_finish":{"type":["string","null"]},"feature_description":{"type":"string"},"fixing_kit":{"type":["string","null"]},"gtin":{"type":"string"},"handle_position":{"type":["string","null"]},"in_stock":{"type":"boolean"},"installation_type":{"type":["string","null"]},"installation_type_bowls":{"type":["string","null"]},"packed_product_height_mm":{"type":"string"},"packed_product_length_mm":{"type":"string"},"packed_product_weight_kg":{"type":"number"},"packed_product_width_mm":{"type":"string"},"plug_and_waste":{"type":["string","null"]},"product_height_mm":{"type":"string"},"product_length_mm":{"type":"string"},"product_lifecycle_stage":{"type":["string","null"]},"product_owner":{"type":"string"},"product_type":{"type":"string"},"product_weight_kg":{"type":"number"},"product_width_mm":{"type":"string"},"rich_info_complete":{"type":"number"},"suggested_retail_price":{"type":"number"},"taphole_configuration":{"type":["string","null"]},"test_date":{"type":["string","null"]},"test_multiselect":{"type":["string","null"]},"title":{"type":"string"},"type":{"type":"string"},"type_of_cartridge":{"type":["string","null"]},"video_url":{"type":["string","null"]},"washbasin_capacity_l":{"type":["string","null"]}}},"categories":{"type":"array","items":{}},"created":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"modified":{"type":"string"},"num_variations":{"type":"integer"},"sku":{"type":"string"},"status":{"type":"string"},"thumbnail":{"type":["string","null"]}}}}}},"examples":{"default":{"value":{"data":[{"_parent_id":null,"assets":[],"attributes":{"application_place":null,"basic_info_complete":100,"bowl_depth_mm":"455","bowl_length_mm":"160","bowl_position":"Central","bowl_width_mm":null,"brand":"Plytix","collection":"2019","color":"Glass","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.","eta_stock_date":null,"faucets_finish":null,"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.","fixing_kit":null,"gtin":"3234567890126","handle_position":null,"in_stock":true,"installation_type":null,"installation_type_bowls":null,"packed_product_height_mm":"198","packed_product_length_mm":"167","packed_product_weight_kg":4.75,"packed_product_width_mm":"256","plug_and_waste":null,"product_height_mm":"175","product_length_mm":"148","product_lifecycle_stage":null,"product_owner":"Jon","product_type":"Bathroom Sink","product_weight_kg":3.23,"product_width_mm":"241","rich_info_complete":90.9090909090909,"suggested_retail_price":310.24,"taphole_configuration":null,"test_date":null,"test_multiselect":null,"title":"Black Wavy Frost Glass Vessel Bowl","type":"Vessel Bowl","type_of_cartridge":null,"video_url":null,"washbasin_capacity_l":null},"categories":[],"created":"2019-03-25T16:10:45.312000+00:00","id":"5c98ef754a6c252c96793574","label":"Black Wavy Frost Glass Vessel Bowl","modified":"2019-06-04T09:58:17.746000+00:00","num_variations":0,"sku":"1001","status":"Completed","thumbnail":null}]}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 5c4ec5afb3bfd10001e45603"}}}}}}}}},"patch":{"tags":["products"],"summary":"Update a product","operationId":"modifySelectedAttributesOfAProduct_api_v1_products_product_id_patch","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Modifies attributes from product, leaving the rest unchanged.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"object","properties":{"color_create_a_multiselect_type_attribute":{"type":"array","items":{"type":"string"}},"description_create_a_rich_text_type_attribute":{"type":"string"},"price_create_a_decimal_number_type_attribute":{"type":["string","null"]}}},"label":{"type":"string"},"status":{"type":"string"}}},"examples":{"default":{"value":{"attributes":{"color_create_a_multiselect_type_attribute":["Blue"],"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.","price_create_a_decimal_number_type_attribute":null},"label":"Product ~ 1 - patch example","status":"Completed"}}}}}},"responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"_parent_id":{"type":["string","null"]},"assets":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string"},"id":{"type":"string"},"thumbnail":{"type":"string"},"url":{"type":"string"}}}},"attributes":{"type":"object","properties":{"color_create_a_multiselect_type_attribute":{"type":"array","items":{"type":"string"}},"description_create_a_rich_text_type_attribute":{"type":"string"}}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}}}},"created":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"modified":{"type":"string"},"num_variations":{"type":"integer"},"sku":{"type":"string"},"status":{"type":"string"},"thumbnail":{"type":"object","properties":{"filename":{"type":"string"},"id":{"type":"string"},"thumbnail":{"type":"string"},"url":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"data":[{"_parent_id":null,"assets":[{"filename":"Kettle handle - White.png","id":"5c4ed8002f0985001e233276","thumbnail":"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/00/d8/4e/5c/5c4ed8002f0985001e233276/Kettle handle - White.png","url":"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/00/d8/4e/5c/5c4ed8002f0985001e233276/Kettle handle - White.png"}],"attributes":{"color_create_a_multiselect_type_attribute":["Blue"],"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."},"categories":[{"id":"5c4ed7f62f0985001c233279","name":"Kettles & Teapots","path":["Sample Categories","Kettles & Teapots"]}],"created":"2019-01-28T10:22:56.817000+00:00","id":"5c4ed8002f0985001e233275","label":"Product ~ 1 - patch example","modified":"2019-01-28T10:24:44.792000+00:00","num_variations":0,"sku":"Sample - 001","status":"Completed","thumbnail":{"filename":"assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/00/d8/4e/5c/5c4ed8002f0985001e233276/Kettle handle - White.png","id":"5c4ed8002f0985001e233276","thumbnail":"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/00/d8/4e/5c/5c4ed8002f0985001e233276/Kettle handle - White.png","url":"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/00/d8/4e/5c/5c4ed8002f0985001e233276/Kettle handle - White.png"}}]}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 5c4ed8002f0985001e233279"}}}}}}},"422":{"description":"422 Unprocessable entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"color_create_a_multiselect_type_attribute","msg":"[u'Red'] are not a valid values for Color (Create a multiselect type attribute) attribute."}],"msg":"product data validation failed"}}}}}}}}}},"/api/v1/products/{product_id}/assets":{"get":{"tags":["products"],"summary":"List a product's assets","operationId":"getProductSRelatedAssets_api_v1_products_product_id_assets_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Get all assets related to this product","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string"},"id":{"type":"string"},"thumbnail":{"type":"string"},"url":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"filename":"demo.png","id":"5bfac7d851e7590001486761","thumbnail":"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/demo.png","url":"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/demo.png"}]}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 5c4ec5afb3bfd10001e45603"}}}}}}}}},"post":{"tags":["products"],"summary":"Link an asset to a product","operationId":"linkAnExistingAssetToAProductMediaAttribute_api_v1_products_product_id_assets_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"$bc","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"attribute_label":{"type":"string"}}},"examples":{"default":{"value":{"id":"5c4ed8002f0985001e233275","attribute_label":"dummy_media_attribute"}}}}}},"responses":{"201":{"description":"201 Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5c4ed8002f0985001e233275"}]}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset.id","msg":"asset does not exist"}],"msg":"Asset id 5c4ed8002f0985001e233275 does not exist"}}}}}}},"409":{"description":"409 Asset already linked","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset.id","msg":"already linked"}],"msg":"Asset id 5c4ed8002f0985001e233276 is already linked to product attribute"}}}}}}},"422":{"description":"422 Asset id is not provided","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"Missing data for required field."}],"msg":"Schema validation error"}}}}}}}}}},"/api/v1/products/{product_id}/assets/{asset_id}":{"delete":{"tags":["products"],"summary":"Unlink an asset from a product","operationId":"unbindAssetFromProduct_api_v1_products_product_id_assets_asset_id_delete","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Removes relationship between a product and an asset. Asset is not deleted","responses":{"204":{"description":"204 Success"},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset_id","msg":"asset id 5c483ee8eb9139000154dd53 is not related to product id 5c4ad0e1575fae0020dd7dde"}],"msg":"asset id 5c483ee8eb9139000154dd53 is not related to product id 5c4ad0e1575fae0020dd7dde"}}}}}}}}},"get":{"tags":["products"],"summary":"Get a product's asset","operationId":"getAnAssetOfThisProduct_api_v1_products_product_id_assets_asset_id_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Gets a product's asset by id","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string"},"id":{"type":"string"},"thumbnail":{"type":"string"},"url":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"filename":"k9189-1.jpg","id":"5c483ee8eb9139000154dd5e","thumbnail":"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/e8/3e/48/5c/5c483ee8eb9139000154dd5e/k9189-1.jpg","url":"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/e8/3e/48/5c/5c483ee8eb9139000154dd5e/k9189-1.jpg"}]}}}}}},"404":{"description":"404 Asset not related to product","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset_id","msg":"asset id 5c483ee8eb9139000154dd53 is not related to product id 5c4ad0e1575fae0020dd7dde"}],"msg":"asset id 5c483ee8eb9139000154dd53 is not related to product id 5c4ad0e1575fae0020dd7dde"}}}}}}}}}},"/api/v1/products/{product_id}/categories":{"get":{"tags":["products"],"summary":"List a product's categories","operationId":"getProductSRelatedCategories_api_v1_products_product_id_categories_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Get all categories related to this product","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}}}}}},"examples":{"default":{"value":{"data":[{"id":"5c4ed7f62f0985001c233276","name":"Ground Coffee","path":["Sample Categories","Coffee & Tea","Ground Coffee"]},{"id":"5c4ed7f62f0985001c233279","name":"Kettles & Teapots","path":["Sample Categories","Kettles & Teapots"]}]}}}}}},"404":{"description":"404 Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 5c4ed8002f0985001e233279"}}}}}}}}},"post":{"tags":["products"],"summary":"Link a category to a product","operationId":"linkAnExistingCategoryToProduct_api_v1_products_product_id_categories_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Link an existing category to this product.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}},"examples":{"default":{"value":{"id":"5c4ed7f62f0985001c233279"}}}}}},"responses":{"201":{"description":"201 Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}}}}}},"examples":{"default":{"value":{"data":[{"id":"5c4ed7f62f0985001c233279","name":"Kettles & Teapots","path":["Sample Categories","Kettles & Teapots"]}]}}}}}},"404":{"description":"404 Product not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 5c4ed8002f0985001e233279"}}}}}}},"409":{"description":"409 Category already linked","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"category.id","msg":"already linked"}],"msg":"Category id 5c4ed7f62f0985001c233279 is already linked to product"}}}}}}},"422":{"description":"422 Category not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"category.id","msg":"does not exist"}],"msg":"Unknown category 5c4ed7f62f0985001c233288"}}}}}}}}}},"/api/v1/products/{product_id}/categories/{category_id}":{"delete":{"tags":["products"],"summary":"Unlink a category from a product","operationId":"unbindCategoryFromProduct_api_v1_products_product_id_categories_category_id_delete","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Removes relationship between a product and category. Category is not deleted","responses":{"204":{"description":"204 OK"},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset.id","msg":"category_id 5c482b0b06d4fc001ce9bb10 is not related to product id 5c4ad0e1575fae0020dd7dde"}],"msg":"category_id 5c482b0b06d4fc001ce9bb10 is not related to product id 5c4ad0e1575fae0020dd7dde"}}}}}}}}},"get":{"tags":["products"],"summary":"Get a product's category","operationId":"getACategoryOfThisProduct_api_v1_products_product_id_categories_category_id_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Gets a product's category by id","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}}}}}},"examples":{"default":{"value":{"data":[{"id":"5c482b0b06d4fc001ce9bb1c","name":"Drinkware","path":["Sample Categories","Drinkware"]}]}}}}}},"404":{"description":"404 Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset.id","msg":"category_id 5c482b0b06d4fc001ce9bb10 is not related to product id 5c4ad0e1575fae0020dd7dde"}],"msg":"category_id 5c482b0b06d4fc001ce9bb10 is not related to product id 5c4ad0e1575fae0020dd7dde"}}}}}}}}}},"/api/v1/products/{product_id}/family":{"post":{"tags":["products"],"summary":"Assign a product family","operationId":"assignFamily_api_v1_products_product_id_family_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Assign family to a product\n\n| **parameter** | **description** | **mandatory** |\n| --- | --- | --- |\n| product_family_id | id of the product family that is going to be assigned to the product | yes |\n\n# Important notes:\n\n- 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","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product_family_id":{"type":"string"}}},"examples":{"default":{"value":{"product_family_id":""}}}}}},"responses":{"200":{"description":"200 OK Assign family to a parent product","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"_parent_id":{"type":["string","null"]},"assets":{"type":"array","items":{}},"attributes":{"type":"object","properties":{"boolean":{"type":"boolean"},"date":{"type":"string"},"decimal":{"type":"number"},"integer":{"type":"integer"},"paragraph":{"type":"string"},"short_text":{"type":"string"}}},"categories":{"type":"array","items":{}},"created":{"type":"string"},"gtin":{"type":["string","null"]},"id":{"type":"string"},"label":{"type":["string","null"]},"modified":{"type":"string"},"num_variations":{"type":"integer"},"overwritten_attributes":{"type":"array","items":{}},"product_family_id":{"type":"string"},"product_family_model_id":{"type":"string"},"product_type":{"type":"string"},"relationships":{"type":"array","items":{}},"sku":{"type":"string"},"status":{"type":"string"},"thumbnail":{"type":["string","null"]}}}}}},"examples":{"default":{"value":{"data":[{"_parent_id":null,"assets":[],"attributes":{"boolean":false,"date":"2023-02-27T00:00:00","decimal":25.3,"integer":25,"paragraph":"paragraph","short_text":"shorttext"},"categories":[],"created":"2023-03-20T16:21:06.052000+00:00","gtin":null,"id":"641887f2d10eec81d978e10e","label":null,"modified":"2023-03-22T13:33:06.925000+00:00","num_variations":0,"overwritten_attributes":[],"product_family_id":"6422dd98d732cac61a58431e","product_family_model_id":"6422dda9d732cac61a584320","product_type":"PARENT","relationships":[],"sku":"1013","status":"Draft","thumbnail":null}]}}}}}}}}},"/api/v1/products/{product_id}/relationships/{relationship_id}":{"post":{"tags":["products"],"summary":"Add products to a relationship","operationId":"assignProductsToRelationship_api_v1_products_product_id_relationships_relationship_id_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"relationship_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"$bd","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product_relationships":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"integer"},"product_id":{"type":"string"}}}}}},"examples":{"default":{"value":{"product_relationships":[{"quantity":1,"product_id":"5d0baf07d4bf5513d190245f"},{"quantity":9,"product_id":"5d0baf07d4bf5513d1902460"},{"quantity":6,"product_id":"5d0baf07d4bf5513d1902461"},{"quantity":1,"product_id":"5d0baf07d4bf5513d1902462"}]}}}}}},"responses":{"200":{"description":"200 OK, no updates","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"related_products":{"type":"array","items":{"type":"object","properties":{"last_modified":{"type":"string"},"product_id":{"type":"string"},"quantity":{"type":"integer"}}}},"relationship_id":{"type":"string"},"relationship_label":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"related_products":[{"last_modified":"2023-08-22T10:06:56.535000+00:00","product_id":"64df58d393861834c7ffcacb","quantity":1},{"last_modified":"2023-08-22T10:05:07.255000+00:00","product_id":"64df58d34f8bba397effcacd","quantity":1}],"relationship_id":"64e485f90fc35b27e41c2367","relationship_label":"relationship"}]}}}}}},"201":{"description":"Assign products to a relationship","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"related_products":{"type":"array","items":{"type":"object","properties":{"last_modified":{"type":"string"},"product_id":{"type":"string"},"quantity":{"type":"integer"}}}},"relationship_id":{"type":"string"},"relationship_label":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"related_products":[{"last_modified":"2019-09-24T17:28:07.329000+00:00","product_id":"5d0baf07d4bf5513d190245f","quantity":1},{"last_modified":"2019-09-24T17:28:07.329000+00:00","product_id":"5d0baf07d4bf5513d1902460","quantity":9},{"last_modified":"2019-09-24T17:28:07.329000+00:00","product_id":"5d0baf07d4bf5513d1902461","quantity":6},{"last_modified":"2019-09-24T17:28:07.329000+00:00","product_id":"5d0baf07d4bf5513d1902462","quantity":1}],"relationship_id":"5d8a50b547397aea2a603079","relationship_label":"contains"}]}}}}}},"409":{"description":"409 Conflict, no product id found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"},"value":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"product_id","msg":"product does not exists","value":"64e4875575a60446300615e8"}],"msg":"relationship data validation failed"}}}}}}}}}},"/api/v1/products/{product_id}/relationships/{relationship_id}/product/{related_product_id}":{"patch":{"tags":["products"],"summary":"Update a related product","operationId":"modifyRelationshipAttributes_api_v1_products_product_id_relationships_relationship_id_product_related_product_id_patch","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"relationship_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"related_product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Modify selected relationship attributes\n\nCurrent version of the API only allows the modification of the 'quantity' attribute.\nA 200 OK status code will be returned upon successful call\n\n# Request format\n| *field* | *type* | *description* |\n| --- | :---: | --- |\n| quantity | number | new value, must be a positive integer |\n\n\n# Response format\n\nSuccessful responses will be returned in \"data\" array and will be in the form:\n\n| *field* | *type* | *description* |\n| --- | :---: | --- |\n| product_id | string | related product identifier | \n| quantity | number | current quantity | \n| last_modified | date | last modification date | \n\n\nExample Request and Response:\n\n~~~~\nRequest:\n{\n\t\"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~~~~","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quantity":{"type":"integer"}}},"examples":{"default":{"value":{"quantity":10}}}}}},"responses":{"200":{"description":"Modify association attributes","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"last_modified":{"type":"string"},"product_id":{"type":"string"},"quantity":{"type":"integer"}}}}}},"examples":{"default":{"value":{"data":[{"last_modified":"2019-09-27T05:57:45.865974+00:00","product_id":"5d8cf911bde76bea4e2eff13","quantity":10}]}}}}}}}}},"/api/v1/products/{product_id}/relationships/{relationship_id}/unlink":{"post":{"tags":["products"],"summary":"Remove products from a relationship","operationId":"removeProductsFromARelationship_api_v1_products_product_id_relationships_relationship_id_unlink_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"relationship_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Remove products from an existing relationship\n\nA 204 No Content status code is returned upon success\n\n# Request format\n\nRequest format is the same used to assign products to a relationship except for the 'quantity' field, which is not necessary and will be ignored.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product_relationships":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"}}}}}},"examples":{"default":{"value":{"product_relationships":[{"product_id":"5d8cf9114b1830f2192eff0c"},{"product_id":"5d8cf911326dbd40982eff0c"}]}}}}}},"responses":{"204":{"description":"Remove products from a relationship"}}}},"/api/v1/products/{product_id}/variant/{variant_id}":{"post":{"tags":["products"],"summary":"Link a variant to a product","operationId":"linkVariantToAProduct_api_v1_products_product_id_variant_variant_id_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"variant_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Link an existing product as a variant of another product\n\n**variant_id** will become a Variant of **product_id**\n\n- Product can be a Single product or a Parent product\n \n- Variant must be a Single product\n \n\nBoth product and variant must belong to the same Family or be Unassigned.\n\n**⚠️ The result of this operation may cause data loss**","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"_parent_id":{"type":["string","null"]},"assets":{"type":"array","items":{}},"attributes":{"type":"object","properties":{"boolean":{"type":"boolean"},"decimal":{"type":"number"},"multiselect":{"type":"array","items":{"type":"string"}},"short_text":{"type":"string"},"url":{"type":"string"}}},"categories":{"type":"array","items":{}},"created":{"type":"string"},"created_user_audit":{"type":"object","properties":{"avatar_color":{"type":"string"},"type":{"type":"string"},"user_display_name":{"type":["string","null"]},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_last_name":{"type":"string"},"user_name":{"type":"string"},"user_thumb":{"type":"string"},"username":{"type":"string"}}},"gtin":{"type":["string","null"]},"id":{"type":"string"},"label":{"type":["string","null"]},"modified":{"type":"string"},"modified_user_audit":{"type":"object","properties":{"avatar_color":{"type":["string","null"]},"type":{"type":"string"},"user_display_name":{"type":["string","null"]},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_last_name":{"type":["string","null"]},"user_name":{"type":"string"},"user_thumb":{"type":["string","null"]},"username":{"type":["string","null"]}}},"num_variations":{"type":"integer"},"overwritten_attributes":{"type":"array","items":{}},"product_family_id":{"type":"string"},"product_family_model_id":{"type":"string"},"product_type":{"type":"string"},"relationships":{"type":"array","items":{}},"sku":{"type":"string"},"status":{"type":"string"},"thumbnail":{"type":["string","null"]}}}}}},"examples":{"default":{"value":{"data":[{"_parent_id":null,"assets":[],"attributes":{"boolean":false,"decimal":23.3,"multiselect":["a","d"],"short_text":"shorttext","url":"https://gitlab.plytix.com/"},"categories":[],"created":"2023-03-20T16:21:05.923000+00:00","created_user_audit":{"avatar_color":"#74cc66","type":"USER","user_display_name":null,"user_email":"user@email.com","user_id":"60795d80302a91ac42e7f5f8","user_last_name":"Name","user_name":"User","user_thumb":"https://static.plytix.com/template/dev/img/user-default-image.png","username":"username"},"gtin":null,"id":"641887f1d10eec81d978e10a","label":null,"modified":"2023-03-20T16:32:13.485000+00:00","modified_user_audit":{"avatar_color":null,"type":"API","user_display_name":null,"user_email":"apikey","user_id":"6405cf21f856320007dd2210","user_last_name":null,"user_name":"apikey","user_thumb":null,"username":null},"num_variations":1,"overwritten_attributes":[],"product_family_id":"6405f5ce7288e165f149eb3c","product_family_model_id":"6405f74a7288e165f149eb47","product_type":"PARENT","relationships":[],"sku":"1011","status":"Draft","thumbnail":null}]}}}}}},"422":{"description":"422 Parent and Variant do not belong to the same family","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"Parent and variants must be assigned to the same family"}}}}}}}}}},"/api/v1/products/{product_id}/variants":{"get":{"tags":["products"],"summary":"List a product's variants","operationId":"getProductSRelatedVariants_api_v1_products_product_id_variants_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Get related variants of a parent product","responses":{"201":{"description":"200 Ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"_parent_id":{"type":"string"},"assets":{"type":"array","items":{}},"attributes":{"type":"object","properties":{}},"categories":{"type":"array","items":{}},"created":{"type":"string"},"gtin":{"type":["string","null"]},"id":{"type":"string"},"label":{"type":["string","null"]},"modified":{"type":"string"},"num_variations":{"type":"integer"},"overwritten_attributes":{"type":"array","items":{}},"product_family_id":{"type":"string"},"product_family_model_id":{"type":"string"},"product_type":{"type":"string"},"relationships":{"type":"array","items":{}},"sku":{"type":"string"},"status":{"type":"string"},"thumbnail":{"type":["string","null"]}}}}}},"examples":{"default":{"value":{"data":[{"_parent_id":"64130527e3628de6cf7cdf7e","assets":[],"attributes":{},"categories":[],"created":"2023-03-16T12:02:03.395000+00:00","gtin":null,"id":"6413053be3628de6cf7cdf7f","label":null,"modified":"2023-03-16T12:02:03.439000+00:00","num_variations":0,"overwritten_attributes":[],"product_family_id":"6405f5ce7288e165f149eb3c","product_family_model_id":"6405f74a7288e165f149eb47","product_type":"VARIANT","relationships":[],"sku":"my_variant_product","status":"Draft","thumbnail":null}]}}}}}},"422":{"description":"404 Product not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"does not exist"}],"msg":" No results found for 64130527e3621de6cf7cdf7e"}}}}}}}}}},"/api/v1/relationships":{"post":{"tags":["relationships"],"summary":"Create a relationship","operationId":"addNewRelationship_api_v1_relationships_post","description":"Create a new relationship.\n\nEach product can have a maximum of 300 products related to it per relationship.\n\nUpon successful creation, a 201 http status code will be returned.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}},"examples":{"default":{"value":{"name":"Recommended products"}}}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/relationships/search":{"post":{"tags":["relationships"],"summary":"Search relationships","operationId":"searchRelationships_api_v1_relationships_search_post","description":"Filter relationships by multiple criteria.\n\nFilter structure and format is described under the [Resources](#resources) section in this guide, available fields can be queried using relationship filters endpoint","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"string"}},"filters":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}},"relationship_filters":{"type":"array","items":{}},"pagination":{"type":"object","properties":{"count":{"type":"integer"},"order":{"type":"string"},"page":{"type":"integer"}}}}},"examples":{"default":{"value":{"attributes":["id","modified","name","symmetrical"],"filters":[[{"field":"name","operator":"like","value":"free"},{"field":"symmetrical","operator":"eq","value":true}]],"relationship_filters":[],"pagination":{"count":4,"order":"name","page":1}}}}}}},"responses":{"200":{"description":"Sample search","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"modified":{"type":"string"},"name":{"type":"string"}}}},"pagination":{"type":"object","properties":{"count":{"type":"integer"},"order":{"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"}}}}},"examples":{"default":{"value":{"data":[{"id":"64ad0d69573a2e83cd38b146","label":"gift_pack","modified":"2023-07-11T08:06:01.419000+00:00","name":"Gift pack"}],"pagination":{"count":1,"order":"name","page":1,"page_size":25,"total_count":4}}}}}}}}}},"/api/v1/relationships/{relationship_id}":{"get":{"tags":["relationships"],"summary":"Get a relationship","operationId":"getRelationshipData_api_v1_relationships_relationship_id_get","parameters":[{"name":"relationship_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get relationship data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"modified":{"type":"string"},"name":{"type":"string"},"label":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5d8362c226387abb39cddb88","created_at":"2019-09-19T00:00:00.000000+00:00","modified":"2019-09-19T00:00:00.000008+00:00","name":"Gift basket","label":"gift_basket"}]}}}}}}}},"patch":{"tags":["relationships"],"summary":"Update a relationship","operationId":"modifyAttributesOfARelationship_api_v1_relationships_relationship_id_patch","parameters":[{"name":"relationship_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Current version of the API supports the following attributes:\n\n| *field* | *type* | *description* |\n| --- | :---: | --- |\n| name | string | human-friendly name |\n\nany other attributes will be ignored","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}},"examples":{"default":{"value":{"name":"new name"}}}}}},"responses":{"200":{"description":"Modify attributes","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"modified":{"type":"string"},"name":{"type":"string"},"label":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5d8362c226387abb39cddb88","created_at":"2019-09-19T00:00:00.000000+00:00","modified":"2019-09-19T00:00:00.000008+00:00","name":"Gift basket","label":"gift_basket"}]}}}}}}}},"delete":{"tags":["relationships"],"summary":"Delete a relationship","operationId":"removeRelationshipsFromAccount_api_v1_relationships_relationship_id_delete","parameters":[{"name":"relationship_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Remove a relationship from user’s account.\n\nIf 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.\n\nA 204 No content is returned upon success","responses":{"204":{"description":"Successful deletion of relationship"},"409":{"description":"Remove in-use relationship","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"object","properties":{"ecatalogs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"usages","msg":{"ecatalogs":[{"id":"5d88684a58ab2325c4991206","name":"All products - 2019"}]}}],"msg":"Relationship id 5d8362c226387abb39cddb88 is in use"}}}}}}}}}},"/api/v2/products":{"post":{"tags":["products V2 BETA"],"summary":"Create a product","operationId":"addNewProducts_api_v2_products_post","description":"$be","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product_data":{"type":"string"}}},"examples":{"default":{"value":{"product_data":"your_product_data"}}}}}},"responses":{"201":{"description":"201 Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"created":{"type":"string"},"modified":{"type":"string"},"created_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}},"modified_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"data":[{"id":"5c4ef3a9bedb5e000189befc","created":"2019-01-28T12:20:57.341000+00:00","modified":"2019-01-28T12:20:57.437000+00:00","created_user_audit":{"type":"API","user_email":"api","user_id":"67191ed7d6e8e300016f1414","user_name":"api"},"modified_user_audit":{"type":"API","user_email":"api","user_id":"67191ed7d6e8e300016f1414","user_name":"api"}}]}}}}}},"400":{"description":"400 Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"integer"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"http_status_code","msg":400}],"msg":"Failed to decode JSON object: Expecting property name enclosed in double quotes: line 2 column 5 (char 6)"}}}}}}},"422":{"description":"422 Unprocessable entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"status","msg":"Value is not valid, valid values are [Draft, Completed, Archived]"}],"msg":"product data validation failed"}}}}}}}}}},"/api/v2/products/search":{"post":{"tags":["products V2 BETA"],"summary":"Search products","operationId":"productSearch_api_v2_products_search_post","description":"$bf","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"}}}}},"attributes":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"order":{"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"}}}}},"examples":{"default":{"value":{"filters":[[{"field":"status","operator":"eq","value":"Draft"},{"field":"categories","operator":"in","value":["5c4ed7f62f0985001c233274"]}],[{"field":"categories","operator":"!exists","value":null}]],"attributes":["thumbnail","assets","label","categories","modified","created","status"],"pagination":{"order":"sku","page":1,"page_size":25}}}}}}},"responses":{"200":{"description":"200 Minimum search query","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"object","properties":{}},"id":{"type":"string"},"num_variations":{"type":"integer"},"sku":{"type":"string"}}}},"pagination":{"type":"object","properties":{"count":{"type":"integer"},"order":{"type":["string","null"]},"page":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"}}}}},"examples":{"default":{"value":{"data":[{"attributes":{},"id":"5c4ed8002f0985001d233274","num_variations":0,"sku":"Sample - 002"},{"attributes":{},"id":"5c4ed8002f09850020233274","num_variations":0,"sku":"Sample - 003"},{"attributes":{},"id":"5c4ed8002f0985001e233275","num_variations":0,"sku":"Sample - 001"},{"attributes":{},"id":"5c4ed8002f0985001f233274","num_variations":0,"sku":"Sample - 004"},{"attributes":{},"id":"5c4ed8002f0985001a233274","num_variations":5,"sku":"Sample - 005"},{"attributes":{},"id":"5c4ed8002f0985001b233274","num_variations":2,"sku":"Sample - 009"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4ed80c2f0985001a23327e","num_variations":0,"sku":"Sample - 008"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4ed80c2f0985001e233279","num_variations":0,"sku":"Sample - 007"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4ed80c2f0985001b23327a","num_variations":0,"sku":"Sample - 006"},{"_parent_id":"5c4ed8002f0985001b233274","attributes":{},"id":"5c4ed80c2f0985001d233278","num_variations":0,"sku":"Sample - 011"},{"_parent_id":"5c4ed8002f0985001b233274","attributes":{},"id":"5c4ed80c2f09850021233275","num_variations":0,"sku":"Sample - 010"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4eeb97050d860001717698","num_variations":0,"sku":"new variant from API"},{"_parent_id":"5c4ed8002f0985001a233274","attributes":{},"id":"5c4eec84908d2d00011c8e0b","num_variations":0,"sku":"new variant from APId"},{"attributes":{},"id":"5c4ef0c59311990001fc3db0","num_variations":0,"sku":"Black Kettle"},{"attributes":{},"id":"5c4ef1709311990001fc3db1","num_variations":0,"sku":"Black Kettle_1"},{"attributes":{},"id":"5c4ef29d9311990001fc3db2","num_variations":0,"sku":"Black Kettle_11"},{"attributes":{},"id":"5c4ef3829311990001fc3db3","num_variations":0,"sku":"Black Kettle_111"},{"attributes":{},"id":"5c4ef3a9bedb5e000189befc","num_variations":0,"sku":"Black Kettle_1111"},{"attributes":{},"id":"5c4ef7f7bedb5e000189befd","num_variations":0,"sku":"Black Kettle111111"},{"attributes":{},"id":"5c4ef836bedb5e000189befe","num_variations":0,"sku":"Black Kettle111111111"}],"pagination":{"count":20,"order":null,"page":1,"page_size":25,"total_count":20}}}}}}},"422":{"description":"422 Column limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"schema","msg":"columns limit exceeded, current limit is 50"}],"msg":"Schema validation error"}}}}}}}}}},"/api/v2/products/{parent_product_id}/variant/{variant_id}":{"delete":{"tags":["products V2 BETA"],"summary":"Unlink a variant","operationId":"unlinkAVariantOfAProduct_api_v2_products_parent_product_id_variant_variant_id_delete","parameters":[{"name":"parent_product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"variant_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Removes relationship between a variant and its parent. Variant becomes a Single product.\n\n**⚠️ This action might cause data loss**","responses":{"204":{"description":"204 No content","content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"default":{"value":{}}}}}},"422":{"description":"422 Variant not linked to parent","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"variant","msg":"this product is not variant of the parent product"}],"msg":"unlinking unrelated products"}}}}}}}}}},"/api/v2/products/{parent_product_id}/variants":{"post":{"tags":["products V2 BETA"],"summary":"Add a variant","operationId":"addAVariantOfAProduct_api_v2_products_parent_product_id_variants_post","parameters":[{"name":"parent_product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Add a new product as a variant of another product.\n\nIt's necessary to send a dictionary with the info of the new variant.\n\nIt returns the id of the new product created.\n\n**⚠️ Keep in mind that converting a Single product to a Parent might cause data loss**\n\n| **field** | **Mandatory** | **Description** |\n| --- | --- | --- |\n| sku | yes | sku for the new product |\n| label | no | label for the new product. Any other System attribute can be set at the same level |\n| attributes | no | custom attribute values for the new products. If you add a parent-level attribute here it will be set as Overwritten |","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string"},"label":{"type":"string"},"attributes":{"type":"object","properties":{"description_create_a_rich_text_type_attribute":{"type":"string"},"price_create_a_decimal_number_type_attribute":{"type":"number"}}}}},"examples":{"default":{"value":{"sku":"new variant from API","label":"new variant label","attributes":{"description_create_a_rich_text_type_attribute":"Variants can be created from the API","price_create_a_decimal_number_type_attribute":23.99}}}}}}},"responses":{"201":{"description":"201 Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"created":{"type":"string"},"created_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}},"modified":{"type":"string"},"modified_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"data":[{"id":"6734ac432bbf7d289efd7988","created":"2024-11-13T13:40:19.620951","created_user_audit":{"type":"API","user_email":"api","user_id":"67191ed7d6e8e300016f1414","user_name":"api"},"modified":"2024-11-13T13:40:19.707781","modified_user_audit":{"type":"API","user_email":"api","user_id":"67191ed7d6e8e300016f1414","user_name":"api"}}]}}}}}},"409":{"description":"409 Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"sku","msg":"A product with the same SKU already exists"}],"msg":"product data validation failed"}}}}}}}}}},"/api/v2/products/{parent_product_id}/variants/resync":{"post":{"tags":["products V2 BETA"],"summary":"Resync variants","operationId":"resyncVariants_api_v2_products_parent_product_id_variants_resync_post","parameters":[{"name":"parent_product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Restore the attributes at parent level of the variant with the value of the parent\n\nIt's necessary to send two list, one with the labels of the attributes and another with the ids of the variant products.\n\n| **field** | **Mandatory** | **Description** |\n| --- | --- | --- |\n| attribute_labels | yes | List of attribute labels to reset. These attributes must be at a parent level |\n| 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 |\n\nA 200 OK is returned upon success.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_labels":{"type":"array","items":{"type":"string"}},"variant_ids":{"type":"array","items":{"type":"string"}}}},"examples":{"default":{"value":{"attribute_labels":["attribute_label_1","attribute_label_2"],"variant_ids":["",""]}}}}}},"responses":{"200":{"description":"200 Ok"},"400":{"description":"400 Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"attribute_labels","msg":"attributes.attribute_at_variant_level not a parent attribute from family model"}],"msg":"You must only supply attributes from parent product when accessing this resource"}}}}}}}}}},"/api/v2/products/{product_id}":{"delete":{"tags":["products V2 BETA"],"summary":"Delete a product","operationId":"removesProductFromTheSystem_api_v2_products_product_id_delete","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Removes a product from the PIM\n\n**WARNING**: All variants linked to this product will be removed.\n\nIf there are any variants you do not want to delete, \nthey must be unlinked from the parent first, which will turn them into single products.\n\n204 code is returned upon success","responses":{"200":{"description":"204 No Content","content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"default":{"value":{}}}}}},"404":{"description":"404 Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":"No results found for 5c4ad0e1575fae0020dd7eef"}}}}}}}}},"get":{"tags":["products V2 BETA"],"summary":"Get a product","operationId":"getProductData_api_v2_products_product_id_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"$c0","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"created":{"type":"string"},"account_id":{"type":"string"},"assets":{"type":"array","items":{"type":"string"}},"attributes":{"type":"object","properties":{"boolean":{"type":"boolean"},"completeness":{"type":"number"},"date":{"type":"string"},"decimal":{"type":"number"},"integer":{"type":"integer"},"media_gallery":{"type":"array","items":{"type":"string"}},"media_single":{"type":"array","items":{"type":"string"}},"short_text":{"type":"string"},"url":{"type":"string"}}},"categories":{"type":"array","items":{"type":"string"}},"created_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}},"label":{"type":"string"},"mark_as_deleted":{"type":"boolean"},"modified":{"type":"string"},"modified_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_last_name":{"type":"string"},"user_name":{"type":"string"},"user_thumb":{"type":"string"},"username":{"type":"string"}}},"num_variations":{"type":"integer"},"overwritten_attributes":{"type":"array","items":{}},"product_level":{"type":"integer"},"relationships":{"type":"array","items":{"type":"object","properties":{"relationship_label":{"type":"string"},"relationship_id":{"type":"string"},"related_products":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"quantity":{"type":"integer"}}}}}}},"sku":{"type":"string"},"static_list_ids":{"type":"array","items":{}},"status":{"type":"string"},"thumbnail":{"type":"array","items":{"type":"string"}},"product_type":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"67348b7e2bbf7d289efd7984","created":"2024-11-13T11:20:30.578000","account_id":"5b30cfabe6eecf41df89a3a3","assets":["671b5ffcc0c8f0e5fd21b9b9","671918ceb301fed08f12f804","671918c4b301fed08f12f803"],"attributes":{"boolean":true,"completeness":71.43,"date":"2015-03-28","decimal":12.3,"integer":123,"media_gallery":["671b5ffcc0c8f0e5fd21b9b9","671918ceb301fed08f12f804"],"media_single":["671918c4b301fed08f12f803"],"short_text":"lorem ipsum","url":"http://acme.com"},"categories":["67191873b301fed08f12f7fb"],"created_user_audit":{"type":"API","user_email":"api","user_id":"67191ed7d6e8e300016f1414","user_name":"api"},"label":"Adventure mug","mark_as_deleted":false,"modified":"2024-11-13T12:12:20.698000","modified_user_audit":{"type":"USER","user_email":"user@email.com","user_id":"5e678436cc9e97962c059bd7","user_last_name":"God","user_name":"The Owner","user_thumb":"https://static.plytix.com/template/3.14.0/img/user-default-image.png","username":"5e678436cc9e97962c059bd7"},"num_variations":0,"overwritten_attributes":[],"product_level":0,"relationships":[{"relationship_label":"related_to","relationship_id":"6372284da99fdeceabff05ba","related_products":[{"product_id":"669fdaed59cf441db9df928b","quantity":1},{"product_id":"669fdaed59cf441db9df928d","quantity":1}]},{"relationship_label":"matching_products","relationship_id":"6372284da99fdeceabff05b9","related_products":[{"product_id":"669fdaf12a51570ff89b343a","quantity":1},{"product_id":"669fdaf12a51570ff89b3438","quantity":1},{"product_id":"669fdaf12a51570ff89b3436","quantity":1},{"product_id":"669fdaf12a51570ff89b3434","quantity":1},{"product_id":"669fdaf12a51570ff89b3432","quantity":1},{"product_id":"669fdaf12a51570ff89b3430","quantity":1}]}],"sku":"red adventure mug S02223","static_list_ids":[],"status":"Draft","thumbnail":["671b5ffcc0c8f0e5fd21b9b9"],"product_type":"SINGLE"}]}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 5c4ec5afb3bfd10001e45603"}}}}}}}}},"patch":{"tags":["products V2 BETA"],"summary":"Update a product","operationId":"modifySelectedAttributesOfAProduct_api_v2_products_product_id_patch","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Modifies attributes from product, leaving the rest unchanged. It will return the id of the product updated.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"object","properties":{"color_create_a_multiselect_type_attribute":{"type":"array","items":{"type":"string"}},"description_create_a_rich_text_type_attribute":{"type":"string"},"price_create_a_decimal_number_type_attribute":{"type":["string","null"]}}},"label":{"type":"string"},"status":{"type":"string"}}},"examples":{"default":{"value":{"attributes":{"color_create_a_multiselect_type_attribute":["Blue"],"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.","price_create_a_decimal_number_type_attribute":null},"label":"Product ~ 1 - patch example","status":"Completed"}}}}}},"responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"created":{"type":"string"},"modified":{"type":"string"},"created_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}},"modified_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"data":[{"id":"5c4ed8002f0985001e233275","created":"2019-01-28T10:22:56.817000+00:00","modified":"2019-01-28T10:24:44.792000+00:00","created_user_audit":{"type":"API","user_email":"api","user_id":"67191ed7d6e8e300016f1414","user_name":"api"},"modified_user_audit":{"type":"API","user_email":"api","user_id":"67191ed7d6e8e300016f1414","user_name":"api"}}]}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 5c4ed8002f0985001e233279"}}}}}}},"422":{"description":"422 Unprocessable entity","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"color_create_a_multiselect_type_attribute","msg":"[u'Red'] are not a valid values for Color (Create a multiselect type attribute) attribute."}],"msg":"product data validation failed"}}}}}}}}}},"/api/v2/products/{product_id}/assets":{"get":{"tags":["products V2 BETA"],"summary":"List a product's assets","operationId":"getProductSRelatedAssets_api_v2_products_product_id_assets_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Get all assets related to this product","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string"},"file_size":{"type":"integer"},"id":{"type":"string"},"thumbnail":{"type":"string"},"url":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"filename":"demo.png","file_size":39403,"id":"5bfac7d851e7590001486761","thumbnail":"https://files.plytix.com/api/v1.1/thumb/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/demo.png","url":"https://files.plytix.com/api/v1.1/file/public_files/pim/assets/d1/6d/8e/5b/5b8e6dd17f7f46000c7e9629/images/d8/c7/fa/5b/5bfac7d851e7590001486761/demo.png"}]}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"No product found for id 671a315ac5f822881dbe6ab1"}}}}}}}}},"post":{"tags":["products V2 BETA"],"summary":"Link an asset to a product","operationId":"linkAnExistingAssetToAProductMediaAttribute_api_v2_products_product_id_assets_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"$c1","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"attribute_label":{"type":"string"}}},"examples":{"default":{"value":{"id":"5c4ed8002f0985001e233275","attribute_label":"dummy_media_attribute"}}}}}},"responses":{"201":{"description":"201 Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"id":"5c4ed8002f0985001e233275"}]}}}}}},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset.id","msg":"asset does not exist"}],"msg":"Asset id 5c4ed8002f0985001e233275 does not exist"}}}}}}},"409":{"description":"409 Asset already linked","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset.id","msg":"already linked"}],"msg":"Asset id 5c4ed8002f0985001e233276 is already linked to product attribute"}}}}}}},"422":{"description":"422 Asset id is not provided","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset.id","msg":"asset id not found in request"}],"msg":"you must supply an id"}}}}}}}}}},"/api/v2/products/{product_id}/assets/{asset_id}":{"delete":{"tags":["products V2 BETA"],"summary":"Unlink an asset from a product","operationId":"unbindAssetFromProduct_api_v2_products_product_id_assets_asset_id_delete","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"asset_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Removes relationship between a product and an asset. Asset is not deleted","responses":{"204":{"description":"204 Success"},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"asset_id","msg":"asset id 5c483ee8eb9139000154dd53 is not related to product id 5c4ad0e1575fae0020dd7dde"}],"msg":"asset id 5c483ee8eb9139000154dd53 is not related to product id 5c4ad0e1575fae0020dd7dde"}}}}}}}}}},"/api/v2/products/{product_id}/categories":{"get":{"tags":["products V2 BETA"],"summary":"List a product's categories","operationId":"getProductSRelatedCategories_api_v2_products_product_id_categories_get","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Get all categories related to this product","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}}}}}},"examples":{"default":{"value":{"data":[{"id":"5c4ed7f62f0985001c233276","name":"Ground Coffee","path":["Sample Categories","Coffee & Tea","Ground Coffee"]},{"id":"5c4ed7f62f0985001c233279","name":"Kettles & Teapots","path":["Sample Categories","Kettles & Teapots"]}]}}}}}},"404":{"description":"404 Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 5c4ed8002f0985001e233279"}}}}}}}}},"post":{"tags":["products V2 BETA"],"summary":"Link a category to a product","operationId":"linkAnExistingCategoryToProduct_api_v2_products_product_id_categories_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Link an existing category to this product.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}},"examples":{"default":{"value":{"id":"5c4ed7f62f0985001c233279"}}}}}},"responses":{"201":{"description":"201 Created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}}}}}},"examples":{"default":{"value":{"data":[{"id":"5c4ed7f62f0985001c233279","name":"Kettles & Teapots","path":["Sample Categories","Kettles & Teapots"]}]}}}}}},"404":{"description":"404 Product not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 5c4ed8002f0985001e233279"}}}}}}},"409":{"description":"409 Category already linked","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"category.id","msg":"already linked"}],"msg":"Category id 5c4ed7f62f0985001c233279 is already linked to product"}}}}}}},"422":{"description":"422 Category not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"category.id","msg":"does not exist"}],"msg":"Unknown category 5c4ed7f62f0985001c233288"}}}}}}}}}},"/api/v2/products/{product_id}/categories/{category_id}":{"delete":{"tags":["products V2 BETA"],"summary":"Unlink a category from a product","operationId":"unbindCategoryFromProduct_api_v2_products_product_id_categories_category_id_delete","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"category_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Removes relationship between a product and category. Category is not deleted","responses":{"204":{"description":"204 No content"},"404":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"msg":{"type":"string"}}}},"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"errors":[{"field":"id","msg":"product does not exist"}],"msg":" No results found for 6731f3686e1a5c30cfd3b7c3"}}}}}}}}}},"/api/v2/products/{product_id}/family":{"post":{"tags":["products V2 BETA"],"summary":"Assign a product family","operationId":"assignFamily_api_v2_products_product_id_family_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Assign family to a product. It will return the id of the product and the modification date.\n\n| **parameter** | **description** | **mandatory** |\n| --- | --- | --- |\n| product_family_id | id of the product family that is going to be assigned to the product | yes |\n\n# Important notes:\n\n- Changing product family might cause data loss\n \n- Product families cannot be assigned to Variant products\n \n- Changing the product family will change the same fields of the variants","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product_family_id":{"type":"string"}}},"examples":{"default":{"value":{"product_family_id":""}}}}}},"responses":{"200":{"description":"200 OK Assign family to a parent product","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"created":{"type":"string"},"modified":{"type":"string"},"created_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}},"modified_user_audit":{"type":"object","properties":{"type":{"type":"string"},"user_email":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}}}}}}}},"examples":{"default":{"value":{"data":[{"id":"641887f2d10eec81d978e10e","created":"2023-03-21T13:33:06.925000+00:00","modified":"2023-03-22T13:33:06.925000+00:00","created_user_audit":{"type":"API","user_email":"api","user_id":"67191ed7d6e8e300016f1414","user_name":"api"},"modified_user_audit":{"type":"API","user_email":"api","user_id":"67191ed7d6e8e300016f1414","user_name":"api"}}]}}}}}}}}},"/api/v2/products/{product_id}/relationships/{relationship_id}":{"post":{"tags":["products V2 BETA"],"summary":"Add products to a relationship","operationId":"assignProductsToRelationship_api_v2_products_product_id_relationships_relationship_id_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"relationship_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Assign products to an existing relationship\n\n**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.\n\nA 200 OK status code is returned upon success\n\n# Request format\n\nTo assing a product to any relationship, the id of the product to be related along with its quantity must be provided.\n\n| _field_ | _type_ | _description_ |\n| --- | --- | --- |\n| product_relationships | Array of objects | list with product and quantities |\n\nA _product_relationship_ object is defined by:\n\n| _field_ | _type_ | _description_ |\n| --- | --- | --- |\n| product_id | string | product identifier |\n| quantity | number | relationship quantity |","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product_relationships":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"integer"},"product_id":{"type":"string"}}}}}},"examples":{"default":{"value":{"product_relationships":[{"quantity":1,"product_id":"5d0baf07d4bf5513d190245f"},{"quantity":9,"product_id":"5d0baf07d4bf5513d1902460"},{"quantity":6,"product_id":"5d0baf07d4bf5513d1902461"},{"quantity":1,"product_id":"5d0baf07d4bf5513d1902462"}]}}}}}},"responses":{"200":{"description":"Assign products to a relationship"}}},"delete":{"tags":["products V2 BETA"],"summary":"Remove products from a relationship","operationId":"removeProductsFromARelationship_api_v2_products_product_id_relationships_relationship_id_delete","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"relationship_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Remove products from an existing relationship\n\n**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.\n\nA 204 No Content status code is returned upon success\n\n# Request format\n\nRequest format is a dictionary with \"product_relationships\" as key, and a list of relatiosnhips to unlik as value. \nIds that does not belong the relationship in that product will be ignored","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product_relationships":{"type":"array","items":{"type":"string"}}}},"examples":{"default":{"value":{"product_relationships":["671b9614919135f2b585e0z2","671b9614919135f2b585e0c3"]}}}}}},"responses":{"204":{"description":"Remove products from a relationship","content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"default":{"value":{}}}}}}}},"patch":{"tags":["products V2 BETA"],"summary":"Update related products","operationId":"modifyRelationshipAttributes_api_v2_products_product_id_relationships_relationship_id_patch","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"relationship_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Modify selected relationship attributes\n\nModify the quantity of the related products. \n \n**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. \n \nA 200 OK status code will be returned upon successful call\n\n# Request format\n\n| _field_ | _type_ | _description_ |\n| --- | --- | --- |\n| product_relationships | Array of objects | list with product and quantities |\n\nA _product_relationship_ object is defined by:\n\n| _field_ | _type_ | _description_ |\n| --- | --- | --- |\n| product_id | string | product identifier |\n| quantity | number | relationship quantity |","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product_relationships":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"integer"},"product_id":{"type":"string"}}}}}},"examples":{"default":{"value":{"product_relationships":[{"quantity":1,"product_id":"5d0baf07d4bf5513d190245f"},{"quantity":9,"product_id":"5d0baf07d4bf5513d1902460"},{"quantity":6,"product_id":"5d0baf07d4bf5513d1902461"},{"quantity":1,"product_id":"5d0baf07d4bf5513d1902462"}]}}}}}},"responses":{"200":{"description":"Modify association attributes"}}}},"/api/v2/products/{product_id}/variant/{variant_id}":{"post":{"tags":["products V2 BETA"],"summary":"Link a variant to a product","operationId":"linkVariantToAProduct_api_v2_products_product_id_variant_variant_id_post","parameters":[{"name":"product_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"variant_id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Link an existing product as a variant of another product\n\n**variant_id** will become a Variant of **product_id**\n\n- Product can be a Single product or a Parent product\n \n- Variant must be a Single product\n \n\nBoth product and variant must belong to the same Family or be Unassigned.\n\nIt will return a 204 NO CONTENT upon success.\n\n**⚠️ The result of this operation may cause data loss**","responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"default":{"value":{}}}}}},"422":{"description":"422 Parent and Variant do not belong to the same family","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"msg":{"type":"string"}}}}},"examples":{"default":{"value":{"error":{"msg":"Parent and variants must be assigned to the same family"}}}}}}}}}},"/auth/api/get-token":{"post":{"tags":["authentication"],"summary":"Get an access token","operationId":"retrievesAnAuthenticationToken_auth_api_get_token_post","description":"$c2","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"api_key":{"type":"string"},"api_password":{"type":"string"}},"required":["api_key","api_password"]},"examples":{"default":{"value":{"api_key":"your.api.key","api_password":"your.secret.api.password"}}}}}},"responses":{"200":{"description":"200 OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"access_token":{"type":"string"}}}}}},"examples":{"default":{"value":{"data":[{"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"}]}}}}}},"401":{"description":"401 Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"}}},"examples":{"default":{"value":{"msg":"Bad api_key or api_password"}}}}}}},"security":[],"servers":[{"url":"https://auth.plytix.com"}]}}}}},"proxyUrl":"$undefined"}}]]]}]]}]

Get a product family

Authorization

Path Parameters

Response Body

200