| POST | /orders/close |
|---|
import Foundation
import ServiceStack
public class OrderClose : IPost, Codable
{
public var orderCloseData:NAVOrderClose?
public var shipment:[NAVOrderCloseShipment] = []
required public init(){}
}
public class NAVOrderClose : Codable
{
public var externalOrderId:String?
public var orderTypeId:String?
public var createdDateUTC:Date?
public var submittedDateUTC:Date?
public var completedDateUTC:Date?
public var beeNumberCustomer:Double?
public var beeNumberPayee:Double?
public var orderSource:String?
public var shippingMethod:String?
public var giftMessage:String?
public var giftMessageFrom:String?
public var giftMessageTo:String?
public var shippingComment:String?
public var shippingAddress:NAVOrderCloseAddress?
public var orderSkus:[NAVOrderCloseSku] = []
public var orderPayments:[NAVOrderClosePayment] = []
public var orderFees:[NAVOrderCloseFee] = []
public var subTotal:Double?
public var orderTotal:Double?
public var shippingCost:Double?
public var tax:Double?
public var shippingTax:Double?
public var externalDiscountReason:String?
public var pcLevel:Double?
public var agentId:String?
public var numberOfCustomersServed:Double?
public var versionNumber:String?
public var versionYear:String?
public var additionalCode:String?
public var discountPercent:String?
public var taxRatePercent:String?
public var orderWithinTimePeriod:Double?
public var taxAreaCode:String?
public var geocode:String?
public var fundraiserId:String?
public var warehouseCode:String?
public var originalReshipExternalOrderId:String?
public var shippedVersionNumber:String?
public var shippedVersionYear:String?
public var masterOrderId:String?
public var couponValue:String?
public var salesCenterId:String?
public var premierLevel:String?
public var pcLevelCurrentCycle:Double?
public var premierLevelCurrentCycle:String?
public var emailAddress:String?
public var phoneNumber:String?
required public init(){}
}
public class NAVOrderCloseAddress : Codable
{
public var firstName:String?
public var lastName:String?
public var addressLine1:String?
public var addressLine2:String?
public var addressLine3:String?
public var addressLine4:String?
public var addressLine5:String?
public var city:String?
public var stateProvinceCode:String?
public var postalCode:String?
public var county:String?
public var countryCode:String?
required public init(){}
}
public class NAVOrderCloseSku : Codable
{
public var skuCode:String?
public var orderLineNumber:Int?
public var quantity:Int?
public var isAutoShip:Bool?
public var orderSkuComponents:[NAVOrderCloseSkuComponent] = []
public var pricePaidPerUnit:Double?
public var retailPricePerUnit:Double?
public var netPrice:Double?
public var netSales:Double?
public var submittedNetPrice:Double?
public var submittedNetSales:Double?
public var manualDiscountAmount:Double?
public var itemDiscountPercent:Double?
public var taxAmount:Double?
public var taxPercentage:Double?
public var commissionableValueEarned:Double?
public var qualifyingValueEarned:Double?
public var qualifyingValueEarnedSubmitted:Double?
public var overrideCVEarned:Double?
public var overrideCVEarnedSubmitted:Double?
public var overrideQVEarned:Double?
public var groupCVEarned:Double?
public var groupQVEarned:Double?
public var uplineCVEarned:Double?
public var uplineQVEarned:Double?
public var versionNumber:String?
public var versionYear:String?
public var couponCode:String?
public var substituteIndicator:String?
public var fulfillmentIndicator:String?
public var substituteSkuCode:String?
public var vehicleId:String?
public var offerId:String?
public var buyingDiscount:Double?
public var originalOrderQty:Double?
public var parentSKUCode:String?
public var closedQuantity:Double?
required public init(){}
}
public class NAVOrderCloseSkuComponent : Codable
{
public var parentOrderLineNumber:Int?
public var orderLineNumber:Int?
public var skuCode:String?
public var quantity:Int?
public var pricePaidPerUnit:Double?
public var retailPricePerUnit:Double?
public var netPrice:Double?
public var taxAmount:Double?
public var taxPercentage:Double?
public var versionNumber:String?
public var versionYear:String?
public var vehicleId:String?
public var offerId:String?
required public init(){}
}
public class NAVOrderClosePayment : Codable
{
public var paymentType:String?
public var paymentIdentifier1:String?
public var paymentIdentifier2:String?
public var paymentIdentifier3:String?
public var paymentIdentifier4:String?
public var paymentIdentifier5:String?
public var paymentToken:String?
public var authorizationTime:Date?
public var authorizationCode:String?
public var transactionId:String?
public var amountCharged:Double?
public var billingAddress:NAVOrderCloseAddress?
required public init(){}
}
public class NAVOrderCloseFee : Codable
{
public var feeSystemKeyword:String?
public var feeAmount:Double?
public var taxAmount:Double?
public var feeTotal:Double?
required public init(){}
}
public class NAVOrderCloseShipment : Codable
{
public var shipmentDateUTC:Date?
public var shippingMethod:String?
public var shippingSpeed:String?
public var trackingNumber:String?
public var shipmentStatus:String?
public var shipmentDetails:String?
public var shippingCost:Double?
public var charge:Double?
public var tax:Double?
public var actualShippingCost:Double?
public var cartonWeight:Double?
public var orderShipmentSku:[NAVOrderCloseShipmentSku] = []
required public init(){}
}
public class NAVOrderCloseShipmentSku : Codable
{
public var orderLineNumber:Int?
public var quantityShipped:Int?
public var substituteSkuCode:String?
required public init(){}
}
public class OrderCloseResponse : Codable
{
public var responseStatus:ResponseStatus?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>