Products

Create a new product

post/v3/products

Request

Base URL
https://integrators.prod.api.tabsplatform.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/tabsplatform/apis/tabs-external-api/docs/v3/products/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Internal catalog name of the product

displayNamestring

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

status'ACTIVE' | 'INACTIVE' required

Product status (active or inactive)

descriptionstring

Product description

integrationItemIdstring

ERP integration item ID

erpClassIdstring

ERP class ID

Example request

{
  "name": "string",
  "status": "ACTIVE"
}

Response

Product created successfully

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "manufacturerId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Enterprise License",
    "displayName": "Enterprise License",
    "status": "ACTIVE",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.