GetRma

Endpoint URL https://www.yournetosite.com.au/do/WS/NetoAPI
Method POST
XML Headers
NETOAPI_ACTION GetRma
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 GetRma
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
XSD Schema GetRma XSD   |   GetRma Response XSD

GetRma Post

You must specify at least one filter and one OutputSelector in your GetRma request. These will determine the results returned.

XML POST

<?xml version="1.0" encoding="utf-8"?>
<GetRma>
   <Filter> 
    <OrderID>(String)</OrderID>    
    <Username>(String)</Username>    
    <RmaID>(String)</RmaID>    
    <InvoiceNumber>(String)</InvoiceNumber>    
    <RmaStatus>(String)</RmaStatus>    
    <DateIssuedFrom>(DateTime)</DateIssuedFrom>    
    <DateIssuedTo>(DateTime)</DateIssuedTo>    
    <DateUpdatedFrom>(DateTime)</DateUpdatedFrom>    
    <DateUpdatedTo>(DateTime)</DateUpdatedTo>    
    <DateApprovedFrom>(Date)</DateApprovedFrom>    
    <DateApprovedTo>(Date)</DateApprovedTo>    
    <SplitKitComponents>(String)</SplitKitComponents>    
    <OutputSelector>OrderID</OutputSelector>    
    <OutputSelector>InvoiceNumber</OutputSelector>    
    <OutputSelector>CustomerUsername</OutputSelector>    
    <OutputSelector>StaffUsername</OutputSelector>    
    <OutputSelector>PurchaseOrderNumber</OutputSelector>    
    <OutputSelector>InternalNotes</OutputSelector>    
    <OutputSelector>CurrencyCode</OutputSelector>    
    <OutputSelector>RmaStatus</OutputSelector>    
    <OutputSelector>ShippingRefundAmount</OutputSelector>    
    <OutputSelector>ShippingRefundTaxCode</OutputSelector>    
    <OutputSelector>SurchargeRefundAmount</OutputSelector>    
    <OutputSelector>RefundSubtotal</OutputSelector>    
    <OutputSelector>RefundTotal</OutputSelector>    
    <OutputSelector>RefundTaxTotal</OutputSelector>    
    <OutputSelector>TaxInclusive</OutputSelector>    
    <OutputSelector>DateIssued</OutputSelector>    
    <OutputSelector>DateUpdated</OutputSelector>    
    <OutputSelector>DateApproved</OutputSelector>    
    <OutputSelector>RmaLine</OutputSelector>    
    <OutputSelector>RmaLine.ItemNumber</OutputSelector>    
    <OutputSelector>RmaLine.Extra</OutputSelector>    
    <OutputSelector>RmaLine.ExtraOptions</OutputSelector>    
    <OutputSelector>RmaLine.ItemNotes</OutputSelector>    
    <OutputSelector>RmaLine.ProductName</OutputSelector>    
    <OutputSelector>RmaLine.RefundSubtotal</OutputSelector>    
    <OutputSelector>RmaLine.Tax</OutputSelector>    
    <OutputSelector>RmaLine.TaxCode</OutputSelector>    
    <OutputSelector>RmaLine.WarehouseID</OutputSelector>    
    <OutputSelector>RmaLine.WarehouseName</OutputSelector>    
    <OutputSelector>RmaLine.WarehouseReference</OutputSelector>    
    <OutputSelector>RmaLine.ResolutionOutcome</OutputSelector>    
    <OutputSelector>RmaLine.ReturnReason</OutputSelector>    
    <OutputSelector>RmaLine.ItemStatusType</OutputSelector>    
    <OutputSelector>RmaLine.ItemStatus</OutputSelector>    
    <OutputSelector>RmaLine.ResolutionStatus</OutputSelector>    
    <OutputSelector>RmaLine.ManufacturerClaims</OutputSelector>    
    <OutputSelector>RmaLine.IsRestockIssued</OutputSelector>    
    <OutputSelector>RefundedTotal</OutputSelector>    
    <OutputSelector>Refund</OutputSelector>    
    <OutputSelector>Refund.PaymentMethodID</OutputSelector>    
    <OutputSelector>Refund.PaymentMethodName</OutputSelector>    
    <OutputSelector>Refund.DateIssued</OutputSelector>    
    <OutputSelector>Refund.DateRefunded</OutputSelector>    
    <OutputSelector>Refund.RefundStatus</OutputSelector>    
    <SortBy>(String)</SortBy>    
    <Page>(Integer)</Page>    
    <Limit>(Integer)</Limit>    
   </Filter>
