nshiftone

This is the options request API of the nShift Checkout

Getting Started

Documentation Overview

Glossary

Data Types and Formats

Basic Flow 

Authentication

Create Client ID 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 Name or Email

Split Shipment

Create Session: Split Shipment

Update Session: Split Shipment

Fetch Delivery Options: Split Shipment

Create Partial Shipments: Split Shipment

Own Pickup Locations API

Widget

Senders

Create Sender

Update Sender

Delete Sender

Fetch Sender

Fetch Senders

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

Metrics

Default

Checkout Production

Production

nShift Checkout

Options API

Shipments API

Configuration API

Sandbox

<h2 class="slate-h2 " >Welcome to nShift Checkout!</h2><p class="slate-p " >nShift Checkout integrates flexible delivery options into your ecommerce experience to lift conversion, reduce friction, and streamline fulfillment. Give consumers the delivery options they want and watch cart abandonment drop. </p><p class="slate-p slate-indent-0" style="0px">This is technical documentation intended for developers. For user guides on configuring the product, adding shipping options, adjusting prices, and related topics, please refer to our <a href="https://helpcenter.nshift.com/hc/en-us/sections/10499214778780-nShift-Checkout-New" target="_blank">Help Center</a>.</p><p class="slate-p " >An active nShift Checkout agreement is required to access the functionality described in this documentation. The availability of features depends on your subscription plan.</p><p class="slate-p slate-indent-0" style="0px">If you do not have an nShift Checkout agreement and would like to learn more, please <a href="https://nshift.com/products/checkout#form-footer" target="_blank">request a demo</a> or contact your sales representative.</p><p class="slate-p slate-indent-0-1-1" style="NaNpx"></p><p class="slate-p " ></p>

nShift Checkout integrates flexible delivery options into your ecommerce experience to lift conversion, reduce friction, and streamline fulfillment. Give consumers the delivery options they want and watch cart abandonment drop. 

This is technical documentation intended for developers. For user guides on configuring the product, adding shipping options, adjusting prices, and related topics, please refer to our 

An active nShift Checkout agreement is required to access the functionality described in this documentation. The availability of features depends on your subscription plan.

If you do not have an nShift Checkout agreement and would like to learn more, please 

<p class="slate-p " >Below is an overview of the basic integration flow, outlining the key steps to follow when working with the nShift Checkout API.</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 Client ID and Secret</h3><p class="slate-p " >Generate a Client ID and Client Secret in the nShift Portal, or ask your administrator to provide you with a set. These credentials are required for authentication.</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 " >Use your Client ID and Client Secret to issue an access token. This token is required to create a session and access all nShift Checkout features.</p><p class="slate-p " >Tokens are valid for <strong class="slate-bold">1 hour</strong>. After expiration, you must re-authenticate to obtain a new one.</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 " >Use your access token and a Connection ID to create a session. A session is required to access nShift Checkout features.</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 " >Once a session is created, you can fetch available delivery options. Ensure that you include all required body parameters, including any parameters used within a configuration&apos;s rule engine.</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 " >After the consumer selects a delivery option and completes the purchase, create a partial shipment. <strong class="slate-bold">Note:</strong> Creating a partial shipment is <strong class="slate-bold">mandatory</strong>, and it ensures full compatibility with all existing and future nShift Checkout features.</p><p class="slate-p " ><a href="6759543121c5f7e0c0f32444/6759546028b8b17a0e087336" target="">Follow this guide</a></p><p class="slate-p " ></p></div></div></div><div style="width:60%;
	min-width:60%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >If you need to implement split shipment logic, please refer to our <a href="6939765641b7b1957812111d" target="_blank">dedicated Split Shipment endpoints</a> for full details.</p></div></div><p class="slate-p " ></p>

Below is an overview of the basic integration flow, outlining the key steps to follow when working with the nShift Checkout API.

