Returns

Über den Returns-Endpunkt können sie Informationen zu Retouren abfragen, welche in unserem Retourenzentrum auf Schweizer Seite eingegangen und erfasst wurden.

Endpunkt URL

https://api.meineinkauf.ch/v1/returns

GET - einzelne Retoure

GET https://api.meineinkauf.ch/v1/returns/<reference>

Parameter

Name Beispiel Pflichtfeld Hinweis
reference 6019123456 Ja Die Referenznummer einer Retoure

Beispiel Aufruf

curl https://api.meineinkauf.ch/v1/returns/6019123456 \
  -X GET \
  -u 'api:MEINEINKAUF_TEST_API_KEY'

Antwort

{
  "return": {
    "id": 1234,
    "created": "2019-02-28T14:50:28+01:00",
    "reference": "6019123456",
    "processingState": "completed",
    "processingStateHistory": [
      {
        "state": "open",
        "changed": "2019-02-28T14:50:28+01:00"
      },
      {
        "state": "ready_for_transfer",
        "changed": "2019-02-28T16:30:15+01:00"
      },
      {
        "state": "transferred",
        "changed": "2019-03-02T09:36:12+01:00"
      },
      {
        "state": "completed",
        "changed": "2019-03-02T15:21:24+01:00"
      }
    ],
    "processingStateChanged": "2019-03-02T15:21:24+01:00",
    "order": {
      "id": 1234,
      "orderNumber": "1518180121"
    },
    "items": [
      {
        "id": 1234,
        "reference": 8812452250,
        "article": {
          "id": 1234,
          "name": "Rotes Hemd",
          "articleNumber":"12345678",
        },
        "reason": "too_small",
        "state": "as_new"
      },
      {
        "id": 1235,
        "reference": 8812452251,
        "article": {
          "id": 1234,
          "name": "Gelbes Hemd",
          "articleNumber":"12345678",
        },
        "reason": "not_as_described",
        "state": "used"
      }
    ],
    "tour": {
      "id": 1234,
      "mrnDe": "12345678",
      "mrnCh": "12345678",
      "transferDate": "2019-03-02"
    },
    "tracking": {
      "carrier": "dhl",
      "trackingNumber": "JJD000390011001751123"
    }
  },
  "errors": [],
  "success": true
}
Name Typ Hinweis
return Return-Object Alle Informationen der abgefragten Retoure
errors Array Die eventuellen Fehler des Requests, eine Auflistung der möglichen Fehler finden Sie hier
success Boolean Dieses Flag beschreibt ob der Request erfolgreich war oder nicht

Return-Object

Name Typ Hinweis
id Integer Ein eindeutiger Identifizierer der Retoure
created String  Der Zeitpunkt der Retouren-Erfassung
reference String Die interne Referenznummer der Retoure
processingState Enum[String] Der aktuelle Bearbeitungsstatus der Retoure

["open", "ready_for_transfer", "transferred", "completed"]

Eine detaillierte Beschreibung hierzu finden Sie hier.
processingStateHistory Array[processingStateHistory-Object] Der detaillierte Verlauf der Bearbeitungsstatus
processingStateChanged  String Der Zeitpunkt der letzten Verarbeitungs-Status Änderung
order Order-Object Eine Referenz auf die ursprüngliche Bestellung
items Array[Item-Object] Eine Auflistung der retournierten Items
tour Tour-Object Die Informationen zur Retouren-Tour
tracking Tracking-Object Die Trackinginformationen der innerdeutschen Rücksendung

ProcessingStateHistory-Object

Name Typ Hinweis
state String Der entsprechende Bearbeitungsstatus
changed String Der Zeitpunkt wann die Retoure in den entsprechenden Status ging (Format ISO-8601)

Order-Object

Name Typ Hinweis
id Integer Ein eindeutiger Identifizierer der Bestellung
orderNumber String Die Bestellnummer

Item-Object

Name Typ Hinweis
id Integer Ein eindeutiger Identifizierer des Items
reference String Die Referenznummer des Items
article Article-Object Die Informationen zum entsprechenden Artikel des Items
reason Enum[String] Der Grund des Kunden für die Retoure, diese können in Absprache definiert werden

["too_small", "too_lage", "not_as_described", ...]
state Enum[String] Der Zustand des retournierten Items, diese können in Absprache definiert werden

["as_new", "used", ...]

Article-Object

Name Typ Hinweis
id Integer Ein eindeutiger Identifizierer des Artikels
name String Die Artikelname
articleNumber String Die Artikelnummer

