NAV

ReturnGet

The following routes are available for this service:
GET	/returns/{RMANumber}

**ReturnGet** Parameters:
Name	Parameter	Data Type	Required	Description
RMANumber	path	string	No

**GetResponse<TEntity>** Parameters:
Name	Parameter	Data Type	Required	Description
Item	form	TEntity	No
ResponseStatus	form	ResponseStatus	No

**ReturnViewModel** Parameters:
Name	Parameter	Data Type	Required
BeeNumber	form	decimal	No
BeeNumberCustomer	form	decimal	No
EventId	form	int?	No
EventStartDate	form	DateTime?	No
MasterOrderId	form	int	No
MasterOrderIdParent	form	int	No
MasterOrderIdRelated	form	int?	No
OrderIdOutbound	form	int	No
CreatedDate	form	DateTime	No
UpdatedDate	form	DateTime	No
RmaNumber	form	string	No
BeeBusinessGuid	form	decimal	No
IsSubmitted	form	bool	No
SubmittedDate	form	DateTime?	No
ExportDate	form	DateTime?	No
RmaStatus	form	string	No
InboundReturnTotal	form	decimal?	No
OutboundTotal	form	decimal?	No
TaxAmount	form	decimal?	No
ShippingTaxAmount	form	decimal?	No
FeeTotal	form	decimal?	No
Total	form	decimal?	No
ShippingMethod	form	string	No
MasterOrderIdOutbound	form	int?	No
RmaNote	form	string	No
SubTotal	form	decimal?	No
ShippingAmount	form	decimal?	No
PaymentTotal	form	decimal?	No
CreditNotAppliedToProductAmount	form	decimal?	No
FeeTotalWaived	form	decimal?	No
OutboundOrderSavingsClubAmount	form	decimal?	No
InboundReplacementTotal	form	decimal?	No
InboundTaxAmount	form	decimal?	No
OutboundTaxAmount	form	decimal?	No
OutboundOrderTotal	form	decimal?	No
OutboundOrderCreditCardAmount	form	decimal?	No
OrderCreatedDate	form	DateTime?	No
ClosedDate	form	DateTime?	No
ActualShippingTaxAmount	form	decimal?	No
ActualShippingAmount	form	decimal?	No
ActualTaxAmount	form	decimal?	No
ActualInboundTaxAmount	form	decimal?	No
RmaCreditCardAmount	form	decimal?	No
RmaSavingsClubAmount	form	decimal?	No
ActualFeeTotal	form	decimal?	No
ActualFeeTotalWaived	form	decimal?	No
ActualTotal	form	decimal?	No
ActualSubTotal	form	decimal?	No
ActualInboundReturnTotal	form	decimal?	No
ActualInboundReplacementTotal	form	decimal?	No
ActualCreditNotAppliedToProductAmount	form	decimal?	No
TaxExportDate	form	DateTime?	No
TaxTransactionTime	form	DateTime?	No
TaxTransactionId	form	string	No
ReverseTaxExportDate	form	DateTime?	No
ReverseTaxTransactionTime	form	DateTime?	No
ReverseTaxTransactionId	form	string	No
FinalTax	form	decimal?	No
ReverseFinalTax	form	decimal?	No
ReuseableInboundTaxTransactionId	form	string	No
ReuseableOutboundTaxTransactionId	form	string	No
OrderId	form	int?	No
OrderNumber	form	string	No
Note	form	string	No
ClawbackCVOverride	form	bool	No
ClawbackQVOverride	form	bool	No
IssueGiftCard	form	bool	No
RmaGiftCardAmount	form	decimal?	No
BeeSavingsSerialGuid	form	decimal?	No
SerialNumber	form	string	No
GiftCardEmail	form	string	No
OrderCreatedDuringSubmit	form	bool	No
TotalQualifyingValue	form	decimal?	No
TotalCommissionableValue	form	decimal?	No
BeeSavingsClubGuid	form	decimal?	No
IsCancelOrder	form	bool?	No
CreatedBy	form	string	No
RmaSeverity	form	string	No
Reference	form	string	No
UserName	form	string	No
TotalOverrideCV	form	decimal?	No
TotalOverrideQV	form	decimal?	No
TotalUplineCV	form	decimal?	No
TotalUplineQV	form	decimal?	No
TotalGroupCV	form	decimal?	No
TotalGroupQV	form	decimal?	No
OverrideCV	form	decimal?	No
OverrideQV	form	decimal?	No
UplineCV	form	decimal?	No
UplineQV	form	decimal?	No
GroupCV	form	decimal?	No
GroupQV	form	decimal?	No
IssueCheck	form	bool	No
RmaCheckAmount	form	decimal?	No
ShippingAddress	form	AddressViewModel	No
InboundSkus	form	List<ReturnInboundSkuViewModel>	No
OutboundSkus	form	List<ReturnOutboundSkuViewModel>	No
ShipmentIssueSkus	form	List<ReturnShipmentIssueSkuViewModel>	No
Payments	form	List<ReturnPaymentViewModel>	No
Holds	form	List<ReturnHoldViewModel>	No