<p class="slate-p " ><p class="slate-p " >This section describes how to create the <a href="6759495f21c5f7e0c0f2ef0b/67595dfe88ff6fb4a62d6a89" target="">Client ID and Client Secret</a>, which are required to <a href="6759495f21c5f7e0c0f2ef0b/67595c2b28b8b17a0e09f6b8" target="">generate an access token</a>.</p></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >This section describes how to <a href="6759458a21c5f7e0c0f2e59f/6759496628b8b17a0e0829ea" target="">create a session</a> and <a href="6759458a21c5f7e0c0f2e59f/6759492388ff6fb4a62b5d64" target="">fetch delivery options</a> within that session.</p></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >If you need to implement split shipment logic, please refer to our <a href="6939765641b7b1957812111d" target="_blank">dedicated Split Shipment endpoints</a> for full details.</p></div></div><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >This section describes all endpoints related to partial shipments. <a href="6759543121c5f7e0c0f32444/6759546028b8b17a0e087336" target="">Creating a partial shipment</a> is <strong class="slate-bold">mandatory</strong>, while the use of the other endpoints is optional.</p></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >Once an order in the webshop has converted, create a partial shipment. You can then use this data to create the actual shipment in your shipping solution.</p><p class="slate-p " ><p class="slate-p " >nShift shipping solutions (sometimes also refferred to as “book &amp; print platforms&quot;): Delivery, Ship and Transsmart.</p></p><p class="slate-p " ><strong class="slate-bold">Note:</strong> Creating a partial shipment is <strong class="slate-bold">mandatory</strong>, and it ensures full compatibility with all existing and future nShift Checkout features.</p><p class="slate-p " >In the Sender used in your checkout configuration, add the API credentials for your shipping solution account. When you use this endpoint to create a partial shipment, it will be created in the linked shipping solution account and will also appear in the Shipment log in the nShift Checkout UI.</p><p class="slate-p " >
<span style="background-color:rgb(255, 255, 255);color:rgba(20, 23, 25, 0.84)"><strong class="slate-bold">Please note:</strong></span><span style="background-color:rgb(255, 255, 255);color:rgba(20, 23, 25, 0.84)"> Creating the actual shipment (complete booking and printing labels) from the partial shipment requires further actions within your shipping solution.</span></p><p class="slate-p " >For historical reasons the term partial shipment might not be consistent across the different shipping solutions, cf Prepared Shipment in Delivery/Transsmart and Store Order in Ship.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Delivery:</strong> <a href="https://helpcenter.nshift.com/hc/en-us/articles/7553024469404-Prepared-shipments#h_01GR45W3H5S87CB2SQXBWS2CFZ" target="_blank">Link to nShift Help Center article on &quot;Prepared Shipments&quot;</a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Ship:</strong> <a href="https://helpcenter.nshift.com/hc/en-us/articles/360021335919-Using-StoreOrder-to-save-orders-for-import#h_01F5B6Z23AANM3WX52XMFK1EE6" target="_blank">Link to nShift Help Center article on &quot;Using StoreOrder to Save Orders for Import&quot;</a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Transsmart:</strong> <a href="https://helpcenter.nshift.com/hc/en-us/articles/23945629942300-Create-update-and-book-prepared-shipments" target="_blank">Link to nShift Help Center article on &quot;Prepared Shipments&quot;</a></div></li></ul></p>

orderId

sessionId

optionId

Mandatory if the chosen delivery option is a pickup point

pickupPointId

timeSlotId

receiver

addons

fields

packages

Set to False to only get back Id and OrderId. Set to True to get the full details of the created shipment back (similar to GET shipment).

extended-result

Set to True if the shipment should be created in the connected Book&Print platform

send-to-book-and-print

organizationId

organizationUnitId

memberAccountId

carrier

carrierProduct

carrierProductVersion

created

sender

pickupPoint

type

status

detail

issues

<p class="slate-p " ><p class="slate-p " >To delete a shipment stored in nShift Checkout. Note: It is not possible to delete a shipment in your Book&amp;Print platform using this method.</p></p>

shipmentId

<p class="slate-p " ><p class="slate-p " >Fetch a shipment information stored in NShift Checkout.</p></p>

<p class="slate-p " ><p class="slate-p " >Fetch all your shipments stored in NShift Checkout. You can filter the list by passing in parameters.</p></p>

order-id

member-account-id

filter

locale

sorting

page

rows

result

pageSize

pageCount

totalCount

message

location

parseState

rootCause

resourceDescription

anonymizeSender

anonymizeReceiver

sender-name

sender-email

receiver-name

receiver-email

