Skip to main content

Adaptive Catalog API (1.0)

Download OpenAPI specification:Download

ImportExtensions

Run Extension Via Queue (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
apiKey
string or null
extensionId
string or null
organization
string or null
targetCatalog
string or null
callbackUrl
string or null
fileUrl
string or null
username
string or null
password
string or null
fileType
string or null
delimiter
string
quoteChar
string
zipped
boolean
zippedFile
string or null
createProducts
boolean
updateMetadata
boolean
normalizeManufacturerName
boolean
vendor
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.Extensions.ImportExtensionMapping)

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "apiKey": "string",
  • "extensionId": "string",
  • "organization": "string",
  • "targetCatalog": "string",
  • "callbackUrl": "string",
  • "fileUrl": "string",
  • "username": "string",
  • "password": "string",
  • "fileType": "string",
  • "delimiter": "string",
  • "quoteChar": "string",
  • "zipped": true,
  • "zippedFile": "string",
  • "createProducts": true,
  • "updateMetadata": true,
  • "normalizeManufacturerName": true,
  • "vendor": "string",
  • "mappings": [
    ]
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

ExportExtensions

Run Extension (v1.0)

path Parameters
id
required
string
query Parameters
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductReference)
workspace
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "error": "string",
  • "success": true,
  • "redirectUrl": "string",
  • "messageHeader": "string",
  • "message": "string",
  • "products": [
    ]
}

Run Extension Possible Matches (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductReference)
workspace
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "error": "string",
  • "success": true,
  • "products": [
    ]
}

Run Extension Options (v1.0)

path Parameters
id
required
string
field
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
search
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalData": {
    },
  • "search": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "error": "string",
  • "success": true,
  • "options": [
    ]
}

RealTimeExtensions

Run All Real Time Extensions (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductReference)
workspace
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "items": [
    ]
}

Run Real Time Extension (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductReference)
workspace
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "error": "string",
  • "success": true,
  • "items": [
    ]
}

RecommendationExtensions

Run Recommendation Extension (v1.0)

path Parameters
extension
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductReference)
workspace
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "error": "string",
  • "success": true,
  • "products": [
    ],
  • "matchedProducts": [
    ],
  • "possibleProducts": [
    ]
}

Upload Recommendation File (v1.0)

path Parameters
extension
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
file
string or null
fileName
string or null
type
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "file": "string",
  • "fileName": "string",
  • "type": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "url": "string"
}

InstalledExtensions

