The list of supported fields for product update is the same as fields for Patch Product endpoint from OnVoard API.
When creating new product, the following fields are required:
- external_id
- name
- url
When updating existing product, OnVoard will only update provided fields. Below are supported fields for Product:
| Field | Type | Description |
| external_id | string | Unique identifier for Product in ecommerce platform. |
| name | string | Name of product. |
| url | string | URL to view product. |
| price | float | The price of the product. |
| compare_at_price | float | The original price before discount. |
| currency | string | The three-letter currency code (ISO 4217 format) for product's price. |
| image_url | string | Image URL for product. You can pass empty string to unset image. |
| group | string | Group ID for product. |
| tags[] | string array | List of tag names to assign product. For example: ["tag-1", "tag-2"]. Our system will automatically create new tag if name doesn't exist. |
Here's a sample payload. Keep in mind that payload must be a valid JSON object.
{
"url": "https://example.com/products/mani-moisture",
"price": 57.5,
"compare_at_price": 72.5,
"currency": "USD",
"image_url": "https://example.com/products/mani-moisture.jpg",
"group": null,
"tags": []
}