</GetRma>

JSON POST

{
  "Filter": {
    "OrderID":["String"/*, ...*/],
    "Username":["String"/*, ...*/],
    "RmaID":["String"/*, ...*/],
    "InvoiceNumber":["String"/*, ...*/],
    "RmaStatus":["String"/*, ...*/],
    "DateIssuedFrom":"DateTime",
    "DateIssuedTo":"DateTime",
    "DateUpdatedFrom":"DateTime",
    "DateUpdatedTo":"DateTime",
    "DateApprovedFrom":"Date",
    "DateApprovedTo":"Date",
    "SplitKitComponents":["String"/*, ...*/],
    "OutputSelector":["Enumeration"/*, ...*/],
    "SortBy":["String"/*, ...*/],
    "Page":"Integer",
    "Limit":"Integer" 
} 
}

<Filter>

Element Name Required Field Type / Options
OrderID Optional
Supports Multiple Elements		 String(15)
Username Optional
Supports Multiple Elements		 String(25)
RmaID Optional
Supports Multiple Elements		 String(10)
InvoiceNumber Optional
Supports Multiple Elements		 String(25)
RmaStatus Optional
Supports Multiple Elements		 String(6)
DateIssuedFrom Optional DateTime
DateIssuedTo Optional DateTime
DateUpdatedFrom Optional DateTime
DateUpdatedTo Optional DateTime
DateApprovedFrom Optional Date
DateApprovedTo Optional Date
SplitKitComponents Optional
Supports Multiple Elements		 String(10)

<OutputSelector>

Determines what is returned by the POST. Refer to the example response below this table or the related XSD schema for details and restrictions of each output element.

Note: Each OutputSelector should be a separate element in your post.

OutputSelector Enumeration (OrderID, InvoiceNumber, CustomerUsername, StaffUsername, PurchaseOrderNumber, InternalNotes, CurrencyCode, RmaStatus, ShippingRefundAmount, ShippingRefundTaxCode, SurchargeRefundAmount, RefundSubtotal, RefundTotal, RefundTaxTotal, TaxInclusive, DateIssued, DateUpdated, DateApproved, RmaLine, RmaLine.ItemNumber, RmaLine.Extra, RmaLine.ExtraOptions, RmaLine.ItemNotes, RmaLine.ProductName, RmaLine.RefundSubtotal, RmaLine.Tax, RmaLine.TaxCode, RmaLine.WarehouseID, RmaLine.WarehouseName, RmaLine.WarehouseReference, RmaLine.ResolutionOutcome, RmaLine.ReturnReason, RmaLine.ItemStatusType, RmaLine.ItemStatus, RmaLine.ResolutionStatus, RmaLine.ManufacturerClaims, RmaLine.IsRestockIssued, RefundedTotal, Refund, Refund.PaymentMethodID, Refund.PaymentMethodName, Refund.DateIssued, Refund.DateRefunded, Refund.RefundStatus)
SortBy Optional
Supports Multiple Elements String(30) Page Optional Integer Limit Optional Integer

GetRma Responses

XML Response

