curl --request POST \
--url https://api.hubapi.com/crm-objects/v1/objects/products/batch-read
"\nExample POST URL (without properties):\nhttps://api.hubapi.com/crm-objects/v1/objects/products/batch-read\n\nExample POST JSON:\n{\n \"ids\": [\n 1645187,\n 1642796\n ]\n}\n\nExample Response:\n{\n \"1642796\": {\n \"objectType\": \"PRODUCT\",\n \"portalId\": 62515,\n \"objectId\": 1642796,\n \"properties\": {},\n \"version\": 1,\n \"isDeleted\": false\n },\n \"1645187\": {\n \"objectType\": \"PRODUCT\",\n \"portalId\": 62515,\n \"objectId\": 1645187,\n \"properties\": {},\n \"version\": 1,\n \"isDeleted\": false\n }\n}\n\n\nExample POST URL (with properties):\nhttps://api.hubapi.com/crm-objects/v1/objects/products/batch-read?properties=name&properties=description&price\n\nExample POST JSON:\n{\n \"ids\": [\n 1645187,\n 1642796\n ]\n}\n\nExample response:\n{\n \"1642796\": {\n \"objectType\": \"PRODUCT\",\n \"portalId\": 62515,\n \"objectId\": 1642796,\n \"properties\": {\n \"name\": {\n \"versions\": [\n {\n \"name\": \"name\",\n \"value\": \"A second new product\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceVid\": []\n }\n ],\n \"value\": \"A second new product\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceId\": null\n },\n \"description\": {\n \"versions\": [\n {\n \"name\": \"description\",\n \"value\": \"A description the second new product.\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceVid\": []\n }\n ],\n \"value\": \"A description the second new product.\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceId\": null\n }\n },\n \"version\": 1,\n \"isDeleted\": false\n },\n \"1645187\": {\n \"objectType\": \"PRODUCT\",\n \"portalId\": 62515,\n \"objectId\": 1645187,\n \"properties\": {\n \"name\": {\n \"versions\": [\n {\n \"name\": \"name\",\n \"value\": \"Another new product\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceVid\": []\n }\n ],\n \"value\": \"Another new product\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceId\": null\n },\n \"description\": {\n \"versions\": [\n {\n \"name\": \"description\",\n \"value\": \"A description of yet another product.\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceVid\": []\n }\n ],\n \"value\": \"A description of yet another product.\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceId\": null\n }\n },\n \"version\": 1,\n \"isDeleted\": false\n }\n}"
Create a group of products. Up to 100 products can be created in a single request. The request body will be an array, with each entry being a list of products properties you want to set for each new product. Please see the example for more details.
curl --request POST \
--url https://api.hubapi.com/crm-objects/v1/objects/products/batch-read
"\nExample POST URL (without properties):\nhttps://api.hubapi.com/crm-objects/v1/objects/products/batch-read\n\nExample POST JSON:\n{\n \"ids\": [\n 1645187,\n 1642796\n ]\n}\n\nExample Response:\n{\n \"1642796\": {\n \"objectType\": \"PRODUCT\",\n \"portalId\": 62515,\n \"objectId\": 1642796,\n \"properties\": {},\n \"version\": 1,\n \"isDeleted\": false\n },\n \"1645187\": {\n \"objectType\": \"PRODUCT\",\n \"portalId\": 62515,\n \"objectId\": 1645187,\n \"properties\": {},\n \"version\": 1,\n \"isDeleted\": false\n }\n}\n\n\nExample POST URL (with properties):\nhttps://api.hubapi.com/crm-objects/v1/objects/products/batch-read?properties=name&properties=description&price\n\nExample POST JSON:\n{\n \"ids\": [\n 1645187,\n 1642796\n ]\n}\n\nExample response:\n{\n \"1642796\": {\n \"objectType\": \"PRODUCT\",\n \"portalId\": 62515,\n \"objectId\": 1642796,\n \"properties\": {\n \"name\": {\n \"versions\": [\n {\n \"name\": \"name\",\n \"value\": \"A second new product\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceVid\": []\n }\n ],\n \"value\": \"A second new product\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceId\": null\n },\n \"description\": {\n \"versions\": [\n {\n \"name\": \"description\",\n \"value\": \"A description the second new product.\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceVid\": []\n }\n ],\n \"value\": \"A description the second new product.\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceId\": null\n }\n },\n \"version\": 1,\n \"isDeleted\": false\n },\n \"1645187\": {\n \"objectType\": \"PRODUCT\",\n \"portalId\": 62515,\n \"objectId\": 1645187,\n \"properties\": {\n \"name\": {\n \"versions\": [\n {\n \"name\": \"name\",\n \"value\": \"Another new product\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceVid\": []\n }\n ],\n \"value\": \"Another new product\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceId\": null\n },\n \"description\": {\n \"versions\": [\n {\n \"name\": \"description\",\n \"value\": \"A description of yet another product.\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceVid\": []\n }\n ],\n \"value\": \"A description of yet another product.\",\n \"timestamp\": 1525289943771,\n \"source\": \"API\",\n \"sourceId\": null\n }\n },\n \"version\": 1,\n \"isDeleted\": false\n }\n}"
Successful response - Create a group of products
The response is of type object
.
Was this page helpful?