Request a Return

post

https://marketplace-integrations.nelo.co/v1/admin/orders/{id}/return

Request and create a Return for items in an order. If the return shipping method is specified, it will be automatically fulfilled.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the Order.

Query Params

expand

string

Comma-separated relations that should be expanded in the returned order.

fields

string

Comma-separated fields that should be included in the returned order.

Body Params

The details of the requested return.

items

array of objects

required

The line items that will be returned.

items*

return_shipping

object

The Shipping Method to be used to handle the return shipment.

note

string

An optional note with information about the Return.

receive_now

boolean

Defaults to false

A flag to indicate if the Return should be registerd as received immediately.

no_notification

boolean

If set to true, no notification will be sent to the customer related to this Return.

refund

integer

The amount to refund.

location_id

string

The ID of the location used for the return.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Client Error or Multiple Errors

401User is not authorized. Must log in first

404Not Found Error

409Invalid State Error

422Invalid Request Error

500Server Error