<?xml version="1.0" encoding="utf-8"?>
<GetRma>
   <Rma> 
    <RmaID>(Integer)</RmaID>    
    <OrderID>(String)</OrderID>    
    <InvoiceNumber>(String)</InvoiceNumber>    
    <CustomerUsername>(String)</CustomerUsername>    
    <StaffUsername>(String)</StaffUsername>    
    <PurchaseOrderNumber>(String)</PurchaseOrderNumber>    
    <InternalNotes>(String)</InternalNotes>    
    <CurrencyCode>(String)</CurrencyCode>    
    <RmaStatus>(String)</RmaStatus>    
    <ShippingRefundAmount>(Decimal)</ShippingRefundAmount>    
    <ShippingRefundTaxCode>(String)</ShippingRefundTaxCode>    
    <SurchargeRefundAmount>(Decimal)</SurchargeRefundAmount>    
    <RefundSubtotal>(Decimal)</RefundSubtotal>    
    <RefundTotal>(Decimal)</RefundTotal>    
    <RefundTaxTotal>(Decimal)</RefundTaxTotal>    
    <TaxInclusive>(Boolean)</TaxInclusive>    
    <DateIssued>(DateTime)</DateIssued>    
    <DateUpdated>(DateTime)</DateUpdated>    
    <DateApproved>(DateTime)</DateApproved>    
     <RmaLines> 
       <RmaLine> 
        <RmaLineID>(String)</RmaLineID>        
        <SKU>(String)</SKU>        
        <Quantity>(Integer)</Quantity>        
        <ProductName>(String)</ProductName>        
        <ItemNotes>(String)</ItemNotes>        
        <ItemNumber>(String)</ItemNumber>        
        <Extra>(String)</Extra>        
         <ExtraOptions> 
           <ExtraOptions> 
            <Name>(String)</Name>            
            <Value>(String)</Value>            
           </ExtraOptions>          
         </ExtraOptions>        <RefundSubtotal>(Decimal)</RefundSubtotal>        
        <Tax>(Decimal)</Tax>        
        <TaxCode>(String)</TaxCode>        
        <WarehouseID>(Integer)</WarehouseID>        
        <WarehouseName>(String)</WarehouseName>        
        <WarehouseReference>(String)</WarehouseReference>        
        <ResolutionOutcome>(String)</ResolutionOutcome>        
        <ReturnReason>(String)</ReturnReason>        
        <ItemStatusType>(String)</ItemStatusType>        
        <ItemStatus>(String)</ItemStatus>        
        <ResolutionStatus>(String)</ResolutionStatus>        
        <ManufacturerClaims>(String)</ManufacturerClaims>        
        <ComponentOfKit>(Integer)</ComponentOfKit>        
        <KitPartID>(Integer)</KitPartID>        
       </RmaLine>      
     </RmaLines>    
     <Refunds> 
       <Refund> 
        <RefundID>(Integer)</RefundID>        
        <RefundAmount>(Decimal)</RefundAmount>        
        <PaymentMethodID>(Integer)</PaymentMethodID>        
        <PaymentMethodName>(String)</PaymentMethodName>        
        <DateIssued>(DateTime)</DateIssued>        
        <DateRefunded>(DateTime)</DateRefunded>        
        <RefundStatus>(String)</RefundStatus>        
       </Refund>      
     </Refunds>    
    <RefundedTotal>(DateTime)</RefundedTotal>    
   </Rma>  
   <Messages> 
     <Error> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
      <Description>(String)</Description>      
     </Error>    
     <Warning> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
     </Warning>    
   </Messages>
</GetRma>

JSON Response

