POST api/CommonShipper

Request Information

URI Parameters

None.

Body Parameters

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

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonShipperResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
CommonShippers	Collection of CommonShipperItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "CommonShippers": [
    {
      "CommonShipperID": "sample string 1",
      "CompanyID": 2,
      "OfficeID": 1,
      "OfficeCode": "sample string 3",
      "UserID": 1,
      "UserName": "sample string 4",
      "ShipperName": "sample string 5",
      "PhoneNumber": "sample string 6",
      "FaxNumber": "sample string 7",
      "EmailAddress": "sample string 8",
      "CustomerID": 9,
      "CustomerName": "sample string 10",
      "AccountNumber": "sample string 11",
      "Reference": "sample string 12",
      "BillToAttention": "sample string 13",
      "Contents": "sample string 14",
      "Pieces": 1,
      "Weight": 1.0,
      "WeightUOM": "sample string 15",
      "InsertUserID": 16,
      "InsertDateTime": "2024-12-28T09:19:04.0289875+00:00",
      "UserSpecified": true
    },
    {
      "CommonShipperID": "sample string 1",
      "CompanyID": 2,
      "OfficeID": 1,
      "OfficeCode": "sample string 3",
      "UserID": 1,
      "UserName": "sample string 4",
      "ShipperName": "sample string 5",
      "PhoneNumber": "sample string 6",
      "FaxNumber": "sample string 7",
      "EmailAddress": "sample string 8",
      "CustomerID": 9,
      "CustomerName": "sample string 10",
      "AccountNumber": "sample string 11",
      "Reference": "sample string 12",
      "BillToAttention": "sample string 13",
      "Contents": "sample string 14",
      "Pieces": 1,
      "Weight": 1.0,
      "WeightUOM": "sample string 15",
      "InsertUserID": 16,
      "InsertDateTime": "2024-12-28T09:19:04.0289875+00:00",
      "UserSpecified": true
    }
  ]
}

application/xml, text/xml

Sample:

<CommonShipperResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <CommonShippers>
    <CommonShipperItem>
      <AccountNumber>sample string 11</AccountNumber>
      <BillToAttention>sample string 13</BillToAttention>
      <CommonShipperID>sample string 1</CommonShipperID>
      <CompanyID>2</CompanyID>
      <Contents>sample string 14</Contents>
      <CustomerID>9</CustomerID>
      <CustomerName>sample string 10</CustomerName>
      <EmailAddress>sample string 8</EmailAddress>
      <FaxNumber>sample string 7</FaxNumber>
      <InsertDateTime>2024-12-28T09:19:04.0289875+00:00</InsertDateTime>
      <InsertUserID>16</InsertUserID>
      <OfficeCode>sample string 3</OfficeCode>
      <OfficeID>1</OfficeID>
      <PhoneNumber>sample string 6</PhoneNumber>
      <Pieces>1</Pieces>
      <Reference>sample string 12</Reference>
      <ShipperName>sample string 5</ShipperName>
      <UserID>1</UserID>
      <UserName>sample string 4</UserName>
      <UserSpecified>true</UserSpecified>
      <Weight>1</Weight>
      <WeightUOM>sample string 15</WeightUOM>
    </CommonShipperItem>
    <CommonShipperItem>
      <AccountNumber>sample string 11</AccountNumber>
      <BillToAttention>sample string 13</BillToAttention>
      <CommonShipperID>sample string 1</CommonShipperID>
      <CompanyID>2</CompanyID>
      <Contents>sample string 14</Contents>
      <CustomerID>9</CustomerID>
      <CustomerName>sample string 10</CustomerName>
      <EmailAddress>sample string 8</EmailAddress>
      <FaxNumber>sample string 7</FaxNumber>
      <InsertDateTime>2024-12-28T09:19:04.0289875+00:00</InsertDateTime>
      <InsertUserID>16</InsertUserID>
      <OfficeCode>sample string 3</OfficeCode>
      <OfficeID>1</OfficeID>
      <PhoneNumber>sample string 6</PhoneNumber>
      <Pieces>1</Pieces>
      <Reference>sample string 12</Reference>
      <ShipperName>sample string 5</ShipperName>
      <UserID>1</UserID>
      <UserName>sample string 4</UserName>
      <UserSpecified>true</UserSpecified>
      <Weight>1</Weight>
      <WeightUOM>sample string 15</WeightUOM>
    </CommonShipperItem>
  </CommonShippers>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</CommonShipperResp>