Motives are the basic visual building blocks of designs. Users can choose motives from the platform library or upload their own. Each motive can have localizations for different languages, and its image can be retrieved in various sizes and formats.
/accounts/{accountId}/shops/{shopId}/motives
Create a new motive. The motive is created within the specified shop. After creation, upload an image file using the bitmap or vector upload endpoints.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
Motive | the motive data including name and type |
application/xml |
Motive |
| Code | Condition |
|---|---|
| 200 | the motive was created successfully |
| 400 | validation failed (e.g., missing required fields) |
| 404 | account or shop not found |
<motive>
<id>...</id>
<uuid>...</uuid>
<name>funny thing</name>
<type>VECTOR</type>
</motive>
{
"motive" : {
"id" : 12345,
"uuid" : "...",
"name" : "funny thing",
"type" : "VECTOR"
}
}
<motive>
<id>...</id>
<uuid>...</uuid>
<name>funny thing</name>
<type>VECTOR</type>
</motive>
{
"motive" : {
"id" : 12345,
"uuid" : "...",
"name" : "funny thing",
"type" : "VECTOR"
}
}
/accounts/{accountId}/shops/{shopId}/motives
List all motives for the shop. Returns a paginated list of motives belonging to the specified shop. Results can be narrowed down using a server-side filter.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop | |
filterId |
query | |
optional saved Filter.Motive ID; empty string for all | ||
page |
query | 0 |
int | zero-based page index | |
size |
query | 10 |
int | number of items per page |
| Code | Condition |
|---|---|
| 200 | paginated list of motives |
| 404 | account or shop not found |
<pagedData>
<records>...</records>
<totalElements>...</totalElements>
</pagedData>
{
"pagedData" : {
"records" : [ { }, { } ],
"totalElements" : 12345
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}
Get a single motive by its id.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the motive was successfully retrieved |
| 404 | motive not found for the given id |
<motive>
<id>...</id>
<uuid>...</uuid>
<name>funny thing</name>
<type>VECTOR</type>
</motive>
{
"motive" : {
"id" : 12345,
"uuid" : "...",
"name" : "funny thing",
"type" : "VECTOR"
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}
Update an existing motive.
Replaces the motive data with the values provided in the request body. Include the
current version field to prevent conflicts from concurrent modifications.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive to update | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
Motive | the updated motive data |
application/xml |
Motive |
| Code | Condition |
|---|---|
| 200 | the motive was updated successfully |
| 400 | validation failed (e.g., missing required fields or invalid values) |
| 404 | motive not found for the given id |
| 409 | version conflict due to concurrent modification |
<motive>
<id>...</id>
<uuid>...</uuid>
<name>funny thing</name>
<type>VECTOR</type>
</motive>
{
"motive" : {
"id" : 12345,
"uuid" : "...",
"name" : "funny thing",
"type" : "VECTOR"
}
}
<motive>
<id>...</id>
<uuid>...</uuid>
<name>funny thing</name>
<type>VECTOR</type>
</motive>
{
"motive" : {
"id" : 12345,
"uuid" : "...",
"name" : "funny thing",
"type" : "VECTOR"
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}
Delete a motive. Permanently removes the motive and all associated data (localizations, layer data, category assignments) from the shop.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive to delete | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 204 | the motive was deleted successfully |
| 404 | motive not found for the given id |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/motives/allCustomizable
List all customizable motives for the shop. Returns a paginated list of motives that support text customization. Results can be filtered by custom text content and narrowed using a server-side filter.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop | |
customText |
query | optional text string to search within customizable motive content | |||
filterId |
query | |
optional saved Filter.Motive ID; empty string for all | ||
page |
query | 0 |
int | zero-based page index | |
size |
query | 10 |
int | number of items per page |
| Code | Condition |
|---|---|
| 200 | paginated list of customizable motives |
| 404 | account or shop not found |
<pagedData>
<records>...</records>
<totalElements>...</totalElements>
</pagedData>
{
"pagedData" : {
"records" : [ { }, { } ],
"totalElements" : 12345
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/assignedCategories
List all category assignments for a motive. Returns a paginated list of categories that the specified motive is assigned to.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop | |
filterId |
query | |
optional saved Filter.MotiveAssignedToCategory ID; empty string for all | ||
page |
query | 0 |
int | zero-based page index | |
size |
query | 10 |
int | number of items per page |
| Code | Condition |
|---|---|
| 200 | paginated list of assigned categories |
| 404 | motive not found for the given id |
<pagedData>
<records>...</records>
<totalElements>...</totalElements>
</pagedData>
{
"pagedData" : {
"records" : [ { }, { } ],
"totalElements" : 12345
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/image
Get the rendered image of a motive.
Returns the motive image as a binary stream. The image can be resized using the
size, width, and height query parameters.
Layer colors and names can be overridden for preview purposes.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
motiveId |
required | path | int | the unique identifier of the motive | |
height |
query | -2 |
int | desired image height in pixels | |
isWhite |
query | false |
boolean | if true, renders the motive on a white background |
|
layerColors |
query | list of hex color values to apply to the motive layers | |||
layerNames |
query | list of layer names corresponding to the layer colors | |||
size |
query | -2 |
int | uniform scale factor; overrides width and height when set | |
techProfileId |
query | int | optional technology profile id to apply during rendering | ||
width |
query | -2 |
int | desired image width in pixels |
| Code | Condition |
|---|---|
| 200 | the motive image as binary data |
| 404 | motive not found for the given id |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/localizations
List all localizations for a motive. Returns a paginated list of localized versions (translations) of the specified motive.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop | |
filterId |
query | |
optional saved Filter.MotiveLocalized ID; empty string for all | ||
page |
query | 0 |
int | zero-based page index | |
size |
query | 10 |
int | number of items per page |
| Code | Condition |
|---|---|
| 200 | paginated list of motive localizations |
| 404 | motive not found for the given id |
<pagedData>
<records>...</records>
<totalElements>...</totalElements>
</pagedData>
{
"pagedData" : {
"records" : [ { }, { } ],
"totalElements" : 12345
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/technologies
List all print technologies for a motive. Returns a paginated list of print technology configurations assigned to the specified motive. Each entry defines how the motive is printed using a specific technology.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop | |
filterId |
query | |
optional saved Filter.MotivePrintTechnology ID; empty string for all | ||
page |
query | 0 |
int | zero-based page index | |
size |
query | 10 |
int | number of items per page |
| Code | Condition |
|---|---|
| 200 | paginated list of motive print technologies |
| 404 | motive not found for the given id |
<pagedData>
<records>...</records>
<totalElements>...</totalElements>
</pagedData>
{
"pagedData" : {
"records" : [ { }, { } ],
"totalElements" : 12345
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/assignedCategories/{assignedCategoryId}
Get a single category assignment by its id.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
assignedCategoryId |
required | path | int | the unique identifier of the category assignment | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the category assignment was successfully retrieved |
| 404 | motive or category assignment not found for the given id |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
CategoryAssignedToMotive | |
application/xml |
CategoryAssignedToMotive |
<categoryAssignedToMotive>
<id>...</id>
<version>...</version>
<active>...</active>
<orderIndex>...</orderIndex>
<category>
<id>...</id>
<version>...</version>
<name>...</name>
<orderIndex>...</orderIndex>
<active>...</active>
<deleted>...</deleted>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</category>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</categoryAssignedToMotive>
{
"categoryAssignedToMotive" : {
"id" : 12345,
"version" : 12345,
"active" : true,
"orderIndex" : 12345,
"category" : {
"id" : 12345,
"version" : 12345,
"name" : "...",
"orderIndex" : 12345,
"active" : true,
"deleted" : true,
"rest" : [ { }, { } ]
},
"rest" : [ { }, { } ]
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/localizations/{localizationId}
Get a single motive localization by its id.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
localizationId |
required | path | int | the unique identifier of the localization | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the localization was successfully retrieved |
| 404 | motive or localization not found for the given id |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
MotiveLocalized | |
application/xml |
MotiveLocalized |
<motiveLocalized>
<id>...</id>
<name>funny thing</name>
<language>
<id>...</id>
<code>en</code>
<name>English</name>
</language>
</motiveLocalized>
{
"motiveLocalized" : {
"id" : 12345,
"name" : "funny thing",
"language" : {
"id" : 12345,
"code" : "en",
"name" : "English"
}
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/technologies/{motivePrintTechnologyId}
Get a single motive print technology by its id.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive | |
motivePrintTechnologyId |
required | path | int | the unique identifier of the motive print technology | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the motive print technology was successfully retrieved |
| 404 | motive or print technology not found for the given id |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
MotivePrintTechnology | |
application/xml |
MotivePrintTechnology |
<motivePrintTechnology>
<id>...</id>
<active>...</active>
<printTechnology>
<id>...</id>
<version>...</version>
<name>...</name>
<orderIndex>...</orderIndex>
<active>...</active>
<vectorEnabled>...</vectorEnabled>
<bitmapEnabled>...</bitmapEnabled>
<occupiedViewsCount>...</occupiedViewsCount>
<summarySymbolsEnable>...</summarySymbolsEnable>
<priceFormula>...</priceFormula>
<type>...</type>
<motivePriceFormula>...</motivePriceFormula>
<barcodeNaming>...</barcodeNaming>
<enabledCreatorFrontend>...</enabledCreatorFrontend>
<enabledCreatorBackend>...</enabledCreatorBackend>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</printTechnology>
<minWidth>...</minWidth>
<minHeight>...</minHeight>
<maxWidth>...</maxWidth>
<maxHeight>...</maxHeight>
<allowScale>...</allowScale>
<keepProportions>...</keepProportions>
<allowRotation>...</allowRotation>
<only90DegreesRotation>...</only90DegreesRotation>
<allowMirror>...</allowMirror>
<allowColorChange>...</allowColorChange>
<reduceColors>...</reduceColors>
<version>...</version>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</motivePrintTechnology>
{
"motivePrintTechnology" : {
"id" : 12345,
"active" : true,
"printTechnology" : {
"id" : 12345,
"version" : 12345,
"name" : "...",
"orderIndex" : 12345,
"active" : true,
"vectorEnabled" : true,
"bitmapEnabled" : true,
"occupiedViewsCount" : true,
"summarySymbolsEnable" : true,
"priceFormula" : "...",
"type" : "DIRECT_TO_FOIL",
"motivePriceFormula" : "...",
"barcodeNaming" : "...",
"enabledCreatorFrontend" : "...",
"enabledCreatorBackend" : "...",
"rest" : [ { }, { } ]
},
"minWidth" : 12345,
"minHeight" : 12345,
"maxWidth" : 12345,
"maxHeight" : 12345,
"allowScale" : true,
"keepProportions" : true,
"allowRotation" : true,
"only90DegreesRotation" : true,
"allowMirror" : true,
"allowColorChange" : true,
"reduceColors" : true,
"version" : 12345,
"rest" : [ { }, { } ]
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/assignedCategories
Create a new category assignment for a motive.
Assigns the motive to the specified category. The category field must reference
an existing motive category within the same shop.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
CategoryAssignedToMotive | the category assignment data including the category reference |
application/xml |
CategoryAssignedToMotive |
| Code | Condition |
|---|---|
| 200 | the category assignment was created successfully |
| 404 | motive or referenced category not found |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
CategoryAssignedToMotive | |
application/xml |
CategoryAssignedToMotive |
<categoryAssignedToMotive>
<id>...</id>
<version>...</version>
<active>...</active>
<orderIndex>...</orderIndex>
<category>
<id>...</id>
<version>...</version>
<name>...</name>
<orderIndex>...</orderIndex>
<active>...</active>
<deleted>...</deleted>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</category>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</categoryAssignedToMotive>
{
"categoryAssignedToMotive" : {
"id" : 12345,
"version" : 12345,
"active" : true,
"orderIndex" : 12345,
"category" : {
"id" : 12345,
"version" : 12345,
"name" : "...",
"orderIndex" : 12345,
"active" : true,
"deleted" : true,
"rest" : [ { }, { } ]
},
"rest" : [ { }, { } ]
}
}
<categoryAssignedToMotive>
<id>...</id>
<version>...</version>
<active>...</active>
<orderIndex>...</orderIndex>
<category>
<id>...</id>
<version>...</version>
<name>...</name>
<orderIndex>...</orderIndex>
<active>...</active>
<deleted>...</deleted>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</category>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</categoryAssignedToMotive>
{
"categoryAssignedToMotive" : {
"id" : 12345,
"version" : 12345,
"active" : true,
"orderIndex" : 12345,
"category" : {
"id" : 12345,
"version" : 12345,
"name" : "...",
"orderIndex" : 12345,
"active" : true,
"deleted" : true,
"rest" : [ { }, { } ]
},
"rest" : [ { }, { } ]
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/bitmap
Upload a bitmap image for a motive.
Replaces the current bitmap image of the motive with the uploaded file. The file must be
sent as multipart/form-data with the image bytes in the
uploadedFile form field.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
multipart/form-data |
(custom)
|
the multipart form containing the bitmap image file |
| Code | Condition |
|---|---|
| 200 | the bitmap image was uploaded successfully |
| 400 | invalid image file or unsupported format |
| 404 | motive not found for the given id |
<motive>
<id>...</id>
<uuid>...</uuid>
<name>funny thing</name>
<type>VECTOR</type>
</motive>
{
"motive" : {
"id" : 12345,
"uuid" : "...",
"name" : "funny thing",
"type" : "VECTOR"
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/localizations
Create a new motive localization. Adds a translated version of the motive for a specific language. Each motive can have at most one localization per language.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
MotiveLocalized | the localization data including name and language |
application/xml |
MotiveLocalized |
| Code | Condition |
|---|---|
| 200 | the localization was created successfully |
| 400 | validation failed (e.g., duplicate language or missing required fields) |
| 404 | motive not found for the given id |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
MotiveLocalized | |
application/xml |
MotiveLocalized |
<motiveLocalized>
<id>...</id>
<name>funny thing</name>
<language>
<id>...</id>
<code>en</code>
<name>English</name>
</language>
</motiveLocalized>
{
"motiveLocalized" : {
"id" : 12345,
"name" : "funny thing",
"language" : {
"id" : 12345,
"code" : "en",
"name" : "English"
}
}
}
<motiveLocalized>
<id>...</id>
<name>funny thing</name>
<language>
<id>...</id>
<code>en</code>
<name>English</name>
</language>
</motiveLocalized>
{
"motiveLocalized" : {
"id" : 12345,
"name" : "funny thing",
"language" : {
"id" : 12345,
"code" : "en",
"name" : "English"
}
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/technologies
Create a new motive print technology.
Assigns a print technology configuration to the specified motive. The
printTechnology field must reference an existing print technology in the account.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
MotivePrintTechnology | the print technology configuration to assign |
application/xml |
MotivePrintTechnology |
| Code | Condition |
|---|---|
| 200 | the motive print technology was created successfully |
| 404 | motive or referenced print technology not found |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
MotivePrintTechnology | |
application/xml |
MotivePrintTechnology |
<motivePrintTechnology>
<id>...</id>
<active>...</active>
<printTechnology>
<id>...</id>
<version>...</version>
<name>...</name>
<orderIndex>...</orderIndex>
<active>...</active>
<vectorEnabled>...</vectorEnabled>
<bitmapEnabled>...</bitmapEnabled>
<occupiedViewsCount>...</occupiedViewsCount>
<summarySymbolsEnable>...</summarySymbolsEnable>
<priceFormula>...</priceFormula>
<type>...</type>
<motivePriceFormula>...</motivePriceFormula>
<barcodeNaming>...</barcodeNaming>
<enabledCreatorFrontend>...</enabledCreatorFrontend>
<enabledCreatorBackend>...</enabledCreatorBackend>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</printTechnology>
<minWidth>...</minWidth>
<minHeight>...</minHeight>
<maxWidth>...</maxWidth>
<maxHeight>...</maxHeight>
<allowScale>...</allowScale>
<keepProportions>...</keepProportions>
<allowRotation>...</allowRotation>
<only90DegreesRotation>...</only90DegreesRotation>
<allowMirror>...</allowMirror>
<allowColorChange>...</allowColorChange>
<reduceColors>...</reduceColors>
<version>...</version>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</motivePrintTechnology>
{
"motivePrintTechnology" : {
"id" : 12345,
"active" : true,
"printTechnology" : {
"id" : 12345,
"version" : 12345,
"name" : "...",
"orderIndex" : 12345,
"active" : true,
"vectorEnabled" : true,
"bitmapEnabled" : true,
"occupiedViewsCount" : true,
"summarySymbolsEnable" : true,
"priceFormula" : "...",
"type" : "DECORATION_ATTACH",
"motivePriceFormula" : "...",
"barcodeNaming" : "...",
"enabledCreatorFrontend" : "...",
"enabledCreatorBackend" : "...",
"rest" : [ { }, { } ]
},
"minWidth" : 12345,
"minHeight" : 12345,
"maxWidth" : 12345,
"maxHeight" : 12345,
"allowScale" : true,
"keepProportions" : true,
"allowRotation" : true,
"only90DegreesRotation" : true,
"allowMirror" : true,
"allowColorChange" : true,
"reduceColors" : true,
"version" : 12345,
"rest" : [ { }, { } ]
}
}
<motivePrintTechnology>
<id>...</id>
<active>...</active>
<printTechnology>
<id>...</id>
<version>...</version>
<name>...</name>
<orderIndex>...</orderIndex>
<active>...</active>
<vectorEnabled>...</vectorEnabled>
<bitmapEnabled>...</bitmapEnabled>
<occupiedViewsCount>...</occupiedViewsCount>
<summarySymbolsEnable>...</summarySymbolsEnable>
<priceFormula>...</priceFormula>
<type>...</type>
<motivePriceFormula>...</motivePriceFormula>
<barcodeNaming>...</barcodeNaming>
<enabledCreatorFrontend>...</enabledCreatorFrontend>
<enabledCreatorBackend>...</enabledCreatorBackend>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</printTechnology>
<minWidth>...</minWidth>
<minHeight>...</minHeight>
<maxWidth>...</maxWidth>
<maxHeight>...</maxHeight>
<allowScale>...</allowScale>
<keepProportions>...</keepProportions>
<allowRotation>...</allowRotation>
<only90DegreesRotation>...</only90DegreesRotation>
<allowMirror>...</allowMirror>
<allowColorChange>...</allowColorChange>
<reduceColors>...</reduceColors>
<version>...</version>
<link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</motivePrintTechnology>
{
"motivePrintTechnology" : {
"id" : 12345,
"active" : true,
"printTechnology" : {
"id" : 12345,
"version" : 12345,
"name" : "...",
"orderIndex" : 12345,
"active" : true,
"vectorEnabled" : true,
"bitmapEnabled" : true,
"occupiedViewsCount" : true,
"summarySymbolsEnable" : true,
"priceFormula" : "...",
"type" : "DIGITAL_DIRECT",
"motivePriceFormula" : "...",
"barcodeNaming" : "...",
"enabledCreatorFrontend" : "...",
"enabledCreatorBackend" : "...",
"rest" : [ { }, { } ]
},
"minWidth" : 12345,
"minHeight" : 12345,
"maxWidth" : 12345,
"maxHeight" : 12345,
"allowScale" : true,
"keepProportions" : true,
"allowRotation" : true,
"only90DegreesRotation" : true,
"allowMirror" : true,
"allowColorChange" : true,
"reduceColors" : true,
"version" : 12345,
"rest" : [ { }, { } ]
}
}
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/localizations/{localizationId}
Delete a motive localization. Permanently removes the specified localization from the motive.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
localizationId |
required | path | int | the unique identifier of the localization to delete | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 204 | the localization was deleted successfully |
| 404 | motive or localization not found for the given id |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/motives/{motiveId}/localizations/{localizationId}
Update a motive localization.
Replaces the localization data with the values provided in the request body. Include the
current version field to prevent conflicts from concurrent modifications.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
localizationId |
required | path | int | the unique identifier of the localization to update | |
motiveId |
required | path | int | the unique identifier of the motive | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
MotiveLocalized | the updated localization data including name and language |
application/xml |
MotiveLocalized |
| Code | Condition |
|---|---|
| 200 | the localization was updated successfully |
| 400 | validation failed (e.g., missing required fields or invalid values) |
| 404 | motive or localization not found for the given id |
| 409 | version conflict due to concurrent modification |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
MotiveLocalized | |
application/xml |
MotiveLocalized |
<motiveLocalized>
<id>...</id>
<name>funny thing</name>
<language>
<id>...</id>
<code>en</code>
<name>English</name>
</language>
</motiveLocalized>
{
"motiveLocalized" : {
"id" : 12345,
"name" : "funny thing",
"language" : {
"id" : 12345,
"code" : "en",
"name" : "English"
}
}
}
<motiveLocalized>
<id>...</id>
<name>funny thing</name>
<language>
<id>...</id>
<code>en</code>
<name>English</name>
</language>
</motiveLocalized>
{
"motiveLocalized" : {
"id" : 12345,
"name" : "funny thing",
"language" : {
"id" : 12345,
"code" : "en",
"name" : "English"
}
}
}