NAV

<back to all web services

NAVOrderImport

The following routes are available for this service:
POST/orders
NAVOrderImport Parameters:
NameParameterData TypeRequiredDescription
ExternalOrderIdbodystringNo
OrderTypeIdbodystringNo
CreatedDateUTCbodyDateTime?No
SubmittedDateUTCbodyDateTime?No
BeeNumberCustomerbodydecimal?No
BeeNumberPayeebodydecimal?No
OrderSourcebodystringNo
ShippingMethodbodystringNo
GiftMessagebodystringNo
GiftMessageFrombodystringNo
GiftMessageTobodystringNo
ShippingCommentbodystringNo
ShippingAddressbodyNAVOrderImportAddressNo
OrderSkusbodyList<NAVOrderImportSku>No
OrderPaymentsbodyList<NAVOrderImportPayment>No
OrderFeesbodyList<NAVOrderImportFee>No
SubTotalbodydecimal?No
OrderTotalbodydecimal?No
ShippingCostbodydecimal?No
Taxbodydecimal?No
ShippingTaxbodydecimal?No
ExternalDiscountReasonbodystringNo
PCLevelbodydecimal?No
AgentIdbodystringNo
NumberOfCustomersServedbodydecimal?No
VersionNumberbodystringNo
VersionYearbodystringNo
AdditionalCodebodystringNo
DiscountPercentbodystringNo
TaxRatePercentbodystringNo
OrderWithinTimePeriodbodydecimal?No
TaxAreaCodebodystringNo
GeocodebodystringNo
FundraiserIdbodystringNo
WarehouseCodebodystringNo
OriginalReshipExternalOrderIdbodystringNo
ShippedVersionNumberbodystringNo
ShippedVersionYearbodystringNo
MasterOrderIdbodystringNo
CouponValuebodystringNo
SalesCenterIdbodystringNo
PremierLevelbodystringNo
PCLevelCurrentCyclebodydecimal?No
PremierLevelCurrentCyclebodystringNo
EmailAddressbodystringNo
PhoneNumberbodystringNo
NAVOrderImportAddress Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
AddressLine1formstringNo
AddressLine2formstringNo
AddressLine3formstringNo
AddressLine4formstringNo
AddressLine5formstringNo
CityformstringNo
StateProvinceCodeformstringNo
PostalCodeformstringNo
CountyformstringNo
CountryCodeformstringNo
NAVOrderImportSku Parameters:
NameParameterData TypeRequiredDescription
SkuCodeformstringNo
OrderLineNumberformint?No
Quantityformint?No
IsAutoShipformbool?No
OrderSkuComponentsformList<NAVOrderImportSkuComponent>No
PricePaidPerUnitformdecimal?No
RetailPricePerUnitformdecimal?No
NetPriceformdecimal?No
NetSalesformdecimal?No
SubmittedNetPriceformdecimal?No
SubmittedNetSalesformdecimal?No
ManualDiscountAmountformdecimal?No
ItemDiscountPercentformdecimal?No
TaxAmountformdecimal?No
TaxPercentageformdecimal?No
CommissionableValueEarnedformdecimal?No
QualifyingValueEarnedformdecimal?No
QualifyingValueEarnedSubmittedformdecimal?No
OverrideCVEarnedformdecimal?No
OverrideCVEarnedSubmittedformdecimal?No
OverrideQVEarnedformdecimal?No
GroupCVEarnedformdecimal?No
GroupQVEarnedformdecimal?No
UplineCVEarnedformdecimal?No
UplineQVEarnedformdecimal?No
VersionNumberformstringNo
VersionYearformstringNo
CouponCodeformstringNo
SubstituteIndicatorformstringNo
FulfillmentIndicatorformstringNo
SubstituteSkuCodeformstringNo
VehicleIdformstringNo
OfferIdformstringNo
ParentSKUCodeformstringNo
BuyingDiscountformdecimal?No
OriginalOrderQtyformdecimal?No
ClosedQuantityformdecimal?No
NAVOrderImportSkuComponent Parameters:
NameParameterData TypeRequiredDescription
ParentOrderLineNumberformint?No
OrderLineNumberformint?No
SkuCodeformstringNo
Quantityformint?No
PricePaidPerUnitformdecimal?No
RetailPricePerUnitformdecimal?No
NetPriceformdecimal?No
TaxAmountformdecimal?No
TaxPercentageformdecimal?No
VersionNumberformstringNo
VersionYearformstringNo
VehicleIdformstringNo
OfferIdformstringNo
NAVOrderImportPayment Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringNo
PaymentIdentifier1formstringNo
PaymentIdentifier2formstringNo
PaymentIdentifier3formstringNo
PaymentIdentifier4formstringNo
PaymentIdentifier5formstringNo
PaymentTokenformstringNo
AuthorizationTimeformDateTime?No
AuthorizationCodeformstringNo
TransactionIdformstringNo
AmountChargedformdecimal?No
BillingAddressformNAVOrderImportAddressNo
NAVOrderImportFee Parameters:
NameParameterData TypeRequiredDescription
FeeSystemKeywordformstringNo
FeeAmountformdecimal?No
TaxAmountformdecimal?No
FeeTotalformdecimal?No
NAVOrderImportResponse Parameters:
NameParameterData TypeRequiredDescription
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 /orders HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	externalOrderId: String,
	orderTypeId: String,
	createdDateUTC: 0001-01-01T00:00:00,
	submittedDateUTC: 0001-01-01T00:00:00,
	beeNumberCustomer: 0,
	beeNumberPayee: 0,
	orderSource: String,
	shippingMethod: String,
	giftMessage: String,
	giftMessageFrom: String,
	giftMessageTo: String,
	shippingComment: 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
	},
	orderSkus: 
	[
		{
			skuCode: String,
			orderLineNumber: 0,
			quantity: 0,
			isAutoShip: False,
			orderSkuComponents: 
			[
				{
					parentOrderLineNumber: 0,
					orderLineNumber: 0,
					skuCode: String,
					quantity: 0,
					pricePaidPerUnit: 0,
					retailPricePerUnit: 0,
					netPrice: 0,
					taxAmount: 0,
					taxPercentage: 0,
					versionNumber: String,
					versionYear: String,
					vehicleId: String,
					offerId: String
				}
			],
			pricePaidPerUnit: 0,
			retailPricePerUnit: 0,
			netPrice: 0,
			netSales: 0,
			submittedNetPrice: 0,
			submittedNetSales: 0,
			manualDiscountAmount: 0,
			itemDiscountPercent: 0,
			taxAmount: 0,
			taxPercentage: 0,
			commissionableValueEarned: 0,
			qualifyingValueEarned: 0,
			qualifyingValueEarnedSubmitted: 0,
			overrideCVEarned: 0,
			overrideCVEarnedSubmitted: 0,
			overrideQVEarned: 0,
			groupCVEarned: 0,
			groupQVEarned: 0,
			uplineCVEarned: 0,
			uplineQVEarned: 0,
			versionNumber: String,
			versionYear: String,
			couponCode: String,
			substituteIndicator: String,
			fulfillmentIndicator: String,
			substituteSkuCode: String,
			vehicleId: String,
			offerId: String,
			parentSKUCode: String,
			buyingDiscount: 0,
			originalOrderQty: 0,
			closedQuantity: 0
		}
	],
	orderPayments: 
	[
		{
			paymentType: String,
			paymentIdentifier1: String,
			paymentIdentifier2: String,
			paymentIdentifier3: String,
			paymentIdentifier4: String,
			paymentIdentifier5: String,
			paymentToken: String,
			authorizationTime: 0001-01-01T00:00:00,
			authorizationCode: String,
			transactionId: String,
			amountCharged: 0,
			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
			}
		}
	],
	orderFees: 
	[
		{
			feeSystemKeyword: String,
			feeAmount: 0,
			taxAmount: 0,
			feeTotal: 0
		}
	],
	subTotal: 0,
	orderTotal: 0,
	shippingCost: 0,
	tax: 0,
	shippingTax: 0,
	externalDiscountReason: String,
	pcLevel: 0,
	agentId: String,
	numberOfCustomersServed: 0,
	versionNumber: String,
	versionYear: String,
	additionalCode: String,
	discountPercent: String,
	taxRatePercent: String,
	orderWithinTimePeriod: 0,
	taxAreaCode: String,
	geocode: String,
	fundraiserId: String,
	warehouseCode: String,
	originalReshipExternalOrderId: String,
	shippedVersionNumber: String,
	shippedVersionYear: String,
	masterOrderId: String,
	couponValue: String,
	salesCenterId: String,
	premierLevel: String,
	pcLevelCurrentCycle: 0,
	premierLevelCurrentCycle: String,
	emailAddress: String,
	phoneNumber: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}