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

<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 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 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 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.

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 " >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.

The return information for the order item.

returns

The authorization token for accessing the API.

Authorization

Indicates any errors encountered in the response.

Sections