Logg på

nShift Help Center

Forberedte forsendelser

Avatar
Malene Tidemann
Oppdatert

Delivery-checkout-label.png


Oppretter forsendelser og lagrede forsendelser fra en forberedt forsendelse.


Avsnitt i denne artikkelen:

 

Hent en forberedt forsendelse

GET /prepared-shipments/{prepareId}

Henter en forberedt forsendelse som tidligere ble opprettet.

 

URI-parametere

prepareId string Identifikasjon av den forberedte forsendelsen. Påkrevd

 

Respons-eksempel


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


For en beskrivelse av egenskaper, vennligst se Egenskapsreferanseguide.

For skjema og testing, vennligst se https://api.unifaun.com/rs-docs/ og naviger til /prepared-shipments/{prepareId} GET.

 

 

Slett en forberedt forsendelse

DELETE /prepared-shipments/{prepareId}

Sletter en forberedt forsendelse.

Når den forberedte forsendelsen er slettet, vil ingen videre operasjoner være mulige på den forberedte forsendelses-IDen.

 

URI-parametere

prepareId string Identifikasjon av den delvise forsendelsen Påkrevd

 

Ingen responsbody returneres når en forberedt forsendelse er slettet med suksess.

For en beskrivelse av egenskaper, vennligst se Egenskapsreferanseguide. For skjema og testing, vennligst se https://api.unifaun.com/rs-docs/ og naviger til /prepared-shipments/{prepareId} DELETE.

 

Opprett en forsendelse fra en forberedt forsendelse

POST /prepared-shipments/{prepareId}/shipments

Oppretter en forsendelse fra en forberedt forsendelse.

Forsendelsesdataene i forespørselsbodyen må oppfylle de spesifikke kravene til forsendelsens tjeneste. Flere forsendelser kan opprettes hvis den lagrede forsendelsen representerer en kombinert normal- og returforsendelse. Som standard returneres dokumentene som en URL. Som et alternativ kan dokumentene være innebygd i print.data-objektet i resultatet. print.data-objektet kodes i base64.

De genererte dokumentene vil kun være tilgjengelige i én (1) time.


URI-parametere

prepareId string Identifikasjon av den forberedte forsendelsen. Påkrevd

 

Spørringsparametere

returnFile boolean 'true' hvis PDF/ZPL-filen skal returneres inline. Valgfritt
keepPreparedShipment boolean

Den forberedte IDen skal brukes igjen.

For eksempel, hvis en ordre inneholder forsendelser som skal sendes fra forskjellige lokasjoner, hvis en vare i ordren er restordre eller for en returservice.

 Valgfritt

 

Body-eksempel


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

 

Respons-eksempel


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

For en beskrivelse av egenskaper, vennligst se Egenskapsreferanseguide.

For skjema og testing, vennligst se https://api.unifaun.com/rs-docs/ og naviger til /prepared-shipments/{prepareId}/shipments POST.

 

 

Opprett en lagret forsendelse fra en forberedt forsendelse

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

Oppretter en lagret forsendelse fra en forberedt forsendelse.

Forsendelsesdataene i forespørselsbodyen må oppfylle de spesifikke kravene til forsendelsens tjeneste.

 

URI-parametere

prepareId string Identifikasjon av den forberedte forsendelsen. Påkrevd

 

Spørringsparametere

keepPreparedShipment boolean

Den forberedte IDen skal brukes igjen.

For eksempel, hvis en ordre inneholder forsendelser som skal sendes fra forskjellige lokasjoner, hvis en vare i ordren er restordre eller for en returservice.

 Valgfritt

 

 

Body-eksempel

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

 

Respons-eksempel


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

For en beskrivelse av egenskaper, vennligst se Egenskapsreferanseguide.

For skjema og testing, vennligst se https://api.unifaun.com/rs-docs/ og naviger til /prepared-shipments/stored-shipments POST.

Relaterte artikler