POST api/v1/PickTrip

Retrieve a list of orders for a specific pick trip id

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
TripID	Return all orders for a specific pick trip ID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "TripID": 1,
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample:

<TripParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TripID>1</TripID>
  <apiKey>sample string 1</apiKey>
</TripParams>

Response Information

Resource Description

Returns:
200 OK Returns a collection of orders
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if the requested filters dont match any data 503 Service Unavailable

PickTrip

Name	Description	Type	Additional information
TripList		Collection of PickTripDet	None.

Response Formats

application/json, text/json

Sample:

{
  "TripList": [
    {
      "Complete": "sample string 1",
      "AssignedToEmp": "sample string 2",
      "TripShipments": {
        "TripShipment": [
          {
            "OrderID": 1,
            "OrderNo": 2,
            "Shipment": 3,
            "AccountNo": "sample string 4",
            "AccountID": 5,
            "WebOrderRef": "sample string 6",
            "DespDocID": 7
          },
          {
            "OrderID": 1,
            "OrderNo": 2,
            "Shipment": 3,
            "AccountNo": "sample string 4",
            "AccountID": 5,
            "WebOrderRef": "sample string 6",
            "DespDocID": 7
          }
        ]
      }
    },
    {
      "Complete": "sample string 1",
      "AssignedToEmp": "sample string 2",
      "TripShipments": {
        "TripShipment": [
          {
            "OrderID": 1,
            "OrderNo": 2,
            "Shipment": 3,
            "AccountNo": "sample string 4",
            "AccountID": 5,
            "WebOrderRef": "sample string 6",
            "DespDocID": 7
          },
          {
            "OrderID": 1,
            "OrderNo": 2,
            "Shipment": 3,
            "AccountNo": "sample string 4",
            "AccountID": 5,
            "WebOrderRef": "sample string 6",
            "DespDocID": 7
          }
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:

<PickTrip xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PickTripDet>
    <Complete>sample string 1</Complete>
    <AssignedToEmp>sample string 2</AssignedToEmp>
    <TripShipments>
      <TripShipment>
        <OrderID>1</OrderID>
        <OrderNo>2</OrderNo>
        <Shipment>3</Shipment>
        <AccountNo>sample string 4</AccountNo>
        <AccountID>5</AccountID>
        <WebOrderRef>sample string 6</WebOrderRef>
        <DespDocID>7</DespDocID>
      </TripShipment>
      <TripShipment>
        <OrderID>1</OrderID>
        <OrderNo>2</OrderNo>
        <Shipment>3</Shipment>
        <AccountNo>sample string 4</AccountNo>
        <AccountID>5</AccountID>
        <WebOrderRef>sample string 6</WebOrderRef>
        <DespDocID>7</DespDocID>
      </TripShipment>
    </TripShipments>
  </PickTripDet>
  <PickTripDet>
    <Complete>sample string 1</Complete>
    <AssignedToEmp>sample string 2</AssignedToEmp>
    <TripShipments>
      <TripShipment>
        <OrderID>1</OrderID>
        <OrderNo>2</OrderNo>
        <Shipment>3</Shipment>
        <AccountNo>sample string 4</AccountNo>
        <AccountID>5</AccountID>
        <WebOrderRef>sample string 6</WebOrderRef>
        <DespDocID>7</DespDocID>
      </TripShipment>
      <TripShipment>
        <OrderID>1</OrderID>
        <OrderNo>2</OrderNo>
        <Shipment>3</Shipment>
        <AccountNo>sample string 4</AccountNo>
        <AccountID>5</AccountID>
        <WebOrderRef>sample string 6</WebOrderRef>
        <DespDocID>7</DespDocID>
      </TripShipment>
    </TripShipments>
  </PickTripDet>
</PickTrip>