Infobip
Infobip Catalogs API

Create and manage your catalogs to use with other Infobip solutions. Catalogs are similar to databases, you can store and retrieve data sets. Concepts explained Catalog - a set of records. Each record can be for a product or service. Item - a record within a catalog. An item could be a product or service. — 7 operation path(s) and 0 webhook(s) in Infobip's published OpenAPI.
Documentation GitHub OpenAPI
OpenAPI Specification

{
 "openapi":"3.1.0",
 "info":{
  "title":"Infobip OpenAPI Specification",
  "description":"OpenAPI Specification that contains all public endpoints and webhooks.",
  "contact":{
   "name":"Infobip support",
   "email":"support@infobip.com"
  },
  "version":"3.210.0",
  "x-generatedAt":"2026-07-23T15:23:55.164948913Z"
 },
 "tags":[
  {
   "name":"platform",
   "description":"Modular tools to scale and automate your business.\n",
   "x-type":"category",
   "x-displayName":"Platform"
  },
  {
   "name":"catalogs-api",
   "description":"Create and manage your catalogs to use with other Infobip solutions. Catalogs are similar to databases, you can store and retrieve data sets. \n\nConcepts explained\n* __Catalog__ -  a set of records. Each record can be for a product or service. \n* __Item__ - a record within a catalog. An item could be a product or service. \n* __Field__ - define the data structure for the items in the catalog.\n",
   "x-type":"product",
   "x-displayName":"Catalogs"
  },
  {
   "name":"catalogs",
   "description":"",
   "x-type":"section",
   "x-displayName":"Catalogs"
  },
  {
   "name":"fields",
   "description":"",
   "x-type":"section",
   "x-displayName":"Catalog Fields"
  },
  {
   "name":"items",
   "description":"",
   "x-type":"section",
   "x-displayName":"Catalog Items"
  }
 ],
 "paths":{
  "/catalogs/1/catalogs":{
   "get":{
    "tags":[
     "platform",
     "catalogs-api",
     "catalogs"
    ],
    "summary":"Get catalogs",
    "description":"Use this method to get a list of catalogs with pagination. Query parameters are optional and can be used to narrow down the results.",
    "operationId":"get-catalogs",
    "parameters":[
     {
      "name":"ids",
      "in":"query",
      "description":"Catalog IDs.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"array",
       "items":{
        "type":"integer",
        "format":"int64"
       }
      },
      "example":"1,2,3,4,5"
     },
     {
      "name":"name",
      "in":"query",
      "description":"Catalog name.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"Catalog name"
     },
     {
      "name":"type",
      "in":"query",
      "description":"Catalog type.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"blank"
     },
     {
      "name":"page",
      "in":"query",
      "description":"Results page to retrieve (0..N).",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":0,
       "minimum":0
      }
     },
     {
      "name":"size",
      "in":"query",
      "description":"Number of catalogs per page.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32",
       "default":10,
       "maximum":100,
       "minimum":1
      }
     }
    ],
    "responses":{
     "200":{
      "description":"Successful Response",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.PageResponseDto"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "results":[
            {
             "id":10061,
             "name":"Catalog-534",
             "description":"desc",
             "type":"BLANK"
            },
            {
             "id":10062,
             "name":"Catalog-535",
             "description":"desc",
             "type":"BLANK"
            }
           ],
           "paging":{
            "page":1,
            "size":20,
            "totalPages":1,
            "totalResults":2
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <results>\n            \n    <id>10061</id>\n            \n    <name>Catalog-534</name>\n            \n    <description>desc</description>\n            \n    <type>BLANK</type>\n        \n  </results>\n      \n  <results>\n            \n    <id>10062</id>\n            \n    <name>Catalog-535</name>\n            \n    <description>desc</description>\n            \n    <type>BLANK</type>\n        \n  </results>\n      \n  <paging>\n            \n    <page>1</page>\n            \n    <size>20</size>\n            \n    <totalPages>1</totalPages>\n            \n    <totalResults>2</totalResults>\n        \n  </paging>\n  \n</root>\n"
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Catalog is not found"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "catalogs:read",
     "catalogs:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "post":{
    "tags":[
     "platform",
     "catalogs-api",
     "catalogs"
    ],
    "summary":"Create catalog",
    "description":"Use this method to create a catalog.",
    "operationId":"create-catalog",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogDto"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"Successful Response",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogDto"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "id":10000,
           "name":"Blank catalog",
           "description":"Example of the simple Catalog",
           "type":"BLANK"
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <id>10000</id>\n      \n  <name>Blank catalog</name>\n      \n  <description>Example of the simple Catalog</description>\n      \n  <type>BLANK</type>\n  \n</root>\n"
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "catalogs:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/catalogs/1/catalogs/{id}":{
   "get":{
    "tags":[
     "platform",
     "catalogs-api",
     "catalogs"
    ],
    "summary":"Get catalog",
    "description":"Use this method to get a specific catalog.",
    "operationId":"get-catalog",
    "parameters":[
     {
      "name":"id",
      "in":"path",
      "description":"Catalog id.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"integer",
       "format":"int64"
      },
      "example":10000
     }
    ],
    "responses":{
     "200":{
      "description":"Successful Response",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogDto"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "id":10000,
           "name":"Blank catalog",
           "description":"Example of the simple Catalog",
           "type":"BLANK"
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <id>10000</id>\n      \n  <name>Blank catalog</name>\n      \n  <description>Example of the simple Catalog</description>\n      \n  <type>BLANK</type>\n  \n</root>\n"
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Catalog is not found"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "catalogs:read",
     "catalogs:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "delete":{
    "tags":[
     "platform",
     "catalogs-api",
     "catalogs"
    ],
    "summary":"Delete catalog",
    "description":"Use this method to delete a catalog.",
    "operationId":"delete-catalog",
    "parameters":[
     {
      "name":"id",
      "in":"path",
      "description":"Catalog id.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"integer",
       "format":"int64"
      },
      "example":10000
     }
    ],
    "responses":{
     "200":{
      "description":"Successful Response",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CountResponse"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "count":3
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <count>3</count>\n  \n</root>\n"
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Catalog is not found"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "catalogs:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "patch":{
    "tags":[
     "platform",
     "catalogs-api",
     "catalogs"
    ],
    "summary":"Update catalog",
    "description":"Use this method to overwrite a catalog with the data passed in the request body.\nNew values replace the existing values from the catalog. If no value is passed in the request,\nthe parameter keeps its value.",
    "operationId":"update-catalog",
    "parameters":[
     {
      "name":"id",
      "in":"path",
      "description":"Catalog id.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"integer",
       "format":"int64"
      },
      "example":10000
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogDto"
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"Successful Response",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogDto"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "id":10000,
           "name":"Blank catalog",
           "description":"Example of the simple Catalog",
           "type":"BLANK"
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "id":10000,
           "name":"Blank catalog",
           "description":"Example of the simple Catalog",
           "type":"BLANK"
          }
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Catalog is not found"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "catalogs:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   }
  },
  "/catalogs/1/catalogs/{catalogId}/fields":{
   "get":{
    "tags":[
     "platform",
     "catalogs-api",
     "fields"
    ],
    "summary":"Get fields",
    "description":"Use this method to get a list of fields for a specific catalog.",
    "operationId":"get-catalog-fields",
    "parameters":[
     {
      "name":"catalogId",
      "in":"path",
      "description":"Catalog id.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"integer",
       "format":"int64"
      }
     }
    ],
    "responses":{
     "200":{
      "description":"Successful Response",
      "content":{
       "application/json":{
        "schema":{
         "type":"array",
         "items":{
          "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDto"
         }
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":[
           {
            "id":"8b00a8c6-5302-4fd0-a0cc-bb090b28ac34",
            "name":"Catalog field #1",
            "dataType":"TEXT",
            "isPredefined":false
           },
           {
            "id":"17ceebe0-1900-479f-9432-7865a6c686b6",
            "name":"Catalog field #2",
            "dataType":"BOOLEAN",
            "isPredefined":false
           }
          ]
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <fields>\n            \n    <id>8b00a8c6-5302-4fd0-a0cc-bb090b28ac34</id>\n            \n    <name>Catalog field #1</name>\n            \n    <dataType>TEXT</dataType>\n            \n    <isPredefined>false</isPredefined>\n        \n  </fields>\n      \n  <fields>\n            \n    <id>17ceebe0-1900-479f-9432-7865a6c686b6</id>\n            \n    <name>Catalog field #2</name>\n            \n    <dataType>BOOLEAN</dataType>\n            \n    <isPredefined>false</isPredefined>\n        \n  </fields>\n  \n</root>\n"
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"NOT_FOUND",
             "text":"Catalog is not found"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     }
    },
    "security":[
     {
      "IBSSOTokenHeader":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "Basic":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "catalogs:manage",
     "catalogs:read"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "post":{
    "tags":[
     "platform",
     "catalogs-api",
     "fields"
    ],
    "summary":"Create fields",
    "description":"Use this method to add catalog fields to a specific catalog.<br><br>\n<strong>NOTE</strong><br><ul><li>Maximum of <code>100</code> catalog fields are allowed.</li></ul>",
    "operationId":"create-catalog-fields",
    "parameters":[
     {
      "name":"catalogId",
      "in":"path",
      "description":"Catalog id.",
      "required":true,
      "style":"simple",
      "explode":false,
      "schema":{
       "type":"integer",
       "format":"int64"
      },
      "example":10000
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "type":"array",
        "items":{
         "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogFieldDto"
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"Successful Response",
      "content":{
       "application/json":{
        "schema":{
         "type":"array",
         "items":{
          "$ref":"#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDto"
         }
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":[
           {
            "id":"8b00a8c6-5302-4fd0-a0cc-bb090b28ac34",
            "name":"Catalog field #1",
            "dataType":"TEXT",
            "isPredefined":false
           },
           {
            "id":"17ceebe0-1900-479f-9432-7865a6c686b6",
            "name":"Catalog field #2",
            "dataType":"BOOLEAN",
            "isPredefined":false
           }
          ]
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <fields>\n            \n    <id>8b00a8c6-5302-4fd0-a0cc-bb090b28ac34</id>\n            \n    <name>Catalog field #1</name>\n            \n    <dataType>TEXT</dataType>\n            \n    <isPredefined>false</isPredefined>\n        \n  </fields>\n      \n  <fields>\n            \n    <id>17ceebe0-1900-479f-9432-7865a6c686b6</id>\n            \n    <name>Catalog field #2</name>\n            \n    <dataType>BOOLEAN</dataType>\n            \n    <isPredefined>false</isPredefined>\n        \n  </fields>\n  \n</root>\n"
         }
        }
       }
      }
     },
     "400":{
      "description":"Bad Request",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException"
        },
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":{
           "requestError":{
            "serviceException":{
             "messageId":"BAD_REQUEST",
             "text":"Bad request"
            }
           }
          }
         }
        }
       },
       "application/xml":{
        "examples":{
         "Response example":{
          "summary":"Response example",
          "value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "404":{
      "description":"Not Found",
   

# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-catalogs-api-openapi.json
Infobip Catalogs API

Documentation

Specifications

Other Resources

OpenAPI Specification
