Adaptive Catalog API (3.0)

Download OpenAPI specification:Download

Support: [email protected]

ImportExtensions

Run Import Extension

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Import Data

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

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
recordCount	integer or null <int64>
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=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

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

ExportExtensions

Run Extension

path Parameters

id

required

string

query Parameters

catalog

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

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

Run Existing Extension Links

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

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

Run Extension Possible Matches

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

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

Run Extension Options

path Parameters

id required	string
field required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

	object or null
search	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

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

RealTimeExtensions

Run All Real Time Extensions

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.0

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

Response samples

200
400

Content type

application/json; x-api-version=3.0

{"error": "string",
"success": true,
"items": [{"id": "string",
"vendors": [{"vendorName": "string",
"vendorPartNumber": "string",
"active": true,
"inStock": 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"
}
]
}
]
}
],
"warning": "string"
}

Run Real Time Extension

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.0

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

Response samples

200
400

Content type

application/json; x-api-version=3.0

{"error": "string",
"success": true,
"items": [{"vendorPartNumber": "string",
"active": true,
"inStock": true,
"onHand": 0,
"manufacturerPartNumber": "string",
"description": "string",
"cost": 0,
"error": "string",
"status": "string",
"inStockDate": "2019-08-24T14:15:22Z",
"newMatch": true,
"warehouses": [{"warehouse": "string",
"onHand": 0,
"inStockDate": "2019-08-24T14:15:22Z"
}
],
"internalId": "string",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "string"
}
]
}

RecommendationExtensions

Run Recommendation Extension

path Parameters

extension

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.0

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

Response samples

200
404

Content type

application/json; x-api-version=3.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

path Parameters

extension

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

file	string or null
fileName	string or null
type	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

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

Response samples

200
404

Content type

application/json; x-api-version=3.0

{"url": "string"
}

InstalledExtensions

Get Installed Extensions

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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,
"hash": "string",
"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,
"hashable": true,
"fieldFilter": {"filterType": "string",
"target": "string",
"value": "string"
},
"step": "string"
}
],
"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,
"hashable": true,
"fieldFilter": {"filterType": "string",
"target": "string",
"value": "string"
},
"step": "string"
}
],
"allowFileLibrary": true,
"allowUnmatchedLookup": true,
"steps": [{"order": 0,
"name": "string",
"requiredFields": ["string"
],
"identifier": "string",
"flag": "string",
"showItems": true
}
],
"subOrganization": "string"
}
]

Update Installed Extension

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.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
400

Content type

application/json; x-api-version=3.0

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

Delete Installed Extension

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Disable Installed Extension

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Enable Installed Extension

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Get Extension Logs

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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
}
],
"total": 0
}

Get Extension Library Files

path Parameters

id

required

string

query Parameters

enabledOnly

boolean

Default: false

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"items": [{"id": "string",
"user": "string",
"name": "string",
"notes": "string",
"version": 0,
"enabled": true,
"extensionId": "string"
}
],
"total": 0
}

Upload Extension Library File

path Parameters

id

required

string

query Parameters

userLevel

boolean

Default: false

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

file	string or null
fileName	string or null
type	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

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

Disable Extension Library File

path Parameters

id required	string
fileId required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Enable Extension Library File

path Parameters

id required	string
fileId required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Get Extension Unmatched Products

path Parameters

id

required

string

query Parameters

page	integer <int32> Default: 1

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"items": [{"id": "string",
"extensionId": "string",
"sourceType": "string",
"source": "string",
"sourceId": "string",
"created": "2019-08-24T14:15:22Z",
"name": "string",
"manufacturerPartNumber": "string",
"manufacturer": "string",
"status": "string",
"msrp": 0,
"upc": "string",
"cost": 0,
"onHand": 0,
"inStock": true,
"active": true,
"possibleMatches": [{"acId": "string",
"name": "string",
"manufacturerPartNumber": "string",
"manufacturer": "string"
}
],
"confirmedMatch": "string",
"confirmedCreateNew": true,
"costMessage": "string",
"description": "string",
"category": "string",
"subCategory": "string"
}
],
"total": 0
}

Confirm Extension Unmatched Product

path Parameters

extensionId required	string
matchId required	string
catalog required	string
productId required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Create Extension Unmatched Product

