GET 3dCartWebAPI/v1/RMA/{rmaid}


Get a specific RMA

Request Information

URI Parameters

NameDescriptionTypeAdditional information
rmaid

RMA ID

integer

Required

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 RMA
NameDescriptionTypeAdditional 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

Sample:
[
  {
    "RMAID": 1,
    "RmaDate": "08/23/2019 22:25",
    "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": "08/23/2019 22:25",
    "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

Sample:
<ArrayOfRMA xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <RMA>
    <Comments>sample string 1</Comments>
    <InternalComments>sample string 2</InternalComments>
    <OrderID>1</OrderID>
    <RMAID>1</RMAID>
    <RMAItemList xmlns:d3p1="http://schemas.datacontract.org/2004/07/_3dCartWebAPI.Models">
      <d3p1:RMAItem>
        <d3p1:CatalogID>1</d3p1:CatalogID>
        <d3p1:ItemName>sample string 2</d3p1:ItemName>
        <d3p1:ReceivedQuantity>1</d3p1:ReceivedQuantity>
        <d3p1:RestockQuantity>1</d3p1:RestockQuantity>
        <d3p1:ReturnQuantity>1</d3p1:ReturnQuantity>
        <d3p1:SKU>sample string 1</d3p1:SKU>
      </d3p1:RMAItem>
      <d3p1:RMAItem>
        <d3p1:CatalogID>1</d3p1:CatalogID>
        <d3p1:ItemName>sample string 2</d3p1:ItemName>
        <d3p1:ReceivedQuantity>1</d3p1:ReceivedQuantity>
        <d3p1:RestockQuantity>1</d3p1:RestockQuantity>
        <d3p1:ReturnQuantity>1</d3p1:ReturnQuantity>
        <d3p1:SKU>sample string 1</d3p1:SKU>
      </d3p1:RMAItem>
    </RMAItemList>
    <RMAMethodID>1</RMAMethodID>
    <RMAReasonID>1</RMAReasonID>
    <RMAStatusID>1</RMAStatusID>
    <RmaDate>2019-08-23T22:25:54.7641107-04:00</RmaDate>
    <StaffComments>sample string 3</StaffComments>
  </RMA>
  <RMA>
    <Comments>sample string 1</Comments>
    <InternalComments>sample string 2</InternalComments>
    <OrderID>1</OrderID>
    <RMAID>1</RMAID>
    <RMAItemList xmlns:d3p1="http://schemas.datacontract.org/2004/07/_3dCartWebAPI.Models">
      <d3p1:RMAItem>
        <d3p1:CatalogID>1</d3p1:CatalogID>
        <d3p1:ItemName>sample string 2</d3p1:ItemName>
        <d3p1:ReceivedQuantity>1</d3p1:ReceivedQuantity>
        <d3p1:RestockQuantity>1</d3p1:RestockQuantity>
        <d3p1:ReturnQuantity>1</d3p1:ReturnQuantity>
        <d3p1:SKU>sample string 1</d3p1:SKU>
      </d3p1:RMAItem>
      <d3p1:RMAItem>
        <d3p1:CatalogID>1</d3p1:CatalogID>
        <d3p1:ItemName>sample string 2</d3p1:ItemName>
        <d3p1:ReceivedQuantity>1</d3p1:ReceivedQuantity>
        <d3p1:RestockQuantity>1</d3p1:RestockQuantity>
        <d3p1:ReturnQuantity>1</d3p1:ReturnQuantity>
        <d3p1:SKU>sample string 1</d3p1:SKU>
      </d3p1:RMAItem>
    </RMAItemList>
    <RMAMethodID>1</RMAMethodID>
    <RMAReasonID>1</RMAReasonID>
    <RMAStatusID>1</RMAStatusID>
    <RmaDate>2019-08-23T22:25:54.7641107-04:00</RmaDate>
    <StaffComments>sample string 3</StaffComments>
  </RMA>
</ArrayOfRMA>