PUT api/CrmLunchboxCancel?lunchboxId={lunchboxId}&specialtysNetUserId={specialtysNetUserId}&isDefect={isDefect}¬es={notes}
Cancels an order
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
lunchboxId |
Order number |
integer |
Required |
specialtysNetUserId |
Specialtys User ID that is requesting order cancellation |
integer |
Required |
isDefect |
Was this caused by a stores mistake |
boolean |
Required |
notes |
Notes describing why the order was canceled |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
BaseResponseName | Description | Type | Additional information |
---|---|---|---|
Success | boolean |
None. |
|
ExceptionMessage | string |
None. |
|
SuccessMessage | string |
None. |
|
IsBaseResponse | boolean |
None. |
|
NewSessionLunchcartCreated | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Success": true, "ExceptionMessage": "sample string 2", "SuccessMessage": "sample string 3", "IsBaseResponse": true, "NewSessionLunchcartCreated": true }
text/html
Sample:
{"Success":true,"ExceptionMessage":"sample string 2","SuccessMessage":"sample string 3","IsBaseResponse":true,"NewSessionLunchcartCreated":true}
application/xml, text/xml
Sample:
<BaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Specialtys.DTO.Response"> <ExceptionMessage>sample string 2</ExceptionMessage> <IsBaseResponse>true</IsBaseResponse> <NewSessionLunchcartCreated>true</NewSessionLunchcartCreated> <Success>true</Success> <SuccessMessage>sample string 3</SuccessMessage> </BaseResponse>