<p class="slate-p " >Split shipment support in nShift Checkout is enabled exclusively through the dedicated split shipment API endpoints described in this section.  There are no configuration flags or UI settings that turn this feature on or off. Because of this, any checkout configuration, connection, group, or experiment can be used for split shipment scenarios, as long as the integration uses the correct endpoints.</p><p class="slate-p " >Merchants that support both split shipment and non-split shipment scenarios can rely exclusively on the split shipment endpoints. The split shipment API fully supports single shipment, however, the opposite is <strong class="slate-bold">not</strong> supported:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Split shipment endpoints → can handle both single and multiple sub-shipments. </div></li><li class="slate-li " ><div style="position:relative">Regular single-shipment endpoints → cannot be used for split shipment scenarios. </div></li></ul><p class="slate-p " >For this reason, integrators who anticipate using split shipments at any point are recommended to implement only the split shipment endpoints to cover all use cases with one unified flow.
</p><p class="slate-p " ></p><h2 class="slate-h2 " >Integration Flow - Split Shipment Endpoints</h2><p class="slate-p " >From an integration perspective, the split shipment flow follows the same overall pattern as a standard single-shipment Checkout integration, but uses dedicated split shipment endpoints to manage multiple shipments within a single order. The key difference is that you work with multiple sub-shipments instead of one shipment. At a high level, the flow looks like this:</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 " >Issue an Access Token</h3><p class="slate-p " ><a href="6759495f21c5f7e0c0f2ef0b" target="_blank"><em class="slate-italic">Follow this guide.</em></a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Create a Session</h3><p class="slate-p " ><em class="slate-italic">POST /options/v1/split-shipments/sessions/{checkoutConnectionId}</em></p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgba(20, 23, 25, 0.84)">Use your access token and a Connection ID to create a session using the </span>split shipment session creation endpoint and include the list of subShipments. If needed the Session can be updated, via <em class="slate-italic">PUT /split-shipments/sessions/{sessionId}</em>, for example if there is a need to add or remove subShipments based on changes in the cart.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Fetch Delivery Options</h3><p class="slate-p " ><em class="slate-italic">POST /options/v1/split-shipments/shipping-options/{sessionId}</em></p><p class="slate-p " >Retrieve available delivery options for each sub-shipment. Each sub-shipment may return different options depending on rules, carriers, or configuration.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Create Partial Shipments</h3><p class="slate-p " ><em class="slate-italic">POST /shipments/v1/split-shipments/shipments</em></p><p class="slate-p " >Once the consumer has selected delivery options for each sub-shipment, create the corresponding partial shipments.</p></div></div></div><p class="slate-p " ></p><h3 class="slate-h3 " >subShipment Objects</h3><p class="slate-p " >The split shipment endpoints accept a list of <em class="slate-italic">subShipment</em> objects, each representing one shipment that together form a single checkout session. <strong class="slate-bold">It is the webshop integration’s responsibility to determine how the items in the cart should be divided into sub-shipments.</strong></p><p class="slate-p " >Sub-shipments should only be created when <em class="slate-italic">different shipping options are expected or required</em> between parts of the same order.</p><p class="slate-p " >Warehouse packaging logic does <u class="slate-underline">not</u> determine whether split shipment is needed. For example: A carrier may only allow one physical package per shipment. A customer ordering three large items may therefore result in three physical shipments handled by the carrier. However, if all items can be shipped using the same shipping option, then the checkout should not use split shipment.</p><p class="slate-p " ></p>

Split shipment support in nShift Checkout is enabled exclusively through the dedicated split shipment API endpoints described in this section.  There are no configuration flags or UI settings that turn this feature on or off. Because of this, any checkout configuration, connection, group, or experiment can be used for split shipment scenarios, as long as the integration uses the correct endpoints.

Merchants that support both split shipment and non-split shipment scenarios can rely exclusively on the split shipment endpoints. The split shipment API fully supports single shipment, however, the opposite is 

For this reason, integrators who anticipate using split shipments at any point are recommended to implement only the split shipment endpoints to cover all use cases with one unified flow.


Integration Flow - Split Shipment Endpoints