path Parameters

extensionId required	string
matchId required	string
catalog required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

AvailableExtensions

Get Available Extensions

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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,
"hashable": true,
"fieldFilter": {"filterType": "string",
"target": "string",
"value": "string"
},
"step": "string"
}
],
"mapToVendor": true,
"allowUnmatchedLookup": true,
"steps": [{"order": 0,
"name": "string",
"requiredFields": ["string"
],
"identifier": "string",
"flag": "string",
"showItems": true
}
]
}
]

Get Extension

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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,
"hashable": true,
"fieldFilter": {"filterType": "string",
"target": "string",
"value": "string"
},
"step": "string"
}
],
"mapToVendor": true,
"allowUnmatchedLookup": true,
"steps": [{"order": 0,
"name": "string",
"requiredFields": ["string"
],
"identifier": "string",
"flag": "string",
"showItems": true
}
]
}

Validate Extension

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.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=3.0

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

Get Import Sample

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

object or null

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

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

Install Extension

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.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=3.0

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

Get Install Extension Options

path Parameters

id required	string
field required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

KeyAuth

Generate API Key

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

name	string or null
keyType	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

{"id": "string",
"success": true,
"error": "string",
"key": "string"
}

Get API Keys

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Get API Key Types

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Disable API Key

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Enable API Key

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Delete API Key

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Generate Session Key

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

organization	string or null
key	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"organization": "string",
"key": "string"
}

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Get SessionKey

query Parameters

sessionKey

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"expiration": "2019-08-24T14:15:22Z",
"isSubmittable": true
}

Submit Punchout Workspace

path Parameters

id

required

string

header Parameters

x-session-key required	string
x-api-version	string Default: 3.0 The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"postUrl": "string",
"data": "string"
}

Submit CW CPQ Workspace

path Parameters

id

required

string

header Parameters

x-session-key required	string
x-api-version	string Default: 3.0 The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"postUrl": "string",
"data": "string"
}

Search

query Parameters

catalog	string
manufacturerPartNumber	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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)
tags	Array of strings or null
userTags	Array of strings or null
productLines	Array of strings or null
manufacturerPartNumber	string or null
overrideUsername	string or null
overrideOrganization	string or null
sortVendor	string or null
sortDirection	string or null
inStockVendors	Array of strings or null
inCatalogVendors	Array of strings or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.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
}
],
"tags": ["string"
],
"userTags": ["string"
],
"productLines": ["string"
],
"manufacturerPartNumber": "string",
"overrideUsername": "string",
"overrideOrganization": "string",
"sortVendor": "string",
"sortDirection": "string",
"inStockVendors": ["string"
],
"inCatalogVendors": ["string"
]
}

Response samples

200

Content type

application/json; x-api-version=3.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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
}
],
"total": 0,
"searchLogId": "string",
"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

query Parameters

catalog	string
manufacturerPartNumber	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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)
tags	Array of strings or null
userTags	Array of strings or null
productLines	Array of strings or null
manufacturerPartNumber	string or null
overrideUsername	string or null
overrideOrganization	string or null
sortVendor	string or null
sortDirection	string or null
inStockVendors	Array of strings or null
inCatalogVendors	Array of strings or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.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
}
],
"tags": ["string"
],
"userTags": ["string"
],
"productLines": ["string"
],
"manufacturerPartNumber": "string",
"overrideUsername": "string",
"overrideOrganization": "string",
"sortVendor": "string",
"sortDirection": "string",
"inStockVendors": ["string"
],
"inCatalogVendors": ["string"
]
}

Response samples

200

Content type

application/json; x-api-version=3.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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
}
],
"total": 0,
"searchLogId": "string"
}

Metadata

query Parameters

catalog

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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

query Parameters

search required	string
catalog	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"manufacturers": ["string"
],
"categories": {"property1": ["string"
],
"property2": ["string"
]
},
"manufacturerPartNumbers": ["string"
],
"productNames": ["string"
],
"productLines": ["string"
],
"subCategories": {"property1": {"property1": ["string"
],
"property2": ["string"
]
},
"property2": {"property1": ["string"
],
"property2": ["string"
]
}
},
"tags": ["string"
],
"userTags": ["string"
]
}

Count

query Parameters

