Overview

The Orders to Fulfill feed provides a shopper's new order to the Warehouse Management System (WMS) for fulfillment. The order record contains the necessary data to pick, pack, and ship an order and to print a packing slip.

Notes:

  • Default Character Encoding: Unicode: UTF-8
  • Recipient Acknowledgment or Order Confirmation Required: Client Specific
  • Exchange Frequency: Client Specific
  • Production Mailbox Location: Client Specific
  • Test Mailbox Location: Client Specific
  • By default, realtime OTF events are generated and transmitted to the WMS or third-party fulfiller. A batched transmission feature is available on request only.

Schema

Order to Fulfill schema: OrdersToFulfill.xsd

API Structure

Order to Fulfill element table: OrdersToFulfill.xsd.html

Examples

Data Keys

Charge Category

Description

LineCheckPaymentDiscountAmount

Check Payment Discount

LineCODSurchargeAmount

COD Surcharge

LineCustomizationAmount

Customization

LineCustomizationCreditAmount

Customization Credit

LineCustomizationDiscAmount

Customization Discount

LineCVSSurchargeAmount

CVS Surcharge

LineDiscountAmount

Discount

LineDutyAmount

Duty

LineDutyCreditAmount

Duty Credit

LineFeesAmount

Fees

LineFeesCreditAmount

Fees Credit

LineGiftWrapAmount

Gift Wrap

LineGiftWrapCreditAmount

Gift Wrap Credit

LineGiftWrapDiscountAmount

Gift Wrap Discount

LineHFRAmount

HFR

LineHFRCreditAmount

HFR Credit

LineInventorySetChargeAmount

Inventory Set Charge

LineInventorySetDiscountAmount

Inventory Set Discount

LineMerchandiseDiscountAmount

Merchandise Discount

LinePriceAdjustmentAmount

Price Adjustment

LineShippingAmount

Shipping

LineShippingCreditAmount

Shipping Credit

LineShippingDiscountAmount

Shipping Discount

LineTaxCreditAmount

Tax Credit

LineWEEEFeesAmount

WEEE Fees

LineZCRChargeAmount

ZCR Charge

DELIVERY

Delivery instructions

DST_GIFT

Destination-level gifting instructions

DST_PACK

Destination level packslip instructions

GIFT

Line level gifting instructions

OTHER

Miscellaneous

PACK

Line level pack slip instructions

SHOPRUNNER

Shop runner comments

SHPGRPNAME

Ship group name

Invoice Amount Type

Description

TotalCheckPaymentDiscountAmount

Total Check Payment Discount Amount

TotalCheckPaymentDiscountTaxAmount

Total Check Payment Discount Tax Amount

TotalCODSurchargeAmount

Total COD Surcharge Amount

TotalCODSurchargeTaxAmount

Total COD Surcharge Tax Amount

TotalCustomizationAmount

Total invoice customization charges

TotalCustomizationCreditAmount

Total Customization Credit Amount

TotalCustomizationCreditTaxAmount

Total Customization Credit Tax Amount

TotalCustomizationDiscAmount

Total Customization Discount Amount

TotalCustomizationDiscTaxAmount

Total Customization Discount Tax Amount

TotalCustomizationTaxAmount

Total Customization Tax Amount

TotalCVSSurchargeAmount

Total CVS Surcharge Amount

TotalCVSSurchargeTaxAmount

Total CVS Surcharge Tax Amount

TotalDiscountAmount

Total Discount Amount

TotalDiscountTaxAmount

Total Discount Tax Amount

TotalDutyAmount

Total Invoice duties amount

TotalDutyCreditAmount

Total Duty Credit Amount

TotalDutyCreditTaxAmount

Total Duty Credit Tax Amount

TotalDutyTaxAmount

Total Duty Tax Amount

TotalFeesAmount

Total Fees Amount

TotalFeesCreditAmount

Total Fees Credit Amount

TotalFeesCreditTaxAmount

Total Fees Credit Tax Amount

TotalFeesTaxAmount

Total Fees Tax Amount

TotalGiftWrapAmount

Total Invoice gift wrap Amount

TotalGiftWrapCreditAmount

Total Gift Wrap Credit Amount

TotalGiftWrapCreditTaxAmount

Total Gift Wrap Credit Tax Amount

TotalGiftWrapDiscountAmount

Total Gift Wrap Discount Amount

TotalGiftWrapDiscountTaxAmount

Total Gift Wrap Discount Tax Amount

TotalGiftWrapTaxAmount

Total Gift Wrap Tax Amount

TotalHandlingAmount

Total Handling Amount

TotalHandlingCreditAmount

Total Handling Credit Amount

TotalHandlingCreditTaxAmount

Total Handling Credit Tax Amount

TotalHandlingTaxAmount

Total Handling Tax Amount

TotalHFRCreditAmount

Total HFR Credit Amount

TotalHFRCreditTaxAmount

Total HFR Credit Tax Amount

TotalInventorySetChargeAmount

Total Inventory Set Charge Amount

TotalInventorySetChargeTaxAmount

