POST api/Orders/GetShipmentsByReference

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGUID	Unique system generated user identifier	string	None.
AccountNumber	Account number	string	None.
ReferenceTypeCode	Reference Type Code	string	None.
ReferenceValue	Reference Value	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "AccountNumber": "sample string 2",
  "ReferenceTypeCode": "sample string 3",
  "ReferenceValue": "sample string 4"
}

application/xml, text/xml

Sample:

<GetShipmentsByReferenceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <AccountNumber>sample string 2</AccountNumber>
  <ReferenceTypeCode>sample string 3</ReferenceTypeCode>
  <ReferenceValue>sample string 4</ReferenceValue>
  <UserGUID>sample string 1</UserGUID>
</GetShipmentsByReferenceParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetShipmentsByReferenceResp

Name	Description	Type	Additional information
IsSuccessful	Set to true if method was successful	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Shipments	Shipments	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Shipments": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<GetShipmentsByReferenceResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Shipments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Shipments>
</GetShipmentsByReferenceResp>