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 <strong class="slate-bold">Get return summaries</strong> endpoint provides a lightweight way to retrieve return activity within a specific period. It returns records that include order and customer identifiers, product references, returned quantities, refund values, reason codes, and the current processing state. Because it focuses on summarized data, this endpoint is well suited for reporting, tracking return trends, or monitoring activity without pulling full order details. Filtering is done with <code class="slate-code">periodStart</code>, <code class="slate-code">periodEnd</code>, and optionally by <code class="slate-code">marketCode</code>, and results can be paginated with <code class="slate-code">pageSize</code> and <code class="slate-code">pageNumber</code>.</p><p class="slate-p " ></p><p class="slate-p " ></p>

 endpoint provides a lightweight way to retrieve return activity within a specific period. It returns records that include order and customer identifiers, product references, returned quantities, refund values, reason codes, and the current processing state. Because it focuses on summarized data, this endpoint is well suited for reporting, tracking return trends, or monitoring activity without pulling full order details. Filtering is done with 

Authorization

periodStart

periodEnd

The market code associated with the return.

marketCode

The number of items per page for pagination.

pageSize

pageNumber

records

The total number of return summaries available.

totalRecords

Information related to the pagination of the return summaries.

pagination

<p class="slate-p " >The <strong class="slate-bold">Get returns</strong> endpoint delivers complete return order data. It allows filtering by creation or update date ranges using <code class="slate-code">createdAfter</code>, <code class="slate-code">createdBefore</code>, <code class="slate-code">updatedAfter</code>, and <code class="slate-code">updatedBefore</code>. The response includes everything related to a return order: identifiers, status, totals for amounts and fees, detailed line items with refund values and reasons, reconversion items for exchanges, applied fees, and shipment and tracking information. </p>

 endpoint delivers complete return order data. It allows filtering by creation or update date ranges using 

. The response includes everything related to a return order: identifiers, status, totals for amounts and fees, detailed line items with refund values and reasons, reconversion items for exchanges, applied fees, and shipment and tracking information. 

Header parameter for authorization purposes.

Filters return orders updated after the specified date and time.

updatedAfter

Filters return orders updated before the specified date and time.

updatedBefore

Filters return orders created after the specified date and time.

createdAfter

Filters return orders created before the specified date and time.

createdBefore

returnOrderId

External identifier for the return order.

returnOrderExtId

Unique identifier for the original order associated with the return order.

orderId

Alternative external identifier for the return order.

alternativeExternalId

Date and time when the return order was created.

createdAt

Indicates the date and time when the return order was last updated.

updated

Unique identifier for the shop associated with the return order.

shopId

Identifies the customer who initiated the return order.

customerId

status

Currency used for the financial transactions related to the return order.

currency

netOriginalTotal

taxOriginalTotal

Represents the original total gross amount of the order.

grossOriginalTotal

Original shipping fee associated with the order.

grossOriginalShippingFee

refundableGrossShippingCost

Total amount of net refund processed for the return order.

netRefundTotal

Total tax refund amount processed for the return order.

taxRefundTotal

Total gross refund amount processed for the return order.

grossRefundTotal

Total net fees associated with the return order.

netFeesTotal

Total tax fees associated with the return order.

taxFeesTotal

Represents the total gross fees associated with the return order.

grossFeesTotal

The tracking number associated with the return order.

trackingNumber

items

Items that are being reconverted in the return order.

reconversionItems

The fees associated with the return order.

fees

Details of the shipments associated with the return order.

shipments

<p class="slate-p " >This endpoint retrieves detailed information about a single return order by its unique <code class="slate-code">returnOrderId</code>. The response includes the main return order data such as identifiers, status, totals, and customer reference, along with item details, fees, and shipment information. Use this endpoint when you need the full return order object for a specific case.</p><p class="slate-p " ></p>

This endpoint retrieves detailed information about a single return order by its unique 

. The response includes the main return order data such as identifiers, status, totals, and customer reference, along with item details, fees, and shipment information. Use this endpoint when you need the full return order object for a specific case.

The authorization header for accessing the API.

The external identifier associated with the return order.

The unique identifier of the original order linked to the return order.

An alternative external identifier for the return order.

The date and time when the return order was created.

Indicates whether the return order information has been updated.

The unique identifier of the shop associated with the return order.

The unique identifier of the customer associated with the return order.

The current status of the return order (e.g., processing, completed).

The currency used for the monetary values in the return order.

The total amount of original net order value.

The total amount of original taxes associated with the order.

The total amount of the original gross order value.

The total amount of the original gross shipping fee.

The gross shipping cost eligible for refund.

The total amount of net refund after deducting fees and taxes.

The total amount of tax refund associated with the return order.

The total amount of gross refund including fees and taxes.

The total amount of net fees incurred in the return order.

The total amount of tax fees incurred in the return order.

The total amount of gross fees associated with the return order.

The tracking number associated with the return order shipment.

Items included in the reconversion process of the return order.

Information regarding the shipments associated with the return order.

<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

Ask an AI

Code with AI