Table of Contents

Class ReturnMerchandiseAuthorization

Namespace
Dynamicweb.Ecommerce.Orders.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

string

CustomerAddress2

Gets or sets rma customer address(2nd line).

public string CustomerAddress2 { get; set; }

Property Value

string

CustomerCell

Gets or sets rma customer mobile phone number.

public string CustomerCell { get; set; }

Property Value

string

CustomerCity

Gets or sets rma customer city.

public string CustomerCity { get; set; }

Property Value

string

CustomerCompany

Gets or sets rma customer company name.

public string CustomerCompany { get; set; }

Property Value

string

CustomerCountry

Gets or sets rma customer country.

public string CustomerCountry { get; set; }

Property Value

string

CustomerCountryCode

Gets or sets rma customer country code.

public string CustomerCountryCode { get; set; }

Property Value

string

CustomerEan

Gets or sets rma customer EAN number.

public string CustomerEan { get; set; }

Property Value

string

CustomerEmail

Gets or sets rma customer e-mail.

public string CustomerEmail { get; set; }

Property Value

string

CustomerFax

Gets or sets rma customer fax number.

public string CustomerFax { get; set; }

Property Value

string

CustomerName

Gets or sets rma customer name.

public string CustomerName { get; set; }

Property Value

string

CustomerNumber

Gets or sets rma customer number.

public string CustomerNumber { get; set; }

Property Value

string

CustomerPhone

Gets or sets rma customer phone number.

public string CustomerPhone { get; set; }

Property Value

string

CustomerRefId

Gets or sets rma customer referral id.

public string CustomerRefId { get; set; }

Property Value

string

CustomerRegion

Gets or sets rma customer region.

public string CustomerRegion { get; set; }

Property Value

string

CustomerVatRegNumber

Gets or sets rma customer VAT registration number.

public string CustomerVatRegNumber { get; set; }

Property Value

string

CustomerZip

Gets or sets rma customer zip code.

public string CustomerZip { get; set; }

Property Value

string

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

string

DeliveryAddress2

Gets or sets rma delivery address(2nd line).

public string DeliveryAddress2 { get; set; }

Property Value

string

DeliveryCell

Gets or sets rma delivery mobile phone number.

public string DeliveryCell { get; set; }

Property Value

string

DeliveryCity

Gets or sets rma delivery city.

public string DeliveryCity { get; set; }

Property Value

string

DeliveryCompany

Gets or sets rma delivery company name.

public string DeliveryCompany { get; set; }

Property Value

string

DeliveryCountry

Gets or sets rma delivery country.

public string DeliveryCountry { get; set; }

Property Value

string

DeliveryCountryCode

Gets or sets rma delivery country code.

public string DeliveryCountryCode { get; set; }

Property Value

string

DeliveryEmail

Gets or sets rma delivery e-mail.

public string DeliveryEmail { get; set; }

Property Value

string

DeliveryFax

Gets or sets rma delivery fax number.

public string DeliveryFax { get; set; }

Property Value

string

DeliveryName

Gets or sets rma delivery name.

public string DeliveryName { get; set; }

Property Value

string

DeliveryPhone

Gets or sets rma delivery phone number.

public string DeliveryPhone { get; set; }

Property Value

string

DeliveryRegion

Gets or sets rma delivery region.

public string DeliveryRegion { get; set; }

Property Value

string

DeliveryZip

Gets or sets rma delivery zip code.

public string DeliveryZip { get; set; }

Property Value

string

EmailNotificationLanguage 

public string EmailNotificationLanguage { get; set; }

Property Value

string

History

Gets the history of this ReturnMerchandiseAuthorization.

public ReturnMerchandiseAuthorizationCommentCollection History { get; }

Property Value

ReturnMerchandiseAuthorizationCommentCollection

Id

Gets the id.

public string Id { get; set; }

Property Value

string

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

ReturnMerchandiseAuthorizationOrderlineCollection

ReplacementOrder

Gets the replacement order. If no replacement order exists then null is returned.

public Order ReplacementOrder { get; set; }

Property Value

Order

State

Gets the current ReturnMerchandiseAuthorizationState for this ReturnMerchandiseAuthorization.

public ReturnMerchandiseAuthorizationState State { get; }

Property Value

ReturnMerchandiseAuthorizationState

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