**AddressViewModel** Parameters:
Name	Parameter	Data Type	Required
FirstName	form	string	No
LastName	form	string	No
HouseNumber	form	string	No
AddressLine1	form	string	No
AddressLine2	form	string	No
AddressLine3	form	string	No
AddressLine4	form	string	No
AddressLine5	form	string	No
City	form	string	No
LocalityLevelID1	form	string	No
LocalityLevelID2	form	string	No
LocalityLevelID3	form	string	No
LocalityLevelID4	form	string	No
LocalityLevelID5	form	string	No
StateCode	form	string	No
PostalCode	form	string	No
CountryCode	form	string	No
AddressGoodDate	form	DateTime?	No
Latitude	form	decimal	No
Longitude	form	decimal	No
AddressId	form	int	No

**ReturnInboundSkuViewModel** Parameters:
Name	Parameter	Data Type	Required
RmaType	form	string	No
ReturnQuantity	form	int?	No
AutoReceivedQuantity	form	int?	No
OriginalQuantity	form	int?	No
ReturnQuantityOnClone	form	int?	No
ReasonType	form	string	No
SkuNote	form	string	No
OrderId	form	int?	No
OrderNumber	form	string	No
OrderSkuId	form	int?	No
OrderLineNumber	form	int?	No
FeeAmount	form	decimal?	No
ExtendedFeeAmount	form	decimal?	No
ReturnTaxAmount	form	decimal?	No
ReturnExtendedFeeAmount	form	decimal?	No
ReturnExtendedPrice	form	decimal?	No
Fees	form	List<ReturnFeeViewModel>	No

**ReturnOutboundSkuViewModel** Parameters:
Name	Parameter	Data Type	Required
EntitySkuId	form	int	No
CreatedDate	form	DateTime	No
UpdatedDate	form	DateTime	No
LineNumber	form	int	No
SkuId	form	int	No
SkuCode	form	string	No
WarehouseSkuCode	form	string	No
Quantity	form	int	No
Price	form	decimal?	No
ExtendedPrice	form	decimal?	No
PriceOverride	form	decimal?	No
TaxablePrice	form	decimal?	No
TaxAmount	form	decimal?	No
OrderedQuantity	form	int?	No
ReturnTaxablePrice	form	decimal?	No

**ReturnFeeViewModel** Parameters:
Name	Parameter	Data Type	Required
RmaFeeId	form	int	No
CreatedDate	form	DateTime	No
UpdatedDate	form	DateTime	No
IsFeeWaived	form	bool	No
UsernameFeeWaived	form	string	No
WaivedNote	form	string	No
FeeId	form	string	No

**ReturnShipmentIssueSkuViewModel** Parameters:
Name	Parameter	Data Type	Required
RMAShipmentIssueSkuId	form	int	No
CreatedDate	form	DateTime	No
UpdatedDate	form	DateTime	No
LineNumber	form	int	No
SkuId	form	int	No
SkuCode	form	string	No
WarehouseSkuCode	form	string	No
Quantity	form	int	No
Price	form	decimal?	No
ExtendedPrice	form	decimal?	No
PriceOverride	form	decimal?	No

**ReturnPaymentViewModel** Parameters:
Name	Parameter	Data Type	Required
PaymentId	form	int	No
PaymentType	form	string	No
CreditCardType	form	string	No
CreditCardName	form	string	No
CreditCardNumber	form	string	No
CreditCardToken	form	string	No
PaymentGuid	form	string	No
CreditCardExpired	form	string	No
AuthorizationCode	form	string	No
BankAccountNumber	form	string	No
BankRoutingNumber	form	string	No
BankAccountType	form	string	No
BankName	form	string	No
BankAccountName	form	string	No
LicenseNumber	form	string	No
LicenseDOB	form	string	No
LicenseState	form	string	No
CheckNumber	form	string	No
SavingsClub	form	string	No
Charge	form	decimal	No
RmaEnteredRefund	form	decimal?	No
TextResponse	form	string	No
Processed	form	bool	No
ConfirmationCode	form	string	No
AuthorizationTime	form	DateTime?	No
BillingAddress	form	AddressViewModel	No
TransactionId	form	string	No
AVS	form	string	No
BalancingPayment	form	bool	No
SerialNumber	form	string	No
PaymentExportKeyword	form	string	No

