API Load Receipts

HTTP
Method

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

POST

/receipts/v3/submit

Environment

Request URL

UAT

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

Live

https://ihub.supplystream.com:8081/api/receipts/v3/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

<?xml version="1.0"?>
<Request>
<Receipt>
<ReceiptReasonCode>string</ReceiptReasonCode>
<UpdateReceipt>true</UpdateReceipt>
<ReceiptType>string</ReceiptType>
<ASNNumber>string</ASNNumber>
<GUID>string</GUID>
<HBReference>string</HBReference>
<IsReturn>true</IsReturn>
<Notes>string</Notes>
<WarehouseETA>1970-01-01T00:00:00.001Z</WarehouseETA>
</Receipt>
<ReceiptHeader>
<DCCode>string</DCCode>
</ReceiptHeader>
<List>
<ReceiptLineItem>
<LotNumber>string</LotNumber>
<CaseCount>1</CaseCount>
<BestBeforeDate>1970-01-01T00:00:00.001Z</BestBeforeDate>
<SupplierName>string</SupplierName>
<CountryOfOrigin>string</CountryOfOrigin>
<MIDCode>string</MIDCode>
<Channel>string</Channel>
<EAN>string</EAN>
<GUID>string</GUID>
<LineNumber>1</LineNumber>
<ProductCode>string</ProductCode>
<Quantity>1</Quantity>
<ReturnReason>string</ReturnReason>
<SupplierCompanyCode>string</SupplierCompanyCode>
</ReceiptLineItem>
</List>
</Request>

Example success Response Body

<?xml version="1.0" encoding="utf-8"?>
<Response>
<CallStatus>
<Success>true</Success>
<Code>0</Code>
<Message></Message>
</CallStatus>
<GUID>14d78523-3cfb-4460-befb-897e4c196cb7</GUID>
</Response>

Example failure Response Body

<?xml version="1.0" encoding="utf-8"?>
<Response>
<CallStatus>
<Success>false</Success>
<Code>100</Code>
<Message>Error. Invalid Mapping - DC</Message>
</CallStatus>
<GUID />
</Response>

JSON Format

Body

{
"Receipt": {
"ReceiptReasonCode": "string",
"UpdateReceipt": true,
"ReceiptType": "string",
"ASNNumber": "string",
"GUID": "string",
"HBReference": "string",
"IsReturn": true,
"Notes": "string",
"WarehouseETA": "2017-10-11T08:11:25.872Z"
},
"ReceiptHeader": {
"DCCode": "string"
},
"List": {
"ReceiptLineItem": [
{
"LotNumber": "string",
"CaseCount": 0,
"BestBeforeDate": "2017-10-11T08:11:25.872Z",
"SupplierName": "string",
"CountryOfOrigin": "string",
"MIDCode": "string",
"Channel": "string",
"EAN": "string",
"GUID": "string",
"LineNumber": 0,
"ProductCode": "string",
"Quantity": 0,
"ReturnReason": "string",
"SupplierCompanyCode": "string"
}
]
}
}

Example success Response Body

{
"CallStatus": {
"Success": true,
"Code": 0,
"Message": ""
},
"GUID": "bc6c46f1-1972-4be7-916f-496e709663cb"
}

Example failure Response Body

{
"CallStatus": {
"Success": false,
"Code": 100,
"Message": "Error. Invalid Mapping - DC"
},
"GUID": null
}