Skip to main content

Getting Started

This guide will help you authenticate with the Scoffable API and make your first request.

1. Generate a Bearer Token​

  1. Log in to the Scoffable Partner Centre
  2. Navigate to the Developers section
  3. Click Create New Token
  4. Select which vendor locations this token should access
  5. Provide a description to identify the token's purpose

See Authentication for more details. If you do not see the Developers section, please contact Scoffable for access.

2. Send a Request​

Include your Bearer Token in the Authorization header when calling an endpoint.

Example request:

GET https://partners-api.scoffable.com/v1/orderUpdates
Authorization: Bearer YOUR_TOKEN

3. Parse the Response​

A successful request returns an HTTP 200 OK response with a JSON body:

{
  "hasMore": true,
  "data": [
    {
      "id": 72818291,
      "version": 1,
      "latestVersion": true,
      "vendorId": "YOUR_VENDOR_ID_1",
      "status": "accepted",
      "type": "delivery",
      "placedAt": 1641038400000,
      "total": {
        "amount": 2930,
        "currency": "GBP"
      },
      "items": [
        {
          "name": "Margherita Pizza",
          "quantity": 1,
          "price": {"amount": 1450, "currency": "GBP"}
        }
      ]
    }
  ],
  "nextPageId": "c8138c3f-3482-488e-aaaa-ae401cc73760"
}

Use the hasMore and nextPageId fields for pagination if multiple pages are available. See Order Sync for complete integration guidance.