POST api/Document/Shipment/Update
Request Information
URI Parameters
None.
Body Parameters
UpdateShipmentDocumentParmName | Description | Type | Additional information |
---|---|---|---|
auth | string |
None. |
|
ShipmentDocumentID | integer |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
DocumentTypeID | integer |
None. |
|
IncludeWithPickup | boolean |
None. |
|
IncludeWithDelivery | boolean |
None. |
|
VisibleToCustomers | boolean |
None. |
|
IncludeWithInvoice | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "auth": "sample string 1", "ShipmentDocumentID": 2, "Name": "sample string 3", "Description": "sample string 4", "DocumentTypeID": 5, "IncludeWithPickup": true, "IncludeWithDelivery": true, "VisibleToCustomers": true, "IncludeWithInvoice": true }
application/xml, text/xml
Sample:
<UpdateShipmentDocumentParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <Description>sample string 4</Description> <DocumentTypeID>5</DocumentTypeID> <IncludeWithDelivery>true</IncludeWithDelivery> <IncludeWithInvoice>true</IncludeWithInvoice> <IncludeWithPickup>true</IncludeWithPickup> <Name>sample string 3</Name> <ShipmentDocumentID>2</ShipmentDocumentID> <VisibleToCustomers>true</VisibleToCustomers> <auth>sample string 1</auth> </UpdateShipmentDocumentParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBaseName | 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>