NAV

<back to all web services

NAVReturnCreate

The following routes are available for this service:
POST/returns
namespace NAV.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type NAVReturnCreateResponse() = 
        member val RmaNumber:String = null with get,set
        member val PackingListURI:String = null with get,set
        member val Total:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type NAVReturnHeaderCreate() = 
        member val OriginalOrderNumber:String = null with get,set
        member val OriginalOrderTypeId:String = null with get,set
        member val RmaNote:String = null with get,set
        member val ShipLabelType:String = null with get,set

    [<AllowNullLiteral>]
    type NAVReturnInboundSkuCreate() = 
        member val SkuCode:String = null with get,set
        member val OrderLineNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val QuantityReturned:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReasonType:String = null with get,set
        member val RmaNote:String = null with get,set

    [<AllowNullLiteral>]
    type NAVReturnOutboundSkuCreate() = 
        member val SkuCode:String = null with get,set
        member val OrderLineNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val QuantityReturned:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReasonType:String = null with get,set

    [<AllowNullLiteral>]
    type NAVReturnAddress() = 
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val AddressLine1:String = null with get,set
        member val AddressLine2:String = null with get,set
        member val AddressLine3:String = null with get,set
        member val AddressLine4:String = null with get,set
        member val AddressLine5:String = null with get,set
        member val City:String = null with get,set
        member val StateProvinceCode:String = null with get,set
        member val PostalCode:String = null with get,set
        member val County:String = null with get,set
        member val CountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type NAVReturnCreate() = 
        interface IPost
        member val Header:NAVReturnHeaderCreate = null with get,set
        member val InboundSkus:ResizeArray<NAVReturnInboundSkuCreate> = new ResizeArray<NAVReturnInboundSkuCreate>() with get,set
        member val OutboundSkus:ResizeArray<NAVReturnOutboundSkuCreate> = new ResizeArray<NAVReturnOutboundSkuCreate>() with get,set
        member val BillingAddress:NAVReturnAddress = null with get,set
        member val ShippingAddress:NAVReturnAddress = null with get,set

F# 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
		}
	}
}