GET 3dCartWebAPI/v1/RMA/{rmaid}/Items
Gets the items from a specific RMA
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
rmaid |
Order ID |
integer |
Default value is 0 |
limit |
Maximum number of items that can be returned |
integer |
Default value is 0 |
offset |
Starting point for the return data |
integer |
Default value is 0 |
Body Parameters
None.
Sample Request |
|
Please click here to download the C# Rest API Client project from GitHub.
not yet available
not yet available
Response Information
Resource Description
Collection of RMAItemName | Description | Type | Additional information |
---|---|---|---|
CatalogID |
database reference = RMA_oitem.orderitemid |
integer |
None. |
SKU |
database reference = oitems.itemid |
string |
String length: inclusive between 0 and 150 |
ItemName |
database reference = oitems.itemname |
string |
String length: inclusive between 0 and 65535 |
ReturnQuantity |
database reference = RMA_oitem.qty_return |
integer |
None. |
ReceivedQuantity |
database reference = RMA_oitem.qty_received |
integer |
None. |
RestockQuantity |
database reference = RMA_oitem.qty_restock |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "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
Sample:
<ArrayOfRMAItem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <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> </ArrayOfRMAItem>