GET api/SendItBatch/batchSummary/{batchID}

Request Information

URI Parameters

Name	Description	Type	Additional information
batchID		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of BatchPackageSummary

Name	Type	Additional information
OrderBatchPackageID	integer	None.
OrderBatchID	integer	None.
ClientID	integer	None.
ClientShortName	string	None.
OrderID	integer	None.
ShipmentID	integer	None.
ReferenceNumber	string	None.
ShippingServiceCode	string	None.
ConsigneeName	string	None.
ConsigneeCompany	string	None.
ConsigneeCity	string	None.
ConsigneeStateProvince	string	None.
ConsigneePostalCode	string	None.
ConsigneeCountry	string	None.
ShippingServiceName	string	None.
WarehouseID	integer	None.
SKUs	integer	None.
ItemCount	integer	None.
PackageNumber	integer	None.
Weight	decimal number	None.
DimLength	decimal number	None.
DimWidth	decimal number	None.
DimHeight	decimal number	None.
Residential	boolean	None.
OrderStatus	string	None.
OrderStep	integer	None.
PackageStatus	string	None.
PackageID	integer	None.
Shipped	boolean	None.
FaultCount	integer	None.
PrintCount	integer	None.
TrackingNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderBatchPackageID": 1,
    "OrderBatchID": 2,
    "ClientID": 3,
    "ClientShortName": "sample string 4",
    "OrderID": 5,
    "ShipmentID": 6,
    "ReferenceNumber": "sample string 7",
    "ShippingServiceCode": "sample string 8",
    "ConsigneeName": "sample string 9",
    "ConsigneeCompany": "sample string 10",
    "ConsigneeCity": "sample string 11",
    "ConsigneeStateProvince": "sample string 12",
    "ConsigneePostalCode": "sample string 13",
    "ConsigneeCountry": "sample string 14",
    "ShippingServiceName": "sample string 15",
    "WarehouseID": 16,
    "SKUs": 17,
    "ItemCount": 18,
    "PackageNumber": 19,
    "Weight": 20.0,
    "DimLength": 21.0,
    "DimWidth": 22.0,
    "DimHeight": 23.0,
    "Residential": true,
    "OrderStatus": "sample string 25",
    "OrderStep": 26,
    "PackageStatus": "sample string 27",
    "PackageID": 28,
    "Shipped": true,
    "FaultCount": 30,
    "PrintCount": 31,
    "TrackingNumber": "sample string 32"
  },
  {
    "OrderBatchPackageID": 1,
    "OrderBatchID": 2,
    "ClientID": 3,
    "ClientShortName": "sample string 4",
    "OrderID": 5,
    "ShipmentID": 6,
    "ReferenceNumber": "sample string 7",
    "ShippingServiceCode": "sample string 8",
    "ConsigneeName": "sample string 9",
    "ConsigneeCompany": "sample string 10",
    "ConsigneeCity": "sample string 11",
    "ConsigneeStateProvince": "sample string 12",
    "ConsigneePostalCode": "sample string 13",
    "ConsigneeCountry": "sample string 14",
    "ShippingServiceName": "sample string 15",
    "WarehouseID": 16,
    "SKUs": 17,
    "ItemCount": 18,
    "PackageNumber": 19,
    "Weight": 20.0,
    "DimLength": 21.0,
    "DimWidth": 22.0,
    "DimHeight": 23.0,
    "Residential": true,
    "OrderStatus": "sample string 25",
    "OrderStep": 26,
    "PackageStatus": "sample string 27",
    "PackageID": 28,
    "Shipped": true,
    "FaultCount": 30,
    "PrintCount": 31,
    "TrackingNumber": "sample string 32"
  }
]

application/xml, text/xml

Sample:

<ArrayOfBatchPackageSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Models.SendIt">
  <BatchPackageSummary>
    <ClientID>3</ClientID>
    <ClientShortName>sample string 4</ClientShortName>
    <ConsigneeCity>sample string 11</ConsigneeCity>
    <ConsigneeCompany>sample string 10</ConsigneeCompany>
    <ConsigneeCountry>sample string 14</ConsigneeCountry>
    <ConsigneeName>sample string 9</ConsigneeName>
    <ConsigneePostalCode>sample string 13</ConsigneePostalCode>
    <ConsigneeStateProvince>sample string 12</ConsigneeStateProvince>
    <DimHeight>23</DimHeight>
    <DimLength>21</DimLength>
    <DimWidth>22</DimWidth>
    <FaultCount>30</FaultCount>
    <ItemCount>18</ItemCount>
    <OrderBatchID>2</OrderBatchID>
    <OrderBatchPackageID>1</OrderBatchPackageID>
    <OrderID>5</OrderID>
    <OrderStatus>sample string 25</OrderStatus>
    <OrderStep>26</OrderStep>
    <PackageID>28</PackageID>
    <PackageNumber>19</PackageNumber>
    <PackageStatus>sample string 27</PackageStatus>
    <PrintCount>31</PrintCount>
    <ReferenceNumber>sample string 7</ReferenceNumber>
    <Residential>true</Residential>
    <SKUs>17</SKUs>
    <ShipmentID>6</ShipmentID>
    <Shipped>true</Shipped>
    <ShippingServiceCode>sample string 8</ShippingServiceCode>
    <ShippingServiceName>sample string 15</ShippingServiceName>
    <TrackingNumber>sample string 32</TrackingNumber>
    <WarehouseID>16</WarehouseID>
    <Weight>20</Weight>
  </BatchPackageSummary>
  <BatchPackageSummary>
    <ClientID>3</ClientID>
    <ClientShortName>sample string 4</ClientShortName>
    <ConsigneeCity>sample string 11</ConsigneeCity>
    <ConsigneeCompany>sample string 10</ConsigneeCompany>
    <ConsigneeCountry>sample string 14</ConsigneeCountry>
    <ConsigneeName>sample string 9</ConsigneeName>
    <ConsigneePostalCode>sample string 13</ConsigneePostalCode>
    <ConsigneeStateProvince>sample string 12</ConsigneeStateProvince>
    <DimHeight>23</DimHeight>
    <DimLength>21</DimLength>
    <DimWidth>22</DimWidth>
    <FaultCount>30</FaultCount>
    <ItemCount>18</ItemCount>
    <OrderBatchID>2</OrderBatchID>
    <OrderBatchPackageID>1</OrderBatchPackageID>
    <OrderID>5</OrderID>
    <OrderStatus>sample string 25</OrderStatus>
    <OrderStep>26</OrderStep>
    <PackageID>28</PackageID>
    <PackageNumber>19</PackageNumber>
    <PackageStatus>sample string 27</PackageStatus>
    <PrintCount>31</PrintCount>
    <ReferenceNumber>sample string 7</ReferenceNumber>
    <Residential>true</Residential>
    <SKUs>17</SKUs>
    <ShipmentID>6</ShipmentID>
    <Shipped>true</Shipped>
    <ShippingServiceCode>sample string 8</ShippingServiceCode>
    <ShippingServiceName>sample string 15</ShippingServiceName>
    <TrackingNumber>sample string 32</TrackingNumber>
    <WarehouseID>16</WarehouseID>
    <Weight>20</Weight>
  </BatchPackageSummary>
</ArrayOfBatchPackageSummary>