Read SalesReturn
Retrieves the details of a SalesReturn object that has been previously created.
Parameters
| Path Params | |
|---|---|
| yourCompany: | string The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/SalesReturn will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/SalesReturn |
| Query Params | |
|---|---|
| filter: | string In this parameter fieldname needs to be provided with condition and value to fetch related details.for eg. Subject,eq,Salesreturn subject
|
| customview: | string https://xyzcompany.agiliron.net/agiliron/api-40/SalesReturn?customview=ABC Customview&key=xyzkey |
| page: | int https://xyzcompany.agiliron.net/agiliron/api-40/SalesReturn?filter=Status,eq,Created | Invoiced | Shipped;Test CheckBox,eq,0&page=10&key=xyzkey |
| pageSize: | int https://xyzcompany.agiliron.net/agiliron/api-40/SalesReturn?filter=Status,eq,Created | Invoiced | Shipped;Test CheckBox,eq,0&pageSize=10&key=xyzkey |
| Header Params | |
|---|---|
| Accept: | string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button. |
| Query Auth | |
|---|---|
| key: | string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0. |
| Header Auth | |
|---|---|
| apiKey: | string Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0. |
Sample Code
NOTE: For SalesReturn ,
- SalesReturnId field contains SalesReturn Id.
- OrderNo field contains RMA Number.
- AgilironOrderNo field contains Return no.
- RelatedSalesOrders field contains SalesOrder No.
{
"SalesReturns": {
"Order": [{
"OrderNo": "2794",
"AgilironOrderNo": "3001",
"SalesReturnId": "13001",
"OrderDate": "01-24-2020 08:33:59",
"OrderDateUTC": "01-24-2020 15:01:35",
"ModifiedDate": "01-24-2020 06:39:02",
"ModifiedTimeUTC": "01-24-2020 15:05:56",
"Subject": "Test New Sales return",
"AccountId": "156961",
"AccountName": "Test Account",
"AccountPhone": "23444522",
"AccountEmailAddress": "[email protected]",
"ContactId": "156962",
"ContactFirstName": "John",
"ContactLastName": "Doe",
"ContactPhone": "41533345",
"ContactEmailAddress": "[email protected]",
"Fax": "",
"DueDate": "",
"BillingName": "John Doe",
"BillingStreet": "4567DoeCircle",
"BillingCity": "SanFrancisco",
"BillingState": "CA",
"BillingZipCode": "94104",
"BillingCountry": "UnitedStates",
"ShipToName": "",
"ShipToPhone": "(415)675-3134",
"ShipToEmailAddress": "[email protected]",
"ShippingStreet": "4567DoeCircle",
"ShippingCity": "SanFrancisco",
"ShippingState": "CA",
"ShippingZipCode": "94104",
"ShippingCountry": "UnitedStates",
"OrderDiscount": "",
"SubTotal": "455.780",
"ShippingCost": "",
"SalesTaxAuthority": "",
"SalesTaxes": "0.000",
"GrandTotal": "462.530",
"DefaultCurrency": "",
"ExchangeRate": "0.00000",
"Status": "Created,Invoiced,",
"PaymentLineItems": {
"Payment": [
{
"PaymentMethod": "Credit Card",
"PaymentAmount": "10",
"PaymentDate": "05-12-2025",
"CheckNumber": null,
"CheckWriter": null,
"CreditCardNumber": "",
"CreditCardNumberMasked": "",
"CreditCardType": "Visa",
"CreditCardOwner": "John",
"CreditCardExpires": "",
"CreditCardSecurityCode": "",
"CreditCardAuthorization": "123",
"InvoiceNumber": null,
"CustomerBankAccount": null,
"PaymentEmailAddress": null,
"TransactionRecordNumber": null,
"AmountDue": "0.00"
}
]
},
"AssignedTo": "admin",
"ExportToQuickbooks": "2",
"TermsAndConditions": "Prepaid",
"Description": "Order notes goes here.",
"Carrier": "",
"ShippingMethod": "",
"DeliverTo": "OAK",
"RMANumber": "5012323123223",
"TrackingNo": "",
"RelatedSalesOrders": "2308",
"OrdersCustomFields": {
"CustomField": [{
"Name": "CustomFied1",
"Value": "Custom info 1"
},
{
"Name": "CustomFied2",
"Value": "Custom info 2"
}
]
},
"OrderDetails": {
"OD": [{
"ProductsName": "Test New Product1",
"ProductCode": "TNP1",
"MatrixSKUCode": "0",
"SerialNo": "",
"ProductNotes": "Product notes goes here.",
"ProductQty": "2",
"ProductPrice": "15",
"ProductDiscount": "0",
"ProductTotal": "30"
},
{
"ProductsName": "Test New Product2",
"ProductCode": "TNP2",
"MatrixSKUCode": "0",
"SerialNo": "",
"ProductNotes": "Product notes goes here.",
"ProductQty": "2",
"ProductPrice": "5",
"ProductDiscount": "0",
"ProductTotal": "10"
}
]
}
}],
"TotalRecords": "1",
"CurrentPage": "1",
"TotalPages": "1",
"PageSize": "50"
}
}<SalesReturns>
<Order>
<OrderNo>2794</OrderNo>
<AgilironOrderNo>3001</AgilironOrderNo>
<SalesReturnId>13001</SalesReturnId>
<OrderDate>01-24-2020 08:33:59</OrderDate>
<OrderDateUTC>01-24-2020 15:01:35</OrderDateUTC>
<ModifiedDate>01-24-2020 06:39:02</ModifiedDate>
<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
<Subject>Test New Sales return</Subject>
<AccountId>156961</AccountId>
<AccountName>Test Account</AccountName>
<AccountPhone>23444522</AccountPhone>
<AccountEmailAddress>[email protected]</AccountEmailAddress>
<ContactId>156962</ContactId>
<ContactFirstName>John</ContactFirstName>
<ContactLastName>Doe</ContactLastName>
<ContactPhone>41533345</ContactPhone>
<ContactEmailAddress>[email protected]</ContactEmailAddress>
<Fax></Fax>
<DueDate></DueDate>
<BillingName>John Doe</BillingName>
<BillingStreet>4567DoeCircle</BillingStreet>
<BillingCity>SanFrancisco</BillingCity>
<BillingState>CA</BillingState>
<BillingZipCode>94104</BillingZipCode>
<BillingCountry>UnitedStates</BillingCountry>
<ShipToName></ShipToName>
<ShipToPhone>(415)675-3134</ShipToPhone>
<ShipToEmailAddress>[email protected]</ShipToEmailAddress>
<ShippingStreet>4567DoeCircle</ShippingStreet>
<ShippingCity>SanFrancisco</ShippingCity>
<ShippingState>CA</ShippingState>
<ShippingZipCode>94104</ShippingZipCode>
<ShippingCountry>UnitedStates</ShippingCountry>
<OrderDiscount></OrderDiscount>
<SubTotal>455.780</SubTotal>
<ShippingCost></ShippingCost>
<SalesTaxAuthority></SalesTaxAuthority>
<SalesTaxes>0.000</SalesTaxes>
<GrandTotal>462.530</GrandTotal>
<DefaultCurrency></DefaultCurrency>
<ExchangeRate>0.00000</ExchangeRate>
<Status>Created,Invoiced,</Status>
<PaymentLineItems>
<Payment>
<PaymentMethod>Credit Card</PaymentMethod>
<PaymentAmount>10</PaymentAmount>
<PaymentDate>05-12-2025</PaymentDate>
<CheckNumber></CheckNumber>
<CheckWriter></CheckWriter>
<CreditCardNumber></CreditCardNumber>
<CreditCardNumberMasked></CreditCardNumberMasked>
<CreditCardType>Visa</CreditCardType>
<CreditCardOwner>John</CreditCardOwner>
<CreditCardExpires></CreditCardExpires>
<CreditCardSecurityCode></CreditCardSecurityCode>
<CreditCardAuthorization>123</CreditCardAuthorization>
<InvoiceNumber></InvoiceNumber>
<CustomerBankAccount></CustomerBankAccount>
<PaymentEmailAddress></PaymentEmailAddress>
<TransactionRecordNumber></TransactionRecordNumber>
<AmountDue>0.00</AmountDue>
</Payment>
</PaymentLineItems>
<AssignedTo>admin</AssignedTo>
<ExportToQuickbooks>2</ExportToQuickbooks>
<TermsAndConditions>Prepaid</TermsAndConditions>
<Description>Order notes goes here.</Description>
<Carrier></Carrier>
<ShippingMethod></ShippingMethod>
<DeliverTo>OAK</DeliverTo>
<RMANumber>5012323123223</RMANumber>
<TrackingNo></TrackingNo>
<RelatedSalesOrders>2308</RelatedSalesOrders>
<OrdersCustomFields>
<CustomField>
<Name>CustomFied1</Name>
<Value>Custom info 1</Value>
</CustomField>
<CustomField>
<Name>CustomFied2</Name>
<Value>Custom info 2</Value>
</CustomField>
</OrdersCustomFields>
<OrderDetails>
<OD>
<ProductsName>Test New Product1</ProductsName>
<ProductCode>TNP1</ProductCode>
<MatrixSKUCode>0</MatrixSKUCode>
<SerialNo></SerialNo>
<ProductNotes>Product notes goes here.</ProductNotes>
<ProductQty>2</ProductQty>
<ProductPrice>15</ProductPrice>
<ProductDiscount>0</ProductDiscount>
<ProductTotal>30</ProductTotal>
</OD>
<OD>
<ProductsName>Test New Product2</ProductsName>
<ProductCode>TNP2</ProductCode>
<MatrixSKUCode>0</MatrixSKUCode>
<SerialNo></SerialNo>
<ProductNotes>Product notes goes here.</ProductNotes>
<ProductQty>2</ProductQty>
<ProductPrice>5</ProductPrice>
<ProductDiscount>0</ProductDiscount>
<ProductTotal>10</ProductTotal>
</OD>
</OrderDetails>
</Order>
<TotalRecords>1</TotalRecords>
<CurrentPage>1</CurrentPage>
<TotalPages>1</TotalPages>
<PageSize>50</PageSize>
</SalesReturns>WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="SalesReturn">
<method name="GET">
<resource path="{filter}">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>