| POST | /orders/close |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderCloseData | body | NAVOrderClose | No | |
| Shipment | body | List<NAVOrderCloseShipment> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExternalOrderId | form | string | No | |
| OrderTypeId | form | string | No | |
| CreatedDateUTC | form | DateTime? | No | |
| SubmittedDateUTC | form | DateTime? | No | |
| CompletedDateUTC | form | DateTime? | No | |
| BeeNumberCustomer | form | decimal? | No | |
| BeeNumberPayee | form | decimal? | No | |
| OrderSource | form | string | No | |
| ShippingMethod | form | string | No | |
| GiftMessage | form | string | No | |
| GiftMessageFrom | form | string | No | |
| GiftMessageTo | form | string | No | |
| ShippingComment | form | string | No | |
| ShippingAddress | form | NAVOrderCloseAddress | No | |
| OrderSkus | form | List<NAVOrderCloseSku> | No | |
| OrderPayments | form | List<NAVOrderClosePayment> | No | |
| OrderFees | form | List<NAVOrderCloseFee> | No | |
| SubTotal | form | decimal? | No | |
| OrderTotal | form | decimal? | No | |
| ShippingCost | form | decimal? | No | |
| Tax | form | decimal? | No | |
| ShippingTax | form | decimal? | No | |
| ExternalDiscountReason | form | string | No | |
| PCLevel | form | decimal? | No | |
| AgentId | form | string | No | |
| NumberOfCustomersServed | form | decimal? | No | |
| VersionNumber | form | string | No | |
| VersionYear | form | string | No | |
| AdditionalCode | form | string | No | |
| DiscountPercent | form | string | No | |
| TaxRatePercent | form | string | No | |
| OrderWithinTimePeriod | form | decimal? | No | |
| TaxAreaCode | form | string | No | |
| Geocode | form | string | No | |
| FundraiserId | form | string | No | |
| WarehouseCode | form | string | No | |
| OriginalReshipExternalOrderId | form | string | No | |
| ShippedVersionNumber | form | string | No | |
| ShippedVersionYear | form | string | No | |
| MasterOrderId | form | string | No | |
| CouponValue | form | string | No | |
| SalesCenterId | form | string | No | |
| PremierLevel | form | string | No | |
| PCLevelCurrentCycle | form | decimal? | No | |
| PremierLevelCurrentCycle | form | string | No | |
| EmailAddress | form | string | No | |
| PhoneNumber | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | No | |
| LastName | form | string | No | |
| AddressLine1 | form | string | No | |
| AddressLine2 | form | string | No | |
| AddressLine3 | form | string | No | |
| AddressLine4 | form | string | No | |
| AddressLine5 | form | string | No | |
| City | form | string | No | |
| StateProvinceCode | form | string | No | |
| PostalCode | form | string | No | |
| County | form | string | No | |
| CountryCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SkuCode | form | string | No | |
| OrderLineNumber | form | int? | No | |
| Quantity | form | int? | No | |
| IsAutoShip | form | bool? | No | |
| OrderSkuComponents | form | List<NAVOrderCloseSkuComponent> | No | |
| PricePaidPerUnit | form | decimal? | No | |
| RetailPricePerUnit | form | decimal? | No | |
| NetPrice | form | decimal? | No | |
| NetSales | form | decimal? | No | |
| SubmittedNetPrice | form | decimal? | No | |
| SubmittedNetSales | form | decimal? | No | |
| ManualDiscountAmount | form | decimal? | No | |
| ItemDiscountPercent | form | decimal? | No | |
| TaxAmount | form | decimal? | No | |
| TaxPercentage | form | decimal? | No | |
| CommissionableValueEarned | form | decimal? | No | |
| QualifyingValueEarned | form | decimal? | No | |
| QualifyingValueEarnedSubmitted | form | decimal? | No | |
| OverrideCVEarned | form | decimal? | No | |
| OverrideCVEarnedSubmitted | form | decimal? | No | |
| OverrideQVEarned | form | decimal? | No | |
| GroupCVEarned | form | decimal? | No | |
| GroupQVEarned | form | decimal? | No | |
| UplineCVEarned | form | decimal? | No | |
| UplineQVEarned | form | decimal? | No | |
| VersionNumber | form | string | No | |
| VersionYear | form | string | No | |
| CouponCode | form | string | No | |
| SubstituteIndicator | form | string | No | |
| FulfillmentIndicator | form | string | No | |
| SubstituteSkuCode | form | string | No | |
| VehicleId | form | string | No | |
| OfferId | form | string | No | |
| BuyingDiscount | form | decimal? | No | |
| OriginalOrderQty | form | decimal? | No | |
| ParentSKUCode | form | string | No | |
| ClosedQuantity | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ParentOrderLineNumber | form | int? | No | |
| OrderLineNumber | form | int? | No | |
| SkuCode | form | string | No | |
| Quantity | form | int? | No | |
| PricePaidPerUnit | form | decimal? | No | |
| RetailPricePerUnit | form | decimal? | No | |
| NetPrice | form | decimal? | No | |
| TaxAmount | form | decimal? | No | |
| TaxPercentage | form | decimal? | No | |
| VersionNumber | form | string | No | |
| VersionYear | form | string | No | |
| VehicleId | form | string | No | |
| OfferId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentType | form | string | No | |
| PaymentIdentifier1 | form | string | No | |
| PaymentIdentifier2 | form | string | No | |
| PaymentIdentifier3 | form | string | No | |
| PaymentIdentifier4 | form | string | No | |
| PaymentIdentifier5 | form | string | No | |
| PaymentToken | form | string | No | |
| AuthorizationTime | form | DateTime? | No | |
| AuthorizationCode | form | string | No | |
| TransactionId | form | string | No | |
| AmountCharged | form | decimal? | No | |
| BillingAddress | form | NAVOrderCloseAddress | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FeeSystemKeyword | form | string | No | |
| FeeAmount | form | decimal? | No | |
| TaxAmount | form | decimal? | No | |
| FeeTotal | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShipmentDateUTC | form | DateTime? | No | |
| ShippingMethod | form | string | No | |
| ShippingSpeed | form | string | No | |
| TrackingNumber | form | string | No | |
| ShipmentStatus | form | string | No | |
| ShipmentDetails | form | string | No | |
| ShippingCost | form | decimal? | No | |
| Charge | form | decimal? | No | |
| Tax | form | decimal? | No | |
| ActualShippingCost | form | decimal? | No | |
| CartonWeight | form | decimal? | No | |
| OrderShipmentSku | form | List<NAVOrderCloseShipmentSku> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderLineNumber | form | int? | No | |
| QuantityShipped | form | int? | No | |
| SubstituteSkuCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}