API Load Sales Order Cancellations

HTTP
Method

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

POST

/salesorders/v3/{salesOrderNumber}/cancel

Environment

Request URL

UAT

https://ihubuat.supplystream.com:8081/api/salesorders/v3/<salesOrderNumber>/cancel?api_key=<api_Key>

Live

https://ihub.supplystream.com:8081/api/salesorders/v3/<salesOrderNumber>/cancel?api_key=<api_Key>

Header

Requirement

JSON

XML

Accept

Optional. Returns JSON if undefined.

Accept: application/json

Accept: application/xml

Description

Parameters

Request URL

Includes an sales order number

Sales order number: SOTest234

https://ihubuat.supplystream.com:8081/api/salesorders/v3/SOTest234/cancel?api_key=21121212

XML Format

Body

N/A

Example success Response Body

<?xml version="1.0" encoding="utf-8"?>
<Response>
<CallStatus>
<Success>true</Success>
<Code>0</Code>
<Message></Message>
</CallStatus>
<GUID />
</Response>

Example failure Response Body

<?xml version="1.0" encoding="utf-8"?>
<Response>
<CallStatus>
<Success>false</Success>
<Code>100</Code>
<Message>Error. Sales Order does not exist.</Message>
</CallStatus>
<GUID />
</Response>

JSON Format

Body

N/A

Example success Response Body

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

Example failure Response Body

{
"CallStatus": {
"Success": false,
"Code": 100,
"Message": "Error. Sales Order does not exist."
},
"GUID": null
}