catalog	string
manufacturerPartNumber	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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)
tags	Array of strings or null
userTags	Array of strings or null
productLines	Array of strings or null
manufacturerPartNumber	string or null
overrideUsername	string or null
overrideOrganization	string or null
sortVendor	string or null
sortDirection	string or null
inStockVendors	Array of strings or null
inCatalogVendors	Array of strings or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.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
}
],
"tags": ["string"
],
"userTags": ["string"
],
"productLines": ["string"
],
"manufacturerPartNumber": "string",
"overrideUsername": "string",
"overrideOrganization": "string",
"sortVendor": "string",
"sortDirection": "string",
"inStockVendors": ["string"
],
"inCatalogVendors": ["string"
]
}

Response samples

200

Content type

application/json; x-api-version=3.0

{"count": 0,
"catalog": "string"
}

Search History

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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
}
],
"tags": ["string"
],
"userTags": ["string"
],
"productLines": ["string"
],
"catalog": "string",
"username": "string"
}
],
"total": 0
}

Favorites

Get Favorites

query Parameters

catalog

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
}
],
"total": 0,
"searchLogId": "string",
"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

path Parameters

id

required

string

query Parameters

catalog

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

company	boolean
user	boolean

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

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

Remove Company Favorite

path Parameters

id

required

string

query Parameters

catalog

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Remove User Favorite

path Parameters

id

required

string

query Parameters

catalog

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Workspaces

Get Workspaces

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

{"items": [{"id": "string",
"name": "string",
"active": true,
"defaultMarkup": 0,
"defaultListDiscount": 0,
"defaultSource": "string",
"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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
},
"details": {"quantity": 0,
"price": 0,
"markup": 0,
"listDiscount": 0,
"source": "string",
"isTaxable": true,
"taxRate": 0,
"taxCode": "string",
"priceLevelPartNumber": "string"
}
}
],
"lastAccessed": "2019-08-24T14:15:22Z",
"isTemplate": true,
"defaultTaxable": true,
"defaultTaxCode": "string",
"defaultTaxRate": 0,
"session": "string",
"companyId": "string",
"companyName": "string"
}
],
"total": 0
}

Create Workspace

query Parameters

name

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Get Workspace Templates

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

{"items": [{"id": "string",
"name": "string",
"active": true,
"defaultMarkup": 0,
"defaultListDiscount": 0,
"defaultSource": "string",
"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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
},
"details": {"quantity": 0,
"price": 0,
"markup": 0,
"listDiscount": 0,
"source": "string",
"isTaxable": true,
"taxRate": 0,
"taxCode": "string",
"priceLevelPartNumber": "string"
}
}
],
"lastAccessed": "2019-08-24T14:15:22Z",
"isTemplate": true,
"defaultTaxable": true,
"defaultTaxCode": "string",
"defaultTaxRate": 0,
"session": "string",
"companyId": "string",
"companyName": "string"
}
],
"total": 0
}

Create Workspace From Template

path Parameters

name required	string
template required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400
404

Content type

application/json; x-api-version=3.0

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

Get Workspace

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"id": "string",
"name": "string",
"active": true,
"defaultMarkup": 0,
"defaultListDiscount": 0,
"defaultSource": "string",
"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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
},
"details": {"quantity": 0,
"price": 0,
"markup": 0,
"listDiscount": 0,
"source": "string",
"isTaxable": true,
"taxRate": 0,
"taxCode": "string",
"priceLevelPartNumber": "string"
}
}
],
"lastAccessed": "2019-08-24T14:15:22Z",
"isTemplate": true,
"defaultTaxable": true,
"defaultTaxCode": "string",
"defaultTaxRate": 0,
"session": "string",
"companyId": "string",
"companyName": "string"
}

Update Workspace

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

id	string or null
name	string or null
active	boolean or null
defaultMarkup	number or null <double>
defaultListDiscount	number or null <double>
defaultSource	string or null
	Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.WorkspaceItem)
