x-api-key
This is your API Key that needs to be sent with every request.
x-user api-key
This is the user auth_key which can be obtained from the /api/v2/system/security/login endpoint and needs to be sent with every endpoint that has a KEY icon against it.
Get categories
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| region_uuid | string | false | Region | |
| search | string | false | Search term | |
| sort | string | false | Sort | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Get collections
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | string | false | Search term | |
| user_uuid | string | false | User | |
| type | string | false | curated_collection|community_collection | |
| sort | string | false | Sort |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| pageUuid |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Download document
| Name | Requirement | Type | Description |
|---|---|---|---|
| uuid | [a-f0-9\-]{36} |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| ip | string | false | IP for the user downloading the document |
| Status Code | Description |
|---|---|
| 200 |
|
Get documents
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| uuids[] | array | false | Filter on partner contact | |
| region_uuid | string | false | Region | |
| manufacturer_uuid | string | false | Manufacturer | |
| document_type | string | false | Document type | |
| search | string | false | Search term | |
| sort | string | false | Sort | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Get product downloads
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| manufacturer_uuid | array | false | Filter on manufacturer, doesn't work if your key is restricted by manufacturer | |
| product_uuid | array | false | Filter on product | |
| date_from | string | false | Date to | |
| date_to | string | false | Date from | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Get product overview
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| manufacturer_uuid | array | false | Filter on manufacturer, doesn't work if your key is restricted by manufacturer | |
| product_uuid | array | false | Filter on product | |
| date_from | string | false | Date to | |
| date_to | string | false | Date from |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| manufacturerUserUuid | [a-f0-9\-]{36} |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | string | false | comment | new_rating | new_follower | resource | product_download | product_added_to_collection | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| manufacturerUserUuid | [a-f0-9\-]{36} |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | string | false | Search term | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Get manufacturers
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| region_uuid | string | false | Region | |
| user_uuid | string | false | User | |
| search | string | false | Search term | |
| updated_at | string | false | YYYY-MM-DD | |
| sort | string | false | Sort | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | string | false | Search term | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| manufacturerUserUuid | [a-f0-9\-]{36} |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | string | false | Search term | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Partner Document Download
| Name | Requirement | Type | Description |
|---|---|---|---|
| uuid | [a-f0-9\-]{36} |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| download | object (DownloadType) | true | ||
| download[firstName] | string | true | First Name | |
| download[lastName] | string | true | Last Name | |
| download[email] | string | true | Email address | |
| download[isSharingDetails] | boolean | false | Share details with manufacturers | |
| download[ip] | string | false | IP for the user downloading the object | |
| download[city] | string | false | City of the user downloading the object | |
| download[region] | string | false | Region of the user downloading the object | |
| download[country] | string | false | Country of the user downloading the object |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
Partner Object Download
| Name | Requirement | Type | Description |
|---|---|---|---|
| uuid | [a-f0-9\-]{36} |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| download | object (DownloadType) | true | ||
| download[firstName] | string | true | First Name | |
| download[lastName] | string | true | Last Name | |
| download[email] | string | true | Email address | |
| download[isSharingDetails] | boolean | false | Share details with manufacturers | |
| download[ip] | string | false | IP for the user downloading the object | |
| download[city] | string | false | City of the user downloading the object | |
| download[region] | string | false | Region of the user downloading the object | |
| download[country] | string | false | Country of the user downloading the object |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
Get portal products
| Name | Requirement | Type | Description |
|---|---|---|---|
| uuid | [a-f0-9\-]{36} |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| include_user_content | boolean | false | Set to true to include user content, False is default | |
| region_uuid | string | false | Region | |
| manufacturer_uuid | string | false | Manufacturer | |
| category_uuid | string | false | Category | |
| search | string | false | Search term | |
| updated_at | string | false | YYYY-MM-DD | Date |
| object_last_updated_at | string | false | YYYY-MM-DD | Date |
| status | string | false | live|inactive | Default: live |
| sort | string | false | Sort | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Download object
| Name | Requirement | Type | Description |
|---|---|---|---|
| uuid | [a-f0-9\-]{36} |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| ip | string | false | IP for the user downloading the object |
| Status Code | Description |
|---|---|
| 200 |
|
Get products
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| uuids[] | array | false | Filter on partner contact | |
| include_user_content | boolean | false | Set to true to include user content, False is default | |
| region_uuid | string | false | Region | |
| manufacturer_uuid | string | false | Manufacturer | |
| category_uuid | string | false | Category | |
| search | string | false | Search term | |
| updated_at | string | false | YYYY-MM-DD | Date |
| object_last_updated_at | string | false | YYYY-MM-DD | Date |
| status | string | false | live|inactive | Default: live |
| sort | string | false | Sort | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Get quote enquiry listing
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| reference | string | false | Reference to filter by | |
| search | string | false | Search term | |
| status | string | false | Status | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Quote Enquiry
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| quote_enquiry | object (QuoteEnquiryType) | true | ||
| quote_enquiry[productUuid] | string | true | Product UUID | |
| quote_enquiry[reference] | string | true | Reference | |
| quote_enquiry[projectName] | string | false | Project Name | |
| quote_enquiry[location] | string | false | Location | |
| quote_enquiry[latitude] | string | false | Latitude | |
| quote_enquiry[longitude] | string | false | Longitude | |
| quote_enquiry[firstName] | string | true | First Name | |
| quote_enquiry[lastName] | string | true | Last Name | |
| quote_enquiry[email] | string | true | Email address | |
| quote_enquiry[telephone] | string | false | Telephone | |
| quote_enquiry[companyName] | string | false | Company Name | |
| quote_enquiry[quantity] | integer | true | Quantity | |
| quote_enquiry[notes] | string | true | Notes | |
| quote_enquiry[url] | string | false | URL |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 403 |
|
Register
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| register | object (RegisterType) | true | ||
| register[firstName] | string | true | First Name | |
| register[lastName] | string | true | Last Name | |
| register[email] | string | true | Email address | |
| register[password] | string | true | Password | |
| register[isSharingDetails] | boolean | false | Share details with manufacturers |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | string | false | product_updates | connection_updates | resource_updates | forum_updates | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| search | string | false | Search term | |
| type | string | false | reward_centre_claimed | reward_centre_unclaimed | |
| tier | string | false | UUID of Tier | |
| up_to_tier_level | int | false | Up to tier level | |
| items_per_page | int | false | Items per page | |
| page_number | int | false | Page number |
| Status Code | Description |
|---|---|
| 200 |
|
Documentation auto-generated on Sun, 19 May 24 18:10:36 +0100