POST api/v1/product/configuration

JOS: ADD COMMENTS

Request Information

URI Parameters

None.

Body Parameters

GetProductConfigurationParameter
NameDescriptionTypeAdditional information
OwnArticleNumber

string

None.

ProductIdentifier

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "OwnArticleNumber": "sample string 1",
  "ProductIdentifier": "1c91dc6d-7e8f-41e9-bbcb-566103e719bf"
}

application/xml, text/xml

Sample:
<GetProductConfigurationParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <OwnArticleNumber>sample string 1</OwnArticleNumber>
  <ProductIdentifier>1c91dc6d-7e8f-41e9-bbcb-566103e719bf</ProductIdentifier>
</GetProductConfigurationParameter>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetProductConfigurationParameter'.

Response Information

Resource Description

ProductConfiguration
NameDescriptionTypeAdditional information
ProductConfigurationItems

Collection of ProductConfigurationItem

None.

MainPurchaseOrderNumber

string

None.

MainOwnArticleNumber

string

None.

MainProductIdentifier

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "ProductConfigurationItems": [
    {
      "LinkedColorRestrictions": [
        {
          "LinkedColorCode": "sample string 1"
        },
        {
          "LinkedColorCode": "sample string 1"
        }
      ],
      "LinkedSizeRestrictions": [
        {
          "LinkedSizeCode": "sample string 1"
        },
        {
          "LinkedSizeCode": "sample string 1"
        }
      ],
      "LinkedOption1Restrictions": [
        {
          "LinkedOptionKey": "sample string 1"
        },
        {
          "LinkedOptionKey": "sample string 1"
        }
      ],
      "LinkedOption2Restrictions": [
        {
          "LinkedOptionKey": "sample string 1"
        },
        {
          "LinkedOptionKey": "sample string 1"
        }
      ],
      "CombinationNumber": 1,
      "CombinationType": "sample string 1",
      "QuantityDenominator": 2.0,
      "QuantityDenominatorUnit": "sample string 3",
      "QuantityNumerator": 4.0,
      "QuantityNumeratorUnit": "sample string 5",
      "QuantityType": "sample string 6",
      "ResultRoundDigits": 7,
      "SortNumber": 8,
      "UseColorsFromArticleCombination": 1,
      "UseSizesFromArticleCombination": 1,
      "UseOption1FromArticleCombination": 1,
      "UseOption2FromArticleCombination": 1,
      "RestrictedToColorSizeCombination": true,
      "RestrictedToVariation": true,
      "MainColorKey": "sample string 17",
      "MainSizeKey": "sample string 18",
      "LinkedPurchaseOrderNumber": "sample string 13",
      "LinkedOwnArticleNumber": "sample string 14",
      "LinkedProductIdentifier": "81859ad3-aee3-4f3c-8508-3f7565e91e1a",
      "AddAsInlineCost": true,
      "SetPrintPositionOnlyPriceToOnInsert": true,
      "SetPrintPositionToOnInsert": true,
      "SetPrintPriceSummaryToOnInsert": true
    },
    {
      "LinkedColorRestrictions": [
        {
          "LinkedColorCode": "sample string 1"
        },
        {
          "LinkedColorCode": "sample string 1"
        }
      ],
      "LinkedSizeRestrictions": [
        {
          "LinkedSizeCode": "sample string 1"
        },
        {
          "LinkedSizeCode": "sample string 1"
        }
      ],
      "LinkedOption1Restrictions": [
        {
          "LinkedOptionKey": "sample string 1"
        },
        {
          "LinkedOptionKey": "sample string 1"
        }
      ],
      "LinkedOption2Restrictions": [
        {
          "LinkedOptionKey": "sample string 1"
        },
        {
          "LinkedOptionKey": "sample string 1"
        }
      ],
      "CombinationNumber": 1,
      "CombinationType": "sample string 1",
      "QuantityDenominator": 2.0,
      "QuantityDenominatorUnit": "sample string 3",
      "QuantityNumerator": 4.0,
      "QuantityNumeratorUnit": "sample string 5",
      "QuantityType": "sample string 6",
      "ResultRoundDigits": 7,
      "SortNumber": 8,
      "UseColorsFromArticleCombination": 1,
      "UseSizesFromArticleCombination": 1,
      "UseOption1FromArticleCombination": 1,
      "UseOption2FromArticleCombination": 1,
      "RestrictedToColorSizeCombination": true,
      "RestrictedToVariation": true,
      "MainColorKey": "sample string 17",
      "MainSizeKey": "sample string 18",
      "LinkedPurchaseOrderNumber": "sample string 13",
      "LinkedOwnArticleNumber": "sample string 14",
      "LinkedProductIdentifier": "81859ad3-aee3-4f3c-8508-3f7565e91e1a",
      "AddAsInlineCost": true,
      "SetPrintPositionOnlyPriceToOnInsert": true,
      "SetPrintPositionToOnInsert": true,
      "SetPrintPriceSummaryToOnInsert": true
    }
  ],
  "MainPurchaseOrderNumber": "sample string 1",
  "MainOwnArticleNumber": "sample string 2",
  "MainProductIdentifier": "df57894a-7fe3-4100-af2f-ceed5f6691e3"
}