lastAccessed	string or null <date-time>
isTemplate	boolean or null
defaultTaxable	boolean or null
defaultTaxCode	string or null
defaultTaxRate	number or null <double>
session	string or null
companyId	string or null
companyName	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"id": "string",
"name": "string",
"active": true,
"defaultMarkup": 0,
"defaultListDiscount": 0,
"defaultSource": "string",
"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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
},
"details": {"quantity": 0,
"price": 0,
"markup": 0,
"listDiscount": 0,
"source": "string",
"isTaxable": true,
"taxRate": 0,
"taxCode": "string",
"priceLevelPartNumber": "string"
}
}
],
"lastAccessed": "2019-08-24T14:15:22Z",
"isTemplate": true,
"defaultTaxable": true,
"defaultTaxCode": "string",
"defaultTaxRate": 0,
"session": "string",
"companyId": "string",
"companyName": "string"
}

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Delete Workspace

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Get Recent Workspaces

query Parameters

numberOfWorkspaces

integer <int32>

Default: 5

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

{"items": [{"id": "string",
"name": "string",
"active": true,
"defaultMarkup": 0,
"defaultListDiscount": 0,
"defaultSource": "string",
"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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
},
"details": {"quantity": 0,
"price": 0,
"markup": 0,
"listDiscount": 0,
"source": "string",
"isTaxable": true,
"taxRate": 0,
"taxCode": "string",
"priceLevelPartNumber": "string"
}
}
],
"lastAccessed": "2019-08-24T14:15:22Z",
"isTemplate": true,
"defaultTaxable": true,
"defaultTaxCode": "string",
"defaultTaxRate": 0,
"session": "string",
"companyId": "string",
"companyName": "string"
}
],
"total": 0
}

Get Workspace Items

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

{"items": [{"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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
},
"details": {"quantity": 0,
"price": 0,
"markup": 0,
"listDiscount": 0,
"source": "string",
"isTaxable": true,
"taxRate": 0,
"taxCode": "string",
"priceLevelPartNumber": "string"
}
}
],
"total": 0
}

Remove Multiple Workspace Items

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

items

Array of strings or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"items": ["string"
]
}

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Update Workspace Item

path Parameters

id required	string
itemId required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

quantity	number or null <double>
price	number or null <double>
markup	number or null <double>
listDiscount	number or null <double>
source	string or null
isTaxable	boolean or null
taxRate	number or null <double>
taxCode	string or null
priceLevelPartNumber	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"quantity": 0,
"price": 0,
"markup": 0,
"listDiscount": 0,
"source": "string",
"isTaxable": true,
"taxRate": 0,
"taxCode": "string",
"priceLevelPartNumber": "string"
}

Response samples

200

Content type

application/json; x-api-version=3.0

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

Remove Workspace Item

path Parameters

id required	string
itemId required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Add Items From Workspace Template

path Parameters

sourceId required	string
destinationId required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"items": [{"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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
},
"details": {"quantity": 0,
"price": 0,
"markup": 0,
"listDiscount": 0,
"source": "string",
"isTaxable": true,
"taxRate": 0,
"taxCode": "string",
"priceLevelPartNumber": "string"
}
}
],
"total": 0
}

Get Workspace Extension Fields

path Parameters

id required	string
extension required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

{"items": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"total": 0
}

Get All Workspace Extension Fields

query Parameters

workspace

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

{"items": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"total": 0
}

Get Workspace Extension Field

path Parameters

id required	string
extension required	string
field required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
400

Content type

application/json; x-api-version=3.0

{"extensionId": "string",
"key": "string",
"value": "string"
}

Update Workspace Metadata

path Parameters

id required	string
extension required	string
field required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

value

string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"value": "string"
}

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Catalog

Get Catalogs

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Create Catalog

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

name	string or null
description	string or null
active	boolean
checkRealtime	boolean

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

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

Retrieve Products

path Parameters

catalog

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

ids	Array of strings or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"ids": ["string"
]
}

Response samples

200

Content type

application/json; x-api-version=3.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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
}
]

Create Product

path Parameters

catalog

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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 <date-time>
productLines	Array of strings or null
tags	Array of strings or null
userTags	Array of strings or null
source	string or null
	Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.PriceLevel)

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
}

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Get Product

path Parameters

catalog required	string
id required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
}

Update Product

path Parameters

