POST api/OrderTasks

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth		string	None.
ShipmentGUID		string	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "ShipmentGUID": "sample string 2"
}

application/xml, text/xml

Sample:

<ShipmentTaskParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <auth>sample string 1</auth>
</ShipmentTaskParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipmentTaskResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
Tasks	Collection of ShipmentTaskItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Tasks": [
    {
      "ShipmentTaskGUID": "sample string 1",
      "ShipmentGUID": "sample string 2",
      "OverrideType": "sample string 3",
      "OverrideStatus": 1,
      "OverrideStatusName": "sample string 4",
      "OverrideDateTime": "2024-09-19T09:06:52.6754219+00:00",
      "ShortNote": "sample string 5",
      "Description": "sample string 6",
      "ClearedDateTime": "2024-09-19T09:06:52.6754219+00:00",
      "ClearedUserGUID": "sample string 7",
      "ClearedUserName": "sample string 8",
      "ClearedNote": "sample string 9",
      "InsertDateTime": "2024-09-19T09:06:52.6754219+00:00",
      "InsertUserGUID": "sample string 11",
      "InsertUserName": "sample string 12",
      "UpdateDateTime": "2024-09-19T09:06:52.6754219+00:00",
      "UpdateUserGUID": "sample string 13",
      "UpdateUserName": "sample string 14",
      "StatusIcon": "sample string 15",
      "RoleForTask": "sample string 16",
      "OverrideDescription": "sample string 17",
      "CreatedByDisplay": "sample string 18",
      "ClearedByDisplay": "sample string 19",
      "UpdatedByDisplay": "sample string 20"
    },
    {
      "ShipmentTaskGUID": "sample string 1",
      "ShipmentGUID": "sample string 2",
      "OverrideType": "sample string 3",
      "OverrideStatus": 1,
      "OverrideStatusName": "sample string 4",
      "OverrideDateTime": "2024-09-19T09:06:52.6754219+00:00",
      "ShortNote": "sample string 5",
      "Description": "sample string 6",
      "ClearedDateTime": "2024-09-19T09:06:52.6754219+00:00",
      "ClearedUserGUID": "sample string 7",
      "ClearedUserName": "sample string 8",
      "ClearedNote": "sample string 9",
      "InsertDateTime": "2024-09-19T09:06:52.6754219+00:00",
      "InsertUserGUID": "sample string 11",
      "InsertUserName": "sample string 12",
      "UpdateDateTime": "2024-09-19T09:06:52.6754219+00:00",
      "UpdateUserGUID": "sample string 13",
      "UpdateUserName": "sample string 14",
      "StatusIcon": "sample string 15",
      "RoleForTask": "sample string 16",
      "OverrideDescription": "sample string 17",
      "CreatedByDisplay": "sample string 18",
      "ClearedByDisplay": "sample string 19",
      "UpdatedByDisplay": "sample string 20"
    }
  ]
}

application/xml, text/xml

Sample:

<ShipmentTaskResp 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>
  <Tasks>
    <ShipmentTaskItem>
      <ClearedByDisplay>sample string 19</ClearedByDisplay>
      <ClearedDateTime>2024-09-19T09:06:52.6754219+00:00</ClearedDateTime>
      <ClearedNote>sample string 9</ClearedNote>
      <ClearedUserGUID>sample string 7</ClearedUserGUID>
      <ClearedUserName>sample string 8</ClearedUserName>
      <CreatedByDisplay>sample string 18</CreatedByDisplay>
      <Description>sample string 6</Description>
      <InsertDateTime>2024-09-19T09:06:52.6754219+00:00</InsertDateTime>
      <InsertUserGUID>sample string 11</InsertUserGUID>
      <InsertUserName>sample string 12</InsertUserName>
      <OverrideDateTime>2024-09-19T09:06:52.6754219+00:00</OverrideDateTime>
      <OverrideDescription>sample string 17</OverrideDescription>
      <OverrideStatus>1</OverrideStatus>
      <OverrideStatusName>sample string 4</OverrideStatusName>
      <OverrideType>sample string 3</OverrideType>
      <RoleForTask>sample string 16</RoleForTask>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <ShipmentTaskGUID>sample string 1</ShipmentTaskGUID>
      <ShortNote>sample string 5</ShortNote>
      <StatusIcon>sample string 15</StatusIcon>
      <UpdateDateTime>2024-09-19T09:06:52.6754219+00:00</UpdateDateTime>
      <UpdateUserGUID>sample string 13</UpdateUserGUID>
      <UpdateUserName>sample string 14</UpdateUserName>
      <UpdatedByDisplay>sample string 20</UpdatedByDisplay>
    </ShipmentTaskItem>
    <ShipmentTaskItem>
      <ClearedByDisplay>sample string 19</ClearedByDisplay>
      <ClearedDateTime>2024-09-19T09:06:52.6754219+00:00</ClearedDateTime>
      <ClearedNote>sample string 9</ClearedNote>
      <ClearedUserGUID>sample string 7</ClearedUserGUID>
      <ClearedUserName>sample string 8</ClearedUserName>
      <CreatedByDisplay>sample string 18</CreatedByDisplay>
      <Description>sample string 6</Description>
      <InsertDateTime>2024-09-19T09:06:52.6754219+00:00</InsertDateTime>
      <InsertUserGUID>sample string 11</InsertUserGUID>
      <InsertUserName>sample string 12</InsertUserName>
      <OverrideDateTime>2024-09-19T09:06:52.6754219+00:00</OverrideDateTime>
      <OverrideDescription>sample string 17</OverrideDescription>
      <OverrideStatus>1</OverrideStatus>
      <OverrideStatusName>sample string 4</OverrideStatusName>
      <OverrideType>sample string 3</OverrideType>
      <RoleForTask>sample string 16</RoleForTask>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <ShipmentTaskGUID>sample string 1</ShipmentTaskGUID>
      <ShortNote>sample string 5</ShortNote>
      <StatusIcon>sample string 15</StatusIcon>
      <UpdateDateTime>2024-09-19T09:06:52.6754219+00:00</UpdateDateTime>
      <UpdateUserGUID>sample string 13</UpdateUserGUID>
      <UpdateUserName>sample string 14</UpdateUserName>
      <UpdatedByDisplay>sample string 20</UpdatedByDisplay>
    </ShipmentTaskItem>
  </Tasks>
</ShipmentTaskResp>