Saltar al contenido principal

Order Payload

Every new order arrives as an OrderCreate webhook. The request body wraps an order object:

{
"event": {
"type": "OrderCreate",
"status": "NEW"
},
"order": {
"id": "order-001"
}
}

All amounts are integers in cents unless noted, for example 1999 is $19.99. Keep the order id: you need it to confirm the order and for every later update.

Top-level order fields​

FieldTypeDescription
idstringUnique identifier for the order.
consumerobjectThe customer who placed the order. See Consumer object.
storeobjectThe store fulfilling the order. See Store object.
subtotalintegerOrder subtotal in cents, before tax, tips, and fees.
taxintegerTax amount in cents.
estimated_pickup_timestringISO 8601 UTC timestamp for when DoorDash expects the order to be picked up.
is_pickupbooleantrue when the customer picks up the order.
categoriesarrayThe ordered items, grouped by category. See Categories object.
is_tax_remitted_by_doordashbooleantrue when DoorDash remits tax for the order, for example in Marketplace Facilitator states.
tax_amount_remitted_by_doordashintegerTax amount in cents that DoorDash remits, when is_tax_remitted_by_doordash is true.
commission_typestringThe type of customer account that placed the order: regular or dashpass.
delivery_short_codestringShort code the Dasher uses to identify the order at pickup.
fulfillment_typestringHow the order is fulfilled: dx_delivery (Dasher delivery), pickup (customer pickup), or mx_fleet_delivery (Self Delivery).
merchant_tip_amountintegerTip in cents for your store staff.
tip_amountintegerDelivery tip the customer added, in cents. 0 for pickup orders.
experiencestringWhere the order was placed: DOORDASH, CAVIAR, STOREFRONT, WHITE_LABELED, DOORDASH_CHECKOUT, or ANY_EXPERIENCE.
is_plastic_ware_option_selectedbooleantrue when the customer asked for plasticware or utensils.
custom_feearrayCustom fees on the order, such as a bag fee. Only present when a custom fee applies. See Bag Fees.

Example order​

The following example is a pickup order for one wireless mouse with a 2-year protection plan, plus a bag fee.

{
"id": "order-001",
"consumer": {
"id": 123456,
"first_name": "Jane",
"last_name": "D",
"email": "[email protected]",
"phone": "+18552228111"
},
"store": {
"merchant_supplied_id": "store-123",
"provider_type": "my_provider"
},
"subtotal": 2499,
"tax": 263,
"estimated_pickup_time": "2025-06-14T19:00:00Z",
"is_pickup": true,
"categories": [
{
"name": "Electronics",
"merchant_supplied_id": "cat-001",
"items": [
{
"name": "Wireless Mouse",
"merchant_supplied_id": "item-001",
"price": 1999,
"quantity": 1,
"extras": [
{
"name": "Protection Plan",
"merchant_supplied_id": "extra-001",
"options": [
{
"name": "2-Year Protection Plan",
"merchant_supplied_id": "opt-001",
"price": 500,
"quantity": 1
}
]
}
],
"special_instructions": "Color: Black",
"line_item_id": "line-001"
}
]
}
],
"is_tax_remitted_by_doordash": true,
"tax_amount_remitted_by_doordash": 263,
"commission_type": "regular",
"fulfillment_type": "pickup",
"merchant_tip_amount": 200,
"tip_amount": 0,
"experience": "DOORDASH",
"is_plastic_ware_option_selected": false,
"custom_fee": [
{
"type": "BAG_FEE",
"price": 30,
"tax": 5
}
]
}

Consumer object​

Details about the customer who placed the order.

FieldTypeDescription
idinteger (int64)Unique identifier for the customer. Your system must support a 64-bit integer.
first_namestringCustomer's first name.
last_namestringCustomer's last name initial.
emailstringA DoorDash support email address, not the customer's own email.
phonestringA DoorDash support phone number, unless the Masked Customer Phone Number feature is enabled for your store.

Store object​

The store fulfilling the order.

FieldTypeRequiredDescription
merchant_supplied_idstringYesYour unique identifier for the store location.
provider_typestringYesYour integration's provider identifier, assigned by DoorDash or set up in the Developer Portal.

Categories object​

The categories array groups the ordered items the same way your catalog does.

FieldTypeDescription
namestringDisplay name of the category.
merchant_supplied_idstringYour unique identifier for the category.
itemsarrayThe items ordered in this category. See Items object.

Items object​

FieldTypeDescription
namestringName of the item.
merchant_supplied_idstringYour unique identifier for the item.
priceintegerItem price in cents, for example 1499 for $14.99.
quantityintegerNumber of this item ordered.
extrasarrayModifier groups the customer selected options from. See Extras object.
consumer_namestringFor group orders, the first name of the person who ordered this item.
special_instructionsstringThe customer's instructions for this item, if your store allows them.
line_item_idstringUnique identifier for this line item. Use it when you adjust the order.

Extras object​

An extra is a modifier group, such as "Protection Plan". It has no price of its own: the price is on each option the customer selected.

FieldTypeDescription
namestringName of the modifier group.
merchant_supplied_idstringYour unique identifier for the modifier group.
optionsarrayThe options the customer selected in this group. See Options object.

Options object​

An option is the specific choice inside an extra, such as "2-Year Protection Plan".

FieldTypeDescription
namestringName of the option.
merchant_supplied_idstringYour unique identifier for the option.
priceintegerAdditional price in cents for this option.
quantityintegerQuantity of this option selected.
extrasarrayNested modifier groups under this option, in the same shape as the Extras object.
line_option_idstringUnique identifier for this option line.

Feature-specific fields​

Orders can include more fields when a feature applies to the order, such as a promotion, Self Delivery, or SNAP/EBT payment. Those fields are documented with each feature:

FeatureFieldsDocumented in
Promotions and discountsapplied_discounts, applied_discounts_details, subtotal_for_tax, subtotal_tax_amount, subtotal_discount_funding_source, total_merchant_funded_discount_amount, and applied_item_discount_details on itemsReceive Integrated Promo Data
Self Deliverydelivery_address, delivery_feeEnable Self Delivery
Substitutionssubstitution_preferences on itemsSubstitution Preferences and item instructions
SNAP/EBTsnap_amount on itemsSNAP/EBT Order Data
Bag feescustom_feeReceive Bag Fees
Was this page helpful?