NAV

<back to all web services

OrderClose

The following routes are available for this service:
POST/orders/close
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports NAV.ServiceModel

Namespace Global

    Namespace NAV.ServiceModel

        Public Partial Class NAVOrderClose
            Public Sub New()
                OrderSkus = New List(Of NAVOrderCloseSku)
                OrderPayments = New List(Of NAVOrderClosePayment)
                OrderFees = New List(Of NAVOrderCloseFee)
            End Sub

            Public Overridable Property ExternalOrderId As String
            Public Overridable Property OrderTypeId As String
            Public Overridable Property CreatedDateUTC As Nullable(Of Date)
            Public Overridable Property SubmittedDateUTC As Nullable(Of Date)
            Public Overridable Property CompletedDateUTC As Nullable(Of Date)
            Public Overridable Property BeeNumberCustomer As Nullable(Of Decimal)
            Public Overridable Property BeeNumberPayee As Nullable(Of Decimal)
            Public Overridable Property OrderSource As String
            Public Overridable Property ShippingMethod As String
            Public Overridable Property GiftMessage As String
            Public Overridable Property GiftMessageFrom As String
            Public Overridable Property GiftMessageTo As String
            Public Overridable Property ShippingComment As String
            Public Overridable Property ShippingAddress As NAVOrderCloseAddress
            Public Overridable Property OrderSkus As List(Of NAVOrderCloseSku)
            Public Overridable Property OrderPayments As List(Of NAVOrderClosePayment)
            Public Overridable Property OrderFees As List(Of NAVOrderCloseFee)
            Public Overridable Property SubTotal As Nullable(Of Decimal)
            Public Overridable Property OrderTotal As Nullable(Of Decimal)
            Public Overridable Property ShippingCost As Nullable(Of Decimal)
            Public Overridable Property Tax As Nullable(Of Decimal)
            Public Overridable Property ShippingTax As Nullable(Of Decimal)
            Public Overridable Property ExternalDiscountReason As String
            Public Overridable Property PCLevel As Nullable(Of Decimal)
            Public Overridable Property AgentId As String
            Public Overridable Property NumberOfCustomersServed As Nullable(Of Decimal)
            Public Overridable Property VersionNumber As String
            Public Overridable Property VersionYear As String
            Public Overridable Property AdditionalCode As String
            Public Overridable Property DiscountPercent As String
            Public Overridable Property TaxRatePercent As String
            Public Overridable Property OrderWithinTimePeriod As Nullable(Of Decimal)
            Public Overridable Property TaxAreaCode As String
            Public Overridable Property Geocode As String
            Public Overridable Property FundraiserId As String
            Public Overridable Property WarehouseCode As String
            Public Overridable Property OriginalReshipExternalOrderId As String
            Public Overridable Property ShippedVersionNumber As String
            Public Overridable Property ShippedVersionYear As String
            Public Overridable Property MasterOrderId As String
            Public Overridable Property CouponValue As String
            Public Overridable Property SalesCenterId As String
            Public Overridable Property PremierLevel As String
            Public Overridable Property PCLevelCurrentCycle As Nullable(Of Decimal)
            Public Overridable Property PremierLevelCurrentCycle As String
            Public Overridable Property EmailAddress As String
            Public Overridable Property PhoneNumber As String
        End Class

        Public Partial Class NAVOrderCloseAddress
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property AddressLine1 As String
            Public Overridable Property AddressLine2 As String
            Public Overridable Property AddressLine3 As String
            Public Overridable Property AddressLine4 As String
            Public Overridable Property AddressLine5 As String
            Public Overridable Property City As String
            Public Overridable Property StateProvinceCode As String
            Public Overridable Property PostalCode As String
            Public Overridable Property County As String
            Public Overridable Property CountryCode As String
        End Class

        Public Partial Class NAVOrderCloseFee
            Public Overridable Property FeeSystemKeyword As String
            Public Overridable Property FeeAmount As Nullable(Of Decimal)
            Public Overridable Property TaxAmount As Nullable(Of Decimal)
            Public Overridable Property FeeTotal As Nullable(Of Decimal)
        End Class

        Public Partial Class NAVOrderClosePayment
            Public Overridable Property PaymentType As String
            Public Overridable Property PaymentIdentifier1 As String
            Public Overridable Property PaymentIdentifier2 As String
            Public Overridable Property PaymentIdentifier3 As String
            Public Overridable Property PaymentIdentifier4 As String
            Public Overridable Property PaymentIdentifier5 As String
            Public Overridable Property PaymentToken As String
            Public Overridable Property AuthorizationTime As Nullable(Of Date)
            Public Overridable Property AuthorizationCode As String
            Public Overridable Property TransactionId As String
            Public Overridable Property AmountCharged As Nullable(Of Decimal)
            Public Overridable Property BillingAddress As NAVOrderCloseAddress
        End Class

        Public Partial Class NAVOrderCloseShipment
            Public Sub New()
                OrderShipmentSku = New List(Of NAVOrderCloseShipmentSku)
            End Sub

            Public Overridable Property ShipmentDateUTC As Nullable(Of Date)
            Public Overridable Property ShippingMethod As String
            Public Overridable Property ShippingSpeed As String
            Public Overridable Property TrackingNumber As String
            Public Overridable Property ShipmentStatus As String
            Public Overridable Property ShipmentDetails As String
            Public Overridable Property ShippingCost As Nullable(Of Decimal)
            Public Overridable Property Charge As Nullable(Of Decimal)
            Public Overridable Property Tax As Nullable(Of Decimal)
            Public Overridable Property ActualShippingCost As Nullable(Of Decimal)
            Public Overridable Property CartonWeight As Nullable(Of Decimal)
            Public Overridable Property OrderShipmentSku As List(Of NAVOrderCloseShipmentSku)
        End Class

        Public Partial Class NAVOrderCloseShipmentSku
            Public Overridable Property OrderLineNumber As Nullable(Of Integer)
            Public Overridable Property QuantityShipped As Nullable(Of Integer)
            Public Overridable Property SubstituteSkuCode As String
        End Class

        Public Partial Class NAVOrderCloseSku
            Public Sub New()
                OrderSkuComponents = New List(Of NAVOrderCloseSkuComponent)
            End Sub

            Public Overridable Property SkuCode As String
            Public Overridable Property OrderLineNumber As Nullable(Of Integer)
            Public Overridable Property Quantity As Nullable(Of Integer)
            Public Overridable Property IsAutoShip As Nullable(Of Boolean)
            Public Overridable Property OrderSkuComponents As List(Of NAVOrderCloseSkuComponent)
            Public Overridable Property PricePaidPerUnit As Nullable(Of Decimal)
            Public Overridable Property RetailPricePerUnit As Nullable(Of Decimal)
            Public Overridable Property NetPrice As Nullable(Of Decimal)
            Public Overridable Property NetSales As Nullable(Of Decimal)
            Public Overridable Property SubmittedNetPrice As Nullable(Of Decimal)
            Public Overridable Property SubmittedNetSales As Nullable(Of Decimal)
            Public Overridable Property ManualDiscountAmount As Nullable(Of Decimal)
            Public Overridable Property ItemDiscountPercent As Nullable(Of Decimal)
            Public Overridable Property TaxAmount As Nullable(Of Decimal)
            Public Overridable Property TaxPercentage As Nullable(Of Decimal)
            Public Overridable Property CommissionableValueEarned As Nullable(Of Decimal)
            Public Overridable Property QualifyingValueEarned As Nullable(Of Decimal)
            Public Overridable Property QualifyingValueEarnedSubmitted As Nullable(Of Decimal)
            Public Overridable Property OverrideCVEarned As Nullable(Of Decimal)
            Public Overridable Property OverrideCVEarnedSubmitted As Nullable(Of Decimal)
            Public Overridable Property OverrideQVEarned As Nullable(Of Decimal)
            Public Overridable Property GroupCVEarned As Nullable(Of Decimal)
            Public Overridable Property GroupQVEarned As Nullable(Of Decimal)
            Public Overridable Property UplineCVEarned As Nullable(Of Decimal)
            Public Overridable Property UplineQVEarned As Nullable(Of Decimal)
            Public Overridable Property VersionNumber As String
            Public Overridable Property VersionYear As String
            Public Overridable Property CouponCode As String
            Public Overridable Property SubstituteIndicator As String
            Public Overridable Property FulfillmentIndicator As String
            Public Overridable Property SubstituteSkuCode As String
            Public Overridable Property VehicleId As String
            Public Overridable Property OfferId As String
            Public Overridable Property BuyingDiscount As Nullable(Of Decimal)
            Public Overridable Property OriginalOrderQty As Nullable(Of Decimal)
            Public Overridable Property ParentSKUCode As String
            Public Overridable Property ClosedQuantity As Nullable(Of Decimal)
        End Class

        Public Partial Class NAVOrderCloseSkuComponent
            Public Overridable Property ParentOrderLineNumber As Nullable(Of Integer)
            Public Overridable Property OrderLineNumber As Nullable(Of Integer)
            Public Overridable Property SkuCode As String
            Public Overridable Property Quantity As Nullable(Of Integer)
            Public Overridable Property PricePaidPerUnit As Nullable(Of Decimal)
            Public Overridable Property RetailPricePerUnit As Nullable(Of Decimal)
            Public Overridable Property NetPrice As Nullable(Of Decimal)
            Public Overridable Property TaxAmount As Nullable(Of Decimal)
            Public Overridable Property TaxPercentage As Nullable(Of Decimal)
            Public Overridable Property VersionNumber As String
            Public Overridable Property VersionYear As String
            Public Overridable Property VehicleId As String
            Public Overridable Property OfferId As String
        End Class

        Public Partial Class OrderClose
            Implements IPost
            Public Sub New()
                Shipment = New List(Of NAVOrderCloseShipment)
            End Sub

            Public Overridable Property OrderCloseData As NAVOrderClose
            Public Overridable Property Shipment As List(Of NAVOrderCloseShipment)
        End Class

        Public Partial Class OrderCloseResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET OrderClose DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"orderCloseData":{"externalOrderId":"String","orderTypeId":"String","createdDateUTC":"0001-01-01T00:00:00.0000000","submittedDateUTC":"0001-01-01T00:00:00.0000000","completedDateUTC":"0001-01-01T00:00:00.0000000","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","buyingDiscount":0,"originalOrderQty":0,"parentSKUCode":"String","closedQuantity":0}],"orderPayments":[{"paymentType":"String","paymentIdentifier1":"String","paymentIdentifier2":"String","paymentIdentifier3":"String","paymentIdentifier4":"String","paymentIdentifier5":"String","paymentToken":"String","authorizationTime":"0001-01-01T00:00:00.0000000","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"},"shipment":[{"shipmentDateUTC":"0001-01-01T00:00:00.0000000","shippingMethod":"String","shippingSpeed":"String","trackingNumber":"String","shipmentStatus":"String","shipmentDetails":"String","shippingCost":0,"charge":0,"tax":0,"actualShippingCost":0,"cartonWeight":0,"orderShipmentSku":[{"orderLineNumber":0,"quantityShipped":0,"substituteSkuCode":"String"}]}]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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