Aanmelden

nShift Help Center

Voorbereide zendingen

Avatar
Malene Tidemann
Bijgewerkt

Delivery-checkout-label.png


Maakt zendingen en opgeslagen zendingen aan vanuit een voorbereide zending.


Onderdelen in dit artikel:

 

Haal een voorbereide zending op

GET /prepared-shipments/{prepareId}

Haalt een voorbereide zending op die eerder is aangemaakt.

 

URI-parameters

prepareId string Identificatie van de voorbereide zending. Vereist

 

Voorbeeld van een respons


{
  "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"
    }
  ]
}


Voor een beschrijving van eigenschappen, zie de Eigenschappen referentiegids.

Voor schema en testen, zie https://api.unifaun.com/rs-docs/ en navigeer naar /prepared-shipments/{prepareId} GET.

 

 

Verwijder een voorbereide zending

DELETE /prepared-shipments/{prepareId}

Verwijdert een voorbereide zending.

Wanneer de voorbereide zending is verwijderd, is geen verdere bewerking mogelijk met het voorbereide zending-ID.

 

URI-parameters

prepareId string Identificatie van de gedeeltelijke zending Vereist

 

Er wordt geen response body teruggegeven wanneer een voorbereide zending succesvol is verwijderd.

Voor een beschrijving van eigenschappen, zie de Eigenschappen referentiegids. Voor schema en testen, zie https://api.unifaun.com/rs-docs/ en navigeer naar /prepared-shipments/{prepareId} DELETE.

 

Maak een zending aan vanuit een voorbereide zending

POST /prepared-shipments/{prepareId}/shipments

Maakt een zending aan vanuit een voorbereide zending.

De zendingsgegevens in de request body moeten voldoen aan de specifieke eisen van de dienst van de zending. Meerdere zendingen kunnen worden aangemaakt als de opgeslagen zending een gecombineerde normale en retourzending vertegenwoordigt. Standaard worden de documenten als een URL teruggegeven. Optioneel kunnen de documenten inline worden opgenomen in het print.data-object in het resultaat. Het print.data-object is gecodeerd in base64.

De gegenereerde documenten zijn slechts één (1) uur beschikbaar.


URI-parameters

prepareId string Identificatie van de voorbereide zending. Vereist

 

Query parameters

returnFile boolean 'true' als het PDF/ZPL-bestand inline moet worden teruggegeven. Optioneel
keepPreparedShipment boolean

Het prepare ID moet opnieuw worden gebruikt.

Bijvoorbeeld als een bestelling zendingen bevat die vanuit verschillende locaties moeten worden verzonden, als een artikel in de bestelling niet op voorraad is of voor een retourservice.

 Optioneel

 

Voorbeeld van een body


{
  "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"
      }
    ]
  }
}

 

Voorbeeld van een respons


{
  "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"
    }
  ]
}

Voor een beschrijving van eigenschappen, zie de Eigenschappen referentiegids.

Voor schema en testen, zie https://api.unifaun.com/rs-docs/ en navigeer naar /prepared-shipments/{prepareId}/shipments POST.

 

 

Maak een opgeslagen zending aan vanuit een voorbereide zending

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

Maakt een opgeslagen zending aan vanuit een voorbereide zending.

De zendingsgegevens in de request body moeten voldoen aan de specifieke eisen van de dienst van de zending.

 

URI-parameters

prepareId string Identificatie van de voorbereide zending. Vereist

 

Query parameters

keepPreparedShipment boolean

Het prepare ID moet opnieuw worden gebruikt.

Bijvoorbeeld als een bestelling zendingen bevat die vanuit verschillende locaties moeten worden verzonden, als een artikel in de bestelling niet op voorraad is of voor een retourservice.

 Optioneel

 

 

Voorbeeld van een body

 
{
  "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"
    }
  ]
}

 

Voorbeeld van een respons


{
  "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"
    }
  ]
}

Voor een beschrijving van eigenschappen, zie de Eigenschappen referentiegids.

Voor schema en testen, zie https://api.unifaun.com/rs-docs/ en navigeer naar /prepared-shipments/stored-shipments POST.

Verwante artikelen