Adaptive Catalog API (1.0)

Download OpenAPI specification:Download

Support: support@adaptivecatalog.com

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

Payload

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": [{"column": 0,
"field": "string",
"attribute": "string"
}
]
}

Response samples

200

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

Payload

Content type

application/json; x-api-version=1.0

{"additionalFields": {"property1": "string",
"property2": "string"
},
"products": [{"catalog": "string",
"id": "string"
}
],
"workspace": "string"
}

Response samples

200

Content type

application/json; x-api-version=1.0

{"error": "string",
"success": true,
"redirectUrl": "string",
"messageHeader": "string",
"message": "string",
"products": [{"id": "string",
"catalog": "string",
"externalId": "string"
}
]
}

Run Existing Extension Links (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

Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.GetExtensionLinkRequest)

Array

acId	string or null
acCatalog	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=1.0

{"products": [{"acId": "string",
"acCatalog": "string"
}
]
}

Response samples

200

Content type

application/json; x-api-version=1.0

{"links": [{"type": "string",
"acId": "string",
"acCatalog": "string",
"externalId": "string",
"link": "string",
"user": "string"
}
]
}

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

Payload

Content type

application/json; x-api-version=1.0

{"additionalFields": {"property1": "string",
"property2": "string"
},
"products": [{"catalog": "string",
"id": "string"
}
],
"workspace": "string"
}

Response samples

200

Content type

application/json; x-api-version=1.0

{"error": "string",
"success": true,
"products": [{"acId": "string",
"id": "string",
"mfp": "string",
"name": "string"
}
]
}

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

Payload

Content type

application/json; x-api-version=1.0

{"additionalData": {"property1": "string",
"property2": "string"
},
"search": "string"
}

Response samples

200

Content type

application/json; x-api-version=1.0

{"error": "string",
"success": true,
"options": [{"value": "string",
"display": "string",
"default": true
}
]
}

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

Payload

Content type

application/json; x-api-version=1.0

{"additionalFields": {"property1": "string",
"property2": "string"
},
"products": [{"catalog": "string",
"id": "string"
}
],
"workspace": "string"
}

Response samples

200

Content type

application/json; x-api-version=1.0

