FAQ

Answers to the questions developers ask most.

How do I get an API key?

See Authentication.

My request returns UNAUTHENTICATED.

The key is missing, invalid, or belongs to the other environment. See Errors.

A list is empty, but the data exists.

• Archived items are hidden by default on most lists: add filterBy: { archived: INCLUDED } to get them too.
• With a filter on shopIds, check the shop ID.
• Check that your key gives access to that shop.

I see the same variant several times.

Your key gives access to several shops, and each shop has its own copy of the variant. Filter by shop, or group the copies that Wino linked by cku.

How do I find the stock of a variant?

Ask for stock { rawQuantity formattedQuantity } on the variant. See Catalog.

Can I delete what I created while testing?

No: the API has no delete. Archive it instead, and test on staging (see Environments).

I don't receive webhook notifications.

• Check that the subscription isn't disabled, and that the kind of data you expect is true in its settings.
• Check that your URL is public, uses https, doesn't redirect, and answers with a 2xx status within 10 seconds.
• Check that you subscribed for the right shop.
• Some changes send no notification: see Not every change sends a notification.
• Wait up to 5 minutes after creating or changing a subscription: changes aren't applied right away.

See Webhooks.

A field is marked as deprecated.

It still works but will be removed. The GraphQL schema gives its replacement.