Anmelden

nShift Help Center

Vorbereitete Sendungen

Avatar
Malene Tidemann
Aktualisiert

Delivery-checkout-label.png


Erstellt Sendungen und gespeicherte Sendungen aus einer vorbereiteten Sendung.


Abschnitte in diesem Artikel:

 

Eine vorbereitete Sendung abrufen

GET /prepared-shipments/{prepareId}

Ruft eine zuvor erstellte vorbereitete Sendung ab.

 

URI-Parameter

prepareId string Identifikation der vorbereiteten Sendung. Erforderlich

 

Beispielantwort


{
  "sender": {
    "quickId": "1",
    "name": "nShift AB",
    "address1": "Skeppsbron 5-6",
    "zipcode": "41121",
    "city": "GÖTEBORG",
    "country": "SE",
    "phone": "+46 31 725 35 00",
    "email": "email1@example.com"
  },
  "senderPartners": [
    {
      "id": "PLAB",
      "custNo": "XX"
    }
  ],
  "receiver": {
    "name": "nShift AB",
    "address1": "Tegnérgatan 34",
    "zipcode": "11359",
    "city": "STOCKHOLM",
    "country": "SE",
    "phone": "+46 8 34 35 15",
    "email": "email2@example.com"
  },
  "service": {
    "id": "P15"
  },
  "parcels": [
    {
      "copies": "1",
      "weight": "37.5",
      "contents": "important things",
      "valuePerParcel": true
    }
  ],
  "orderNo": "order number 123",
  "senderReference": "sender ref 234",
  "receiverReference": "receiver ref 345",
  "options": [
    {
      "message": "This is order number 123",
      "to": "email2@example.com",
      "id": "ENOT",
      "languageCode": "SE",
      "from": "email1@example.com"
    }
  ]
}


Für eine Beschreibung der Eigenschaften siehe bitte den Eigenschaftsreferenzleitfaden.

Für Schema und Tests siehe bitte https://api.unifaun.com/rs-docs/ und navigiere zu /prepared-shipments/{prepareId} GET.

 

 

Eine vorbereitete Sendung löschen

DELETE /prepared-shipments/{prepareId}

Löscht eine vorbereitete Sendung.

Nach dem Löschen der vorbereiteten Sendung ist keine weitere Operation mit der vorbereiteten Sendungs-ID möglich.

 

URI-Parameter

prepareId string Identifikation der Teilsendung Erforderlich

 

Beim erfolgreichen Löschen einer vorbereiteten Sendung wird kein Antwortkörper zurückgegeben.

Für eine Beschreibung der Eigenschaften siehe bitte den Eigenschaftsreferenzleitfaden. Für Schema und Tests siehe bitte https://api.unifaun.com/rs-docs/ und navigiere zu /prepared-shipments/{prepareId} DELETE.

 

Eine Sendung aus einer vorbereiteten Sendung erstellen

POST /prepared-shipments/{prepareId}/shipments

Erstellt eine Sendung aus einer vorbereiteten Sendung.

Die Sendungsdaten im Anfragetext müssen die spezifischen Anforderungen des Service der Sendung erfüllen. Mehrere Sendungen können erstellt werden, wenn die gespeicherte Sendung eine kombinierte normale und Rücksendung darstellt. Standardmäßig werden die Dokumente als URL zurückgegeben. Optional können die Dokumente inline im Objekt print.data im Ergebnis enthalten sein. Das print.data-Objekt ist base64-codiert.

Die generierten Dokumente sind nur für eine (1) Stunde verfügbar.


URI-Parameter

prepareId string Identifikation der vorbereiteten Sendung. Erforderlich

 

Abfrageparameter

returnFile boolean 'true', wenn die PDF/ZPL-Datei inline zurückgegeben werden soll. Optional
keepPreparedShipment boolean

Die Prepare-ID soll erneut verwendet werden.

Zum Beispiel, wenn eine Bestellung Sendungen enthält, die von verschiedenen Standorten versendet werden sollen, wenn ein Artikel in der Bestellung nachbestellt wird oder für einen Rücksendeservice.

 Optional

 

Beispiel für den Anfragetext


{
  "printConfig": {
    "target1Media": "thermo-250",
    "target1Type": "zpl",
    "target1XOffset": 0,
    "target1YOffset": 0,
    "target1Options": [
      {
        "key": "mode",
        "value": "DT"
      }
    ],
    "target2Media": "laser-a4",
    "target2Type": "pdf",
    "target2XOffset": 0,
    "target2YOffset": 0,
    "target3Media": null,
    "target3Type": null,
    "target3XOffset": 0,
    "target3YOffset": 0,
    "target4Media": null,
    "target4Type": null,
    "target4XOffset": 0,
    "target4YOffset": 0
  },
  "shipment": {
    "parcels": [
      {
        "copies": "1",
        "weight": "2.75",
        "contents": "important things",
        "valuePerParcel": true
      }
    ],
    "orderNo": "order number 123",
    "senderReference": "sender ref 234",
    "receiverReference": "receiver ref 345",
    "options": [
      {
        "message": "This is order number 123",
        "to": "email2@example.com",
        "id": "ENOT",
        "languageCode": "SE",
        "from": "email1@example.com"
      }
    ]
  }
}

 