{"items": [{"id": "string",
"vendors": [{"vendorName": "string",
"vendorPartNumber": "string",
"active": true,
"onHand": 0,
"manufacturerPartNumber": "string",
"description": "string",
"cost": 0,
"error": "string",
"inStockDate": "2019-08-24T14:15:22Z",
"warehouses": [{"warehouse": "string",
"onHand": 0,
"inStockDate": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}

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

Payload

Content type

application/json; x-api-version=1.0

{"additionalFields": {"property1": "string",
"property2": "string"
},
"products": [{"catalog": "string",
"id": "string"
}
],
"workspace": "string"
}

Response samples

200
400

Content type

application/json; x-api-version=1.0

{"error": "string",
"success": true,
"items": [{"vendorPartNumber": "string",
"active": true,
"onHand": 0,
"manufacturerPartNumber": "string",
"description": "string",
"cost": 0,
"error": "string",
"status": "string",
"inStockDate": "2019-08-24T14:15:22Z",
"warehouses": [{"warehouse": "string",
"onHand": 0,
"inStockDate": "2019-08-24T14:15:22Z"
}
]
}
]
}

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

Payload

Content type

application/json; x-api-version=1.0

{"additionalFields": {"property1": "string",
"property2": "string"
},
"products": [{"catalog": "string",
"id": "string"
}
],
"workspace": "string"
}

Response samples

200
404

Content type

application/json; x-api-version=1.0

{"error": "string",
"success": true,
"products": ["string"
],
"matchedProducts": [{"productId": "string",
"score": 0,
"scorer": "string",
"source": "string",
"matchedTo": "string",
"qty": "string",
"mfp": "string",
"name": "string",
"matchGroup": "string"
}
],
"possibleProducts": [{"productId": "string",
"score": 0,
"scorer": "string",
"source": "string",
"matchedTo": "string",
"qty": "string",
"mfp": "string",
"name": "string",
"matchGroup": "string"
}
]
}

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

Payload

Content type

application/json; x-api-version=1.0

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

Response samples

200
404

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

200

Content type

application/json; x-api-version=1.0

[{"id": "string",
"enabled": true,
"source": "string",
"name": "string",
"description": "string",
"extensionType": "string",
"catalogFilter": ["string"
],
"vendor": "string",
"nickname": "string",
"link": "string",
"useLinkedItems": true,
"allowAdHocItems": true,
"allowPrice": true,
"sharedData": [{"field": "string",
"description": "string",
"fieldType": "string",
"defaultValue": "string",
"protected": true,
"dataType": "string",
"hasOptions": true,
"adHocOnlyField": true,
"optionsFields": [{"type": "string",
"field": "string"
}
],
"searchable": true,
"sharedKey": "string",
"sharedId": "string",
"optional": true
}
],
"additionalData": [{"field": "string",
"description": "string",
"fieldType": "string",
"defaultValue": "string",
"protected": true,
"dataType": "string",
"hasOptions": true,
"adHocOnlyField": true,
"optionsFields": [{"type": "string",
"field": "string"
}
],
"searchable": true,
"sharedKey": "string",
"sharedId": "string",
"optional": true
}
]
}
]

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

Payload

Content type

application/json; x-api-version=1.0

{"additionalData": {"property1": "string",
"property2": "string"
},
"vendor": "string",
"catalog": "string",
"extensionLevel": "string",
"extensionNickname": "string",
"schedule": "string",
"mappings": [{"column": 0,
"field": "string",
"attribute": "string"
}
]
}

Response samples

200

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

200

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

200

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

200

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

200

Content type

application/json; x-api-version=1.0

{"items": [{"extensionId": "string",
"extensionNickname": "string",
"success": true,
"message": "string",
"timestamp": "2019-08-24T14:15:22Z",
"action": "string",
"timeTaken": 0,
"username": "string",
"errorMessage": "string",
"productCount": 0,
"productsCreated": 0,
"productsSkipped": 0,
"productsUpdated": 0,
"recommendedProductCount": 0,
"potentialMatchProductCount": 0
}
]
}

AvailableExtensions

Get Available Extensions (v1.0)

header Parameters

x-api-version

required

string

Default: 1.0

The requested API version

Responses

Response samples

200

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": [{"field": "string",
"description": "string",
"fieldType": "string",
"defaultValue": "string",
"protected": true,
"dataType": "string",
"hasOptions": true,
"adHocOnlyField": true,
"optionsFields": [{"type": "string",
"field": "string"
}
],
"searchable": true,
"sharedKey": "string",
"sharedId": "string",
"optional": true
}
],
"mapToVendor": true
}
]

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

200

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": [{"field": "string",
"description": "string",
"fieldType": "string",
"defaultValue": "string",
"protected": true,
"dataType": "string",
"hasOptions": true,
"adHocOnlyField": true,
"optionsFields": [{"type": "string",
"field": "string"
}
],
"searchable": true,
"sharedKey": "string",
"sharedId": "string",
"optional": true
}
],
"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

Payload

Content type

application/json; x-api-version=1.0

{"additionalData": {"property1": "string",
"property2": "string"
},
"vendor": "string",
"catalog": "string",
"extensionLevel": "string",
"extensionNickname": "string",
"schedule": "string",
"mappings": [{"column": 0,
"field": "string",
"attribute": "string"
}
]
}

Response samples

200

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

Payload

Content type

application/json; x-api-version=1.0

{"additionalFields": {"property1": "string",
"property2": "string"
}
}

Response samples

200

Content type

application/json; x-api-version=1.0

{"error": "string",
"success": true,
"columns": [["string"
]
]
}

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

