NAV

<back to all web services

SalesCenterReturnCreate

The following routes are available for this service:
POST/sales-center/return
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SalesCenterReturnCreate implements IPost
    {
        public NAVReturnHeaderCreate header = null;
        public ArrayList<NAVReturnInboundSkuCreate> inboundSkus = null;
        public ArrayList<NAVReturnOutboundSkuCreate> outboundSkus = null;
        public NAVReturnAddress billingAddress = null;
        public NAVReturnAddress shippingAddress = null;
        
        public NAVReturnHeaderCreate getHeader() { return header; }
        public SalesCenterReturnCreate setHeader(NAVReturnHeaderCreate value) { this.header = value; return this; }
        public ArrayList<NAVReturnInboundSkuCreate> getInboundSkus() { return inboundSkus; }
        public SalesCenterReturnCreate setInboundSkus(ArrayList<NAVReturnInboundSkuCreate> value) { this.inboundSkus = value; return this; }
        public ArrayList<NAVReturnOutboundSkuCreate> getOutboundSkus() { return outboundSkus; }
        public SalesCenterReturnCreate setOutboundSkus(ArrayList<NAVReturnOutboundSkuCreate> value) { this.outboundSkus = value; return this; }
        public NAVReturnAddress getBillingAddress() { return billingAddress; }
        public SalesCenterReturnCreate setBillingAddress(NAVReturnAddress value) { this.billingAddress = value; return this; }
        public NAVReturnAddress getShippingAddress() { return shippingAddress; }
        public SalesCenterReturnCreate setShippingAddress(NAVReturnAddress value) { this.shippingAddress = value; return this; }
    }

    public static class NAVReturnHeaderCreate
    {
        public String originalOrderNumber = null;
        public String originalOrderTypeId = null;
        public String rmaNote = null;
        public String shipLabelType = null;
        
        public String getOriginalOrderNumber() { return originalOrderNumber; }
        public NAVReturnHeaderCreate setOriginalOrderNumber(String value) { this.originalOrderNumber = value; return this; }
        public String getOriginalOrderTypeId() { return originalOrderTypeId; }
        public NAVReturnHeaderCreate setOriginalOrderTypeId(String value) { this.originalOrderTypeId = value; return this; }
        public String getRmaNote() { return rmaNote; }
        public NAVReturnHeaderCreate setRmaNote(String value) { this.rmaNote = value; return this; }
        public String getShipLabelType() { return shipLabelType; }
        public NAVReturnHeaderCreate setShipLabelType(String value) { this.shipLabelType = value; return this; }
    }

    public static class NAVReturnInboundSkuCreate
    {
        public String skuCode = null;
        public Integer orderLineNumber = null;
        public Integer quantityReturned = null;
        public String reasonType = null;
        public String rmaNote = null;
        
        public String getSkuCode() { return skuCode; }
        public NAVReturnInboundSkuCreate setSkuCode(String value) { this.skuCode = value; return this; }
        public Integer getOrderLineNumber() { return orderLineNumber; }
        public NAVReturnInboundSkuCreate setOrderLineNumber(Integer value) { this.orderLineNumber = value; return this; }
        public Integer getQuantityReturned() { return quantityReturned; }
        public NAVReturnInboundSkuCreate setQuantityReturned(Integer value) { this.quantityReturned = value; return this; }
        public String getReasonType() { return reasonType; }
        public NAVReturnInboundSkuCreate setReasonType(String value) { this.reasonType = value; return this; }
        public String getRmaNote() { return rmaNote; }
        public NAVReturnInboundSkuCreate setRmaNote(String value) { this.rmaNote = value; return this; }
    }

    public static class NAVReturnOutboundSkuCreate
    {
        public String skuCode = null;
        public Integer orderLineNumber = null;
        public Integer quantityReturned = null;
        public String reasonType = null;
        
        public String getSkuCode() { return skuCode; }
        public NAVReturnOutboundSkuCreate setSkuCode(String value) { this.skuCode = value; return this; }
        public Integer getOrderLineNumber() { return orderLineNumber; }
        public NAVReturnOutboundSkuCreate setOrderLineNumber(Integer value) { this.orderLineNumber = value; return this; }
        public Integer getQuantityReturned() { return quantityReturned; }
        public NAVReturnOutboundSkuCreate setQuantityReturned(Integer value) { this.quantityReturned = value; return this; }
        public String getReasonType() { return reasonType; }
        public NAVReturnOutboundSkuCreate setReasonType(String value) { this.reasonType = value; return this; }
    }

    public static class NAVReturnAddress
    {
        public String firstName = null;
        public String lastName = null;
        public String addressLine1 = null;
        public String addressLine2 = null;
        public String addressLine3 = null;
        public String addressLine4 = null;
        public String addressLine5 = null;
        public String city = null;
        public String stateProvinceCode = null;
        public String postalCode = null;
        public String county = null;
        public String countryCode = null;
        
        public String getFirstName() { return firstName; }
        public NAVReturnAddress setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public NAVReturnAddress setLastName(String value) { this.lastName = value; return this; }
        public String getAddressLine1() { return addressLine1; }
        public NAVReturnAddress setAddressLine1(String value) { this.addressLine1 = value; return this; }
        public String getAddressLine2() { return addressLine2; }
        public NAVReturnAddress setAddressLine2(String value) { this.addressLine2 = value; return this; }
        public String getAddressLine3() { return addressLine3; }
        public NAVReturnAddress setAddressLine3(String value) { this.addressLine3 = value; return this; }
        public String getAddressLine4() { return addressLine4; }
        public NAVReturnAddress setAddressLine4(String value) { this.addressLine4 = value; return this; }
        public String getAddressLine5() { return addressLine5; }
        public NAVReturnAddress setAddressLine5(String value) { this.addressLine5 = value; return this; }
        public String getCity() { return city; }
        public NAVReturnAddress setCity(String value) { this.city = value; return this; }
        public String getStateProvinceCode() { return stateProvinceCode; }
        public NAVReturnAddress setStateProvinceCode(String value) { this.stateProvinceCode = value; return this; }
        public String getPostalCode() { return postalCode; }
        public NAVReturnAddress setPostalCode(String value) { this.postalCode = value; return this; }
        public String getCounty() { return county; }
        public NAVReturnAddress setCounty(String value) { this.county = value; return this; }
        public String getCountryCode() { return countryCode; }
        public NAVReturnAddress setCountryCode(String value) { this.countryCode = value; return this; }
    }

    public static class NAVReturnCreateResponse
    {
        public String rmaNumber = null;
        public String packingListURI = null;
        public BigDecimal total = null;
        public ResponseStatus responseStatus = null;
        
        public String getRmaNumber() { return rmaNumber; }
        public NAVReturnCreateResponse setRmaNumber(String value) { this.rmaNumber = value; return this; }
        public String getPackingListURI() { return packingListURI; }
        public NAVReturnCreateResponse setPackingListURI(String value) { this.packingListURI = value; return this; }
        public BigDecimal getTotal() { return total; }
        public NAVReturnCreateResponse setTotal(BigDecimal value) { this.total = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public NAVReturnCreateResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java SalesCenterReturnCreate DTOs

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.

POST /sales-center/return HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	header: 
	{
		originalOrderNumber: String,
		originalOrderTypeId: String,
		rmaNote: String,
		shipLabelType: String
	},
	inboundSkus: 
	[
		{
			skuCode: String,
			orderLineNumber: 0,
			quantityReturned: 0,
			reasonType: String,
			rmaNote: String
		}
	],
	outboundSkus: 
	[
		{
			skuCode: String,
			orderLineNumber: 0,
			quantityReturned: 0,
			reasonType: String
		}
	],
	billingAddress: 
	{
		firstName: String,
		lastName: String,
		addressLine1: String,
		addressLine2: String,
		addressLine3: String,
		addressLine4: String,
		addressLine5: String,
		city: String,
		stateProvinceCode: String,
		postalCode: String,
		county: String,
		countryCode: String
	},
	shippingAddress: 
	{
		firstName: String,
		lastName: String,
		addressLine1: String,
		addressLine2: String,
		addressLine3: String,
		addressLine4: String,
		addressLine5: String,
		city: String,
		stateProvinceCode: String,
		postalCode: String,
		county: String,
		countryCode: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	rmaNumber: String,
	packingListURI: String,
	total: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}