nshiftone

nShift One developer portal

Getting started

Authentication

Push API

General information

Individual data submission

Store orders consolidated

Update shipment status

Pull api and update order

Update return order refund status by return order id

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

Update Fulfillment date.

Update order item information by order external id

Default

Returns

Production

Sandbox

<h2 class="slate-h2 " >
Welcome to nShift!</h2>nShift return seamlessly integrates with the leading ecommerce platforms, giving customers a better return experience. With the world’s largest carrier and <a href="https://nshift.com/pudo-deliveries" target="_blank">PUDO</a> library, it’s easy to provide the delivery options customers want, increase customer statifaction and keep customers returning. 
<h2 class="slate-h2 " >API</h2>Our intuitive package return service simplifies the entire returns process, empowering consumers to effortlessly select the items they wish to return without the hassle of navigating complex carrier systems or protocols. By handling the technical complexities for you, we enable your business to focus on delivering a seamless and stress-free return experience for your customers, all while maintaining cost-efficiency.Every aspect of our package return service is designed to work independently or in harmony with your existing systems, allowing you to integrate powerful return management capabilities into your platform. Whether it’s streamlining label generation, tracking returns, or managing refunds, our solution ensures a smooth and customer-friendly experience that enhances satisfaction and builds loyalty. Let us handle the challenges of returns, so you can focus on keeping your customers happy and coming back for more.
<h2 class="slate-h2 " >Documentation</h2>This is a technical documentation aimed at developers and user guides on how to configure the product and use it can be found in this guide: 
<a href="https://helpcenter.nshift.com/hc/en-us/categories/7668450105244-Returns" target="_self">https://helpcenter.nshift.com/hc/en-us/categories/7668450105244-Returns</a>

nShift return seamlessly integrates with the leading ecommerce platforms, giving customers a better return experience. With the world’s largest carrier and 

 library, it’s easy to provide the delivery options customers want, increase customer statifaction and keep customers returning. 


Our intuitive package return service simplifies the entire returns process, empowering consumers to effortlessly select the items they wish to return without the hassle of navigating complex carrier systems or protocols. By handling the technical complexities for you, we enable your business to focus on delivering a seamless and stress-free return experience for your customers, all while maintaining cost-efficiency.

Every aspect of our package return service is designed to work independently or in harmony with your existing systems, allowing you to integrate powerful return management capabilities into your platform. Whether it’s streamlining label generation, tracking returns, or managing refunds, our solution ensures a smooth and customer-friendly experience that enhances satisfaction and builds loyalty. Let us handle the challenges of returns, so you can focus on keeping your customers happy and coming back for more.

This is a technical documentation aimed at developers and user guides on how to configure the product and use it can be found in this guide: 


All nShift Return api&apos;s uses Basic Authentication. 
The information required consists of the username and password for your organization (image showing the use-case from Postman below).<div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/c5695623-4184-4a14-9a97-eca064725f3e.jpg" style="
 width:430px;
	 height:220px;
	 aspect-ratio:430 / 220"
 /></div>

 uses Basic Authentication. 
The information required consists of the username and password for your organization (image showing the use-case from Postman below).

Having a single endpoint for pushing the entire structure ensures better data consistency, making it also easier for the customer to push the full payload, instead of performing separate calls for the required entities.The purpose of the endpoint is to push orders (including the customer and product data) that can then be further returned by customers in the Returns portal based on the return policy setup in the portal.

Having a single endpoint for pushing the entire structure ensures better data consistency, making it also easier for the customer to push the full payload, instead of performing separate calls for the required entities.

The purpose of the endpoint is to push orders (including the customer and product data) that can then be further returned by customers in the Returns portal based on the return policy setup in the portal.

The Returns section allows users to retrieve information related to returns within their account. Users can access details about return requests, status updates, and resolutions through this API section. By utilizing the Returns API, users can efficiently manage and track returns for improved customer service and operational efficiency.

The Returns section allows users to retrieve information related to returns within their account. Users can access details about return requests, status updates, and resolutions through this API section. By utilizing the Returns API, users can efficiently manage and track returns for improved customer service and operational efficiency.

The "Update return order refund status by return order id" section allows users to modify the refund status of a specific return order. By updating the refund status, users can track and manage the status of refunds associated with return orders efficiently. This functionality helps streamline the process of handling returns and refunds within the system.

Indicates whether the refund process was successful or not.

refundSucceeded

The unique identifier of the order associated with the return.

orderId

A code representing any errors encountered during the refund process.

errorCode

A description of any errors encountered during the refund process.

errorDescription

A token provided to authenticate the request.

Authorization

The unique identifier of the return order to update.

returnOrderId

The &quot;Get return summaries&quot; section allows users to retrieve summarized data related to returns, including information such as customer and order details, return quantities, refund values, and more. By filtering the data with additional parameters, users can gain insights into return trends and manage returns efficiently within their system.

The "Get return summaries" section allows users to retrieve summarized data related to returns, including information such as customer and order details, return quantities, refund values, and more. By filtering the data with additional parameters, users can gain insights into return trends and manage returns efficiently within their system.

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

The Returns section allows users to retrieve information about return orders based on specified date criteria. Users can access details such as the return order ID, order ID, status, and product information for efficient management of return processes.

The Returns section allows users to retrieve information about return orders based on specified date criteria. Users can access details such as the return order ID, order ID, status, and product information for efficient management of return processes.

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

External identifier for the return order.

returnOrderExtId

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

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

The "Get return order by return order id" section allows users to retrieve detailed information about a specific return order by providing its unique return order id. Users can access data such as order details, item information, fees, and shipment details related to the return order, facilitating efficient management and tracking of returns within the system.

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.

Sections