Update a product

PATCH

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

PATCH

/v3/products/:id

$ curl -X PATCH https://integrators.prod.api.tabsplatform.com/v3/products/123e4567-e89b-12d3-a456-426614174000 \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "payload": {
3     "id": "123e4567-e89b-12d3-a456-426614174000",
4     "manufacturerId": "987f6543-e21b-45d3-b789-123456789abc",
5     "name": "Enterprise License",
6     "displayName": "Enterprise License",
7     "status": "ACTIVE",
8     "createdAt": "2023-01-01T00:00:00.000Z",
9     "updatedAt": "2024-05-20T15:45:00.000Z",
10     "description": "Full access license for enterprise users including premium support and updates.",
11     "integrationItemId": "INT-456789",
12     "integrationItemName": "Enterprise License Item",
13     "erpClassId": "ERP-12345",
14     "erpClassName": "Software Licenses"
15   },
16   "success": true,
17   "message": "Product updated successfully",
18   "error": {
19     "code": 0,
20     "message": "",
21     "details": {}
22   }
23 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Product ID

Request

This endpoint expects an object.

namestringOptional

Internal catalog name of the product

displayNamestringOptional

Customer-facing display name of the product

statusenumOptional

Product status (active or inactive)

descriptionstringOptional

Product description

integrationItemIdstringOptional

ERP integration item ID

erpClassIdstringOptional

ERP class ID

Response

Product updated 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