GET api/GetOrders?from={from}&to={to}&withLabels={withLabels}

Orders from a specific time period can be retrieved here. Period must not exceed 2 years. Optionally, you can also display the previously created shipping labels again via ByteCode

Request Information

URI Parameters

Name	Type	Additional information
from	date	Required
to	date	Required
withLabels	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

GetOrdersResponse

Name	Type	Additional information
Orders	Collection of Order	None.
Status	Status	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Orders": [
    {
      "OrderID": "sample string 1",
      "OrderReference": "sample string 2",
      "CD": "2024-09-17T11:20:01.6527866+02:00",
      "Status": "CREATED",
      "Labels": [
        {
          "Trackingnummer": "sample string 1",
          "CD": "2024-09-17T11:20:01.6527866+02:00",
          "LabelByteCode": "QEA="
        },
        {
          "Trackingnummer": "sample string 1",
          "CD": "2024-09-17T11:20:01.6527866+02:00",
          "LabelByteCode": "QEA="
        }
      ]
    },
    {
      "OrderID": "sample string 1",
      "OrderReference": "sample string 2",
      "CD": "2024-09-17T11:20:01.6527866+02:00",
      "Status": "CREATED",
      "Labels": [
        {
          "Trackingnummer": "sample string 1",
          "CD": "2024-09-17T11:20:01.6527866+02:00",
          "LabelByteCode": "QEA="
        },
        {
          "Trackingnummer": "sample string 1",
          "CD": "2024-09-17T11:20:01.6527866+02:00",
          "LabelByteCode": "QEA="
        }
      ]
    }
  ],
  "Status": "SUCCESS",
  "ErrorMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<GetOrdersController.GetOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bandel.Dropshipping.API.Controllers">
  <ErrorMessage>sample string 1</ErrorMessage>
  <Orders>
    <GetOrdersController.Order>
      <CD>2024-09-17T11:20:01.6527866+02:00</CD>
      <Labels>
        <GetOrdersController.Label>
          <CD>2024-09-17T11:20:01.6527866+02:00</CD>
          <LabelByteCode>QEA=</LabelByteCode>
          <Trackingnummer>sample string 1</Trackingnummer>
        </GetOrdersController.Label>
        <GetOrdersController.Label>
          <CD>2024-09-17T11:20:01.6527866+02:00</CD>
          <LabelByteCode>QEA=</LabelByteCode>
          <Trackingnummer>sample string 1</Trackingnummer>
        </GetOrdersController.Label>
      </Labels>
      <OrderID>sample string 1</OrderID>
      <OrderReference>sample string 2</OrderReference>
      <Status>CREATED</Status>
    </GetOrdersController.Order>
    <GetOrdersController.Order>
      <CD>2024-09-17T11:20:01.6527866+02:00</CD>
      <Labels>
        <GetOrdersController.Label>
          <CD>2024-09-17T11:20:01.6527866+02:00</CD>
          <LabelByteCode>QEA=</LabelByteCode>
          <Trackingnummer>sample string 1</Trackingnummer>
        </GetOrdersController.Label>
        <GetOrdersController.Label>
          <CD>2024-09-17T11:20:01.6527866+02:00</CD>
          <LabelByteCode>QEA=</LabelByteCode>
          <Trackingnummer>sample string 1</Trackingnummer>
        </GetOrdersController.Label>
      </Labels>
      <OrderID>sample string 1</OrderID>
      <OrderReference>sample string 2</OrderReference>
      <Status>CREATED</Status>
    </GetOrdersController.Order>
  </Orders>
  <Status>SUCCESS</Status>
</GetOrdersController.GetOrdersResponse>