Pizza Hut

Check Pizza Hut delivery serviceability and estimated fee for one store and address

Checks whether a Pizza Hut restaurant's delivery integration can deliver to a given address and, when it can, the estimated delivery fee (broken down by fee line item) and pickup/dropoff time. This is a checkout-time estimate -- it does not add an item to a cart or place an order, and takes no payment or account information. serviceable is true only when the upstream returned a real estimate; a false value with reason populated covers every other case seen live, such as the requested delivery_provider not being enabled at that store. For the default INTERNAL provider, a serviceable result does not by itself confirm the address is within a real deliverable radius -- see this endpoint's markdown doc for the caveat. order_subtotal materially affects the fee estimate, so it is required rather than defaulted. pickup_at defaults to 30 minutes from now (an "order now" style estimate) when omitted.

get/pizzahut/delivery-estimate

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/pizzahut/delivery-estimate
  • Auth: API key in header x-api-key

Query parameters

store_numberstring required

Pizza Hut's store number, from /pizzahut/stores

address1string required

Delivery address line 1

address2string

Delivery address line 2

citystring required

Delivery address city

statestring required

Delivery address state, two-letter code

postal_codestring required

Delivery address postal code

country_codestring

Delivery address country code (default US)

latitudenumber required

Delivery address latitude

longitudenumber required

Delivery address longitude

order_subtotalnumber required

Order subtotal before fees, in dollars

pickup_atstring

RFC3339 pickup time (default 30 minutes from now)

delivery_provider'DOORDASH' | 'MOCK_DOORDASH' | 'INTERNAL'

Delivery provider to check (default INTERNAL)

Headers

x-api-keystring required

API key required

Response

OK

codeinteger

Code is the HTTP status code or a custom code used to indicate the result of the request @example 200

msgunknown

Example response

{
  "data": {
    "delivery_provider": "INTERNAL",
    "fee": {
      "amount": 20.99,
      "amount_cents": 2099,
      "currency_code": "USD"
    },
    "fees": [
      {
        "amount": {
          "amount": 20.99,
          "amount_cents": 2099,
          "currency_code": "USD"
        },
        "name": "Delivery fee",
        "type": "DELIVERY_FEE"
      }
    ],
    "reason": "The requested StoreDeliveryProvider has not be enabled at this store",
    "serviceable": true,
    "store_number": "040937"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.