Get Installed Extensions (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
[
  • {
    }
]

Update Installed Extension (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
vendor
string or null
catalog
string or null
extensionLevel
string or null
extensionNickname
string or null
schedule
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.Extensions.ImportExtensionMapping)

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalData": {
    },
  • "vendor": "string",
  • "catalog": "string",
  • "extensionLevel": "string",
  • "extensionNickname": "string",
  • "schedule": "string",
  • "mappings": [
    ]
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Delete Installed Extension (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Disable Installed Extension (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Enable Installed Extension (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Extension Logs (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "items": [
    ]
}

AvailableExtensions

Get Available Extensions (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
[
  • {
    }
]

Get Extension (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "id": "string",
  • "category": "string",
  • "name": "string",
  • "description": "string",
  • "configUrl": "string",
  • "ready": true,
  • "statusMessage": "string",
  • "image": "string",
  • "hasValidation": true,
  • "allowAdHocItems": true,
  • "hasSampleLoad": true,
  • "additionalData": [
    ],
  • "mapToVendor": true
}

Validate Extension (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
vendor
string or null
catalog
string or null
extensionLevel
string or null
extensionNickname
string or null
schedule
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.Extensions.ImportExtensionMapping)

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalData": {
    },
  • "vendor": "string",
  • "catalog": "string",
  • "extensionLevel": "string",
  • "extensionNickname": "string",
  • "schedule": "string",
  • "mappings": [
    ]
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Import Sample (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
property name*
additional property
string

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalFields": {
    }
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "error": "string",
  • "success": true,
  • "columns": [
    ]
}

Install Extension (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
object or null
vendor
string or null
catalog
string or null
extensionLevel
string or null
extensionNickname
string or null
schedule
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.Extensions.ImportExtensionMapping)

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "additionalData": {
    },
  • "vendor": "string",
  • "catalog": "string",
  • "extensionLevel": "string",
  • "extensionNickname": "string",
  • "schedule": "string",
  • "mappings": [
    ]
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

KeyAuth

Generate API Key (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
name
string or null
keyType
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "name": "string",
  • "keyType": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "id": "string",
  • "success": true,
  • "error": "string",
  • "key": "string"
}

Get API Keys (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "keys": [
    ]
}

Disable API Key (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Enable API Key (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Delete API Key (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get SessionKey (v1.0)

query Parameters
sessionKey
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "expiration": "2019-08-24T14:15:22Z",
  • "isSubmittable": true
}

Search

Search (v1.0)

query Parameters
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
keywords
string or null
page
integer <int32>
pageSize
integer <int32>
inStock
boolean
lowPrice
number or null <double>
highPrice
number or null <double>
manufacturer
Array of strings or null
vendors
Array of strings or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.FilterCriteria)
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.FilterCriteria)
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.FilterCriteria)
segment
string or null
category
string or null
subCategory
string or null
checkRealtimeSelection
boolean or null
includeMetadata
boolean or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductFilter)

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "keywords": "string",
  • "page": 0,
  • "pageSize": 0,
  • "inStock": true,
  • "lowPrice": 0,
  • "highPrice": 0,
  • "manufacturer": [
    ],
  • "vendors": [
    ],
  • "must": [
    ],
  • "boost": [
    ],
  • "exclude": [
    ],
  • "segment": "string",
  • "category": "string",
  • "subCategory": "string",
  • "checkRealtimeSelection": true,
  • "includeMetadata": true,
  • "filters": [
    ]
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "products": [
    ],
  • "total": 0,
  • "metadata": {
    }
}

Metadata (v1.0)

query Parameters
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "segments": {
    },
  • "vendors": [
    ],
  • "manufacturers": [
    ],
  • "facets": {
    },
  • "filters": {
    }
}

Quicksearch (v1.0)

query Parameters
search
required
string
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "manufacturers": [
    ],
  • "categories": [
    ],
  • "manufacturerPartNumbers": [
    ]
}

Count (v1.0)

query Parameters
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
keywords
string or null
page
integer <int32>
pageSize
integer <int32>
inStock
boolean
lowPrice
number or null <double>
highPrice
number or null <double>
manufacturer
Array of strings or null
vendors
Array of strings or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.FilterCriteria)
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.FilterCriteria)
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.FilterCriteria)
segment
string or null
category
string or null
subCategory
string or null
checkRealtimeSelection
boolean or null
includeMetadata
boolean or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductFilter)

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "keywords": "string",
  • "page": 0,
  • "pageSize": 0,
  • "inStock": true,
  • "lowPrice": 0,
  • "highPrice": 0,
  • "manufacturer": [
    ],
  • "vendors": [
    ],
  • "must": [
    ],
  • "boost": [
    ],
  • "exclude": [
    ],
  • "segment": "string",
  • "category": "string",
  • "subCategory": "string",
  • "checkRealtimeSelection": true,
  • "includeMetadata": true,
  • "filters": [
    ]
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "count": 0,
  • "catalog": "string"
}

Search History (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "items": [
    ]
}

Favorites

Get Favorites (v1.0)

query Parameters
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "products": [
    ],
  • "total": 0,
  • "metadata": {
    }
}

Set Favorites (v1.0)

path Parameters
id
required
string
query Parameters
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
company
boolean
user
boolean

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "company": true,
  • "user": true
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Remove Company Favorite (v1.0)

path Parameters
id
required
string
query Parameters
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Remove User Favorite (v1.0)

path Parameters
id
required
string
query Parameters
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Workspaces

Get Workspaces (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "workspaces": [
    ]
}

Get Workspace Detail (v1.0)

path Parameters
workspace
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "id": "string",
  • "name": "string",
  • "active": true,
  • "products": [
    ]
}

