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