NAV

OrderClose

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class OrderClose : IPost
{
    var orderCloseData:NAVOrderClose? = null
    var shipment:ArrayList<NAVOrderCloseShipment> = ArrayList<NAVOrderCloseShipment>()
}

open class NAVOrderClose
{
    var externalOrderId:String? = null
    var orderTypeId:String? = null
    var createdDateUTC:Date? = null
    var submittedDateUTC:Date? = null
    var completedDateUTC:Date? = null
    var beeNumberCustomer:BigDecimal? = null
    var beeNumberPayee:BigDecimal? = null
    var orderSource:String? = null
    var shippingMethod:String? = null
    var giftMessage:String? = null
    var giftMessageFrom:String? = null
    var giftMessageTo:String? = null
    var shippingComment:String? = null
    var shippingAddress:NAVOrderCloseAddress? = null
    var orderSkus:ArrayList<NAVOrderCloseSku> = ArrayList<NAVOrderCloseSku>()
    var orderPayments:ArrayList<NAVOrderClosePayment> = ArrayList<NAVOrderClosePayment>()
    var orderFees:ArrayList<NAVOrderCloseFee> = ArrayList<NAVOrderCloseFee>()
    var subTotal:BigDecimal? = null
    var orderTotal:BigDecimal? = null
    var shippingCost:BigDecimal? = null
    var tax:BigDecimal? = null
    var shippingTax:BigDecimal? = null
    var externalDiscountReason:String? = null
    var pcLevel:BigDecimal? = null
    var agentId:String? = null
    var numberOfCustomersServed:BigDecimal? = null
    var versionNumber:String? = null
    var versionYear:String? = null
    var additionalCode:String? = null
    var discountPercent:String? = null
    var taxRatePercent:String? = null
    var orderWithinTimePeriod:BigDecimal? = null
    var taxAreaCode:String? = null
    var geocode:String? = null
    var fundraiserId:String? = null
    var warehouseCode:String? = null
    var originalReshipExternalOrderId:String? = null
    var shippedVersionNumber:String? = null
    var shippedVersionYear:String? = null
    var masterOrderId:String? = null
    var couponValue:String? = null
    var salesCenterId:String? = null
    var premierLevel:String? = null
    var pcLevelCurrentCycle:BigDecimal? = null
    var premierLevelCurrentCycle:String? = null
    var emailAddress:String? = null
    var phoneNumber:String? = null
}

