This article explains where the configuration of Delivery Checkout when used with Transsmart differs from the standard configuration.  

Sections in this article:

• Create a delivery checkout to use with Transsmart
• Book and print with Transsmart
• DeliveryCheckout API

Create a delivery checkout to use with Transsmart

If you are new to Delivery Checkout, we recommend starting by reading these articles:

• Getting started with Checkout
• Set up Delivery Checkout
  
  

1. Before you begin the setup, make sure you have at least one sender in your address book. Please refer to Add a new sender, Address book via API or Import address book.
   
   
2. You must also enter your Transsmart account number, user ID and password in the Transsmart details section on the Sender page in nShift Delivery.
   
   
3. Next, follow the steps described in: Create a delivery checkout

See our other articles about

• Checkout setup
• Delivery conditions

Delivery Checkout flow with Transsmart:

Book and print with Transsmart

You can book and print shipments with Transsmart via API, MyTranssmart or a direct link.

Via API

To book and print shipments via the Transsmart API you use prepare ID as the reference to perform the BOOK or PRINT action. Using the PRINT option the shipment will also be booked. When booking the shipment you have to add missing mandatory shipment information, such as package information.

In the MyTranssmart dashboard you can also configure defaults that will then be used automatically.

Read the Transsmart Developer Documentation to perform book and print from your eCommerce, ERP or WMS system here.

Manage the default settings in Transsmart here.

Via MyTranssmart

You can also book and print the shipment in the MyTranssmart user interface.

Go to Book and print in MyTranssmart.

Via direct link

If you want to go directly to the shipment to book and print, you use a URL.

https://api.transsmart.com/v2/direct/details?key=<transsmart key>&reference=<prepareId>

• Replace <transsmart key> with your key from Transsmart.
• Replace <prepareId> with the prepare ID from Delivery Checkout.

Obtain your Transsmart key here.

DeliveryCheckoutAPI

DeliveryCheckout API is an integration service for communication between Delivery Checkout and your webshop. DeliveryCheckout API uses a REST API framework for communication with JSON as data carrier offering a number of functions.

Please find all the general documentation for the DeliveryCheckoutAPI here.

When used together with Transsmart, there are a few special scenarios, which we will cover below. 

Create a partial shipment

POST /delivery-checkouts/{deliveryCheckoutId}/shipments

Creates a partial shipment based on the delivery option the consumer has selected in the webshop.

This endpoint is mandatory. 
Always use the complete delivery checkout ID since the delivery checkout version is included in the ID.

URI parameters

Body example

{
  "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
  }
}

Response example

{
  "sourceSystem": "TS",
  "serviceId": "TS:BPO:TAXIPOST24H",
  "optionTitle": "BPost taxipost 24h pickup point delivery",
  "serviceCaption": "BPost taxipost 24h pickup point delivery"
}

For a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkouts/{deliveryCheckoutId}/shipments POST.

Fetch a partial shipment

GET /delivery-checkout-shipments/{prepareId}

Fetches a partial shipment that was previously created.

URI parameters

Response example

{
  "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 a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkout-shipments/{prepareId} GET.

Delete a partial shipment

DELETE /delivery-checkout-shipments/{prepareId}

Deletes a partial shipment.

When the partial shipment is deleted the prepare ID can be reused for new partial shipments.

URI parameters

No response body is returned when a partial shipment is successfully deleted.

For a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkout-shipments/{prepareId} DELETE.

Fetch the service source system

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

Fetches the source system from which the partial shipment service originates.

Useful if only the prepare ID is known and the delivery checkout configuration contains options with services from several source systems.

URI parameters

For a description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkout-shipments/{prepareId}/source-system GET.