Create Item

post

Body

application/jsontext/jsonapplication/*+json

productall ofRequired

namestringOptional

descriptionstringOptional

externalIdsall ofRequired

groupall ofRequired

unitall ofRequired

termsall ofRequired

quantityNotApplicablebooleanOptional

Responses

201

Created

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

post

HTTPcURLJavaScriptPython

POST /public/v1/catalog/items HTTP/1.1
Host: api.s1.today
Content-Type: application/json
Accept: */*
Content-Length: 287

{
  "product": {
    "id": "text"
  },
  "name": "text",
  "description": "text",
  "externalIds": {
    "vendor": "text",
    "operations": "text"
  },
  "group": {
    "id": "text"
  },
  "unit": {
    "id": "text"
  },
  "terms": {
    "model": "one-time",
    "period": "1m",
    "commitment": "1m"
  },
  "quantityNotApplicable": true,
  "parameters": [
    {
      "id": "text",
      "value": null
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-08-09T14:52:19.479Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-08-09T14:52:19.479Z",
      "by": "[Circular Reference]"
    },
    "pending": {
      "at": "2025-08-09T14:52:19.479Z",
      "by": "[Circular Reference]"
    },
    "published": {
      "at": "2025-08-09T14:52:19.479Z",
      "by": "[Circular Reference]"
    },
    "unpublished": {
      "at": "2025-08-09T14:52:19.479Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "description": "text",
  "externalIds": {
    "vendor": "text",
    "operations": "text"
  },
  "group": {
    "id": "text",
    "name": "text"
  },
  "unit": {
    "id": "text",
    "description": "text",
    "name": "text"
  },
  "terms": {
    "period": "1m",
    "commitment": "1m"
  },
  "quantityNotApplicable": true,
  "status": "text",
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "parameters": [
    {
      "id": "text",
      "externalId": "text",
      "type": "text",
      "name": "text",
      "value": null,
      "displayValue": "text"
    }
  ]
}