POST api/VehicleLoad/GetTransportHeader

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DeviceUniqueId	string	None.
TransportHeaderCode	string	None.
Version	integer	None.
IdBorderaux	integer	None.
IdOperator	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "DeviceUniqueId": "sample string 1",
  "TransportHeaderCode": "sample string 2",
  "Version": 3,
  "IdBorderaux": 1,
  "IdOperator": 4
}

application/xml, text/xml

Sample:

<VehicleLoad_GetTransportHeaderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PharmatoolsWarehouseAPI.Models">
  <DeviceUniqueId>sample string 1</DeviceUniqueId>
  <IdBorderaux>1</IdBorderaux>
  <IdOperator>4</IdOperator>
  <TransportHeaderCode>sample string 2</TransportHeaderCode>
  <Version>3</Version>
</VehicleLoad_GetTransportHeaderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VehicleLoad_GetTransportHeaderResponse

Name	Type	Additional information
Result	VehicleLoad_GetTransportHeaderResult	None.
TransportHeader	TransportHeader	None.
TotalOUPackages	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": 0,
  "TransportHeader": {
    "IdHeader": 1,
    "Code": "sample string 2",
    "IdOperativeUnit": 3,
    "OUCode": "sample string 4",
    "OUDescription": "sample string 5",
    "IdDeliveryZone": 6,
    "DZCode": "sample string 7",
    "DZDescription": "sample string 8",
    "IdUnloadingPoint": 9,
    "UPCode": "sample string 10",
    "UPDescription": "sample string 11",
    "IdCustomer": 12,
    "Customer": "sample string 13",
    "DeliveryDate": "2025-12-09T02:23:57.3521777+01:00",
    "UrgencyLevel": 0,
    "KanBan": true,
    "Frigo": true,
    "Flammable": true,
    "Cytotoxic": true,
    "Frozen": true,
    "PackagesNumber": 19,
    "Version": 20,
    "VolumeType": "sample string 21",
    "AssociatedByODN": true,
    "DeliveryNotes": [
      {
        "IdDeliveryNote": 1,
        "Transit": true,
        "DeliveryNoteType": "sample string 3",
        "DeliveryNoteNumber": "sample string 4",
        "DeliveryNoteDate": "2025-12-09T02:23:57.3521777+01:00",
        "DeliveryNoteCode": "sample string 6",
        "Status": 0,
        "IdOperativeUnit": 7,
        "OUCode": "sample string 8",
        "OUDescription": "sample string 9",
        "IdCustomer": 10,
        "Customer": "sample string 11",
        "IdPickingList": 1,
        "PickingListType": "sample string 12",
        "PickingListNumber": "sample string 13",
        "PickingListDate": "2025-12-09T02:23:57.3521777+01:00",
        "PickingListStatus": 0,
        "PickingListUrgency": 0
      },
      {
        "IdDeliveryNote": 1,
        "Transit": true,
        "DeliveryNoteType": "sample string 3",
        "DeliveryNoteNumber": "sample string 4",
        "DeliveryNoteDate": "2025-12-09T02:23:57.3521777+01:00",
        "DeliveryNoteCode": "sample string 6",
        "Status": 0,
        "IdOperativeUnit": 7,
        "OUCode": "sample string 8",
        "OUDescription": "sample string 9",
        "IdCustomer": 10,
        "Customer": "sample string 11",
        "IdPickingList": 1,
        "PickingListType": "sample string 12",
        "PickingListNumber": "sample string 13",
        "PickingListDate": "2025-12-09T02:23:57.3521777+01:00",
        "PickingListStatus": 0,
        "PickingListUrgency": 0
      }
    ],
    "Packages": [
      {
        "IdPackage": 1,
        "Index": 2,
        "Code": "sample string 3",
        "SealCode": "sample string 4",
        "IdOperator": 1,
        "DateLoading": "2025-12-09T02:23:57.3521777+01:00"
      },
      {
        "IdPackage": 1,
        "Index": 2,
        "Code": "sample string 3",
        "SealCode": "sample string 4",
        "IdOperator": 1,
        "DateLoading": "2025-12-09T02:23:57.3521777+01:00"
      }
    ]
  },
  "TotalOUPackages": 1
}

application/xml, text/xml

Sample:

