Developer documentation

Export

Use the Exports API to request, track, and download CSV exports.

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

Available exports types

Exports are available for the following types:

  • stock
  • exports
  • 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

Retrieve an export

GET/wms/exports/:id/

Retrieve a single export.

Try it

Send a live request against the development middleware using your current API test session.

GET

Path parameters

Request examplecURL
curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/184c47d4-d3ee-4412-b156-ce5a4518d641/
Response exampleJSON
{
  "id": "184c47d4-d3ee-4412-b156-ce5a4518d641",
  "status": "completed",
  "extension": "csv",
  "subject": "NORMAL",
  "type": "orders",
  "filters": {
    "from": null,
    "to": null,
    "search": null
  },
  "fields": [
    "reference"
  ],
  "ready": true
}

Download an export

GET/wms/exports/:id/download/

Download a single export.

Try it

Send a live request against the development middleware using your current API test session.

GET

Path parameters

Request examplecURL
curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/184c47d4-d3ee-4412-b156-ce5a4518d641/download/

Request an export

POST/wms/exports/

This endpoint allows you to request a new export.

Try it

Send a live request against the development middleware using your current API test session.

POST
Request examplecURL
curl -X POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/' \
            -H 'Content-Type: application/json' \
            --data-raw '{
                "filters": {
                    "search": null,
                    "from": "2022-06-01",
                    "to": null
                },
                "type": "orders",
                "fields": [
                    "reference",
                    "article_code"
                ]
            }'

Request a billing export

POST/wms/exports/billing/

This endpoint allows you to request a new billing export.

Billing exports are available for the following types:
- packings
- inbounds
- locations

Try it

Send a live request against the development middleware using your current API test session.

POST
Request examplecURL
curl -X POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/billing/' \
            -H 'Content-Type: application/json' \
            --data-raw '{
                "filters": {
                    "search": null,
                    "from": null,
                    "to": null
                },
                "type": "orders"
            }'

Request a financial export

POST/wms/exports/financial/

This endpoint allows you to request a new financial export.

Financial exports are available for the following types:
- colloType
- fillings
- inbounds

Try it

Send a live request against the development middleware using your current API test session.

POST
Request examplecURL
curl -X POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/exports/financial/' \
            -H 'Content-Type: application/json' \
            --data-raw '{
                "filters": {
                    "search": null,
                    "from": null,
                    "to": null
                },
                "type": "orders"
            }'