Update Workspace (v1.0)

path Parameters
workspace
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Delete Workspace (v1.0)

path Parameters
workspace
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Update Workspace Item (v1.0)

path Parameters
workspace
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
quantity
number or null <double>
price
number or null <double>

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "quantity": 0,
  • "price": 0
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Delete Workspace Item (v1.0)

path Parameters
workspace
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Update Workspace Metadata (v1.0)

path Parameters
workspace
required
string
extension
required
string
field
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
value
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "value": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Recommendations (v1.0)

path Parameters
workspace
required
string
extension
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "error": "string",
  • "success": true,
  • "products": [
    ],
  • "matchedProducts": [
    ],
  • "possibleProducts": [
    ]
}

Get Workspace Extension Field Metadata By Extension (v1.0)

path Parameters
workspace
required
string
extension
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "fields": [
    ]
}

Get Workspace Extension Field Metadata (v1.0)

path Parameters
workspace
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "fields": [
    ]
}

Get Workspace Extension Field Metadata By Field (v1.0)

path Parameters
workspace
required
string
field
required
string
query Parameters
extension
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "fields": [
    ]
}

Catalog

Get Catalogs (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "catalogs": [
    ]
}

Create Catalog (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
name
string or null
description
string or null
active
boolean
checkRealtime
boolean

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "checkRealtime": true
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Retrieve Products (v1.0)

path Parameters
name
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
ids
Array of strings or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "ids": [
    ]
}

Response samples

Content type
application/json; x-api-version=1.0
[
  • {
    }
]

Get Product (v1.0)

path Parameters
name
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "id": "string",
  • "description": "string",
  • "manufacturer": "string",
  • "manufacturerPartNumber": "string",
  • "msrp": 0,
  • "name": "string",
  • "image": "string",
  • "images": [
    ],
  • "catalog": "string",
  • "unspsc": "string",
  • "vendors": [
    ],
  • "attributes": {
    },
  • "filters": {
    },
  • "facets": {
    },
  • "links": [
    ],
  • "notes": [
    ],
  • "segment": "string",
  • "category": "string",
  • "subCategory": "string",
  • "extensionFields": [
    ],
  • "favorite": {
    },
  • "updatedBy": "string",
  • "lastUpdated": "string"
}

Update Product (v1.0)

path Parameters
name
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
id
string or null
description
string or null
manufacturer
string or null
manufacturerPartNumber
string or null
msrp
number or null <double>
name
string or null
image
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductImage)
catalog
string or null
unspsc
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.Vendor)
object or null
object or null
object or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductLink)
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductNote)
segment
string or null
category
string or null
subCategory
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ExtensionField)
object (AdaptiveCatalog.Api.Shared.Models.V_1._0.Favorite)
updatedBy
string or null
lastUpdated
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "id": "string",
  • "description": "string",
  • "manufacturer": "string",
  • "manufacturerPartNumber": "string",
  • "msrp": 0,
  • "name": "string",
  • "image": "string",
  • "images": [
    ],
  • "catalog": "string",
  • "unspsc": "string",
  • "vendors": [
    ],
  • "attributes": {
    },
  • "filters": {
    },
  • "facets": {
    },
  • "links": [
    ],
  • "notes": [
    ],
  • "segment": "string",
  • "category": "string",
  • "subCategory": "string",
  • "extensionFields": [
    ],
  • "favorite": {
    },
  • "updatedBy": "string",
  • "lastUpdated": "string"
}

Update Product (POST) (v1.0)

