ProductAssignedSticker Data Type

Assignment of a sticker overlay to a product, including placement and display rules.

Properties
Name Type Description
id number Resource identifier.
sticker Sticker The sticker being assigned.
onAllColors boolean Whether the sticker appears on all product colors.
aboveMotives boolean Whether the sticker is rendered above motive layers.
creatorOnly boolean Whether the sticker is visible only in the creator tool.
xTwips number Horizontal position of the sticker in twips.
yTwips number Vertical position of the sticker in twips.
widthTwips number Rendered width of the sticker in twips.
heightTwips number Rendered height of the sticker in twips.
designWidthTwips number Original design width of the sticker in twips.
designHeightTwips number Original design height of the sticker in twips.
displayUntil number Date until which the sticker is displayed; null means indefinite.
version number Optimistic locking version.
Used in
GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/assignedStickers/{assignedStickerId} response
ProductAssignedSticker (JSON) 
{
  "assignedProductSticker" : {
    "id" : 12345,
    "sticker" : {
      "id" : 12345,
      "name" : "...",
      "version" : 12345,
      "imageId" : 12345
    },
    "onAllColors" : true,
    "aboveMotives" : true,
    "creatorOnly" : true,
    "xTwips" : 12345,
    "yTwips" : 12345,
    "widthTwips" : 12345,
    "heightTwips" : 12345,
    "designWidthTwips" : 12345,
    "designHeightTwips" : 12345,
    "displayUntil" : 12345,
    "version" : 12345
  }
}
ProductAssignedSticker Data Type

Assignment of a sticker overlay to a product, including placement and display rules.

Properties
Name Type Description
aboveMotives boolean Whether the sticker is rendered above motive layers.
creatorOnly boolean Whether the sticker is visible only in the creator tool.
designHeightTwips short Original design height of the sticker in twips.
designWidthTwips short Original design width of the sticker in twips.
displayUntil dateTime Date until which the sticker is displayed; null means indefinite.
heightTwips short Rendered height of the sticker in twips.
id int Resource identifier.
onAllColors boolean Whether the sticker appears on all product colors.
sticker Sticker The sticker being assigned.
version int Optimistic locking version.
widthTwips short Rendered width of the sticker in twips.
xTwips short Horizontal position of the sticker in twips.
yTwips short Vertical position of the sticker in twips.
Used in
GET /accounts/{accountId}/shops/{shopId}/products/{productId}/assignedViews/{assignedViewId}/assignedStickers/{assignedStickerId} response
ProductAssignedSticker (XML) 
<assignedProductSticker>
  <id>...</id>
  <sticker>
    <id>...</id>
    <name>...</name>
    <version>...</version>
    <imageId>...</imageId>
  </sticker>
  <onAllColors>...</onAllColors>
  <aboveMotives>...</aboveMotives>
  <creatorOnly>...</creatorOnly>
  <xTwips>...</xTwips>
  <yTwips>...</yTwips>
  <widthTwips>...</widthTwips>
  <heightTwips>...</heightTwips>
  <designWidthTwips>...</designWidthTwips>
  <designHeightTwips>...</designHeightTwips>
  <displayUntil>...</displayUntil>
  <version>...</version>
</assignedProductSticker>