Log ind

nShift Help Center

Forberedte forsendelser

Avatar
Malene Tidemann
Opdateret

Delivery-checkout-label.png


Opretter forsendelser og gemte forsendelser ud fra en forberedt forsendelse.


Afsnit i denne artikel:

 

Hent en forberedt forsendelse

GET /prepared-shipments/{prepareId}

Henter en forberedt forsendelse, som tidligere er oprettet.

 

URI-parametre

prepareId string Identifikation af den forberedte forsendelse. Påkrævet

 

Response 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 af egenskaber, se venligst Egenskabsreferencen.

For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /prepared-shipments/{prepareId} GET.

 

 

Slet en forberedt forsendelse

DELETE /prepared-shipments/{prepareId}

Sletter en forberedt forsendelse.

Når den forberedte forsendelse er slettet, vil der ikke være mulighed for yderligere operationer på den forberedte forsendelses ID.

 

URI-parametre

prepareId string Identifikation af den delvise forsendelse Påkrævet

 

Der returneres ikke noget svarindhold, når en forberedt forsendelse slettes med succes.

For en beskrivelse af egenskaber, se venligst Egenskabsreferencen. For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /prepared-shipments/{prepareId} DELETE.

 

Opret en forsendelse fra en forberedt forsendelse

POST /prepared-shipments/{prepareId}/shipments

Opretter en forsendelse fra en forberedt forsendelse.

Forsendelsesdataene i anmodningskroppen skal opfylde de specifikke krav for forsendelsens service. Flere forsendelser kan oprettes, hvis den gemte forsendelse repræsenterer en kombineret normal- og returforsendelse. Som standard returneres dokumenterne som en URL. Som et valg kan dokumenterne være inline i print.data-objektet i resultatet. print.data-objektet er kodet i base64.

De genererede dokumenter vil kun være tilgængelige i en (1) time.


URI-parametre

prepareId string Identifikation af den forberedte forsendelse. Påkrævet

 

Query-parametre

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

Prepare ID'et skal bruges igen.

For eksempel, hvis en ordre indeholder forsendelser, der skal sendes fra forskellige lokationer, hvis en vare i ordren er restordre eller til en returtjeneste.

 Valgfri

 

Kroppseksempel


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

 

Response 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 af egenskaber, se venligst Egenskabsreferencen.

For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /prepared-shipments/{prepareId}/shipments POST.

 

 

Opret en gemt forsendelse fra en forberedt forsendelse

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

Opretter en gemt forsendelse fra en forberedt forsendelse.

Forsendelsesdataene i anmodningskroppen skal opfylde de specifikke krav for forsendelsens service.

 

URI-parametre

prepareId string Identifikation af den forberedte forsendelse. Påkrævet

 

Query-parametre

keepPreparedShipment boolean

Prepare ID'et skal bruges igen.

For eksempel, hvis en ordre indeholder forsendelser, der skal sendes fra forskellige lokationer, hvis en vare i ordren er restordre eller til en returtjeneste.

 Valgfri

 

 

Kroppseksempel

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

 

Response 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 af egenskaber, se venligst Egenskabsreferencen.

For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /prepared-shipments/stored-shipments POST.

Relaterede artikler