NAV

OrderClose

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

namespace NAV.ServiceModel

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

    [<AllowNullLiteral>]
    type OrderCloseResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type NAVOrderCloseAddress() = 
        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 NAVOrderCloseSkuComponent() = 
        member val ParentOrderLineNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OrderLineNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SkuCode:String = null with get,set
        member val Quantity:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PricePaidPerUnit:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val RetailPricePerUnit:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val NetPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TaxAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TaxPercentage:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val VersionNumber:String = null with get,set
        member val VersionYear:String = null with get,set
        member val VehicleId:String = null with get,set
        member val OfferId:String = null with get,set

    [<AllowNullLiteral>]
    type NAVOrderCloseSku() = 
        member val SkuCode:String = null with get,set
        member val OrderLineNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Quantity:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsAutoShip:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val OrderSkuComponents:ResizeArray<NAVOrderCloseSkuComponent> = new ResizeArray<NAVOrderCloseSkuComponent>() with get,set
        member val PricePaidPerUnit:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val RetailPricePerUnit:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val NetPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val NetSales:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val SubmittedNetPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val SubmittedNetSales:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ManualDiscountAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ItemDiscountPercent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TaxAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TaxPercentage:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CommissionableValueEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val QualifyingValueEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val QualifyingValueEarnedSubmitted:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OverrideCVEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OverrideCVEarnedSubmitted:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OverrideQVEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val GroupCVEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val GroupQVEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val UplineCVEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val UplineQVEarned:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val VersionNumber:String = null with get,set
        member val VersionYear:String = null with get,set
        member val CouponCode:String = null with get,set
        member val SubstituteIndicator:String = null with get,set
        member val FulfillmentIndicator:String = null with get,set
        member val SubstituteSkuCode:String = null with get,set
        member val VehicleId:String = null with get,set
        member val OfferId:String = null with get,set
        member val BuyingDiscount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OriginalOrderQty:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ParentSKUCode:String = null with get,set
        member val ClosedQuantity:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type NAVOrderClosePayment() = 
        member val PaymentType:String = null with get,set
        member val PaymentIdentifier1:String = null with get,set
        member val PaymentIdentifier2:String = null with get,set
        member val PaymentIdentifier3:String = null with get,set
        member val PaymentIdentifier4:String = null with get,set
        member val PaymentIdentifier5:String = null with get,set
        member val PaymentToken:String = null with get,set
        member val AuthorizationTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AuthorizationCode:String = null with get,set
        member val TransactionId:String = null with get,set
        member val AmountCharged:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val BillingAddress:NAVOrderCloseAddress = null with get,set

    [<AllowNullLiteral>]
    type NAVOrderCloseFee() = 
        member val FeeSystemKeyword:String = null with get,set
        member val FeeAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TaxAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val FeeTotal:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type NAVOrderClose() = 
        member val ExternalOrderId:String = null with get,set
        member val OrderTypeId:String = null with get,set
        member val CreatedDateUTC:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SubmittedDateUTC:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CompletedDateUTC:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val BeeNumberCustomer:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val BeeNumberPayee:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OrderSource:String = null with get,set
        member val ShippingMethod:String = null with get,set
        member val GiftMessage:String = null with get,set
        member val GiftMessageFrom:String = null with get,set
        member val GiftMessageTo:String = null with get,set
        member val ShippingComment:String = null with get,set
        member val ShippingAddress:NAVOrderCloseAddress = null with get,set
        member val OrderSkus:ResizeArray<NAVOrderCloseSku> = new ResizeArray<NAVOrderCloseSku>() with get,set
        member val OrderPayments:ResizeArray<NAVOrderClosePayment> = new ResizeArray<NAVOrderClosePayment>() with get,set
        member val OrderFees:ResizeArray<NAVOrderCloseFee> = new ResizeArray<NAVOrderCloseFee>() with get,set
        member val SubTotal:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OrderTotal:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ShippingCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Tax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ShippingTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ExternalDiscountReason:String = null with get,set
        member val PCLevel:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AgentId:String = null with get,set
        member val NumberOfCustomersServed:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val VersionNumber:String = null with get,set
        member val VersionYear:String = null with get,set
        member val AdditionalCode:String = null with get,set
        member val DiscountPercent:String = null with get,set
        member val TaxRatePercent:String = null with get,set
        member val OrderWithinTimePeriod:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TaxAreaCode:String = null with get,set
        member val Geocode:String = null with get,set
        member val FundraiserId:String = null with get,set
        member val WarehouseCode:String = null with get,set
        member val OriginalReshipExternalOrderId:String = null with get,set
        member val ShippedVersionNumber:String = null with get,set
        member val ShippedVersionYear:String = null with get,set
        member val MasterOrderId:String = null with get,set
        member val CouponValue:String = null with get,set
        member val SalesCenterId:String = null with get,set
        member val PremierLevel:String = null with get,set
        member val PCLevelCurrentCycle:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PremierLevelCurrentCycle:String = null with get,set
        member val EmailAddress:String = null with get,set
        member val PhoneNumber:String = null with get,set

    [<AllowNullLiteral>]
    type NAVOrderCloseShipmentSku() = 
        member val OrderLineNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val QuantityShipped:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SubstituteSkuCode:String = null with get,set

    [<AllowNullLiteral>]
    type NAVOrderCloseShipment() = 
        member val ShipmentDateUTC:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ShippingMethod:String = null with get,set
        member val ShippingSpeed:String = null with get,set
        member val TrackingNumber:String = null with get,set
        member val ShipmentStatus:String = null with get,set
        member val ShipmentDetails:String = null with get,set
        member val ShippingCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Charge:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Tax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val ActualShippingCost:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CartonWeight:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OrderShipmentSku:ResizeArray<NAVOrderCloseShipmentSku> = new ResizeArray<NAVOrderCloseShipmentSku>() with get,set

    [<AllowNullLiteral>]
    type OrderClose() = 
        interface IPost
        member val OrderCloseData:NAVOrderClose = null with get,set
        member val Shipment:ResizeArray<NAVOrderCloseShipment> = new ResizeArray<NAVOrderCloseShipment>() with get,set

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