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": "string",
  "status": "ACTIVE"
}'

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "manufacturerId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Enterprise License",
    "displayName": "Enterprise License",
    "status": "ACTIVE",
    "arrDefault": "UNSPECIFIED",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "description": "string",
    "integrationItemId": "string",
    "integrationItemName": "string",
    "erpClassId": "string",
    "erpClassName": "string"
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "errorCode": "string",
    "details": {}
  }
}

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)

Allowed values:

displayNamestringOptional

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

arrDefaultenumOptional

ARR treatment a new billing term inherits when created against this product. Defaults to UNSPECIFIED (no product-level default) when omitted.

Allowed values:

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

errorobjectOptional

json element with any error messages or warnings

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error