nshiftgo

Getting started

Sign-up

Onboarding

Key concepts

REST API guidelines

Authentication

Accounts

Creates a new Account.
Creates an isolated data context for an Account.
Returns the `accountId`, which is used to issue Access Tokens and associate related data.
**Note:** Clients must create at least one Account before creating any other resources via the API.
The `accountId` is **confidential** and must not be shared. It is used to issue Access Tokens for API access.

Create Account

Issues an Access Token for the specified Account.
Provide the `accountId` returned from the Create Account endpoint in the `sub` field.
Returns an Access Token valid for 4 hours.
**Note:** The token must be renewed by calling this endpoint again after expiration.

Issue Token for Account

Updates an existing Account. 
Provide the `accountId` returned from the Create Account endpoint, along with updated values such as contact person email, company name or address to reflect changes in your setup.

Update Account

Fetches an existing Account.
Provide the `accountId` returned from the Create Account endpoint.
Returns the Account configuration.

Fetch Account

Lists all Accounts configured on your Client Account.
Returns a list of Accounts including their identifiers and configuration details.

List Accounts

Addresses

Creates a new Address.
Stores address details that can be referenced in other entities such as Shipment Bookings. 
Returns the `addressId` for future use. 
**Note:** Roles such as `SENDER` and `RECEIVER` are not assigned when creating an Address. Instead, roles are specified when referencing the Address in a Shipment Booking, defining how it is used in that specific context (e.g., as `SENDER`, `RECEIVER`, or `SELLER`).
The meaning and behavior of roles may vary depending on the endpoint. For example, the `SELLER` role does not necessarily represent the actual sender in a Shipment Booking.
Before using this endpoint, create at least one Account via the Create Account endpoint.

Create Address

Updates an existing Address.
Provide the `addressId` returned from the Create Address endpoint, along with updated values such as contact person email, company name or street to reflect changes in your setup. 
**Note:** Changes may not affect previously processed entities such as Shipment Bookings.

Update Address

Deletes an existing Address.
Provide the `addressId` returned from the Create Address endpoint. Deletes the Address and all related references.
**Note:** Changes may not affect previously processed entities such as Shipment Bookings.

Delete Address

Fetches an existing Address.
Provide the `addressId` returned from the Create Address endpoint. 
Returns the Address configuration.
**Note:** Retrieved information reflects the most recently stored data.

Fetch Address

Lists all Addresses configured on your account.
Returns a list of Addresses including their identifiers and configuration details.

List Addresses

Carriers

Fetch Carrier

Fetches a specific Service.
Provide the `serviceId` returned from the List Carrier Services endpoint/List Services.
Returns the Service configuration."


Fetch Carrier Service

Lists all Carriers.
Provide `routeFrom` and `routeTo` for route-specific validation.
Returns a list of Carriers with basic information, including `carrierId`.
Use the `carrierId` to fetch additional Carrier and Service configurations.


List Carriers

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

List Carrier Services

Lists all Services.
Provide `routeFrom` and `routeTo` for route-specific validation.
Returns a list of Services with basic information, including serviceId.
Use the `serviceId` to fetch additional Service configurations.


List Services

List Serials

Carrier Setups

Creates a new Carrier Definition.
Provide details such as carrier code, service code, and add-ons to configure the Carrier Definition according to your needs. 
Returns the `carrier-definition-id` for future use.

Create Carrier Definition

Updates an existing Carrier Definition.
Provide the `carrier-definition-id` returned from the Create Carrier Definition endpoint, along with updated values such as carrier code, service code, and add-ons to reflect changes in your setup.

Update Carrier Definition

Deletes an existing Carrier Definition.
Provide the `carrier-definition-id` returned from the Create Carrier Definition endpoint.
Deletes the Carrier Definition configuration, including carrier code, service code, and add-ons. 

Delete Carrier Definition

Fetches an existing Carrier Definition.
Provide the `carrier-definition-id` returned from the Create Carrier Definition endpoint.
Returns the Carrier Definition configuration, including carrier code, service code, and add-ons.

Fetch Carrier Definition

Lists all Carrier Definitions configured on your account.
Returns a list of Carrier Definitions including their identifiers and configuration details.

List Carrier Definitions

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

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

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

Creates a new Service Definition. 
Provide details such as service code and add-ons to configure the Service Definition according to your needs.
Returns the `service-definition-id` for future use.

Create Service Definition

Updates an existing Service Definition.
Provide the `service-definition-id` returned from the Create Service Definition endpoint, along with updated values such as service code and add-ons to reflect changes in your setup.

Update Service Definition

Deletes an existing Service Definition.
Provide the `service-definition-id` returned from the Create Service Definition endpoint. 
Deletes the Service Definition configuration, including service code and add-ons.

Delete Service Definition

Fetches an existing Service Definition.
Provide the `service-definition-id` returned from the Create Service Definition endpoint. 
Returns the Service Definition configuration, including service code and add-ons.

Fetch Service Definition

