NAV

<back to all web services

NAVOrderImport

The following routes are available for this service:
POST/orders

export class NAVOrderImportResponse
{
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<NAVOrderImportResponse>) { (Object as any).assign(this, init); }
}

export class NAVOrderImportAddress
{
    public firstName?: string;
    public lastName?: string;
    public addressLine1?: string;
    public addressLine2?: string;
    public addressLine3?: string;
    public addressLine4?: string;
    public addressLine5?: string;
    public city?: string;
    public stateProvinceCode?: string;
    public postalCode?: string;
    public county?: string;
    public countryCode?: string;

    public constructor(init?: Partial<NAVOrderImportAddress>) { (Object as any).assign(this, init); }
}

export class NAVOrderImportSkuComponent
{
    public parentOrderLineNumber?: number;
    public orderLineNumber?: number;
    public skuCode?: string;
    public quantity?: number;
    public pricePaidPerUnit?: number;
    public retailPricePerUnit?: number;
    public netPrice?: number;
    public taxAmount?: number;
    public taxPercentage?: number;
    public versionNumber?: string;
    public versionYear?: string;
    public vehicleId?: string;
    public offerId?: string;

    public constructor(init?: Partial<NAVOrderImportSkuComponent>) { (Object as any).assign(this, init); }
}

export class NAVOrderImportSku
{
    public skuCode?: string;
    public orderLineNumber?: number;
    public quantity?: number;
    public isAutoShip?: boolean;
    public orderSkuComponents?: NAVOrderImportSkuComponent[];
    public pricePaidPerUnit?: number;
    public retailPricePerUnit?: number;
    public netPrice?: number;
    public netSales?: number;
    public submittedNetPrice?: number;
    public submittedNetSales?: number;
    public manualDiscountAmount?: number;
    public itemDiscountPercent?: number;
    public taxAmount?: number;
    public taxPercentage?: number;
    public commissionableValueEarned?: number;
    public qualifyingValueEarned?: number;
    public qualifyingValueEarnedSubmitted?: number;
    public overrideCVEarned?: number;
    public overrideCVEarnedSubmitted?: number;
    public overrideQVEarned?: number;
    public groupCVEarned?: number;
    public groupQVEarned?: number;
    public uplineCVEarned?: number;
    public uplineQVEarned?: number;
    public versionNumber?: string;
    public versionYear?: string;
    public couponCode?: string;
    public substituteIndicator?: string;
    public fulfillmentIndicator?: string;
    public substituteSkuCode?: string;
    public vehicleId?: string;
    public offerId?: string;
    public parentSKUCode?: string;
    public buyingDiscount?: number;
    public originalOrderQty?: number;
    public closedQuantity?: number;

    public constructor(init?: Partial<NAVOrderImportSku>) { (Object as any).assign(this, init); }
}

export class NAVOrderImportPayment
{
    public paymentType?: string;
    public paymentIdentifier1?: string;
    public paymentIdentifier2?: string;
    public paymentIdentifier3?: string;
    public paymentIdentifier4?: string;
    public paymentIdentifier5?: string;
    public paymentToken?: string;
    public authorizationTime?: string;
    public authorizationCode?: string;
    public transactionId?: string;
    public amountCharged?: number;
    public billingAddress?: NAVOrderImportAddress;

    public constructor(init?: Partial<NAVOrderImportPayment>) { (Object as any).assign(this, init); }
}

export class NAVOrderImportFee
{
    public feeSystemKeyword?: string;
    public feeAmount?: number;
    public taxAmount?: number;
    public feeTotal?: number;

    public constructor(init?: Partial<NAVOrderImportFee>) { (Object as any).assign(this, init); }
}

