Feed APIs

It is common for product feeds to have products with multiple variants.

To add a variant to a product that already has variants and an existing uniqueId:

{
    "feed": {
        "catalog": {
            "add": {
                "items": [{
                    "uniqueId": "ffff78ac",
                    "title": "Acme Jumper Suit",
                    "description": "The perfect casual wear for an evening out",
                    "color": "Orange",
                    "variants": [{
                            "var_description": "The jumper suit for the party animal in you",
                            "variantId": "GOR00302",
                            "var_price": 400,
                            "color": "Dark Red"
                        },

                        {
                            "var_description": "The jumper suit when you don't want to blend in",
                            "variantId": "GOR00302",
                            "var_price": 400,
                            "color": "Purple"
                        }
                    ]
                }]
            }
        }
    }
}

As in the code above, the ‘Add’ block allows you to pass a new variant along with all other variants and other product fields.

There are two scenarios when syncing latest changes/additions to variants using the Add action.

Scenario 1

When performing a delta upload, you can use the ‘Add’ action to add new variants to existing products as well as updating the rest of the variants.

To do this, ensure that all variants are a part of the ‘Add’ block within the base product.

For example, let’s assume an existing product in your catalog ‘Acme Party Shirt’ has 2 different variants (colors) and you want to add 1 new variant (colors) to the catalog. You can use the ‘Add’ block to add the new variants to the base product along with the 2 existing variants. So as to achieve this, you would be required to perform an ‘Add’ action for all the 3 variants, as shown in the sample JSON below:

{
    "feed": {
        "catalog": {
            "add": {
                "items": [{
                        "uniqueId": "GDR1234",
                        "title": "Superman",
                        "variants": [{
                            "variantId": "child-1",
                            "vColor": [{
                                "id": "47587",
                                "value": "Red"
                            },{
                            "variantId": "child-2",
                            "vColor": [{
                                "id": "47587",
                                "value": "Blue"
                               }]
                        },

                       {
                            "variantId": "child-3",
                            "vColor": [{
                                "id": "49867",
                                "value": "Green"
                            }],
                            "vSize": "S",
                            "vPrice": 130
                        }

                    ]
                    },
                 ]
            }
        }
    }
}

Scenario 2

When performing a delta upload, you can use the ‘Add’ action to add a new product with variants.

For instance,

{
    "feed": {
        "catalog": {
            "add": {
                "items": [{
                    "uniqueId": "GDR1234",
                    "title": "Superman",
                    "variants": [{
                        "variantId": "child-1",
                        "vColor": [{
                            "id": "47587",
                            "value": "Red"
                        }]
                    }]
                }]
            }
        }
    }
}

Delete

Used when you want to delete products from your existing feed file.

To delete, mention the uniqueID of the product you want to delete.

{
    "feed": {
        "catalog": {
            "delete": {
                "items": [{
                    "uniqueId": "GDR1234"
                }]
            }
        }
    }
}

Update

Used when you want to update the values of an existing field in your existing Product Feed synced with Unbxd.

You cannot update the field names or add/delete fields.

To update, upload the snapshot of the uniqueIDs of only those products along with the fields whose values need to be changed.

Generally, this action is used for updating the quantity or availability of a product.

Scenario 1

When performing a delta upload, you can use the ‘Update’ action to update only a few variants of a product, you can update the changes in the update block of that variant.

For example, let’s consider you have a Product ‘Acme Party Shirt’ with three variants [variantId1, variantId11, variantId12] and another Product ‘Lucus Casual Shirts’ with the three variants [variantId2, variantId21, variantId22]. If you want to update only variantId1, variantId11 & variantId2, you can include only these three variants when the variantIds are unique as in the JSON below.

{
 	"feed": {
 		"catalog": {
 			"update": {
 				"items": [{
 						"uniqueId": "uniqueId1",
 						"variants": [{
 								"variantId": "variantId1",
 								"inventoryCount": 10
 							},
 							{
 								"variantId": "variantId11",
 								"inventoryCount": 15
 							}
 						]
 					},
 					{
 						"uniqueId": "unqiueId2",
 						"variants": [{
 							"variantId": "variantId2",
 							"inventoryCount": 12
 						}]
 					}
 				]
 			}
 		}
 	}
 }