Apps

Methods

Get a list of apps for Online Ordering

Retrieves a list of apps for Online Ordering

GET /marketplace/v2/apps/online-ordering

Response 200

Returns a list of apps for Online Ordering

[
  {
    "guid": "string",
    "key": "string",
    "name": "string",
    "originAppKeys": [
      "string"
    ]
  }
]

Example:

[
  {
    "guid": "1aecbde2-e4ec-4fad-af98-b2a35e999eaf",
    "key": "deliverect",
    "name": "Deliverect",
    "originAppKeys": [
      "doordash",
      "uber-eats",
      "grubhub"
    ]
  },
  {
    "guid": "f55c4cd8-315c-4c9d-abe1-9b6a4f05c923",
    "key": "cuboh",
    "name": "Cuboh",
    "originAppKeys": [
      "doordash",
      "uber-eats",
      "grubhub",
      "postmates"
    ]
  }
]

Response 401

Unauthorized โ€“ invalid or missing public credentials.

Response 500

Internal server error


Add App Installation Origin Keys

Adds origin keys to an app installation for a specific location.

POST /marketplace/v2/locations/{locationId}/app-installation/origin-keys

Path Parameters

Name Type Description
locationId* integer location id

Request Body (required) Array of origin app keys

Content-Type: application/json

Example body:

[
  "doordash",
  "uber-eats"
]

Response 201

App installation origin keys added successfully.

[
  "doordash",
  "uber-eats",
  "grubhub"
]

Response 400

Invalid request body - must be an array of strings.

Response 401

Unauthorized โ€“ invalid or missing public credentials.

Response 404

Location not found or inaccessible for the caller.

Response 500

Internal server error.


Delete App Installation Origin Keys

Deletes app installation origin keys for a specific location.

DELETE /marketplace/v2/locations/{locationId}/app-installation/origin-keys

Path Parameters

Name Type Description
locationId* integer location id

Request Body (required) Array of origin app keys to delete

Content-Type: application/json

Example body:

[
  "doordash",
  "uber-eats"
]

Response 200

App installation origin keys deleted successfully.

[
  "grubhub"
]

Response 400

Invalid request body - must be an array of strings.

Response 401

Unauthorized โ€“ invalid or missing public credentials.

Response 404

Location not found or inaccessible for the caller.

Response 500

Internal server error.

Note

The originAppKeys from this response should be used when creating orders. The app information retrieved here is required for the order creation process.

See Create Order for more details on how to use this data.

results matching ""

    No results matching ""