GET api/Cost/Order/{auth}/{ShipmentGUID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

string

Required

ShipmentGUID

string

Required

Body Parameters

None.

Response Information

Resource Description

CostOrderResp
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.

ErrorMessage

string

None.

Costs

Collection of OrderCostItem

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Costs": [
    {
      "CostKey": "sample string 1",
      "CostClass": "sample string 2",
      "CostID": 3,
      "GUID": "sample string 4",
      "EntityNumber": 5,
      "CostTypeID": 6,
      "Name": "sample string 7",
      "Description": "sample string 8",
      "Amount": 9.0,
      "TaxAmount": 10.0,
      "NetAmount": 11.0,
      "CurrencyID": "sample string 12",
      "GLAccountNumber": "sample string 13",
      "InsertUserID": 14,
      "InsertUserName": "sample string 15",
      "InsertDateTime": "2024-09-19T09:13:43.4246135+00:00",
      "EditStatus": "sample string 17",
      "LockFlag": true,
      "LockUserID": 1,
      "LockUserName": "sample string 19",
      "LockDateTime": "2024-09-19T09:13:43.4246135+00:00",
      "VendorID": 1,
      "VendorName": "sample string 20",
      "VendorExternalVendorNum": "sample string 21",
      "CourierID": 1,
      "CourierKey": "sample string 22",
      "CourierName": "sample string 23",
      "CarrierID": 1,
      "CarrierIataID": "sample string 24",
      "CarrierName": "sample string 25",
      "CarrierKey": "sample string 26",
      "VendorInvDetailGUID": "sample string 27",
      "VendorInvApprove": "2024-09-19T09:13:43.4246135+00:00",
      "ReconcileDisplay": "sample string 28",
      "ReconcileNote": "sample string 29",
      "VendorInvoiceNumber": "sample string 30",
      "PrintAmount": 31.0,
      "DueAgentOrCarrier": "sample string 32",
      "SharedAmount": 33.0,
      "ConversionFactor": 1.0,
      "Intercompany": true,
      "IntercompanyOfficeID": 1
    },
    {
      "CostKey": "sample string 1",
      "CostClass": "sample string 2",
      "CostID": 3,
      "GUID": "sample string 4",
      "EntityNumber": 5,
      "CostTypeID": 6,
      "Name": "sample string 7",
      "Description": "sample string 8",
      "Amount": 9.0,
      "TaxAmount": 10.0,
      "NetAmount": 11.0,
      "CurrencyID": "sample string 12",
      "GLAccountNumber": "sample string 13",
      "InsertUserID": 14,
      "InsertUserName": "sample string 15",
      "InsertDateTime": "2024-09-19T09:13:43.4246135+00:00",
      "EditStatus": "sample string 17",
      "LockFlag": true,
      "LockUserID": 1,
      "LockUserName": "sample string 19",
      "LockDateTime": "2024-09-19T09:13:43.4246135+00:00",
      "VendorID": 1,
      "VendorName": "sample string 20",
      "VendorExternalVendorNum": "sample string 21",
      "CourierID": 1,
      "CourierKey": "sample string 22",
      "CourierName": "sample string 23",
      "CarrierID": 1,
      "CarrierIataID": "sample string 24",
      "CarrierName": "sample string 25",
      "CarrierKey": "sample string 26",
      "VendorInvDetailGUID": "sample string 27",
      "VendorInvApprove": "2024-09-19T09:13:43.4246135+00:00",
      "ReconcileDisplay": "sample string 28",
      "ReconcileNote": "sample string 29",
      "VendorInvoiceNumber": "sample string 30",
      "PrintAmount": 31.0,
      "DueAgentOrCarrier": "sample string 32",
      "SharedAmount": 33.0,
      "ConversionFactor": 1.0,
      "Intercompany": true,
      "IntercompanyOfficeID": 1
    }
  ]
}

application/xml, text/xml

