Logga in
nShift Help Center

Delivery Checkout och nShift Ship

Avatar
Malene Tidemann
Uppdaterad

Delivery-checkout-label.png


Den här artikeln förklarar var konfigurationen av Delivery Checkout skiljer sig från standardkonfigurationen när den används tillsammans med nShift Ship. 

Avsnitt i den här artikeln:

 

Skapa en Delivery Checkout för användning med nShift Ship

Om Delivery Checkout är nytt för dig rekommenderar vi att du börjar med att läsa följande artiklar:


Innan du börjar konfigurera måste du se till att du har minst en avsändare i din adressbok. Se Adressbok – nShift Delivery Help Center


Du måste också ange ditt nShift Ship Actor ID och Key i avsnittet Ship details för din Sender i nShift Delivery:

  1. Gå till Maintenance > Senders.
     
  2. Sök efter din avsändare eller lägg till en ny avsändare.
     
  3. Ange ditt Actor ID och din Key i avsnittet Ship details.

    ship-checkout.png

Följ sedan stegen som beskrivs i den här artikeln: Skapa en delivery checkout

 

Se våra andra artiklar om

 

Flöde för Delivery Checkout med nShift Ship:

Checkout-Ship.png

 

 

Boka och skriv ut med nShift Ship

Du kan boka och skriva ut försändelser med Ship via API eller filimport.

 

Via API

För att boka och skriva ut försändelser via Shipment Server API använder du prepare ID som referens för OrderId när du utför åtgärden SubmitShipment.

När du utför SubmitShipment måste du lägga till obligatorisk information om försändelsen som saknas, till exempel paketinformation.

Läs mer om att använda StoreOrder för att spara order för import

 

Filimport

Du kan importera prepare ID och importera detta värde till References > ShipAdvisor Reference tillsammans med obligatorisk information om försändelsen, till exempel paketinformation.

 

Gå till Ship-hjälpen här.

 

 

DeliveryCheckoutAPI

DeliveryCheckout API är en integrationstjänst för kommunikation mellan Delivery Checkout och din webbshop. DeliveryCheckout API använder ett REST API-ramverk för kommunikation med JSON som databärare och erbjuder ett antal funktioner.

Du hittar all generell dokumentation för DeliveryCheckoutAPI här.

När det används tillsammans med nShift Ship finns det några särskilda scenarier, som vi går igenom nedan. 

 

Skapa en delleverans

POST /delivery-checkouts/{deliveryCheckoutId}/shipments

Skapar en delleverans baserat på det leveransalternativ som konsumenten har valt i webbshopen.

Denna endpoint är obligatorisk. 
Använd alltid hela Delivery Checkout-ID:t eftersom Delivery Checkout-versionen ingår i ID:t.

 

URI-parametrar

deliveryCheckoutId string Delivery Checkout-ID:t som returneras från GET-begäran Obligatorisk
returnShipmentData boolean Försändelsedata returneras i svaret. Valfri

 

Exempel på body

{
  "selectedOptionId": "3e01c458-b4fb-4a15-9468-f9179a516a0c",
  "language": "en",
  "orderNo": "order number 123",
  "prepareId": "test34",
  "receiver": {
    "name": "Testname",
    "address1": "Testaddress 1",
    "zipCode": "1080",
    "city": "Ixelles",
    "country": "BE",
    "mobile": "0733000000",
    "email": "email2@example.com"
  },
  "agent": {
    "quickId": "19172",
    "name": "DISTRIBUTEUR TRIBES BXL CN",
    "address1": "Avenue Louise 279",
    "address2": null,
    "zipCode": "1050",
    "city": "Bruxelles",
    "state": null,
    "country": "BE",
    "mapLongitude": 4.36706,
    "mapLatitude": 50.82386,
    "phone": null,
    "email": null
  }
}

 

Exempel på svar

{
    "sourceSystem": "DH",
    "serviceId": "DH:7132",
    "optionTitle": "PostNord Varubrev 1:a klass (7132)",
    "serviceCaption": "PostNord Varubrev 1:a klass (7132)",
    "addons": []
}

För en beskrivning av egenskaperna, se referensguiden för egenskaper.

För schema och testning, se https://api.unifaun.com/rs-docs/ och gå till /delivery-checkouts/{deliveryCheckoutId}/shipments POST.

 

Hämta en delleverans

GET /delivery-checkout-shipments/{prepareId}

Hämtar en delleverans som tidigare har skapats.

 

URI-parametrar

prepareId string Identifiering av delleveransen. Obligatorisk

 

Exempel på svar

{
  "serviceId": "DCTEST",
  "serviceTitle": "Delivery Checkout Test Service",
  "sourceSystem": "UO",
  "orderNo": "order number 123",
  "prepareId": "123",
  "sender": {
    "quickId": "1",
    "name": "nShift AB",
    "address1": "Skeppsbron 5-6",
    "postalCode": "41121",
    "city": "GÖTEBORG",
    "country": "SE",
    "phone": "+46 31 725 35 00",
    "email": "email1@example.com"
  },
  "receiver": {
    "name": "nShift AB",
    "address1": "Tegnérgatan 34",
    "postalCode": "11359",
    "city": "STOCKHOLM",
    "country": "SE",
    "phone": "+46 8 34 35 15",
    "email": "email2@example.com"
  }
}

För en beskrivning av egenskaperna, se referensguiden för egenskaper.

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

 

 

Ta bort en delleverans

DELETE /delivery-checkout-shipments/{prepareId}

Tar bort en delleverans.

När delleveransen har tagits bort kan prepare ID återanvändas för nya delleveranser.

 

URI-parametrar

prepareId string Identifiering av delleveransen Obligatorisk

 

Ingen response body returneras när en delleverans har tagits bort.

För en beskrivning av egenskaperna, se referensguiden för egenskaper.

För schema och testning, se https://api.unifaun.com/rs-docs/ och gå till /delivery-checkout-shipments/{prepareId} DELETE.

 

 

Hämta tjänstens källsystem

GET /delivery-checkout-shipments/{prepareId}/source-system

Hämtar det källsystem som delleveranstjänsten kommer från.

Användbart om endast prepare ID är känt och Delivery Checkout-konfigurationen innehåller alternativ med tjänster från flera källsystem.

 

URI-parametrar

prepareId string Identifiering av delleveransen. Obligatorisk


För en beskrivning av egenskaperna, se referensguiden för egenskaper.

För schema och testning, se https://api.unifaun.com/rs-docs/ och gå till /delivery-checkout-shipments/{prepareId}/source-system GET.

Relaterade artiklar