A merchant is represented in the delivery.com API by the data structures described below. The data structure has a few small differences depending on which API it is being sent in.
A merchant also has a menu, hours, and reviews.
Contents
Merchant From Search Example
{
"id": "835",
"summary": {
"name": "Barking Dog Luncheonette",
"cuisines": [
"American",
"Sandwiches"
],
"phone": "212-861-3600",
"description": "Voted as the \"Best Budget Brunch\" by the New York Post, Barking Dog Luncheonette serves diner classics like omelettes, sandwiches, burgers and more! Order in your favorite brunch today!",
"overall_rating": 72,
"num_ratings": 129,
"type": "R",
"type_label": "Restaurant",
"notes": [
"In order to process your credit card, We require that you provide your CVV code printed on the back of your credit card. The restaurant will be contacting you after you place your order to obtain this information."
],
"url_stub": {
"geo": "nyc",
"merchant": "barking-dog-luncheonette-10075"
},
"activation_date": "2003-03-06"
},
"ordering": {
"delivery_processes_card": true,
"payment_types": [
"credit",
"gift card",
"promotions",
"cash"
],
"is_rds": false,
"time_needed": 0,
"specials": [
"10% Off All Orders Over $60"
],
"next_order_time": "2014-01-27 22:45:00",
"minimum": 5,
"is_open": true,
"delivery_charge": 0,
"delivery_percent": 0
},
"location": {
"distance": 0.34532518731836,
"street": "1453 YORK AVE",
"city": "NEW YORK",
"state": "NY",
"zip": "10075",
"longitude": -73.951241,
"latitude": 40.770489,
"landmark": "Corner of 77th Street"
}
}
Merchant From Info Example
{
"message": [],
"merchant": {
"id": "835",
"location": {
"street": "1453 YORK AVE",
"city": "NEW YORK",
"state": "NY",
"zip": "10075",
"longitude": -73.951241,
"latitude": 40.770489,
"landmark": "Corner of 77th Street"
},
"summary": {
"name": "Barking Dog Luncheonette",
"phone": "212-861-3600",
"description": "Voted as the \"Best Budget Brunch\" by the New York Post, Barking Dog Luncheonette serves diner classics like omelettes, sandwiches, burgers and more! Order in your favorite brunch today!",
"overall_rating": 72,
"num_ratings": 129,
"type": "R",
"notes": "Array",
"cuisines": [
"American",
"Sandwiches"
],
"url_stub": {
"geo": "nyc",
"merchant": "barking-dog-luncheonette-10075"
},
"activation_date": "2003-03-06"
},
"ordering": {
"availability": {
"pickup": false,
"delivery": false,
"next_pickup_time": "2014-01-28T07:00:00-0500",
"next_delivery_time": "2014-01-28T07:00:00-0500"
},
"payment_types": [
"credit",
"gift card",
"promotions",
"cash"
],
"time_needed": "0",
"specials": [
"10% Off All Orders Over $60"
],
"order_type": "delivery"
}
}
}
merchant.summary
General information about the merchant
| Property Name | Value | Description |
|---|---|---|
| id | String | Unique identifier for this merchant. |
| name | String | Name of the merchant. |
| cuisines | String[] | Array of different cuisines that this merchant offers. |
| phone | String | Merchant phone number. |
| description | String | Description generated by the merchant. |
| overall_rating | Integer | Rating of the merchant generated by user reviews, on a scale of 1-100. 0 means that the merchant hasn’t had any reviews yet. |
| type | R|C|F|I|W|U|P|Z | Type of merchant. See Merchant Search. |
| notes | String | Extra info about ordering from this merchant that is usually more important to the user than the description. E.g. ‘Adding additional meat to a salad is $1.00 extra.’ |
| url_stub | Object | Ignore and use summary.url instead. |
| url | String | (TODO)A link to the merchant listing on delivery.com. We’ll handle redirecting mobile users as necessary. |
| activation_date | String | The date that the merchant went live on delivery.com. The format is YYYY-MM-DD. |
merchant.ordering
Data related to placing orders from this merchant.
| Property Name | Value | Description |
|---|---|---|
| payment_types | String[] | The different payment options that this merchant accepts. |
| is_rds | true|false | If true, this merchant uses a 3rd party delivery service to deliver orders. |
| time_needed | Integer | How much time a merchant needs to prepare an order. For example, if you’re allowing customers to book future orders, you shouldn’t let them book a pickup order for the minute the merchant opens. |
| specials | String[] | null | Array of specials that this merchant offers. |
| last_or_next_order_time | String | If the merchant is currently accepting orders, this is the last time that you can place an order today. If they’re not accepting orders, it’s the next time that you can place an order for. |
| minimum | Float | Minimum order size for pickup/delivery depending on which endpoint you’re calling. |
| is_open | true|false | Whether or not this merchant is open at the current point in time. |
| delivery_charge | Float | The flat fee that this merchant charges for delivery. |
| delivery_percent | Float | The percentage fee that this merchant charges for delivery. This ranges from 0-1, so 15% would be represented as 0.15. |
merchant.location
Location Location object.
| Property Name | Value | Description |
|---|---|---|
| distance | Double | The distance in miles from this merchant to the searched location. |
| landmark | String | Extra info about where the merchant is located. |
merchant.ordering
Search specific properties
| Property Name | Value | Description |
|---|---|---|
| favorite | true|false | Whether or not the user has favorited this merchant. You must submit an access token with your request to see this parameter. |
| delivery_processes_card | true|false | If true, delivery.com charges the customer’s credit card. If false, the merchant charges it. |
merchant.ordering.availability
| Parameter | Type | Explanation |
|---|---|---|
| active | boolean | Is the merchant currently active |
| pickup | boolean | Is pickup available at the requested order_time |
| delivery | boolean | Is pickup available at the requested order_time |
| pickup_supported | boolean | Does the merchant even support pickup? |
| delivery_supported | boolean | Does the merchant even support delivery? |
| last_pickup_time | time | If pickup available it will show timestamp; otherwise null. |
| last_delivery_time | time | If delivery available it will show timestamp; otherwise null. |
| next_pickup_time | time|null | If pickup not available it will show timestamp; otherwise null. |
| next_delivery_time | time|null | If delivery not available it will show tiemstamp; otherwise null. |
| pickup_estimate | integer | Estimated pickup time |
| delivery_estimate | integer | Estimated delivery time |