NAV

<back to all web services

SalesCenterReturnCreate

The following routes are available for this service:
POST/sales-center/return
SalesCenterReturnCreate Parameters:
NameParameterData TypeRequiredDescription
HeaderbodyNAVReturnHeaderCreateNo
InboundSkusbodyList<NAVReturnInboundSkuCreate>No
OutboundSkusbodyList<NAVReturnOutboundSkuCreate>No
BillingAddressbodyNAVReturnAddressNo
ShippingAddressbodyNAVReturnAddressNo
NAVReturnHeaderCreate Parameters:
NameParameterData TypeRequiredDescription
OriginalOrderNumberformstringNo
OriginalOrderTypeIdformstringNo
RmaNoteformstringNo
ShipLabelTypeformstringNo
NAVReturnInboundSkuCreate Parameters:
NameParameterData TypeRequiredDescription
SkuCodeformstringNo
OrderLineNumberformint?No
QuantityReturnedformint?No
ReasonTypeformstringNo
RmaNoteformstringNo
NAVReturnOutboundSkuCreate Parameters:
NameParameterData TypeRequiredDescription
SkuCodeformstringNo
OrderLineNumberformint?No
QuantityReturnedformint?No
ReasonTypeformstringNo
NAVReturnAddress Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
AddressLine1formstringNo
AddressLine2formstringNo
AddressLine3formstringNo
AddressLine4formstringNo
AddressLine5formstringNo
CityformstringNo
StateProvinceCodeformstringNo
PostalCodeformstringNo
CountyformstringNo
CountryCodeformstringNo
NAVReturnCreateResponse Parameters:
NameParameterData TypeRequiredDescription
RmaNumberformstringNo
PackingListURIformstringNo
Totalformdecimal?No
ResponseStatusformResponseStatusNo

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