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>Welcome to nShift! </h2>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 over 1,000 carriers throughout Europe. In collaboration with our partner carriers, we offer inte

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 

Accounts should be created for each individual merchant. This is also the only data isolation layer we have, meaning if you need to separate activity between e.g. stores or warehouses etc. and manage access you need to setup as many accounts as you require.Each account will hold it's own data including settings, personal information etc. and you will need to issue individual access tokens per account.

An address provides a standardized data model used by our different services. This means that an address will appear the same whether it's used in an order or shipment booking. However, providing specific roles to addresses will limit them to the extent they can be used or by what processes they are used. Roles can also be composites of other roles.You can create as many addresses as you need and store them for later usage.

Before creating a shipment booking or delivery option you will need to create a carrier configuration. This will contain carrier specific information such as credentials and service parameters.

Data about all supported carriers and their services can be fetched so that integrating becomes easier and changes implemented in carrier connectivity can be reflected directly in your integration. Necessary data that can be retrieved includes codes, valid routes, validation rules etc.

Delivery options are user configurable objects that connect carrier configurations and conditions that return prices and are used to create shipping quotes. Delivery options are intended to be used from a checkout where the consumer is able to make choices around the delivery.

Documents are generated by shipment bookings such as labels, waybills, invoices etc. In addition, a user is able to uploade their own documents as attachments to orders or additional customs documents that can be used if the carrier supports paperless customs handling.

Events are propagated throughout the system whenever an object changes. These events can be channeled to a webhook by setting up an event channel and defining the topics of interest that the channel should intercept.An example event channel for the <code>shipment_booking_event</code> topic would return the following to webhooks:<div></div>

Parcels are a level lower than shipments and contain information about packing types, item descriptions and options for dangerous goods handling.

Some carrier services use PUDO points where the consumer picks up or drops off parcels. These endpoints allow you to find PUDO points based on the consumer address information.

Shipping quotes are generated from delivery options. Once the delivery options are configured you can evaluate them and the system will automatically generate relevant shipping quotes. The quotes will only persist for 24 hours after which they are removed from our system.

Shipment bookings contains information about everything associated with the delivery including addresses, carrier service codes, parcel information, customs declaration etc. Before you start creating shipments you need to create a shipment channel that contains configurations for shipment processing e.g. how generated documents are rendered.