POST api/Bag

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
ManifestGUID	string	None.
BagNumber	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "ManifestGUID": "sample string 2",
  "BagNumber": 1
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BagResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
Bags	Collection of BagItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Bags": [
    {
      "BagGUID": "sample string 1",
      "BagNumber": 2,
      "BagIdentifier": "sample string 3",
      "BagIdentifierOrNumber": "sample string 4",
      "CompanyID": 5,
      "ManifestGUID": "sample string 6",
      "BagTypeID": 7,
      "PackagingType": "sample string 8",
      "BagTypeName": "sample string 9",
      "Weight": 10.0,
      "DimWeight": 1.0,
      "WeightDescription": "sample string 11",
      "DimWeightDescription": "sample string 12",
      "WeightUOM": "sample string 13",
      "Length": 1,
      "Width": 1,
      "Height": 1,
      "SizeUOM": "sample string 14",
      "SizeDescription": "sample string 15",
      "InsertUserID": 16,
      "InsertUserName": "sample string 17",
      "InsertDateTime": "2024-09-19T09:19:38.3780644+00:00",
      "PieceCount": 19,
      "ManifestNumber": 20,
      "DepartHubID": "sample string 21",
      "ArriveHubID": "sample string 22",
      "DisplayDescription": "sample string 23",
      "BagDescription": "sample string 24",
      "Weight_LB": 25.0,
      "Weight_KG": 26.0,
      "DimWeight_LB": 1.0,
      "DimWeight_KG": 1.0,
      "WeightUser": 1.0,
      "DimWeightUser": 1.0,
      "LengthUser": 1,
      "WidthUser": 1,
      "HeightUser": 1
    },
    {
      "BagGUID": "sample string 1",
      "BagNumber": 2,
      "BagIdentifier": "sample string 3",
      "BagIdentifierOrNumber": "sample string 4",
      "CompanyID": 5,
      "ManifestGUID": "sample string 6",
      "BagTypeID": 7,
      "PackagingType": "sample string 8",
      "BagTypeName": "sample string 9",
      "Weight": 10.0,
      "DimWeight": 1.0,
      "WeightDescription": "sample string 11",
      "DimWeightDescription": "sample string 12",
      "WeightUOM": "sample string 13",
      "Length": 1,
      "Width": 1,
      "Height": 1,
      "SizeUOM": "sample string 14",
      "SizeDescription": "sample string 15",
      "InsertUserID": 16,
      "InsertUserName": "sample string 17",
      "InsertDateTime": "2024-09-19T09:19:38.3780644+00:00",
      "PieceCount": 19,
      "ManifestNumber": 20,
      "DepartHubID": "sample string 21",
      "ArriveHubID": "sample string 22",
      "DisplayDescription": "sample string 23",
      "BagDescription": "sample string 24",
      "Weight_LB": 25.0,
      "Weight_KG": 26.0,
      "DimWeight_LB": 1.0,
      "DimWeight_KG": 1.0,
      "WeightUser": 1.0,
      "DimWeightUser": 1.0,
      "LengthUser": 1,
      "WidthUser": 1,
      "HeightUser": 1
    }
  ]
}

application/xml, text/xml

Sample:

<BagResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Bags>
    <BagItem>
      <ArriveHubID>sample string 22</ArriveHubID>
      <BagDescription>sample string 24</BagDescription>
      <BagGUID>sample string 1</BagGUID>
      <BagIdentifier>sample string 3</BagIdentifier>
      <BagIdentifierOrNumber>sample string 4</BagIdentifierOrNumber>
      <BagNumber>2</BagNumber>
      <BagTypeID>7</BagTypeID>
      <BagTypeName>sample string 9</BagTypeName>
      <CompanyID>5</CompanyID>
      <DepartHubID>sample string 21</DepartHubID>
      <DimWeight>1</DimWeight>
      <DimWeightDescription>sample string 12</DimWeightDescription>
      <DimWeightUser>1</DimWeightUser>
      <DimWeight_KG>1</DimWeight_KG>
      <DimWeight_LB>1</DimWeight_LB>
      <DisplayDescription>sample string 23</DisplayDescription>
      <Height>1</Height>
      <HeightUser>1</HeightUser>
      <InsertDateTime>2024-09-19T09:19:38.3780644+00:00</InsertDateTime>
      <InsertUserID>16</InsertUserID>
      <InsertUserName>sample string 17</InsertUserName>
      <Length>1</Length>
      <LengthUser>1</LengthUser>
      <ManifestGUID>sample string 6</ManifestGUID>
      <ManifestNumber>20</ManifestNumber>
      <PackagingType>sample string 8</PackagingType>
      <PieceCount>19</PieceCount>
      <SizeDescription>sample string 15</SizeDescription>
      <SizeUOM>sample string 14</SizeUOM>
      <Weight>10</Weight>
      <WeightDescription>sample string 11</WeightDescription>
      <WeightUOM>sample string 13</WeightUOM>
      <WeightUser>1</WeightUser>
      <Weight_KG>26</Weight_KG>
      <Weight_LB>25</Weight_LB>
      <Width>1</Width>
      <WidthUser>1</WidthUser>
    </BagItem>
    <BagItem>
      <ArriveHubID>sample string 22</ArriveHubID>
      <BagDescription>sample string 24</BagDescription>
      <BagGUID>sample string 1</BagGUID>
      <BagIdentifier>sample string 3</BagIdentifier>
      <BagIdentifierOrNumber>sample string 4</BagIdentifierOrNumber>
      <BagNumber>2</BagNumber>
      <BagTypeID>7</BagTypeID>
      <BagTypeName>sample string 9</BagTypeName>
      <CompanyID>5</CompanyID>
      <DepartHubID>sample string 21</DepartHubID>
      <DimWeight>1</DimWeight>
      <DimWeightDescription>sample string 12</DimWeightDescription>
      <DimWeightUser>1</DimWeightUser>
      <DimWeight_KG>1</DimWeight_KG>
      <DimWeight_LB>1</DimWeight_LB>
      <DisplayDescription>sample string 23</DisplayDescription>
      <Height>1</Height>
      <HeightUser>1</HeightUser>
      <InsertDateTime>2024-09-19T09:19:38.3780644+00:00</InsertDateTime>
      <InsertUserID>16</InsertUserID>
      <InsertUserName>sample string 17</InsertUserName>
      <Length>1</Length>
      <LengthUser>1</LengthUser>
      <ManifestGUID>sample string 6</ManifestGUID>
      <ManifestNumber>20</ManifestNumber>
      <PackagingType>sample string 8</PackagingType>
      <PieceCount>19</PieceCount>
      <SizeDescription>sample string 15</SizeDescription>
      <SizeUOM>sample string 14</SizeUOM>
      <Weight>10</Weight>
      <WeightDescription>sample string 11</WeightDescription>
      <WeightUOM>sample string 13</WeightUOM>
      <WeightUser>1</WeightUser>
      <Weight_KG>26</Weight_KG>
      <Weight_LB>25</Weight_LB>
      <Width>1</Width>
      <WidthUser>1</WidthUser>
    </BagItem>
  </Bags>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</BagResp>