Kirjaudu sisään

nShift Help Center

Valmiit lähetykset

Avatar
Malene Tidemann
Päivitetty

Delivery-checkout-label.png


Luo lähetyksiä ja tallennettuja lähetyksiä valmiista lähetyksestä.


Artikkelin osiot:

 

Nouda valmis lähetys

GET /prepared-shipments/{prepareId}

Nouda aiemmin luotu valmis lähetys.

 

URI-parametrit

prepareId merkkijono Valmiin lähetyksen tunniste. Pakollinen

 

Vastausesimerkki


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


Ominaisuuksien kuvauksen löydät Ominaisuuksien viiteoppaasta.

Kaavion ja testauksen osalta katso https://api.unifaun.com/rs-docs/ ja siirry kohtaan /prepared-shipments/{prepareId} GET.

 

 

Poista valmis lähetys

DELETE /prepared-shipments/{prepareId}

Poistaa valmiin lähetyksen.

Kun valmis lähetys on poistettu, kyseisellä valmiin lähetyksen tunnisteella ei voi enää suorittaa muita toimintoja.

 

URI-parametrit

prepareId merkkijono Osalähetyksen tunniste Pakollinen

 

Valmiin lähetyksen onnistuneen poiston yhteydessä ei palauteta vastausrunkoa.

Ominaisuuksien kuvauksen löydät Ominaisuuksien viiteoppaasta. Kaavion ja testauksen osalta katso https://api.unifaun.com/rs-docs/ ja siirry kohtaan /prepared-shipments/{prepareId} DELETE.

 

Luo lähetys valmiista lähetyksestä

POST /prepared-shipments/{prepareId}/shipments

Luo lähetyksen valmiista lähetyksestä.

Pyyntöruudun lähetystietojen tulee täyttää lähetyspalvelun erityisvaatimukset. Useita lähetyksiä voidaan luoda, jos tallennettu lähetys edustaa yhdistettyä normaalia ja palautuslähetystä. Oletuksena asiakirjat palautetaan URL-osoitteena. Vaihtoehtoisesti asiakirjat voidaan sisällyttää tulosta.data-objektiin tuloksen mukana. Tulosta.data-objekti koodataan base64-muodossa.

Luodut asiakirjat ovat saatavilla vain yhden (1) tunnin ajan.


URI-parametrit

prepareId merkkijono Valmiin lähetyksen tunniste. Pakollinen

 

Kyselyparametrit

returnFile boolean 'true', jos PDF/ZPL-tiedosto halutaan palauttaa suoraan. Valinnainen
keepPreparedShipment boolean

Valmiin lähetyksen tunnistetta käytetään uudelleen.

Esimerkiksi jos tilaukseen sisältyy lähetyksiä, jotka lähetetään eri paikoista, jos tilauksen tuote on jälkitoimituksessa tai palautuspalvelua varten.

 Valinnainen

 

Esimerkkivartalo


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

 

Vastausesimerkki


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

Ominaisuuksien kuvauksen löydät Ominaisuuksien viiteoppaasta.

Kaavion ja testauksen osalta katso https://api.unifaun.com/rs-docs/ ja siirry kohtaan /prepared-shipments/{prepareId}/shipments POST.

 

 

Luo tallennettu lähetys valmiista lähetyksestä

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

Luo tallennetun lähetyksen valmiista lähetyksestä.

Pyyntöruudun lähetystietojen tulee täyttää lähetyspalvelun erityisvaatimukset.

 

URI-parametrit

prepareId merkkijono Valmiin lähetyksen tunniste. Pakollinen

 

Kyselyparametrit

keepPreparedShipment boolean

Valmiin lähetyksen tunnistetta käytetään uudelleen.

Esimerkiksi jos tilaukseen sisältyy lähetyksiä, jotka lähetetään eri paikoista, jos tilauksen tuote on jälkitoimituksessa tai palautuspalvelua varten.

 Valinnainen

 

 

Esimerkkivartalo

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

 

Vastausesimerkki


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

Ominaisuuksien kuvauksen löydät Ominaisuuksien viiteoppaasta.

Kaavion ja testauksen osalta katso https://api.unifaun.com/rs-docs/ ja siirry kohtaan /prepared-shipments/stored-shipments POST.

Aiheeseen liittyvät artikkelit