Sign in

nShift Help Center

Getting started with DeliveryCheckout API

Avatar
Malene Tidemann
Updated

Delivery-checkout-label.png


DeliveryCheckout API is an integration service for communication between Delivery Checkout and your webshop.

Sections in this article:

Introduction

DeliveryCheckout API uses a REST API framework for communication with JSON as data carrier offering a number of functions.

With DeliveryCheckout API you can:

  • Present delivery options in your webshop.
  • Prepare shipments
  • Upload agent lists

The REST API endpoints are only accessible via HTTPS and are located at api.unifaun.com.

https://api.unifaun.com/rs-extapi/v1

 

Before getting started you need to know your developer ID and create an API key.

As a merchant, you may have outsourced your logistics to a third-party logistics (3PL) provider. You need an account where you configure the checkout and the 3PL needs an account to print the shipments. The recommended process in Delivery Checkout is to send the response from POST/delivery-checkouts/{deliveryCheckoutId} to your 3PL. Consequently, the shipment will be created from the 3PL's nShift Delivery account.

Alternatively, the 3PL can fetch the prepared shipment information using GET /prepared-shipments/{prepareId}.

We recommend that you prepare a fallback solution for every checkout session in case you do not get a response from our API, for example, due to maintenance. This way you ensure that your customers are always presented with shipping options.



Delivery Checkout flow

checkout-flows.png

 

 

API keys

An API key is a unique identifier used to authenticate an application or user. API keys can be used on the account or profile level.

If you have profile management activated on your account, you can create API keys connected to a specific profile. This API key then uses the profile group of the selected profile to filter out what information you can collect using the API, and where it will be posted.


Create an API key

  1. Log in to nShift Delivery.

  2. Go to Maintenance > API keys.

    API-keys.png

  3. Click New API key.

  4. Status should be "Enabled".

  5. Type should be set to "Web Services (REST)".

  6. Specify what the API key is used for in the Note field. As you can create multiple API keys, it is recommended to use the Note field.

  7. Enter Valid IP addresses if the API key should only be used from certain IP addresses or ranges of IP addresses.

  8. The Email field is not used at this time.

  9. Enter your Developer ID. Normally, the developer ID is your account user ID. But if you have, or are, an ERP, webshop provider or another third party that will post data into the account, it is the user ID of the provider's account.

  10. Select a Profile in the drop-down menu, if the API key should be connected to a specific profile.

  11. Click Save. The system will automatically generate the key consisting of an ID, a secret ID and a combined ID.
    It is the ID and the secret ID that you use to authenticate towards the REST API framework.

    new-API-key.png

Use the search function to search for your API keys.

 

Related articles