Logga in

nShift Help Center

Förberedda försändelser

Avatar
Malene Tidemann
Uppdaterad

Delivery-checkout-label.png


Skapar försändelser och lagrade försändelser från en förberedd försändelse.


Avsnitt i denna artikel:

 

Hämta en förberedd försändelse

GET /prepared-shipments/{prepareId}

Hämtar en förberedd försändelse som tidigare skapats.

 

URI-parametrar

prepareId string Identifiering av den förberedda försändelsen. Krävs

 

Exempel på svar


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


För en beskrivning av egenskaper, se Egenskapsreferensguiden.

För schema och testning, se https://api.unifaun.com/rs-docs/ och navigera till /prepared-shipments/{prepareId} GET.

 

 

Radera en förberedd försändelse

DELETE /prepared-shipments/{prepareId}

Raderar en förberedd försändelse.

När den förberedda försändelsen är raderad kommer inga ytterligare operationer att vara möjliga på den förberedda försändelse-ID:n.

 

URI-parametrar

prepareId string Identifiering av den delvisa försändelsen Krävs

 

Inget svarsinnehåll returneras när en förberedd försändelse raderas framgångsrikt.

För en beskrivning av egenskaper, se Egenskapsreferensguiden. För schema och testning, se https://api.unifaun.com/rs-docs/ och navigera till /prepared-shipments/{prepareId} DELETE.

 

Skapa en försändelse från en förberedd försändelse

POST /prepared-shipments/{prepareId}/shipments

Skapar en försändelse från en förberedd försändelse.

Försändelsens data i förfrågningskroppen måste uppfylla de specifika kraven för försändelsens tjänst. Flera försändelser kan skapas om den lagrade försändelsen representerar en kombinerad normal- och returförsändelse. Som standard returneras dokumenten som en URL. Som ett alternativ kan dokumenten vara inline i print.data-objektet i resultatet. print.data-objektet är kodad i base64.

De genererade dokumenten kommer endast att vara tillgängliga i en (1) timme.


URI-parametrar

prepareId string Identifiering av den förberedda försändelsen. Krävs

 

Query-parametrar

returnFile boolean 'true' om PDF/ZPL-filen ska returneras inline. Valfritt
keepPreparedShipment boolean

Förberedelse-ID:t ska användas igen.

Till exempel om en order innehåller försändelser som ska skickas från olika platser, om en vara i ordern är restnoterad eller för en returservice.

 Valfritt

 

Exempel på kropp


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

 

Exempel på svar


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

För en beskrivning av egenskaper, se Egenskapsreferensguiden.

För schema och testning, se https://api.unifaun.com/rs-docs/ och navigera till /prepared-shipments/{prepareId}/shipments POST.

 

 

Skapa en lagrad försändelse från en förberedd försändelse

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

Skapar en lagrad försändelse från en förberedd försändelse.

Försändelsens data i förfrågningskroppen måste uppfylla de specifika kraven för försändelsens tjänst.

 

URI-parametrar

prepareId string Identifiering av den förberedda försändelsen. Krävs

 

Query-parametrar

keepPreparedShipment boolean

Förberedelse-ID:t ska användas igen.

Till exempel om en order innehåller försändelser som ska skickas från olika platser, om en vara i ordern är restnoterad eller för en returservice.

 Valfritt

 

 

Exempel på kropp

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

 

Exempel på svar


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

För en beskrivning av egenskaper, se Egenskapsreferensguiden.

För schema och testning, se https://api.unifaun.com/rs-docs/ och navigera till /prepared-shipments/stored-shipments POST.

Relaterade artiklar