nshiftgo

nShift API documentation

Getting Started

Features

Signup

Onboarding

Terminology

REST API Guideline

Accounts

Creates a new account that can be used to interact with the nShift Go APIs.  As a [Partner](https://docs.nshiftgo.com/getting-started/terminology), you create at least one [Account](https://docs.nshiftgo.com/getting-started/terminology) for each one of your clients. This ensures data isolation for your clients. 

Once you have an `accountId`, it can be used to [issue an Access Token](#tag/Accounts/operation/IssueToken), which can be used to call the nShift Go APIs. 

The `accountId` should be considered a **SECRET** between the Partner and nShift, and should not be exposed to your clients.

Create Account

To interact with the nShift Go APIs, you need an Access Token for the Account you intend to act as.

 To issue such a token, call this endpoint with the `accountId` of the Account returned from the [Create Account](#tag/Accounts/operation/CreateAccount) endpoint as the `sub` parameter. . 

 All Access Tokens are valid for 4 hours, and then need to be re-newed by calling this endpoint again.

Issue Token for Account

Updates the details of an existing Account. The `accountId` is returned from the [Create Account](#tag/Accounts/operation/CreateAccount) endpoint.

Update Account

Returns the details of a specific account. The `accountId` is the unique identifier for the account.

Fetch Account

Returns a list of all accounts that have been created by the Partner. This can be used to get a list of all clients that the Partner has onboarded.

List Accounts

Addresses

Create new addresses that can be used through Orders or Shipment Bookings by referencing their unique identifiers.
When defining an Address you need to provide suitable roles. Each role corresponds to how the address can be used in the system e.g. an Address with both 'SENDER' and 'RECEIVER' roles can be used both for dispatching and delivery addresses. The role definitions differ according to which API endpoints you use as e.g. 'SELLER' may not correspond to where the Shipment Booking is actually sent from etc.

Create Address

Update an existing Address with new information. Note that changes made to an Address may not be reflected on already processed entities such as Orders and Shipment Bookings.

Update Address

Remove an existing Address. Note that changes made to an Address may not be reflected on already processed entities such as Orders and Shipment Bookings.

Delete Address

Fetch an existing Address by using its unique identifier.

Fetch Address

Fetch all existing Addresses stored on your account.

Fetch Addresses

Carrier Configurations

Using this endpoint allows you to set up and configure a new carrier. By providing the necessary details such as carrier code, service code, and add-ons, you can tailor the configuration to your specific needs. Upon successful creation, you receive a response confirming the creation of the new carrier configuration.

Create Carrier Configuration

Using this endpoint allows you to modify an existing carrier configuration by providing its unique identifier along with the updated details. By specifying the carrier configuration id of the carrier configuration to be updated and supplying the revised information such as carrier code, service code, and add-ons, you can tailor the configuration to reflect any changes or adjustments. Upon successful execution, the endpoint applies the modifications to the specified carrier configuration and returns a response confirming the update.

Update Carrier Configuration

Using this endpoint allows you to remove a carrier configuration from the system based on its unique identifier. By providing the ID of the carrier configuration to be deleted, you can initiate the removal process. Once executed, the endpoint permanently removes the specified carrier configuration from the system, including all associated details such as carrier code, service code, and add-ons. Upon successful deletion, the endpoint returns a response confirming the removal of the carrier configuration.

Delete Carrier Configuration

Using this endpoint allows you to retrieve the details of a specific carrier configuration based on its unique identifier. By providing the configuration id of the carrier configuration as a parameter, you can access all the relevant information, including the carrier code, service code, and any associated add-ons. Upon successful retrieval, the endpoint returns a response containing the comprehensive configuration details of the specified carrier.

Fetch Carrier Configuration

Using this endpoint allows you to retrieve a list of all existing carrier configurations within the system. It provides a comprehensive overview of the configured carriers, including their respective carrier codes, service codes, and associated add-ons. This endpoint allows you to efficiently manage and monitor all configured carriers in your system. Upon successful execution, the endpoint returns a response containing a list of all available carrier configurations.

List Carrier Configurations

Carriers

Fetch Carrier

If you already know the carrierId and the serviceId you are able to retrieve the data directly.

Fetch Carrier Service

This endpoint will list all available carriers and provide rudimentary information about each. Once this information is aquired further requests can be made to discover more data about each carrier and service.

List Carriers

This endpoint will list all available services for a specific carrier.

List Carrier Services

Checks (coming soon)

Perform a lookup check based on more detailed address information. The lookup will return best matching address.

Check Address

Perform a lookup check based on countryCode and postalCode. The lookup will return the country name and city name in addition to validating whether the postalcode exists.

Check Postalcode

Delivery Options

Create a new Delivery Option that can be used to create Shipping Quotes that include prices and shipping information. The Delivery Option is defined using items and conditions.

The Zones need to be created and associated with the Delivery Option.

Create Delivery Option

This endpoint will update the existing Delivery Option using their unique identifiers.

Update Delivery Option

This endpoint will remove existing Delivery Option using their unique identifiers.

Delete Delivery Option

Use this endpoint to fetch specific Delivery Options using their unique identifiers.

Fetch Delivery Option

This endpoint will list all the existing Delivery Options on your account.

List Delivery Options

Evaluate all active Delivery Options using payload with parameters and generate Shipping Quotes that hold temporary information about the provided input and returned Delivery Option.
A purchaseId identifier (UUID) is generated for the batch of Shipping Quotes that are generated so that the user can esily identify them later through /shipping-quotes endpoints.

Evaluate Delivery Options

Create a new Zone definition that can be used to create Delivery Options that include prices and shipping information.

The Zone is defined using a list of conditions that are evaluated against the shipment details.

The Zone is associated with a Delivery Option.


Create Zone

Update an existing Zone definition using their unique identifiers.

Update Zone

Delete an existing Zone definition using their unique identifiers. If the Zone is currently associated with a Delivery Option the operation will be denied.

Delete Zone

Fetch existing Zones by using their unique identifiers.

Fetch Zone

List all existing Zone definitions associated with the account.

List Zones

Documents

Fetch the meta data and Base64-encoded content of a document using its unique identifier documentId.

Fetch Document

Retrieve the raw binary data of a document based on its content type using the document's unique identifier documentId.

Fetch Document Data

Fetch the meta data of a specific document using its unique identifier documentId.

Fetch Document Meta Data

Retrieve meta data for all documents associated with a specific account. Optionally, filter the results by `groupId` to include only documents related to a particular entity, such as a Shipment Booking.

List Document Meta Data

Event Channels

Create Event Channel

Update Event Channel

Delete Event Channel

Fetch Event Channel

List Event Channels

Orders (coming soon)

Creating an Order allows you to store handle fulfillment and transition to creating a Shipment Booking in a convenient manner. Oders have associated entities like Addresses, Parcels, Carrier Configurations and Documents.

Create Order

Use this endpoint for updating an existing Order.

Update Order

Use this endpoint to remove an existing Order using it's unique identifier.

Delete Order

You are able to fetch a specific Order using it's unique identifier.

Fetch Order

Use this endpoint to list existing Orders using query parameters.

List Orders

Create Order Channel

Update Order Channel

Delete Order Channel

Fetch Order Channel

List Order Channels

Fetch Order Channel Type

List Order Channel Types

Parcels

Create Parcel

This endpoint will update the existing Parcel using their unique identifiers.

Update Parcel

This endpoint will remove existing Parcel using their unique identifiers.

Delete Parcel

Use this endpoint to fetch specific Parcel using their unique identifiers.

Fetch Parcel

This endpoint will list all the existing Parcels on your account.

List Parcels

Create Parcel Item

This endpoint will update the existing Parcel Item using their unique identifiers.

Update Parcel Item

This endpoint will remove existing parcel Item using their unique identifiers.

Delete Parcel Item

Use this endpoint to fetch specific Parcel Item using their unique identifiers.

Fetch Parcel Item

This endpoint will list all the existing Parcel Items on your account.

List Parcel Items

PUDO Points

Using this endpoint will list any PUDO Points that fall within the proximity of the provided address information.

Query PUDO Points

If you need to fetch a specific PUDO Point you can request it by providing the PUDO Point ID.

Fetch PUDO Point

Print (coming soon)

If you need a solution for printing a Document you can use this endpoint. This requires that you first install the Print client which comes bundled free of charge with your subscription.

Create Print Job

It is not possible to delete a Print Job completely since it has likely already left our system and might already have ended up in your printer queue.
However, if there is a build up due to e.g. a paperjam this means that you likely should be able to stop it from ending up in the queue. Our Print client will automatically receive new printjobs at the rate that it is able to queue print jobs. This endpoint will change the Print Job status to 'CANCELLED'.

Delete Print Job

Whenever you need to fetch a specific Print Job this endpoint can be used using the unqie identifier of the Print Job.

Fetch Print Job

Use this endpoint to retrieve Print Jobs that have already been triggered and sent to your printer.

List Print Jobs

Reports (coming soon)

Generate a report of Shipment Bookings created on accounts with a breakdown about carrier and service usage. Filters can be used to target specific accounts, timespans, carriers and services. The report is generated asynchronously and the report ID is returned in response. Events are propagataed when the report is ready to be retrieved.

Generate Shipment Booking Usage Report

Fetch an existing Shipment Booking usage Report by using its unique identifier. If the Report is ready it will be returned.

Fetch Shipment Booking Report

Shipping Quotes

A Shipping Quote stores information about a specific Delivery Option, the evaluated price and cart information.
This endpoint will evaluate existing Deliver Options and generate corresponding Shipping Quotes. You can then use a Shipping Quote and transform it into an Order or Shipment Booking directly.

Create Shipping Quotes

If you need to fetch a specific Shipping Quote you can request it by providing the Shipping Quote ID.

Fetch Shipping Quote

Using this endpoint will list any existing Shipping Quotes filtered by provided reference.

Fetch Shipping Quotes

Shipments

Create a new Shipment Channel containing information about how an associated Shipment Booking is processed.

Create Shipment Channel

Update an existing Shipment Channel containing information about how an associated Shipment Booking is processed.

Update Shipment Channel

Delete an existing Shipment Channel by using its unique identifier.
Note that Shipment Channels are required to create Shipment Bookings and removing a used Shipment Channel might cause an integration to stop working.

Delete Shipment Channel

Fetch an existing Shipment Channel by using its unique identifier.

Fetch Shipment Channel

Fetch all existing Shipment Channels stored on the account.

Fetch Shipment Channels

Create a new Shipment Booking containing information about associated Shipment Channel, Carrier Configuration and Addresses etc.
Parcel information is also provided or optionally pulled from associated Parcel objects that you define before hand.

Create Shipment Booking

Using this endpoint you will be able to update a Shipment Booking but only under certain conditions. Normally a Shipment Booking is finalized immediately but there are Shipment Channel controls you can use for e.g. Consolidation, Pre-validation etc. that affects the process of finalizing a Shipment Booking.

Update Shipment Booking

Delete an existing Shipment Booking by using its unique identifier.
Note that removing a Shipment Booking is not possible after it has been finalized. This endpoint will in this case only change the status of the Shipment Booking to 'CANCELLED'.
If the Shipment Booking is being processed as a Consolidation or Pre-Validation it is, however, possible to remove the Shipment Booking entirely.

Delete Shipment Booking

Fetch an existing Shipment Booking by using its unique identifier.

Fetch Shipment Booking

Fetch all existing Shipment Bookings stored on your account.

Fetch Shipment Bookings

Default

nShift Go API

nShift Go Documentation

<h2 class="slate-h2 " >Welcome to nShift! </h2><p class="slate-p " >nShift Go is a comprehensive shipping solution, crafted to simplify the operations of e-commerce retailers by automating your workflows and unifying all your shipping tasks on one platform. We bridge online merchants to an extensive range of international shipping services and delivery choices from <strong class="slate-bold">over 1,000 carriers throughout Europe</strong>. In collaboration with our partner carriers, we offer integrations with more than <strong class="slate-bold">450 e-commerce platforms</strong>, Warehouse Management Systems (WMS), and marketplaces.</p><p class="slate-p " ></p><h2 class="slate-h2 " >API</h2><p class="slate-p " >Our user-friendly REST API allows you to oversee all your shipping requirements, eliminating the need to grapple with the intricacies of various carrier APIs and protocols. We take care of the challenging aspects, enabling you to concentrate on delivering an exceptional shipping experience to your customers at the most competitive rates.</p><p class="slate-p " >Every feature of nShift Go can be utilized independently or synergistically to incorporate robust shipping capabilities into your application or service.</p><p class="slate-p " >Read more about the the <a href="https://docs.nshiftgo.com/getting-started/rest-api-guideline" target="_top">guidelines we follow</a> when implementing our API.
</p><h2 class="slate-h2 " >Mission</h2><p class="slate-p " >Our mission is to empower European retailers with a sustainable, fully-integrable commerce and <strong class="slate-bold">delivery management</strong>  suite. We strive to simplify their operations, helping them focus on their core business and scale effortlessly. We&apos;re committed to driving innovation in retail, leading with <strong class="slate-bold">sustainability</strong>.</p><p class="slate-p " ></p><h2 class="slate-h2 " >What is nShift Go?</h2><p class="slate-p " >Elevate your platform with our tailor-made end-to-end <strong class="slate-bold">delivery management</strong> solution, designed for <strong class="slate-bold">seamless integration</strong> and revenue growth. <strong class="slate-bold">Built to be</strong> <strong class="slate-bold">built in</strong>.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">One platform for global deliveries with the <strong class="slate-bold">largest compliant carrier library </strong>in the world.</div></li><li class="slate-li " ><div style="position:relative">Serves shippers <strong class="slate-bold">of all sizes</strong>.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tailored eCOM modules</strong> to drive top line revenue and end customer satisfaction (checkout, post-purchase, returns).</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Holistic solution that combines products</strong> and share modules. We are connecting products/stages (checkout to returns) in one company.</div></li></ul><p class="slate-p " ></p>

nShift Go is a comprehensive shipping solution, crafted to simplify the operations of e-commerce retailers by automating your workflows and unifying all your shipping tasks on one platform. We bridge online merchants to an extensive range of international shipping services and delivery choices from 

. In collaboration with our partner carriers, we offer integrations with more than 

, Warehouse Management Systems (WMS), and marketplaces.

Our user-friendly REST API allows you to oversee all your shipping requirements, eliminating the need to grapple with the intricacies of various carrier APIs and protocols. We take care of the challenging aspects, enabling you to concentrate on delivering an exceptional shipping experience to your customers at the most competitive rates.

Every feature of nShift Go can be utilized independently or synergistically to incorporate robust shipping capabilities into your application or service.

Our mission is to empower European retailers with a sustainable, fully-integrable commerce and 

  suite. We strive to simplify their operations, helping them focus on their core business and scale effortlessly. We're committed to driving innovation in retail, leading with 

Elevate your platform with our tailor-made end-to-end 

<p class="slate-p " ><a href="https://docs.nshiftgo.com/accounts" target="_top"><strong class="slate-bold">Account management</strong></a></p><p class="slate-p " >Complete self-service onboarding with a simple configuration to seamlessly onboard and create customer accounts.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><a href="https://docs.nshiftgo.com/carriers" target="_top"><strong class="slate-bold">Carrier management</strong></a></p><p class="slate-p " >Carrier data service provides metadata about carriers, services, carrier rates, and related data that can be consumed by other services.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><a href="https://docs.nshiftgo.com/delivery-options" target="_top"><strong class="slate-bold">Delivery options</strong></a></p><p class="slate-p " >The user to create delivery options based on zone and rule definitions and generate shipping quotes based on consumer choices in your checkout.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><a href="https://docs.nshiftgo.com/shipments" target="_top"><strong class="slate-bold">Shipment booking</strong></a></p><p class="slate-p " >Utilize a unified system to orchestrate the booking of shipments using the worlds largest carrier library.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><a href="https://docs.nshiftgo.com/orders" target=""><strong class="slate-bold">Order management (coming soon)</strong></a></p><p class="slate-p " >Import orders directly from your platform and fulfill them into shipment bookings based on the order details.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><a href="https://docs.nshiftgo.com/print" target=""><strong class="slate-bold">Label printing (coming soon)</strong></a></p><p class="slate-p " >Stable and reliable print service. Configure printer profiles according to what type of printers in use or what type of documents to print.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Complete self-service onboarding with a simple configuration to seamlessly onboard and create customer accounts.

Carrier data service provides metadata about carriers, services, carrier rates, and related data that can be consumed by other services.

The user to create delivery options based on zone and rule definitions and generate shipping quotes based on consumer choices in your checkout.

Utilize a unified system to orchestrate the booking of shipments using the worlds largest carrier library.

Import orders directly from your platform and fulfill them into shipment bookings based on the order details.

Stable and reliable print service. Configure printer profiles according to what type of printers in use or what type of documents to print.

<p class="slate-p " >Signup and subscription models is managed using Stripe, for more details regarding Stripe please visit <a href="https://stripe.com/en-se/billing/features#subscription-management" target="_top">https://stripe.com/en-se/billing/features#subscription-management</a>.</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">You will receive a link from us for a <strong class="slate-bold">onboarding page</strong> displaying a subscription.
If you have a prenegotiated model you will receive a unique link instead of our standard link.</div></li><li class="slate-li " ><div style="position:relative">Once you access the onboarding page you will see the available subscriptions and the pricing.</div></li><li class="slate-li " ><div style="position:relative">Select a subscription and provide the needed information to finish the process.</div></li><li class="slate-li " ><div style="position:relative">Once completed, you will find your unique client ID and client Secret (Save these credentials securely).</div></li></ol><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/4328fa46-b3a6-49d5-9e85-8a0c8895ce5a.jpg" style="
              width:888px;
	            height:473px;
	            aspect-ratio:888 / 473"
         /></div><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=error ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.08366 9.9801C9.25033 9.9801 9.39269 9.92107 9.51074 9.80302C9.6288 9.68496 9.68783 9.53566 9.68783 9.3551V5.31344C9.68783 5.14677 9.62533 5.00441 9.50033 4.88635C9.37533 4.7683 9.22949 4.70927 9.06283 4.70927C8.88227 4.70927 8.73296 4.7683 8.61491 4.88635C8.49685 5.00441 8.43783 5.15371 8.43783 5.33427V9.37594C8.43783 9.5426 8.50033 9.68496 8.62533 9.80302C8.75033 9.92107 8.9031 9.9801 9.08366 9.9801ZM9.00033 13.1676C9.19477 13.1676 9.35796 13.1016 9.48991 12.9697C9.62185 12.8377 9.68783 12.6745 9.68783 12.4801C9.68783 12.2857 9.62185 12.1225 9.48991 11.9905C9.35796 11.8586 9.19477 11.7926 9.00033 11.7926C8.80588 11.7926 8.64269 11.8586 8.51074 11.9905C8.3788 12.1225 8.31283 12.2857 8.31283 12.4801C8.31283 12.6745 8.3788 12.8377 8.51074 12.9697C8.64269 13.1016 8.80588 13.1676 9.00033 13.1676ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C10.9448 16.0843 12.6114 15.3898 14.0003 14.0009C15.3892 12.612 16.0837 10.9454 16.0837 9.00094C16.0837 7.05649 15.3892 5.38982 14.0003 4.00094C12.6114 2.61205 10.9448 1.9176 9.00033 1.9176C7.05588 1.9176 5.38921 2.61205 4.00033 4.00094C2.61144 5.38982 1.91699 7.05649 1.91699 9.00094C1.91699 10.9454 2.61144 12.612 4.00033 14.0009C5.38921 15.3898 7.05588 16.0843 9.00033 16.0843Z" fill="#E90005"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">IMPORTANT: </strong>Remember to store your Client ID and Client Secret in a secure manner. These cannot be regenerated.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Signup and subscription models is managed using Stripe, for more details regarding Stripe please visit 

<div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >If you&apos;re a partner you have to <a href="https://docs.nshiftgo.com/getting-started/signup" target="_top">sign up as an nShift Go partner</a> before you can start onboarding customers.</p></div></div><p class="slate-p " >If you are new to REST APIs then have a look at our <a href="https://docs.nshiftgo.com/getting-started/rest-api-guideline" target="_top">REST API Guidelines</a> to get a good starting point. Below you will find some step-by-step <strong class="slate-bold">tutorials</strong> to get you started.</p><p class="slate-p " >As accounts, carrier configurations and shipment channels are prerequisites to booking shipments we recommend following the sections below in subsequent order.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h1 class="slate-h1 " ><strong class="slate-bold">Create accounts</strong></h1><p class="slate-p " >First you need to create an <strong class="slate-bold">account </strong>for your <a href="https://docs.nshiftgo.com/getting-started/terminology" target="_top">merchant</a>:</p><h3 class="slate-h3 " ><strong class="slate-bold">Step 1: Create account</strong></h3><p class="slate-p " ><a href="https://docs.nshiftgo.com/accounts/create-an-account" target="_top">Create account</a> using your <strong class="slate-bold">client ID</strong> and <strong class="slate-bold">client secret </strong>from the <a href="https://docs.nshiftgo.com/getting-started/signup" target="">signup</a> process.</p><p class="slate-p " >Authentification for accounts need to be verified through a base64 encoded string of <code class="slate-code">client_id:client_secret</code> following <a href="https://swagger.io/docs/specification/v3_0/authentication/" target="">OpenAPI&apos;s securitySchemes and basicAuth</a>, more info on the <a href="https://docs.nshiftgo.com/accounts" target="">Accounts page</a>.</p><h3 class="slate-h3 " ><strong class="slate-bold">Step 2: Issue Token</strong></h3><p class="slate-p " >The <strong class="slate-bold">account ID</strong> received is used as <code class="slate-code">sub</code> using the <a href="https://docs.nshiftgo.com/accounts/issue-a-token-for-an-account" target="_top">Issue Token endpoint</a>.</p><p class="slate-p " ><strong class="slate-bold">Grant type</strong> is always set to “<strong class="slate-bold">client_credentials</strong>”.</p><h3 class="slate-h3 " ><strong class="slate-bold">Step 3: Receive Bearer token</strong></h3><p class="slate-p " >Token returned is used as <strong class="slate-bold">Bearer token</strong> (expiration time 4 h) in subsequent requests to other endpoints.</p><p class="slate-p " >For each account you will need to do some initial configurations.</p><p class="slate-p " >As a partner, you create at least one account for each of your clients to ensure data isolation. Once an account ID is obtained, it can be used to issue an access token for further API interactions. The account ID should be considered a secret between the partner and nShift and should not be exposed to your clients.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h1 class="slate-h1 " ><strong class="slate-bold">Setup carrier configuration</strong></h1><p class="slate-p " >In order to create shipments you need to add carriers to the account in question through carrier configurations. </p><h3 class="slate-h3 " >Step 1: API Endpoint</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Endpoint</strong>: <strong class="slate-bold">POST /v0/carrier-configurations</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Base URL</strong>: <a href="https://api.nshiftgo.com/" target="_blank"><strong class="slate-bold">https://api.nshiftgo.com</strong></a></div></li></ul><h3 class="slate-h3 " >Step 2: Request Body</h3><p class="slate-p " >The request body must include the necessary details for the carrier configuration. Below is an example of the required and optional fields:</p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">{
  "carrierId": "your-uuid-for-carrier",
  "name": "DHL Home Delivery",
  "serialDefinition": [
    {
      "level": "SHIPMENT",
      "recycle": {
        "afterDays": 30,
        "enabled": true,
        "expires": "2023-12-31T23:59:59Z",
        "group": "your-group",
        "iterations": 5
      },
      "start": "start-date",
      "stop": "stop-date",
      "type": "your-type"
    }
  ],
  "service": {
    "id": "your-uuid-for-service",
    "addons": [
      {
        "code": "DLVIN",
        "info": [
          {
            "key": "mobile",
            "value": "+467012367890"
          }
        ]
      }
    ]
  },
  "settings": [
    {
      "key": "api-key",
      "value": "your-api-key"
    }
  ]
} </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><h3 class="slate-h3 " >Step 3: Authentication Header</h3><p class="slate-p " >Add the following header for authentication:</p><p class="slate-p " ><span style="color:rgb(56, 67, 91)"><code class="slate-code">Authorization: Bearer {token}</code></span></p><p class="slate-p " >Replace <strong class="slate-bold">{token}</strong> with your actual bearer token.</p><h3 class="slate-h3 " >Step 4: Content Type</h3><p class="slate-p " >Ensure the <strong class="slate-bold">Content-Type</strong> header is set to <strong class="slate-bold">application/json</strong> to indicate the MIME type of the request body.</p><h3 class="slate-h3 " >Step 5: Request</h3><p class="slate-p " >Using a tool like cURL, Postman, or any HTTP client library in your programming language, send the POST request constructed in the previous steps to the server.</p><h3 class="slate-h3 " >Step 6: Response</h3><p class="slate-p " >A successful request will return HTTP status <strong class="slate-bold">201 Created</strong> with a JSON response containing the <strong class="slate-bold">id</strong> of the newly created carrier configuration. Handle other HTTP status codes (like <strong class="slate-bold">400 Bad Request</strong>) appropriately based on the API documentation.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h1 class="slate-h1 " ><strong class="slate-bold">Setup shipment channel</strong></h1><p class="slate-p " >Once you have configured the carrier you have to setup a shipment channel containing information about how shipment bookings are processed.
Configuring a shipment channel involves setting up parameters that dictate how shipments are processed, including document rendering settings and unit measurements.</p><h3 class="slate-h3 " ><strong class="slate-bold">Create a New Shipment Channel</strong></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Endpoint:</strong> <strong class="slate-bold">POST </strong><a href="https://api.nshiftgo.com/shipments/channels" target="_blank"><strong class="slate-bold">https://api.nshiftgo.com/shipments/channels</strong></a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Content Type:</strong> <strong class="slate-bold">application/json</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Required Headers: Authorization: Bearer {token} </strong>(optional)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Request Body:</strong></div></li></ul><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">{
       "name": "Channel 1",
       "documentRendering": {
         "enabled": true,
         "settings": [
           {
             "contentType": "zpl",
             "documentType": "NODFL",
             "enabled": true,
             "mediaType": "laser-1a5",
             "offsetX": 0,
             "offsetY": 0,
             "options": {
               "mode": "DT"
             }
           }
         ]
       },
       "units": {
         "dimensions": "cm",
         "volume": "cm3",
         "weight": "kg"
       }
     } </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><h3 class="slate-h3 " ><strong class="slate-bold">Update an Existing Shipment Channel</strong></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Endpoint:</strong> <strong class="slate-bold">PUT </strong><a href="https://api.nshiftgo.com/shipments/channels/%7BchannelId%7D" target="_blank"><strong class="slate-bold">https://api.nshiftgo.com/shipments/channels/{channelId}</strong></a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Content Type:</strong> <strong class="slate-bold">application/json</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Required Path Parameter: channelId</strong> (UUID of the Shipment Channel)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Required Headers: Authorization: Bearer {token}</strong> (optional)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Request Body:</strong> Similar to the creation, but include the <strong class="slate-bold">channelId</strong> in the path and modify the settings as necessary.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Fetch Existing Shipment Channel</strong></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Endpoint:</strong> <strong class="slate-bold">GET </strong><a href="https://api.nshiftgo.com/shipments/channels/%7BchannelId%7D" target="_blank"><strong class="slate-bold">https://api.nshiftgo.com/shipments/channels/{channelId}</strong></a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Content Type:</strong> <strong class="slate-bold">application/json</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Required Path Parameter: channelId</strong> (UUID of the Shipment Channel)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Required Headers: Authorization: Bearer {token}</strong> (optional)</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">Retrieve All Shipment Channels</strong></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Endpoint:</strong> <strong class="slate-bold">GET </strong><a href="https://api.nshiftgo.com/shipments/channels" target="_blank"><strong class="slate-bold">https://api.nshiftgo.com/shipments/channels</strong></a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Content Type:</strong> <strong class="slate-bold">application/json</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Query Parameters:</strong> (optional)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">page</strong>: The page number of results.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">size</strong>: Number of items per page.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Required Headers: Authorization: Bearer {token}</strong> (optional)</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h1 class="slate-h1 " ><strong class="slate-bold">Prepare shipment booking</strong></h1><p class="slate-p " >Once you have configured the shipment channel you can start booking shipments.</p><h3 class="slate-h3 " >Step 1: Required Data</h3><p class="slate-p " >Before making a request to create a shipment booking, ensure you have the following information ready:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Shipment Channel</strong>: You need the unique identifier of the Shipment Channel.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Carrier Configuration</strong>: Details like the carrier code, carrier ID, and specific configurations for the carrier.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Parcel Information</strong>: Details about the parcels including dimensions, weight, and any specific parcel items.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Addresses and Parties</strong>: Information about parties involved such as sender, receiver, and any other relevant parties.</div></li></ul><h3 class="slate-h3 " >Step 2: Request Body</h3><p class="slate-p " >Create a JSON/ object that includes all necessary details. Here is a general structure based on the requirements:</p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">{
  "parties": [
    {
      // Details about each party involved  
    }
  ],
  "shipmentChannel": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851"  // Example UUID for Shipment Channel
  },
  "carrierConfiguration": {
    "carrierCode": "DHL",
    "carrierId": "uuid-of-carrier",
    "id": "bb5afd39-f289-4fc4-a14b-5ee89502799c",  // Example UUID for Carrier Configuration
    "name": "DHL Home Delivery",
    "service": {
      // Additional service details
    }
  },
  "parcels": [
    {
      "id": "uuid-of-existing-parcel",  // Optional
      "items": [
        {
          "product": {
            "description": "This is a product description",
            "isPhysical": true,
            "location": "location-of-product",
            "sku": "product-sku",
            "weight": 10.5,
            "weightUnit": "G"
          },
          "quantity": 2
        }
      ]
    }
  ]
} </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><h3 class="slate-h3 " >Step 3: API Request</h3><p class="slate-p " >Send a POST request to the endpoint that handles shipment booking:</p><p class="slate-p " ><code class="slate-code">POST </code><a href="https://api.nshiftgo.com/shipment-booking" target="_self"><code class="slate-code">https://api.nshiftgo.com/shipment-booking</code></a></p><p class="slate-p " >Include the JSON body you&apos;ve constructed in the request. Ensure that the <strong class="slate-bold">Content-Type</strong> header of your request is set to <strong class="slate-bold">application/json</strong>.</p><h3 class="slate-h3 " >Step 4: Response</h3><p class="slate-p " >The API will respond with details of the created shipment booking. Handle the response/ accordingly based on your application&apos;s logic. If successful, the response should contain information about the booked shipment, including any identifiers and status information.</p><h3 class="slate-h3 " >Step 5: Errors</h3><p class="slate-p " >Always check the response for possible errors. Handle any errors by checking the status code and the error message returned by the API. This will help in troubleshooting issues like validation errors or server problems.</p><h3 class="slate-h3 " >Example CURL Command</h3><p class="slate-p " >Here is an example CURL command to create a shipment booking:</p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">curl -X POST https://api.nshiftgo.com/shipment-booking -H "Content-Type: application/json" -d '{
"parties": [...],
"shipmentChannel": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851"},
"carrierConfiguration": {...},
"parcels": [...]
}' </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><p class="slate-p " >Replace the placeholders and property values with actual data as per your requirements.</p><p class="slate-p " ></p><p class="slate-p " ></p>

If you are new to REST APIs then have a look at our 

 to get a good starting point. Below you will find some step-by-step 

As accounts, carrier configurations and shipment channels are prerequisites to booking shipments we recommend following the sections below in subsequent order.