POST rma?customerNumber={customerNumber}

Create RMA

Request Information

URI Parameters

Name	Description	Type	Additional information
customerNumber		string	None.

Body Parameters

CreateRMARequest

Name	Description	Type	Additional information
CustomerNumber	Your ScanSource customer number	string	Max length: 10
PONumber	Your Purchase Order Number	string	Required
SalesRepName	Your sales rep name	string	None.
ContactName	Contact name for RMA	string	Required
ContactPhone	Contact phone number for RMA	string	Required
ContactFax	Contact fax number for RMA	string	None.
ContactEmail	Contact email number for RMA	string	Required
PartnerReturnNumber	Partner return number	string	None.
BoxFactorySealed	Flag indicating return factory sealed	boolean	None.
DOA	Flag indicating dead on arrival	boolean	None.
ReplacementNeeded	Flag indiciating replacement part requested	boolean	None.
Overnight	Flag indicating replacement sent overnight delivery	boolean	None.
NumberBoxes	Number of boxes to return	integer	None.
ShippingAddressContactName	Shipping Address Contact name	string	None.
ShippingAddressContactPhone	Shipping Address Contact phone	string	None.
ShippingAddress	Shipping Address	Address	None.
ReturnAddressType	Specifies Return Address Type (BillTo, ShipTo, Other) 0 – BillTo 1 – ShipTo 2 – Other	ReturnAddressType	None.
ReturnAddressContactName	Return Address Contact name	string	None.
ReturnAddressContactPhone	Return Address Contact phone	string	None.
ReturnAddressContactEmail	Return Address Contact email	string	None.
ReturnAddress	Return address	Address	None.
Comments	Comments for RMA	string	None.
lines	RMA line details	Collection of CreateRMALine	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerNumber": "sample string 1",
  "PONumber": "sample string 2",
  "SalesRepName": "sample string 3",
  "ContactName": "sample string 4",
  "ContactPhone": "sample string 5",
  "ContactFax": "sample string 6",
  "ContactEmail": "sample string 7",
  "PartnerReturnNumber": "sample string 8",
  "BoxFactorySealed": true,
  "DOA": true,
  "ReplacementNeeded": true,
  "Overnight": true,
  "NumberBoxes": 13,
  "ShippingAddressContactName": "sample string 14",
  "ShippingAddressContactPhone": "sample string 15",
  "ShippingAddress": {
    "Name": "sample string 1",
    "Attn": "sample string 2",
    "Street1": "sample string 3",
    "Street2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "PostalCode": "sample string 7",
    "Country": "sample string 8"
  },
  "ReturnAddressType": 0,
  "ReturnAddressContactName": "sample string 16",
  "ReturnAddressContactPhone": "sample string 17",
  "ReturnAddressContactEmail": "sample string 18",
  "ReturnAddress": {
    "Name": "sample string 1",
    "Attn": "sample string 2",
    "Street1": "sample string 3",
    "Street2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "PostalCode": "sample string 7",
    "Country": "sample string 8"
  },
  "Comments": "sample string 19",
  "lines": [
    {
      "InvoiceNumber": "sample string 1",
      "ItemNumber": "sample string 2",
      "Quantity": 3,
      "SerialNumber": "sample string 4",
      "Reason": 0,
      "ProblemDetail": "sample string 5"
    },
    {
      "InvoiceNumber": "sample string 1",
      "ItemNumber": "sample string 2",
      "Quantity": 3,
      "SerialNumber": "sample string 4",
      "Reason": 0,
      "ProblemDetail": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<CreateRMARequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerNumber>sample string 1</CustomerNumber>
  <PONumber>sample string 2</PONumber>
  <SalesRepName>sample string 3</SalesRepName>
  <ContactName>sample string 4</ContactName>
  <ContactPhone>sample string 5</ContactPhone>
  <ContactFax>sample string 6</ContactFax>
  <ContactEmail>sample string 7</ContactEmail>
  <PartnerReturnNumber>sample string 8</PartnerReturnNumber>
  <BoxFactorySealed>true</BoxFactorySealed>
  <DOA>true</DOA>
  <ReplacementNeeded>true</ReplacementNeeded>
  <Overnight>true</Overnight>
  <NumberBoxes>13</NumberBoxes>
  <ShippingAddressContactName>sample string 14</ShippingAddressContactName>
  <ShippingAddressContactPhone>sample string 15</ShippingAddressContactPhone>
  <ShippingAddress>
    <Name>sample string 1</Name>
    <Attn>sample string 2</Attn>
    <Street1>sample string 3</Street1>
    <Street2>sample string 4</Street2>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <PostalCode>sample string 7</PostalCode>
    <Country>sample string 8</Country>
  </ShippingAddress>
  <ReturnAddressType>BillTo</ReturnAddressType>
  <ReturnAddressContactName>sample string 16</ReturnAddressContactName>
  <ReturnAddressContactPhone>sample string 17</ReturnAddressContactPhone>
  <ReturnAddressContactEmail>sample string 18</ReturnAddressContactEmail>
  <ReturnAddress>
    <Name>sample string 1</Name>
    <Attn>sample string 2</Attn>
    <Street1>sample string 3</Street1>
    <Street2>sample string 4</Street2>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <PostalCode>sample string 7</PostalCode>
    <Country>sample string 8</Country>
  </ReturnAddress>
  <Comments>sample string 19</Comments>
  <lines>
    <CreateRMALine>
      <InvoiceNumber>sample string 1</InvoiceNumber>
      <ItemNumber>sample string 2</ItemNumber>
      <Quantity>3</Quantity>
      <SerialNumber>sample string 4</SerialNumber>
      <Reason>CustomerError</Reason>
      <ProblemDetail>sample string 5</ProblemDetail>
    </CreateRMALine>
    <CreateRMALine>
      <InvoiceNumber>sample string 1</InvoiceNumber>
      <ItemNumber>sample string 2</ItemNumber>
      <Quantity>3</Quantity>
      <SerialNumber>sample string 4</SerialNumber>
      <Reason>CustomerError</Reason>
      <ProblemDetail>sample string 5</ProblemDetail>
    </CreateRMALine>
  </lines>
</CreateRMARequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateRMAResponse

Name	Description	Type	Additional information
RMARequestCreated	Flag indicating if RMA request created, if false see Error Description	boolean	None.
Message	Response message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "RMARequestCreated": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<CreateRMAResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RMARequestCreated>true</RMARequestCreated>
  <Message>sample string 2</Message>
</CreateRMAResponse>