Class ReturnMerchandiseAuthorization
- Assembly
- Dynamicweb.Ecommerce.dll
The class ReturnMerchandiseAuthorization represent returning a product in order to receive a refund, replacement, or repair.
public class ReturnMerchandiseAuthorization
- Inheritance
-
ReturnMerchandiseAuthorization
- Inherited Members
Constructors
ReturnMerchandiseAuthorization()
Initializes a new instance of the ReturnMerchandiseAuthorization class.
public ReturnMerchandiseAuthorization()
Properties
Closed
Gets or sets a value indicating whether this ReturnMerchandiseAuthorization is closed.
public bool Closed { get; set; }
Property Value
- bool
true
if closed; otherwise,false
.
CustomerAddress
Gets or sets rma customer address.
public string CustomerAddress { get; set; }
Property Value
CustomerAddress2
Gets or sets rma customer address(2nd line).
public string CustomerAddress2 { get; set; }
Property Value
CustomerCell
Gets or sets rma customer mobile phone number.
public string CustomerCell { get; set; }
Property Value
CustomerCity
Gets or sets rma customer city.
public string CustomerCity { get; set; }
Property Value
CustomerCompany
Gets or sets rma customer company name.
public string CustomerCompany { get; set; }
Property Value
CustomerCountry
Gets or sets rma customer country.
public string CustomerCountry { get; set; }
Property Value
CustomerCountryCode
Gets or sets rma customer country code.
public string CustomerCountryCode { get; set; }
Property Value
CustomerEan
Gets or sets rma customer EAN number.
public string CustomerEan { get; set; }
Property Value
CustomerEmail
Gets or sets rma customer e-mail.
public string CustomerEmail { get; set; }
Property Value
CustomerFax
Gets or sets rma customer fax number.
public string CustomerFax { get; set; }
Property Value
CustomerName
Gets or sets rma customer name.
public string CustomerName { get; set; }
Property Value
CustomerNumber
Gets or sets rma customer number.
public string CustomerNumber { get; set; }
Property Value
CustomerPhone
Gets or sets rma customer phone number.
public string CustomerPhone { get; set; }
Property Value
CustomerRefId
Gets or sets rma customer referral id.
public string CustomerRefId { get; set; }
Property Value
CustomerRegion
Gets or sets rma customer region.
public string CustomerRegion { get; set; }
Property Value
CustomerVatRegNumber
Gets or sets rma customer VAT registration number.
public string CustomerVatRegNumber { get; set; }
Property Value
CustomerZip
Gets or sets rma customer zip code.
public string CustomerZip { get; set; }
Property Value
Deleted
Gets or sets a value indicating whether this ReturnMerchandiseAuthorization is deleted.
public bool Deleted { get; set; }
Property Value
- bool
true
if deleted; otherwise,false
.
DeliveryAddress
Gets or sets rma delivery address.
public string DeliveryAddress { get; set; }
Property Value
DeliveryAddress2
Gets or sets rma delivery address(2nd line).
public string DeliveryAddress2 { get; set; }
Property Value
DeliveryCell
Gets or sets rma delivery mobile phone number.
public string DeliveryCell { get; set; }
Property Value
DeliveryCity
Gets or sets rma delivery city.
public string DeliveryCity { get; set; }
Property Value
DeliveryCompany
Gets or sets rma delivery company name.
public string DeliveryCompany { get; set; }
Property Value
DeliveryCountry
Gets or sets rma delivery country.
public string DeliveryCountry { get; set; }
Property Value
DeliveryCountryCode
Gets or sets rma delivery country code.
public string DeliveryCountryCode { get; set; }
Property Value
DeliveryEmail
Gets or sets rma delivery e-mail.
public string DeliveryEmail { get; set; }
Property Value
DeliveryFax
Gets or sets rma delivery fax number.
public string DeliveryFax { get; set; }
Property Value
DeliveryName
Gets or sets rma delivery name.
public string DeliveryName { get; set; }
Property Value
DeliveryPhone
Gets or sets rma delivery phone number.
public string DeliveryPhone { get; set; }
Property Value
DeliveryRegion
Gets or sets rma delivery region.
public string DeliveryRegion { get; set; }
Property Value
DeliveryZip
Gets or sets rma delivery zip code.
public string DeliveryZip { get; set; }
Property Value
EmailNotificationLanguage
public string EmailNotificationLanguage { get; set; }
Property Value
History
Gets the history of this ReturnMerchandiseAuthorization.
public ReturnMerchandiseAuthorizationCommentCollection History { get; }
Property Value
Id
Gets the id.
public string Id { get; set; }
Property Value
IsNew
Gets a value indicating whether this instance is new.
public bool IsNew { get; }
Property Value
- bool
true
if this instance is new; otherwise,false
.
OrderLines
Gets rma order lines.
public ReturnMerchandiseAuthorizationOrderlineCollection OrderLines { get; }
Property Value
ReplacementOrder
Gets the replacement order. If no replacement order exists then null is returned.
public Order ReplacementOrder { get; set; }
Property Value
State
Gets the current ReturnMerchandiseAuthorizationState for this ReturnMerchandiseAuthorization.
public ReturnMerchandiseAuthorizationState State { get; }
Property Value
StateId
Gets or sets the ID of the ReturnMerchandiseAuthorizationState that this ReturnMerchandiseAuthorization is currently in.
Can be used to change ReturnMerchandiseAuthorizationState.
public int StateId { get; set; }
Property Value
- int
- The ID of the ReturnMerchandiseAuthorizationState.
Type
Gets or sets the type. The type can either be ProductReturn or ProductDefect.
public ReturnMerchandiseAuthorizationType Type { get; set; }
Property Value
Methods
AddComment(string, ReturnMerchandiseAuthorizationCommentImageCollection)
Adds the comment with a ReturnMerchandiseAuthorizationCommentImageCollection to the History for this ReturnMerchandiseAuthorization.
public void AddComment(string comment, ReturnMerchandiseAuthorizationCommentImageCollection images)
Parameters
comment
string- The comment.
images
ReturnMerchandiseAuthorizationCommentImageCollection
AddComment(string, string)
Adds the comment to the History for this ReturnMerchandiseAuthorization.
public void AddComment(string comment, string commentImage = "")
Parameters
AddOrderLine(OrderLine, string)
Adds the OrderLine to this ReturnMerchandiseAuthorization.
public void AddOrderLine(OrderLine orderLine, string serialNumber)
Parameters
Clone()
Clones this rma instance.
public ReturnMerchandiseAuthorization Clone()
Returns
- ReturnMerchandiseAuthorization
- The cloned instance.
Delete()
Deletes this instance.
public void Delete()
GetAllAvailableOrdersByCustomerId(long, bool, bool)
public static OrderCollection GetAllAvailableOrdersByCustomerId(long customerId, bool includeOrders = true, bool includeLedgers = true)
Parameters
Returns
GetAllAvailableOrdersByCustomerId(long, string, bool, bool)
public static OrderCollection GetAllAvailableOrdersByCustomerId(long customerId, string shopIDs, bool includeOrders = true, bool includeLedgers = true)
Parameters
customerId
longshopIDs
stringincludeOrders
bool- Include orders
includeLedgers
bool- Include ledgers
Returns
GetAllAvailableOrdersByCustomerNumber(string, bool, bool)
Get all available orders for rma by customer number
public static OrderCollection GetAllAvailableOrdersByCustomerNumber(string customerNumber, bool includeOrders = true, bool includeLedgers = true)
Parameters
customerNumber
string- Customer number
includeOrders
bool- Include orders
includeLedgers
bool- Include ledgers
Returns
GetAllRmas()
Gets a ReturnMerchandiseAuthorizationCollection containing all ReturnMerchandiseAuthorization objects.
public static ReturnMerchandiseAuthorizationCollection GetAllRmas()
Returns
GetCustomerId()
Get rma customer user Id
public int GetCustomerId()
Returns
- int
- Returns User Id if successfully, otherwise 0
GetOrder()
Get rma order from order lines
public Order GetOrder()
Returns
- Order
- Returns Order if successfully, otherwise Nothing
GetRmaById(string)
Gets the ReturnMerchandiseAuthorization by id.
public static ReturnMerchandiseAuthorization GetRmaById(string id)
Parameters
id
string- The id.
Returns
GetRmaByReplacementOrderId(string)
Gets the ReturnMerchandiseAuthorization associated with the replacement Order id.
public static ReturnMerchandiseAuthorization GetRmaByReplacementOrderId(string orderId)
Parameters
Returns
GetRmasByCustomerId(long, string, string)
Get MerchandiseAuthorizationCollection By Customer Id
[Obsolete]
public static ReturnMerchandiseAuthorizationCollection GetRmasByCustomerId(long customerId, string sortColumn, string sortOrder)
Parameters
customerId
long- The customer id.
sortColumn
string- The column used for sorting.
sortOrder
string- The sorting order.
Returns
GetRmasByCustomerId(long, string, string, string)
Get MerchandiseAuthorizationCollection By Customer and shop Id
[Obsolete]
public static ReturnMerchandiseAuthorizationCollection GetRmasByCustomerId(long customerId, string shopIDs, string sortColumn, string sortOrder)
Parameters
customerId
long- The customer id.
shopIDs
string- The shops IDs.
sortColumn
string- The column used for sorting.
sortOrder
string- The sorting order.
Returns
GetRmasByCustomerId(long, string, string, string, string)
Get MerchandiseAuthorizationCollection By Customer and shop Id
public static ReturnMerchandiseAuthorizationCollection GetRmasByCustomerId(long customerId, string shopIDs, string orderContextIDs, string sortColumn, string sortOrder)
Parameters
customerId
long- The customer id.
shopIDs
string- The shops IDs.
orderContextIDs
string- The order contexts ids
sortColumn
string- The column used for sorting.
sortOrder
string- The sorting order.
Returns
GetRmasByCustomerNumber(string, string, string, string)
Get MerchandiseAuthorizationCollection By Customer number
[Obsolete]
public static ReturnMerchandiseAuthorizationCollection GetRmasByCustomerNumber(string customerNumber, string shopIDs, string sortColumn, string sortOrder)
Parameters
customerNumber
string- Customer number
shopIDs
string- The shops IDs.
sortColumn
string- The column used for sorting.
sortOrder
string- The sorting order.
Returns
GetRmasByCustomerNumber(string, string, string, string, string)
Get MerchandiseAuthorizationCollection By Customer number
public static ReturnMerchandiseAuthorizationCollection GetRmasByCustomerNumber(string customerNumber, string shopIDs, string orderContextIDs, string sortColumn, string sortOrder)
Parameters
customerNumber
string- Customer number
shopIDs
string- The shops IDs.
orderContextIDs
string- The order contexts ids
sortColumn
string- The column used for sorting.
sortOrder
string- The sorting order.
Returns
GetRmasByOrderId(string)
Gets a ReturnMerchandiseAuthorizationCollection containing all ReturnMerchandiseAuthorization objects associated with the Order id.
public static ReturnMerchandiseAuthorizationCollection GetRmasByOrderId(string orderId)
Parameters
Returns
GetRmasByOrderLineId(string)
Gets a ReturnMerchandiseAuthorizationCollection containing all ReturnMerchandiseAuthorization associated with the Id of the OrderLine.
public static ReturnMerchandiseAuthorizationCollection GetRmasByOrderLineId(string orderLineId)
Parameters
Returns
GetRmasByShopId(string)
Gets a ReturnMerchandiseAuthorizationCollection containing all ReturnMerchandiseAuthorization objects associated with the Shop id.
public static ReturnMerchandiseAuthorizationCollection GetRmasByShopId(string shopId)
Parameters
Returns
HasRmaWithStateId(int)
Check is the specified state Id in use.
public static bool HasRmaWithStateId(int stateId)
Parameters
stateId
int- The state Id.
Returns
Save()
Saves this instance.
public void Save()
SetCustomerInfoOnOrder(Order)
public void SetCustomerInfoOnOrder(Order order)
Parameters
order
Order