Store API (v1.0)

Download OpenAPI specification:Download

Store By Id

By passing in the appropriate options, you can search for available Store by company

query Parameters

Latitude	number Search Latitude (requires longitude)
Longitude	number Search Longitude (requires latitude)
Radius "Search Radius (requires longitude and latitude) default 5 miles"	integer Radius

header Parameters

X-Company

required

string

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 0,
"companyId": 0,
"companyName": "string",
"name": "string",
"phoneNumber": "string",
"email": "string",
"address": "string",
"additionalAddressInfo": "string",
"city": "string",
"state": "st",
"postalcode": "string",
"primaryContact": {"id": 0,
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"email": "string"
},
"timeZone": "string",
"paymentAddressRequiredForPayments": false
}
],
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Store By Id

By passing in the appropriate options, you can search for available Store in the system

path Parameters

id

required

integer

ID of the Store

Responses

Response samples

200

Content type

application/json

{"data": {"id": 0,
"companyId": 0,
"companyName": "string",
"name": "string",
"phoneNumber": "string",
"email": "string",
"address": "string",
"additionalAddressInfo": "string",
"city": "string",
"state": "st",
"postalcode": "string",
"primaryContact": {"id": 0,
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"email": "string"
},
"timeZone": "string",
"paymentAddressRequiredForPayments": false
},
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Get Delivery Metrics and if available and Fees

Get Delivery Metrics and if address is eligible for delivery

path Parameters

id

required

integer

ID of the Store

query Parameters

streetNumber required	string address to lookup
streetName required	string street name and type
city	string state
state	string state
postalCode	string address to lookup
includeDrivingDistance	string Include Driving Distance (default false)
distanceUOM	string Distance UOM (mi or km) (default mi)

Responses

Response samples

200

Content type

application/json

{"data": {"zoneName": "string",
"deliverable": true,
"distance": 0,
"drivingDistance": 0,
"distanceUOM": "string",
"deliveryFee": 0,
"longitude": -180,
"latitude": -90
},
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

List Email Messages to be sent

path Parameters

id

required

integer

ID of the Store

Request Body schema: application/json

Email Message to send

Array of objects (EmailMessage)

Array

	Array of objects (EmailAddress) List to ToEmailAddress
	Array of objects (EmailAddress) List to CCEmailAddress
	Array of objects (EmailAddress) List to bccEmails
subject	string Subject line of the email message
	object (EmailAddress) Email Address
	Array of objects (EmailContent) List to contents
	Array of objects (EmailAttachment) An array of objects where you can specify any attachments you want to include.
	object (Tags) Custom Tags

Responses

Request samples

Payload

Content type

application/json

{"data": [{"toEmails": [{"email": "string",
"name": "string"
}
],
"ccEmails": [{"email": "string",
"name": "string"
}
],
"bccEmails": [{"email": "string",
"name": "string"
}
],
"subject": "string",
"fromEmail": {"email": "string",
"name": "string"
},
"contents": [{"contentType": "string",
"value": "string"
}
],
"attachments": [{"content": "string",
"type": "string",
"filename": "string",
"disposition": "string",
"contentId": "string"
}
],
"tags": {"siteId": "string",
"emailType": "string"
}
}
]
}

Response samples

422

Content type

application/json

{"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Deprecated

List Email Messages to be sent

path Parameters

id

required

integer

ID of the Store

Request Body schema: application/json

Email Message to send

Array of objects (EmailMessage)

Array

	Array of objects (EmailAddress) List to ToEmailAddress
	Array of objects (EmailAddress) List to CCEmailAddress
	Array of objects (EmailAddress) List to bccEmails
subject	string Subject line of the email message
	object (EmailAddress) Email Address
	Array of objects (EmailContent) List to contents
	Array of objects (EmailAttachment) An array of objects where you can specify any attachments you want to include.
	object (Tags) Custom Tags

Responses

Request samples

Payload

Content type

application/json

{"data": [{"toEmails": [{"email": "string",
"name": "string"
}
],
"ccEmails": [{"email": "string",
"name": "string"
}
],
"bccEmails": [{"email": "string",
"name": "string"
}
],
"subject": "string",
"fromEmail": {"email": "string",
"name": "string"
},
"contents": [{"contentType": "string",
"value": "string"
}
],
"attachments": [{"content": "string",
"type": "string",
"filename": "string",
"disposition": "string",
"contentId": "string"
}
],
"tags": {"siteId": "string",
"emailType": "string"
}
}
]
}

Response samples

422

Content type

application/json

{"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

List store GeoFences

By passing in the appropriate options, you can search for available GeoFences for a store

path Parameters

id

required

integer

ID of the Store

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"delivery": true,
"additionalFee": 0,
"driverCompensation": 0,
"geoCodes": [{"sequence": 0,
"longitude": -180,
"latitude": -90
}
]
}
],
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Store Gateway credentials

Gateway credentials for Payments

path Parameters

id

required

integer

ID of the Store

Responses

Response samples

200

Content type

application/json

{"data": {"id": "string",
"accountToken": "string",
"acceptorId": "string",
"terminalId": "string"
},
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

List Order Types

By passing in the appropriate options, you can search for available Order Types for a store

path Parameters

id

required

integer

ID of the Store

query Parameters

serviceType

string (ServiceType)

Enum: "None" "GrubHubEMail" "DoorDash" "GrubHub" "UberEats" "GoogleOrdering" "Menufy" "Kanekt365"

pass an optional search to lookup by serviceType

Responses

Response samples

200

Content type

application/json

{"data": [{"estimatedTime": 0,
"estimatedTimeManager": 0,
"estimatedTimeManagerDate": "2019-08-24",
"orderTypeCategory": "Pickup",
"paymentTypes": [{"id": "string",
"paymentTypeCategory": "string"
}
],
"orderChannels": [{"id": 0,
"name": "string"
}
],
"id": "string"
}
],
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Get Order Type

By passing in the appropriate options, you can search for order type

path Parameters

id required	integer ID of the Store
orderType required	string OrderType

Responses

Response samples

200

Content type

application/json

{"data": {"estimatedTime": 0,
"estimatedTimeManager": 0,
"estimatedTimeManagerDate": "2019-08-24",
"orderTypeCategory": "Pickup",
"paymentTypes": [{"id": "string",
"paymentTypeCategory": "string"
}
],
"orderChannels": [{"id": 0,
"name": "string"
}
],
"id": "string"
},
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Patch Order Type

Properties will be merged with exisitng Store Order Type. Limited to EstimatedTime, estimatedTimeManager and estimatedTimeManagerDate at this time.

path Parameters

id required	integer ID of the Store
orderType required	string OrderType

Request Body schema: application/json

Store Order Type Patch

	object (StoreOrderType) Order Type
message	string High level message suitable to display
	Array of objects (MessageDetail) More detailed messages

Responses

Request samples

Payload

Content type

application/json

{"data": {"estimatedTime": 0,
"estimatedTimeManager": 0,
"estimatedTimeManagerDate": "2019-08-24",
"orderTypeCategory": "Pickup",
"paymentTypes": [{"id": "string",
"paymentTypeCategory": "string"
}
],
"orderChannels": [{"id": 0,
"name": "string"
}
],
"id": "string"
},
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Response samples

422

Content type

application/json

{"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Get Order Type EstimatedTime

By passing in the appropriate options, you can search for order type EstimatedTime

path Parameters

id required	integer ID of the Store
orderType required	string OrderType

query Parameters

desiredDueTime

required

string <date-time>

Desired Due Time of the Order Date and time in ISO 8601 format. YYYY-MM-ddTHH:mm:ssZ or YYYY-MM-ddTHH:mm:ss.ss±hh:mm

Responses

Response samples

200

Content type

application/json

{"data": {"estimatedTime": 0
},
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

List Service Types

By passing in the appropriate options, you can search for available Service types for a store

path Parameters

id

required

integer

ID of the Store

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string"
}
],
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Get SystemConfiguration ()limted number of properties at this time)

By passing in the appropriate options, you can search for available Service types for a store

path Parameters

id

required

integer

ID of the Store

Responses

Response samples

200

Content type

application/json

{"data": {"message": "string"
},
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Patch SystemConfiguration

Properties will be merged with exisitng Store System Configuration. Limited to System Message at this time.

path Parameters

id

required

integer

ID of the Store

Request Body schema: application/json

Store System Configuration Patch

	object (StoreSystemConfiguration) Store System Configuration
message	string High level message suitable to display
	Array of objects (MessageDetail) More detailed messages

Responses

Request samples

Payload

Content type

application/json

{"data": {"message": "string"
},
"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}

Response samples

422

Content type

application/json

{"message": "string",
"messagesDetails": [{"id": "string",
"message": "string",
"messageType": "ERROR"
}
]
}