Tour-Object

Name Typ Hinweis
id Integer Ein eindeutiger Identifizierer der Tour
mrnDe String Die deutsche MRN (Master Reference Number) der Retouren-Tour
mrnCh String Die schweizer MRN (Master Reference Number) der Retouren-Tour
transferDate String Das Überführungsdatum der Retouren-Tour

Tracking-Object

Name Typ Hinweis
carrier Enum[String] Das Versandunternehmenen mit welchem die Sendung in Deutschland versendet wird.

["undefined", "dhl", "dpd", "ups", "hermes"]
trackingNumber String Die Trackingnummer

GET - mehrere Retouren

GET https://api.meineinkauf.ch/v1/returns

Hinweise
Die Retouren werden absteigend nach Erfassungs-Datum sortiert. Bitte beachten Sie, dass wir bei Abfrage von mehreren Retouren die Anzahl der Retouren aus technischen Gründen auf 50 limitieren.

Parameter

Name Beispiel Default Hinweis
limit 25 50 Das Limit der zurückgegebenen Bestellungen, maximal 50
offset 0 0 Das Offset der zurückgegebenen Bestellungen
sort id:asc,created:desc created:desc Die Sortierung des Ergebnisses, kommaseparierte Liste aus "eigenschaft:richtung"-Tupeln

Mögliche Eigenschaften: ["id", "created", "processingStateChanged"]

Mögliche Richtungen: ["desc", "asc"]
processingStates open,ready_for_transfer Eine Filterung des Ergebnisses anhand des Verarbeitungs-Status, kommaseparierte Liste aus möglichen Status

Mögliche Status: siehe hier

Beispiel Aufruf

curl https://api.meineinkauf.ch/v1/returns?limit=25&offset=0&sort=id:asc,created:desc&processingStates=open,ready_for_transfer \
  -X GET \
  -u 'api:MEINEINKAUF_TEST_API_KEY'

Antwort

{
  "returns": [
    {
      "id": 1234,
      "created": "2019-02-28T14:50:28+01:00",
      "reference": "6019123456",
      "processingState": "completed",
      "processingStateHistory": [
        {
          "state": "open",
          "changed": "2019-02-28T14:50:28+01:00"
        },
        {
          "state": "ready_for_transfer",
          "changed": "2019-02-28T16:30:15+01:00"
        },
        {
          "state": "transferred",
          "changed": "2019-03-02T09:36:12+01:00"
        },
        {
          "state": "completed",
          "changed": "2019-03-02T15:21:24+01:00"
        }
      ],
      "processingStateChanged": "2019-03-02T15:21:24+01:00",
      "order": {
        "id": 1234,
        "orderNumber": "1518180121"
      },
      "items": [
        {
          "id": 1234,
          "reference": 8812452250,
          "article": {
            "id": 1234,
            "name": "Rotes Hemd",
            "articleNumber":"12345678",
          },
          "reason": "too_small",
          "state": "as_new"
        },
        {
          "id": 1235,
          "reference": 8812452251,
          "article": {
            "id": 1234,
            "name": "Gelbes Hemd",
            "articleNumber":"12345678",
          },
          "reason": "not_as_described",
          "state": "used"
        }
      ],
      "tour": {
        "id": 1234,
        "mrnDe": "12345678",
        "mrnCh": "12345678",
        "transferDate": "2019-03-02"
      },
      "tracking": {
        "carrier": "dhl",
        "trackingNumber": "JJD000390011001751123"
      }
    }
  ],
  "count": 211,
  "offset": 0,
  "limit": 50,
  "errors": [],
  "success": true
}
Name Typ Hinweis
returns Array[Return-Object] Eine Auflistung der einzelnen Retoure-Objekte mit den dazugehörigen Informationen
count Integer Die Gesamtanzahl der vorhandenen Bestellungen
offset Integer Das aktuelle Offset des Requests
limit Integer Das aktuelle Limit des Requests
errors Array Die eventuellen Fehler des Requests, eine Auflistung der möglichen Fehler finden Sie hier
success Boolean Dieses Flag beschreibt ob der Request erfolgreich war oder nicht

Verarbeitungs-Status

Name Beschreibung
open Die Retoure wurde ist im Retourenzentrum eingegangen und wurde erfasst
ready_for_transfer Die Retoure wurde für die Überführung/Verzollung vorbereitet
transferred Die Retoure wurde überführt
completed Die Retoure ist abgeschlossen