ProductPrice Data Type

A price entry for a product, scoped by country, color, size, and quantity tier.

Properties
Name Type Description
id number Resource identifier.
version number Optimistic locking version.
country Country The country this price applies to.
assignedColor AssignedProductColor The product color this price applies to, or null for all colors.
assignedSize AssignedProductSize The product size this price applies to, or null for all sizes.
amount number Minimum quantity for this price tier to apply.
margin number Margin value added on top of the base cost.
price number Final selling price for this tier.
Used in
GET /accounts/{accountId}/shops/{shopId}/products/{productId}/prices/{priceId} response
ProductPrice (JSON) 
{
  "productPrice" : {
    "id" : 12345,
    "version" : 12345,
    "country" : {
      "id" : 12345,
      "code" : "UK",
      "name" : "United Kingdom",
      "standardVat" : {
        "id" : 12345,
        "percentValue" : 19.0
      },
      "reducedVat" : {
        "id" : 12345,
        "percentValue" : 19.0
      },
      "currency" : {
        "id" : 12345,
        "code" : "EUR",
        "symbol" : "€",
        "name" : "Euro"
      },
      "pricePrecision" : 2,
      "priceFractionalDigits" : 2,
      "default" : true
    },
    "assignedColor" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productColor" : {
        "id" : 12345,
        "name" : "black"
      },
      "default" : true,
      "active" : true
    },
    "assignedSize" : {
      "id" : 12345,
      "orderIndex" : 1,
      "default" : true,
      "productSize" : {
        "id" : 12345,
        "name" : "XXL",
        "dimensions" : 12345,
        "groupingId" : "...",
        "groupingDefault" : true
      },
      "width" : 47.0,
      "height" : 68.0,
      "length" : 12345.0,
      "accuracy" : 12345.0
    },
    "amount" : 12345,
    "margin" : 12345.0,
    "price" : 12345.0
  }
}
ProductPrice Data Type

A price entry for a product, scoped by country, color, size, and quantity tier.

Properties
Name Type Description
amount int Minimum quantity for this price tier to apply.
assignedColor AssignedProductColor The product color this price applies to, or null for all colors.
assignedSize AssignedProductSize The product size this price applies to, or null for all sizes.
country Country The country this price applies to.
id int Resource identifier.
margin decimal Margin value added on top of the base cost.
price decimal Final selling price for this tier.
version int Optimistic locking version.
Used in
GET /accounts/{accountId}/shops/{shopId}/products/{productId}/prices/{priceId} response
ProductPrice (XML) 
<productPrice>
  <id>...</id>
  <version>...</version>
  <country>
    <id>...</id>
    <code>UK</code>
    <name>United Kingdom</name>
    <standardVat>
      <id>...</id>
      <percentValue>19</percentValue>
    </standardVat>
    <reducedVat>
      <id>...</id>
      <percentValue>19</percentValue>
    </reducedVat>
    <currency>
      <id>...</id>
      <code>EUR</code>
      <symbol>€</symbol>
      <name>Euro</name>
    </currency>
    <pricePrecision>2</pricePrecision>
    <priceFractionalDigits>2</priceFractionalDigits>
    <default>...</default>
  </country>
  <assignedColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedColor>
  <assignedSize>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <default>...</default>
    <productSize>
      <id>...</id>
      <name>XXL</name>
      <dimensions>...</dimensions>
      <groupingId>...</groupingId>
      <groupingDefault>...</groupingDefault>
    </productSize>
    <width>47</width>
    <height>68</height>
    <length>...</length>
    <accuracy>...</accuracy>
  </assignedSize>
  <amount>...</amount>
  <margin>...</margin>
  <price>...</price>
</productPrice>