application/xml, text/xml

Sample:
<ProductConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <MainOwnArticleNumber>sample string 2</MainOwnArticleNumber>
  <MainProductIdentifier>df57894a-7fe3-4100-af2f-ceed5f6691e3</MainProductIdentifier>
  <MainPurchaseOrderNumber>sample string 1</MainPurchaseOrderNumber>
  <ProductConfigurationItems>
    <ProductConfigurationItem>
      <AddAsInlineCost>true</AddAsInlineCost>
      <CombinationNumber>1</CombinationNumber>
      <CombinationType>sample string 1</CombinationType>
      <LinkedColorRestrictions>
        <ProductConfigurationColorItem>
          <LinkedColorCode>sample string 1</LinkedColorCode>
        </ProductConfigurationColorItem>
        <ProductConfigurationColorItem>
          <LinkedColorCode>sample string 1</LinkedColorCode>
        </ProductConfigurationColorItem>
      </LinkedColorRestrictions>
      <LinkedOption1Restrictions>
        <ProductConfigurationOptionItem>
          <LinkedOptionKey>sample string 1</LinkedOptionKey>
        </ProductConfigurationOptionItem>
        <ProductConfigurationOptionItem>
          <LinkedOptionKey>sample string 1</LinkedOptionKey>
        </ProductConfigurationOptionItem>
      </LinkedOption1Restrictions>
      <LinkedOption2Restrictions>
        <ProductConfigurationOptionItem>
          <LinkedOptionKey>sample string 1</LinkedOptionKey>
        </ProductConfigurationOptionItem>
        <ProductConfigurationOptionItem>
          <LinkedOptionKey>sample string 1</LinkedOptionKey>
        </ProductConfigurationOptionItem>
      </LinkedOption2Restrictions>
      <LinkedOwnArticleNumber>sample string 14</LinkedOwnArticleNumber>
      <LinkedProductIdentifier>81859ad3-aee3-4f3c-8508-3f7565e91e1a</LinkedProductIdentifier>
      <LinkedPurchaseOrderNumber>sample string 13</LinkedPurchaseOrderNumber>
      <LinkedSizeRestrictions>
        <ProductConfigurationSizeItem>
          <LinkedSizeCode>sample string 1</LinkedSizeCode>
        </ProductConfigurationSizeItem>
        <ProductConfigurationSizeItem>
          <LinkedSizeCode>sample string 1</LinkedSizeCode>
        </ProductConfigurationSizeItem>
      </LinkedSizeRestrictions>
      <MainColorKey>sample string 17</MainColorKey>
      <MainSizeKey>sample string 18</MainSizeKey>
      <QuantityDenominator>2</QuantityDenominator>
      <QuantityDenominatorUnit>sample string 3</QuantityDenominatorUnit>
      <QuantityNumerator>4</QuantityNumerator>
      <QuantityNumeratorUnit>sample string 5</QuantityNumeratorUnit>
      <QuantityType>sample string 6</QuantityType>
      <RestrictedToColorSizeCombination>true</RestrictedToColorSizeCombination>
      <RestrictedToVariation>true</RestrictedToVariation>
      <ResultRoundDigits>7</ResultRoundDigits>
      <SetPrintPositionOnlyPriceToOnInsert>true</SetPrintPositionOnlyPriceToOnInsert>
      <SetPrintPositionToOnInsert>true</SetPrintPositionToOnInsert>
      <SetPrintPriceSummaryToOnInsert>true</SetPrintPriceSummaryToOnInsert>
      <SortNumber>8</SortNumber>
      <UseColorsFromArticleCombination>1</UseColorsFromArticleCombination>
      <UseOption1FromArticleCombination>1</UseOption1FromArticleCombination>
      <UseOption2FromArticleCombination>1</UseOption2FromArticleCombination>
      <UseSizesFromArticleCombination>1</UseSizesFromArticleCombination>
    </ProductConfigurationItem>
    <ProductConfigurationItem>
      <AddAsInlineCost>true</AddAsInlineCost>
      <CombinationNumber>1</CombinationNumber>
      <CombinationType>sample string 1</CombinationType>
      <LinkedColorRestrictions>
        <ProductConfigurationColorItem>
          <LinkedColorCode>sample string 1</LinkedColorCode>
        </ProductConfigurationColorItem>
        <ProductConfigurationColorItem>
          <LinkedColorCode>sample string 1</LinkedColorCode>
        </ProductConfigurationColorItem>
      </LinkedColorRestrictions>
      <LinkedOption1Restrictions>
        <ProductConfigurationOptionItem>
          <LinkedOptionKey>sample string 1</LinkedOptionKey>
        </ProductConfigurationOptionItem>
        <ProductConfigurationOptionItem>
          <LinkedOptionKey>sample string 1</LinkedOptionKey>
        </ProductConfigurationOptionItem>
      </LinkedOption1Restrictions>
      <LinkedOption2Restrictions>
        <ProductConfigurationOptionItem>
          <LinkedOptionKey>sample string 1</LinkedOptionKey>
        </ProductConfigurationOptionItem>
        <ProductConfigurationOptionItem>
          <LinkedOptionKey>sample string 1</LinkedOptionKey>
        </ProductConfigurationOptionItem>
      </LinkedOption2Restrictions>
      <LinkedOwnArticleNumber>sample string 14</LinkedOwnArticleNumber>
      <LinkedProductIdentifier>81859ad3-aee3-4f3c-8508-3f7565e91e1a</LinkedProductIdentifier>
      <LinkedPurchaseOrderNumber>sample string 13</LinkedPurchaseOrderNumber>
      <LinkedSizeRestrictions>
        <ProductConfigurationSizeItem>
          <LinkedSizeCode>sample string 1</LinkedSizeCode>
        </ProductConfigurationSizeItem>
        <ProductConfigurationSizeItem>
          <LinkedSizeCode>sample string 1</LinkedSizeCode>
        </ProductConfigurationSizeItem>
      </LinkedSizeRestrictions>
      <MainColorKey>sample string 17</MainColorKey>
      <MainSizeKey>sample string 18</MainSizeKey>
      <QuantityDenominator>2</QuantityDenominator>
      <QuantityDenominatorUnit>sample string 3</QuantityDenominatorUnit>
      <QuantityNumerator>4</QuantityNumerator>
      <QuantityNumeratorUnit>sample string 5</QuantityNumeratorUnit>
      <QuantityType>sample string 6</QuantityType>
      <RestrictedToColorSizeCombination>true</RestrictedToColorSizeCombination>
      <RestrictedToVariation>true</RestrictedToVariation>
      <ResultRoundDigits>7</ResultRoundDigits>
      <SetPrintPositionOnlyPriceToOnInsert>true</SetPrintPositionOnlyPriceToOnInsert>
      <SetPrintPositionToOnInsert>true</SetPrintPositionToOnInsert>
      <SetPrintPriceSummaryToOnInsert>true</SetPrintPriceSummaryToOnInsert>
      <SortNumber>8</SortNumber>
      <UseColorsFromArticleCombination>1</UseColorsFromArticleCombination>
      <UseOption1FromArticleCombination>1</UseOption1FromArticleCombination>
      <UseOption2FromArticleCombination>1</UseOption2FromArticleCombination>
      <UseSizesFromArticleCombination>1</UseSizesFromArticleCombination>
    </ProductConfigurationItem>
  </ProductConfigurationItems>
</ProductConfiguration>