NAV

<back to all web services

OrderClose

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

export class OrderCloseResponse
{
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<OrderCloseResponse>) { (Object as any).assign(this, init); }
}

export class NAVOrderCloseAddress
{
    public firstName?: string;
    public lastName?: string;
    public addressLine1?: string;
    public addressLine2?: string;
    public addressLine3?: string;
    public addressLine4?: string;
    public addressLine5?: string;
    public city?: string;
    public stateProvinceCode?: string;
    public postalCode?: string;
    public county?: string;
    public countryCode?: string;

    public constructor(init?: Partial<NAVOrderCloseAddress>) { (Object as any).assign(this, init); }
}

export class NAVOrderCloseSkuComponent
{
    public parentOrderLineNumber?: number;
    public orderLineNumber?: number;
    public skuCode?: string;
    public quantity?: number;
    public pricePaidPerUnit?: number;
    public retailPricePerUnit?: number;
    public netPrice?: number;
    public taxAmount?: number;
    public taxPercentage?: number;
    public versionNumber?: string;
    public versionYear?: string;
    public vehicleId?: string;
    public offerId?: string;

    public constructor(init?: Partial<NAVOrderCloseSkuComponent>) { (Object as any).assign(this, init); }
}

export class NAVOrderCloseSku
{
    public skuCode?: string;
    public orderLineNumber?: number;
    public quantity?: number;
    public isAutoShip?: boolean;
    public orderSkuComponents?: NAVOrderCloseSkuComponent[];
    public pricePaidPerUnit?: number;
    public retailPricePerUnit?: number;
    public netPrice?: number;
    public netSales?: number;
    public submittedNetPrice?: number;
    public submittedNetSales?: number;
    public manualDiscountAmount?: number;
    public itemDiscountPercent?: number;
    public taxAmount?: number;
    public taxPercentage?: number;
    public commissionableValueEarned?: number;
    public qualifyingValueEarned?: number;
    public qualifyingValueEarnedSubmitted?: number;
    public overrideCVEarned?: number;
    public overrideCVEarnedSubmitted?: number;
    public overrideQVEarned?: number;
    public groupCVEarned?: number;
    public groupQVEarned?: number;
    public uplineCVEarned?: number;
    public uplineQVEarned?: number;
    public versionNumber?: string;
    public versionYear?: string;
    public couponCode?: string;
    public substituteIndicator?: string;
    public fulfillmentIndicator?: string;
    public substituteSkuCode?: string;
    public vehicleId?: string;
    public offerId?: string;
    public buyingDiscount?: number;
    public originalOrderQty?: number;
    public parentSKUCode?: string;
    public closedQuantity?: number;

    public constructor(init?: Partial<NAVOrderCloseSku>) { (Object as any).assign(this, init); }
}

export class NAVOrderClosePayment
{
    public paymentType?: string;
    public paymentIdentifier1?: string;
    public paymentIdentifier2?: string;
    public paymentIdentifier3?: string;
    public paymentIdentifier4?: string;
    public paymentIdentifier5?: string;
    public paymentToken?: string;
    public authorizationTime?: string;
    public authorizationCode?: string;
    public transactionId?: string;
    public amountCharged?: number;
    public billingAddress?: NAVOrderCloseAddress;

    public constructor(init?: Partial<NAVOrderClosePayment>) { (Object as any).assign(this, init); }
}

export class NAVOrderCloseFee
{
    public feeSystemKeyword?: string;
    public feeAmount?: number;
    public taxAmount?: number;
    public feeTotal?: number;

    public constructor(init?: Partial<NAVOrderCloseFee>) { (Object as any).assign(this, init); }
}

export class NAVOrderClose
{
    public externalOrderId?: string;
    public orderTypeId?: string;
    public createdDateUTC?: string;
    public submittedDateUTC?: string;
    public completedDateUTC?: string;
    public beeNumberCustomer?: number;
    public beeNumberPayee?: number;
    public orderSource?: string;
    public shippingMethod?: string;
    public giftMessage?: string;
    public giftMessageFrom?: string;
    public giftMessageTo?: string;
    public shippingComment?: string;
    public shippingAddress?: NAVOrderCloseAddress;
    public orderSkus?: NAVOrderCloseSku[];
    public orderPayments?: NAVOrderClosePayment[];
    public orderFees?: NAVOrderCloseFee[];
    public subTotal?: number;
    public orderTotal?: number;
    public shippingCost?: number;
    public tax?: number;
    public shippingTax?: number;
    public externalDiscountReason?: string;
    public pcLevel?: number;
    public agentId?: string;
    public numberOfCustomersServed?: number;
    public versionNumber?: string;
    public versionYear?: string;
    public additionalCode?: string;
    public discountPercent?: string;
    public taxRatePercent?: string;
    public orderWithinTimePeriod?: number;
    public taxAreaCode?: string;
    public geocode?: string;
    public fundraiserId?: string;
    public warehouseCode?: string;
    public originalReshipExternalOrderId?: string;
    public shippedVersionNumber?: string;
    public shippedVersionYear?: string;
    public masterOrderId?: string;
    public couponValue?: string;
    public salesCenterId?: string;
    public premierLevel?: string;
    public pcLevelCurrentCycle?: number;
    public premierLevelCurrentCycle?: string;
    public emailAddress?: string;
    public phoneNumber?: string;

    public constructor(init?: Partial<NAVOrderClose>) { (Object as any).assign(this, init); }
}

export class NAVOrderCloseShipmentSku
{
    public orderLineNumber?: number;
    public quantityShipped?: number;
    public substituteSkuCode?: string;

    public constructor(init?: Partial<NAVOrderCloseShipmentSku>) { (Object as any).assign(this, init); }
}

export class NAVOrderCloseShipment
{
    public shipmentDateUTC?: string;
    public shippingMethod?: string;
    public shippingSpeed?: string;
    public trackingNumber?: string;
    public shipmentStatus?: string;
    public shipmentDetails?: string;
    public shippingCost?: number;
    public charge?: number;
    public tax?: number;
    public actualShippingCost?: number;
    public cartonWeight?: number;
    public orderShipmentSku?: NAVOrderCloseShipmentSku[];

    public constructor(init?: Partial<NAVOrderCloseShipment>) { (Object as any).assign(this, init); }
}

export class OrderClose implements IPost
{
    public orderCloseData?: NAVOrderClose;
    public shipment?: NAVOrderCloseShipment[];

    public constructor(init?: Partial<OrderClose>) { (Object as any).assign(this, init); }
}

TypeScript 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"}}}