<VehicleLoad_GetTransportHeaderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PharmatoolsWarehouseAPI.Models">
  <Result>GenericError</Result>
  <TotalOUPackages>1</TotalOUPackages>
  <TransportHeader>
    <AssociatedByODN>true</AssociatedByODN>
    <Code>sample string 2</Code>
    <Customer>sample string 13</Customer>
    <Cytotoxic>true</Cytotoxic>
    <DZCode>sample string 7</DZCode>
    <DZDescription>sample string 8</DZDescription>
    <DeliveryDate>2025-12-09T02:23:57.3521777+01:00</DeliveryDate>
    <DeliveryNotes>
      <OutDeliveryNote>
        <Customer>sample string 11</Customer>
        <DeliveryNoteCode>sample string 6</DeliveryNoteCode>
        <DeliveryNoteDate>2025-12-09T02:23:57.3521777+01:00</DeliveryNoteDate>
        <DeliveryNoteNumber>sample string 4</DeliveryNoteNumber>
        <DeliveryNoteType>sample string 3</DeliveryNoteType>
        <IdCustomer>10</IdCustomer>
        <IdDeliveryNote>1</IdDeliveryNote>
        <IdOperativeUnit>7</IdOperativeUnit>
        <IdPickingList>1</IdPickingList>
        <OUCode>sample string 8</OUCode>
        <OUDescription>sample string 9</OUDescription>
        <PickingListDate>2025-12-09T02:23:57.3521777+01:00</PickingListDate>
        <PickingListNumber>sample string 13</PickingListNumber>
        <PickingListStatus>newPickingList</PickingListStatus>
        <PickingListType>sample string 12</PickingListType>
        <PickingListUrgency>normal</PickingListUrgency>
        <Status>newDeliveryNote</Status>
        <Transit>true</Transit>
      </OutDeliveryNote>
      <OutDeliveryNote>
        <Customer>sample string 11</Customer>
        <DeliveryNoteCode>sample string 6</DeliveryNoteCode>
        <DeliveryNoteDate>2025-12-09T02:23:57.3521777+01:00</DeliveryNoteDate>
        <DeliveryNoteNumber>sample string 4</DeliveryNoteNumber>
        <DeliveryNoteType>sample string 3</DeliveryNoteType>
        <IdCustomer>10</IdCustomer>
        <IdDeliveryNote>1</IdDeliveryNote>
        <IdOperativeUnit>7</IdOperativeUnit>
        <IdPickingList>1</IdPickingList>
        <OUCode>sample string 8</OUCode>
        <OUDescription>sample string 9</OUDescription>
        <PickingListDate>2025-12-09T02:23:57.3521777+01:00</PickingListDate>
        <PickingListNumber>sample string 13</PickingListNumber>
        <PickingListStatus>newPickingList</PickingListStatus>
        <PickingListType>sample string 12</PickingListType>
        <PickingListUrgency>normal</PickingListUrgency>
        <Status>newDeliveryNote</Status>
        <Transit>true</Transit>
      </OutDeliveryNote>
    </DeliveryNotes>
    <Flammable>true</Flammable>
    <Frigo>true</Frigo>
    <Frozen>true</Frozen>
    <IdCustomer>12</IdCustomer>
    <IdDeliveryZone>6</IdDeliveryZone>
    <IdHeader>1</IdHeader>
    <IdOperativeUnit>3</IdOperativeUnit>
    <IdUnloadingPoint>9</IdUnloadingPoint>
    <KanBan>true</KanBan>
    <OUCode>sample string 4</OUCode>
    <OUDescription>sample string 5</OUDescription>
    <Packages>
      <TransportHeaderPackage>
        <Code>sample string 3</Code>
        <DateLoading>2025-12-09T02:23:57.3521777+01:00</DateLoading>
        <IdOperator>1</IdOperator>
        <IdPackage>1</IdPackage>
        <Index>2</Index>
        <SealCode>sample string 4</SealCode>
      </TransportHeaderPackage>
      <TransportHeaderPackage>
        <Code>sample string 3</Code>
        <DateLoading>2025-12-09T02:23:57.3521777+01:00</DateLoading>
        <IdOperator>1</IdOperator>
        <IdPackage>1</IdPackage>
        <Index>2</Index>
        <SealCode>sample string 4</SealCode>
      </TransportHeaderPackage>
    </Packages>
    <PackagesNumber>19</PackagesNumber>
    <UPCode>sample string 10</UPCode>
    <UPDescription>sample string 11</UPDescription>
    <UrgencyLevel>normal</UrgencyLevel>
    <Version>20</Version>
    <VolumeType>sample string 21</VolumeType>
  </TransportHeader>
</VehicleLoad_GetTransportHeaderResponse>