Payload

Content type

application/json; x-api-version=1.0

{"additionalData": {"property1": "string",
"property2": "string"
},
"vendor": "string",
"catalog": "string",
"extensionLevel": "string",
"extensionNickname": "string",
"schedule": "string",
"mappings": [{"column": 0,
"field": "string",
"attribute": "string"
}
]
}

Response samples

200

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

Payload

Content type

application/json; x-api-version=1.0

{"name": "string",
"keyType": "string"
}

Response samples

200

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

200

Content type

application/json; x-api-version=1.0

{"keys": [{"id": "string",
"name": "string",
"enabled": true,
"keyType": "string",
"createDate": "2019-08-24T14:15:22Z",
"username": "string"
}
]
}

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

200

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

200

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

200

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

200

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

Payload

Content type

application/json; x-api-version=1.0

{"keywords": "string",
"page": 0,
"pageSize": 0,
"inStock": true,
"lowPrice": 0,
"highPrice": 0,
"manufacturer": ["string"
],
"vendors": ["string"
],
"must": [{"type": "string",
"name": "string",
"value": "string"
}
],
"boost": [{"type": "string",
"name": "string",
"value": "string"
}
],
"exclude": [{"type": "string",
"name": "string",
"value": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"checkRealtimeSelection": true,
"includeMetadata": true,
"filters": [{"name": "string",
"min": 0,
"max": 0
}
]
}

Response samples

200

Content type

application/json; x-api-version=1.0

{"products": [{"id": "string",
"description": "string",
"manufacturer": "string",
"manufacturerPartNumber": "string",
"msrp": 0,
"name": "string",
"image": "string",
"images": [{"id": "string",
"url": "string",
"name": "string",
"type": "string",
"isCustom": true
}
],
"catalog": "string",
"unspsc": "string",
"vendors": [{"cost": 0,
"onHand": 0,
"inStock": true,
"vendorPartNumber": "string",
"vendorName": "string",
"status": "string",
"name": "string"
}
],
"attributes": {"property1": "string",
"property2": "string"
},
"filters": {"property1": 0,
"property2": 0
},
"facets": {"property1": "string",
"property2": "string"
},
"links": [{"type": "string",
"value": "string",
"recommended": true
}
],
"notes": [{"username": "string",
"text": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "string"
}
],
"total": 0,
"metadata": {"segments": {"property1": ["string"
],
"property2": ["string"
]
},
"vendors": ["string"
],
"manufacturers": ["string"
],
"facets": {"property1": ["string"
],
"property2": ["string"
]
},
"filters": {"property1": {"key": "string",
"min": 0,
"max": 0
},
"property2": {"key": "string",
"min": 0,
"max": 0
}
}
}
}

Simple 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

Payload

Content type

application/json; x-api-version=1.0

{"keywords": "string",
"page": 0,
"pageSize": 0,
"inStock": true,
"lowPrice": 0,
"highPrice": 0,
"manufacturer": ["string"
],
"vendors": ["string"
],
"must": [{"type": "string",
"name": "string",
"value": "string"
}
],
"boost": [{"type": "string",
"name": "string",
"value": "string"
}
],
"exclude": [{"type": "string",
"name": "string",
"value": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"checkRealtimeSelection": true,
"includeMetadata": true,
"filters": [{"name": "string",
"min": 0,
"max": 0
}
]
}

Response samples

200

Content type

application/json; x-api-version=1.0

{"products": [{"id": "string",
"description": "string",
"manufacturer": "string",
"manufacturerPartNumber": "string",
"msrp": 0,
"name": "string",
"image": "string",
"images": [{"id": "string",
"url": "string",
"name": "string",
"type": "string",
"isCustom": true
}
],
"catalog": "string",
"unspsc": "string",
"vendors": [{"cost": 0,
"onHand": 0,
"inStock": true,
"vendorPartNumber": "string",
"vendorName": "string",
"status": "string",
"name": "string"
}
],
"attributes": {"property1": "string",
"property2": "string"
},
"filters": {"property1": 0,
"property2": 0
},
"facets": {"property1": "string",
"property2": "string"
},
"links": [{"type": "string",
"value": "string",
"recommended": true
}
],
"notes": [{"username": "string",
"text": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "string"
}
],
"total": 0
}

Metadata (v1.0)

query Parameters

catalog

string

header Parameters

x-api-version

required

string

Default: 1.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=1.0

{"segments": {"property1": ["string"
],
"property2": ["string"
]
},
"vendors": ["string"
],
"manufacturers": ["string"
],
"facets": {"property1": ["string"
],
"property2": ["string"
]
},
"filters": {"property1": {"key": "string",
"min": 0,
"max": 0
},
"property2": {"key": "string",
"min": 0,
"max": 0
}
}
}

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

200

Content type

application/json; x-api-version=1.0

{"manufacturers": ["string"
],
"categories": ["string"
],
"manufacturerPartNumbers": ["string"
]
}

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

Payload

Content type

application/json; x-api-version=1.0

{"keywords": "string",
"page": 0,
"pageSize": 0,
"inStock": true,
"lowPrice": 0,
"highPrice": 0,
"manufacturer": ["string"
],
"vendors": ["string"
],
"must": [{"type": "string",
"name": "string",
"value": "string"
}
],
"boost": [{"type": "string",
"name": "string",
"value": "string"
}
],
"exclude": [{"type": "string",
"name": "string",
"value": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"checkRealtimeSelection": true,
"includeMetadata": true,
"filters": [{"name": "string",
"min": 0,
"max": 0
}
]
}

Response samples

200

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

200

Content type

application/json; x-api-version=1.0

{"items": [{"keywords": "string",
"page": 0,
"pageSize": 0,
"inStock": true,
"lowPrice": 0,
"highPrice": 0,
"manufacturer": ["string"
],
"vendors": ["string"
],
"must": [{"type": "string",
"name": "string",
"value": "string"
}
],
"boost": [{"type": "string",
"name": "string",
"value": "string"
}
],
"exclude": [{"type": "string",
"name": "string",
"value": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"checkRealtimeSelection": true,
"includeMetadata": true,
"filters": [{"name": "string",
"min": 0,
"max": 0
}
],
"catalog": "string",
"username": "string"
}
]
}

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

200

Content type

application/json; x-api-version=1.0

{"products": [{"id": "string",
"description": "string",
"manufacturer": "string",
"manufacturerPartNumber": "string",
"msrp": 0,
"name": "string",
"image": "string",
"images": [{"id": "string",
"url": "string",
"name": "string",
"type": "string",
"isCustom": true
}
],
"catalog": "string",
"unspsc": "string",
"vendors": [{"cost": 0,
"onHand": 0,
"inStock": true,
"vendorPartNumber": "string",
"vendorName": "string",
"status": "string",
"name": "string"
}
],
"attributes": {"property1": "string",
"property2": "string"
},
"filters": {"property1": 0,
"property2": 0
},
"facets": {"property1": "string",
"property2": "string"
},
"links": [{"type": "string",
"value": "string",
"recommended": true
}
],
"notes": [{"username": "string",
"text": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "string"
}
],
"total": 0,
"metadata": {"segments": {"property1": ["string"
],
"property2": ["string"
]
},
"vendors": ["string"
],
"manufacturers": ["string"
],
"facets": {"property1": ["string"
],
"property2": ["string"
]
},
"filters": {"property1": {"key": "string",
"min": 0,
"max": 0
},
"property2": {"key": "string",
"min": 0,
"max": 0
}
}
}
}

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

Payload

Content type

application/json; x-api-version=1.0

{"company": true,
"user": true
}

Response samples

200

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

200

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

200

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

200

Content type

application/json; x-api-version=1.0

{"workspaces": [{"id": "string",
"name": "string",
"active": true,
"products": [{"id": "string",
"username": "string",
"productId": "string",
"catalog": "string",
"workspace": "string",
"product": {"id": "string",
"description": "string",
"manufacturer": "string",
"manufacturerPartNumber": "string",
"msrp": 0,
"name": "string",
"image": "string",
"images": [{"id": "string",
"url": "string",
"name": "string",
"type": "string",
"isCustom": true
}
],
"catalog": "string",
"unspsc": "string",
"vendors": [{"cost": 0,
"onHand": 0,
"inStock": true,
"vendorPartNumber": "string",
"vendorName": "string",
"status": "string",
"name": "string"
}
],
"attributes": {"property1": "string",
"property2": "string"
},
"filters": {"property1": 0,
"property2": 0
},
"facets": {"property1": "string",
"property2": "string"
},
"links": [{"type": "string",
"value": "string",
"recommended": true
}
],
"notes": [{"username": "string",
"text": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "string"
},
"details": {"quantity": 0,
"price": 0
}
}
]
}
]
}

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

200

Content type

application/json; x-api-version=1.0

{"id": "string",
"name": "string",
"active": true,
"products": [{"id": "string",
"username": "string",
"productId": "string",
"catalog": "string",
"workspace": "string",
"product": {"id": "string",
"description": "string",
"manufacturer": "string",
"manufacturerPartNumber": "string",
"msrp": 0,
"name": "string",
"image": "string",
"images": [{"id": "string",
"url": "string",
"name": "string",
"type": "string",
"isCustom": true
}
],
"catalog": "string",
"unspsc": "string",
"vendors": [{"cost": 0,
"onHand": 0,
"inStock": true,
"vendorPartNumber": "string",
"vendorName": "string",
"status": "string",
"name": "string"
}
],
"attributes": {"property1": "string",
"property2": "string"
},
"filters": {"property1": 0,
"property2": 0
},
"facets": {"property1": "string",
"property2": "string"
},
"links": [{"type": "string",
"value": "string",
"recommended": true
}
],
"notes": [{"username": "string",
"text": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "string"
},
"details": {"quantity": 0,
"price": 0
}
}
]
}

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

200

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

200

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

Payload

Content type

application/json; x-api-version=1.0

{"quantity": 0,
"price": 0
}

Response samples

200

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

200

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

Payload

Content type

application/json; x-api-version=1.0

{"value": "string"
}

Response samples

200

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

200
404

Content type

application/json; x-api-version=1.0

{"error": "string",
"success": true,
"products": ["string"
],
"matchedProducts": [{"productId": "string",
"score": 0,
"scorer": "string",
"source": "string",
"matchedTo": "string",
"qty": "string",
"mfp": "string",
"name": "string",
"matchGroup": "string"
}
],
"possibleProducts": [{"productId": "string",
"score": 0,
"scorer": "string",
"source": "string",
"matchedTo": "string",
"qty": "string",
"mfp": "string",
"name": "string",
"matchGroup": "string"
}
]
}

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

200

Content type

application/json; x-api-version=1.0

{"fields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
]
}

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

200

Content type

application/json; x-api-version=1.0

{"fields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
]
}

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

200

Content type

application/json; x-api-version=1.0

{"fields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
]
}

Catalog

Get Catalogs (v1.0)

header Parameters

x-api-version

required

string

Default: 1.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=1.0

{"catalogs": [{"name": "string",
"description": "string",
"active": true,
"checkRealtime": true
}
]
}

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

Payload

Content type

application/json; x-api-version=1.0

{"name": "string",
"description": "string",
"active": true,
"checkRealtime": true
}

Response samples

200

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

Payload

Content type

application/json; x-api-version=1.0

{"ids": ["string"
]
}

Response samples

200

Content type

application/json; x-api-version=1.0

[{"id": "string",
"description": "string",
"manufacturer": "string",
"manufacturerPartNumber": "string",
"msrp": 0,
"name": "string",
"image": "string",
"images": [{"id": "string",
"url": "string",
"name": "string",
"type": "string",
"isCustom": true
}
],
"catalog": "string",
"unspsc": "string",
"vendors": [{"cost": 0,
"onHand": 0,
"inStock": true,
"vendorPartNumber": "string",
"vendorName": "string",
"status": "string",
"name": "string"
}
],
"attributes": {"property1": "string",
"property2": "string"
},
"filters": {"property1": 0,
"property2": 0
},
"facets": {"property1": "string",
"property2": "string"
},
"links": [{"type": "string",
"value": "string",
"recommended": true
}
],
"notes": [{"username": "string",
"text": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "string"
}
]

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

200

Content type

application/json; x-api-version=1.0

{"id": "string",
"description": "string",
"manufacturer": "string",
"manufacturerPartNumber": "string",
"msrp": 0,
"name": "string",
"image": "string",
"images": [{"id": "string",
"url": "string",
"name": "string",
"type": "string",
"isCustom": true
}
],
"catalog": "string",
"unspsc": "string",
"vendors": [{"cost": 0,
"onHand": 0,
"inStock": true,
"vendorPartNumber": "string",
"vendorName": "string",
"status": "string",
"name": "string"
}
],
"attributes": {"property1": "string",
"property2": "string"
},
"filters": {"property1": 0,
"property2": 0
},
"facets": {"property1": "string",
"property2": "string"
},
"links": [{"type": "string",
"value": "string",
"recommended": true
}
],
"notes": [{"username": "string",
"text": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"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

Payload

Content type

application/json; x-api-version=1.0

{"id": "string",
"description": "string",
"manufacturer": "string",
"manufacturerPartNumber": "string",
"msrp": 0,
"name": "string",
"image": "string",
"images": [{"id": "string",
"url": "string",
"name": "string",
"type": "string",
"isCustom": true
}
],
"catalog": "string",
"unspsc": "string",
"vendors": [{"cost": 0,
"onHand": 0,
"inStock": true,
"vendorPartNumber": "string",
"vendorName": "string",
"status": "string",
"name": "string"
}
],
"attributes": {"property1": "string",
"property2": "string"
},
"filters": {"property1": 0,
"property2": 0
},
"facets": {"property1": "string",
"property2": "string"
},
"links": [{"type": "string",
"value": "string",
"recommended": true
}
],
"notes": [{"username": "string",
"text": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"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

Payload

Content type

application/json; x-api-version=1.0

{"id": "string",
"description": "string",
"manufacturer": "string",
"manufacturerPartNumber": "string",
"msrp": 0,
"name": "string",
"image": "string",
"images": [{"id": "string",
"url": "string",
"name": "string",
"type": "string",
"isCustom": true
}
],
"catalog": "string",
"unspsc": "string",
"vendors": [{"cost": 0,
"onHand": 0,
"inStock": true,
"vendorPartNumber": "string",
"vendorName": "string",
"status": "string",
"name": "string"
}
],
"attributes": {"property1": "string",
"property2": "string"
},
"filters": {"property1": 0,
"property2": 0
},
"facets": {"property1": "string",
"property2": "string"
},
"links": [{"type": "string",
"value": "string",
"recommended": true
}
],
"notes": [{"username": "string",
"text": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"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

Payload

Content type

application/json; x-api-version=1.0

{"value": "string"
}

Response samples

200
404

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

200
404

Content type

application/json; x-api-version=1.0

{"fields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
]
}

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

200
404

Content type

application/json; x-api-version=1.0

{"fields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
]
}

Add Extension Link (v1.0)

path Parameters

name required	string
id required	string
extensionId required	string
externalId required	string

header Parameters

x-api-version

required

string

Default: 1.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=1.0

{"success": true,
"message": "string",
"id": "string",
"taskId": "string"
}

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

200

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

Payload

Content type

application/json; x-api-version=1.0

{"text": "string",
"username": "string",
"productId": "string",
"catalog": "string"
}

Response samples

200
404

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

200
404

Content type

application/json; x-api-version=1.0

{"vendorInsights": [{"id": "string",
"vendor": "string",
"vendorPartNumber": "string",
"manufacturerPartNumber": "string",
"date": "2019-08-24T14:15:22Z",
"price": 0,
"inStock": true,
"onHand": 0
}
]
}

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

200
404

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

200

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

200

Content type

application/json; x-api-version=1.0

{"items": [{"catalog": "string",
"productId": "string",
"updatedBy": "string",
"timestamp": "string",
"fieldsUpdated": ["string"
]
}
]
}

Settings

Get Organizations (v1.0)

header Parameters

x-api-version

required

string

Default: 1.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=1.0

{"organizations": [{"id": "string",
"name": "string",
"catalogs": [{"name": "string",
"description": "string",
"active": true,
"checkRealtime": true
}
],
"defaultCatalog": "string",
"logo": "string",
"configurations": [{"name": "string",
"description": "string",
"defaultValue": "string",
"protected": true,
"dataType": "string"
}
],
"users": [{"username": "string",
"role": "string"
}
],
"userLimit": 0,
"catalogLimit": 0,
"licensedUserCount": 0,
"searchCredits": 0,
"additionalCreditBundle": 0,
"additionalCreditCost": 0
}
]
}

Get Organization Details (v1.0)

header Parameters

x-api-version

required

string

Default: 1.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=1.0

{"id": "string",
"name": "string",
"catalogs": [{"name": "string",
"description": "string",
"active": true,
"checkRealtime": true
}
],
"defaultCatalog": "string",
"logo": "string",
"configurations": [{"name": "string",
"description": "string",
"defaultValue": "string",
"protected": true,
"dataType": "string"
}
],
"users": [{"username": "string",
"role": "string"
}
],
"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

Payload

Content type

application/json; x-api-version=1.0

{"username": "string",
"role": "string",
"firstName": "string",
"lastName": "string",
"sendNotification": true
}

Response samples

200
400

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

200

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

200

Content type

application/json; x-api-version=1.0

{"permissions": ["string"
],
"allPermissions": {"property1": "string",
"property2": "string"
}
}

Get Columns (v1.0)

header Parameters

x-api-version

required

string

Default: 1.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=1.0

{"searchColumns": ["string"
],
"workspaceColumns": ["string"
]
}

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

Payload

Content type

application/json; x-api-version=1.0

["string"
]

Response samples

200

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

200

Content type

application/json; x-api-version=1.0

{"items": [{"catalog": "string",
"productId": "string",
"updatedBy": "string",
"timestamp": "string",
"fieldsUpdated": ["string"
]
}
]
}

Reporting

Search Usage (v1.0)

header Parameters

x-api-version

required

string

Default: 1.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=1.0

{"users": {"property1": {"searchCreditsUsed": 0,
"searchCount": 0
},
"property2": {"searchCreditsUsed": 0,
"searchCount": 0
}
},
"apiKeys": {"property1": {"searchCreditsUsed": 0,
"searchCount": 0
},
"property2": {"searchCreditsUsed": 0,
"searchCount": 0
}
},
"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

200

Content type

application/json; x-api-version=1.0

{"items": [{"id": "string",
"status": "string",
"createDate": "2019-08-24T14:15:22Z",
"message": "string",
"completed": true,
"success": true,
"percentCompleted": 0,
"reviewed": true,
"dismissed": true,
"source": "string",
"sourceType": "string"
}
]
}

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

200

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

200

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

Payload

Content type

application/json; x-api-version=1.0

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

Response samples

200

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

Payload

Content type

application/json; x-api-version=1.0

{"customImageIds": ["string"
]
}