A Wholesaler Catalog contains products listed by the Wholesaler's own internal product codes. These can be attached to specific versions of products and so can therefore be different to the version of the product held as the latest version in the main data pool.
List Catalog Products
get
Get a list of products from a Wholesaler catalog. I.e. products that have a wholesaler product code attached.
Authorizations
AuthorizationstringRequired
You can retrieve your token by visiting your dashboard and clicking Manage API tokens.
Path parameters
wholesalerintegerRequired
The Wholesaler ID.
Example: 1234
Query parameters
sortstringOptional
Sort results by cataloged_at, changed_at, manufacturer_product_name, product_code. Prefixing with a hyphen will reverse order.
Defaults to '-changed_at'.
Example: -cataloged_at
filter[manufacturer]integerOptional
Filter by ID of manufacturer.
Example: 23
filter[brand]integerOptional
Filter by ID of brand.
Example: 2
filter[label]integerOptional
Filter by ID of label.
Example: 3
filter[changed_at]stringOptional
Filter by date of product change equal to (eq:), greater than (gt:) or less than a date (lt:).
Example: gt:2024-10-12
filter[cataloged_at]stringOptional
Filter by date of product cataloged_at or product changed_at, equal to (eq:), greater than (gt:) or less than a date (lt:).
Example: gt:2024-10-12
pageintegerOptional
Page of result set.
Example: 1
limitintegerOptional
Number of records per page. Example 10
Example: 9
Responses
200Success
application/json
Responseone of
or
get
/v2/catalogs/{wholesaler}
200Success
Get Catalog Product
get
Get a product using the Wholesaler product code.
This will return the specific version of the product to which the product code is attached in the Wholesaler's catalog.
Note: You should url encode the wholesaler code. Wholesalers use various characters in their codes that can cause issues if not encoded when calling this endpoint.
Authorizations
AuthorizationstringRequired
You can retrieve your token by visiting your dashboard and clicking Manage API tokens.
Path parameters
wholesalerintegerRequired
The Wholesaler ID.
Example: 1234
codestringRequired
The Wholesaler code for the product. You should url encode this string for this endpoint.
Example: 124ABC
Query parameters
outputstringOptional
Sets an alternative output format to raw, flat or ungroup.
Example: output=ungroup
Responses
200Success
application/json
404Error
application/json
get
/v2/catalogs/{wholesaler}/{code}
Get Catalog Product PDF
get
Download Catalog Product PDF.
This will return the Erudus PDF specification of the specific version of the product to which the product code is attached in the Wholesaler's catalog.
Authorizations
AuthorizationstringRequired
You can retrieve your token by visiting your dashboard and clicking Manage API tokens.
Path parameters
wholesalerintegerRequired
The Wholesaler ID.
Example: 1234
codestringRequired
The Wholesaler code for the product.
Example: 124ABC
Responses
401Error
application/json
get
/v2/catalogs/{wholesaler}/pdf/{code}
401Error
Add Product Code to Catalog
post
Add a Wholesaler Product Code for Erudus product so that it appears in the system as part of a Wholesaler Product Catalog.
If you specify a version (e.g. "1.2") the specific version of the product wil be added to your Catalog against the code supplied.
Authorizations
AuthorizationstringRequired
You can retrieve your token by visiting your dashboard and clicking Manage API tokens.
Path parameters
wholesalerintegerRequired
The Wholesaler ID.
Example: 1234
productstringRequiredExample: molestiae
erudusIdstringRequired
The erudus ID for the product.
Example: c46fe2febd8e41529386da79d920ce92
Body
product_codestringRequired
A new wholesaler product code.
Example: AS234T
versionstringOptional
The specific version of the product.
Example: 2.1
component_uuidstringOptional
The uuid for the inner component if appropriate.
Example: c46fe2febd8e41529386da79d920ce92
Responses
201
Success
application/json
403
Action unauthorised.
application/json
422
Data incorrect or product/version not found.
application/json
post
/v2/catalogs/{wholesaler}/{product}
Remove Product Code from Catalog
delete
Remove a Wholesaler Product Code from catalog.
Authorizations
AuthorizationstringRequired
You can retrieve your token by visiting your dashboard and clicking Manage API tokens.
Path parameters
wholesalerintegerRequired
The Wholesaler ID.
Example: 1234
productstringRequiredExample: qui
codestringRequiredExample: praesentium
erudusIDstringRequired
The erudus ID for the product.
Example: c46fe2febd8e41529386da79d920ce92
product_codestringRequired
Optional parameter. Wholesaler product code to be removed.
Example: {"summary":"When the value is omitted","value":""}
