GET 3dCartWebAPI/v1/RMA
Get all RMAs
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
rmastatusid |
Status of the RMA |
integer |
Default value is 0 |
rmareasonid |
Reason of the RMA |
integer |
Default value is 0 |
rmamethodid |
Method of the RMA |
integer |
Default value is 0 |
catalogid |
CatalogID |
integer |
Default value is 0 |
sku |
SKU Code of the product |
string |
Default value is |
datestart |
Date Start (mm/dd/yyyy hh:mm:ss) |
string |
Default value is |
dateend |
Date End (mm/dd/yyyy hh:mm:ss) |
string |
Default value is |
limit |
Maximum number of items that can be returned |
integer |
Default value is 10 |
offset |
Starting point for the return data |
integer |
Default value is 1 |
countonly |
Count the number of rows only |
integer |
Default value is 0 |
Body Parameters
None.
Sample Request |
|
Response Information
Resource Description
Collection of RMAName | Description | Type | Additional information |
---|---|---|---|
RMAID |
Primary key. Auto-incremented. database reference = RMA.idRma |
integer |
None. |
RmaDate |
database reference = RMA.RmaDate |
date |
None. |
OrderID |
database reference = RMA.orderid |
integer |
None. |
RMAReasonID |
database reference = RMA.idRmaReason |
integer |
None. |
RMAMethodID |
database reference = RMA.idRmaMethod |
integer |
None. |
RMAStatusID |
database reference = RMA.idRmaStatus |
integer |
None. |
Comments |
database reference = RMA.Comments |
string |
String length: inclusive between 0 and 65535 |
InternalComments |
database reference = RMA.intComments |
string |
String length: inclusive between 0 and 65535 |
StaffComments |
database reference = RMA.staffComments |
string |
String length: inclusive between 0 and 65535 |
RMAItemList | Collection of RMAItem |
None. |
Response Formats
application/json, text/json
[ { "RMAID": 1, "RmaDate": "04/12/2024 06:57", "OrderID": 1, "RMAReasonID": 1, "RMAMethodID": 1, "RMAStatusID": 1, "Comments": "sample string 1", "InternalComments": "sample string 2", "StaffComments": "sample string 3", "RMAItemList": [ { "CatalogID": 1, "SKU": "sample string 1", "ItemName": "sample string 2", "ReturnQuantity": 1, "ReceivedQuantity": 1, "RestockQuantity": 1 }, { "CatalogID": 1, "SKU": "sample string 1", "ItemName": "sample string 2", "ReturnQuantity": 1, "ReceivedQuantity": 1, "RestockQuantity": 1 } ] }, { "RMAID": 1, "RmaDate": "04/12/2024 06:57", "OrderID": 1, "RMAReasonID": 1, "RMAMethodID": 1, "RMAStatusID": 1, "Comments": "sample string 1", "InternalComments": "sample string 2", "StaffComments": "sample string 3", "RMAItemList": [ { "CatalogID": 1, "SKU": "sample string 1", "ItemName": "sample string 2", "ReturnQuantity": 1, "ReceivedQuantity": 1, "RestockQuantity": 1 }, { "CatalogID": 1, "SKU": "sample string 1", "ItemName": "sample string 2", "ReturnQuantity": 1, "ReceivedQuantity": 1, "RestockQuantity": 1 } ] } ]
application/xml, text/xml
<ArrayOfRMA xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <RMA> <RMAID>1</RMAID> <RmaDate>2024-04-12T06:57:19.5458974-04:00</RmaDate> <OrderID>1</OrderID> <RMAReasonID>1</RMAReasonID> <RMAMethodID>1</RMAMethodID> <RMAStatusID>1</RMAStatusID> <Comments>sample string 1</Comments> <InternalComments>sample string 2</InternalComments> <StaffComments>sample string 3</StaffComments> <RMAItemList> <RMAItem> <CatalogID>1</CatalogID> <SKU>sample string 1</SKU> <ItemName>sample string 2</ItemName> <ReturnQuantity>1</ReturnQuantity> <ReceivedQuantity>1</ReceivedQuantity> <RestockQuantity>1</RestockQuantity> </RMAItem> <RMAItem> <CatalogID>1</CatalogID> <SKU>sample string 1</SKU> <ItemName>sample string 2</ItemName> <ReturnQuantity>1</ReturnQuantity> <ReceivedQuantity>1</ReceivedQuantity> <RestockQuantity>1</RestockQuantity> </RMAItem> </RMAItemList> </RMA> <RMA> <RMAID>1</RMAID> <RmaDate>2024-04-12T06:57:19.5458974-04:00</RmaDate> <OrderID>1</OrderID> <RMAReasonID>1</RMAReasonID> <RMAMethodID>1</RMAMethodID> <RMAStatusID>1</RMAStatusID> <Comments>sample string 1</Comments> <InternalComments>sample string 2</InternalComments> <StaffComments>sample string 3</StaffComments> <RMAItemList> <RMAItem> <CatalogID>1</CatalogID> <SKU>sample string 1</SKU> <ItemName>sample string 2</ItemName> <ReturnQuantity>1</ReturnQuantity> <ReceivedQuantity>1</ReceivedQuantity> <RestockQuantity>1</RestockQuantity> </RMAItem> <RMAItem> <CatalogID>1</CatalogID> <SKU>sample string 1</SKU> <ItemName>sample string 2</ItemName> <ReturnQuantity>1</ReturnQuantity> <ReceivedQuantity>1</ReceivedQuantity> <RestockQuantity>1</RestockQuantity> </RMAItem> </RMAItemList> </RMA> </ArrayOfRMA>