Returns Label Generation API
{return_reference_number}Authentication
The Return Creation API lets users start returns on the Narvar platform. It can also generate shipping labels for these returns, depending on the return details…
This API needs few key details about the order and return to work well. It mainly uses the order number to identify the specific order and return cart information to know about the items and why they’re being returned. The API can easily get customer details from the order info already on the platform. This order info can come from a custom Order Management System or directly from Narvar’s own order system.
If the return is initiated successfully, the API provides a link to view the shipping label, if one was generated. However, if there are any errors, particularly during label creation, the API will detail the error, aiding in troubleshooting.
Service Endpoints
- QA: ws-qa01.narvar.qa
- Staging: ws-st01.narvar.qa
- Production: ws.narvar.com
Authentication The REST API requests are sent over TLS and secured by HTTP Basic Authentication.
Request body
Responses
Success response
Bad request. Params are missing or invalid.
Unauthorized. Credentials may be invalid. Reachout out to Narvar support
{return_reference_number}Authentication
This API can be leveraged to extract return labels that are associated with orders processed through the Narvar platform.
When users initiate a return on the Narvar platform, each return is assigned a unique “return_reference_number”. This number serves as an integral identifier to ensure the correct linkage between the return and its associated label. By inputting this return_reference_number into the API, it will retrieve the corresponding label.
Once a request is made, the API searches for the label tied to the provided return_reference_number. Upon finding a match, the API responds with a dedicated link. This link not only provides direct access to the label’s URL but also ensures that users can easily view, download, or print the label for their return package
Path variables
Request parameters
A unique return reference number from the narvar returns. e.g The unique return reference number from Narvar returns can be sourced through the Generate Return Labels API call
Responses
OK
400
Unauthorized. Credentials may be invalid. Reachout out to Narvar support
Name of the Carrier
{
"status": "FAILURE",
"messages": [
{
"code": "inv.request",
"message": "Invalid Request. Params are missing."
}
]
}Status value of the Error
JSON object array of type “messages”.
Property constant that can be used for message localization
Description of the error in English
Contains items that require return, accompanied by a justification for the return reason specified for each item
The quantity of the item to be returned.
If the item is uniquely distinguished by its item_id, then this value must be provided.
The code indicating the reason for the return. Retailer reason code as configured in the Narvar hub
User comments captured
The SKU (stock keeping unit) identifier for this item.
Describes the type for the return
URL to access label, if a label is assocaited with a return
Tracking number of the returns package(s).
URL to track return on Narvar experience.
Link to the generated QR code. This will be populated only when retun method of type is evaluated to Printerless/QR code generation
This request includes details of the order, items in the order, RMA (Return Merchandise Authorization) guidelines, and the reasons for the return.
The order number associated with the return.
The ISO3 locale linked to the return. During return creation, settings specific to this locale will be applied, if set up. Defaults to en_US if not provided.
The return merchandise authorization (RMA) number, that would be associated with the return created. If not provided, it will levegae the Narvar RMA generator, if configured or assign RA as default RMA number
The specified carrier name to be used for the return must be set up on the Narvar platform. The system defaults to using Narvar’s predefined rules for the retailer to identify the suitable carrier for mail type returns. In cases where rule assessment suggests multiple carrier options, the provided carrier value acts as a selection filter.
When supplied, the billing zip associated with the order will be cross-checked against the order’s details. In the case of a gift return, the given postal code will be compared with the order’s shipping zip.
The items in the order to be returned.
The email linked to the order. If provided, it will be verified against the order details.
The return type categorization directs the route for a client’s specific return process. If not specified, the default action is the generation of a mail return label.
When set to true, it signifies the processing of a gift return. The postal_code of the originally shipped order should be supplied.
The response confirms a successful/failure transaction, denoted by the status. Relevant details about the order, including a unique return order number and RMA number, are presented.
The response also provides methods for return, specifying the type and associated carrier. Additionally, provides URLs for return labels, tracking, and a QR code, as applicable.
Status of response
Arrays of resaons for the failure
A unique Narvar return_reference_number which can be used to retrieve the label later.
Return order number. Should be same as passed in the request
A distinct rma_number associated with the return. If provided in the request, it must correspond accurately