From an integration perspective, the split shipment flow follows the same overall pattern as a standard single-shipment Checkout integration, but uses dedicated split shipment endpoints to manage multiple shipments within a single order. The key difference is that you work with multiple sub-shipments instead of one shipment. At a high level, the flow looks like this:

The split shipment endpoints accept a list of 

 objects, each representing one shipment that together form a single checkout session. 

It is the webshop integration’s responsibility to determine how the items in the cart should be divided into sub-shipments.

Sub-shipments should only be created when 

different shipping options are expected or required

 determine whether split shipment is needed. For example: A carrier may only allow one physical package per shipment. A customer ordering three large items may therefore result in three physical shipments handled by the carrier. However, if all items can be shipped using the same shipping option, then the checkout should not use split shipment.

<p class="slate-p " ></p><p class="slate-p " >If you want to offer own pickup locations in Checkout, such as stores, warehouses, or other merchant-managed locations used for Click &amp; Collect, the pickup locations can either be maintained via the user interface in nShift Portal or by using our dedicated Own Pickup Locations API.</p><p class="slate-p " >Full details of the Own Pickup Locations API can be found <a href="https://app.theneo.io/nshiftone/own-pickup-locations/getting-started" target="_blank"><strong class="slate-bold">here</strong></a>.</p><p class="slate-p " ></p>

If you want to offer own pickup locations in Checkout, such as stores, warehouses, or other merchant-managed locations used for Click & Collect, the pickup locations can either be maintained via the user interface in nShift Portal or by using our dedicated Own Pickup Locations API.

Full details of the Own Pickup Locations API can be found 

<p class="slate-p " >The nShift Checkout Widget offers a convenient way to display shipping options directly in webshops, without requiring ongoing updates when new delivery features are introduced. Using the widget is completely optional - merchants can also choose a fully headless integration if they prefer full control. The widget can be styled and customized using CSS to match your site’s design.</p><p class="slate-p " ></p><div style="width:60%;
	min-width:60%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >All widget configuration and implementation instructions are documented in our Help Center.</p><p class="slate-p " ><a href="https://helpcenter.nshift.com/hc/en-us/sections/13706000163740-Widget" target="_blank"><strong class="slate-bold">Click here</strong></a><strong class="slate-bold"> </strong>to view the widget documentation.</p></div></div><p class="slate-p " ></p><div style="text-align:left"><figure ><div style="display:inline-block"><img src="https://d24lr4zqs1tgqh.cloudfront.net/760781b6-01c7-4906-ac54-c2e2ea135eeb.jpg" alt="" style="
              width:547px;
	            height:523px;
	            aspect-ratio:547 / 523"
         /></div></figure></div><p class="slate-p " ></p>

The nShift Checkout Widget offers a convenient way to display shipping options directly in webshops, without requiring ongoing updates when new delivery features are introduced. Using the widget is completely optional - merchants can also choose a fully headless integration if they prefer full control. The widget can be styled and customized using CSS to match your site’s design.

<p class="slate-p " ><p class="slate-p " ><p class="slate-p " ><p class="slate-p " >This section describes all Senders endpoints that can be used to create, update, and manage Senders via the API. </p></p><p class="slate-p " ><strong class="slate-bold">Note:</strong> Senders can also be managed through the nShift Checkout UI. Use of these endpoints is optional.</p></p></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >This section describes all Configuration endpoints that can be used to create, update, and manage configurations via the API.</p><p class="slate-p " ><p class="slate-p " ><strong class="slate-bold">Note:</strong> Configurations can also be managed through the nShift Checkout UI. Use of these endpoints is optional.</p></p></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >This section describes all Connection endpoints that can be used to create, update, and manage Connections via the API. Connections are used as a reference towards a Configuration or a Group (and/or an Experiment) to be used. This allows users to change the set-up without having to modify their integration towards nShift Checkout.</p><p class="slate-p " ><strong class="slate-bold">Note:</strong> Connections can also be managed through the nShift Checkout UI. Use of these endpoints is optional.</p><p class="slate-p " ></p></p><p class="slate-p " ></p>

<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"><figure ><div style="display:inline-block"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/39e11178-f297-436d-8577-3c24a1ea6542.png" alt="" style="
              width:1080px;
	            height:160px;
	            aspect-ratio:1080 / 160"
         /></div></figure></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"

Sections

Ask an AI

Code with AI