Download OpenAPI specification:Download
Contains functionality around target market.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Retrieves allowed attributes and values for a given definition.
| definitionKey required | string Definition Key |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "name": "string",
- "nameResourceKey": "string",
- "definition": [
- {
- "attribute": {
- "id": 0,
- "name": "string",
- "nameResourceKey": "string",
- "key": "string",
- "isMandatory": true
}, - "values": [
- {
- "id": 0,
- "name": "string",
- "nameResourceKey": "string",
- "key": "string"
}
]
}
]
}Retrieves attribute and value pairs saved for a specific entity.
| entityUid required | string <uuid> The entity UID |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "definitionKey": "string",
- "instance": [
- {
- "attributeId": 0,
- "valueIds": [
- 0
]
}
]
}Sets a list of attribute and value pairs for a specific entity. More than one value may be saved for a specific attribute. Only attributes which are in the specified target market may be passed. Only values associated with the attribute may be passed for a specific attribute.
| entityUid required | string <uuid> Entity id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
| definitionKey | string Nullable |
| instance | Array of objects (TargetMarketInstanceRequest) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "definitionKey": "DefinitionKey",
- "instance": [
- {
- "attributeId": 1,
- "valueIds": [
- 1,
- 2
]
}, - {
- "attributeId": 2,
- "valueIds": [
- 2,
- 3
]
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Searches instances based on a common definition. Only attributes which are in the specified target market may be passed. Only values associated with the attribute may be passed for a specific attribute.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
| definitionKey | string Nullable |
| searchParameters | Array of objects (TargetMarketInstanceSearchParametersRequest) Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "definitionKey": "DefinitionKey",
- "searchParameters": [
- {
- "attributeId": 1,
- "valueId": 1
}, - {
- "attributeId": 2,
- "valueId": 2
}
]
}{- "results": [
- "5ba3a744-6c7f-4fe7-9607-b6b9f9a410f5",
- "b6491c49-8795-447a-94e7-41bc14717b30",
- "d6c65aae-30fd-4214-bbaf-e59d5a627aac"
]
}