POST Consignment/CancelLabel
Request Information
URI Parameters
None.
Body Parameters
CancelLabelRequestName | Description | Type | Additional information |
---|---|---|---|
OrderReference | string |
None. |
|
AuthorizationToken | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "OrderReference": "sample string 1", "AuthorizationToken": "sample string 2" }
application/xml, text/xml
Sample:
<CancelLabelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.Order"> <AuthorizationToken xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.Base">sample string 2</AuthorizationToken> <OrderReference>sample string 1</OrderReference> </CancelLabelRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CancelLabelResponseName | Description | Type | Additional information |
---|---|---|---|
ErrorMessage | string |
None. |
|
IsError | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "ErrorMessage": "sample string 1", "IsError": true }
application/xml, text/xml
Sample:
<CancelLabelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.Order"> <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.Base">sample string 1</ErrorMessage> <IsError xmlns="http://schemas.datacontract.org/2004/07/Transglobal.Entities.Objects.Linnworks.RequestAndResponse.Base">true</IsError> </CancelLabelResponse>