Kirjaudu sisään
nShift Help Center

Toimituspyynnön rakentaminen ShipmentServer API:lle

Avatar
Simon Schrader Springer
Päivitetty

Tässä artikkelissa kuvataan, kuinka rakentaa SubmitShipment-pyyntö ShipmentServer API:lle.
Tämän API:n avulla voit ohjelmallisesti varata lähetyksiä ja luoda tarroja.

 

Päätepiste ja menetelmä:

Pyyntö tulee tehdä POST-pyyntönä seuraavaan päätepisteeseen:

  • Tuotanto - https://www.shipmentserver.com
  • Sandbox - https://demo.shipmentserver.com

 

Pyyntörunko (multipart/form-data):

Pyyntörunko tulee muotoilla multipart/form-data-muotoon seuraavilla avain-arvopareilla:

  • command: Aseta aina arvoksi "SubmitShipment". Tämä kertoo API:lle, mitä toimintoa suoritetaan.
  • actor: Toimijan tunnus. Tämä on käyttäjätunnuksesi.
  • key: Toimijan avain. Tämä on salasanasi.
  • data (JSON-merkkijono): Tässä kentässä on lähetyksen ydintiedot.
  • options (JSON-merkkijono): Tässä kentässä voit määrittää lisäasetuksia, kuten tarran muodon.


data.json-tiedosto sisältää lähetyksen varaamiseen tarvittavat tiedot, mukaan lukien yksilölliset tunnisteet, lähettäjän ja vastaanottajan osoitteet sekä pakkausmääritykset, kuten mitat ja painon.

-- filename: data.json

{
  "ProdConceptID": 1782, // Tuotteen konseptitunnus
  "OrderNo": "Order123", // Tilausnumero
  "Addresses": [
    {
      "Kind": 1, // 1 vastaanottaja, 2 lähettäjä
      "Name1": "Vastaanottajan nimi",
      "Street1": "Vastaanottajan katu",
      "PostCode": "Vastaanottajan postinumero",
      "City": "Vastaanottajan kaupunki",
      "CountryCode": "Vastaanottajan maan koodi",
      "Phone": "Vastaanottajan puhelin",
      "Email": "receiver@example.com",
      "Attention": "Vastaanottajan huomio" // Valinnainen
    },
    {
      "Kind": 2, // 1 vastaanottaja, 2 lähettäjä
      "Name1": "Lähettäjän nimi",
      "Street1": "Lähettäjän katu",
      "PostCode": "Lähettäjän postinumero",
      "City": "Lähettäjän kaupunki",
      "CountryCode": "Lähettäjän maan koodi",
      "Phone": "Lähettäjän puhelin",
      "Email": "sender@example.com",
      "Attention": "Lähettäjän huomio" // Valinnainen
    }
  ],
  "Lines": [
    {
      "Number": 1, // Rivinumero
      "PkgWeight": 1000, // Paketin paino grammoina
      "Height": 10, // Korkeus millimetreinä
      "Length": 20, // Pituus millimetreinä
      "Width": 15, // Leveys millimetreinä
      "References": [
        { "Kind": 23, "Value": "Viite 1" }
      ]
    }
  ]
}


options.json-tiedostossa määritellään tarran muoto, tässä tapauksessa ZPL-muoto, joka on tarkoitettu tulostettavaksi Zebra-tulostimilla.

-- filename: options.json

{
    "Labels": "ZPLGK"
}

 

Payload (data) -objektin rakentaminen

Vaikka on teknisesti mahdollista rakentaa data JSON -payload manuaalisesti, on suositeltavaa luoda lähetys ensin Ship UI:n kautta ja saada se kuljetusyrityksen validoitavaksi ennen automaation käyttöönottoa. Tämä varmistaa tietojen oikeellisuuden ja välttää mahdolliset ongelmat väärän muotoilun tai puuttuvien pakollisten kenttien vuoksi.

 

Lisätietoja Ship UI:n Developer Toolista:
https://helpcenter.nshift.com/hc/fi/articles/17147027547804

 

Esimerkki curl-komennolla.

curl -X POST "https://demo.shipmentserver.com" \
 -F "command=SubmitShipment" \
 -F "actor=YOUR_ACTOR_ID" \
 -F "key=YOUR_ACTOR_KEY" \
 -F "data=@data.json" \
 -F "options=@options.json"

 

Aiheeseen liittyvät artikkelit