{
  "Rma": [ {
    "RmaID":"Integer",
    "OrderID":"String",
    "InvoiceNumber":"String",
    "CustomerUsername":"String",
    "StaffUsername":"String",
    "PurchaseOrderNumber":"String",
    "InternalNotes":"String",
    "CurrencyCode":"String",
    "RmaStatus":"String",
    "ShippingRefundAmount":"Decimal",
    "ShippingRefundTaxCode":"String",
    "SurchargeRefundAmount":"Decimal",
    "RefundSubtotal":"Decimal",
    "RefundTotal":"Decimal",
    "RefundTaxTotal":"Decimal",
    "TaxInclusive":"Boolean",
    "DateIssued":"DateTime",
    "DateUpdated":"DateTime",
    "DateApproved":"DateTime",
    "RmaLines": [ {
      "RmaLine": [ {
        "RmaLineID":"String",
        "SKU":["String"/*, ...*/],
        "Quantity":["Integer"/*, ...*/],
        "ProductName":"String",
        "ItemNotes":"String",
        "ItemNumber":["String"/*, ...*/],
        "Extra":"String",
        "ExtraOptions": {
          "ExtraOptions": [ {
            "Name":"String",
            "Value":"String" 
} ]  
} ,        "RefundSubtotal":["Decimal"/*, ...*/],
        "Tax":["Decimal"/*, ...*/],
        "TaxCode":["String"/*, ...*/],
        "WarehouseID":"Integer",
        "WarehouseName":"String",
        "WarehouseReference":"String",
        "ResolutionOutcome":"String",
        "ReturnReason":"String",
        "ItemStatusType":"String",
        "ItemStatus":"String",
        "ResolutionStatus":"String",
        "ManufacturerClaims":"String",
        "ComponentOfKit":"Integer",
        "KitPartID":"Integer" 
} ]  
} ] ,    "Refunds": [ {
      "Refund": [ {
        "RefundID":"Integer",
        "RefundAmount":"Decimal",
        "PaymentMethodID":"Integer",
        "PaymentMethodName":"String",
        "DateIssued":"DateTime",
        "DateRefunded":"DateTime",
        "RefundStatus":"String" 
} ]  
} ] ,    "RefundedTotal":"DateTime" 
} ] ,  "Messages": {
    "Error": [ {
      "Message":"String",
      "SeverityCode":"String",
      "Description":"String" 
} ] ,    "Warning": [ {
      "Message":"String",
      "SeverityCode":"String" 
} ]  
} 
}

<Rma>

Element Name Field Type
RmaID Integer
OrderID String
InvoiceNumber String
CustomerUsername String
StaffUsername String
PurchaseOrderNumber String
InternalNotes String
CurrencyCode String
RmaStatus String
ShippingRefundAmount Decimal
ShippingRefundTaxCode String
SurchargeRefundAmount Decimal
RefundSubtotal Decimal
RefundTotal Decimal
RefundTaxTotal Decimal
TaxInclusive Boolean
DateIssued DateTime
DateUpdated DateTime
DateApproved DateTime
RmaLines RmaLinesType
Refunds RefundsType
RefundedTotal DateTime

<RmaLines>

Element Name Field Type
RmaLine RmaLineType

<RmaLine>

Element Name Field Type
RmaLineID String
SKU String
Quantity Integer
ProductName String
ItemNotes String
ItemNumber String
Extra String
ExtraOptions ExtraOptionsType
RefundSubtotal Decimal
Tax Decimal
TaxCode String
WarehouseID Integer
WarehouseName String
WarehouseReference String
ResolutionOutcome String
ReturnReason String
ItemStatusType String
ItemStatus String
ResolutionStatus String
ManufacturerClaims String
ComponentOfKit Integer
KitPartID Integer

<ExtraOptions>

Element Name Field Type
ExtraOptions ExtraOptionsType

<ExtraOptions>

Element Name Field Type
Name String
Value String

<Refunds>

Element Name Field Type
Refund RefundType

<Refund>

Element Name Field Type
RefundID Integer
RefundAmount Decimal
PaymentMethodID Integer
PaymentMethodName String
DateIssued DateTime
DateRefunded DateTime
RefundStatus String

<Messages>

Element Name Field Type
Error ErrorType
Warning WarningType

<Error>

Element Name Field Type
Message String
SeverityCode String
Description String

<Warning>

Element Name Field Type
Message String
SeverityCode String

If you are a vendor creating an integration with Neto by Maropost, we would like to hear from you!

Contact Us

Was this article useful?

Be notified when this page is updated. Optional.