API to manage item catalog, inventory, pricing and other attributes.
Add new items managed by business. Items sold across all stores must be added to business first. Items must be uniquely identifiable across stores. As of now, only one businessId must be specified. Request validation will fail if no businessId or multiple businessIds are specified.
object | |
Array of objects (Item) |
{- "scope": {
- "business_ids": [
- "string"
]
}, - "items": [
- {
- "merchant_supplied_item_id": "string",
- "name": "string",
- "description": "string",
- "product_traits": [
- "ALCOHOL"
], - "other_identifiers": [
- {
- "identifier_type": "UPC",
- "identifier_value": "string"
}
], - "images": [
- {
- "url": "string",
- "sort_id": 0
}
], - "size": {
- "details": {
- "dimensions": {
- "length": {
- "value": 0,
- "unit": "inch"
}, - "width": {
- "value": 0,
- "unit": "inch"
}, - "height": {
- "value": 0,
- "unit": "inch"
}
}, - "weight": {
- "value": 0,
- "unit": "lbs"
}, - "volume": {
- "value": 0,
- "unit": "oz"
}, - "product_specific_size_definition": {
- "value": "400",
- "description": "g"
}
}, - "pack_size_details": {
- "count_per_pack": 0,
- "per_item_size_details": {
- "dimensions": {
- "length": {
- "value": 0,
- "unit": "inch"
}, - "width": {
- "value": 0,
- "unit": "inch"
}, - "height": {
- "value": 0,
- "unit": "inch"
}
}, - "weight": {
- "value": 0,
- "unit": "lbs"
}, - "volume": {
- "value": 0,
- "unit": "oz"
}, - "product_specific_size_definition": {
- "value": "400",
- "description": "g"
}
}
}
}, - "weighted_item_info": {
- "average_weight_per_each": 0,
- "average_weight_measurement_unit": "ea",
- "shop_by_measurement_unit": "ea",
- "price_by_measurement_unit": "ea"
}, - "brand_info": {
- "name": "string"
}, - "program_eligibility": [
- "SNAP"
], - "item_categorizations": [
- {
- "category": {
- "name": "string",
- "sub_category": { }
}
}
], - "product_attributes": [
- {
- "attribute_name": "string",
- "attribute_value": {
- "single_select_bool": true
}
}
]
}
]
}{- "operation_id": "string",
- "operation_status": "QUEUED",
- "message": "string"
}Update existing items managed by business.
object | |
Array of objects (Item) |
{- "scope": {
- "business_ids": [
- "string"
]
}, - "items": [
- {
- "merchant_supplied_item_id": "string",
- "name": "string",
- "description": "string",
- "product_traits": [
- "ALCOHOL"
], - "other_identifiers": [
- {
- "identifier_type": "UPC",
- "identifier_value": "string"
}
], - "images": [
- {
- "url": "string",
- "sort_id": 0
}
], - "size": {
- "details": {
- "dimensions": {
- "length": {
- "value": 0,
- "unit": "inch"
}, - "width": {
- "value": 0,
- "unit": "inch"
}, - "height": {
- "value": 0,
- "unit": "inch"
}
}, - "weight": {
- "value": 0,
- "unit": "lbs"
}, - "volume": {
- "value": 0,
- "unit": "oz"
}, - "product_specific_size_definition": {
- "value": "400",
- "description": "g"
}
}, - "pack_size_details": {
- "count_per_pack": 0,
- "per_item_size_details": {
- "dimensions": {
- "length": {
- "value": 0,
- "unit": "inch"
}, - "width": {
- "value": 0,
- "unit": "inch"
}, - "height": {
- "value": 0,
- "unit": "inch"
}
}, - "weight": {
- "value": 0,
- "unit": "lbs"
}, - "volume": {
- "value": 0,
- "unit": "oz"
}, - "product_specific_size_definition": {
- "value": "400",
- "description": "g"
}
}
}
}, - "weighted_item_info": {
- "average_weight_per_each": 0,
- "average_weight_measurement_unit": "ea",
- "shop_by_measurement_unit": "ea",
- "price_by_measurement_unit": "ea"
}, - "brand_info": {
- "name": "string"
}, - "program_eligibility": [
- "SNAP"
], - "item_categorizations": [
- {
- "category": {
- "name": "string",
- "sub_category": { }
}
}
], - "product_attributes": [
- {
- "attribute_name": "string",
- "attribute_value": {
- "single_select_bool": true
}
}
]
}
]
}{- "operation_id": "string",
- "operation_status": "QUEUED",
- "message": "string"
}| store_location_id required | string <string> ID of store to be updated |
update existing store
| merchant_supplied_store_id | string |
required | Array of objects |
Array of objects |
{- "merchant_supplied_store_id": "string",
- "open_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string"
}
], - "special_hours": [
- {
- "date": "string",
- "start_time": "string",
- "end_time": "string",
- "closed": true
}
]
}{- "merchant_supplied_store_id": "string",
- "open_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string"
}
], - "special_hours": [
- {
- "date": "string",
- "start_time": "string",
- "end_time": "string",
- "closed": true
}
]
}Endpoints to manage inventory/pricing and other item attributes specific to this store
Add inventory/pricing and other in-store attributes of new item that is made available for sale in the store. base_price and status must be specified first time when an item is made available for sale in a store. At this time, item with extras/options is supported only via job management endpoint. Request validation will fail if extras/options are present in POST/PATCH.
| store_location_id required | string <string> ID of store where the item is physically sourced. |
object Only need this information when you use paginated pull workflow | |
Array of objects (StoreItem) |
{- "meta": {
- "current_page": 0,
- "page_size": 0,
- "total_page": 0
}, - "items": [
- {
- "merchant_supplied_item_id": "string",
- "item_availability": "ACTIVE",
- "balance_on_hand": 0,
- "funding_source": "MERCHANT",
- "last_sold_datetime": "string",
- "price_info": {
- "base_price": 0,
- "sale_price": 0,
- "tax_rate": 0,
- "bottle_fee_deposit": 0,
- "base_price_per_measurement_unit": 0,
- "loyalty_price": 0,
- "loyalty_price_per_measurement_unit": 0,
- "sale_price_per_measurement_unit": 0
}, - "location": {
- "aisle": "string",
- "zone": "string",
- "shelf": "string",
- "side": "string",
- "additional_details": "string",
- "coordinates": {
- "x": 0,
- "y": 0
}, - "raw_text": "string",
- "section": "string"
}, - "item_special_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string",
- "start_date": "string",
- "end_date": "string"
}
], - "program_eligibility": [
- "SNAP"
], - "extras": [
- {
- "name": "string",
- "merchant_supplied_id": "string",
- "description": "string",
- "availability": "ACTIVE",
- "sort_id": 0,
- "min_num_options": 0,
- "max_num_options": 0,
- "num_free_options": 0,
- "min_option_choice_quantity": 0,
- "max_option_choice_quantity": 0,
- "min_aggregate_options_quantity": 0,
- "max_aggregate_options_quantity": 0,
- "options": [
- {
- "merchant_supplied_item_id": "string",
- "name": "string",
- "availability": "ACTIVE",
- "price_info": {
- "base_price": 0
}, - "item_extra_option_special_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string",
- "start_date": "string",
- "end_date": "string"
}
], - "description": "string",
- "default": true,
- "sort_id": 0,
- "extras": [
- { }
]
}
]
}
]
}
]
}{- "operation_id": "string",
- "operation_status": "QUEUED",
- "message": "string"
}At this time, item with extras/options is supported only via job management endpoint. Request validation will fail if extras/options are present in POST/PATCH.
| store_location_id required | string <string> ID of store where the item is physically sourced. |
object Only need this information when you use paginated pull workflow | |
Array of objects (StoreItem) |
{- "meta": {
- "current_page": 0,
- "page_size": 0,
- "total_page": 0
}, - "items": [
- {
- "merchant_supplied_item_id": "string",
- "item_availability": "ACTIVE",
- "balance_on_hand": 0,
- "funding_source": "MERCHANT",
- "last_sold_datetime": "string",
- "price_info": {
- "base_price": 0,
- "sale_price": 0,
- "tax_rate": 0,
- "bottle_fee_deposit": 0,
- "base_price_per_measurement_unit": 0,
- "loyalty_price": 0,
- "loyalty_price_per_measurement_unit": 0,
- "sale_price_per_measurement_unit": 0
}, - "location": {
- "aisle": "string",
- "zone": "string",
- "shelf": "string",
- "side": "string",
- "additional_details": "string",
- "coordinates": {
- "x": 0,
- "y": 0
}, - "raw_text": "string",
- "section": "string"
}, - "item_special_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string",
- "start_date": "string",
- "end_date": "string"
}
], - "program_eligibility": [
- "SNAP"
], - "extras": [
- {
- "name": "string",
- "merchant_supplied_id": "string",
- "description": "string",
- "availability": "ACTIVE",
- "sort_id": 0,
- "min_num_options": 0,
- "max_num_options": 0,
- "num_free_options": 0,
- "min_option_choice_quantity": 0,
- "max_option_choice_quantity": 0,
- "min_aggregate_options_quantity": 0,
- "max_aggregate_options_quantity": 0,
- "options": [
- {
- "merchant_supplied_item_id": "string",
- "name": "string",
- "availability": "ACTIVE",
- "price_info": {
- "base_price": 0
}, - "item_extra_option_special_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string",
- "start_date": "string",
- "end_date": "string"
}
], - "description": "string",
- "default": true,
- "sort_id": 0,
- "extras": [
- { }
]
}
]
}
]
}
]
}{- "operation_id": "string",
- "operation_status": "QUEUED",
- "message": "string"
}| job_type | string Enum: "PULL_STORE_ITEMS" "PULL_STORE_ITEMS_WITH_PAGINATION" Use PULL_STORE_ITEMS if you can return all items in one pull call for one store, otherwise use PULL_STORE_ITEMS_WITH_PAGINATION which is paginated version pull. |
object |
{- "job_type": "PULL_STORE_ITEMS",
- "job_parameters": {
- "property1": "string",
- "property2": "string"
}
}{- "operation_id": "string",
- "operation_status": "QUEUED",
- "message": "string",
- "max_page_size": 0
}| store_location_id required | string <string> location ID of store |
create new promotion
| promotion_id | string Promotion Id to identify a promotion uniquely with a Mx. Required. |
| promotion_type | string Enum: "BUY_X_FOR_Y" "BUY_X_SAVE_Y" "BUY_X_GET_Y_Z_PERCENT_OFF" Promotion types |
| funding_source | string Enum: "MERCHANT" "CPG" Funding source type |
object Purchase criteria to redeem this promotion | |
object Purchase criteria to redeem this promotion | |
object Purchase criteria to redeem this promotion | |
object The options to represent for what and how a promotion can be defined | |
| start_time | string <yyyy-MM-ddTHH:mm:ssXXX> required, start time of the promotion with local timezone, example 2024-04-03T10:15:30Z https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#ISO_ZONED_DATE_TIME |
| end_time | string <yyyy-MM-ddTHH:mm:ssXXX> required, end time of the promotion with local timezone https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#ISO_ZONED_DATE_TIME |
{- "promotion_id": "string",
- "promotion_type": "BUY_X_FOR_Y",
- "funding_source": "MERCHANT",
- "purchase_criteria": {
- "purchase_items": [
- "string"
], - "purchase_quantity": 0
}, - "redemption_limit": {
- "limit_per_order": 0
}, - "discount_options": {
- "discount_total_price": 0,
- "discount_price_off": 0,
- "discount_percentage": 0,
- "discount_quantity": 0
}, - "promotion_options": {
- "promotion_conditions": [
- "MIX_AND_MATCH"
]
}, - "start_time": "string",
- "end_time": "string"
}{- "operation_id": "string",
- "operation_status": "QUEUED",
- "message": "string"
}| store_location_id required | string <string> location ID of store to be updated |
update promotions in store
| promotion_id | string Promotion Id to identify a promotion uniquely with a Mx. Required. |
| promotion_type | string Enum: "BUY_X_FOR_Y" "BUY_X_SAVE_Y" "BUY_X_GET_Y_Z_PERCENT_OFF" Promotion types |
| funding_source | string Enum: "MERCHANT" "CPG" Funding source type |
object Purchase criteria to redeem this promotion | |
object Purchase criteria to redeem this promotion | |
object Purchase criteria to redeem this promotion | |
object The options to represent for what and how a promotion can be defined | |
| start_time | string <yyyy-MM-ddTHH:mm:ssXXX> required, start time of the promotion with local timezone, example 2024-04-03T10:15:30Z https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#ISO_ZONED_DATE_TIME |
| end_time | string <yyyy-MM-ddTHH:mm:ssXXX> required, end time of the promotion with local timezone https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#ISO_ZONED_DATE_TIME |
{- "promotion_id": "string",
- "promotion_type": "BUY_X_FOR_Y",
- "funding_source": "MERCHANT",
- "purchase_criteria": {
- "purchase_items": [
- "string"
], - "purchase_quantity": 0
}, - "redemption_limit": {
- "limit_per_order": 0
}, - "discount_options": {
- "discount_total_price": 0,
- "discount_price_off": 0,
- "discount_percentage": 0,
- "discount_quantity": 0
}, - "promotion_options": {
- "promotion_conditions": [
- "MIX_AND_MATCH"
]
}, - "start_time": "string",
- "end_time": "string"
}{- "operation_id": "string",
- "operation_status": "QUEUED",
- "message": "string"
}Endpoints for new verticals self-serve integration onboarding
Creates a managed merchant onboarding URL for NV SSIO partner-initiated merchant onboarding. The partner must redirect the merchant to the returned URL, where DoorDash hosts and manages the full onboarding flow including authentication, store creation, and provider linking.
| location_id required | string Unique identifier of the store in partner system (becomes location_id in API calls) |
| location_group_id required | string Unique identifier of the parent business in partner system |
| store_name required | string Customer-facing name of the store (e.g., "Burger Shack") |
| location_name | string Location-specific context (e.g., "Burger Shack - Las Vegas") |
required | object (MerchantAddress) |
| first_name required | string First name of user on partner side initiating request |
| last_name required | string Last name of user on partner side |
| email required | string <email> Email for user on partner side (receives status updates) |
| business_phone | string Phone number for requestor |
| expected_go_live_date | string <date> Expected activation date (YYYY-MM-DD, best effort) |
| merchant_decision_maker_email required | string <email> Merchant email (must be Business Admin in DoorDash Merchant Portal) |
| order_protocol required | string Enum: "POS" "TABLET" POS - Merchant receives and fulfills orders via their POS; TABLET - Merchant will be sent a DD tablet and orders will not go to their POS |
| fulfillment_protocol required | string Enum: "MERCHANT_PICK" "DASHER_PICK" MERCHANT_PICK - merchant picks; DASHER_PICK - dasher shops and delivers |
| locale required | string Value: "en-US" Locale for the merchant onboarding experience |
{- "location_id": "string",
- "location_group_id": "string",
- "store_name": "string",
- "location_name": "string",
- "address": {
- "line_1": "string",
- "line_2": "string",
- "city": "string",
- "state": "string",
- "zip": "string"
}, - "first_name": "string",
- "last_name": "string",
- "business_phone": "string",
- "expected_go_live_date": "2026-01-15",
- "order_protocol": "POS",
- "fulfillment_protocol": "MERCHANT_PICK",
- "locale": "en-US"
}{
}Submit multiple transactions for checkout
| store_location_id required | string <string> ID of store where checkout is occurring |
Array of objects (Transaction) List of transactions to add | |||||||||
Array
| |||||||||
{- "transactions": [
- {
- "merchant_supplied_transaction_id": "string",
- "in_store_transaction_contents": {
- "total": 0,
- "currency_code": "USD",
- "summary": {
- "subtotal": 0,
- "tax": 0,
- "fees": 0,
- "discount": 0
}, - "items": [
- {
- "line_id": "string",
- "merchant_supplied_item_id": "string",
- "quantity": 0,
- "measurement_unit": "ea",
- "name": "string",
- "category": "string",
- "other_identifiers": [
- {
- "name": "string",
- "value": "string"
}
], - "scan_code": "string",
- "program_eligibility": [
- "SNAP"
], - "price": 0,
- "net_price": 0,
- "price_per_measurement_unit": 0,
- "net_price_per_measurement_unit": 0,
- "discounts": {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}, - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
]
}
], - "discounts": [
- {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}
], - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
], - "fees": [
- {
- "fee_amount": 0,
- "fee_type": "ECO_FEE",
- "fee_type_other": "string"
}
], - "loyalty": {
- "member_info": {
- "member_id": "string",
- "scan_type": "QR_CODE",
- "scan_payload": "string"
}, - "points_awarded": 0
}, - "tenders": [
- {
- "tender_type": "CARD",
- "tender_type_other": "string",
- "amount": 0,
- "card_info": {
- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}, - "doordash_direct_scan_code": "string"
}
]
}, - "marketplace_transaction_contents": {
- "total": 0,
- "currency_code": "USD",
- "summary": {
- "subtotal": 0,
- "tax": 0,
- "fees": 0,
- "discount": 0
}, - "items": [
- {
- "line_id": "string",
- "merchant_supplied_item_id": "string",
- "quantity": 0,
- "measurement_unit": "ea",
- "name": "string",
- "category": "string",
- "other_identifiers": [
- {
- "name": "string",
- "value": "string"
}
], - "scan_code": "string",
- "program_eligibility": [
- "SNAP"
], - "price": 0,
- "net_price": 0,
- "price_per_measurement_unit": 0,
- "net_price_per_measurement_unit": 0,
- "discounts": {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}, - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
]
}
], - "discounts": [
- {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}
], - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
], - "fees": [
- {
- "fee_amount": 0,
- "fee_type": "ECO_FEE",
- "fee_type_other": "string"
}
], - "loyalty": {
- "member_info": {
- "member_id": "string",
- "scan_type": "QR_CODE",
- "scan_payload": "string"
}, - "points_awarded": 0
}, - "tenders": [
- {
- "tender_type": "CARD",
- "tender_type_other": "string",
- "amount": 0,
- "card_info": {
- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}, - "doordash_direct_scan_code": "string"
}
]
}, - "transaction_timestamp": "2019-08-24T14:15:22Z"
}
]
}{- "code": "validation_error",
- "message": "One or more request values couldn't be validated.",
- "field_errors": [
- {
- "field": "pickup_phone_number",
- "error": "Invalid phone number format"
}
]
}| merchant_supplied_item_id | string Merchant supplied Id to identify an item uniquely within business across all stores. Every item that is shopable by CX must be represented as an unique item |
| name | string Name of the item |
| description | string Description of the item |
| product_traits | Array of strings (ProductTrait) Items Enum: "ALCOHOL" "MEDICATION" "WEIGHTED" Specifies type of product(s) represented by the item. These attributes will be used to validate product specific attributes in request and apply product specific business logic internally. For example, when WEIGHTED is specified as one of the product trait, presence of weighted_item_info will be validated in the request payload |
Array of objects Other identifiers associated with item. | |
Array of objects Images of the item, atleast one image must be specified | |
object size of the item | |
object attributes related to items that are sold by weights | |
object brand of the item if applicable | |
| program_eligibility | Array of strings (ProgramEligibility) Items Enum: "SNAP" "HSA" "FSA" Program eligibility of the item |
Array of objects One or more categories associated with the item | |
Array of objects (ProductAttributes) product_attributes allow us to infer everything about an item necessary for customers to shop, dasher to fulfill, merchants to merchandise, and advertisers to advertise. See supported full attribute list: https://developer.doordash.com/en-US/docs/marketplace/retail/catalog_management/supported_attribute |
{- "merchant_supplied_item_id": "string",
- "name": "string",
- "description": "string",
- "product_traits": [
- "ALCOHOL"
], - "other_identifiers": [
- {
- "identifier_type": "UPC",
- "identifier_value": "string"
}
], - "images": [
- {
- "url": "string",
- "sort_id": 0
}
], - "size": {
- "details": {
- "dimensions": {
- "length": {
- "value": 0,
- "unit": "inch"
}, - "width": {
- "value": 0,
- "unit": "inch"
}, - "height": {
- "value": 0,
- "unit": "inch"
}
}, - "weight": {
- "value": 0,
- "unit": "lbs"
}, - "volume": {
- "value": 0,
- "unit": "oz"
}, - "product_specific_size_definition": {
- "value": "400",
- "description": "g"
}
}, - "pack_size_details": {
- "count_per_pack": 0,
- "per_item_size_details": {
- "dimensions": {
- "length": {
- "value": 0,
- "unit": "inch"
}, - "width": {
- "value": 0,
- "unit": "inch"
}, - "height": {
- "value": 0,
- "unit": "inch"
}
}, - "weight": {
- "value": 0,
- "unit": "lbs"
}, - "volume": {
- "value": 0,
- "unit": "oz"
}, - "product_specific_size_definition": {
- "value": "400",
- "description": "g"
}
}
}
}, - "weighted_item_info": {
- "average_weight_per_each": 0,
- "average_weight_measurement_unit": "ea",
- "shop_by_measurement_unit": "ea",
- "price_by_measurement_unit": "ea"
}, - "brand_info": {
- "name": "string"
}, - "program_eligibility": [
- "SNAP"
], - "item_categorizations": [
- {
- "category": {
- "name": "string",
- "sub_category": { }
}
}
], - "product_attributes": [
- {
- "attribute_name": "string",
- "attribute_value": {
- "single_select_bool": true
}
}
]
}| merchant_supplied_store_id | string |
required | Array of objects |
Array of objects |
{- "merchant_supplied_store_id": "string",
- "open_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string"
}
], - "special_hours": [
- {
- "date": "string",
- "start_time": "string",
- "end_time": "string",
- "closed": true
}
]
}| merchant_supplied_item_id | string |
| item_availability | string Enum: "ACTIVE" "INACTIVE" |
| balance_on_hand | integer |
| funding_source | string Enum: "MERCHANT" "CPG" |
| last_sold_datetime | string DateTime in ISO8601 format of when the item was last sold at the store. |
object (PriceInfo) | |
object (ItemLocation) Default location of an item in the store across business. Can be specified at store level for any store specific customizations. | |
Array of objects (TimeBlock) Special hours on when item will be available | |
| program_eligibility | Array of strings (ProgramEligibility) Items Enum: "SNAP" "HSA" "FSA" Program eligibility of the item |
Array of objects (Extra) |
{- "merchant_supplied_item_id": "string",
- "item_availability": "ACTIVE",
- "balance_on_hand": 0,
- "funding_source": "MERCHANT",
- "last_sold_datetime": "string",
- "price_info": {
- "base_price": 0,
- "sale_price": 0,
- "tax_rate": 0,
- "bottle_fee_deposit": 0,
- "base_price_per_measurement_unit": 0,
- "loyalty_price": 0,
- "loyalty_price_per_measurement_unit": 0,
- "sale_price_per_measurement_unit": 0
}, - "location": {
- "aisle": "string",
- "zone": "string",
- "shelf": "string",
- "side": "string",
- "additional_details": "string",
- "coordinates": {
- "x": 0,
- "y": 0
}, - "raw_text": "string",
- "section": "string"
}, - "item_special_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string",
- "start_date": "string",
- "end_date": "string"
}
], - "program_eligibility": [
- "SNAP"
], - "extras": [
- {
- "name": "string",
- "merchant_supplied_id": "string",
- "description": "string",
- "availability": "ACTIVE",
- "sort_id": 0,
- "min_num_options": 0,
- "max_num_options": 0,
- "num_free_options": 0,
- "min_option_choice_quantity": 0,
- "max_option_choice_quantity": 0,
- "min_aggregate_options_quantity": 0,
- "max_aggregate_options_quantity": 0,
- "options": [
- {
- "merchant_supplied_item_id": "string",
- "name": "string",
- "availability": "ACTIVE",
- "price_info": {
- "base_price": 0
}, - "item_extra_option_special_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string",
- "start_date": "string",
- "end_date": "string"
}
], - "description": "string",
- "default": true,
- "sort_id": 0,
- "extras": [
- { }
]
}
]
}
]
}| promotion_id | string Promotion Id to identify a promotion uniquely with a Mx. Required. |
| promotion_type | string Enum: "BUY_X_FOR_Y" "BUY_X_SAVE_Y" "BUY_X_GET_Y_Z_PERCENT_OFF" Promotion types |
| funding_source | string Enum: "MERCHANT" "CPG" Funding source type |
object Purchase criteria to redeem this promotion | |
object Purchase criteria to redeem this promotion | |
object Purchase criteria to redeem this promotion | |
object The options to represent for what and how a promotion can be defined | |
| start_time | string <yyyy-MM-ddTHH:mm:ssXXX> required, start time of the promotion with local timezone, example 2024-04-03T10:15:30Z https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#ISO_ZONED_DATE_TIME |
| end_time | string <yyyy-MM-ddTHH:mm:ssXXX> required, end time of the promotion with local timezone https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#ISO_ZONED_DATE_TIME |
{- "promotion_id": "string",
- "promotion_type": "BUY_X_FOR_Y",
- "funding_source": "MERCHANT",
- "purchase_criteria": {
- "purchase_items": [
- "string"
], - "purchase_quantity": 0
}, - "redemption_limit": {
- "limit_per_order": 0
}, - "discount_options": {
- "discount_total_price": 0,
- "discount_price_off": 0,
- "discount_percentage": 0,
- "discount_quantity": 0
}, - "promotion_options": {
- "promotion_conditions": [
- "MIX_AND_MATCH"
]
}, - "start_time": "string",
- "end_time": "string"
}object | |
Array of objects (Item) |
{- "scope": {
- "business_ids": [
- "string"
]
}, - "items": [
- {
- "merchant_supplied_item_id": "string",
- "name": "string",
- "description": "string",
- "product_traits": [
- "ALCOHOL"
], - "other_identifiers": [
- {
- "identifier_type": "UPC",
- "identifier_value": "string"
}
], - "images": [
- {
- "url": "string",
- "sort_id": 0
}
], - "size": {
- "details": {
- "dimensions": {
- "length": {
- "value": 0,
- "unit": "inch"
}, - "width": {
- "value": 0,
- "unit": "inch"
}, - "height": {
- "value": 0,
- "unit": "inch"
}
}, - "weight": {
- "value": 0,
- "unit": "lbs"
}, - "volume": {
- "value": 0,
- "unit": "oz"
}, - "product_specific_size_definition": {
- "value": "400",
- "description": "g"
}
}, - "pack_size_details": {
- "count_per_pack": 0,
- "per_item_size_details": {
- "dimensions": {
- "length": {
- "value": 0,
- "unit": "inch"
}, - "width": {
- "value": 0,
- "unit": "inch"
}, - "height": {
- "value": 0,
- "unit": "inch"
}
}, - "weight": {
- "value": 0,
- "unit": "lbs"
}, - "volume": {
- "value": 0,
- "unit": "oz"
}, - "product_specific_size_definition": {
- "value": "400",
- "description": "g"
}
}
}
}, - "weighted_item_info": {
- "average_weight_per_each": 0,
- "average_weight_measurement_unit": "ea",
- "shop_by_measurement_unit": "ea",
- "price_by_measurement_unit": "ea"
}, - "brand_info": {
- "name": "string"
}, - "program_eligibility": [
- "SNAP"
], - "item_categorizations": [
- {
- "category": {
- "name": "string",
- "sub_category": { }
}
}
], - "product_attributes": [
- {
- "attribute_name": "string",
- "attribute_value": {
- "single_select_bool": true
}
}
]
}
]
}object Only need this information when you use paginated pull workflow | |
Array of objects (StoreItem) |
{- "meta": {
- "current_page": 0,
- "page_size": 0,
- "total_page": 0
}, - "items": [
- {
- "merchant_supplied_item_id": "string",
- "item_availability": "ACTIVE",
- "balance_on_hand": 0,
- "funding_source": "MERCHANT",
- "last_sold_datetime": "string",
- "price_info": {
- "base_price": 0,
- "sale_price": 0,
- "tax_rate": 0,
- "bottle_fee_deposit": 0,
- "base_price_per_measurement_unit": 0,
- "loyalty_price": 0,
- "loyalty_price_per_measurement_unit": 0,
- "sale_price_per_measurement_unit": 0
}, - "location": {
- "aisle": "string",
- "zone": "string",
- "shelf": "string",
- "side": "string",
- "additional_details": "string",
- "coordinates": {
- "x": 0,
- "y": 0
}, - "raw_text": "string",
- "section": "string"
}, - "item_special_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string",
- "start_date": "string",
- "end_date": "string"
}
], - "program_eligibility": [
- "SNAP"
], - "extras": [
- {
- "name": "string",
- "merchant_supplied_id": "string",
- "description": "string",
- "availability": "ACTIVE",
- "sort_id": 0,
- "min_num_options": 0,
- "max_num_options": 0,
- "num_free_options": 0,
- "min_option_choice_quantity": 0,
- "max_option_choice_quantity": 0,
- "min_aggregate_options_quantity": 0,
- "max_aggregate_options_quantity": 0,
- "options": [
- {
- "merchant_supplied_item_id": "string",
- "name": "string",
- "availability": "ACTIVE",
- "price_info": {
- "base_price": 0
}, - "item_extra_option_special_hours": [
- {
- "day_index": "MON",
- "start_time": "string",
- "end_time": "string",
- "start_date": "string",
- "end_date": "string"
}
], - "description": "string",
- "default": true,
- "sort_id": 0,
- "extras": [
- { }
]
}
]
}
]
}
]
}| job_type | string Enum: "PULL_STORE_ITEMS" "PULL_STORE_ITEMS_WITH_PAGINATION" Use PULL_STORE_ITEMS if you can return all items in one pull call for one store, otherwise use PULL_STORE_ITEMS_WITH_PAGINATION which is paginated version pull. |
object |
{- "job_type": "PULL_STORE_ITEMS",
- "job_parameters": {
- "property1": "string",
- "property2": "string"
}
}| store_location_id | string |
| pull_mode | string Value: "REPLACE" |
| merchant_supplied_page_size | integer |
{- "store_location_id": "string",
- "pull_mode": "REPLACE",
- "merchant_supplied_page_size": 0
}Array of objects (Promotion) | |||||||||||||||||||
Array
| |||||||||||||||||||
{- "promotions": [
- {
- "promotion_id": "string",
- "promotion_type": "BUY_X_FOR_Y",
- "funding_source": "MERCHANT",
- "purchase_criteria": {
- "purchase_items": [
- "string"
], - "purchase_quantity": 0
}, - "redemption_limit": {
- "limit_per_order": 0
}, - "discount_options": {
- "discount_total_price": 0,
- "discount_price_off": 0,
- "discount_percentage": 0,
- "discount_quantity": 0
}, - "promotion_options": {
- "promotion_conditions": [
- "MIX_AND_MATCH"
]
}, - "start_time": "string",
- "end_time": "string"
}
]
}Array of objects (Transaction) List of transactions to add | |||||||||
Array
| |||||||||
{- "transactions": [
- {
- "merchant_supplied_transaction_id": "string",
- "in_store_transaction_contents": {
- "total": 0,
- "currency_code": "USD",
- "summary": {
- "subtotal": 0,
- "tax": 0,
- "fees": 0,
- "discount": 0
}, - "items": [
- {
- "line_id": "string",
- "merchant_supplied_item_id": "string",
- "quantity": 0,
- "measurement_unit": "ea",
- "name": "string",
- "category": "string",
- "other_identifiers": [
- {
- "name": "string",
- "value": "string"
}
], - "scan_code": "string",
- "program_eligibility": [
- "SNAP"
], - "price": 0,
- "net_price": 0,
- "price_per_measurement_unit": 0,
- "net_price_per_measurement_unit": 0,
- "discounts": {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}, - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
]
}
], - "discounts": [
- {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}
], - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
], - "fees": [
- {
- "fee_amount": 0,
- "fee_type": "ECO_FEE",
- "fee_type_other": "string"
}
], - "loyalty": {
- "member_info": {
- "member_id": "string",
- "scan_type": "QR_CODE",
- "scan_payload": "string"
}, - "points_awarded": 0
}, - "tenders": [
- {
- "tender_type": "CARD",
- "tender_type_other": "string",
- "amount": 0,
- "card_info": {
- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}, - "doordash_direct_scan_code": "string"
}
]
}, - "marketplace_transaction_contents": {
- "total": 0,
- "currency_code": "USD",
- "summary": {
- "subtotal": 0,
- "tax": 0,
- "fees": 0,
- "discount": 0
}, - "items": [
- {
- "line_id": "string",
- "merchant_supplied_item_id": "string",
- "quantity": 0,
- "measurement_unit": "ea",
- "name": "string",
- "category": "string",
- "other_identifiers": [
- {
- "name": "string",
- "value": "string"
}
], - "scan_code": "string",
- "program_eligibility": [
- "SNAP"
], - "price": 0,
- "net_price": 0,
- "price_per_measurement_unit": 0,
- "net_price_per_measurement_unit": 0,
- "discounts": {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}, - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
]
}
], - "discounts": [
- {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}
], - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
], - "fees": [
- {
- "fee_amount": 0,
- "fee_type": "ECO_FEE",
- "fee_type_other": "string"
}
], - "loyalty": {
- "member_info": {
- "member_id": "string",
- "scan_type": "QR_CODE",
- "scan_payload": "string"
}, - "points_awarded": 0
}, - "tenders": [
- {
- "tender_type": "CARD",
- "tender_type_other": "string",
- "amount": 0,
- "card_info": {
- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}, - "doordash_direct_scan_code": "string"
}
]
}, - "transaction_timestamp": "2019-08-24T14:15:22Z"
}
]
}| bin | string Bank Identification Number (first 6 digits of card) |
| card_holder_name | string Name of the card holder |
| last_four_digits | string Last four digits of the card number |
| card_type | string Enum: "CREDIT" "OTHER" Type of card |
| card_type_other | string Additional details when card_type is OTHER |
| approval_code | string Authorization or approval code from the card network or processor |
| card_transaction_status | string Status of the card transaction |
{- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}| amount | number Discount amount in minor units of the specified currency |
| discount_type | string Enum: "MEMBER_SAVINGS" "MX_PROMO" "CPG_PROMO" "OTHER" Type of discount applied |
| discount_type_other | string Additional details when discount_type is OTHER |
{- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}| fee_amount | number Fee amount in minor units of the specified currency |
| fee_type | string Enum: "ECO_FEE" "BAG_FEE" "BOTTLE_DEPOSIT_FEE" "OTHER" Type of fee applied |
| fee_type_other | string Additional details when fee_type is OTHER |
{- "fee_amount": 0,
- "fee_type": "ECO_FEE",
- "fee_type_other": "string"
}| member_id | string Loyalty member identifier |
| scan_type | string Enum: "QR_CODE" "BARCODE" "NA" Type of scan method used for loyalty |
| scan_payload | string Scanned loyalty payload value |
{- "member_id": "string",
- "scan_type": "QR_CODE",
- "scan_payload": "string"
}| name | string Identifier name |
| value | string Identifier value |
{- "name": "string",
- "value": "string"
}| amount | number Tax amount in minor units of the specified currency |
| tax_type | string Enum: "SALES_TAX" "VAT" "GST" "EXCISE_TAX" "TAX_ON_FEES" "TAX_ON_SUBTOTAL" "OTHER" Type of tax applied |
| tax_type_other | string Additional details when tax_type is OTHER |
{- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}| tender_type | string Enum: "CARD" "DOORDASH_DIRECT" "HSA_FSA" "SNAP" "EBT" "OTHER" Type of tender used |
| tender_type_other | string Additional details when tender_type is OTHER |
| amount | number Amount paid with this tender in minor units of the specified currency |
object (CardTransactionInfo) Card transaction information | |
| doordash_direct_scan_code required | string Scanned barcode or QR code value when tender_type is DOORDASH_DIRECT |
{- "tender_type": "CARD",
- "tender_type_other": "string",
- "amount": 0,
- "card_info": {
- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}, - "doordash_direct_scan_code": "string"
}| merchant_supplied_transaction_id required | string Merchant supplied transaction identifier |
required | object (TransactionContent) Transaction details without merchant-supplied transaction identifier |
object (TransactionContent) Transaction details without merchant-supplied transaction identifier | |
| transaction_timestamp | string <date-time> Timestamp when the transaction occurred in ISO8601 format |
{- "merchant_supplied_transaction_id": "string",
- "in_store_transaction_contents": {
- "total": 0,
- "currency_code": "USD",
- "summary": {
- "subtotal": 0,
- "tax": 0,
- "fees": 0,
- "discount": 0
}, - "items": [
- {
- "line_id": "string",
- "merchant_supplied_item_id": "string",
- "quantity": 0,
- "measurement_unit": "ea",
- "name": "string",
- "category": "string",
- "other_identifiers": [
- {
- "name": "string",
- "value": "string"
}
], - "scan_code": "string",
- "program_eligibility": [
- "SNAP"
], - "price": 0,
- "net_price": 0,
- "price_per_measurement_unit": 0,
- "net_price_per_measurement_unit": 0,
- "discounts": {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}, - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
]
}
], - "discounts": [
- {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}
], - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
], - "fees": [
- {
- "fee_amount": 0,
- "fee_type": "ECO_FEE",
- "fee_type_other": "string"
}
], - "loyalty": {
- "member_info": {
- "member_id": "string",
- "scan_type": "QR_CODE",
- "scan_payload": "string"
}, - "points_awarded": 0
}, - "tenders": [
- {
- "tender_type": "CARD",
- "tender_type_other": "string",
- "amount": 0,
- "card_info": {
- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}, - "doordash_direct_scan_code": "string"
}
]
}, - "marketplace_transaction_contents": {
- "total": 0,
- "currency_code": "USD",
- "summary": {
- "subtotal": 0,
- "tax": 0,
- "fees": 0,
- "discount": 0
}, - "items": [
- {
- "line_id": "string",
- "merchant_supplied_item_id": "string",
- "quantity": 0,
- "measurement_unit": "ea",
- "name": "string",
- "category": "string",
- "other_identifiers": [
- {
- "name": "string",
- "value": "string"
}
], - "scan_code": "string",
- "program_eligibility": [
- "SNAP"
], - "price": 0,
- "net_price": 0,
- "price_per_measurement_unit": 0,
- "net_price_per_measurement_unit": 0,
- "discounts": {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}, - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
]
}
], - "discounts": [
- {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}
], - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
], - "fees": [
- {
- "fee_amount": 0,
- "fee_type": "ECO_FEE",
- "fee_type_other": "string"
}
], - "loyalty": {
- "member_info": {
- "member_id": "string",
- "scan_type": "QR_CODE",
- "scan_payload": "string"
}, - "points_awarded": 0
}, - "tenders": [
- {
- "tender_type": "CARD",
- "tender_type_other": "string",
- "amount": 0,
- "card_info": {
- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}, - "doordash_direct_scan_code": "string"
}
]
}, - "transaction_timestamp": "2019-08-24T14:15:22Z"
}| reason_code | string Enum: "INVALID_SCAN_CODE" "CHECKOUT_NOT_ACTIVE" "UNKNOWN_CHECKOUT_ID" "OTHER" "TRANSACTION_TOTAL_MISMATCH" Reason code for audit result |
| message | string Detailed message for the audit result |
{- "reason_code": "INVALID_SCAN_CODE",
- "message": "string"
}| checkout_id | string DoorDash checkout identifier (optional; authoritative checkout id is parsed from dd_direct_scan_code) |
| client_txn_context_id | string Client-supplied context id for this transaction; server echoes it back in the response |
| dd_direct_scan_code required | string DoorDash Direct scan code for the transaction |
required | object (TransactionContent) Transaction details without merchant-supplied transaction identifier |
| client_request_time | string <date-time> Timestamp when the client initiated the request in ISO8601 format |
{- "checkout_id": "string",
- "client_txn_context_id": "string",
- "dd_direct_scan_code": "string",
- "transaction_contents": {
- "total": 0,
- "currency_code": "USD",
- "summary": {
- "subtotal": 0,
- "tax": 0,
- "fees": 0,
- "discount": 0
}, - "items": [
- {
- "line_id": "string",
- "merchant_supplied_item_id": "string",
- "quantity": 0,
- "measurement_unit": "ea",
- "name": "string",
- "category": "string",
- "other_identifiers": [
- {
- "name": "string",
- "value": "string"
}
], - "scan_code": "string",
- "program_eligibility": [
- "SNAP"
], - "price": 0,
- "net_price": 0,
- "price_per_measurement_unit": 0,
- "net_price_per_measurement_unit": 0,
- "discounts": {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}, - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
]
}
], - "discounts": [
- {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}
], - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
], - "fees": [
- {
- "fee_amount": 0,
- "fee_type": "ECO_FEE",
- "fee_type_other": "string"
}
], - "loyalty": {
- "member_info": {
- "member_id": "string",
- "scan_type": "QR_CODE",
- "scan_payload": "string"
}, - "points_awarded": 0
}, - "tenders": [
- {
- "tender_type": "CARD",
- "tender_type_other": "string",
- "amount": 0,
- "card_info": {
- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}, - "doordash_direct_scan_code": "string"
}
]
}, - "client_request_time": "2019-08-24T14:15:22Z"
}| client_txn_context_id | string Client-supplied context id for this transaction (echoed from request) |
| order_uuid | string DoorDash order UUID |
| delivery_uuid | string DoorDash delivery UUID |
| approval_status | string Enum: "APPROVED" "APPROVED_WITH_CONDITIONS" "DENIED" Overall approval status of the transaction |
Array of objects (TransactionAuditResult) List of audit results explaining why the transaction was approved with conditions or denied; empty when approval_status is APPROVED |
{- "client_txn_context_id": "string",
- "order_uuid": "string",
- "delivery_uuid": "string",
- "approval_status": "APPROVED",
- "audit_results": [
- {
- "reason_code": "INVALID_SCAN_CODE",
- "message": "string"
}
]
}| total required | number Total transaction amount in minor units of the specified currency |
| currency_code required | string Enum: "USD" "AUD" Currency code for the transaction |
object or null (TransactionSummary) Summary of transaction totals; the property may be omitted, sent as an empty object, or sent as null when not applicable | |
Array of objects (TransactionLineItem) List of line items in the transaction | |
Array of objects (DiscountInfo) Transaction-level discounts | |
Array of objects or null (TaxInfo) Transaction-level taxes; omit, use [], or null when not applicable | |
Array of objects (FeeInfo) Transaction-level fees | |
object Loyalty information for transaction | |
Array of objects (Tender) = 1 items List of payment tenders used in this transaction. Exactly one tender must be provided per transaction; requests with zero or multiple tenders are rejected. |
{- "total": 0,
- "currency_code": "USD",
- "summary": {
- "subtotal": 0,
- "tax": 0,
- "fees": 0,
- "discount": 0
}, - "items": [
- {
- "line_id": "string",
- "merchant_supplied_item_id": "string",
- "quantity": 0,
- "measurement_unit": "ea",
- "name": "string",
- "category": "string",
- "other_identifiers": [
- {
- "name": "string",
- "value": "string"
}
], - "scan_code": "string",
- "program_eligibility": [
- "SNAP"
], - "price": 0,
- "net_price": 0,
- "price_per_measurement_unit": 0,
- "net_price_per_measurement_unit": 0,
- "discounts": {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}, - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
]
}
], - "discounts": [
- {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}
], - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
], - "fees": [
- {
- "fee_amount": 0,
- "fee_type": "ECO_FEE",
- "fee_type_other": "string"
}
], - "loyalty": {
- "member_info": {
- "member_id": "string",
- "scan_type": "QR_CODE",
- "scan_payload": "string"
}, - "points_awarded": 0
}, - "tenders": [
- {
- "tender_type": "CARD",
- "tender_type_other": "string",
- "amount": 0,
- "card_info": {
- "bin": "string",
- "card_holder_name": "string",
- "last_four_digits": "string",
- "card_type": "CREDIT",
- "card_type_other": "string",
- "approval_code": "string",
- "card_transaction_status": "string"
}, - "doordash_direct_scan_code": "string"
}
]
}| line_id | string Unique identifier for the line item |
| merchant_supplied_item_id | string Merchant supplied item identifier |
| quantity | number Quantity of the item |
| measurement_unit | string Enum: "ea" "kg" "lb" "gm" "oz" Unit of measurement for the item; accepted in either lower or upper case (e.g., 'ea' or 'EA') |
| name | string Name of the item |
| category | string Category of the item |
Array of objects (OtherIdentifier) Other identifiers associated with the item | |
| scan_code | string Barcode or scan code for the item |
| program_eligibility | Array of strings (ProgramEligibility) Items Enum: "SNAP" "HSA" "FSA" Program eligibility of the item |
| price | number or null Price per unit in minor units of the specified currency; null when the line item does not represent a priced unit (e.g., variable-measure) |
| net_price | number Total net price in minor units of the specified currency |
| price_per_measurement_unit | number or null Price per measurement unit in minor units of the specified currency; null when not applicable (e.g., line item is not measured-by-unit) |
| net_price_per_measurement_unit | number Net price per measurement unit in minor units of the specified currency |
object (DiscountInfo) Discount information for line items or transaction | |
Array of objects or null (TaxInfo) Tax information for this line item; omit, use [], or null when not applicable |
{- "line_id": "string",
- "merchant_supplied_item_id": "string",
- "quantity": 0,
- "measurement_unit": "ea",
- "name": "string",
- "category": "string",
- "other_identifiers": [
- {
- "name": "string",
- "value": "string"
}
], - "scan_code": "string",
- "program_eligibility": [
- "SNAP"
], - "price": 0,
- "net_price": 0,
- "price_per_measurement_unit": 0,
- "net_price_per_measurement_unit": 0,
- "discounts": {
- "amount": 0,
- "discount_type": "MEMBER_SAVINGS",
- "discount_type_other": "string"
}, - "taxes": [
- {
- "amount": 0,
- "tax_type": "SALES_TAX",
- "tax_type_other": "string"
}
]
}| subtotal | number Subtotal amount in minor units of the specified currency before tax and fees |
| tax | number Total tax amount in minor units of the specified currency |
| fees | number Total fees amount in minor units of the specified currency |
| discount | number Total discount amount in minor units of the specified currency |
{- "subtotal": 0,
- "tax": 0,
- "fees": 0,
- "discount": 0
}