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 renewed 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

Lists all existing Addresses stored on the account.

List Addresses

Carriers

Fetch Carrier

Fetch a specific carrier service by `serviceId`.

Fetch Carrier Service

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

List Carriers

List all available services for a specific `carrierId`. For route-specific validation information, specify `routeFrom` and `routeTo`.

List Carrier Services

List all available services. For route-specific validation information, specify `routeFrom` and `routeTo`.

List Services

This endpoint is used to send a request to fetch new data regarding the settings. The version parameter is optional and can be used to specify the version of the data to fetch. If no version is specified, the latest data will be fetched.

Fetch Data Request

Carrier Definitions

This endpoint creates a new Carrier Definition, with needed information to use a specific Carrier, on your account.

Create Carrier Definition

This endpoint updates an existing Carrier Definition on your account.

Update Carrier Definition

This endpoint deletes an existing Carrier Definition on your account.

Delete Carrier Definition

This endpoint will fetch an existing Carrier Definition on your account.

Fetch Carrier Definition

This endpoint will list all the existing Carrier Definitions on your account.

List Carrier Definitions

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 (coming soon)

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 (coming soon)

Create Event Channel

Update Event Channel

Delete Event Channel

Fetch Event Channel

List Event Channels

Mock endpoint for generating events. This endpoint is used for testing purposes.

Create Mock Events

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.

Remove 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

Remove Order Channel

Fetch Order Channel

List Order Channels

Fetch Order Channel Type

List Order Channel Types

Parcels

Creates a new Parcel in the system with the provided specifications.

Create Parcel

Modifies an existing Parcel identified by its unique ID with the provided data.

Update Parcel

Removes a Parcel from the system based on its unique identifier.

Delete Parcel

Retrieves a specific Parcel by its unique identifier.

Fetch Parcel

Retrieves a paginated list of all Parcels associated with the authenticated account.

List Parcels

Creates a new Parcel Item in the system with the provided specifications.

Create Parcel Item

Modifies an existing Parcel Item identified by its unique ID with the provided data.

Update Parcel Item

Removes a Parcel Item from the system based on its unique identifier.

Delete Parcel Item

Retrieves a specific Parcel Item by its unique identifier.

Fetch Parcel Item

Retrieves a paginated list of all Parcel Items associated with the authenticated 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

Lists all existing Shipping Quotes stored on the account,

List Shipping Quotes

Shipment Channels

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

List all existing Shipment Channels stored on the account.

List Shipment Channels

Shipment Bookings

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

Fetch an existing Shipment Booking by using its unique identifier.

Fetch Shipment Booking

Lists all existing Shipment Bookings stored on the account.

List Shipment Bookings

Service Definitions

This endpoint creates a new Service Definition, with needed information to use a specific Service, on your account.

Create Service Definition

This endpoint updates an existing Service Definition on your account.

Update Service Definition

This endpoint deletes an existing Service Definition on your account.

Delete Service Definition

This endpoint will fetch an existing Service Definition on your account.

Fetch Service Definition

This endpoint will list all the existing Service Definitions on your account.

List Service Definitions

Using this endpoint allows you to retrieve a list of serial numbers based on the carrier configuration ID.

List Serial Numbers

Default

nShift Go API

nShift Go Documentation

Production

<h2 class="slate-h2 " >Welcome to nShift! </h2><p class="slate-p " >nShift Go API is an API-first, cloud native and fully headless platform which allows e-commerce platforms and online B2C marketplaces to integrate shipping as a part of their own offering. </p><p class="slate-p " >We reduce the complexity of shipping with one API connection that gives access to a thousand carriers.</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><p class="slate-p " ></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>

Sections