| GET | /returns/{RMANumber} |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class ReturnGet : IGet
{
var rmaNumber:String? = null
}
open class ReturnGetResponse : GetResponse<ReturnViewModel>()
{
}
open class GetResponse<TEntity>
{
var item:TEntity? = null
var responseStatus:ResponseStatus? = null
}
open class ReturnViewModel
{
var beeNumber:BigDecimal? = null
var beeNumberCustomer:BigDecimal? = null
var eventId:Int? = null
var eventStartDate:Date? = null
var masterOrderId:Int? = null
var masterOrderIdParent:Int? = null
var masterOrderIdRelated:Int? = null
var orderIdOutbound:Int? = null
var createdDate:Date? = null
var updatedDate:Date? = null
var rmaNumber:String? = null
var beeBusinessGuid:BigDecimal? = null
var isSubmitted:Boolean? = null
var submittedDate:Date? = null
var exportDate:Date? = null
var rmaStatus:String? = null
var inboundReturnTotal:BigDecimal? = null
var outboundTotal:BigDecimal? = null
var taxAmount:BigDecimal? = null
var shippingTaxAmount:BigDecimal? = null
var feeTotal:BigDecimal? = null
var total:BigDecimal? = null
var shippingMethod:String? = null
var masterOrderIdOutbound:Int? = null
var rmaNote:String? = null
var subTotal:BigDecimal? = null
var shippingAmount:BigDecimal? = null
var paymentTotal:BigDecimal? = null
var creditNotAppliedToProductAmount:BigDecimal? = null
var feeTotalWaived:BigDecimal? = null
var outboundOrderSavingsClubAmount:BigDecimal? = null
var inboundReplacementTotal:BigDecimal? = null
var inboundTaxAmount:BigDecimal? = null
var outboundTaxAmount:BigDecimal? = null
var outboundOrderTotal:BigDecimal? = null
var outboundOrderCreditCardAmount:BigDecimal? = null
var orderCreatedDate:Date? = null
var closedDate:Date? = null
var actualShippingTaxAmount:BigDecimal? = null
var actualShippingAmount:BigDecimal? = null
var actualTaxAmount:BigDecimal? = null
var actualInboundTaxAmount:BigDecimal? = null
var rmaCreditCardAmount:BigDecimal? = null
var rmaSavingsClubAmount:BigDecimal? = null
var actualFeeTotal:BigDecimal? = null
var actualFeeTotalWaived:BigDecimal? = null
var actualTotal:BigDecimal? = null
var actualSubTotal:BigDecimal? = null
var actualInboundReturnTotal:BigDecimal? = null
var actualInboundReplacementTotal:BigDecimal? = null
var actualCreditNotAppliedToProductAmount:BigDecimal? = null
var taxExportDate:Date? = null
var taxTransactionTime:Date? = null
var taxTransactionId:String? = null
var reverseTaxExportDate:Date? = null
var reverseTaxTransactionTime:Date? = null
var reverseTaxTransactionId:String? = null
var finalTax:BigDecimal? = null
var reverseFinalTax:BigDecimal? = null
var reuseableInboundTaxTransactionId:String? = null
var reuseableOutboundTaxTransactionId:String? = null
var orderId:Int? = null
var orderNumber:String? = null
var note:String? = null
var clawbackCVOverride:Boolean? = null
var clawbackQVOverride:Boolean? = null
var issueGiftCard:Boolean? = null
var rmaGiftCardAmount:BigDecimal? = null
var beeSavingsSerialGuid:BigDecimal? = null
var serialNumber:String? = null
var giftCardEmail:String? = null
var orderCreatedDuringSubmit:Boolean? = null
var totalQualifyingValue:BigDecimal? = null
var totalCommissionableValue:BigDecimal? = null
var beeSavingsClubGuid:BigDecimal? = null
var isCancelOrder:Boolean? = null
var createdBy:String? = null
var rmaSeverity:String? = null
var reference:String? = null
var userName:String? = null
var totalOverrideCV:BigDecimal? = null
var totalOverrideQV:BigDecimal? = null
var totalUplineCV:BigDecimal? = null
var totalUplineQV:BigDecimal? = null
var totalGroupCV:BigDecimal? = null
var totalGroupQV:BigDecimal? = null
var overrideCV:BigDecimal? = null
var overrideQV:BigDecimal? = null
var uplineCV:BigDecimal? = null
var uplineQV:BigDecimal? = null
var groupCV:BigDecimal? = null
var groupQV:BigDecimal? = null
var issueCheck:Boolean? = null
var rmaCheckAmount:BigDecimal? = null
var shippingAddress:AddressViewModel? = null
var inboundSkus:ArrayList<ReturnInboundSkuViewModel> = ArrayList<ReturnInboundSkuViewModel>()
var outboundSkus:ArrayList<ReturnOutboundSkuViewModel> = ArrayList<ReturnOutboundSkuViewModel>()
var shipmentIssueSkus:ArrayList<ReturnShipmentIssueSkuViewModel> = ArrayList<ReturnShipmentIssueSkuViewModel>()
var payments:ArrayList<ReturnPaymentViewModel> = ArrayList<ReturnPaymentViewModel>()
var holds:ArrayList<ReturnHoldViewModel> = ArrayList<ReturnHoldViewModel>()
}
open class AddressViewModel
{
var firstName:String? = null
var lastName:String? = null
var houseNumber:String? = null
var addressLine1:String? = null
var addressLine2:String? = null
var addressLine3:String? = null
var addressLine4:String? = null
var addressLine5:String? = null
var city:String? = null
var localityLevelID1:String? = null
var localityLevelID2:String? = null
var localityLevelID3:String? = null
var localityLevelID4:String? = null
var localityLevelID5:String? = null
var stateCode:String? = null
var postalCode:String? = null
var countryCode:String? = null
var addressGoodDate:Date? = null
var latitude:BigDecimal? = null
var longitude:BigDecimal? = null
var addressId:Int? = null
}
open class ReturnInboundSkuViewModel : ReturnOutboundSkuViewModel()
{
var rmaType:String? = null
var returnQuantity:Int? = null
var autoReceivedQuantity:Int? = null
var originalQuantity:Int? = null
var returnQuantityOnClone:Int? = null
var reasonType:String? = null
var skuNote:String? = null
var orderId:Int? = null
var orderNumber:String? = null
var orderSkuId:Int? = null
var orderLineNumber:Int? = null
var feeAmount:BigDecimal? = null
var extendedFeeAmount:BigDecimal? = null
var returnTaxAmount:BigDecimal? = null
var returnExtendedFeeAmount:BigDecimal? = null
var returnExtendedPrice:BigDecimal? = null
var fees:ArrayList<ReturnFeeViewModel> = ArrayList<ReturnFeeViewModel>()
}
open class ReturnOutboundSkuViewModel
{
var entitySkuId:Int? = null
var createdDate:Date? = null
var updatedDate:Date? = null
var lineNumber:Int? = null
var skuId:Int? = null
var skuCode:String? = null
var warehouseSkuCode:String? = null
var quantity:Int? = null
var price:BigDecimal? = null
var extendedPrice:BigDecimal? = null
var priceOverride:BigDecimal? = null
var taxablePrice:BigDecimal? = null
var taxAmount:BigDecimal? = null
var orderedQuantity:Int? = null
var returnTaxablePrice:BigDecimal? = null
}
open class ReturnFeeViewModel
{
var rmaFeeId:Int? = null
var createdDate:Date? = null
var updatedDate:Date? = null
var isFeeWaived:Boolean? = null
var usernameFeeWaived:String? = null
var waivedNote:String? = null
var feeId:String? = null
}
open class ReturnShipmentIssueSkuViewModel
{
var rmaShipmentIssueSkuId:Int? = null
var createdDate:Date? = null
var updatedDate:Date? = null
var lineNumber:Int? = null
var skuId:Int? = null
var skuCode:String? = null
var warehouseSkuCode:String? = null
var quantity:Int? = null
var price:BigDecimal? = null
var extendedPrice:BigDecimal? = null
var priceOverride:BigDecimal? = null
}
open class ReturnPaymentViewModel
{
var paymentId:Int? = null
var paymentType:String? = null
var creditCardType:String? = null
var creditCardName:String? = null
var creditCardNumber:String? = null
var creditCardToken:String? = null
var paymentGuid:String? = null
var creditCardExpired:String? = null
var authorizationCode:String? = null
var bankAccountNumber:String? = null
var bankRoutingNumber:String? = null
var bankAccountType:String? = null
var bankName:String? = null
var bankAccountName:String? = null
var licenseNumber:String? = null
var licenseDOB:String? = null
var licenseState:String? = null
var checkNumber:String? = null
var savingsClub:String? = null
var charge:BigDecimal? = null
var rmaEnteredRefund:BigDecimal? = null
var textResponse:String? = null
var processed:Boolean? = null
var confirmationCode:String? = null
var authorizationTime:Date? = null
var billingAddress:AddressViewModel? = null
var transactionId:String? = null
var avs:String? = null
var balancingPayment:Boolean? = null
var serialNumber:String? = null
var paymentExportKeyword:String? = null
}
open class ReturnHoldViewModel
{
var rmaHoldId:Int? = null
var createdDate:Date? = null
var updatedDate:Date? = null
var releaseDate:Date? = null
var usernameRelease:String? = null
var holdReason:String? = null
var holdNote:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"item":{"beeNumber":0,"beeNumberCustomer":0,"eventId":0,"eventStartDate":"0001-01-01T00:00:00.0000000","masterOrderId":0,"masterOrderIdParent":0,"masterOrderIdRelated":0,"orderIdOutbound":0,"createdDate":"0001-01-01T00:00:00.0000000","updatedDate":"0001-01-01T00:00:00.0000000","rmaNumber":"String","beeBusinessGuid":0,"isSubmitted":false,"submittedDate":"0001-01-01T00:00:00.0000000","exportDate":"0001-01-01T00:00:00.0000000","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.0000000","closedDate":"0001-01-01T00:00:00.0000000","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.0000000","taxTransactionTime":"0001-01-01T00:00:00.0000000","taxTransactionId":"String","reverseTaxExportDate":"0001-01-01T00:00:00.0000000","reverseTaxTransactionTime":"0001-01-01T00:00:00.0000000","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.0000000","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.0000000","updatedDate":"0001-01-01T00:00:00.0000000","isFeeWaived":false,"usernameFeeWaived":"String","waivedNote":"String","feeId":"String"}],"entitySkuId":0,"createdDate":"0001-01-01T00:00:00.0000000","updatedDate":"0001-01-01T00:00:00.0000000","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.0000000","updatedDate":"0001-01-01T00:00:00.0000000","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.0000000","updatedDate":"0001-01-01T00:00:00.0000000","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.0000000","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.0000000","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.0000000","updatedDate":"0001-01-01T00:00:00.0000000","releaseDate":"0001-01-01T00:00:00.0000000","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"}}}