Sample:
<CostOrderResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Costs>
    <OrderCostItem>
      <Amount>9</Amount>
      <CarrierID>1</CarrierID>
      <CarrierIataID>sample string 24</CarrierIataID>
      <CarrierKey>sample string 26</CarrierKey>
      <CarrierName>sample string 25</CarrierName>
      <ConversionFactor>1</ConversionFactor>
      <CostClass>sample string 2</CostClass>
      <CostID>3</CostID>
      <CostKey>sample string 1</CostKey>
      <CostTypeID>6</CostTypeID>
      <CourierID>1</CourierID>
      <CourierKey>sample string 22</CourierKey>
      <CourierName>sample string 23</CourierName>
      <CurrencyID>sample string 12</CurrencyID>
      <Description>sample string 8</Description>
      <DueAgentOrCarrier>sample string 32</DueAgentOrCarrier>
      <EditStatus>sample string 17</EditStatus>
      <EntityNumber>5</EntityNumber>
      <GLAccountNumber>sample string 13</GLAccountNumber>
      <GUID>sample string 4</GUID>
      <InsertDateTime>2024-09-19T09:13:43.4246135+00:00</InsertDateTime>
      <InsertUserID>14</InsertUserID>
      <InsertUserName>sample string 15</InsertUserName>
      <Intercompany>true</Intercompany>
      <IntercompanyOfficeID>1</IntercompanyOfficeID>
      <LockDateTime>2024-09-19T09:13:43.4246135+00:00</LockDateTime>
      <LockFlag>true</LockFlag>
      <LockUserID>1</LockUserID>
      <LockUserName>sample string 19</LockUserName>
      <Name>sample string 7</Name>
      <NetAmount>11</NetAmount>
      <PrintAmount>31</PrintAmount>
      <ReconcileDisplay>sample string 28</ReconcileDisplay>
      <ReconcileNote>sample string 29</ReconcileNote>
      <SharedAmount>33</SharedAmount>
      <TaxAmount>10</TaxAmount>
      <VendorExternalVendorNum>sample string 21</VendorExternalVendorNum>
      <VendorID>1</VendorID>
      <VendorInvApprove>2024-09-19T09:13:43.4246135+00:00</VendorInvApprove>
      <VendorInvDetailGUID>sample string 27</VendorInvDetailGUID>
      <VendorInvoiceNumber>sample string 30</VendorInvoiceNumber>
      <VendorName>sample string 20</VendorName>
    </OrderCostItem>
    <OrderCostItem>
      <Amount>9</Amount>
      <CarrierID>1</CarrierID>
      <CarrierIataID>sample string 24</CarrierIataID>
      <CarrierKey>sample string 26</CarrierKey>
      <CarrierName>sample string 25</CarrierName>
      <ConversionFactor>1</ConversionFactor>
      <CostClass>sample string 2</CostClass>
      <CostID>3</CostID>
      <CostKey>sample string 1</CostKey>
      <CostTypeID>6</CostTypeID>
      <CourierID>1</CourierID>
      <CourierKey>sample string 22</CourierKey>
      <CourierName>sample string 23</CourierName>
      <CurrencyID>sample string 12</CurrencyID>
      <Description>sample string 8</Description>
      <DueAgentOrCarrier>sample string 32</DueAgentOrCarrier>
      <EditStatus>sample string 17</EditStatus>
      <EntityNumber>5</EntityNumber>
      <GLAccountNumber>sample string 13</GLAccountNumber>
      <GUID>sample string 4</GUID>
      <InsertDateTime>2024-09-19T09:13:43.4246135+00:00</InsertDateTime>
      <InsertUserID>14</InsertUserID>
      <InsertUserName>sample string 15</InsertUserName>
      <Intercompany>true</Intercompany>
      <IntercompanyOfficeID>1</IntercompanyOfficeID>
      <LockDateTime>2024-09-19T09:13:43.4246135+00:00</LockDateTime>
      <LockFlag>true</LockFlag>
      <LockUserID>1</LockUserID>
      <LockUserName>sample string 19</LockUserName>
      <Name>sample string 7</Name>
      <NetAmount>11</NetAmount>
      <PrintAmount>31</PrintAmount>
      <ReconcileDisplay>sample string 28</ReconcileDisplay>
      <ReconcileNote>sample string 29</ReconcileNote>
      <SharedAmount>33</SharedAmount>
      <TaxAmount>10</TaxAmount>
      <VendorExternalVendorNum>sample string 21</VendorExternalVendorNum>
      <VendorID>1</VendorID>
      <VendorInvApprove>2024-09-19T09:13:43.4246135+00:00</VendorInvApprove>
      <VendorInvDetailGUID>sample string 27</VendorInvDetailGUID>
      <VendorInvoiceNumber>sample string 30</VendorInvoiceNumber>
      <VendorName>sample string 20</VendorName>
    </OrderCostItem>
  </Costs>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</CostOrderResp>