Quickstart

In about 10 minutes: send your first query and find your shop and device IDs.

Before you start

• A Staging or Production API key (see Environments).
• The Device ID your integration is registered as. It's required to create some entities (see Your shop and your device).
• The Apollo GraphQL Playground (see Playground).

Get your shop information

Request:

query Shops {
  shops {
    edges {
      node {
        id
        name
      }
    }
  }
}

Response:

{
  "data": {
    "shops": {
      "edges": [
        {
          "node": {
            "id": "8d6f…", // This is your ShopID
            "name": "My wine shop"
          }
        }
      ]
    }
  }
}

Your shop and your device

Your requests need two IDs: a shop and a device.

• The shop (shopId): almost everything in Wino belongs to one shop: products, prices, stock, customers. A merchant with a shop in Lyon and one in Paris has two catalogs, so when you create a product, Wino needs to know which shop it goes in.
• The device (deviceId): a device is where a change comes from: a shop's cash register, the web back-office, an ERP, or your integration. Wino records it on every stock movement (createStockActivity needs it), so the merchant can see that a sale came from the website and not from the register.

Your device ID comes with your API key. devices lists the devices of your shops, with their shop. slug says what each device is: W is the web back-office, d the dashboard, ERP an ERP integration, BOT Wino's automatic changes, and any other value is a cash register.

query Devices {
  devices(first: 50) {
    edges {
      node {
        id
        name
        slug
        shop {
          id
          name
        }
      }
    }
  }
}

You can read the other devices, but don't use them: record your changes with your own device only. The API doesn't create or change devices.

Next

• Playground: try requests in your browser.
• Catalog: how products, variants, prices and stock fit together.
• Webhooks: be notified when data changes.