Create product

Create a new product.

post

Body

multipart/form-data

iconstring · binaryOptional

Responses

201

Created

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

shortDescriptionstring · nullableOptional

longDescriptionstring · nullableOptional

websitestringOptional

statusstringOptional

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

post

/public/v1/catalog/products

HTTPcURLJavaScriptPython

POST /public/v1/catalog/products HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 111

{
  "product": {
    "Name": "text",
    "ShortDescription": "text",
    "LongDescription": "text",
    "Website": "text"
  },
  "icon": "binary"
}

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-05-17T09:00:05.411Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-05-17T09:00:05.411Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "published": {
      "at": "2026-05-17T09:00:05.411Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "pending": {
      "at": "2026-05-17T09:00:05.411Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "unpublished": {
      "at": "2026-05-17T09:00:05.411Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "shortDescription": "text",
  "longDescription": "text",
  "externalIds": {
    "operations": "text",
    "defaultErpItem": "text"
  },
  "website": "text",
  "status": "text",
  "vendor": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-05-17T09:00:05.411Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-05-17T09:00:05.411Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "settings": {
    "productOrdering": true,
    "productRequests": {
      "enabled": true,
      "name": "text",
      "label": "text"
    },
    "itemSelection": true,
    "orderQueueChanges": true,
    "preValidation": {
      "purchaseOrderDraft": true,
      "purchaseOrderQuerying": true,
      "changeOrderDraft": true,
      "configurationOrderDraft": true,
      "terminationOrder": true
    },
    "splitBilling": {
      "enabled": true,
      "type": "text"
    },
    "sendCostToErp": true,
    "subscriptionCessation": {
      "enabled": true,
      "mode": "Termination"
    }
  },
  "statistics": {
    "itemCount": 1,
    "ordersPlacedCount": 1,
    "agreementCount": 1,
    "subscriptionCount": 1
  }
}