catalog required	string
id required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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 <date-time>
productLines	Array of strings or null
tags	Array of strings or null
userTags	Array of strings or null
source	string or null
	Array of objects or null (AdaptiveCatalog.Api.Shared.Models.V_1._0.PriceLevel)

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.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",
"costMessage": "string",
"startQuantity": 0,
"endQuantity": 0,
"internalId": "string",
"vendorAttributes": {"property1": "string",
"property2": "string"
},
"priceLevelPartNumber": "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",
"company": "string"
}
],
"segment": "string",
"category": "string",
"subCategory": "string",
"extensionFields": [{"extensionId": "string",
"key": "string",
"value": "string"
}
],
"favorite": {"company": true,
"user": true
},
"updatedBy": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"productLines": ["string"
],
"tags": ["string"
],
"userTags": ["string"
],
"source": "string",
"priceLevels": [{"partNumber": "string",
"name": "string",
"startQuantity": 0,
"endQuantity": 0
}
]
}

Update Extensions Field

path Parameters

catalog required	string
id required	string
extension required	string
field required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

value

string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"value": "string"
}

Response samples

200
404

Content type

application/json; x-api-version=3.0

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

Get Product Specific Extension Fields

path Parameters

catalog required	string
id required	string
extension required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
404

Content type

application/json; x-api-version=3.0

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

Get Extension Fields

path Parameters

catalog required	string
id required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
404

Content type

application/json; x-api-version=3.0

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

Add Extension Link

path Parameters

catalog required	string
id required	string
extensionId required	string
externalId required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Get Product Notes

path Parameters

catalog required	string
id required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"userNote": {"text": "string",
"username": "string",
"productId": "string",
"catalog": "string",
"organization": "string"
},
"companyNote": {"text": "string",
"username": "string",
"productId": "string",
"catalog": "string",
"organization": "string"
}
}

Update Product Notes

path Parameters

catalog required	string
id required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

userNote	string or null
companyNote	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"userNote": "string",
"companyNote": "string"
}

Response samples

200
404

Content type

application/json; x-api-version=3.0

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

Get Insights

path Parameters

catalog required	string
id required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
404

Content type

application/json; x-api-version=3.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

path Parameters

catalog required	string
id required	string
workspace required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

quantity	number or null <double>
price	number or null <double>
markup	number or null <double>
listDiscount	number or null <double>
source	string or null
isTaxable	boolean or null
taxRate	number or null <double>
taxCode	string or null
priceLevelPartNumber	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"quantity": 0,
"price": 0,
"markup": 0,
"listDiscount": 0,
"source": "string",
"isTaxable": true,
"taxRate": 0,
"taxCode": "string",
"priceLevelPartNumber": "string"
}

Response samples

200
404

Content type

application/json; x-api-version=3.0

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

Copy Product To Catalog

path Parameters

catalog required	string
id required	string
targetCatalog required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Get Product Logs

path Parameters

catalog required	string
id required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"items": [{"catalog": "string",
"productId": "string",
"updatedBy": "string",
"timestamp": "2019-08-24T14:15:22Z",
"fieldsUpdated": ["string"
]
}
],
"total": 0
}

Update Product Tags

path Parameters

productId required	string
catalog required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

Array

string

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

["string"
]

Response samples

200

Content type

application/json; x-api-version=3.0

true

Update Product Tags (User)

path Parameters

productId required	string
catalog required	string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

Array

string

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

["string"
]

Response samples

200

Content type

application/json; x-api-version=3.0

true

Settings

Delete Company (v2.0)

path Parameters

companyId

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
404

Content type

application/json; x-api-version=3.0

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

Get Company By Id

path Parameters

companyId

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"organization": "string",
"username": "string",
"companyName": "string",
"companyIdentifier": "string",
"contact": {"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string"
},
"address": {"address1": "string",
"address2": "string",
"address3": "string",
"postalCodeZip": "string",
"city": "string",
"stateTerritory": "string",
"country": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"id": "string",
"lastAccessed": "2019-08-24T14:15:22Z"
}

Get Company Workspace Count (v2.0)

path Parameters

companyId

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

0

0

Get Organizations

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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,
"subOrganizationsEnabled": true,
"country": "string"
}
]
}

Get Organization Details

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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,
"subOrganizationsEnabled": true,
"country": "string"
}

Update Organization

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

name	string or null
logo	string or null
country	string or null
defaultCatalog	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"name": "string",
"logo": "string",
"country": "string",
"defaultCatalog": "string"
}

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Save User to Organization

