Getting Started
Welcome to nShift!
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.
We reduce the complexity of shipping with one API connection that gives access to a thousand carriers.
API
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.
Read more about the the guidelines we follow when implementing our API.
Mission
Our mission is to empower European retailers with a sustainable, fully-integrable commerce and delivery management 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 sustainability.
What is nShift Go?
Elevate your platform with our tailor-made end-to-end delivery management solution, designed for seamless integration and revenue growth. Built to be built in.
- One platform for global deliveries with the largest compliant carrier library in the world.
- Serves shippers of all sizes.
- Tailored eCOM modules to drive top line revenue and end customer satisfaction (checkout, post-purchase, returns).
- Holistic solution that combines products and share modules. We are connecting products/stages (checkout to returns) in one company.
Accounts
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.
Authentication for accounts need to be verified through a base64 encoded string of client_id:client_secret following OpenAPI's securitySchemes and basicAuth.
"securitySchemes" : {
"basicAuth" : {
"description" : "Basic Authentication, `base64(client_id:secret)`",
"scheme" : "basic",
"type" : "http"
},
"bearerToken" : {
"bearerFormat" : "Bearer <token>",
"description" : "Use the `/authorize` endpoint to get a token.",
"scheme" : "bearer",
"type" : "http"
}
} Base URL
Production:
https://api.nshiftgo.com
Addresses
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. This way you only need to keep track of their identifiers when you want to use them.
Carriers
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.
Carrier Definitions
Before creating a shipment booking or delivery option you will need to create a carrier definition. This will contain carrier specific information such as credentials and service parameters.
Documents
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.
Parcels
Parcels are a level lower than shipments and contain information about packing types, item descriptions and options for dangerous goods handling.
What made this section unhelpful for you?
Create Parcel
Creates a new Parcel in the system with the provided specifications.
Header Parameters
Body Parameters
Show child attributes
Show child attributes
Show child attributes
The reference of the parcel
Response
Response Attributes
The unique identifier of the resource.
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}What made this section unhelpful for you?
Update Parcel
Updates an existing Parcel using their unique identifier parcel-id.
Header Parameters
Path Parameters
Body Parameters
Show child attributes
Show child attributes
Show child attributes
The reference of the parcel
Response
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
No ContentWhat made this section unhelpful for you?
Delete Parcel
Removes an existing Parcel using their unique identifier parcel-id.
Header Parameters
Path Parameters
Response
Response Attributes
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
No contentWhat made this section unhelpful for you?
Fetch Parcel
Fetch a specific Parcel using their unique identifier parcel-id.
Header Parameters
Path Parameters
Response
Response Attributes
The date and time when the Parcel was created.
Optional, the unique UUID value pointing to an existing parcel
Show child attributes
Show child attributes
Show child attributes
The reference of the parcel
The date and time when the Parcel was last updated.
Response Attributes
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
{
"createdAt": "2021-09-01T12:00:00+02:00",
"id": "",
"items": [
{
"createdAt": "2021-09-01T12:00:00+02:00",
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"isReturnable": true,
"meta": [
""
],
"pricing": {
"countryOfOrigin": "US",
"currency": "USD",
"discountType": "PERCENTAGE",
"discountValue": 10.5,
"discountedUnitPrice": 10.5,
"tariffNumber": "12345678901234",
"unitPrice": 10.5,
"vatPercent": 10.5
},
"product": {
"description": "This is a product description",
"isPhysical": true,
"location": "",
"sku": "5678-678",
"weight": 10.5,
"weightUnit": "G"
},
"quantity": 2,
"reference": "",
"updatedAt": "2021-09-01T12:00:00+02:00"
}
],
"meta": [
""
],
"packing": {
"dimensionsUnit": "M",
"height": 10,
"length": 10,
"markings": [
""
],
"pallet": {
"group": "",
"type": "EPAL-1"
},
"type": "box",
"volume": 10,
"volumeUnit": "CM3",
"weight": 10,
"weightUnit": "G",
"width": 10
},
"reference": "123e4567-e89b-12d3-a456-426614174000",
"serial": "",
"updatedAt": "2021-09-01T12:00:00+02:00"
}What made this section unhelpful for you?
List Parcels
Retrieves a paginated list of all Parcels associated with the authenticated account.
Header Parameters
Query Parameters
Response
Response Attributes
Show child attributes
The next cursor to be used for the next page.
Response Attributes
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
{
"items": [
{
"createdAt": "2021-09-01T12:00:00+02:00",
"id": "",
"items": [
{
"createdAt": "2021-09-01T12:00:00+02:00",
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"isReturnable": true,
"meta": [
""
],
"pricing": {
"countryOfOrigin": "US",
"currency": "USD",
"discountType": "PERCENTAGE",
"discountValue": 10.5,
"discountedUnitPrice": 10.5,
"tariffNumber": "12345678901234",
"unitPrice": 10.5,
"vatPercent": 10.5
},
"product": {
"description": "This is a product description",
"isPhysical": true,
"location": "",
"sku": "5678-678",
"weight": 10.5,
"weightUnit": "G"
},
"quantity": 2,
"reference": "",
"updatedAt": "2021-09-01T12:00:00+02:00"
}
],
"meta": [
""
],
"packing": {
"dimensionsUnit": "M",
"height": 10,
"length": 10,
"markings": [
""
],
"pallet": {
"group": "",
"type": "EPAL-1"
},
"type": "box",
"volume": 10,
"volumeUnit": "CM3",
"weight": 10,
"weightUnit": "G",
"width": 10
},
"reference": "123e4567-e89b-12d3-a456-426614174000",
"serial": "",
"updatedAt": "2021-09-01T12:00:00+02:00"
}
],
"nextCursor": "12345678-1234-1234-1234-123456789012"
}What made this section unhelpful for you?
Create Parcel Item
Creates a new Parcel Item in the system with the provided specifications.
Header Parameters
Body Parameters
Defaults to false
Show child attributes
Show child attributes
Show child attributes
The quantity of the Parcel item content
Response
Response Attributes
The unique identifier of the resource.
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}What made this section unhelpful for you?
Update Parcel Item
Modifies an existing Parcel Item using their unique identifier itemId.
Header Parameters
Path Parameters
Body Parameters
Defaults to false
Show child attributes
Show child attributes
Show child attributes
The quantity of the Parcel item content
Response
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
No ContentWhat made this section unhelpful for you?
Delete Parcel Item
Remove an existing parcel Item using their unique identifier item-id.
Header Parameters
Path Parameters
Response
Response Attributes
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
No contentWhat made this section unhelpful for you?
Fetch Parcel Item
Fetch a specific Parcel Item using their unique identifier item-id.
Header Parameters
Path Parameters
Response
Response Attributes
The date and time when the Parcel Item was created.
The unique identifier of the Parcel content
Defaults to false
Show child attributes
Show child attributes
Show child attributes
The quantity of the Parcel item content
The date and time when the Parcel Item was last updated.
Response Attributes
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
{
"createdAt": "2021-09-01T12:00:00+02:00",
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"isReturnable": true,
"meta": [
""
],
"pricing": {
"countryOfOrigin": "US",
"currency": "USD",
"discountType": "PERCENTAGE",
"discountValue": 10.5,
"discountedUnitPrice": 10.5,
"tariffNumber": "12345678901234",
"unitPrice": 10.5,
"vatPercent": 10.5
},
"product": {
"description": "This is a product description",
"isPhysical": true,
"location": "",
"sku": "5678-678",
"weight": 10.5,
"weightUnit": "G"
},
"quantity": 2,
"reference": "",
"updatedAt": "2021-09-01T12:00:00+02:00"
}What made this section unhelpful for you?
List Parcel Items
Retrieves a paginated list of all Parcel Items associated with the authenticated account.
Header Parameters
Query Parameters
Response
Response Attributes
Show child attributes
The next cursor to be used for the next page.
Response Attributes
Response Attributes
The type of error
Response Attributes
The type of error
Response Attributes
What made this section unhelpful for you?
Response
{
"items": [
{
"createdAt": "2021-09-01T12:00:00+02:00",
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"isReturnable": true,
"meta": [
""
],
"pricing": {
"countryOfOrigin": "US",
"currency": "USD",
"discountType": "PERCENTAGE",
"discountValue": 10.5,
"discountedUnitPrice": 10.5,
"tariffNumber": "12345678901234",
"unitPrice": 10.5,
"vatPercent": 10.5
},
"product": {
"description": "This is a product description",
"isPhysical": true,
"location": "",
"sku": "5678-678",
"weight": 10.5,
"weightUnit": "G"
},
"quantity": 2,
"reference": "",
"updatedAt": "2021-09-01T12:00:00+02:00"
}
],
"nextCursor": "12345678-1234-1234-1234-123456789012"
}What made this section unhelpful for you?
PUDO Points
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
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.
Base URL
Production:
https://api.nshiftgo.com
Shipment Channels
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.
Shipment Bookings
Shipment bookings contains information about everything associated with the delivery including addresses, carrier service codes, parcel information, customs declaration etc.
Service Definitions
Service definitions are pre-configured settings for services, which allows you to quickly refer and use services from carriers without configuring parameters each call.