Accounts - Show

Overview

This endpoint allows you to list information about a given account.

---

Request

GET /v1/accounts/{account_uuid}

Example Request

GET /v1/accounts/3584a197b5a9

---

Response

Response Values

Key	Type	Value
uuid	String	A unique ID for the given account.
default_promised_delivery_minutes	Integer or null	The default promised delivery minutes for the account
friendly_name	String	A friendly name
kind	String	fleet or store
partners_external_identifier	String	a specific external id assigned by the Partner creating the store
fleet_account_uuid	String or null	The uuid of the fleet (account) if this account belongs to one
webhook_settings	Object Webhook Settings	Information about webhook settings.

Webhook Settings

⚠️ Warning This key will not be sent if your account is using the new webhook system.

Key	Type	Description	Example
webhook_url	string	default webhook url	http://webhook.com/default_url
order_kds_print_request_webhook_url	string	webhook url for order_kds_print_request.	http://webhook.com/order_kds_print_request
item_status_updated	Object	Information about item_status_updated webhook
order_preparation_updated	Object	Information about order_preparation_updated webhook

Item and Order Preparation Updated

Key	Type	Description	Example
being_prepared	Boolean	whether to send webhook when status is updated to being_prepared	false
prepared	Boolean	whether to send webhook when status is updated to prepared	true
suggested	Boolean	whether to send webhook when status is updated to suggested	false
webhook_url	String	Webhook URL to send the event to	http://webhook.com/item_preparation_updated

Example Response

{
  "uuid": "c99f9692429c",
  "default_promised_delivery_minutes": 60,
  "friendly_name": "ChocoF",
  "partners_external_identifier": "POSKing-224",
  "kind": "store",
  "fleet_account_uuid": "e96043b3d8d6",
  "webhook_settings": {
    "webhook_url": "http://webhook.com/default_Webhook_url",
    "order_kds_print_request_webhook_url": "http://webhook.com/order_kds_print_request",
    "item_status_updated": {
      "being_prepared": true,
      "prepared": true,
      "suggested": false,
      "webhook_url": "http://webhook.com/item_status_updated"
    },
    "order_preparation_updated": {
      "being_prepared": true,
      "prepared": false,
      "suggested": false,
      "webhook_url": "http://webhook.com/order_preparation_updated"
    }
  }
}