Denne artikel forklarer, hvor konfigurationen af Delivery Checkout, når den bruges med Transsmart, adskiller sig fra standardkonfigurationen.
Afsnit i denne artikel:
- Opret en Delivery Checkout til brug med Transsmart
- Book og udskriv med Transsmart
- DeliveryCheckout API
Opret en Delivery Checkout til brug med Transsmart
Hvis du er ny i Delivery Checkout, anbefaler vi, at du starter med at læse disse artikler:
- Inden du begynder opsætningen, skal du sikre dig, at du har mindst én afsender i din adressebog. Se venligst Tilføj en ny afsender, Adressebog via API eller Importer adressebog.
- Du skal også angive dit Transsmart kontonummer, bruger-ID og adgangskode i afsnittet Transsmart details på siden Sender i nShift Delivery.
- Følg derefter de trin, der er beskrevet i: Opret en Delivery Checkout
Se vores andre artikler om
Delivery Checkout-flow med Transsmart:
Book og udskriv med Transsmart
Du kan booke og udskrive forsendelser med Transsmart via API, MyTranssmart eller et direkte link.
Via API
For at booke og udskrive forsendelser via Transsmart API bruger du prepare ID som reference til at udføre BOOK- eller PRINT-handlingen. Hvis du bruger PRINT-indstillingen, vil forsendelsen også blive booket. Når du booker forsendelsen, skal du tilføje manglende obligatoriske forsendelsesoplysninger, f.eks. pakkeoplysninger.
I MyTranssmart-dashboardet kan du også konfigurere standardindstillinger, der derefter bruges automatisk.
Læs Transsmart Developer Documentation for at udføre book og udskriv fra dit e-handels-, ERP- eller WMS-system her.
Administrer standardindstillingerne i Transsmart her.
Via MyTranssmart
Du kan også booke og udskrive forsendelsen i MyTranssmart-brugergrænsefladen.
Gå til Book og udskriv i MyTranssmart.
Via direkte link
Hvis du vil gå direkte til forsendelsen for at booke og udskrive, bruger du en URL.
https://api.transsmart.com/v2/direct/details?key=<transsmart key>&reference=<prepareId>
- Erstat <transsmart key> med din nøgle fra Transsmart.
- Erstat <prepareId> med prepare ID fra Delivery Checkout.
Hent din Transsmart-nøgle her.
DeliveryCheckoutAPI
DeliveryCheckout API er en integrationstjeneste til kommunikation mellem Delivery Checkout og din webshop. DeliveryCheckout API bruger et REST API-framework til kommunikation med JSON som databærer og tilbyder en række funktioner.
Du finder al den generelle dokumentation for DeliveryCheckoutAPI her.
Når det bruges sammen med Transsmart, er der nogle særlige scenarier, som vi vil gennemgå nedenfor.
Opret en delvis forsendelse
POST /delivery-checkouts/{deliveryCheckoutId}/shipmentsOpretter en delvis forsendelse baseret på den leveringsmulighed, forbrugeren har valgt i webshoppen.
Dette endpoint er obligatorisk.
Brug altid det komplette Delivery Checkout-ID, da Delivery Checkout-versionen er inkluderet i ID'et.
URI-parametre
| deliveryCheckoutId | string | Delivery Checkout-ID'et returneret fra GET-anmodningen | Påkrævet |
| returnShipmentData | boolean | Forsendelsesdata returneres i svaret. | Valgfrit |
Eksempel 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
}
}
Eksempel på svar
{
"sourceSystem": "TS",
"serviceId": "TS:BPO:TAXIPOST24H",
"optionTitle": "BPost taxipost 24h pickup point delivery",
"serviceCaption": "BPost taxipost 24h pickup point delivery"
}For en beskrivelse af egenskaber, se venligst Egenskabsreferenceguiden.
For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /delivery-checkouts/{deliveryCheckoutId}/shipments POST.
Hent en delvis forsendelse
GET /delivery-checkout-shipments/{prepareId}Henter en delvis forsendelse, der tidligere er oprettet.
URI-parametre
| prepareId | string | Identifikation af den delvise forsendelse. | Påkrævet |
Eksempel 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"
}
}For en beskrivelse af egenskaber, se venligst Egenskabsreferenceguiden.
For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /delivery-checkout-shipments/{prepareId} GET.
Slet en delvis forsendelse
DELETE /delivery-checkout-shipments/{prepareId}Sletter en delvis forsendelse.
Når den delvise forsendelse er slettet, kan prepare ID genbruges til nye delvise forsendelser.
URI-parametre
| prepareId | string | Identifikation af den delvise forsendelse | Påkrævet |
Der returneres ingen svarfunktion, når en delvis forsendelse er slettet.
For en beskrivelse af egenskaber, se venligst Egenskabsreferenceguiden.
For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /delivery-checkout-shipments/{prepareId} DELETE.
Hent tjenestens kildesystem
GET /delivery-checkout-shipments/{prepareId}/source-systemHenter det kildesystem, som den delvise forsendelsestjeneste stammer fra.
Nyttigt, hvis kun prepare ID er kendt, og Delivery Checkout-konfigurationen indeholder muligheder med tjenester fra flere kildesystemer.
URI-parametre
| prepareId | string | Identifikation af den delvise forsendelse. | Påkrævet |
For en beskrivelse af egenskaber, se venligst Egenskabsreferenceguiden.
For skema og test, se venligst https://api.unifaun.com/rs-docs/ og naviger til /delivery-checkout-shipments/{prepareId}/source-system GET.