PUT admin/product

Request Information

URI Parameters

None.

Body Parameters

ProductUpdateRequest
NameDescriptionTypeAdditional information
marketplaceId

string

None.

productId

string

None.

sku

string

None.

documentName

string

None.

documentId

string

None.

productName

string

None.

productDescription

string

None.

productImage

ImageData

None.

background

ImageData

None.

uiTemplateId

string

None.

isActive

boolean

None.

productOptions

Collection of ProductOptionRequest

None.

Request Formats

application/json, text/json

Sample:
{
  "marketplaceId": "sample string 1",
  "productId": "sample string 2",
  "sku": "sample string 3",
  "documentName": "sample string 4",
  "documentId": "sample string 5",
  "productName": "sample string 6",
  "productDescription": "sample string 7",
  "productImage": {
    "mime": "sample string 1",
    "data": "sample string 2"
  },
  "background": {
    "mime": "sample string 1",
    "data": "sample string 2"
  },
  "uiTemplateId": "sample string 8",
  "isActive": true,
  "productOptions": [
    {
      "optionId": "sample string 1",
      "displayOrder": 2,
      "isRequired": true
    },
    {
      "optionId": "sample string 1",
      "displayOrder": 2,
      "isRequired": true
    }
  ]
}

application/xml, text/xml

Sample:
<ProductUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JCAPI.Models">
  <background>
    <data>sample string 2</data>
    <mime>sample string 1</mime>
  </background>
  <documentId>sample string 5</documentId>
  <documentName>sample string 4</documentName>
  <isActive>true</isActive>
  <marketplaceId>sample string 1</marketplaceId>
  <productDescription>sample string 7</productDescription>
  <productId>sample string 2</productId>
  <productImage>
    <data>sample string 2</data>
    <mime>sample string 1</mime>
  </productImage>
  <productName>sample string 6</productName>
  <productOptions>
    <ProductOptionRequest>
      <displayOrder>2</displayOrder>
      <isRequired>true</isRequired>
      <optionId>sample string 1</optionId>
    </ProductOptionRequest>
    <ProductOptionRequest>
      <displayOrder>2</displayOrder>
      <isRequired>true</isRequired>
      <optionId>sample string 1</optionId>
    </ProductOptionRequest>
  </productOptions>
  <sku>sample string 3</sku>
  <uiTemplateId>sample string 8</uiTemplateId>
</ProductUpdateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>