Når en kunde gennemfører checkout, kan du oprette en partial shipment i nShift Checkout. En delvis forsendelse indeholder leveringsvalget (transportør/service, afhentningssted osv.), men den skal stadig færdiggøres (bookes) i nShift Ship for at generere forsendelsesnumre og labels.

Oversigt

Dette er det typiske end-to-end-flow:

1. Opret en delvis forsendelse i Checkout (Checkout API).
2. Book forsendelsen i nShift Ship ved hjælp af Post Shipment-anmodningen for at producere labels og et forsendelsesnummer.

Trin 1: Opret den delvise forsendelse i Checkout

Når kunden har valgt en leveringsmulighed, skal du oprette en delvis forsendelse ved hjælp af Checkout API-dokumentationen: Create Partial Shipment.

Vigtigt: Sørg for at gemme den identifikator, du senere vil bruge til at finde ordren/forsendelsen. Dette er typisk orderID.
 

Trin 3: Færdiggør forsendelsen ved at booke den i nShift Ship

For at afslutte en delvis forsendelse booker du den ved hjælp af metoden Post Shipment i Ship API. Dette opretter/booker forsendelsen og returnerer fragtlabelen. 
 

Det skal du inkludere for at kunne booke korrekt

En booket forsendelse kræver et komplet “data object” for forsendelsen (modtager, transportørprodukt/service, pakker/vægte osv.). Følgende er påkrævet, men kun de oplysninger, som ikke er inkluderet i den delvise forsendelse, er nødvendige for at færdiggøre forsendelsen. I praksis indeholder den delvise forsendelse (fra Checkout) normalt ikke alt det, der er nødvendigt for at gennemføre bookingen.

• OrderID: tilføjes i Options, og den henter dataene fra den delvise forsendelse fra Checkout
• Carrier service: ProdConceptID
• Order number: OrderNo
• Addresses: modtager (Kind: 1) og afsender (Kind: 2)
• Packages / lines: for eksempel vægte/dimensioner i Lines
• Goodstypes: kræves af nogle transportører
• Label format options: for eksempel "Labels": "ZPLGK"
• Customs details: nødvendigt ved forsendelse over toldgrænser

Hver transportør har sine egne specifikationer og krav - læs mere her: Identifikation af påkrævede felter ved booking af forsendelser

For flere detaljer om booking af en forsendelse, se Sådan gør du - Book en forsendelse

Eksempel på anmodning (enkelt pakke)

Dette eksempel viser en forsendelse, der indeholder adresseoplysninger. Normalt er adresseoplysninger en del af den delvise forsendelse fra Checkout og er ikke påkrævet, men nogle transportører kan have brug for ekstra oplysninger afhængigt af deres krav.

curl -s -X POST "{{URL}}/ShipServer/{{ACTOR_ID}}/Shipments" \
  -H "Authorization: {{TOKEN}}" \
  -H "Content-Type: application/json" \
  --data-raw "{
    \"data\": {
      \"OrderNo\": \"Test Shipment 1\",
      \"Addresses\": [{
        \"Kind\": 1,
        \"Name1\": \"Test Receiver Name1\",
        \"Street1\": \"Test Road 1\",
        \"PostCode\": 7400,
        \"City\": \"Herning\",
        \"CountryCode\": \"DK\",
        \"Phone\": \"12341234\",
        \"Mobile\": \"12341234\",
        \"Email\": \"noreply@nshift.com\",
        \"Attention\": \"Test Attention\"
      },{
        \"Kind\": 2,
        \"Name1\": \"Test Sender Name1\",
        \"Street1\": \"Test Road 1\",
        \"PostCode\": 6400,
        \"City\": \"Sønderborg\",
        \"CountryCode\": \"DK\",
        \"Phone\": \"12341234\",
        \"Mobile\": \"12341234\",
        \"Email\": \"noreply@nshift.com\",
        \"Attention\": \"Test Attention\"
      }],
      \"Lines\":[{
        \"Number\": 1,
        \"PkgWeight\": 10000,
        \"Height\": 100,
        \"Length\": 100,
        \"Width\": 100,
        \"GoodsTypeID\": 13
      }]
    },
    \"options\": { \"Labels\": \"ZPLGK\" \"OrderID\":\"order123\" }
  }"

Hvad du får tilbage

Svaret indeholder forsendelsesidentifikatorer (f.eks. forsendelsesnummer) og label-/dokumentindhold, som du kan udskrive eller videresende til efterfølgende systemer.

Flowchart, der illustrerer en Checkout-integration med nShift Ship: