API Load Product Masters

HTTP
Method

/<service>/<version>/<parameters>

POST

/products/v4/submit

Environment

Request URL

UAT

https://ihubuat.supplystream.com:8081/api/products/v4/submit?api_key=<api_Key>

Live

https://ihub.supplystream.com:8081/api/products/v4/submit?api_key=<api_Key>

Header

Requirement

JSON

XML

Content-Type

Required

Content-Type: application/json

Content-Type: application/xml

Accept

Optional. Returns Content-Type format if undefined

Accept: application/json

Accept: application/xml

XML Format

Body

<Request>
<ProductMaster>
<CountryOfOrigin>string</CountryOfOrigin>
<Brand>string</Brand>
<Colour>string</Colour>
<Size>string</Size>
<GroupIdentifier>string</GroupIdentifier>
<QCControlled>true</QCControlled>
<QCPercentage>1</QCPercentage>
<SerialNumberControlled>true</SerialNumberControlled>
<InwardProcessing>true</InwardProcessing>
<WetBond>true</WetBond>
<UnitPrice>1.1</UnitPrice>
<LeadTime>1</LeadTime>
<Category1>string</Category1>
<Category2>string</Category2>
<MOQ>1</MOQ>
<Currency>string</Currency>
<ProductUse>string</ProductUse>
<ClientProductStatus>string</ClientProductStatus>
<Business>string</Business>
<Bonded>true</Bonded>
<SecondaryCurrencyCode>string</SecondaryCurrencyCode>
<SecondaryPrice>1.1</SecondaryPrice>
<StyleCode>string</StyleCode>
<EAN>string</EAN>
<HTSCode>string</HTSCode>
<ProductDescription>string</ProductDescription>
<DateControlled>true</DateControlled>
<GrossWeight>1.1</GrossWeight>
<GrossWeightUOM>string</GrossWeightUOM>
<LotControlled>true</LotControlled>
<Hazardous>true</Hazardous>
<ProductCode>string</ProductCode>
<ProductLongDescription>string</ProductLongDescription>
</ProductMaster>
<List>
<Image>
<ImageData>string</ImageData>
<DefaultImage>true</DefaultImage>
</Image>
<SupplierMapping>
<SupplierCode>string</SupplierCode>
<SupplierDescription>string</SupplierDescription>
<UOM>1</UOM>
</SupplierMapping>
<ShipToCompanyMapping>
<BranchCode>string</BranchCode>
<CompanyCode>string</CompanyCode>
<MappedCode>string</MappedCode>
</ShipToCompanyMapping>
<ProductCategory>
<CategoryCode>string</CategoryCode>
</ProductCategory>
<ProductIdentifier>
<Name>string</Name>
<Values>string</Values>
</ProductIdentifier>
</List>
</Request>

Example success Response Body

<Response>
<CallStatus>
<Success>true</Success>
<Code>0</Code>
<Message></Message>
</CallStatus>
</Response>

Example failure Response Body

<Response>
<CallStatus>
<Success>false</Success>
<Code>100</Code>
<Message>Error. Product Code PMTest123 already exists.</Message>
</CallStatus>
</Response>

JSON Format

Body

{
"ProductMaster": {
"CountryOfOrigin": "string",
"Brand": "string",
"Colour": "string",
"Size": "string",
"GroupIdentifier": "string",
"QCControlled": true,
"QCPercentage": 0,
"SerialNumberControlled": true,
"InwardProcessing": true,
"WetBond": true,
"UnitPrice": 0,
"LeadTime": 0,
"Category1": "string",
"Category2": "string",
"MOQ": 0,
"Currency": "string",
"ProductUse": "string",
"ClientProductStatus": "string",
"Business": "string",
"Bonded": true,
"SecondaryCurrencyCode": "string",
"SecondaryPrice": 0,
"StyleCode": "string",
"EAN": "string",
"HTSCode": "string",
"ProductDescription": "string",
"DateControlled": true,
"GrossWeight": 0,
"GrossWeightUOM": "string",
"LotControlled": true,
"Hazardous": true,
"ProductCode": "string",
"ProductLongDescription": "string"
},
"List": {
"Image": [
{
"ImageData": "string",
"DefaultImage": true
}
],
"SupplierMapping": [
{
"SupplierCode": "string",
"SupplierDescription": "string",
"UOM": 0
}
],
"ShipToCompanyMapping": [
{
"BranchCode": "string",
"CompanyCode": "string",
"MappedCode": "string"
}
],
"ProductCategory": [
{
"CategoryCode": "string"
}
],
"ProductIdentifier": [
{
"Name": "string",
"Values": "string"
}
]
}
}

Example success Response Body

{
"CallStatus": {
"Success": true,
"Code": 0,
"Message": ""
}
}

Example failure Response Body

{
"CallStatus": {
"Success": false,
"Code": 100,
"Message": "Error Submitting Product Master: PMTest123 - Error. Product Code PMTest123 already exists."
}
}