POST api/v1/WarehouseActions

Retrieve a list of order movements through the warehouse
Each entry maps to a consignment undergoing a warehouse process

Request Information

URI Parameters

None.

Body Parameters

WarehouseActionsParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
OnlyForChannelID	Only return actions for orders for channel. Leave blank or 0 for all	integer	Required
SinceDateTime	List warehouse actions which occurred since this time. Leave empty to use ID. Use format "2020-01-29T16:00:45.577",	string	None.
SinceID	List warehouse actions with an ID greater than supplied value. Leave empty/0 to use datetime	integer	None.
IncludeProducts	If Y, product breakdown will be returned	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SinceDateTime": "sample string 1",
  "SinceID": 2,
  "IncludeProducts": "sample string 3",
  "apiKey": "sample string 1",
  "OnlyForChannelID": 2
}

application/xml, text/xml

Sample:

<WarehouseActionsParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SinceDateTime>sample string 1</SinceDateTime>
  <SinceID>2</SinceID>
  <IncludeProducts>sample string 3</IncludeProducts>
  <apiKey>sample string 1</apiKey>
  <OnlyForChannelID>2</OnlyForChannelID>
</WarehouseActionsParams>

Response Information

Resource Description

Returns:
200 OK Returns a collection of warehouse action
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

WHActions

Name	Description	Type	Additional information
WHActionsList		Collection of WHAction	None.

Response Formats

application/json, text/json

Sample:

{
  "WHActionsList": [
    {
      "ID": 1,
      "OrderID": 2,
      "OrderNo": 3,
      "Consignment": 4,
      "WebOrderRef": "sample string 5",
      "TimeStamp": "2024-09-19T22:08:44.1019821+01:00",
      "Action": 7,
      "ActionDesc": "sample string 8",
      "ActionedBy": "sample string 9",
      "WHActionsItems": {
        "WHActionsItemsList": [
          {
            "Code": "sample string 1",
            "Description": "sample string 2",
            "Qty": 3
          },
          {
            "Code": "sample string 1",
            "Description": "sample string 2",
            "Qty": 3
          }
        ]
      }
    },
    {
      "ID": 1,
      "OrderID": 2,
      "OrderNo": 3,
      "Consignment": 4,
      "WebOrderRef": "sample string 5",
      "TimeStamp": "2024-09-19T22:08:44.1019821+01:00",
      "Action": 7,
      "ActionDesc": "sample string 8",
      "ActionedBy": "sample string 9",
      "WHActionsItems": {
        "WHActionsItemsList": [
          {
            "Code": "sample string 1",
            "Description": "sample string 2",
            "Qty": 3
          },
          {
            "Code": "sample string 1",
            "Description": "sample string 2",
            "Qty": 3
          }
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:

<WHActions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WHAction>
    <ID>1</ID>
    <OrderID>2</OrderID>
    <OrderNo>3</OrderNo>
    <Consignment>4</Consignment>
    <WebOrderRef>sample string 5</WebOrderRef>
    <TimeStamp>2024-09-19T22:08:44.1019821+01:00</TimeStamp>
    <Action>7</Action>
    <ActionDesc>sample string 8</ActionDesc>
    <ActionedBy>sample string 9</ActionedBy>
    <WHActionsItems>
      <WHActionItem>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Qty>3</Qty>
      </WHActionItem>
      <WHActionItem>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Qty>3</Qty>
      </WHActionItem>
    </WHActionsItems>
  </WHAction>
  <WHAction>
    <ID>1</ID>
    <OrderID>2</OrderID>
    <OrderNo>3</OrderNo>
    <Consignment>4</Consignment>
    <WebOrderRef>sample string 5</WebOrderRef>
    <TimeStamp>2024-09-19T22:08:44.1019821+01:00</TimeStamp>
    <Action>7</Action>
    <ActionDesc>sample string 8</ActionDesc>
    <ActionedBy>sample string 9</ActionedBy>
    <WHActionsItems>
      <WHActionItem>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Qty>3</Qty>
      </WHActionItem>
      <WHActionItem>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Qty>3</Qty>
      </WHActionItem>
    </WHActionsItems>
  </WHAction>
</WHActions>