nshiftone

Getting started

Introduction

Data Types and Formats

Authentication

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

<p class="slate-p " ><h2 class="slate-h2 " ><span style="background-color:rgb(255, 255, 255);color:rgb(22, 22, 22)">Welcome to nShift!</span></h2></p><h2 class="slate-h2 " ><span 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><h2 class="slate-h2 " ><span style="background-color:rgb(255, 255, 255);color:rgb(22, 22, 22)">API Specification </span></h2><p class="slate-p " >We provide HTTP endpoints with Swagger documentation, available for both Production and Staging</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><a href="https://new-prod.returnado.com/public-api/swagger-ui/index.html#/" target="_new"><strong class="slate-bold">Production Swagger</strong></a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://staging.returnado.com/public-api/swagger-ui/index.html#/" target="_new"><strong class="slate-bold">Staging Swagger</strong></a></div></li></ul><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 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>

We provide a Staging an Production environment.

We provide HTTP endpoints with Swagger documentation, available for both Production and Staging

The nShift Returns API is organized around REST and designed to integrate seamlessly with your existing systems.

All endpoints are accessible only via HTTPS.

This technical documentation is intended for developers. For user guides and instructions on how to configure and use the product, see the 

<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 " ><p class="slate-p " >To access the <strong class="slate-bold">nShift Returns APIs</strong>, you need an API credential. Authentication uses <strong class="slate-bold">Basic Authentication</strong>, which requires a username and a password.</p><p class="slate-p " ></p><p class="slate-p " >If you don&apos;t have an API key, you can generate one by following this guide: <a href="https://helpcenter.nshift.com/hc/en-us/articles/22490207752348-Creating-API-keys" target=""><em class="slate-italic">Generate API-keys</em></a></p></p>

<p class="slate-p " >Our PUSH API is 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><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 method that best fits your workflow! </p><p class="slate-p " ></p>

Our PUSH API is 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. 

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

Choose the method that best fits your workflow! 

<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