Lists all Service Definitions configured on your account.
Returns a list of all Service Definitions including their identifiers and configuration details.

List Service Definitions

Lists service specific Serial Numbers.
Provide the `service-definition-id` returned from the Create Service Definition endpoint. 
Returns the generated Serial Numbers.

List Serial Numbers

Default

nShift Go API

nShift Go Documentation

Production

Sandbox

Test

<p class="slate-p " >nShift Go is a headless, API-first shipping platform designed to simplify delivery management for e-commerce platforms and marketplaces. With a single integration, you gain access to thousands of compliant carriers across Europe and beyond. </p><h2 class="slate-h2 " >Why nShift Go?</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Unified API for shipping, returns, and tracking</div></li><li class="slate-li " ><div style="position:relative">Access to the world’s largest carrier network</div></li><li class="slate-li " ><div style="position:relative">Modular architecture for flexible integration</div></li><li class="slate-li " ><div style="position:relative">Scales with merchants of all sizes</div></li><li class="slate-li " ><div style="position:relative">Built for seamless platform integration</div></li></ul><p class="slate-p " >Read more about 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 " >Process overview</h2><p class="slate-p " >Understand how each layer contributes to the end-to-end shipping experience—spanning from the end consumer to merchant actions, through your platform, and finally to nShift Go.</p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/269d57cb-e310-4b5d-a2ae-4f177ac5aab1.png" style="
              width:1403px;
	            height:1160px;
	            aspect-ratio:1403 / 1160"
         /></div><p class="slate-p " ></p>

nShift Go is a headless, API-first shipping platform designed to simplify delivery management for e-commerce platforms and marketplaces. With a single integration, you gain access to thousands of compliant carriers across Europe and beyond. 

Understand how each layer contributes to the end-to-end shipping experience—spanning from the end consumer to merchant actions, through your platform, and finally to nShift Go.

<p class="slate-p " >Accounts are the primary data isolation layer and must be created for each individual merchant. Use separate accounts to segment operations — for example, one for a store and another for a warehouse.</p><p class="slate-p " >Each account stores its own data — such as settings and personal information — and requires its own access token for API usage.</p><p class="slate-p " >When an account is created, it returns an <code class="slate-code">accountId</code>, which is required to issue access tokens and associate requests with the correct account.
Authentication is verified using a base64-encoded <code class="slate-code">client_id:client_secret</code>, following <a href="https://swagger.io/docs/specification/v3_0/authentication/" target="_blank">OpenAPI’s securitySchemes and basicAuth</a>.</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> The <span style="color:rgb(41, 42, 46)"><code class="slate-code">accountId</code></span> is <strong class="slate-bold">confidential</strong> and must not be shared.</p></div></div><p class="slate-p " >At least one account must be created before using any other endpoints in the API.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</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"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">&quot;securitySchemes&quot; : {
         &quot;basicAuth&quot; : {
            &quot;description&quot; : &quot;Basic Authentication, `base64(client_id:secret)`&quot;,
            &quot;scheme&quot; : &quot;basic&quot;,
            &quot;type&quot; : &quot;http&quot;
         },
         &quot;bearerToken&quot; : {
            &quot;bearerFormat&quot; : &quot;Bearer &lt;token&gt;&quot;,
            &quot;description&quot; : &quot;Use the `/authorize` endpoint to get a token.&quot;,
            &quot;scheme&quot; : &quot;bearer&quot;,
            &quot;type&quot; : &quot;http&quot;
         }
      }    </div></div></code></pre></div><p class="slate-p " ></p>

Accounts are the primary data isolation layer and must be created for each individual merchant. Use separate accounts to segment operations — for example, one for a store and another for a warehouse.

Each account stores its own data — such as settings and personal information — and requires its own access token for API usage.

When an account is created, it returns an 

, which is required to issue access tokens and associate requests with the correct account.
Authentication is verified using a base64-encoded 

At least one account must be created before using any other endpoints in the API.

<p class="slate-p " >Creates a new Account.
Creates an isolated data context for an Account.
Returns the <code class="slate-code">accountId</code>, which is used to issue Access Tokens and associate related data.
<strong class="slate-bold">Note:</strong> Clients must create at least one Account before creating any other resources via the API.
The <code class="slate-code">accountId</code> is <strong class="slate-bold">confidential</strong> and must not be shared. It is used to issue Access Tokens for API access.</p><p class="slate-p " ></p>

Creates a new Account.
Creates an isolated data context for an Account.
Returns the 

, which is used to issue Access Tokens and associate related data.


 Clients must create at least one Account before creating any other resources via the API.
The 

 and must not be shared. It is used to issue Access Tokens for API access.

company

contact

Authorization

detail

instance

properties

status

title

type

<p class="slate-p " >Issues an Access Token for the specified Account.
Provide the <code class="slate-code">accountId</code> returned from the Create Account endpoint in the <code class="slate-code">sub</code> field.
Returns an Access Token valid for 4 hours.
<strong class="slate-bold">Note:</strong> The token must be renewed by calling this endpoint again after expiration.</p><p class="slate-p " ></p>