ReturnMerchandiseAuthorizationType

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

comment string

The comment.

commentImage string

The comment image.

AddOrderLine(OrderLine, string)

Adds the OrderLine to this ReturnMerchandiseAuthorization.

public void AddOrderLine(OrderLine orderLine, string serialNumber)

Parameters

orderLine OrderLine

The OrderLine.

serialNumber string

Clone()

Clones this rma instance.

public ReturnMerchandiseAuthorization Clone()

Returns

ReturnMerchandiseAuthorization

The cloned instance.

Delete()

Deletes this instance.

public void Delete()

GetAllAvailableOrdersByCustomerId(long, bool, bool)

Get all available orders for rma by customer id

public static ICollection<Order> GetAllAvailableOrdersByCustomerId(long customerId, bool includeOrders = true, bool includeLedgers = true)

Parameters

customerId long

The customer id.

includeOrders bool
includeLedgers bool

Returns

ICollection<Order>

GetAllAvailableOrdersByCustomerId(long, string, bool, bool)

Get all available orders for rma by customer and shop id

public static ICollection<Order> GetAllAvailableOrdersByCustomerId(long customerId, string shopIDs, bool includeOrders = true, bool includeLedgers = true)

Parameters

customerId long

The customer id.

shopIDs string

The shops IDs.

includeOrders bool
includeLedgers bool

Returns

ICollection<Order>

GetAllAvailableOrdersByCustomerNumber(string, bool, bool)

Get all available orders for rma by customer number

public static ICollection<Order> GetAllAvailableOrdersByCustomerNumber(string customerNumber, bool includeOrders = true, bool includeLedgers = true)

Parameters

customerNumber string

Customer number

includeOrders bool

Include orders

includeLedgers bool

Include ledgers

Returns

ICollection<Order>

GetAllRmas()

Gets a ReturnMerchandiseAuthorizationCollection containing all ReturnMerchandiseAuthorization objects.

public static ReturnMerchandiseAuthorizationCollection GetAllRmas()

Returns

ReturnMerchandiseAuthorizationCollection

GetAvailableOrderLines(Order)

Gets information about available order lines.

public static Dictionary<string, int> GetAvailableOrderLines(Order order)

Parameters

order Order

The order.

Returns

Dictionary<string, int>

The dictionary with available order lines information. The key is order line id, and the value is available product quantity.

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

ReturnMerchandiseAuthorization

GetRmaByReplacementOrderId(string)

Gets the ReturnMerchandiseAuthorization associated with the replacement Order id.

public static ReturnMerchandiseAuthorization GetRmaByReplacementOrderId(string orderId)

Parameters

orderId string

The replacement Order id.

Returns

ReturnMerchandiseAuthorization

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

ReturnMerchandiseAuthorizationCollection

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

ReturnMerchandiseAuthorizationCollection

GetRmasByOrderId(string)

Gets a ReturnMerchandiseAuthorizationCollection containing all ReturnMerchandiseAuthorization objects associated with the Order id.

public static ReturnMerchandiseAuthorizationCollection GetRmasByOrderId(string orderId)

Parameters

orderId string

The Order id.

Returns

ReturnMerchandiseAuthorizationCollection

GetRmasByOrderLineId(string)

Gets a ReturnMerchandiseAuthorizationCollection containing all ReturnMerchandiseAuthorization associated with the Id of the OrderLine.

public static ReturnMerchandiseAuthorizationCollection GetRmasByOrderLineId(string orderLineId)

Parameters

orderLineId string

The Id of the OrderLine.

Returns

ReturnMerchandiseAuthorizationCollection

GetRmasByShopId(string)

Gets a ReturnMerchandiseAuthorizationCollection containing all ReturnMerchandiseAuthorization objects associated with the Shop id.

public static ReturnMerchandiseAuthorizationCollection GetRmasByShopId(string shopId)

Parameters

shopId string

The ID of the Shop.

Returns

ReturnMerchandiseAuthorizationCollection

HasRmaWithStateId(int)

Check is the specified state Id in use.

public static bool HasRmaWithStateId(int stateId)

Parameters

stateId int

The state Id.

Returns

bool

Save()

Saves this instance.

public void Save()

SetCustomerInfoOnOrder(Order) 

public void SetCustomerInfoOnOrder(Order order)

Parameters

order Order
Improve this doc
To top