Returns

Eingehende Sendungsretouren anzeigen

GET /api/return/list?created_after_at={created_after_at}

Properties

created_after_at datetime

Ein Zeitwert im Format JJJJ-MM-TT HH:MM:SS, wann die Meldung erstellt wurde. Mit diesem Parameter wird nach allen Rückgaben nach dem angegebenen Zeitstempel gefiltert.

Es werden maximal 500 Einträge in aufsteigender Reihenfolge aufgelistet. Um mehr Einträge zu erhalten, erhöhe die created_after_at timestamp.

---

Result

JSON-Object mit den grundlegenden Daten der Rückgabe und der zurückgegebenen Artikel.

id integer

Eine eindeutige Bezeichnung für die Rückgabe

timestamp object

• date datetime

  • Der Zeitstempel der Erstellung der Rückgabe

• timezone_type integer

  • Der jeweilige timezone_type des Zeitstempels

• timezone string

  • Die jeweilige Zeitzone des Zeitstempels

status string

Die Art der Rücksendung. Mögliche Werte sind DHL Zurück für Rücksendung vom Spediteur und Rücksendung für Kundenretouren

reason string

Ein Grundcode oder ein Textfeld, das den Grund für die Rückgabe enthält

remark string

Eine optionale Bemerkung zur Rücksendung für den Kundenservice

order integer

Die Shopify Order ID der entsprechenden Bestellung

items array|object

• sku string

  • Die SKU des zurückgegebenen Artikels

• remark string

  • Zusätzliche Informationen für den Artikel, der vom Packstack-Lagerpersonal hinzugefügt wurde

• reason string

  • Ein Grund für die Rücksendung des Artikels

• restocked bool

  • Wenn der Artikel in den physischen Bestand aufgenommen wurde

[
    {
        "id": 177,
        "timestamp": {
            "date": "2024-02-07 20:27:19.000000",
            "timezone_type": 3,
            "timezone": "Europe/Berlin"
        },
        "status": "DHL Zurück",
        "reason": "Keine Angabe",
        "remark": "",
        "order": 5544614920422,
        "items": [
            {
                "sku": "101/111",
                "remark": "",
                "reason": "poorQuality",
                "restocked": true
            }
        ]
    },
    {
        "id": 178,
        "timestamp": {
            "date": "2024-02-07 20:34:37.000000",
            "timezone_type": 3,
            "timezone": "Europe/Berlin"
        },
        "status": "DHL Zurück",
        "reason": "Keine Angabe",
        "remark": "",
        "order": 5544615313638,
        "items": [
            {
                "sku": "001-101",
                "remark": "",
                "reason": "accidentallyOrdered",
                "restocked": true
            }
        ]
    }
]

Retouren-Ankündigung erfassen

GET /api/return/create?order={orderId}&customerwish={customerWish}&trackingNr={trackingNr}&sendMail={sendMail}&lineItems=

Properties

order integer

Die Shopify-Bestell-ID der ursprünglichen Bestellung

trackingNr string (optional)

Eine vom ankündigen System generierte Tracking oder Referenznummer die als scanbarer Barcode der Rücksendung beigelegt wird. Dieser Wert wird nur gespeichert, falls kein DHL Retourenlabel aufgrund der Konfiguration zurückgegegeben wird.

sendMail string (optional, default: true)

Soll nach der Ankündigung der Retoure eine automatische E-Mail Benachrichtigung an den Endkunden mit dem Retourenschein oder dem Retourenlabel gesendet werden?

customerwish string (optional)

Der Wunsch des Kunden der nach der Bearbeitung der Retoure entscheiden soll. Mögliche Werte sind:

• resend (Der Kunde möchte einen erneuten Versand des retournierten Artikels)

• refund (Der Kunde möchte eine Erstattung des retournierten Artikels)

lineItems array (optional)

Ein multidimensionales assoziatives Array das die zu retournierenden Artikel enthält.

{
  "LineItem ID von Shopify": {
    "quantity": Menge die retourniert wird,
    "reason": "Grund für die Rücksendung, die erlaubten Schlüssel werden vom Kunden in Packstack Connect konfiguriert"
  }
}

Beispiel:

{
  "18243431956747": {
    "quantity": 2,
    "reason": "tooLate"
  },
  "18243431956750": {
    "quantity": 1,
    "reason": "poorQuality"
  }
}

---

Result

Wenn der Kunde konfiguriert hat das DHL-Retourenlabel erzeugt werden, wird ein Retourenlabel das alle notwendigen Informationen enthält als Base64 codierter String zurückgegeben.

Andernfalls wird ein Base64 codierter String des Retourenscheins zurückgegeben.

Es wird zusätzlich der Header X-Object-Id gesetzt, der die interne ID dieser Rücksendung ausgibt. Sollte ein Retourenlabel zurückgegeben werden, wird zusätzlich der Header X-TrackingNr mit der erzeugten Sendungsnummer auf dem Label gesendet.

HTTP/1.1 200 OK
Content-Type: text/plain
Content-Length: 84231
X-Object-Id: 4711

JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdl
cyAyIDAgUgovTGFuZyAoZW4tVVMpCj4+CmVuZG9iagoKMiAwIG9iago8PC9U
eXBlIC9QYWdlcwovQ291bnQgMQovS2lkcyBbMyAwIFJdCj4+CmVuZG9iagoK
...