export class NAVOrderImport implements IPost
{
    public externalOrderId?: string;
    public orderTypeId?: string;
    public createdDateUTC?: string;
    public submittedDateUTC?: string;
    public beeNumberCustomer?: number;
    public beeNumberPayee?: number;
    public orderSource?: string;
    public shippingMethod?: string;
    public giftMessage?: string;
    public giftMessageFrom?: string;
    public giftMessageTo?: string;
    public shippingComment?: string;
    public shippingAddress?: NAVOrderImportAddress;
    public orderSkus?: NAVOrderImportSku[];
    public orderPayments?: NAVOrderImportPayment[];
    public orderFees?: NAVOrderImportFee[];
    public subTotal?: number;
    public orderTotal?: number;
    public shippingCost?: number;
    public tax?: number;
    public shippingTax?: number;
    public externalDiscountReason?: string;
    public pcLevel?: number;
    public agentId?: string;
    public numberOfCustomersServed?: number;
    public versionNumber?: string;
    public versionYear?: string;
    public additionalCode?: string;
    public discountPercent?: string;
    public taxRatePercent?: string;
    public orderWithinTimePeriod?: number;
    public taxAreaCode?: string;
    public geocode?: string;
    public fundraiserId?: string;
    public warehouseCode?: string;
    public originalReshipExternalOrderId?: string;
    public shippedVersionNumber?: string;
    public shippedVersionYear?: string;
    public masterOrderId?: string;
    public couponValue?: string;
    public salesCenterId?: string;
    public premierLevel?: string;
    public pcLevelCurrentCycle?: number;
    public premierLevelCurrentCycle?: string;
    public emailAddress?: string;
    public phoneNumber?: string;

    public constructor(init?: Partial<NAVOrderImport>) { (Object as any).assign(this, init); }
}

