POST api/PimInboundProduct
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SiteCode | string |
None. |
|
| VerificationKey | string |
None. |
|
| TimestampUTC | string |
None. |
|
| APIUsername | string |
None. |
|
| DontProcessImageRules | boolean |
None. |
|
| DontRunExportPlugin | boolean |
None. |
|
| AddOnlyDontUpdate | boolean |
None. |
|
| MasterProduct | ImportProductJson |
None. |
|
| StyleProducts | Collection of ImportProductJson |
None. |
Request Formats
application/json, text/json
Sample:
{
"SiteCode": "sample string 1",
"VerificationKey": "sample string 2",
"TimestampUTC": "sample string 3",
"APIUsername": "sample string 4",
"DontProcessImageRules": true,
"DontRunExportPlugin": true,
"AddOnlyDontUpdate": true,
"MasterProduct": {
"ProductCode": "sample string 1",
"ProductType": "sample string 2",
"IsMaster": true,
"IsStandardProduct": true,
"GtinImportMode": 0,
"Gtins": [
{
"DeckSKU": "sample string 1",
"UPC": "sample string 2",
"JAN": "sample string 3",
"EAN": "sample string 4",
"Attribute1": "sample string 5",
"Attribute2": "sample string 6",
"Attribute3": "sample string 7",
"Attribute4": "sample string 8",
"Attribute5": "sample string 9",
"CustomerSKU": "sample string 10",
"ExternalId": 11
},
{
"DeckSKU": "sample string 1",
"UPC": "sample string 2",
"JAN": "sample string 3",
"EAN": "sample string 4",
"Attribute1": "sample string 5",
"Attribute2": "sample string 6",
"Attribute3": "sample string 7",
"Attribute4": "sample string 8",
"Attribute5": "sample string 9",
"CustomerSKU": "sample string 10",
"ExternalId": 11
}
],
"GenericAttributes": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"SiteSpecificAttributes": [
{
"Key": "sample string 1",
"Value": [
{
"SiteName": "sample string 1",
"Value": "sample string 2"
},
{
"SiteName": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Key": "sample string 1",
"Value": [
{
"SiteName": "sample string 1",
"Value": "sample string 2"
},
{
"SiteName": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"LocalizableAttributes": [
{
"Key": "sample string 1",
"Value": [
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
},
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Key": "sample string 1",
"Value": [
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
},
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"ImportWithMaster": true
},
"StyleProducts": [
{
"ProductCode": "sample string 1",
"ProductType": "sample string 2",
"IsMaster": true,
"IsStandardProduct": true,
"GtinImportMode": 0,
"Gtins": [
{
"DeckSKU": "sample string 1",
"UPC": "sample string 2",
"JAN": "sample string 3",
"EAN": "sample string 4",
"Attribute1": "sample string 5",
"Attribute2": "sample string 6",
"Attribute3": "sample string 7",
"Attribute4": "sample string 8",
"Attribute5": "sample string 9",
"CustomerSKU": "sample string 10",
"ExternalId": 11
},
{
"DeckSKU": "sample string 1",
"UPC": "sample string 2",
"JAN": "sample string 3",
"EAN": "sample string 4",
"Attribute1": "sample string 5",
"Attribute2": "sample string 6",
"Attribute3": "sample string 7",
"Attribute4": "sample string 8",
"Attribute5": "sample string 9",
"CustomerSKU": "sample string 10",
"ExternalId": 11
}
],
"GenericAttributes": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"SiteSpecificAttributes": [
{
"Key": "sample string 1",
"Value": [
{
"SiteName": "sample string 1",
"Value": "sample string 2"
},
{
"SiteName": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Key": "sample string 1",
"Value": [
{
"SiteName": "sample string 1",
"Value": "sample string 2"
},
{
"SiteName": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"LocalizableAttributes": [
{
"Key": "sample string 1",
"Value": [
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
},
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Key": "sample string 1",
"Value": [
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
},
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"ImportWithMaster": true
},
{
"ProductCode": "sample string 1",
"ProductType": "sample string 2",
"IsMaster": true,
"IsStandardProduct": true,
"GtinImportMode": 0,
"Gtins": [
{
"DeckSKU": "sample string 1",
"UPC": "sample string 2",
"JAN": "sample string 3",
"EAN": "sample string 4",
"Attribute1": "sample string 5",
"Attribute2": "sample string 6",
"Attribute3": "sample string 7",
"Attribute4": "sample string 8",
"Attribute5": "sample string 9",
"CustomerSKU": "sample string 10",
"ExternalId": 11
},
{
"DeckSKU": "sample string 1",
"UPC": "sample string 2",
"JAN": "sample string 3",
"EAN": "sample string 4",
"Attribute1": "sample string 5",
"Attribute2": "sample string 6",
"Attribute3": "sample string 7",
"Attribute4": "sample string 8",
"Attribute5": "sample string 9",
"CustomerSKU": "sample string 10",
"ExternalId": 11
}
],
"GenericAttributes": [
{
"Key": "sample string 1",
"Value": "sample string 2"
},
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"SiteSpecificAttributes": [
{
"Key": "sample string 1",
"Value": [
{
"SiteName": "sample string 1",
"Value": "sample string 2"
},
{
"SiteName": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Key": "sample string 1",
"Value": [
{
"SiteName": "sample string 1",
"Value": "sample string 2"
},
{
"SiteName": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"LocalizableAttributes": [
{
"Key": "sample string 1",
"Value": [
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
},
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
}
]
},
{
"Key": "sample string 1",
"Value": [
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
},
{
"LocaleName": "sample string 1",
"Value": "sample string 2"
}
]
}
],
"ImportWithMaster": true
}
]
}
application/xml, text/xml
Sample:
<ImportRelatedProductsJson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.PIM.Common.Contracts">
<APIUsername>sample string 4</APIUsername>
<AddOnlyDontUpdate>true</AddOnlyDontUpdate>
<DontProcessImageRules>true</DontProcessImageRules>
<DontRunExportPlugin>true</DontRunExportPlugin>
<MasterProduct>
<GenericAttributes xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d3p1:KeyValuePairOfstringstring>
<d3p1:key>sample string 1</d3p1:key>
<d3p1:value>sample string 2</d3p1:value>
</d3p1:KeyValuePairOfstringstring>
<d3p1:KeyValuePairOfstringstring>
<d3p1:key>sample string 1</d3p1:key>
<d3p1:value>sample string 2</d3p1:value>
</d3p1:KeyValuePairOfstringstring>
</GenericAttributes>
<GtinImportMode>Upsert</GtinImportMode>
<Gtins>
<ImportProductGTIN>
<Attribute1>sample string 5</Attribute1>
<Attribute2>sample string 6</Attribute2>
<Attribute3>sample string 7</Attribute3>
<Attribute4>sample string 8</Attribute4>
<Attribute5>sample string 9</Attribute5>
<CustomerSKU>sample string 10</CustomerSKU>
<DeckSKU>sample string 1</DeckSKU>
<EAN>sample string 4</EAN>
<ExternalId>11</ExternalId>
<JAN>sample string 3</JAN>
<UPC>sample string 2</UPC>
</ImportProductGTIN>
<ImportProductGTIN>
<Attribute1>sample string 5</Attribute1>
<Attribute2>sample string 6</Attribute2>
<Attribute3>sample string 7</Attribute3>
<Attribute4>sample string 8</Attribute4>
<Attribute5>sample string 9</Attribute5>
<CustomerSKU>sample string 10</CustomerSKU>
<DeckSKU>sample string 1</DeckSKU>
<EAN>sample string 4</EAN>
<ExternalId>11</ExternalId>
<JAN>sample string 3</JAN>
<UPC>sample string 2</UPC>
</ImportProductGTIN>
</Gtins>
<ImportWithMaster>true</ImportWithMaster>
<IsMaster>true</IsMaster>
<IsStandardProduct>true</IsStandardProduct>
<LocalizableAttributes xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d3p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
<d3p1:key>sample string 1</d3p1:key>
<d3p1:value>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
</d3p1:value>
</d3p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
<d3p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
<d3p1:key>sample string 1</d3p1:key>
<d3p1:value>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
</d3p1:value>
</d3p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
</LocalizableAttributes>
<ProductCode>sample string 1</ProductCode>
<ProductType>sample string 2</ProductType>
<SiteSpecificAttributes xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d3p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
<d3p1:key>sample string 1</d3p1:key>
<d3p1:value>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
</d3p1:value>
</d3p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
<d3p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
<d3p1:key>sample string 1</d3p1:key>
<d3p1:value>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
</d3p1:value>
</d3p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
</SiteSpecificAttributes>
</MasterProduct>
<SiteCode>sample string 1</SiteCode>
<StyleProducts>
<ImportProductJson>
<GenericAttributes xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d4p1:KeyValuePairOfstringstring>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>sample string 2</d4p1:value>
</d4p1:KeyValuePairOfstringstring>
<d4p1:KeyValuePairOfstringstring>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>sample string 2</d4p1:value>
</d4p1:KeyValuePairOfstringstring>
</GenericAttributes>
<GtinImportMode>Upsert</GtinImportMode>
<Gtins>
<ImportProductGTIN>
<Attribute1>sample string 5</Attribute1>
<Attribute2>sample string 6</Attribute2>
<Attribute3>sample string 7</Attribute3>
<Attribute4>sample string 8</Attribute4>
<Attribute5>sample string 9</Attribute5>
<CustomerSKU>sample string 10</CustomerSKU>
<DeckSKU>sample string 1</DeckSKU>
<EAN>sample string 4</EAN>
<ExternalId>11</ExternalId>
<JAN>sample string 3</JAN>
<UPC>sample string 2</UPC>
</ImportProductGTIN>
<ImportProductGTIN>
<Attribute1>sample string 5</Attribute1>
<Attribute2>sample string 6</Attribute2>
<Attribute3>sample string 7</Attribute3>
<Attribute4>sample string 8</Attribute4>
<Attribute5>sample string 9</Attribute5>
<CustomerSKU>sample string 10</CustomerSKU>
<DeckSKU>sample string 1</DeckSKU>
<EAN>sample string 4</EAN>
<ExternalId>11</ExternalId>
<JAN>sample string 3</JAN>
<UPC>sample string 2</UPC>
</ImportProductGTIN>
</Gtins>
<ImportWithMaster>true</ImportWithMaster>
<IsMaster>true</IsMaster>
<IsStandardProduct>true</IsStandardProduct>
<LocalizableAttributes xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d4p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
</d4p1:value>
</d4p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
<d4p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
</d4p1:value>
</d4p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
</LocalizableAttributes>
<ProductCode>sample string 1</ProductCode>
<ProductType>sample string 2</ProductType>
<SiteSpecificAttributes xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d4p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
</d4p1:value>
</d4p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
<d4p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
</d4p1:value>
</d4p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
</SiteSpecificAttributes>
</ImportProductJson>
<ImportProductJson>
<GenericAttributes xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d4p1:KeyValuePairOfstringstring>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>sample string 2</d4p1:value>
</d4p1:KeyValuePairOfstringstring>
<d4p1:KeyValuePairOfstringstring>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>sample string 2</d4p1:value>
</d4p1:KeyValuePairOfstringstring>
</GenericAttributes>
<GtinImportMode>Upsert</GtinImportMode>
<Gtins>
<ImportProductGTIN>
<Attribute1>sample string 5</Attribute1>
<Attribute2>sample string 6</Attribute2>
<Attribute3>sample string 7</Attribute3>
<Attribute4>sample string 8</Attribute4>
<Attribute5>sample string 9</Attribute5>
<CustomerSKU>sample string 10</CustomerSKU>
<DeckSKU>sample string 1</DeckSKU>
<EAN>sample string 4</EAN>
<ExternalId>11</ExternalId>
<JAN>sample string 3</JAN>
<UPC>sample string 2</UPC>
</ImportProductGTIN>
<ImportProductGTIN>
<Attribute1>sample string 5</Attribute1>
<Attribute2>sample string 6</Attribute2>
<Attribute3>sample string 7</Attribute3>
<Attribute4>sample string 8</Attribute4>
<Attribute5>sample string 9</Attribute5>
<CustomerSKU>sample string 10</CustomerSKU>
<DeckSKU>sample string 1</DeckSKU>
<EAN>sample string 4</EAN>
<ExternalId>11</ExternalId>
<JAN>sample string 3</JAN>
<UPC>sample string 2</UPC>
</ImportProductGTIN>
</Gtins>
<ImportWithMaster>true</ImportWithMaster>
<IsMaster>true</IsMaster>
<IsStandardProduct>true</IsStandardProduct>
<LocalizableAttributes xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d4p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
</d4p1:value>
</d4p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
<d4p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
<ImportLocaleValueJson>
<LocaleName>sample string 1</LocaleName>
<Value>sample string 2</Value>
</ImportLocaleValueJson>
</d4p1:value>
</d4p1:KeyValuePairOfstringArrayOfImportLocaleValueJsonk8Fimnyq>
</LocalizableAttributes>
<ProductCode>sample string 1</ProductCode>
<ProductType>sample string 2</ProductType>
<SiteSpecificAttributes xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
<d4p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
</d4p1:value>
</d4p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
<d4p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
<d4p1:key>sample string 1</d4p1:key>
<d4p1:value>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
<ImportSiteValueJson>
<SiteName>sample string 1</SiteName>
<Value>sample string 2</Value>
</ImportSiteValueJson>
</d4p1:value>
</d4p1:KeyValuePairOfstringArrayOfImportSiteValueJsonk8Fimnyq>
</SiteSpecificAttributes>
</ImportProductJson>
</StyleProducts>
<TimestampUTC>sample string 3</TimestampUTC>
<VerificationKey>sample string 2</VerificationKey>
</ImportRelatedProductsJson>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseCode | APIResponseCodes |
None. |
|
| Message | string |
None. |
|
| Results | Collection of ProductImportResult |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseCode": 0,
"Message": "sample string 1",
"Results": [
{
"ExternalId": 1,
"ImportResult": 0,
"FailedAttributes": [
"sample string 1",
"sample string 2"
],
"Reason": "sample string 2"
},
{
"ExternalId": 1,
"ImportResult": 0,
"FailedAttributes": [
"sample string 1",
"sample string 2"
],
"Reason": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<ProductImportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.PIM.Common.Contracts.API">
<Message>sample string 1</Message>
<ResponseCode>Success</ResponseCode>
<Results>
<ProductImportResult>
<ExternalId>1</ExternalId>
<FailedAttributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</FailedAttributes>
<ImportResult>Success</ImportResult>
<Reason>sample string 2</Reason>
</ProductImportResult>
<ProductImportResult>
<ExternalId>1</ExternalId>
<FailedAttributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</FailedAttributes>
<ImportResult>Success</ImportResult>
<Reason>sample string 2</Reason>
</ProductImportResult>
</Results>
</ProductImportResponse>