API Reference
Start typing to search…

CreateRMABooking

post https://eu-ext.linnworks.net/api/ReturnsRefunds/CreateRMABooking

Creates an RMA booking in the system
Permissions Required: GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsExchanges.CreateReturnsExchangesNode
Rate limit: 150 / minute

Log in to see full request history
Body Params
request
object
Response

Response body
object
int32

An identifier for the RMA request header being worked with. Newly created RMA headers will have this field populated as part of the "Create" request

Items
array of objects

A collection of verified and validated items that have been added to this RMA request

Items
object
int32

A unique identifier for the RMA line

int32

A unique identifier for the header this RMA line belongs to

string

Identifies the type of RMA for this line

Return Exchange Resend

Status
object
string

The channel reference number for this RMA

date-time

The timestamp for when the RMA was created

boolean

Line-level indicator of whether the refund has been actioned

date-time

If an RMA has been actioned, this denotes the date it was actioned. For not actioned lines, this value is null

boolean

Identifies whether the line has been removed from the RMA, and is pending an update to the database to reflect this

int32
uuid

In the case of an exchange or resend line, this is the identifier for the created order

string

Identifies any validation or submission errors for this RMA item

string
Errors
array of objects
Errors
object
int32
string
date-time
boolean
string

Identifies any validation or submission information for this RMA item

uuid

The stock item ID for the item that will replace the returned item

string

Identifies the SKU of the item that will replace the returned item

string

Identifies the title of the item that will replace the returned item

int32

The number of this item to send as part of the exchange

uuid

The identifier for the location to create the exchange order in. This is where the item will have its stock deducted from

double

This field denotes the additional cost that will be incurred to the customer for this exchange

uuid

The unique ID of the order item to be returned. Note: This field is ignored when part of an Update call

string

The SKU of the order item to be returned. Read-only

string

The title of the order item to be returned. Read-only

int32

If the item is batched, this identifies the batch inventory row the item will be returned to

uuid

The unique identifier for the Linnworks location to return the item to

int32

The amount of the item to be returned

double

Where applicable, the amount to refund the customer as part of this RMA

uuid

Where applicable, the row id for the created refund line associated with this RMA

int32

Where applicable, the amount of returned items to be scrapped

string

The category for the return/exchange reason (e.g. Faulty Item)

boolean

Defines whether the channel RMA reason is being sent as freetext (where supported). Automatically set

string

A freetext internal reason for the return/exchange

string

For channels that support predefined RMA reasons, this is the tag that identifies a predefined reason

string

For channels that support a secondary predefined RMA reason, this is the tag that identifies a predefined secondary reason

string

Used specifically with batch composite parents, this will ensure that all children are returned to the binrack of choice (acts the same as batchinventoryid for single items)

Errors
array of strings

Any global validation errors are included in this collection, along with a concatenation of any errors found in an individual item

Errors
Info
array of strings

Any global validation information is included in this collection, along with a concatenation of any information found in an individual item

Info

Updated over 1 year ago

Did this page help you?
Language
Credentials

Updated over 1 year ago

Did this page help you?