Sync product details such as name, image, price, and category.

To send catalog information, it is necessary to provide the basic information of a product. The fields may be mandatory or optional in this operation.

Learn more about each field on POST Synchronize product information.

Product Insertion and Update in the Catalog

To update the basic product data, the following endpoint must be used:

🚧 Batch Insert / Update

For each batch insert/update, a maximum of 500 objects per request and 3 simultaneous requests are allowed.

Therefore, for an initial load with the entire product base, this limit must be taken into account when sending data.

Request

Processing will be performed asynchronously.


_29POST https://api-retail-media.newtail.com.br/product/bulk/products HTTP/1.1
_29accept: application/json
_29content-type: application/json
_29x-app-id: <PUBLISHER_APP_ID>
_29x-api-key: <API_KEY>
_29
_29[
_29    {
_29    "product_sku": "sample-120210",
_29    "name": "TechBrand Laptop Model X-15 4GB 256GB SSD 15.6\" Display Windows 11 - Gray",
_29    "url": "https://www.example.com/product/4100903080",
_29    "image_url": "https://images.example.com/products/01/00/img/4100903/1/4100903143_1GG.jpg",
_29    "categories": ["Computers", "Laptops"],
_29    "brand": "TechBrand",
_29    "gtins": ["7898915633481"],
_29    "metadata": {
_29        "key": "value1"
_29    }
_29  },
_29  {
_29    "product_sku": "sample-120211", 
_29    "name": "TechBrand Laptop Model X-15 4GB 256GB SSD 15.6\" Display Windows 11 - Gray",
_29    "url": "https://www.example.com/product/4100903080",
_29    "categories": ["Computers", "Laptops"],
_29    "brand": "TechBrand",
_29    "gtins": ["7898915633481"],
_29    "tags": ["Mega Maio"]
_29  }
_29]

Response

A successful response will have HTTP code 202.


_10{
_10 "messages": [
_10  "products will be processed soon"
_10 ]
_10}

Response with Validation Error

For validations, we use the format defined by RFC 8927, as exemplified below.

A failed response will have HTTP code 422.


_44[
_44  {
_44    "instancePath": "/0",
_44    "schemaPath": "#/items/required",
_44    "keyword": "required",
_44    "params": { "missingProperty": "product_sku" },
_44    "message": "must have required property 'product_sku'"
_44  },
_44  {
_44    "instancePath": "/0",
_44    "schemaPath": "#/items/required",
_44    "keyword": "required",
_44    "params": { "missingProperty": "url" },
_44    "message": "must have required property 'url'"
_44  },
_44  {
_44    "instancePath": "/0",
_44    "schemaPath": "#/items/required",
_44    "keyword": "required",
_44    "params": { "missingProperty": "image_url" },
_44    "message": "must have required property 'image_url'"
_44  },
_44  {
_44    "instancePath": "/1",
_44    "schemaPath": "#/items/required",
_44    "keyword": "required",
_44    "params": { "missingProperty": "name" },
_44    "message": "must have required property 'name'"
_44  },
_44  {
_44    "instancePath": "/1",
_44    "schemaPath": "#/items/required",
_44    "keyword": "required",
_44    "params": { "missingProperty": "url" },
_44    "message": "must have required property 'url'"
_44  },
_44  {
_44    "instancePath": "/1",
_44    "schemaPath": "#/items/required",
_44    "keyword": "required",
_44    "params": { "missingProperty": "image_url" },
_44    "message": "must have required property 'image_url'"
_44  }
_44]