Issues an Access Token for the specified Account.
Provide the 

 returned from the Create Account endpoint in the 

 field.
Returns an Access Token valid for 4 hours.


 The token must be renewed by calling this endpoint again after expiration.

grant_type

access_token

expires

token_type

<p class="slate-p " >Updates an existing Account.
Provide the <code class="slate-code">accountId</code> returned from the Create Account endpoint, along with updated values such as contact person email, company name or address to reflect changes in your setup.</p><p class="slate-p " ></p>

Updates an existing Account.
Provide the 

 returned from the Create Account endpoint, along with updated values such as contact person email, company name or address to reflect changes in your setup.

accountId

<p class="slate-p " >Fetches an existing Account.
Provide the <code class="slate-code">accountId</code> returned from the Create Account endpoint.
Returns the Account configuration.</p><p class="slate-p " ></p>

Fetches an existing Account.
Provide the 

 returned from the Create Account endpoint.
Returns the Account configuration.

createdAt

updatedAt

<p class="slate-p " >Lists all Accounts configured on your Client Account.
Returns a list of Accounts including their identifiers and configuration details.</p><p class="slate-p " ></p>

cursor

limit

sort

items

The next cursor to be used for the next page.

nextCursor

<p class="slate-p " >Addresses follow a standardized structure that can be referenced across the platform.
You can create and store multiple addresses for reuse.
Roles such as <code class="slate-code">sender</code> or <code class="slate-code">receiver</code> are assigned when the address is used, defining its purpose in the shipment flow.</p>

Addresses follow a standardized structure that can be referenced across the platform.
You can create and store multiple addresses for reuse.
Roles such as 

 are assigned when the address is used, defining its purpose in the shipment flow.

<p class="slate-p " >Carriers represent the available shipping providers supported by the platform.
Use these endpoints to retrieve service codes, route options, and validation rules — helping you build dynamic integrations and stay aligned with carrier requirements.</p>

Carriers represent the available shipping providers supported by the platform.
Use these endpoints to retrieve service codes, route options, and validation rules — helping you build dynamic integrations and stay aligned with carrier requirements.

<p class="slate-p " >Carrier Setups associate a specific carrier with an account.
They include credentials and service settings required to book shipments through that carrier.
Carrier Setups must be in place before shipment bookings can be created.</p><p class="slate-p " ></p>

Carrier Setups associate a specific carrier with an account.
They include credentials and service settings required to book shipments through that carrier.
Carrier Setups must be in place before shipment bookings can be created.

<p class="slate-p " >Documents are generated automatically as part of a shipment booking and may include labels, invoices, waybills, or customs forms.
You can also upload your own documents as attachments — such as customs documents — for carriers that support paperless handling.</p><p class="slate-p " ></p>

Documents are generated automatically as part of a shipment booking and may include labels, invoices, waybills, or customs forms.
You can also upload your own documents as attachments — such as customs documents — for carriers that support paperless handling.

<p class="slate-p " >Parcels describe the physical shipment and exist as a part of a shipment booking. They include packaging type, weight, volume, and item-level details.
Parcels can also include options for dangerous goods and customs declarations.</p><p class="slate-p " ></p>

Parcels describe the physical shipment and exist as a part of a shipment booking. They include packaging type, weight, volume, and item-level details.
Parcels can also include options for dangerous goods and customs declarations.

<p class="slate-p " >PUDO (pickup and drop-off) Points are used by carrier services that support deliveries to or from a designated service point. Use these endpoints to search for valid PUDO points based on the consumer’s location.</p><p class="slate-p " ></p>

PUDO (pickup and drop-off) Points are used by carrier services that support deliveries to or from a designated service point. Use these endpoints to search for valid PUDO points based on the consumer’s location.

<p class="slate-p " >Shipment Channels must be created before booking shipments.
They determine how shipments are handled — for example, how documents are rendered, which units are used, or what rules apply to routing.</p><p class="slate-p " ></p>

Shipment Channels must be created before booking shipments.
They determine how shipments are handled — for example, how documents are rendered, which units are used, or what rules apply to routing.

<p class="slate-p " >Shipment Bookings includes everything needed to dispatch a shipment: addresses, parcels, carrier setup, customs info, and print-ready documents.
This is the final step that initiates delivery with the selected carrier.</p><p class="slate-p " ></p>

Shipment Bookings includes everything needed to dispatch a shipment: addresses, parcels, carrier setup, customs info, and print-ready documents.
This is the final step that initiates delivery with the selected carrier.

<p class="slate-p " >Service Setups let you reuse predefined setups for interacting with a specific carrier service.
They reduce repetitive setup by allowing you to refer to the service by ID when booking shipments.</p><p class="slate-p " ></p>

Service Setups let you reuse predefined setups for interacting with a specific carrier service.
They reduce repetitive setup by allowing you to refer to the service by ID when booking shipments.

Sections