Create a catalogue project

Creates the catalogue project that POST /ticket-model/from-catalogue takes as catalogueId. Either customerId or contactEmail is required.

POST/catalogue

Authorization

AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Request body

application/json

namestring

Catalogue name.

descriptionstring

Description.

customCatalogueIdstring

Custom catalogue id.

customerIdstring

Id of the customer. Alternative to contactEmail.

contactEmailstring

Email of an existing customer. Alternative to customerId.

cataloguePricingFlowstring

Pricing flow to apply to the catalogue.

additionalFilesobject

Downloadable files to attach, keyed by file name; each value is {url, headers}. An object, not an array.

thumbnailEndpointobject

Where the catalogue thumbnail is downloaded from.

Show properties

urlstring

Downloadable image URL.

headersobject

Headers sent with the download request.

customPropertiesobject

Custom properties of the catalogue.

Show properties

orderany[]

Property ids in display order.

valuesobjectrequired

Property values keyed by property id.

Responses

200

Created.

idinteger | stringrequired

Id of the created catalogue project — pass it to POST /ticket-model/from-catalogue.

Show properties

One of:

integer

integer

string

string

401

Authentication failed. All causes return this identical response.

codeinteger

messagestring

typestring

default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger

messagestring

typestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://next.amfg.ai/engine-service/public-api/v1/catalogue' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "customCatalogueId": "string",
  "customerId": "string",
  "contactEmail": "string",
  "cataloguePricingFlow": "string",
  "additionalFiles": {},
  "thumbnailEndpoint": {
    "url": "string",
    "headers": {}
  },
  "customProperties": {
    "order": [],
    "values": {}
  }
}'

const response = await fetch("https://next.amfg.ai/engine-service/public-api/v1/catalogue", {
  method: "POST",
  headers: {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"customCatalogueId\": \"string\",\n  \"customerId\": \"string\",\n  \"contactEmail\": \"string\",\n  \"cataloguePricingFlow\": \"string\",\n  \"additionalFiles\": {},\n  \"thumbnailEndpoint\": {\n    \"url\": \"string\",\n    \"headers\": {}\n  },\n  \"customProperties\": {\n    \"order\": [],\n    \"values\": {}\n  }\n}"
});

import requests

response = requests.post(
    "https://next.amfg.ai/engine-service/public-api/v1/catalogue",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"customCatalogueId\": \"string\",\n  \"customerId\": \"string\",\n  \"contactEmail\": \"string\",\n  \"cataloguePricingFlow\": \"string\",\n  \"additionalFiles\": {},\n  \"thumbnailEndpoint\": {\n    \"url\": \"string\",\n    \"headers\": {}\n  },\n  \"customProperties\": {\n    \"order\": [],\n    \"values\": {}\n  }\n}",
)

Response

{
  "id": 0
}

{
  "code": 401,
  "message": "Not Authorized"
}

{
  "code": 0,
  "message": "string",
  "type": "string"
}