TypeScript NAVOrderImport DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<NAVOrderImport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <AdditionalCode>String</AdditionalCode>
  <AgentId>String</AgentId>
  <BeeNumberCustomer>0</BeeNumberCustomer>
  <BeeNumberPayee>0</BeeNumberPayee>
  <CouponValue>String</CouponValue>
  <CreatedDateUTC>0001-01-01T00:00:00</CreatedDateUTC>
  <DiscountPercent>String</DiscountPercent>
  <EmailAddress>String</EmailAddress>
  <ExternalDiscountReason>String</ExternalDiscountReason>
  <ExternalOrderId>String</ExternalOrderId>
  <FundraiserId>String</FundraiserId>
  <Geocode>String</Geocode>
  <GiftMessage>String</GiftMessage>
  <GiftMessageFrom>String</GiftMessageFrom>
  <GiftMessageTo>String</GiftMessageTo>
  <MasterOrderId>String</MasterOrderId>
  <NumberOfCustomersServed>0</NumberOfCustomersServed>
  <OrderFees>
    <NAVOrderImportFee>
      <FeeAmount>0</FeeAmount>
      <FeeSystemKeyword>String</FeeSystemKeyword>
      <FeeTotal>0</FeeTotal>
      <TaxAmount>0</TaxAmount>
    </NAVOrderImportFee>
  </OrderFees>
  <OrderPayments>
    <NAVOrderImportPayment>
      <AmountCharged>0</AmountCharged>
      <AuthorizationCode>String</AuthorizationCode>
      <AuthorizationTime>0001-01-01T00:00:00</AuthorizationTime>
      <BillingAddress>
        <AddressLine1>String</AddressLine1>
        <AddressLine2>String</AddressLine2>
        <AddressLine3>String</AddressLine3>
        <AddressLine4>String</AddressLine4>
        <AddressLine5>String</AddressLine5>
        <City>String</City>
        <CountryCode>String</CountryCode>
        <County>String</County>
        <FirstName>String</FirstName>
        <LastName>String</LastName>
        <PostalCode>String</PostalCode>
        <StateProvinceCode>String</StateProvinceCode>
      </BillingAddress>
      <PaymentIdentifier1>String</PaymentIdentifier1>
      <PaymentIdentifier2>String</PaymentIdentifier2>
      <PaymentIdentifier3>String</PaymentIdentifier3>
      <PaymentIdentifier4>String</PaymentIdentifier4>
      <PaymentIdentifier5>String</PaymentIdentifier5>
      <PaymentToken>String</PaymentToken>
      <PaymentType>String</PaymentType>
      <TransactionId>String</TransactionId>
    </NAVOrderImportPayment>
  </OrderPayments>
  <OrderSkus>
    <NAVOrderImportSku>
      <BuyingDiscount>0</BuyingDiscount>
      <ClosedQuantity>0</ClosedQuantity>
      <CommissionableValueEarned>0</CommissionableValueEarned>
      <CouponCode>String</CouponCode>
      <FulfillmentIndicator>String</FulfillmentIndicator>
      <GroupCVEarned>0</GroupCVEarned>
      <GroupQVEarned>0</GroupQVEarned>
      <IsAutoShip>false</IsAutoShip>
      <ItemDiscountPercent>0</ItemDiscountPercent>
      <ManualDiscountAmount>0</ManualDiscountAmount>
      <NetPrice>0</NetPrice>
      <NetSales>0</NetSales>
      <OfferId>String</OfferId>
      <OrderLineNumber>0</OrderLineNumber>
      <OrderSkuComponents>
        <NAVOrderImportSkuComponent>
          <NetPrice>0</NetPrice>
          <OfferId>String</OfferId>
          <OrderLineNumber>0</OrderLineNumber>
          <ParentOrderLineNumber>0</ParentOrderLineNumber>
          <PricePaidPerUnit>0</PricePaidPerUnit>
          <Quantity>0</Quantity>
          <RetailPricePerUnit>0</RetailPricePerUnit>
          <SkuCode>String</SkuCode>
          <TaxAmount>0</TaxAmount>
          <TaxPercentage>0</TaxPercentage>
          <VehicleId>String</VehicleId>
          <VersionNumber>String</VersionNumber>
          <VersionYear>String</VersionYear>
        </NAVOrderImportSkuComponent>
      </OrderSkuComponents>
      <OriginalOrderQty>0</OriginalOrderQty>
      <OverrideCVEarned>0</OverrideCVEarned>
      <OverrideCVEarnedSubmitted>0</OverrideCVEarnedSubmitted>
      <OverrideQVEarned>0</OverrideQVEarned>
      <ParentSKUCode>String</ParentSKUCode>
      <PricePaidPerUnit>0</PricePaidPerUnit>
      <QualifyingValueEarned>0</QualifyingValueEarned>
      <QualifyingValueEarnedSubmitted>0</QualifyingValueEarnedSubmitted>
      <Quantity>0</Quantity>
      <RetailPricePerUnit>0</RetailPricePerUnit>
      <SkuCode>String</SkuCode>
      <SubmittedNetPrice>0</SubmittedNetPrice>
      <SubmittedNetSales>0</SubmittedNetSales>
      <SubstituteIndicator>String</SubstituteIndicator>
      <SubstituteSkuCode>String</SubstituteSkuCode>
      <TaxAmount>0</TaxAmount>
      <TaxPercentage>0</TaxPercentage>
      <UplineCVEarned>0</UplineCVEarned>
      <UplineQVEarned>0</UplineQVEarned>
      <VehicleId>String</VehicleId>
      <VersionNumber>String</VersionNumber>
      <VersionYear>String</VersionYear>
    </NAVOrderImportSku>
  </OrderSkus>
  <OrderSource>String</OrderSource>
  <OrderTotal>0</OrderTotal>
  <OrderTypeId>String</OrderTypeId>
  <OrderWithinTimePeriod>0</OrderWithinTimePeriod>
  <OriginalReshipExternalOrderId>String</OriginalReshipExternalOrderId>
  <PCLevel>0</PCLevel>
  <PCLevelCurrentCycle>0</PCLevelCurrentCycle>
  <PhoneNumber>String</PhoneNumber>
  <PremierLevel>String</PremierLevel>
  <PremierLevelCurrentCycle>String</PremierLevelCurrentCycle>
  <SalesCenterId>String</SalesCenterId>
  <ShippedVersionNumber>String</ShippedVersionNumber>
  <ShippedVersionYear>String</ShippedVersionYear>
  <ShippingAddress>
    <AddressLine1>String</AddressLine1>
    <AddressLine2>String</AddressLine2>
    <AddressLine3>String</AddressLine3>
    <AddressLine4>String</AddressLine4>
    <AddressLine5>String</AddressLine5>
    <City>String</City>
    <CountryCode>String</CountryCode>
    <County>String</County>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <PostalCode>String</PostalCode>
    <StateProvinceCode>String</StateProvinceCode>
  </ShippingAddress>
  <ShippingComment>String</ShippingComment>
  <ShippingCost>0</ShippingCost>
  <ShippingMethod>String</ShippingMethod>
  <ShippingTax>0</ShippingTax>
  <SubTotal>0</SubTotal>
  <SubmittedDateUTC>0001-01-01T00:00:00</SubmittedDateUTC>
  <Tax>0</Tax>
  <TaxAreaCode>String</TaxAreaCode>
  <TaxRatePercent>String</TaxRatePercent>
  <VersionNumber>String</VersionNumber>
  <VersionYear>String</VersionYear>
  <WarehouseCode>String</WarehouseCode>
</NAVOrderImport>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NAVOrderImportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</NAVOrderImportResponse>