POST customizeBK/{sku}

Request Information

URI Parameters

Name	Description	Type	Additional information
sku		string	Required

Body Parameters

XmpieCustomization

Name	Type	Additional information
customerId	string	None.
marketplaceId	string	None.
orderId	string	None.
sku	string	None.
documentId	string	None.
isPreview	string	None.
outputFormat	string	None.
customizationData	Collection of UICustomizationData	None.
sessionID	string	None.
dpi	string	None.

Request Formats

application/json, text/json

Sample:

{
  "customerId": "sample string 1",
  "marketplaceId": "sample string 2",
  "orderId": "sample string 3",
  "sku": "sample string 4",
  "documentId": "sample string 5",
  "isPreview": "sample string 6",
  "outputFormat": "sample string 7",
  "customizationData": [
    {
      "pcodeName": "sample string 1",
      "pcodeType": "sample string 2",
      "pcodeValue": {},
      "isVAR": true
    },
    {
      "pcodeName": "sample string 1",
      "pcodeType": "sample string 2",
      "pcodeValue": {},
      "isVAR": true
    }
  ],
  "sessionID": "sample string 8",
  "dpi": "sample string 9"
}

application/xml, text/xml

Sample:

<XmpieCustomization xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JCAPI.Models">
  <customerId>sample string 1</customerId>
  <customizationData>
    <UICustomizationData>
      <isVAR>true</isVAR>
      <pcodeName>sample string 1</pcodeName>
      <pcodeType>sample string 2</pcodeType>
      <pcodeValue />
    </UICustomizationData>
    <UICustomizationData>
      <isVAR>true</isVAR>
      <pcodeName>sample string 1</pcodeName>
      <pcodeType>sample string 2</pcodeType>
      <pcodeValue />
    </UICustomizationData>
  </customizationData>
  <documentId>sample string 5</documentId>
  <dpi>sample string 9</dpi>
  <isPreview>sample string 6</isPreview>
  <marketplaceId>sample string 2</marketplaceId>
  <orderId>sample string 3</orderId>
  <outputFormat>sample string 7</outputFormat>
  <sessionID>sample string 8</sessionID>
  <sku>sample string 4</sku>
</XmpieCustomization>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

XmpieCustomizationResponse

Name	Type	Additional information
sku	string	None.
customizeURL	string	None.
isError	boolean	None.
customImages	Collection of CustomImage	None.
message	string	None.
customizationID	string	None.
sessionID	string	None.
previewMessage	string	None.
jobId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "sku": "sample string 1",
  "customizeURL": "sample string 2",
  "isError": true,
  "customImages": [
    {
      "pCode": "sample string 1",
      "fileName": "sample string 2"
    },
    {
      "pCode": "sample string 1",
      "fileName": "sample string 2"
    }
  ],
  "message": "sample string 4",
  "customizationID": "sample string 5",
  "sessionID": "sample string 6",
  "previewMessage": "sample string 7",
  "jobId": "sample string 8"
}

application/xml, text/xml

Sample:

<XmpieCustomizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JCAPI.Models">
  <customImages>
    <CustomImage>
      <fileName>sample string 2</fileName>
      <pCode>sample string 1</pCode>
    </CustomImage>
    <CustomImage>
      <fileName>sample string 2</fileName>
      <pCode>sample string 1</pCode>
    </CustomImage>
  </customImages>
  <customizationID>sample string 5</customizationID>
  <customizeURL>sample string 2</customizeURL>
  <isError>true</isError>
  <jobId>sample string 8</jobId>
  <message>sample string 4</message>
  <previewMessage>sample string 7</previewMessage>
  <sessionID>sample string 6</sessionID>
  <sku>sample string 1</sku>
</XmpieCustomizationResponse>