Provides services for requesting brand information.
Fetch Brand Information
Provides information regarding a brand (found through a given ID, name or supplier number), if the brand is available in the portal.
GET
JSON
/portals/api/v1/brand/info
Parameters
| Name | Description | Example | |
|---|---|---|---|
|
accessToken
Required
|
Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. | d0765f518ff0cab426dbbd6d467c9967 | |
|
brand
Required
|
Brand identifier: can be the brand ID, name, or supplier number. | ST | |
|
portal
Required
|
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. | 9999999 | |
|
user
Required
|
User name | john.doe | |
| language | Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. | de | |
| roles | Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. | Heating,Electronics,Top-Customer | |
Responses
| Description | Example |
|---|---|
|
200
Successful response. Returns an empty object if no matching brand is found in the portal.
Content-Type:
application/json
|
{
"id": "ABC123",
"name": "ST Sanitär",
"supplierNumber": "ST",
"supplierNumbers": "ST",
"mediumImageUrl": "https://oxomi.com/dasd/p/tenants/.../.../....jpg",
"manufacturerName": "ST Sanitary Inc",
"manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
"manufacturerElectronicAddress": "st-sanitary@oxomi.local",
"distributorName": "ST Sanitär Europa GmbH",
"distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
"distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
}
|
|
400
Missing parameter or malformed request
Content-Type:
application/json
|
{
"success": false,
"error": true,
"message": "The parameter {missingParameter} must be filled."
}
|
|
401
Authentication required but none provided
Content-Type:
application/json
|
|
|
403
Invalid authentication or missing permission
Content-Type:
application/json
|
|
|
404
Resource not found
Content-Type:
application/json
|
|
|
405
Incorrect request method, e.g. GET instead of POST
Content-Type:
application/json
|
|
|
500
Unexpected server-side error
Content-Type:
application/json
|