Sign in

nShift Help Center

Delivery Checkout and nShift Ship

Avatar
Malene Tidemann
Updated

Delivery-checkout-label.png


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

Sections in this article:

 

Create a Delivery Checkout to use with nShift Ship

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


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.


You must also enter your nShift Ship Actor ID and Key in the Ship details section on your Sender in nShift Delivery:

  1. Go to Maintenance > Senders.

  2. Search for your sender or Add a new sender.

  3. Enter your Actor ID and Key in the Ship details section.

    ship-checkout.png

Next, follow the steps described in this article: Create a delivery checkout

 

See our other articles about

 

Delivery Checkout flow with nShift Ship:

Checkout-Ship.png

 

 

Book and print with nShift Ship

You can book and print shipments with Ship via API or file import.

 

Via API

To book and print shipments via the Shipment Server API you use prepare ID as OrderId reference to perform the SubmitShipment action.

When doing the SubmitShipment you have to add missing mandatory shipment information, such as package information.

Read more about Using StoreOrder to save orders for import

 

File import

You can import the prepare ID and import this value into References > ShipAdvisor Reference together with mandatory shipment information, such as package information.

 

Go to Ship Help 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 nShift Ship, 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

deliveryCheckoutId

string

The Delivery Checkout ID returned from the GET request

Required

returnShipmentData

boolean

Shipment data will be returned in the response.

Optional

 

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": "DH",
    "serviceId": "DH:7132",
    "optionTitle": "PostNord Varubrev 1:a klass (7132)",
    "serviceCaption": "PostNord Varubrev 1:a klass (7132)",
    "addons": []
}

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

prepareId

string

Identification of the partial shipment.

Required

 

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

prepareId

string

Identification of the partial shipment

Required

 

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

prepareId

string

Identification of the partial shipment.

Required


For 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.

Related articles