Create a new product

POST

https://integrators.prod.api.tabsplatform.com/v3/products

POST

/v3/products

$ curl -X POST https://integrators.prod.api.tabsplatform.com/v3/products \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "ProMax Software Suite",
>   "status": "ACTIVE"
> }'

1 {
2   "payload": {
3     "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4     "manufacturerId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
5     "name": "ProMax Software Suite",
6     "displayName": "ProMax Software Suite",
7     "status": "ACTIVE",
8     "createdAt": "2024-05-10T09:15:00.000Z",
9     "updatedAt": "2024-05-10T09:15:00.000Z",
10     "description": "Comprehensive software package for enterprise resource planning.",
11     "integrationItemId": "INTG-456789",
12     "integrationItemName": "ProMax ERP Module",
13     "erpClassId": "ERP-12345",
14     "erpClassName": "Enterprise Software"
15   },
16   "success": true,
17   "message": "Product created successfully.",
18   "error": {
19     "code": 0,
20     "message": "",
21     "details": {}
22   }
23 }

Authentication

Authorizationstring

API Key authentication via header

Request

This endpoint expects an object.

namestringRequired

Internal catalog name of the product

statusenumRequired

Product status (active or inactive)

displayNamestringOptional

Customer-facing display name. If omitted, defaults to name.

descriptionstringOptional

Product description

integrationItemIdstringOptional

ERP integration item ID

erpClassIdstringOptional

ERP class ID

Response

Product created successfully

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error