Beispielantwort


{
  "href": "https://api.unifaun.com/ufoweb-prod-202002111305/rs-extapi/v1/stored-shipments/4127538",
  "id": "4127538",
  "sndName": "nShift AB",
  "sndZipcode": "41121",
  "sndCity": "GÖTEBORG",
  "sndCountry": "SE",
  "rcvName": "nShift AB",
  "rcvZipcode": "11359",
  "rcvCity": "STOCKHOLM",
  "rcvCountry": "SE",
  "serviceId": "P15",
  "orderNo": "order number 123",
  "reference": "sender ref 234",
  "parcelCount": 1,
  "normalShipment": true,
  "returnShipment": false,
  "status": "READY",
  "shipDate": "2015-06-02T14:05:56.342+0000",
  "created": "2015-06-02T14:05:56.569+0000",
  "changed": "2015-06-02T14:05:56.569+0000",
  "statuses": [
    {
      "message": "maximum value (35) exceeded",
      "messageCode": "MaximumFlt",
      "field": "ParcelGroup_Weight",
      "location": "ParcelGroupWeight",
      "type": "ignorable"
    }
  ]
}

Für eine Beschreibung der Eigenschaften siehe bitte den Eigenschaftsreferenzleitfaden.

Für Schema und Tests siehe bitte https://api.unifaun.com/rs-docs/ und navigiere zu /prepared-shipments/{prepareId}/shipments POST.

 

 

Eine gespeicherte Sendung aus einer vorbereiteten Sendung erstellen

POST /prepared-shipments/{prepareId}/stored-shipments

Erstellt eine gespeicherte Sendung aus einer vorbereiteten Sendung.

Die Sendungsdaten im Anfragetext müssen die spezifischen Anforderungen des Service der Sendung erfüllen.

 

URI-Parameter

prepareId string Identifikation der vorbereiteten Sendung. Erforderlich

 

Abfrageparameter

keepPreparedShipment boolean

Die Prepare-ID soll erneut verwendet werden.

Zum Beispiel, wenn eine Bestellung Sendungen enthält, die von verschiedenen Standorten versendet werden sollen, wenn ein Artikel in der Bestellung nachbestellt wird oder für einen Rücksendeservice.

 Optional

 

 

Beispiel für den Anfragetext

 
{
  "parcels": [
    {
      "copies": "1",
      "weight": "37.5",
      "contents": "important things",
      "valuePerParcel": true
    }
  ],
  "orderNo": "order number 123",
  "senderReference": "sender ref 234",
  "receiverReference": "receiver ref 345",
  "options": [
    {
      "message": "This is order number 123",
      "to": "email2@example.com",
      "id": "ENOT",
      "languageCode": "SE",
      "from": "email1@example.com"
    }
  ]
}

 

Beispielantwort


{
  "href": "https://api.unifaun.com/ufoweb-prod-202002111305/rs-extapi/v1/stored-shipments/4127538",
  "id": "4127538",
  "sndName": "nShift AB",
  "sndZipcode": "41121",
  "sndCity": "GÖTEBORG",
  "sndCountry": "SE",
  "rcvName": "nShift AB",
  "rcvZipcode": "11359",
  "rcvCity": "STOCKHOLM",
  "rcvCountry": "SE",
  "serviceId": "P15",
  "orderNo": "order number 123",
  "reference": "sender ref 234",
  "parcelCount": 1,
  "normalShipment": true,
  "returnShipment": false,
  "status": "READY",
  "shipDate": "2015-06-02T14:05:56.342+0000",
  "created": "2015-06-02T14:05:56.569+0000",
  "changed": "2015-06-02T14:05:56.569+0000",
  "statuses": [
    {
      "message": "maximum value (35) exceeded",
      "messageCode": "MaximumFlt",
      "field": "ParcelGroup_Weight",
      "location": "ParcelGroupWeight",
      "type": "ignorable"
    }
  ]
}

Für eine Beschreibung der Eigenschaften siehe bitte den Eigenschaftsreferenzleitfaden.

Für Schema und Tests siehe bitte https://api.unifaun.com/rs-docs/ und navigiere zu /prepared-shipments/stored-shipments POST.

Verwandte Beiträge