GitHub

Exports

Our platform offers the possibility to export data via CSV exports.

The Exports API has limited access and is by default not enabled. Get in touch with us if you want to make use of the Exports API.


Available exports types

Exports are available for the following types:

  • stock
  • articles
  • shipments
  • orders
  • modifications
  • transfers
  • inbounds
  • serial_numbers
  • external_shipments

Requesting exports

After requesting an export our platform will start preparing the export. Based on the export it can take several minutes before the export is ready for download.

  1. Request the export
  2. Fetch the status of the export every 2 or 3 minutes
  3. Download the export when the export has status completed

Requesting exports


GET Get export

Retrieve an export.

Example

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/184c47d4-d3ee-4412-b156-ce5a4518d641'

Response

1{
2 "id": "184c47d4-d3ee-4412-b156-ce5a4518d641",
3 "status": "completed",
4 "extension": "csv",
5 "subject": "NORMAL",
6 "type": "orders",
7 "filters": {
8 "from": null,
9 "to": null,
10 "search": null
11 },
12 "fields": [
13 "reference"
14 ],
15 "ready": true
16}

GET Download export

Download an export. Use Get export to fetch the status of the export.

Example

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/9ab8ea47-4f5f-4f25-9f4d-ae1fc8f5a947/download'

TODO EXAMPLE!!!!


POST Request export

Request an export.

Example

1curl --location --request POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/' \
2--data-raw '{
3 "filters": {
4 "search": null,
5 "from": "2022-06-01",
6 "to": null
7 },
8 "type": "orders",
9 "fields": [
10 "reference",
11 "article_code"
12 ]
13}'

Response

1{
2 "filters": {
3 "search": null,
4 "from": "2022-06-01",
5 "to": null
6 },
7 "type": "orders",
8 "fields": [
9 "reference",
10 "article_code"
11 ]
12}

POST Request billing export

Request a billing export. Billing exports are available for the following types:

  • packings
  • inbounds
  • locations
  • orders

Example

1curl --location --request POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/' \
2--data-raw '{
3 "filters": {
4 "search": null,
5 "from": null,
6 "to": null
7 },
8 "type": "orders"
9}'

Response

1{
2 "filters": {
3 "search": null,
4 "from": null,
5 "to": null
6 },
7 "type": "orders"
8}

POST Request financial export

Request a financial export. Financial exports are available for the following types:

  • colloType
  • fillings
  • inbounds
  • locations
  • orders
  • shipments

Example

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/financial/'

Response

1{
2 "filters": {
3 "search": null,
4 "from": null,
5 "to": null
6 },
7 "type": "orders"
8}