POST api/PimImageImportJob
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteCode | string |
None. |
|
| VerificationKey | string |
None. |
|
| TimestampUTC | string |
None. |
|
| APIUsername | string |
None. |
|
| ProcessAll | boolean |
None. |
|
| AllActive | boolean |
None. |
|
| StartDate | date |
None. |
|
| EndDateTime | date |
None. |
|
| Brand | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"SiteCode": "sample string 1",
"VerificationKey": "sample string 2",
"TimestampUTC": "sample string 3",
"APIUsername": "sample string 4",
"ProcessAll": true,
"AllActive": true,
"StartDate": "2025-12-20T23:39:26.9694553+00:00",
"EndDateTime": "2025-12-20T23:39:26.9694553+00:00",
"Brand": "sample string 9"
}
application/xml, text/xml
Sample:
<ImageImportRequest 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> <AllActive>true</AllActive> <Brand>sample string 9</Brand> <EndDateTime>2025-12-20T23:39:26.9694553+00:00</EndDateTime> <ProcessAll>true</ProcessAll> <SiteCode>sample string 1</SiteCode> <StartDate>2025-12-20T23:39:26.9694553+00:00</StartDate> <TimestampUTC>sample string 3</TimestampUTC> <VerificationKey>sample string 2</VerificationKey> </ImageImportRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
| Name | Description | Type | Additional 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>