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