New Product Families Version: API Migration Guide

The following endpoints will be deprecated soon. Follow this guide to make the necessary changes to keep all your integrations working if your team is using any of these.


GET - Get product's related variations

PF1 Endpoint (Previous)

API Documentation section

Description: Get all variations of this product.

Endpoint: https://pim.plytix.com/api/v1/products/:product_id/variations


PF2 Endpoint (Current)

API Documentation section

Description: Get all variants of this product.

Endpoint: https://pim.plytix.com/api/v1/products/:product_id/variants


Changes required

Changing the URL from “variations” to “variants.”

 


 

POST - Bind product as variation of another

PF1 Endpoint (Previous)

API Documentation section

Description: Convert a product into a variation of another product.

Endpoint: https://pim.plytix.com/api/v1/products/:product_id/variations/:variation_id


PF2 Endpoint (Current)

API Documentation section

Description: Link an existing product as a variant of another product

Endpoint: https://pim.plytix.com/api/v1/products/:product_id/variant/:variant_id


Changes required

Changing the URL from “variations” to “variant” (without ‘s’).

 


 

POST - Add a variation of a product

 

PF1 Endpoint (Previous)

API Documentation section

Description: Add a new variation to a product.

Endpoint: https://pim.plytix.com/api/v1/products/:product_id/variations

Payload:

 

Unset

{

    "sku": "new variation from API",

    "label": "new variation label",

    "attributes": {

        "price_create_a_decimal_number_type_attribute": 23.99

    }

}

 

PF2 Endpoint (Current)

API Documentation section

Description: Add a new product as a variant of another product.

Endpoint: https://pim.plytix.com/api/v1/products/:parent_product_id/variants

Payload:


{

"variant": {

    "sku": "new variation from API",

    "label": "new variation label",

    "attributes": {

         "price_create_a_decimal_number_type_attribute": 23.99

    

}

}

}

 

Changes required

Changing the URL from “variations” to “variants”.

Encapsulate new product data into the “variantkey.

 


 

DELETE - Unbind variation from parent product

PF1 Endpoint (Previous)

API Documentation section

Description: Removes the relationship between a variation and its parent. Variation becomes an independent product.

Endpoint: https://pim.plytix.com/api/v1/products/:product_id/variations/:variation_id


PF2 Endpoint (Current)

API Documentation section

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

Endpoint: https://pim.plytix.com/api/v1/products/:product_id/variant/:variant_id

Changes required

Changing the URL from “variations” to “variant” (without ‘s’).

 


 

PUT - Modify all attributes of a product

 

PF1 Endpoint (Previous)

API Documentation section

Method: PUT

Endpoint: https://pim.plytix.com/api/v1/products/:product_id

Description: Modifies attributes from product, resetting the rest to its default value.


Payload:


{

    "attributes": {

        "color_create_a_multiselect_type_attribute": [

            "Blue"

        ],

        "price_create_a_decimal_number_type_attribute": 23.99

    }

}

 

PF2 Endpoint (Current)

API Documentation section

Method: PATCH

Endpoint: https://pim.plytix.com/api/v1/products/:product_id

Description: Modifies attributes from product, leaving the rest unchanged.


Payload:


{

    "attributes": {

        "price_create_a_decimal_number_type_attribute": 23.99

    }

}

 

Changes required

Method changes from PUT to PATCH.

You don’t need to specify all the attributes now, only the ones you want to change.


 

Summary

 

Method

Deprecated URL

GET

https://pim.plytix.com/api/v1/products/:product_id/variations 

POST

https://pim.plytix.com/api/v1/products/:product_id/variations/:variation_id 

POST

https://pim.plytix.com/api/v1/products/:product_id/variations

PUT

https://pim.plytix.com/api/v1/products/:product_id

DELETE

https://pim.plytix.com/api/v1/products/:product_id/variations/:variation_id