Skip to main content

Pickware GraphQL API overview

Early access
Pickware 1.74.0 and later serve the 2026-06-unstable schema, which may still receive breaking changes, each marked in the Pickware changelog. See Versioning.

The Pickware GraphQL API is part of Pickware on Shopware 6 and available on the Professional and Enterprise plans. It runs inside the shop: integrations send their requests to the shop's own domain and work with the Pickware data of that shop. Its schema covers stock, purchasing, goods receipts, warehouses, bin locations, orders, quotes, documents, products, and supplier data, and it can notify integrations about changes through webhooks.

Running Pickware ERP on Shopify instead? The Shopify section covers its endpoint, tokens, and versioning.

The documentation has two parts:

  • Guides explain how to work with the API in a Shopware 6 shop and describe common merchant integration use cases.
  • The API reference is generated from the GraphQL schema and documents the exact queries, mutations, fields, inputs, and required scopes.

What you can build​

  • Synchronize stock levels across products, warehouses, and bin locations.
  • Apply stock corrections and transfer stock between bin locations.
  • Create and manage supplier orders and supplier order line items.
  • Maintain product-supplier configurations such as purchase prices, supplier product numbers, delivery times, and order constraints.
  • Create goods receipts and move them through approval and completion.
  • Manage warehouses and bin-location codes.
  • Read the orders of the shop and ship them completely.
  • Find products and variants by product number, GTIN, or other exposed identifiers.
  • Read sales quotations with their line items, state, and the order they were converted into, and open a new quote for a customer.
  • Get notified over HTTPS when an order ships, a goods receipt is completed, or a product runs out of stock.

What is different on Shopware 6​

  • One endpoint without a version. Every request goes to POST https://<your-shop-domain>/api/graphql. The endpoint serves the schema that ships with the installed Pickware version; see Versioning.
  • Tokens are created in the Shopware administration under Settings → System → Integrations on the GraphQL API tokens tab; see Authentication.
  • Requests are not throttled. Each query is still subject to a complexity and a depth limit, so split very large queries into smaller pages; see Errors.
  • Webhooks need a publicly reachable shop. The webhook delivery service verifies the shop at its APP_URL; see Webhooks.
  • Shopware's own data stays on the Shopware Admin API. The Pickware GraphQL API covers Pickware data such as stock and purchasing. Everything else in the shop, for example CMS pages or the shop's settings, is still read and written through the Shopware Admin API.

Where to go next​

  • Follow Getting started to run your first query.
  • Read Authentication to create a token and authorize requests.
  • Read Versioning to find out which schema your Pickware version serves.
  • Read Webhooks to react to changes instead of polling for them.
  • Open the Product stock use case for the stock workflow.
  • Review Working with lists before building synchronization jobs.
  • Read Errors for the error format and retry guidance.
  • Use the API reference when you need the exact GraphQL field or input shape.