Total Inventory Set Charge Tax Amount

TotalInventorySetDiscountAmount

Total Inventory Set Discount Amount

TotalInventorySetDiscountTaxAmount

Total Inventory Set Discount Tax Amount

TotalInvoiceAmount

Total Invoice Amount

TotalMerchandiseAmount

Total Shipped Merchandise Amount

TotalMerchandiseDiscountAmount

Total merchandise discount amount

TotalMerchandiseDiscountTaxAmount

Total Merchandise Discount Tax Amount

TotalPriceAdjustmentAmount

Total Price Adjustment Amount

TotalPriceAdjustmentTaxAmount

Total Price Adjustment Tax Amount

TotalShippingAmount

Total Shipping Amount

TotalShippingCreditAmount

Total Shipping Credit Amount

TotalShippingCreditTaxAmount

Total Shipping Credit Tax Amount

TotalShippingDiscountAmount

Total shipping discount amount

TotalShippingDiscountTaxAmount

Total Shipping Discount Tax Amount

TotalShippingTaxAmount

Total Shipping Tax Amount

TotalTaxAmount

Total Tax Amount

TotalTaxCreditAmount

Total Tax Credit Amount

TotalTaxCreditTaxAmount

Total Tax Credit Tax Amount

TotalZCRChargeAmount

Total ZCR Charge Amount

TotalZCRChargeTaxAmount

Total ZCR Charge Tax Amount

ISO Standard Definition
Country – ISO 3166-1 2 Letter Country Standard
Currency – ISO 4217 Currency Standard
Time – ISO 8601 Date Time Standard

 

Jurisdiction Level

Description

APO

Army Post Office

BOROUGH

Borough

CITY

City

COUNTRY

Country

COUNTY

County

DISTRICT

District

FPO

Fleet Post Office

LOCAL_IMPROVEMENT_DISTRICT

Local Improvement District

PARISH

Parish

PROVINCE

Province

SPECIAL_PURPOSE_DISTRICT

Special Purpose District

STATE

State

TERRITORY

Territory

TOWNSHIP

Township

TRADE_BLOCK

Trade Block (ex. European Union, NAFTA)

TRANSIT_DISTRICT

Transit District

Line Amount Type

Description

ExtendedVendorCost

Extended Vendor Cost

LineCheckPaymentDiscountAmount

Line Check Payment Discount Amount

LineCODSurchargeAmount

Line COD Surcharge Amount

LineCustomAmount

Line Custom Amount

LineCustomizationAmount

Line Customization Amount

LineCustomizationCreditAmount

Line Customization Credit Amount

LineCustomizationDiscAmount

Line Customization Disc Amount

LineCVSSurchargeAmount

Line CVS Surcharge Amount

LineDiscountAmount

Line Discount Amount

LineDutyAmount

Line Duty Amount

LineDutyCreditAmount

Line Duty Credit Amount

LineFeesAmount

Line Fees Amount

LineFeesCreditAmount

Line Fees Credit Amount

LineGiftWrapAmount

Line Gift Wrap Amount

LineGiftWrapCreditAmount

Line Gift Wrap Credit Amount

LineGiftWrapDiscountAmount

Line Gift Wrap Discount Amount

LineHandlingAmount

Line Handling Amount

LineHandlingCreditAmount

Line Handling Credit Amount

LineHFRCreditAmount

Line HFR Credit Amount

LineInventorySetChargeAmount

Line Inventory Set Charge Amount

LineInventorySetDiscountAmount

Line Inventory Set Discount Amount

LineMerchandiseAmount

Line Merchandise Amount

LineMerchandiseDiscountAmount

Line Merchandise Discount Amount

LinePriceAdjustmentAmount

Line Price Adjustment Amount

LineShippingAmount

Line Shipping Amount

LineShippingCreditAmount

Line Shipping Credit Amount

LineShippingDiscountAmount

Line Shipping Discount Amount

LineTaxCreditAmount

Line Tax Credit Amount

LineTotalAmount

Line Total Amount

LineZCRChargeAmount

Line ZCR Charge Amount

UnitDiscountAmount

Unit Discount Amount

Order Type

Description

CSROMS

CSR OMS Order

CSRWEB

CSR Web Store Orders

EB2C

External B2B Orders

GAOS

Associate Ordering System

GROUP_SALES

Group Sales

LEGACY

Legacy data migrated from V9/V10

MOBILE

Mobile Device Order Source

MPCAAMAZON

Marketplace Amazon via Channel Advisor

MPCABUY

Marketplace Buy via Channel Advisor

MPCAEBAY

Marketplace eBay via Channel Advisor

MPCAGOOGLE Marketplace Google
MPCAJET Marketplace JET
MPRAKUTEN Marketplace Rakuten

MPYAHOO

Marketplace Yahoo

PHONE

Phone order via IVR

WEB

Web Store Order Source

XLEGACY

External Legacy data migrated when launching a new store on V11

XMOBILE

External Mobile Store

XWEB

External Web Store

ZCREXCHANGE

Zero Cost Reship