AddRma
| Endpoint URL |
https://www.yournetosite.com.au/do/WS/NetoAPI |
| Method |
POST |
| XML Headers |
| NETOAPI_ACTION |
AddRma |
| NETOAPI_USERNAME |
Your Neto Username (generate this in your Neto control panel) |
| NETOAPI_KEY |
Your Neto API Secure Key (generate this in your Neto control panel) |
|
| JSON Headers |
| NETOAPI_ACTION |
AddRma |
| NETOAPI_USERNAME |
Your Neto Username (generate this in your Neto control panel) |
| NETOAPI_KEY |
Your Neto API Secure Key (generate this in your Neto control panel) |
| Accept |
application/json |
|
| Description |
Use this call to add a new RMA (Return Merchadise Authorisation). A successful call to AddRma returns the unique identifier (RmaID) for the new RMA, and the date and time the RMA was added (CurrentTime) |
| XSD Schema |
AddRma XSD | AddRma Response XSD
|
AddRma Post
You must specify at least one filter and one OutputSelector in your AddRma request. These will determine the results returned.
XML POST
<?xml version="1.0" encoding="utf-8"?>
<AddRma>
<Rma>
<OrderID>(String)</OrderID>
<InvoiceNumber>(String)</InvoiceNumber>
<CustomerUsername>(String)</CustomerUsername>
<StaffUsername>(String)</StaffUsername>
<PurchaseOrderNumber>(String)</PurchaseOrderNumber>
<InternalNotes>(String)</InternalNotes>
<RmaStatus></RmaStatus>
<DateIssued>(DateTime)</DateIssued>
<ShippingRefundAmount>(Decimal)</ShippingRefundAmount>
<ShippingRefundTaxCode>(String)</ShippingRefundTaxCode>
<TaxInclusive>(Boolean)</TaxInclusive>
<RmaLines>
<RmaLine>
<Quantity>(Integer)</Quantity>
<SKU>(String)</SKU>
<ItemDescription>(String)</ItemDescription>
<RefundSubtotal>(Decimal)</RefundSubtotal>
<TaxCode>(String)</TaxCode>
<WarehouseID>(Integer)</WarehouseID>
<ResolutionOutcome>(String)</ResolutionOutcome>
<ReturnReason>(String)</ReturnReason>
<ItemStatusType>(String)</ItemStatusType>
<ItemStatus>(String)</ItemStatus>
<ResolutionStatus>(String)</ResolutionStatus>
<ManufacturerClaims>(String)</ManufacturerClaims>
</RmaLine>
</RmaLines> <Refunds>
<Refund>
<PaymentMethod>(String)</PaymentMethod>
<DateRefunded>(DateTime)</DateRefunded>
<RefundAmount>(Decimal)</RefundAmount>
<TransactionNotes>
<TransactionNote>
<Title>(String)</Title>
<Description>(String)</Description>
</TransactionNote>
</TransactionNotes> </Refund>
</Refunds> </Rma>
</AddRma>
JSON POST
{
"Rma": [ {
"OrderID":"String",
"InvoiceNumber":"String",
"CustomerUsername":"String",
"StaffUsername":"String",
"PurchaseOrderNumber":"String",
"InternalNotes":"String",
"RmaStatus":"Enumeration",
"DateIssued":"DateTime",
"ShippingRefundAmount":"Decimal",
"ShippingRefundTaxCode":"String",
"TaxInclusive":"Boolean",
"RmaLines": {
"RmaLine": [ {
"Quantity":"Integer",
"SKU":"String",
"ItemDescription":"String",
"RefundSubtotal":"Decimal",
"TaxCode":"String",
"WarehouseID":"Integer",
"ResolutionOutcome":"String",
"ReturnReason":"String",
"ItemStatusType":"String",
"ItemStatus":"String",
"ResolutionStatus":"String",
"ManufacturerClaims":"String"
} ]
} , "Refunds": {
"Refund": [ {
"PaymentMethod":"String",
"DateRefunded":"DateTime",
"RefundAmount":"Decimal",
"TransactionNotes": {
"TransactionNote": [ {
"Title":"String",
"Description":"String"
} ]
}
} ]
}
} ]
}
<Rma>
| Element Name |
Required |
Field Type / Options |
| OrderID |
Required |
String(15) |
| InvoiceNumber |
Required |
String(32) |
| CustomerUsername |
Required |
String(25) |
| StaffUsername |
Required |
String(25) |
| PurchaseOrderNumber |
Required |
String(50) |
| InternalNotes |
Required |
String(5000) |
| RmaStatus |
Required |
Enumeration(Open, Closed) |
| DateIssued |
Optional |
DateTime |
| ShippingRefundAmount |
Required |
Decimal |
| ShippingRefundTaxCode |
Required |
String(8) |
| TaxInclusive |
Optional |
Boolean(True, False) |
| RmaLines |
Optional |
RmaLinesType |
| Refunds |
Optional |
RefundsType |
<RmaLines>
| Element Name |
Required |
Field Type / Options |
| RmaLine |
Optional
Supports Multiple Elements |
RmaLineType |
<RmaLine>
| Element Name |
Required |
Field Type / Options |
| Quantity |
Required |
Integer |
| SKU |
Required |
String(25) |
| ItemDescription |
Optional |
String(255) |
| RefundSubtotal |
Required |
Decimal |
| TaxCode |
Required |
String(8) |
| WarehouseID |
Required |
Integer |
| ResolutionOutcome |
Optional |
String(100) |
| ReturnReason |
Optional |
String(100) |
| ItemStatusType |
Optional |
String(100) |
| ItemStatus |
Optional |
String(100) |
| ResolutionStatus |
Optional |
String(100) |
| ManufacturerClaims |
Optional |
String(100) |
<Refunds>
| Element Name |
Required |
Field Type / Options |
| Refund |
Optional
Supports Multiple Elements |
RefundType |
<Refund>
<TransactionNotes>
| Element Name |
Required |
Field Type / Options |
| TransactionNote |
Optional
Supports Multiple Elements |
TransactionNoteType |
<TransactionNote>
| Element Name |
Required |
Field Type / Options |
| Title |
Optional |
String(150) |
| Description |
Optional |
String(5000) |
AddRma Responses
XML Response
<?xml version="1.0" encoding="utf-8"?>
<AddRma>
</AddRma>
JSON Response
{
}
If you are a vendor creating an integration with Neto by Maropost, we would like to hear from you!
Contact Us