POST api/PimProductRefresh

Load and save the products specified. This happens inline, so the request may be slow to respond.

Request Information

URI Parameters

None.

Body Parameters

Model representing the request.

ProductRefresh

NameDescriptionTypeAdditional information
SiteCode

string

None.
VerificationKey

string

None.
TimestampUTC

string

None.
APIUsername

string

None.
ProductCodeList

string

None.
Progress

boolean

None.
IncludeChildrenInProductList

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "SiteCode": "sample string 1",
  "VerificationKey": "sample string 2",
  "TimestampUTC": "sample string 3",
  "APIUsername": "sample string 4",
  "ProductCodeList": "sample string 5",
  "Progress": true,
  "IncludeChildrenInProductList": true
}

application/xml, text/xml

Sample: 
<ProductRefresh xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.PIM.Domain.Models.API">
  <APIUsername>sample string 4</APIUsername>
  <IncludeChildrenInProductList>true</IncludeChildrenInProductList>
  <ProductCodeList>sample string 5</ProductCodeList>
  <Progress>true</Progress>
  <SiteCode>sample string 1</SiteCode>
  <TimestampUTC>sample string 3</TimestampUTC>
  <VerificationKey>sample string 2</VerificationKey>
</ProductRefresh>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

NameDescriptionTypeAdditional information
ResponseCode

APIResponseCodes

None.
Message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseCode": 0,
  "Message": "sample string 1"
}

application/xml, text/xml

Sample: 
<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>