Documentation for GET api/Shipping/OrderInformation/GetOrders

GET api/Shipping/OrderInformation/GetOrders

This API method will allow you to get a specific order(s) information for shipping by the primary identifier or all orders for a date range

Request Information

URI Parameters

None.

Body Parameters

OrderShippingRequestModel

Name	Type	Additional information
startDate	date	None.
endDate	date	None.
carrierName	string	None.
orderID	integer	None.
shipCountry	string	None.
shipMethodID	integer	None.

Request Formats

application/xml, text/xml

Sample:

<OrderShippingRequestModel>
  <StartDate>01/09/2025 01:36:56</StartDate>
  <EndDate>01/09/2025 01:36:56</EndDate>
  <CarrierName>sample string 1</CarrierName>
  <OrderID>1</OrderID>
  <ShipCountry>sample string 2</ShipCountry>
  <ShipMethodID>1</ShipMethodID>
</OrderShippingRequestModel>

application/json, text/json

Sample:

{
  "startDate": "2025-01-09T01:36:56.5705976-05:00",
  "endDate": "2025-01-09T01:36:56.5705976-05:00",
  "carrierName": "sample string 1",
  "orderID": 1,
  "shipCountry": "sample string 2",
  "shipMethodID": 1
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'OrderShippingRequestModel'.

Response Information

Resource Description

Collection of OrderShippingViewModel

Name	Type	Additional information
OrderDate	date	None.
DatePosted	date	None.
OrderNumber	integer	None.
OrderType	string	None.
RepDID	string	None.
RepFirstName	string	None.
RepLastName	string	None.
CustomerDID	string	None.
CustomerFirstName	string	None.
CustomerLastName	string	None.
Telephone	string	None.
ShipName1	string	None.
ShipName2	string	None.
ShipStreet1	string	None.
ShipStreet2	string	None.
ShipCity	string	None.
ShipCountry	string	None.
ShipCounty	string	None.
ShipPostalCode	string	None.
ShipState	string	None.
SKU	string	None.
Quantity	integer	None.
RepEntity	integer	None.
ShipMethodID	integer	None.
ShipMethodDescription	string	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfOrderShippingViewModel>
  <OrderShippingViewModel>
    <OrderDate>01/09/2025 01:36:56</OrderDate>
    <DatePosted>01/09/2025 01:36:56</DatePosted>
    <OrderNumber>3</OrderNumber>
    <OrderType>sample string 4</OrderType>
    <RepDID>sample string 5</RepDID>
    <RepFirstName>sample string 6</RepFirstName>
    <RepLastName>sample string 7</RepLastName>
    <CustomerDID>sample string 8</CustomerDID>
    <CustomerFirstName>sample string 9</CustomerFirstName>
    <CustomerLastName>sample string 10</CustomerLastName>
    <ShipPhone>sample string 11</ShipPhone>
    <ShipName1>sample string 12</ShipName1>
    <ShipName2>sample string 13</ShipName2>
    <ShipStreet1>sample string 14</ShipStreet1>
    <ShipStreet2>sample string 15</ShipStreet2>
    <ShipCity>sample string 16</ShipCity>
    <ShipCountry>sample string 17</ShipCountry>
    <ShipCounty>sample string 18</ShipCounty>
    <ShipPostalCode>sample string 19</ShipPostalCode>
    <ShipState>sample string 20</ShipState>
    <ProductID>sample string 21</ProductID>
    <Quantity>22</Quantity>
    <RepEntityID>23</RepEntityID>
    <ShipMethodID>24</ShipMethodID>
    <ShipMethodDescription>sample string 25</ShipMethodDescription>
  </OrderShippingViewModel>
  <OrderShippingViewModel>
    <OrderDate>01/09/2025 01:36:56</OrderDate>
    <DatePosted>01/09/2025 01:36:56</DatePosted>
    <OrderNumber>3</OrderNumber>
    <OrderType>sample string 4</OrderType>
    <RepDID>sample string 5</RepDID>
    <RepFirstName>sample string 6</RepFirstName>
    <RepLastName>sample string 7</RepLastName>
    <CustomerDID>sample string 8</CustomerDID>
    <CustomerFirstName>sample string 9</CustomerFirstName>
    <CustomerLastName>sample string 10</CustomerLastName>
    <ShipPhone>sample string 11</ShipPhone>
    <ShipName1>sample string 12</ShipName1>
    <ShipName2>sample string 13</ShipName2>
    <ShipStreet1>sample string 14</ShipStreet1>
    <ShipStreet2>sample string 15</ShipStreet2>
    <ShipCity>sample string 16</ShipCity>
    <ShipCountry>sample string 17</ShipCountry>
    <ShipCounty>sample string 18</ShipCounty>
    <ShipPostalCode>sample string 19</ShipPostalCode>
    <ShipState>sample string 20</ShipState>
    <ProductID>sample string 21</ProductID>
    <Quantity>22</Quantity>
    <RepEntityID>23</RepEntityID>
    <ShipMethodID>24</ShipMethodID>
    <ShipMethodDescription>sample string 25</ShipMethodDescription>
  </OrderShippingViewModel>
</ListOfOrderShippingViewModel>

application/json, text/json

Sample:

[
  {
    "OrderDate": "2025-01-09T01:36:56.5705976-05:00",
    "DatePosted": "2025-01-09T01:36:56.5705976-05:00",
    "OrderNumber": 3,
    "OrderType": "sample string 4",
    "RepDID": "sample string 5",
    "RepFirstName": "sample string 6",
    "RepLastName": "sample string 7",
    "CustomerDID": "sample string 8",
    "CustomerFirstName": "sample string 9",
    "CustomerLastName": "sample string 10",
    "Telephone": "sample string 11",
    "ShipName1": "sample string 12",
    "ShipName2": "sample string 13",
    "ShipStreet1": "sample string 14",
    "ShipStreet2": "sample string 15",
    "ShipCity": "sample string 16",
    "ShipCountry": "sample string 17",
    "ShipCounty": "sample string 18",
    "ShipPostalCode": "sample string 19",
    "ShipState": "sample string 20",
    "SKU": "sample string 21",
    "Quantity": 22,
    "RepEntity": 23,
    "ShipMethodID": 24,
    "ShipMethodDescription": "sample string 25"
  },
  {
    "OrderDate": "2025-01-09T01:36:56.5705976-05:00",
    "DatePosted": "2025-01-09T01:36:56.5705976-05:00",
    "OrderNumber": 3,
    "OrderType": "sample string 4",
    "RepDID": "sample string 5",
    "RepFirstName": "sample string 6",
    "RepLastName": "sample string 7",
    "CustomerDID": "sample string 8",
    "CustomerFirstName": "sample string 9",
    "CustomerLastName": "sample string 10",
    "Telephone": "sample string 11",
    "ShipName1": "sample string 12",
    "ShipName2": "sample string 13",
    "ShipStreet1": "sample string 14",
    "ShipStreet2": "sample string 15",
    "ShipCity": "sample string 16",
    "ShipCountry": "sample string 17",
    "ShipCounty": "sample string 18",
    "ShipPostalCode": "sample string 19",
    "ShipState": "sample string 20",
    "SKU": "sample string 21",
    "Quantity": 22,
    "RepEntity": 23,
    "ShipMethodID": 24,
    "ShipMethodDescription": "sample string 25"
  }
]