Skip to main content
Documentation Powered by Redocly

Adaptive Catalog API (v1)

Download OpenAPI specification:Download

ImportExtensions

/api/extensions/import/{id}/run

path Parameters
id
required
string
Request Body schema:
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 (ImportExtensionMapping)

Responses

Request samples

Content type
{
  • "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
No sample

ExportExtensions

/api/extensions/export/{id}/run

path Parameters
id
required
string
query Parameters
catalog
string
Request Body schema:
object or null
Array of objects or null (ProductReference)
workspace
string or null

Responses

Request samples

Content type
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
No sample

/api/extensions/export/{id}/existing

path Parameters
id
required
string
Request Body schema:
Array of objects or null (GetExtensionLinkRequest)
Array
acId
string or null
acCatalog
string or null

Responses

Request samples

Content type
{
  • "products": [
    ]
}

Response samples

Content type
No sample

/api/extensions/export/{id}/possibleMatches

path Parameters
id
required
string
Request Body schema:
object or null
Array of objects or null (ProductReference)
workspace
string or null

Responses

Request samples

Content type
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
No sample

/api/extensions/export/{id}/{field}/options

path Parameters
id
required
string
field
required
string
query Parameters
catalog
string
Request Body schema:
object or null
search
string or null

Responses

Request samples

Content type
{
  • "additionalData": {
    },
  • "search": "string"
}

Response samples

Content type
No sample

RealTimeExtensions

/api/extensions/realtime/run

Request Body schema:
object or null
Array of objects or null (ProductReference)
workspace
string or null

Responses

Request samples

Content type
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
No sample

/api/extensions/realtime/{id}/run

path Parameters
id
required
string
Request Body schema:
object or null
Array of objects or null (ProductReference)
workspace
string or null

Responses

Request samples

Content type
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
No sample

RecommendationExtensions

/api/extensions/recommendation/{extension}/run

path Parameters
extension
required
string
Request Body schema:
object or null
Array of objects or null (ProductReference)
workspace
string or null

Responses

Request samples

Content type
{
  • "additionalFields": {
    },
  • "products": [
    ],
  • "workspace": "string"
}

Response samples

Content type
No sample

/api/extensions/recommendation/{extension}/files

path Parameters
extension
required
string
Request Body schema:
file
string or null
fileName
string or null
type
string or null

Responses

Request samples

Content type
{
  • "file": "string",
  • "fileName": "string",
  • "type": "string"
}

Response samples

Content type
No sample

InstalledExtensions

/api/extensions/installed

query Parameters
type
string

Responses

Response samples

Content type
No sample

/api/extensions/installed/{id}

path Parameters
id
required
string
Request Body schema:
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 (ImportExtensionMapping)

Responses

Request samples

Content type
{
  • "additionalData": {
    },
  • "vendor": "string",
  • "catalog": "string",
  • "extensionLevel": "string",
  • "extensionNickname": "string",
  • "schedule": "string",
  • "mappings": [
    ]
}

Response samples

Content type
No sample

/api/extensions/installed/{id}

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/api/extensions/installed/{id}/disable

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/api/extensions/installed/{id}/enable

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/api/extensions/installed/{id}/logs

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

AvailableExtensions

/api/extensions/available

Responses

Response samples

Content type
No sample

/api/extensions/available/{id}

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/api/extensions/available/{id}/validate

path Parameters
id
required
string
Request Body schema:
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 (ImportExtensionMapping)

Responses

Request samples

Content type
{
  • "additionalData": {
    },
  • "vendor": "string",
  • "catalog": "string",
  • "extensionLevel": "string",
  • "extensionNickname": "string",
  • "schedule": "string",
  • "mappings": [
    ]
}

Response samples

Content type
No sample

/api/extensions/available/{id}/getSample

path Parameters
id
required
string
Request Body schema:
object or null
property name*
additional property
string

Responses

Request samples

Content type
{
  • "additionalFields": {
    }
}

Response samples

Content type
No sample

/api/extensions/available/{id}/install

path Parameters
id
required
string
Request Body schema:
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 (ImportExtensionMapping)

Responses

Request samples

Content type
{
  • "additionalData": {
    },
  • "vendor": "string",
  • "catalog": "string",
  • "extensionLevel": "string",
  • "extensionNickname": "string",
  • "schedule": "string",
  • "mappings": [
    ]
}

Response samples

Content type
No sample

/api/extensions/links/{extension}/{id}

path Parameters
extension
required
string
id
required
string

Responses

Response samples

Content type
No sample

/api/extensions/links/{extension}

path Parameters
extension
required
string
Request Body schema:
Array of objects or null (GetExtensionLinkRequest)
Array
acId
string or null
acCatalog
string or null

Responses

Request samples

Content type
{
  • "products": [
    ]
}

Response samples

Content type
No sample

KeyAuth

/api/KeyAuth/apikey

Request Body schema:
name
string or null
keyType
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "keyType": "string"
}

