NAV

<back to all web services

NAVReturnCreate

The following routes are available for this service:
POST/returns
import Foundation
import ServiceStack

public class NAVReturnCreate : IPost, Codable
{
    public var header:NAVReturnHeaderCreate?
    public var inboundSkus:[NAVReturnInboundSkuCreate] = []
    public var outboundSkus:[NAVReturnOutboundSkuCreate] = []
    public var billingAddress:NAVReturnAddress?
    public var shippingAddress:NAVReturnAddress?

    required public init(){}
}

public class NAVReturnHeaderCreate : Codable
{
    public var originalOrderNumber:String?
    public var originalOrderTypeId:String?
    public var rmaNote:String?
    public var shipLabelType:String?

    required public init(){}
}

public class NAVReturnInboundSkuCreate : Codable
{
    public var skuCode:String?
    public var orderLineNumber:Int?
    public var quantityReturned:Int?
    public var reasonType:String?
    public var rmaNote:String?

    required public init(){}
}

public class NAVReturnOutboundSkuCreate : Codable
{
    public var skuCode:String?
    public var orderLineNumber:Int?
    public var quantityReturned:Int?
    public var reasonType:String?

    required public init(){}
}

public class NAVReturnAddress : Codable
{
    public var firstName:String?
    public var lastName:String?
    public var addressLine1:String?
    public var addressLine2:String?
    public var addressLine3:String?
    public var addressLine4:String?
    public var addressLine5:String?
    public var city:String?
    public var stateProvinceCode:String?
    public var postalCode:String?
    public var county:String?
    public var countryCode:String?

    required public init(){}
}

public class NAVReturnCreateResponse : Codable
{
    public var rmaNumber:String?
    public var packingListURI:String?
    public var total:Double?
    public var responseStatus:ResponseStatus?

    required public init(){}
}


Swift NAVReturnCreate 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 /returns 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
		}
	}
}