open class NAVOrderCloseAddress
{
    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 NAVOrderCloseSku
{
    var skuCode:String? = null
    var orderLineNumber:Int? = null
    var quantity:Int? = null
    var isAutoShip:Boolean? = null
    var orderSkuComponents:ArrayList<NAVOrderCloseSkuComponent> = ArrayList<NAVOrderCloseSkuComponent>()
    var pricePaidPerUnit:BigDecimal? = null
    var retailPricePerUnit:BigDecimal? = null
    var netPrice:BigDecimal? = null
    var netSales:BigDecimal? = null
    var submittedNetPrice:BigDecimal? = null
    var submittedNetSales:BigDecimal? = null
    var manualDiscountAmount:BigDecimal? = null
    var itemDiscountPercent:BigDecimal? = null
    var taxAmount:BigDecimal? = null
    var taxPercentage:BigDecimal? = null
    var commissionableValueEarned:BigDecimal? = null
    var qualifyingValueEarned:BigDecimal? = null
    var qualifyingValueEarnedSubmitted:BigDecimal? = null
    var overrideCVEarned:BigDecimal? = null
    var overrideCVEarnedSubmitted:BigDecimal? = null
    var overrideQVEarned:BigDecimal? = null
    var groupCVEarned:BigDecimal? = null
    var groupQVEarned:BigDecimal? = null
    var uplineCVEarned:BigDecimal? = null
    var uplineQVEarned:BigDecimal? = null
    var versionNumber:String? = null
    var versionYear:String? = null
    var couponCode:String? = null
    var substituteIndicator:String? = null
    var fulfillmentIndicator:String? = null
    var substituteSkuCode:String? = null
    var vehicleId:String? = null
    var offerId:String? = null
    var buyingDiscount:BigDecimal? = null
    var originalOrderQty:BigDecimal? = null
    var parentSKUCode:String? = null
    var closedQuantity:BigDecimal? = null
}

open class NAVOrderCloseSkuComponent
{
    var parentOrderLineNumber:Int? = null
    var orderLineNumber:Int? = null
    var skuCode:String? = null
    var quantity:Int? = null
    var pricePaidPerUnit:BigDecimal? = null
    var retailPricePerUnit:BigDecimal? = null
    var netPrice:BigDecimal? = null
    var taxAmount:BigDecimal? = null
    var taxPercentage:BigDecimal? = null
    var versionNumber:String? = null
    var versionYear:String? = null
    var vehicleId:String? = null
    var offerId:String? = null
}

open class NAVOrderClosePayment
{
    var paymentType:String? = null
    var paymentIdentifier1:String? = null
    var paymentIdentifier2:String? = null
    var paymentIdentifier3:String? = null
    var paymentIdentifier4:String? = null
    var paymentIdentifier5:String? = null
    var paymentToken:String? = null
    var authorizationTime:Date? = null
    var authorizationCode:String? = null
    var transactionId:String? = null
    var amountCharged:BigDecimal? = null
    var billingAddress:NAVOrderCloseAddress? = null
}

open class NAVOrderCloseFee
{
    var feeSystemKeyword:String? = null
    var feeAmount:BigDecimal? = null
    var taxAmount:BigDecimal? = null
    var feeTotal:BigDecimal? = null
}

open class NAVOrderCloseShipment
{
    var shipmentDateUTC:Date? = null
    var shippingMethod:String? = null
    var shippingSpeed:String? = null
    var trackingNumber:String? = null
    var shipmentStatus:String? = null
    var shipmentDetails:String? = null
    var shippingCost:BigDecimal? = null
    var charge:BigDecimal? = null
    var tax:BigDecimal? = null
    var actualShippingCost:BigDecimal? = null
    var cartonWeight:BigDecimal? = null
    var orderShipmentSku:ArrayList<NAVOrderCloseShipmentSku> = ArrayList<NAVOrderCloseShipmentSku>()
}

open class NAVOrderCloseShipmentSku
{
    var orderLineNumber:Int? = null
    var quantityShipped:Int? = null
    var substituteSkuCode:String? = null
}

open class OrderCloseResponse
{
    var responseStatus:ResponseStatus? = null
}

Kotlin OrderClose 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/close HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OrderClose xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <OrderCloseData>
    <AdditionalCode>String</AdditionalCode>
    <AgentId>String</AgentId>
    <BeeNumberCustomer>0</BeeNumberCustomer>
    <BeeNumberPayee>0</BeeNumberPayee>
    <CompletedDateUTC>0001-01-01T00:00:00</CompletedDateUTC>
    <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>
      <NAVOrderCloseFee>
        <FeeAmount>0</FeeAmount>
        <FeeSystemKeyword>String</FeeSystemKeyword>
        <FeeTotal>0</FeeTotal>
        <TaxAmount>0</TaxAmount>
      </NAVOrderCloseFee>
    </OrderFees>
    <OrderPayments>
      <NAVOrderClosePayment>
        <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>
      </NAVOrderClosePayment>
    </OrderPayments>
    <OrderSkus>
      <NAVOrderCloseSku>
        <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>
          <NAVOrderCloseSkuComponent>
            <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>
          </NAVOrderCloseSkuComponent>
        </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>
      </NAVOrderCloseSku>
    </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>
  </OrderCloseData>
  <Shipment>
    <NAVOrderCloseShipment>
      <ActualShippingCost>0</ActualShippingCost>
      <CartonWeight>0</CartonWeight>
      <Charge>0</Charge>
      <OrderShipmentSku>
        <NAVOrderCloseShipmentSku>
          <OrderLineNumber>0</OrderLineNumber>
          <QuantityShipped>0</QuantityShipped>
          <SubstituteSkuCode>String</SubstituteSkuCode>
        </NAVOrderCloseShipmentSku>
      </OrderShipmentSku>
      <ShipmentDateUTC>0001-01-01T00:00:00</ShipmentDateUTC>
      <ShipmentDetails>String</ShipmentDetails>
      <ShipmentStatus>String</ShipmentStatus>
      <ShippingCost>0</ShippingCost>
      <ShippingMethod>String</ShippingMethod>
      <ShippingSpeed>String</ShippingSpeed>
      <Tax>0</Tax>
      <TrackingNumber>String</TrackingNumber>
    </NAVOrderCloseShipment>
  </Shipment>
</OrderClose>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrderCloseResponse 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>
</OrderCloseResponse>