Response samples

Content type
No sample

/api/KeyAuth/apikey

Responses

Response samples

Content type
No sample

/api/KeyAuth/apikey/{id}/disable

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/api/KeyAuth/apikey/{id}/enable

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/api/KeyAuth/apikey/{id}

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/api/KeyAuth/sessionkey

Request Body schema:
organization
string or null
key
string or null

Responses

Request samples

Content type
{
  • "organization": "string",
  • "key": "string"
}

Response samples

Content type
No sample

/api/KeyAuth/sessionkey

Responses

Response samples

Content type
No sample

/api/KeyAuth/sessionkey/submit/workspace/{id}

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/api/KeyAuth/sessionkey/submit/cwcpqworkspace/{id}

path Parameters
id
required
string

Responses

Response samples

Content type
No sample

/api/KeyAuth/punchout/setup/json

Request Body schema:
company
string or null
username
string or null
apiKey
string or null
callbackUrl
string or null

Responses

Request samples

Content type
{
  • "company": "string",
  • "username": "string",
  • "apiKey": "string",
  • "callbackUrl": "string"
}

Response samples

Content type
No sample

Search

Search

query Parameters
catalog
string
Request Body schema: application/json
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 (FilterCriteria)
Array of objects or null (FilterCriteria)
Array of objects or null (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 (ProductFilter)

Responses

Request samples

Content type
application/json
{
  • "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
{
  • "products": [
    ],
  • "total": 0,
  • "metadata": {
    }
}

Metadata

query Parameters
catalog
string

Responses

Response samples

Content type
application/json
{
  • "segments": {
    },
  • "vendors": [
    ],
  • "manufacturers": [
    ],
  • "facets": {
    },
  • "filters": {
    }
}

Quicksearch

query Parameters
search
required
string
catalog
string

Responses

Response samples

Content type
application/json
{
  • "manufacturers": [
    ],
  • "categories": [
    ],
  • "manufacturerPartNumbers": [
    ]
}

Count

query Parameters
catalog
string
Request Body schema: application/json
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 (FilterCriteria)
Array of objects or null (FilterCriteria)
Array of objects or null (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 (ProductFilter)

Responses

Request samples

Content type
application/json
{
  • "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
{
  • "count": 0,
  • "catalog": "string"
}

Search History

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Favorites

Get Favorites

query Parameters
catalog
string

Responses

Response samples

Content type
application/json
{
  • "products": [
    ],
  • "total": 0,
  • "metadata": {
    }
}

Set Favorites

path Parameters
id
required
string
query Parameters
catalog
string
Request Body schema: application/json
company
boolean
user
boolean

Responses

Request samples

Content type
application/json
{
  • "company": true,
  • "user": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Remove Company Favorite

path Parameters
id
required
string
query Parameters
catalog
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Remove User Favorite

path Parameters
id
required
string
query Parameters
catalog
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Workspaces

/api/Workspaces

Responses

Response samples

Content type
No sample

/api/Workspaces/{workspace}

path Parameters
workspace
required
string

Responses

Response samples

Content type
No sample

/api/Workspaces/{workspace}

path Parameters
workspace
required
string

Responses

Response samples

Content type
No sample

/api/Workspaces/{workspace}

path Parameters
workspace
required
string

Responses

Response samples

Content type
No sample

/api/Workspaces/{workspace}/items/{id}

path Parameters
workspace
required
string
id
required
string
Request Body schema:
quantity
number or null <double>
price
number or null <double>

Responses

Request samples

Content type
{
  • "quantity": 0,
  • "price": 0
}

Response samples

Content type
No sample

/api/Workspaces/{workspace}/items/{id}

path Parameters
workspace
required
string
id
required
string

Responses

Response samples

Content type
No sample

/api/Workspaces/{workspace}/extensionFields/{extension}/{field}

path Parameters
workspace
required
string
extension
required
string
field
required
string
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
No sample

/api/Workspaces/{workspace}/extensionFields/{extension}/{field}

path Parameters
workspace
required
string
extension
required
string
field
required
string

Responses

Response samples

Content type
No sample

/api/Workspaces/{workspace}/recommendations/{extension}

path Parameters
workspace
required
string
extension
required
string

Responses

Response samples

Content type
No sample

/api/Workspaces/{workspace}/extensionFields/{extension}

path Parameters
workspace
required
string
extension
required
string

Responses

Response samples

Content type
No sample

/api/Workspaces/{workspace}/extensionFields

path Parameters
workspace
required
string

Responses

Response samples

Content type
No sample

Catalog

/api/Catalog

Responses

Response samples

Content type
No sample

/api/Catalog/{Name}

path Parameters
Name
required
string
query Parameters
Description
string
Active
boolean
CheckRealtime
boolean

Responses

Response samples

Content type
No sample

/api/Catalog/{name}/retrieveProducts

path Parameters
name
required
string
Request Body schema:
ids
Array of strings or null

Responses

Request samples

Content type
{
  • "ids": [
    ]
}

Response samples

Content type
No sample

/api/Catalog/{name}/{id}

path Parameters
name
required
string
id
required
string

Responses

Response samples

Content type
No sample

/api/Catalog/{name}/{id}

path Parameters
name
required
string
id
required
string
Request Body schema:
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 (ProductImage)
catalog
string or null
unspsc
string or null
Array of objects or null (Vendor)
object or null
object or null
object or null
Array of objects or null (ProductLink)
Array of objects or null (ProductNote)
segment
string or null
category
string or null
subCategory
string or null
Array of objects or null (ExtensionField)
object (Favorite)
updatedBy
string or null
lastUpdated
string or null

Responses

Request samples

Content type
{
  • "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"
}

/api/Catalog/{name}/{id}

path Parameters
name
required
string
id
required
string
Request Body schema:
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 (ProductImage)
catalog
string or null
unspsc
string or null
Array of objects or null (Vendor)
object or null
object or null
object or null
Array of objects or null (ProductLink)
Array of objects or null (ProductNote)
segment
string or null
category
string or null
subCategory
string or null
Array of objects or null (ExtensionField)
object (Favorite)
updatedBy
string or null
lastUpdated
string or null

Responses

Request samples

Content type
{
  • "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"
}

/api/Catalog/{name}/{id}/extensionFields/{extension}/{field}

path Parameters
name
required
string
id
required
string
extension
required
string
field
required
string
Request Body schema:
value
string or null

Responses

Request samples

Content type
{
  • "value": "string"
}

Response samples

Content type
No sample

/api/Catalog/{name}/{id}/extensionFields/{extension}

path Parameters
name
required
string
id
required
string
extension
required
string

Responses

Response samples

Content type
No sample

/api/Catalog/{name}/{id}/extensionFields

path Parameters
name
required
string
id
required
string

Responses

Response samples

Content type
No sample

/api/Catalog/{name}/{id}/extensionLinks/{extensionId}/{externalId}

path Parameters
name
required
string
id
required
string
extensionId
required
string
externalId
required
string

Responses

Response samples

Content type
No sample

/api/Catalog/{name}/{id}/notes

path Parameters
name
required
string
id
required
string

Responses

Response samples

Content type
No sample

/api/Catalog/{name}/{id}/notes

path Parameters
name
required
string
id
required
string
Request Body schema:
text
string or null
username
string or null
productId
string or null
catalog
string or null

Responses

Request samples

Content type
{
  • "text": "string",
  • "username": "string",
  • "productId": "string",
  • "catalog": "string"
}

Response samples

Content type
No sample

/api/Catalog/{name}/{id}/insights

path Parameters
name
required
string
id
required
string

Responses

Response samples

Content type
No sample

/api/Catalog/{name}/{id}/addToWorkspace/{workspace}

path Parameters
name
required
string
id
required
string
workspace
required
string

Responses

Response samples

Content type
No sample

/api/Catalog/{name}/{id}/copyToCatalog/{catalog}

path Parameters
name
required
string
id
required
string
catalog
required
string

Responses

Response samples

Content type
No sample

/api/Catalog/{name}/{productid}/logs

path Parameters
name
required
string
productId
required
string

Responses

Response samples

Content type
No sample

Settings

Get Organizations

Responses

Response samples

Content type
application/json
{
  • "organizations": [
    ]
}

Get Organization Details

Responses

Response samples

Content type
application/json
{
  • "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

path Parameters
uname
required
string
Request Body schema: application/json
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
{
  • "username": "string",
  • "role": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "sendNotification": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Remove User from Organization

path Parameters
uname
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Permissions

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ],
  • "allPermissions": {
    }
}

Get Columns

Responses

Response samples

Content type
application/json
{
  • "searchColumns": [
    ],
  • "workspaceColumns": [
    ]
}

Save Columns

path Parameters
page
required
string
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Get Product Logs

query Parameters
page
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 0
user
string
catalog
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Reporting

Search Usage

Responses

Response samples

Content type
application/json
{
  • "users": {
    },
  • "apiKeys": {
    },
  • "searchCreditsUsed": 0,
  • "year": 0,
  • "month": 0
}

Tasks

Get Tasks

query Parameters
includeDismissed
boolean
Default: false
fetchUpdates
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Review Task

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Dismiss Task

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "id": "string",
  • "taskId": "string"
}

Files

Save Product Image

Request Body schema: application/json
file
string or null
fileName
string or null
type
string or null

Responses

Request samples

Content type
application/json
{
  • "file": "string",
  • "fileName": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "url": "string"
}

Delete Custom Product Images

path Parameters
productId
required
string
query Parameters
catalog
string
Request Body schema: application/json
customImageIds
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "customImageIds": [
    ]
}