GET api/Reference/{auth}/{ShipmentGUID}

Request Information

URI Parameters

Name	Description	Type	Additional information
auth		string	Required
ShipmentGUID		string	Required

Body Parameters

None.

Response Information

Resource Description

ShipmentReferenceResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
References	Collection of ShipmentReferenceItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "References": [
    {
      "ShipmentReferenceID": 1,
      "ShipmentGUID": "sample string 2",
      "ReferenceTypeID": 3,
      "ReferenceTypeCode": "sample string 4",
      "ReferenceTypeName": "sample string 5",
      "FieldLabelInternal": "sample string 6",
      "FieldLabelExternal": "sample string 7",
      "Value": "sample string 8",
      "InsertUserID": 9,
      "InsertDateTime": "2025-12-03T12:33:26.4068097+00:00"
    },
    {
      "ShipmentReferenceID": 1,
      "ShipmentGUID": "sample string 2",
      "ReferenceTypeID": 3,
      "ReferenceTypeCode": "sample string 4",
      "ReferenceTypeName": "sample string 5",
      "FieldLabelInternal": "sample string 6",
      "FieldLabelExternal": "sample string 7",
      "Value": "sample string 8",
      "InsertUserID": 9,
      "InsertDateTime": "2025-12-03T12:33:26.4068097+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<ShipmentReferenceResp 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>
  <References>
    <ShipmentReferenceItem>
      <FieldLabelExternal>sample string 7</FieldLabelExternal>
      <FieldLabelInternal>sample string 6</FieldLabelInternal>
      <InsertDateTime>2025-12-03T12:33:26.4068097+00:00</InsertDateTime>
      <InsertUserID>9</InsertUserID>
      <ReferenceTypeCode>sample string 4</ReferenceTypeCode>
      <ReferenceTypeID>3</ReferenceTypeID>
      <ReferenceTypeName>sample string 5</ReferenceTypeName>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <ShipmentReferenceID>1</ShipmentReferenceID>
      <Value>sample string 8</Value>
    </ShipmentReferenceItem>
    <ShipmentReferenceItem>
      <FieldLabelExternal>sample string 7</FieldLabelExternal>
      <FieldLabelInternal>sample string 6</FieldLabelInternal>
      <InsertDateTime>2025-12-03T12:33:26.4068097+00:00</InsertDateTime>
      <InsertUserID>9</InsertUserID>
      <ReferenceTypeCode>sample string 4</ReferenceTypeCode>
      <ReferenceTypeID>3</ReferenceTypeID>
      <ReferenceTypeName>sample string 5</ReferenceTypeName>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <ShipmentReferenceID>1</ShipmentReferenceID>
      <Value>sample string 8</Value>
    </ShipmentReferenceItem>
  </References>
</ShipmentReferenceResp>