Dit artikel legt uit waar de configuratie van Delivery Checkout bij gebruik met Transsmart afwijkt van de standaardconfiguratie.
Secties in dit artikel:
- Een Delivery Checkout aanmaken voor gebruik met Transsmart
- Boeken en afdrukken met Transsmart
- DeliveryCheckout API
Een Delivery Checkout aanmaken voor gebruik met Transsmart
Als u nieuw bent met Delivery Checkout, raden we u aan om te beginnen met het lezen van deze artikelen:
- Zorg er voordat u begint met de instelling voor dat u ten minste één afzender in uw adresboek heeft. Raadpleeg Een nieuwe afzender toevoegen, Adresboek via API of Adresboek importeren.
- U moet ook uw Transsmart accountnummer, gebruikers-ID en wachtwoord invoeren in de sectie Transsmart details op de pagina Sender in nShift Delivery.
- Volg vervolgens de stappen beschreven in: Een Delivery Checkout aanmaken
Bekijk onze andere artikelen over
Delivery Checkout-stroom met Transsmart:
Boeken en afdrukken met Transsmart
U kunt zendingen boeken en afdrukken met Transsmart via API, MyTranssmart of een directe link.
Via API
Om zendingen te boeken en af te drukken via de Transsmart API gebruikt u het prepare ID als referentie om de actie BOOK of PRINT uit te voeren. Bij gebruik van de optie PRINT wordt de zending ook geboekt. Bij het boeken van de zending moet u ontbrekende verplichte zendingsinformatie toevoegen, zoals pakketinformatie.
In het MyTranssmart-dashboard kunt u ook standaardinstellingen configureren die vervolgens automatisch worden gebruikt.
Lees de Transsmart Developer Documentation om vanuit uw e-commerce-, ERP- of WMS-systeem te boeken en af te drukken hier.
Beheer de standaardinstellingen in Transsmart hier.
Via MyTranssmart
U kunt de zending ook boeken en afdrukken in de MyTranssmart-gebruikersinterface.
Ga naar Boeken en afdrukken in MyTranssmart.
Via directe link
Als u direct naar de zending wilt gaan om te boeken en af te drukken, gebruikt u een URL.
https://api.transsmart.com/v2/direct/details?key=<transsmart key>&reference=<prepareId>
- Vervang <transsmart key> door uw sleutel van Transsmart.
- Vervang <prepareId> door het prepare ID van Delivery Checkout.
Haal uw Transsmart-sleutel op hier.
DeliveryCheckoutAPI
DeliveryCheckout API is een integratieservice voor communicatie tussen Delivery Checkout en uw webshop. DeliveryCheckout API gebruikt een REST API-framework voor communicatie met JSON als gegevensdrager en biedt een aantal functies.
Alle algemene documentatie voor de DeliveryCheckoutAPI vindt u hier.
Bij gebruik samen met Transsmart zijn er enkele speciale scenario's, die we hieronder zullen bespreken.
Een gedeeltelijke zending aanmaken
POST /delivery-checkouts/{deliveryCheckoutId}/shipmentsMaakt een gedeeltelijke zending aan op basis van de leveringsoptie die de consument in de webshop heeft geselecteerd.
Dit endpoint is verplicht.
Gebruik altijd het volledige Delivery Checkout-ID, omdat de Delivery Checkout-versie in het ID is opgenomen.
URI-parameters
| deliveryCheckoutId | string | Het Delivery Checkout-ID dat wordt geretourneerd door het GET-verzoek | Verplicht |
| returnShipmentData | boolean | Zendingsgegevens worden geretourneerd in het antwoord. | Optioneel |
Voorbeeld van 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
}
}
Voorbeeld van antwoord
{
"sourceSystem": "TS",
"serviceId": "TS:BPO:TAXIPOST24H",
"optionTitle": "BPost taxipost 24h pickup point delivery",
"serviceCaption": "BPost taxipost 24h pickup point delivery"
}Voor een beschrijving van eigenschappen, raadpleeg de Eigenschappenreferentiegids.
Voor schema en testen, raadpleeg https://api.unifaun.com/rs-docs/ en navigeer naar /delivery-checkouts/{deliveryCheckoutId}/shipments POST.
Een gedeeltelijke zending ophalen
GET /delivery-checkout-shipments/{prepareId}Haalt een eerder aangemaakte gedeeltelijke zending op.
URI-parameters
| prepareId | string | Identificatie van de gedeeltelijke zending. | Verplicht |
Voorbeeld van antwoord
{
"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"
}
}Voor een beschrijving van eigenschappen, raadpleeg de Eigenschappenreferentiegids.
Voor schema en testen, raadpleeg https://api.unifaun.com/rs-docs/ en navigeer naar /delivery-checkout-shipments/{prepareId} GET.
Een gedeeltelijke zending verwijderen
DELETE /delivery-checkout-shipments/{prepareId}Verwijdert een gedeeltelijke zending.
Wanneer de gedeeltelijke zending is verwijderd, kan het prepare ID opnieuw worden gebruikt voor nieuwe gedeeltelijke zendingen.
URI-parameters
| prepareId | string | Identificatie van de gedeeltelijke zending | Verplicht |
Er wordt geen antwoordtekst geretourneerd wanneer een gedeeltelijke zending succesvol is verwijderd.
Voor een beschrijving van eigenschappen, raadpleeg de Eigenschappenreferentiegids.
Voor schema en testen, raadpleeg https://api.unifaun.com/rs-docs/ en navigeer naar /delivery-checkout-shipments/{prepareId} DELETE.
Het bronssysteem van de service ophalen
GET /delivery-checkout-shipments/{prepareId}/source-systemHaalt het bronsysteem op waaruit de gedeeltelijke zendingsservice afkomstig is.
Nuttig als alleen het prepare ID bekend is en de Delivery Checkout-configuratie opties bevat met services van meerdere bronsystemen.
URI-parameters
| prepareId | string | Identificatie van de gedeeltelijke zending. | Verplicht |
Voor een beschrijving van eigenschappen, raadpleeg de Eigenschappenreferentiegids.
Voor schema en testen, raadpleeg https://api.unifaun.com/rs-docs/ en navigeer naar /delivery-checkout-shipments/{prepareId}/source-system GET.