Den här artikeln förklarar var konfigurationen av Delivery Checkout vid användning med Transsmart skiljer sig från standardkonfigurationen.
Avsnitt i den här artikeln:
- Skapa en Delivery Checkout för användning med Transsmart
- Boka och skriv ut med Transsmart
- DeliveryCheckout API
Skapa en Delivery Checkout för användning med Transsmart
Om du är ny med Delivery Checkout rekommenderar vi att du börjar med att läsa dessa artiklar:
- Innan du börjar konfigurationen, se till att du har minst en avsändare i din adressbok. Se Lägg till en ny avsändare, Adressbok via API eller Importera adressbok.
- Du måste också ange ditt Transsmart-kontonummer, användar-ID och lösenord i avsnittet Transsmart details på sidan Sender i nShift Delivery.
- Följ sedan de steg som beskrivs i: Skapa en Delivery Checkout
Se våra andra artiklar om
Delivery Checkout-flöde med Transsmart:
Boka och skriv ut med Transsmart
Du kan boka och skriva ut försändelser med Transsmart via API, MyTranssmart eller en direktlänk.
Via API
För att boka och skriva ut försändelser via Transsmart API använder du prepare ID som referens för att utföra åtgärden BOOK eller PRINT. Om du använder alternativet PRINT bokas försändelsen också. När du bokar försändelsen måste du lägga till saknad obligatorisk försändelseinformation, t.ex. paketinformation.
I MyTranssmart-instrumentpanelen kan du också konfigurera standardinställningar som sedan används automatiskt.
Läs Transsmart Developer Documentation för att utföra bokning och utskrift från ditt e-handels-, ERP- eller WMS-system här.
Hantera standardinställningarna i Transsmart här.
Via MyTranssmart
Du kan också boka och skriva ut försändelsen i MyTranssmart-användargränssnittet.
Gå till Boka och skriv ut i MyTranssmart.
Via direktlänk
Om du vill gå direkt till försändelsen för att boka och skriva ut använder du en URL.
https://api.transsmart.com/v2/direct/details?key=<transsmart key>&reference=<prepareId>
- Ersätt <transsmart key> med din nyckel från Transsmart.
- Ersätt <prepareId> med prepare ID från Delivery Checkout.
Hämta din Transsmart-nyckel här.
DeliveryCheckoutAPI
DeliveryCheckout API är en integrationstjänst för kommunikation mellan Delivery Checkout och din webbutik. DeliveryCheckout API använder ett REST API-ramverk för kommunikation med JSON som databärare och erbjuder ett antal funktioner.
All allmän dokumentation för DeliveryCheckoutAPI finns här.
Vid användning tillsammans med Transsmart finns det några särskilda scenarier, som vi går igenom nedan.
Skapa en delleverans
POST /delivery-checkouts/{deliveryCheckoutId}/shipmentsSkapar en delleverans baserat på det leveransalternativ som konsumenten har valt i webbutiken.
Den här slutpunkten är obligatorisk.
Använd alltid det fullständiga 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": "TS",
"serviceId": "TS:BPO:TAXIPOST24H",
"optionTitle": "BPost taxipost 24h pickup point delivery",
"serviceCaption": "BPost taxipost 24h pickup point delivery"
}En beskrivning av egenskaper finns i Egenskapsreferensguiden.
För schema och testning, se https://api.unifaun.com/rs-docs/ och navigera 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"
}
}En beskrivning av egenskaper finns i Egenskapsreferensguiden.
För schema och testning, se https://api.unifaun.com/rs-docs/ och navigera 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 svarstekst returneras när en delleverans har tagits bort.
En beskrivning av egenskaper finns i Egenskapsreferensguiden.
För schema och testning, se https://api.unifaun.com/rs-docs/ och navigera till /delivery-checkout-shipments/{prepareId} DELETE.
Hämta tjänstens källsystem
GET /delivery-checkout-shipments/{prepareId}/source-systemHämtar källsystemet som delleveranstjänsten härstammar 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 |
En beskrivning av egenskaper finns i Egenskapsreferensguiden.
För schema och testning, se https://api.unifaun.com/rs-docs/ och navigera till /delivery-checkout-shipments/{prepareId}/source-system GET.