**ReturnHoldViewModel** Parameters:
Name	Parameter	Data Type	Required
RmaHoldId	form	int	No
CreatedDate	form	DateTime	No
UpdatedDate	form	DateTime	No
ReleaseDate	form	DateTime?	No
UsernameRelease	form	string	No
HoldReason	form	string	No
HoldNote	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /returns/{RMANumber} HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	item: 
	{
		beeNumber: 0,
		beeNumberCustomer: 0,
		eventId: 0,
		eventStartDate: 0001-01-01T00:00:00,
		masterOrderId: 0,
		masterOrderIdParent: 0,
		masterOrderIdRelated: 0,
		orderIdOutbound: 0,
		createdDate: 0001-01-01T00:00:00,
		updatedDate: 0001-01-01T00:00:00,
		rmaNumber: String,
		beeBusinessGuid: 0,
		isSubmitted: False,
		submittedDate: 0001-01-01T00:00:00,
		exportDate: 0001-01-01T00:00:00,
		rmaStatus: String,
		inboundReturnTotal: 0,
		outboundTotal: 0,
		taxAmount: 0,
		shippingTaxAmount: 0,
		feeTotal: 0,
		total: 0,
		shippingMethod: String,
		masterOrderIdOutbound: 0,
		rmaNote: String,
		subTotal: 0,
		shippingAmount: 0,
		paymentTotal: 0,
		creditNotAppliedToProductAmount: 0,
		feeTotalWaived: 0,
		outboundOrderSavingsClubAmount: 0,
		inboundReplacementTotal: 0,
		inboundTaxAmount: 0,
		outboundTaxAmount: 0,
		outboundOrderTotal: 0,
		outboundOrderCreditCardAmount: 0,
		orderCreatedDate: 0001-01-01T00:00:00,
		closedDate: 0001-01-01T00:00:00,
		actualShippingTaxAmount: 0,
		actualShippingAmount: 0,
		actualTaxAmount: 0,
		actualInboundTaxAmount: 0,
		rmaCreditCardAmount: 0,
		rmaSavingsClubAmount: 0,
		actualFeeTotal: 0,
		actualFeeTotalWaived: 0,
		actualTotal: 0,
		actualSubTotal: 0,
		actualInboundReturnTotal: 0,
		actualInboundReplacementTotal: 0,
		actualCreditNotAppliedToProductAmount: 0,
		taxExportDate: 0001-01-01T00:00:00,
		taxTransactionTime: 0001-01-01T00:00:00,
		taxTransactionId: String,
		reverseTaxExportDate: 0001-01-01T00:00:00,
		reverseTaxTransactionTime: 0001-01-01T00:00:00,
		reverseTaxTransactionId: String,
		finalTax: 0,
		reverseFinalTax: 0,
		reuseableInboundTaxTransactionId: String,
		reuseableOutboundTaxTransactionId: String,
		orderId: 0,
		orderNumber: String,
		note: String,
		clawbackCVOverride: False,
		clawbackQVOverride: False,
		issueGiftCard: False,
		rmaGiftCardAmount: 0,
		beeSavingsSerialGuid: 0,
		serialNumber: String,
		giftCardEmail: String,
		orderCreatedDuringSubmit: False,
		totalQualifyingValue: 0,
		totalCommissionableValue: 0,
		beeSavingsClubGuid: 0,
		isCancelOrder: False,
		createdBy: String,
		rmaSeverity: String,
		reference: String,
		userName: String,
		totalOverrideCV: 0,
		totalOverrideQV: 0,
		totalUplineCV: 0,
		totalUplineQV: 0,
		totalGroupCV: 0,
		totalGroupQV: 0,
		overrideCV: 0,
		overrideQV: 0,
		uplineCV: 0,
		uplineQV: 0,
		groupCV: 0,
		groupQV: 0,
		issueCheck: False,
		rmaCheckAmount: 0,
		shippingAddress: 
		{
			firstName: String,
			lastName: String,
			houseNumber: String,
			addressLine1: String,
			addressLine2: String,
			addressLine3: String,
			addressLine4: String,
			addressLine5: String,
			city: String,
			localityLevelID1: String,
			localityLevelID2: String,
			localityLevelID3: String,
			localityLevelID4: String,
			localityLevelID5: String,
			stateCode: String,
			postalCode: String,
			countryCode: String,
			addressGoodDate: 0001-01-01T00:00:00,
			latitude: 0,
			longitude: 0,
			addressId: 0
		},
		inboundSkus: 
		[
			{
				rmaType: String,
				returnQuantity: 0,
				autoReceivedQuantity: 0,
				originalQuantity: 0,
				returnQuantityOnClone: 0,
				reasonType: String,
				skuNote: String,
				orderId: 0,
				orderNumber: String,
				orderSkuId: 0,
				orderLineNumber: 0,
				feeAmount: 0,
				extendedFeeAmount: 0,
				returnTaxAmount: 0,
				returnExtendedFeeAmount: 0,
				returnExtendedPrice: 0,
				fees: 
				[
					{
						rmaFeeId: 0,
						createdDate: 0001-01-01T00:00:00,
						updatedDate: 0001-01-01T00:00:00,
						isFeeWaived: False,
						usernameFeeWaived: String,
						waivedNote: String,
						feeId: String
					}
				],
				entitySkuId: 0,
				createdDate: 0001-01-01T00:00:00,
				updatedDate: 0001-01-01T00:00:00,
				lineNumber: 0,
				skuId: 0,
				skuCode: String,
				warehouseSkuCode: String,
				quantity: 0,
				price: 0,
				extendedPrice: 0,
				priceOverride: 0,
				taxablePrice: 0,
				taxAmount: 0,
				orderedQuantity: 0,
				returnTaxablePrice: 0
			}
		],
		outboundSkus: 
		[
			{
				entitySkuId: 0,
				createdDate: 0001-01-01T00:00:00,
				updatedDate: 0001-01-01T00:00:00,
				lineNumber: 0,
				skuId: 0,
				skuCode: String,
				warehouseSkuCode: String,
				quantity: 0,
				price: 0,
				extendedPrice: 0,
				priceOverride: 0,
				taxablePrice: 0,
				taxAmount: 0,
				orderedQuantity: 0,
				returnTaxablePrice: 0
			}
		],
		shipmentIssueSkus: 
		[
			{
				rmaShipmentIssueSkuId: 0,
				createdDate: 0001-01-01T00:00:00,
				updatedDate: 0001-01-01T00:00:00,
				lineNumber: 0,
				skuId: 0,
				skuCode: String,
				warehouseSkuCode: String,
				quantity: 0,
				price: 0,
				extendedPrice: 0,
				priceOverride: 0
			}
		],
		payments: 
		[
			{
				paymentId: 0,
				paymentType: String,
				creditCardType: String,
				creditCardName: String,
				creditCardNumber: String,
				creditCardToken: String,
				paymentGuid: String,
				creditCardExpired: String,
				authorizationCode: String,
				bankAccountNumber: String,
				bankRoutingNumber: String,
				bankAccountType: String,
				bankName: String,
				bankAccountName: String,
				licenseNumber: String,
				licenseDOB: String,
				licenseState: String,
				checkNumber: String,
				savingsClub: String,
				charge: 0,
				rmaEnteredRefund: 0,
				textResponse: String,
				processed: False,
				confirmationCode: String,
				authorizationTime: 0001-01-01T00:00:00,
				billingAddress: 
				{
					firstName: String,
					lastName: String,
					houseNumber: String,
					addressLine1: String,
					addressLine2: String,
					addressLine3: String,
					addressLine4: String,
					addressLine5: String,
					city: String,
					localityLevelID1: String,
					localityLevelID2: String,
					localityLevelID3: String,
					localityLevelID4: String,
					localityLevelID5: String,
					stateCode: String,
					postalCode: String,
					countryCode: String,
					addressGoodDate: 0001-01-01T00:00:00,
					latitude: 0,
					longitude: 0,
					addressId: 0
				},
				transactionId: String,
				avs: String,
				balancingPayment: False,
				serialNumber: String,
				paymentExportKeyword: String
			}
		],
		holds: 
		[
			{
				rmaHoldId: 0,
				createdDate: 0001-01-01T00:00:00,
				updatedDate: 0001-01-01T00:00:00,
				releaseDate: 0001-01-01T00:00:00,
				usernameRelease: String,
				holdReason: String,
				holdNote: String
			}
		]
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}