path Parameters
name
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
id
string or null
description
string or null
manufacturer
string or null
manufacturerPartNumber
string or null
msrp
number or null <double>
name
string or null
image
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductImage)
catalog
string or null
unspsc
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.Vendor)
object or null
object or null
object or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductLink)
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ProductNote)
segment
string or null
category
string or null
subCategory
string or null
Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.ExtensionField)
object (AdaptiveCatalog.Api.Shared.Models.V_1._0.Favorite)
updatedBy
string or null
lastUpdated
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "id": "string",
  • "description": "string",
  • "manufacturer": "string",
  • "manufacturerPartNumber": "string",
  • "msrp": 0,
  • "name": "string",
  • "image": "string",
  • "images": [
    ],
  • "catalog": "string",
  • "unspsc": "string",
  • "vendors": [
    ],
  • "attributes": {
    },
  • "filters": {
    },
  • "facets": {
    },
  • "links": [
    ],
  • "notes": [
    ],
  • "segment": "string",
  • "category": "string",
  • "subCategory": "string",
  • "extensionFields": [
    ],
  • "favorite": {
    },
  • "updatedBy": "string",
  • "lastUpdated": "string"
}

Update Extensions Field (v1.0)

path Parameters
name
required
string
id
required
string
extension
required
string
field
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
value
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "value": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Product Specific Extension Fields (v1.0)

path Parameters
name
required
string
id
required
string
extension
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "fields": [
    ]
}

Get Extension Fields (v1.0)

path Parameters
name
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "fields": [
    ]
}

Get Product Notes (v1.0)

path Parameters
name
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "text": "string",
  • "username": "string",
  • "productId": "string",
  • "catalog": "string"
}

Update Product Notes (v1.0)

path Parameters
name
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
text
string or null
username
string or null
productId
string or null
catalog
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "text": "string",
  • "username": "string",
  • "productId": "string",
  • "catalog": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Insights (v1.0)

path Parameters
name
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "vendorInsights": [
    ]
}

Add Product To Workspace (v1.0)

path Parameters
name
required
string
id
required
string
workspace
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Copy Product To Catalog (v1.0)

path Parameters
name
required
string
id
required
string
catalog
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Product Logs (v1.0)

path Parameters
name
required
string
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "items": [
    ]
}

Settings

Get Organizations (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "organizations": [
    ]
}

Get Organization Details (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "id": "string",
  • "name": "string",
  • "catalogs": [
    ],
  • "defaultCatalog": "string",
  • "logo": "string",
  • "configurations": [
    ],
  • "users": [
    ],
  • "userLimit": 0,
  • "catalogLimit": 0,
  • "licensedUserCount": 0,
  • "searchCredits": 0,
  • "additionalCreditBundle": 0,
  • "additionalCreditCost": 0
}

Save User to Organization (v1.0)

path Parameters
uname
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
username
string or null
role
string or null
firstName
string or null
lastName
string or null
sendNotification
boolean

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "username": "string",
  • "role": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "sendNotification": true
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Remove User from Organization (v1.0)

path Parameters
uname
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Permissions (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "permissions": [
    ],
  • "allPermissions": {
    }
}

Get Columns (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "searchColumns": [
    ],
  • "workspaceColumns": [
    ]
}

Save Columns (v1.0)

path Parameters
page
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
Array
string

Responses

Request samples

Content type
application/json; x-api-version=1.0
[
  • "string"
]

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Product Reporting Logs (v1.0)

query Parameters
page
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 0
user
string
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "items": [
    ]
}

Reporting

Search Usage (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "users": {
    },
  • "apiKeys": {
    },
  • "searchCreditsUsed": 0,
  • "year": 0,
  • "month": 0
}

Tasks

Get Tasks (v1.0)

query Parameters
includeDismissed
boolean
Default: false
fetchUpdates
boolean
Default: true
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "items": [
    ]
}

Review Task (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Dismiss Task (v1.0)

path Parameters
id
required
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Responses

Response samples

Content type
application/json; x-api-version=1.0
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Files

Save Product Image (v1.0)

header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
file
string or null
fileName
string or null
type
string or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "file": "string",
  • "fileName": "string",
  • "type": "string"
}

Response samples

Content type
application/json; x-api-version=1.0
{
  • "url": "string"
}

Delete Custom Product Images (v1.0)

path Parameters
productId
required
string
query Parameters
catalog
string
header Parameters
x-api-version
required
string
Default: 1.0

The requested API version

Request Body schema: application/json; x-api-version=1.0
customImageIds
Array of strings or null

Responses

Request samples

Content type
application/json; x-api-version=1.0
{
  • "customImageIds": [
    ]
}