nshiftone

nShift One developer portal

This is the options request API of the nShift Checkout

Getting Started

Features

Signup

Terminology

Data Types and Formats

Basic Flow 

Authentication

Create ClientID and Secret

Issue Token

Delivery Options

Create Session

Fetch Delivery Options

Partial Shipments

Create Partial Shipment

Delete Partial Shipment

Fetch Partial Shipment

Fetch Partial Shipments

Anonymize Partial Shipment by Id

Anonymize Partial Shipment by Sender

Widget

Link the Widget files

Create widget on page

Widget Settings

Show Widget

Fill widget with shipping options

Metrics

Configurations

Create Configuration

Update Configuration

Delete Configuration

Fetch Configuration

Fetch Configurations

Fetch Configuration Status

Update Configuration Status

Fetch Configuration Versions

Connections

Create Connection

Update Connection

Delete Connection

Fetch Connection

Fetch Connections

Senders

Create Sender

Update Sender

Delete Sender

Fetch Sender

Fetch Senders

Condition Lists

Create Condition List

Delete Condition List

Fetch Condition List

Fetch Condition Lists

Default

Checkout Production

Production

Sandbox

<h2 class="slate-h2 " >Welcome to nShift!</h2><p class="slate-p slate-indent-0" style="0px">nShift Checkout seamlessly integrates with the leading ecommerce platforms and shopping carts, giving customers a better purchasing experience. With the world’s largest carrier and <a href="https://nshift.com/pudo-deliveries" target="_blank">PUDO</a> library, it’s easy to provide the delivery options customers want, increase conversions at checkout and reduce abandoned carts. </p><p class="slate-p slate-indent-0" style="0px">Our market-leading checkout solution includes the capability to truly personalize the Customer &amp; Delivery Experience using our intuitive and powerful Rules Engine.
</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 slate-indent-0" style="0px">Every feature of nShift Checkout can be utilized independently or synergistically to incorporate robust shipping capabilities into your application or service.</p><p class="slate-p slate-indent-0" style="0px"></p><h2 class="slate-h2 " >Documentation</h2><p class="slate-p slate-indent-0" style="0px">This is a technical documentation aimed at developers and user guides on how to configure the product, add shipping options, changes prices and so on can be found on our support pages.
<a href="https://helpcenter.nshift.com/hc/en-us/sections/10499214778780-nShift-Checkout-New" target="_self">https://helpcenter.nshift.com/hc/en-us/sections/10499214778780-nShift-Checkout-New</a></p><p class="slate-p slate-indent-0-1-1-1" style="NaNpx"></p><p class="slate-p " ></p>

nShift Checkout seamlessly integrates with the leading ecommerce platforms and shopping carts, giving customers a better purchasing experience. With the world’s largest carrier and 

 library, it’s easy to provide the delivery options customers want, increase conversions at checkout and reduce abandoned carts. 

Our market-leading checkout solution includes the capability to truly personalize the Customer & Delivery Experience using our intuitive and powerful Rules Engine.


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 Checkout can be utilized independently or synergistically to incorporate robust shipping capabilities into your application or service.

This is a technical documentation aimed at developers and user guides on how to configure the product, add shipping options, changes prices and so on can be found on our support pages.


<p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Get your ClientID and Secret</h3><p class="slate-p " >If not already done, you should generate a CliendID and Secret in nShiftPortal (or ask your administrator to provide you with a set).</p><p class="slate-p " ><a href="6759495f21c5f7e0c0f2ef0b/67595dfe88ff6fb4a62d6a89" target="">Follow this guide</a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Issue an Access Token</h3><p class="slate-p " >To issue a token you need your ClientID and Secret. It is used later to create a session and access all nShift Checkout features.</p><p class="slate-p " >A Token is valid 60 minutes before it expires and you have to re-authenticate.</p><p class="slate-p " ><a href="6759495f21c5f7e0c0f2ef0b/67595c2b28b8b17a0e09f6b8" target="">Follow this guide</a></p><h6 class="slate-h6 " ></h6></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Create a Session</h3><p class="slate-p " >To be able to create a session (and use all nShift Checkout features), you need to use an access token and a ConnectionID.</p><p class="slate-p " ><a href="6759495f21c5f7e0c0f2ef0b/6759496628b8b17a0e0829ea" target="">Follow this guide</a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Fetch Delivery Options</h3><p class="slate-p " >Using your session you can now fetch delivery options. Remember to fill in the body parameters needed by your condition rules (if any).</p><p class="slate-p " ><a href="6759458a21c5f7e0c0f2e59f/6759492388ff6fb4a62b5d64" target="">Follow this guide</a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >5</h6><h3 class="slate-h3 " >Create a Partial Shipment</h3><p class="slate-p " >When your customer has selected a Delivery Option and completed its purchase, it is time to create a Partial Shipment. </p><p class="slate-p " ><a href="6759543121c5f7e0c0f32444/6759546028b8b17a0e087336" target="">Follow this guide</a></p><p class="slate-p " ></p></div></div></div><p class="slate-p " >
</p><p class="slate-p " ></p>

<p class="slate-p " ></p><p class="slate-p " >Our widget provids a quick an easy way to get shipping options presented on your webpage, without needing to think about changes when new shipping related features comes.</p><p class="slate-p " ></p>

Our widget provids a quick an easy way to get shipping options presented on your webpage, without needing to think about changes when new shipping related features comes.

<p class="slate-p " ><p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">Get usage data between two dates. The dates are inclusive so setting the same start and end date will get information for one day.</p><p class="slate-p slate-indent-0" style="0px">Results are in a csv format. Easily opened in Excel, Numbers and Google Sheets or imported in other BI systems.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Results example</strong></p></p><p class="slate-p " ><p class="slate-p " ><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/39e11178-f297-436d-8577-3c24a1ea6542.png" style="
              width:1517px;
	            height:225px;
	            aspect-ratio:1517 / 225"
         /></div></p></p></p>

start-date

end-date

UUID. Used to filter on a experiment and get only experiment related data

experiment-id

Success

Media type: text/csv. 

Fields:
"Member Account ID",
"Session ID",
"Request ID",
"Connection ID",
"Group ID",
"Segmentation ID",
"Checkout ID",
"Checkout Version",
"Receiver Postal Code",
"Receiver Country Code",
"Language Code",
"Currency Code",
"Option ID",
"Option Name",
"Option Index",
"Source System",
"Carrier ID",
"Carrier Product ID",
"Created",
"Selected",
"Shipment Count",
"Total Request Price",
"Total Checkout Price",
"Total Addons Price",
"Total Full Price"

organizationId

organizationUnitId

memberAccountId

version

name

template

options

languageCodes

currencyCodes

currencyConfigs

currencyFreeShipping

variables

senderId

addons

fields

created

changed

active

features

rules

rulesPhase2StartIndex

deliveryTimeDisplay

deliveryTimeInterval

returnConfiguration

type

status

detail

issues

based-on

include-prices

only-valid-configuration

member-account-id

format

filter

locale

sorting

page

rows

message

location

parseState

rootCause

resourceDescription

result

pageSize

pageCount

totalCount

<p class="slate-p " ><p class="slate-p " >Connections are used as a reference towards a Configuration or a Group (and/or an Experiment) to be used. This allows the user to change the set-up without having to modify his integration towards NShift Checkout. </p><p class="slate-p " >You can manage your connections via the UI or programatically using services in this section.</p></p><p class="slate-p " ></p>

Sections