nshiftone

Introduction

Sign-Up

Authentication

Data Types and Formats

Order - PUSH API

Store orders consolidated

Individual data submission

PULL API

Additional parameters can be used for filtering. Date time format: yyyy-MM-ddTHH:mm:ssZ

Get return summaries

Get return orders created or updated before or after given date and time. Format: yyyy-MM-ddTHH:mm:ssZ

Get return orders

Get return order by return order id

Process Returns

Create/Process/Update Return

Update Order

Update return order refund status by return order id

Update order item information by order external id

Default

Returns

Production

Sandbox

Default Server URL

<div class="slate-div"><p class="slate-p " ><p class="slate-p " >Welcome to the <strong class="slate-bold">nShift Returns API</strong> documentation. This guide will help you integrate with nShift Returns. </p><p class="slate-p " >The Returns API allows you to automate and control the full returns lifecycle - from creating return requests to monitoring their status and outcomes. With the API, you can streamline returns operations, reduce manual handling, and keep your systems in sync with real-time return data.</p><p class="slate-p " >In this documentation, you’ll learn how to authenticate, make API requests, create and manage returns.
</p><h2 class="slate-h2 " ><span class="slate-color" style="background-color:rgb(255, 255, 255);color:rgb(22, 22, 22)">Using the API</span></h2><div class="card-box without-icon" style="width:60%;"><div ><h3 class="slate-h3 " >Swagger specification </h3><p class="slate-p " >We provide HTTP endpoints with Swagger documentation, available for both Production and Staging.</p><p class="slate-p " ><a href="https://new-prod.returnado.com/public-api/swagger-ui/index.html#/" target="_blank"><strong class="slate-bold">Production</strong></a>| <a href="https://staging.returnado.com/public-api/swagger-ui/index.html#/" target="_blank"><strong class="slate-bold">Staging</strong></a></p></div></div></p><h2 class="slate-h2 " ><span class="slate-color" style="background-color:rgb(255, 255, 255);color:rgb(22, 22, 22)">Environments </span></h2><p class="slate-p " >We provide a Staging an Production environment.</p><p class="slate-p " >The nShift Returns API is organized around REST and designed to integrate seamlessly with your existing systems.</p><p class="slate-p " >All endpoints are accessible only via HTTPS.</p><h2 class="slate-h2 " ><span class="slate-color" style="background-color:rgb(255, 255, 255);color:rgb(22, 22, 22)">Documentation</span></h2><p class="slate-p " >This technical documentation is intended for developers. For user guides and instructions on how to configure and use the product, see the <a href="https://helpcenter.nshift.com/hc/en-us/categories/7668450105244-Returns" target="_new">nShift Help Center – Returns</a>.</p><p class="slate-p " ></p></div><p class="slate-p " ></p>

<p class="slate-p slate-indent-0" style="0px">To start using nShift Returns, submit a request through <a href="https://nshift.com/contact-sales#topForm" target="_blank">our contact form</a>. A member of the nShift team will get in touch with you to guide you through the next steps.</p><p class="slate-p " >Once your account has been set up, you will receive access to the <strong class="slate-bold">nShift Returns Portal</strong>, where you can configure and manage your returns.</p>

To start using nShift Returns, submit a request through 

. A member of the nShift team will get in touch with you to guide you through the next steps.

Once your account has been set up, you will receive access to the 

, where you can configure and manage your returns.

<p class="slate-p " >Authenication in nShift Returns uses <strong class="slate-bold">Basic Authentication </strong>using a username and password. You create and manage your API keys in the nShift Returns admin. Multiple API keys can be created as needed, making it easy to separate access across environments or integrations</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >Important: Keep API-keys confidential. Never embed them in client-side code.</p></div></div><h2 class="slate-h2 " >Generate API-keys</h2><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 " >Log into nShift Returns Admin</h3><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Go to Settings → Credentials → Create Credentials </h3><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Enter a username → Create</h3><p class="slate-p " >The username needs to be unique within your account. </p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Credentials created</h3><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(51, 51, 51)">A password will be created for you. Please make sure to copy and save it, as you will not be able to see or retrieve it again. You will be able to click </span><span style="background-color:rgb(255, 255, 255);color:rgb(51, 51, 51)"><strong class="slate-bold">Close </strong></span><span style="background-color:rgb(255, 255, 255);color:rgb(51, 51, 51)">after you have copied the password.</span></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >5</h6><h3 class="slate-h3 " >Overview</h3><p class="slate-p " >You will now see the user on the list. You can create as many users as you need. If you forget a user&apos;s password, you can simply delete that user and create a new one. </p></div></div></div><h2 class="slate-h2 " >Delete keys </h2><p class="slate-p " >In addition to creating API keys, you can also delete them from this view. Please note that deleted keys are permanently removed and cannot be recovered.</p><h2 class="slate-h2 " >Using the API-key</h2><p class="slate-p " >Authentication credentials are sent with every request and are validated by the server. If the credentials are missing or invalid, the API will respond with a <code class="slate-code">401 Unauthorized</code> status code.
</p>

