NAV

<back to all web services

NAVReturnCreate

The following routes are available for this service:
POST/returns
import java.math.*
import java.util.*
import net.servicestack.client.*


open class NAVReturnCreate : IPost
{
    var header:NAVReturnHeaderCreate? = null
    var inboundSkus:ArrayList<NAVReturnInboundSkuCreate> = ArrayList<NAVReturnInboundSkuCreate>()
    var outboundSkus:ArrayList<NAVReturnOutboundSkuCreate> = ArrayList<NAVReturnOutboundSkuCreate>()
    var billingAddress:NAVReturnAddress? = null
    var shippingAddress:NAVReturnAddress? = null
}

open class NAVReturnHeaderCreate
{
    var originalOrderNumber:String? = null
    var originalOrderTypeId:String? = null
    var rmaNote:String? = null
    var shipLabelType:String? = null
}

open class NAVReturnInboundSkuCreate
{
    var skuCode:String? = null
    var orderLineNumber:Int? = null
    var quantityReturned:Int? = null
    var reasonType:String? = null
    var rmaNote:String? = null
}

open class NAVReturnOutboundSkuCreate
{
    var skuCode:String? = null
    var orderLineNumber:Int? = null
    var quantityReturned:Int? = null
    var reasonType:String? = null
}

open class NAVReturnAddress
{
    var firstName:String? = null
    var lastName: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 stateProvinceCode:String? = null
    var postalCode:String? = null
    var county:String? = null
    var countryCode:String? = null
}

open class NAVReturnCreateResponse
{
    var rmaNumber:String? = null
    var packingListURI:String? = null
    var total:BigDecimal? = null
    var responseStatus:ResponseStatus? = null
}

Kotlin 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
		}
	}
}