path Parameters

uname

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.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=3.0

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

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Remove User from Organization

path Parameters

uname

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Get Permissions

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Get Columns

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Save Columns

path Parameters

page

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

Array

string

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

["string"
]

Response samples

200

Content type

application/json; x-api-version=3.0

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

Get Product Reporting Logs

query Parameters

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

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"items": [{"catalog": "string",
"productId": "string",
"updatedBy": "string",
"timestamp": "2019-08-24T14:15:22Z",
"fieldsUpdated": ["string"
]
}
],
"total": 0
}

Get Tax Codes

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"taxCodes": [{"name": "string",
"id": "string",
"description": "string",
"rate": 0,
"active": true,
"source": "string",
"sourceId": "string"
}
]
}

Add or Update Tax Code

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

name	string or null
id	string or null
description	string or null
rate	number or null <double>
active	boolean or null
source	string or null
sourceId	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"name": "string",
"id": "string",
"description": "string",
"rate": 0,
"active": true,
"source": "string",
"sourceId": "string"
}

Response samples

200
404

Content type

application/json; x-api-version=3.0

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

Delete Tax Code

path Parameters

taxCodeId

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200
404

Content type

application/json; x-api-version=3.0

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

Search Companies

path Parameters

searchTerm

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

[{"organization": "string",
"username": "string",
"companyName": "string",
"companyIdentifier": "string",
"contact": {"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string"
},
"address": {"address1": "string",
"address2": "string",
"address3": "string",
"postalCodeZip": "string",
"city": "string",
"stateTerritory": "string",
"country": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"id": "string",
"lastAccessed": "2019-08-24T14:15:22Z"
}
]

Add or Update Company

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

organization	string or null
username	string or null
companyName	string or null
companyIdentifier	string or null
	object (AdaptiveCatalog.Api.Shared.Models.V_2._0.CompanyContact)
	object (AdaptiveCatalog.Api.Shared.Models.V_2._0.CompanyAddress)
createDate	string or null <date-time>
id	string or null
lastAccessed	string <date-time>

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"organization": "string",
"username": "string",
"companyName": "string",
"companyIdentifier": "string",
"contact": {"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"phoneNumber": "string"
},
"address": {"address1": "string",
"address2": "string",
"address3": "string",
"postalCodeZip": "string",
"city": "string",
"stateTerritory": "string",
"country": "string"
},
"createDate": "2019-08-24T14:15:22Z",
"id": "string",
"lastAccessed": "2019-08-24T14:15:22Z"
}

Response samples

200
404

Content type

application/json; x-api-version=3.0

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

Get Sub Organizations

query Parameters

page	integer <int32>
pageSize	integer <int32>

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

{"items": [{"parentOrganization": "string",
"name": "string",
"id": "string",
"logo": "string",
"country": "string"
}
],
"total": 0
}

Create Sub Organization

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

name	string or null
logo	string or null
country	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"name": "string",
"logo": "string",
"country": "string"
}

Response samples

200
400

Content type

application/json; x-api-version=3.0

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

Update Sub Organization

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

name	string or null
logo	string or null
country	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"name": "string",
"logo": "string",
"country": "string"
}

Response samples

200
400
404

Content type

application/json; x-api-version=3.0

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

Reporting

Search Usage

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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

query Parameters

includeDismissed	boolean Default: false
fetchUpdates	boolean Default: true

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.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"
}
],
"total": 0
}

Review Task

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Dismiss Task

path Parameters

id

required

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Responses

Response samples

200

Content type

application/json; x-api-version=3.0

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

Files

Save Product Image

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

file	string or null
fileName	string or null
type	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

{"url": "string"
}

Delete Custom Product Images

path Parameters

productId

required

string

query Parameters

catalog

string

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

customImageIds

Array of strings or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

{"customImageIds": ["string"
]
}

Upload Image

header Parameters

x-api-version

string

Default: 3.0

The requested API version

Request Body schema: application/json; x-api-version=3.0

file	string or null
fileName	string or null
type	string or null

Responses

Request samples

Payload

Content type

application/json; x-api-version=3.0

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

Response samples

200

Content type

application/json; x-api-version=3.0

{"url": "string"
}