POST api/Order/SendStatusEmail
Request Information
URI Parameters
None.
Body Parameters
SendStatusEmailParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| ShipmentGUID | string |
None. |
|
| SendToEmailAddress | string |
None. |
|
| IncludeTracking | boolean |
None. |
|
| IncludeMe | boolean |
None. |
|
| Comment | string |
None. |
|
| Subject | string |
None. |
|
| ShipmentDocumentIDList | Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"ShipmentGUID": "sample string 2",
"SendToEmailAddress": "sample string 3",
"IncludeTracking": true,
"IncludeMe": true,
"Comment": "sample string 6",
"Subject": "sample string 7",
"ShipmentDocumentIDList": [
1,
2
]
}
application/xml, text/xml
Sample:
<SendStatusEmailParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
<Comment>sample string 6</Comment>
<IncludeMe>true</IncludeMe>
<IncludeTracking>true</IncludeTracking>
<SendToEmailAddress>sample string 3</SendToEmailAddress>
<ShipmentDocumentIDList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ShipmentDocumentIDList>
<ShipmentGUID>sample string 2</ShipmentGUID>
<Subject>sample string 7</Subject>
<auth>sample string 1</auth>
</SendStatusEmailParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBase| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2"
}
application/xml, text/xml
Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>