Qubiqle catalog API
The catalog API from Qubiqle — 12 operation(s) for catalog.
Qubiqle catalog API is one of 9 APIs that Qubiqle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include catalog. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 16 operations across 12 paths, and defines 52 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.ottimate.com/v1, https://sandbox-api.ottimate.com/v1.
16 operations
12 paths
52 schemas
7 GET2 PATCH7 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Qubiqle catalog API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (OAuth2).
OAuth2— OAuth2 authentication flows. Auth server URLs will vary by environment
Paths & Operations 16
Across 12 paths, the API surfaces 16 operations — 7 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.
catalog 16
GET
/catalog/entries
List catalog entries
POST
/catalog/entries
Create a catalog entry
GET
/catalog/entries/{id}
Retrieve a catalog entry
PATCH
/catalog/entries/{id}
Update a catalog entry
GET
/catalog/allowances
List catalog allowances
POST
/catalog/allowances
Create a catalog allowance
PATCH
/catalog/allowances/{id}
Update a catalog allowance
GET
/catalog/variances
List catalog variances
POST
/catalog/entries/bulk
Bulk create/update catalog entries (async)
POST
/catalog/allowances/bulk
Bulk create/update catalog allowances (async)
POST
/catalog/prices/bulk
Bulk create catalog prices (async)
GET
/catalog/variances/{id}/invoice-items
Get invoice items for a catalog entry
GET
/catalog/variance-batches
List exported catalog variance batches
POST
/catalog/variance-batches/{id}/export
Export a catalog variance batch (local only)
GET
/catalog/prices
List catalog prices
POST
/catalog/prices
Create a catalog price
Schemas 52
The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are CatalogEntryObject (28 properties), CatalogEntryListResponseResultsItems (23 properties), CatalogAllowanceObject (18 properties), CatalogAllowanceListResponseResultsItems (18 properties). Each schema is shown below with its type and property counts.
CatalogEntryObjectDimensions
object
Resolved dimensions keyed by uppercase dimension type (e.g. DEPARTMENT, SUBDEPARTMENT, CATEGORY, SUBCATEGORY, PROJECT, CLASS). Each value is the dimension name…
CatalogPricesBulkAsyncResponseSummary
object
Summary of the submitted request
1 property
CatalogAllowanceObjectTargetType
string
Human-readable target type
CatalogEntriesPostRequestBodyContentApplicationJsonSchemaAllowancesItems
object
10 properties
2 required
CatalogAllowanceListResponseResultsItemsTargetType
string
Human-readable target type
InvoiceItemVarianceListResponseResultsItems
object
8 properties
6 required
CatalogEntriesPostRequestBodyContentApplicationJsonSchemaPricesItems
object
9 properties
1 required
CatalogEntriesPostRequestBodyContentApplicationJsonSchema
object
Additional custom properties as key-value pairs
CatalogAllowanceListResponseResultsItems
object
Catalog allowance object for standalone list endpoint
18 properties
7 required
CatalogPricesPostRequestBodyContentApplicationJsonSchemaPriceType
string
Price type: company (default), locationgroup, or location
CatalogAllowancesIdPatchRequestBodyContentApplicationJsonSchemaAllowanceType
string
Type of allowance
CatalogAllowancesBulkAsyncResponse
object
Response returned immediately when a bulk allowances request is accepted for async processing.
6 properties
6 required
Catalog_get_catalog_prices_Response_200
object
Paginated list of catalog prices
4 properties
2 required
CatalogAllowanceObject
object
Catalog allowance object for standalone list endpoint
18 properties
7 required
CatalogVarianceBatchObjectExportStatus
string
Always 'exported' — non-exported batches are never returned by this API
CatalogVariancesGetParametersExceptionType
string
CatalogEntryListResponseResultsItems
object
Basic catalog entry object returned for list operations
23 properties
3 required
CatalogAllowanceObjectAllowanceType
string
Type of allowance
CatalogVarianceBatchObject
object
An exported Catalog Variance Manager batch.
7 properties
6 required
CatalogEntryObjectWarningsItems
object
1 property
CatalogItemPayload
object
Additional metadata from the catalog entry
CatalogEntriesBulkAsyncResponse
object
Response returned immediately when a bulk entries request is accepted for async processing.
6 properties
6 required
CatalogEntryObjectAllowancesItems
object
Catalog allowance object nested in catalog entry
17 properties
5 required
CatalogPriceItem
object
Catalog price object
16 properties
4 required
CatalogAllowancesBulkAsyncResponseSummary
object
Summary of the submitted request
1 property
CatalogEntryObject
object
Full catalog entry object returned for retrieve operations
28 properties
3 required
VarianceListResponseResultsItemsLastInvoiceItem
object
5 properties
3 required
CatalogPricesGetParametersPriceType
string
CatalogEntryObjectAllowancesItemsTargetType
string
Human-readable target type
CatalogEntriesPostRequestBodyContentApplicationJsonSchemaAllowancesItemsTarget
string
Allowance target: company (default), locationgroup, or location
CatalogEntriesIdPatchRequestBodyContentApplicationJsonSchema
object
Additional properties
CatalogEntryObjectAllowancesItemsAllowanceType
string
Type of allowance
CatalogEntryListResponse
object
4 properties
2 required
CatalogPriceItemPriceTypeDisplay
string
Human-readable price type
CostBatchPayload
object
Costbatch payload in the same shape as the Pyxis /costbatch endpoint.
6 properties
CatalogEntriesBulkAsyncResponseSummary
object
Summary of the submitted request
1 property
CatalogVarianceBatchListResponse
object
Paginated list of exported catalog variance batches.
4 properties
CatalogEntriesPostRequestBodyContentApplicationJsonSchemaPricesItemsData
object
Additional custom properties for this price
CatalogEntriesPostRequestBodyContentApplicationJsonSchemaPricesItemsPriceType
string
Price type: company (default), locationgroup, or location
CatalogPricesBulkAsyncResponse
object
Response returned immediately when a bulk prices request is accepted for async processing.
6 properties
6 required
InvoiceItemVarianceListResponse
object
Paginated list of invoice items with variance information
5 properties
2 required
VarianceListResponse
object
2 properties
2 required
ErrorResponse
object
4 properties
2 required
CatalogEntryObjectPricesItems
object
Catalog price object
16 properties
4 required
CatalogEntriesPostRequestBodyContentApplicationJsonSchemaAllowancesItemsData
object
Additional custom properties for this allowance
CatalogAllowancesPostRequestBodyContentApplicationJsonSchemaTarget
string
Allowance target: company (default), locationgroup, or location
CatalogAllowanceListResponseResultsItemsAllowanceType
string
Type of allowance
CatalogAllowancesPostRequestBodyContentApplicationJsonSchemaAllowanceType
string
Type of allowance (default: 'allowance')
VarianceListResponseResultsItems
object
7 properties
2 required
CatalogAllowancesIdPatchRequestBodyContentApplicationJsonSchemaTarget
string
Allowance target: company, locationgroup, or location
CatalogAllowanceListResponse
object
2 properties
2 required
CatalogEntryObjectPricesItemsPriceTypeDisplay
string
Human-readable price type
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qubiqle 8
Other APIs Qubiqle publishes across the network.
Qubiqle accounts API
Qubiqle batch API
Qubiqle dimensions API
Qubiqle invoices API
Qubiqle oauth API
Qubiqle purchaseOrders API
Qubiqle receipts API
Qubiqle vendors API
#catalog