| GET | /returns/{RMANumber} |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Nxnw.Adc.Order.ServiceModel
Imports Nxnw.Adc.Common.ServiceModel
Namespace Global
Namespace Nxnw.Adc.Common.ServiceModel
Public Partial Class AddressViewModel
Public Overridable Property FirstName As String
Public Overridable Property LastName As String
Public Overridable Property HouseNumber As String
Public Overridable Property AddressLine1 As String
Public Overridable Property AddressLine2 As String
Public Overridable Property AddressLine3 As String
Public Overridable Property AddressLine4 As String
Public Overridable Property AddressLine5 As String
Public Overridable Property City As String
Public Overridable Property LocalityLevelID1 As String
Public Overridable Property LocalityLevelID2 As String
Public Overridable Property LocalityLevelID3 As String
Public Overridable Property LocalityLevelID4 As String
Public Overridable Property LocalityLevelID5 As String
Public Overridable Property StateCode As String
Public Overridable Property PostalCode As String
Public Overridable Property CountryCode As String
Public Overridable Property AddressGoodDate As Nullable(Of Date)
Public Overridable Property Latitude As Decimal
Public Overridable Property Longitude As Decimal
Public Overridable Property AddressId As Integer
End Class
Public Partial Class GetResponse(Of TEntity)
Public Overridable Property Item As TEntity
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
Namespace Nxnw.Adc.Order.ServiceModel
Public Partial Class ReturnFeeViewModel
Public Overridable Property RmaFeeId As Integer
Public Overridable Property CreatedDate As Date
Public Overridable Property UpdatedDate As Date
Public Overridable Property IsFeeWaived As Boolean
Public Overridable Property UsernameFeeWaived As String
Public Overridable Property WaivedNote As String
Public Overridable Property FeeId As String
End Class
Public Partial Class ReturnGet
Implements IGet
Public Overridable Property RMANumber As String
End Class
Public Partial Class ReturnGetResponse
Inherits GetResponse(Of ReturnViewModel)
End Class
Public Partial Class ReturnHoldViewModel
Public Overridable Property RmaHoldId As Integer
Public Overridable Property CreatedDate As Date
Public Overridable Property UpdatedDate As Date
Public Overridable Property ReleaseDate As Nullable(Of Date)
Public Overridable Property UsernameRelease As String
Public Overridable Property HoldReason As String
Public Overridable Property HoldNote As String
End Class
Public Partial Class ReturnInboundSkuViewModel
Inherits ReturnOutboundSkuViewModel
Public Sub New()
Fees = New List(Of ReturnFeeViewModel)
End Sub
Public Overridable Property RmaType As String
Public Overridable Property ReturnQuantity As Nullable(Of Integer)
Public Overridable Property AutoReceivedQuantity As Nullable(Of Integer)
Public Overridable Property OriginalQuantity As Nullable(Of Integer)
Public Overridable Property ReturnQuantityOnClone As Nullable(Of Integer)
Public Overridable Property ReasonType As String
Public Overridable Property SkuNote As String
Public Overridable Property OrderId As Nullable(Of Integer)
Public Overridable Property OrderNumber As String
Public Overridable Property OrderSkuId As Nullable(Of Integer)
Public Overridable Property OrderLineNumber As Nullable(Of Integer)
Public Overridable Property FeeAmount As Nullable(Of Decimal)
Public Overridable Property ExtendedFeeAmount As Nullable(Of Decimal)
Public Overridable Property ReturnTaxAmount As Nullable(Of Decimal)
Public Overridable Property ReturnExtendedFeeAmount As Nullable(Of Decimal)
Public Overridable Property ReturnExtendedPrice As Nullable(Of Decimal)
Public Overridable Property Fees As List(Of ReturnFeeViewModel)
End Class
Public Partial Class ReturnOutboundSkuViewModel
Public Overridable Property EntitySkuId As Integer
Public Overridable Property CreatedDate As Date
Public Overridable Property UpdatedDate As Date
Public Overridable Property LineNumber As Integer
Public Overridable Property SkuId As Integer
Public Overridable Property SkuCode As String
Public Overridable Property WarehouseSkuCode As String
Public Overridable Property Quantity As Integer
Public Overridable Property Price As Nullable(Of Decimal)
Public Overridable Property ExtendedPrice As Nullable(Of Decimal)
Public Overridable Property PriceOverride As Nullable(Of Decimal)
Public Overridable Property TaxablePrice As Nullable(Of Decimal)
Public Overridable Property TaxAmount As Nullable(Of Decimal)
Public Overridable Property OrderedQuantity As Nullable(Of Integer)
Public Overridable Property ReturnTaxablePrice As Nullable(Of Decimal)
End Class
Public Partial Class ReturnPaymentViewModel
Public Overridable Property PaymentId As Integer
Public Overridable Property PaymentType As String
Public Overridable Property CreditCardType As String
Public Overridable Property CreditCardName As String
Public Overridable Property CreditCardNumber As String
Public Overridable Property CreditCardToken As String
Public Overridable Property PaymentGuid As String
Public Overridable Property CreditCardExpired As String
Public Overridable Property AuthorizationCode As String
Public Overridable Property BankAccountNumber As String
Public Overridable Property BankRoutingNumber As String
Public Overridable Property BankAccountType As String
Public Overridable Property BankName As String
Public Overridable Property BankAccountName As String
Public Overridable Property LicenseNumber As String
Public Overridable Property LicenseDOB As String
Public Overridable Property LicenseState As String
Public Overridable Property CheckNumber As String
Public Overridable Property SavingsClub As String
Public Overridable Property Charge As Decimal
Public Overridable Property RmaEnteredRefund As Nullable(Of Decimal)
Public Overridable Property TextResponse As String
Public Overridable Property Processed As Boolean
Public Overridable Property ConfirmationCode As String
Public Overridable Property AuthorizationTime As Nullable(Of Date)
Public Overridable Property BillingAddress As AddressViewModel
Public Overridable Property TransactionId As String
Public Overridable Property AVS As String
Public Overridable Property BalancingPayment As Boolean
Public Overridable Property SerialNumber As String
Public Overridable Property PaymentExportKeyword As String
End Class
Public Partial Class ReturnShipmentIssueSkuViewModel
Public Overridable Property RMAShipmentIssueSkuId As Integer
Public Overridable Property CreatedDate As Date
Public Overridable Property UpdatedDate As Date
Public Overridable Property LineNumber As Integer
Public Overridable Property SkuId As Integer
Public Overridable Property SkuCode As String
Public Overridable Property WarehouseSkuCode As String
Public Overridable Property Quantity As Integer
Public Overridable Property Price As Nullable(Of Decimal)
Public Overridable Property ExtendedPrice As Nullable(Of Decimal)
Public Overridable Property PriceOverride As Nullable(Of Decimal)
End Class
Public Partial Class ReturnViewModel
Public Sub New()
InboundSkus = New List(Of ReturnInboundSkuViewModel)
OutboundSkus = New List(Of ReturnOutboundSkuViewModel)
ShipmentIssueSkus = New List(Of ReturnShipmentIssueSkuViewModel)
Payments = New List(Of ReturnPaymentViewModel)
Holds = New List(Of ReturnHoldViewModel)
End Sub
Public Overridable Property BeeNumber As Decimal
Public Overridable Property BeeNumberCustomer As Decimal
Public Overridable Property EventId As Nullable(Of Integer)
Public Overridable Property EventStartDate As Nullable(Of Date)
Public Overridable Property MasterOrderId As Integer
Public Overridable Property MasterOrderIdParent As Integer
Public Overridable Property MasterOrderIdRelated As Nullable(Of Integer)
Public Overridable Property OrderIdOutbound As Integer
Public Overridable Property CreatedDate As Date
Public Overridable Property UpdatedDate As Date
Public Overridable Property RmaNumber As String
Public Overridable Property BeeBusinessGuid As Decimal
Public Overridable Property IsSubmitted As Boolean
Public Overridable Property SubmittedDate As Nullable(Of Date)
Public Overridable Property ExportDate As Nullable(Of Date)
Public Overridable Property RmaStatus As String
Public Overridable Property InboundReturnTotal As Nullable(Of Decimal)
Public Overridable Property OutboundTotal As Nullable(Of Decimal)
Public Overridable Property TaxAmount As Nullable(Of Decimal)
Public Overridable Property ShippingTaxAmount As Nullable(Of Decimal)
Public Overridable Property FeeTotal As Nullable(Of Decimal)
Public Overridable Property Total As Nullable(Of Decimal)
Public Overridable Property ShippingMethod As String
Public Overridable Property MasterOrderIdOutbound As Nullable(Of Integer)
Public Overridable Property RmaNote As String
Public Overridable Property SubTotal As Nullable(Of Decimal)
Public Overridable Property ShippingAmount As Nullable(Of Decimal)
Public Overridable Property PaymentTotal As Nullable(Of Decimal)
Public Overridable Property CreditNotAppliedToProductAmount As Nullable(Of Decimal)
Public Overridable Property FeeTotalWaived As Nullable(Of Decimal)
Public Overridable Property OutboundOrderSavingsClubAmount As Nullable(Of Decimal)
Public Overridable Property InboundReplacementTotal As Nullable(Of Decimal)
Public Overridable Property InboundTaxAmount As Nullable(Of Decimal)
Public Overridable Property OutboundTaxAmount As Nullable(Of Decimal)
Public Overridable Property OutboundOrderTotal As Nullable(Of Decimal)
Public Overridable Property OutboundOrderCreditCardAmount As Nullable(Of Decimal)
Public Overridable Property OrderCreatedDate As Nullable(Of Date)
Public Overridable Property ClosedDate As Nullable(Of Date)
Public Overridable Property ActualShippingTaxAmount As Nullable(Of Decimal)
Public Overridable Property ActualShippingAmount As Nullable(Of Decimal)
Public Overridable Property ActualTaxAmount As Nullable(Of Decimal)
Public Overridable Property ActualInboundTaxAmount As Nullable(Of Decimal)
Public Overridable Property RmaCreditCardAmount As Nullable(Of Decimal)
Public Overridable Property RmaSavingsClubAmount As Nullable(Of Decimal)
Public Overridable Property ActualFeeTotal As Nullable(Of Decimal)
Public Overridable Property ActualFeeTotalWaived As Nullable(Of Decimal)
Public Overridable Property ActualTotal As Nullable(Of Decimal)
Public Overridable Property ActualSubTotal As Nullable(Of Decimal)
Public Overridable Property ActualInboundReturnTotal As Nullable(Of Decimal)
Public Overridable Property ActualInboundReplacementTotal As Nullable(Of Decimal)
Public Overridable Property ActualCreditNotAppliedToProductAmount As Nullable(Of Decimal)
Public Overridable Property TaxExportDate As Nullable(Of Date)
Public Overridable Property TaxTransactionTime As Nullable(Of Date)
Public Overridable Property TaxTransactionId As String
Public Overridable Property ReverseTaxExportDate As Nullable(Of Date)
Public Overridable Property ReverseTaxTransactionTime As Nullable(Of Date)
Public Overridable Property ReverseTaxTransactionId As String
Public Overridable Property FinalTax As Nullable(Of Decimal)
Public Overridable Property ReverseFinalTax As Nullable(Of Decimal)
Public Overridable Property ReuseableInboundTaxTransactionId As String
Public Overridable Property ReuseableOutboundTaxTransactionId As String
Public Overridable Property OrderId As Nullable(Of Integer)
Public Overridable Property OrderNumber As String
Public Overridable Property Note As String
Public Overridable Property ClawbackCVOverride As Boolean
Public Overridable Property ClawbackQVOverride As Boolean
Public Overridable Property IssueGiftCard As Boolean
Public Overridable Property RmaGiftCardAmount As Nullable(Of Decimal)
Public Overridable Property BeeSavingsSerialGuid As Nullable(Of Decimal)
Public Overridable Property SerialNumber As String
Public Overridable Property GiftCardEmail As String
Public Overridable Property OrderCreatedDuringSubmit As Boolean
Public Overridable Property TotalQualifyingValue As Nullable(Of Decimal)
Public Overridable Property TotalCommissionableValue As Nullable(Of Decimal)
Public Overridable Property BeeSavingsClubGuid As Nullable(Of Decimal)
Public Overridable Property IsCancelOrder As Nullable(Of Boolean)
Public Overridable Property CreatedBy As String
Public Overridable Property RmaSeverity As String
Public Overridable Property Reference As String
Public Overridable Property UserName As String
Public Overridable Property TotalOverrideCV As Nullable(Of Decimal)
Public Overridable Property TotalOverrideQV As Nullable(Of Decimal)
Public Overridable Property TotalUplineCV As Nullable(Of Decimal)
Public Overridable Property TotalUplineQV As Nullable(Of Decimal)
Public Overridable Property TotalGroupCV As Nullable(Of Decimal)
Public Overridable Property TotalGroupQV As Nullable(Of Decimal)
Public Overridable Property OverrideCV As Nullable(Of Decimal)
Public Overridable Property OverrideQV As Nullable(Of Decimal)
Public Overridable Property UplineCV As Nullable(Of Decimal)
Public Overridable Property UplineQV As Nullable(Of Decimal)
Public Overridable Property GroupCV As Nullable(Of Decimal)
Public Overridable Property GroupQV As Nullable(Of Decimal)
Public Overridable Property IssueCheck As Boolean
Public Overridable Property RmaCheckAmount As Nullable(Of Decimal)
Public Overridable Property ShippingAddress As AddressViewModel
Public Overridable Property InboundSkus As List(Of ReturnInboundSkuViewModel)
Public Overridable Property OutboundSkus As List(Of ReturnOutboundSkuViewModel)
Public Overridable Property ShipmentIssueSkus As List(Of ReturnShipmentIssueSkuViewModel)
Public Overridable Property Payments As List(Of ReturnPaymentViewModel)
Public Overridable Property Holds As List(Of ReturnHoldViewModel)
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}