using a username and password. You create and manage your API keys in the nShift Returns admin. Multiple API keys can be created as needed, making it easy to separate access across environments or integrations

In addition to creating API keys, you can also delete them from this view. Please note that deleted keys are permanently removed and cannot be recovered.

Authentication credentials are sent with every request and are validated by the server. If the credentials are missing or invalid, the API will respond with a 

<p class="slate-p " >If not specified in the different services, refer to this table</p><h3 class="slate-h3 " ><strong class="slate-bold">Date &amp; Time</strong></h3><p class="slate-p " >Timestamps use <strong class="slate-bold">ISO 8601 extended format.</strong></p><p class="slate-p " >Example<strong class="slate-bold">: </strong><code class="slate-code">202x-xx-xxT00:00:00Z</code></p><h3 class="slate-h3 " ><strong class="slate-bold">Locale </strong></h3><p class="slate-p " >Locales should be formatted as <strong class="slate-bold">IETF BCP 47 language tags</strong> = ISO-639 language code + ISO-3166-1 alpha-2 country code (e.g. <code class="slate-code">en-US</code>, <code class="slate-code">fr-FR</code>, <code class="slate-code">ja-JP</code>).</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</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">"locale": "sv-SE", </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><h3 class="slate-h3 " ><strong class="slate-bold">Country </strong></h3><p class="slate-p " >Country code = <strong class="slate-bold">Standard ISO-3166-1 alpha-2</strong> (e.g. <code class="slate-code">US</code>, <code class="slate-code">FR</code>, <code class="slate-code">JP</code>).</p><h3 class="slate-h3 " ><strong class="slate-bold">Currency Code</strong></h3><p class="slate-p " >We use the Standard ISO-4217 standard for defining currencies. </p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</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">"currency": "SEK", </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><h3 class="slate-h3 " ><strong class="slate-bold">Amount </strong></h3><p class="slate-p " >Numeric value represented as a <strong class="slate-bold">decimal number</strong>.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</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">"amount": 8.5 </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

If not specified in the different services, refer to this table

 = ISO-639 language code + ISO-3166-1 alpha-2 country code (e.g. 

We use the Standard ISO-4217 standard for defining currencies. 

<p class="slate-p " >Our Order endpoints are used to push order data towards our API. </p><p class="slate-p " >We support the following methods: </p><h4 class="slate-h4 " >Consolidated Data Submission</h4><p class="slate-p " >With the <strong class="slate-bold">Store Orders Consolidated</strong> option, all related data such as customers, products, and orders is submitted in a single request. This method is our recommended approach. </p><h4 class="slate-h4 " >Individual Data Submission</h4><p class="slate-p " >Alternatively, data can be submitted through separate endpoints:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Store orders </div></li><li class="slate-li " ><div style="position:relative">Store customers </div></li><li class="slate-li " ><div style="position:relative">Store products </div></li></ul><p class="slate-p " >Orders act as the connecting element, linking products to their respective customers.</p><p class="slate-p " >Choose the submission method that best fits your workflow and integration needs.</p><p class="slate-p " ></p>

Our Order endpoints are used to push order data towards our API. 

 option, all related data such as customers, products, and orders is submitted in a single request. This method is our recommended approach. 

Alternatively, data can be submitted through separate endpoints:

Orders act as the connecting element, linking products to their respective customers.

Choose the submission method that best fits your workflow and integration needs.

<p class="slate-p " >Our Pull API is used to <strong class="slate-bold">retrieve return data</strong> from nShift Returns.</p><p class="slate-p " >We support the following methods:</p><h4 class="slate-h4 " >Get return summaries</h4><p class="slate-p " >Returns a list of summarized return data for a given period.</p><h4 class="slate-h4 " >Get returns</h4><p class="slate-p " >Returns complete return orders within a date range.</p><h4 class="slate-h4 " >Get return order by return order id</h4><p class="slate-p " >Returns detailed information about a single return order.</p><p class="slate-p " >Choose the method that best fits your workflow. </p><p class="slate-p " ></p>

Returns a list of summarized return data for a given period.

Returns complete return orders within a date range.

Returns detailed information about a single return order.

Choose the method that best fits your workflow. 

<p class="slate-p " >The Returns section of our API allows users to retrieve information related to returns processed within our warehouse management system. With this section, users can access data on returned items, reasons for return, and status updates, enabling them to efficiently manage returns and track their progress.</p><p class="slate-p " ></p>

The Returns section of our API allows users to retrieve information related to returns processed within our warehouse management system. With this section, users can access data on returned items, reasons for return, and status updates, enabling them to efficiently manage returns and track their progress.

Sections