For the complete documentation index, see llms.txt. This page is also available as Markdown.

Setup

Installing the Shopify app and connecting your first pyck tenant

Audience: Logistics Manager

Setting up is one step: connect one pyck tenant. Everything else on this page is optional and can wait.

1. Install the app

Install the pyck app into your Shopify store the way you install any Shopify app. Shopify will ask you to approve the permissions it needs — reading and writing products, customers, orders, inventory and locations.

After the install, the app opens on a Setup page titled "Welcome to pyck". Until you finish it, nothing syncs.

2. Connect your first tenant

The Setup page asks for one pyck tenant. There are two ways to give it one.

Sign in to pyck

Pick your pyck system and choose Connect pyck account. You sign in to pyck in a new window, come back, and pick which of your pyck tenants this store belongs to. The app creates the credentials for you.

This is the easier route and the one to use when your pyck system offers it.

Paste an API key

If your pyck system has no sign-in registered, or the sign-in is not cooperating, choose Enter an API key manually. You then give the app two things:

  • the pyck system, or a custom endpoint URL if yours is self-hosted — the full GraphQL endpoint address

  • your pyck API key

Either way you end up with the same thing: one connection.

3. Setup is now complete

The connection you just made is called production. It is your live warehouse: the only connection that fulfils orders and the only one allowed to change your Shopify stock.

The name production is permanent. Routing labels point at that exact text, so it cannot be renamed later.

The moment it is saved:

  • Setup is complete and the app's menu changes to Home, Connections, Warehouse stock and Activity.

  • Products, customers and orders are all switched on and start flowing to pyck as they change in Shopify.

You can turn any of the three off under Connections. Products and orders sync as you would expect; customers sync their profiles and also record the route labels their orders later inherit.

Product variants without a SKU are never sent. pyck finds stock by SKU, so a variant without one has nothing to match against.

4. Bring your existing catalogue over

New and changed records flow automatically, but records that already existed before you installed the app have never been sent. To send them once:

  1. Open Activity.

  2. Check the line under Full sync — it names which types are enabled.

  3. Choose Sync now.

This walks your whole store and sends everything currently switched on. The same Activity page then lists every sync attempt, so you can see what landed and what did not.

Run this once after setup. After that, ordinary changes keep pyck up to date on their own.

What is optional from here

Nothing below is required, and none of it is switched on by default.

If you want to
Go to

Fill fields of your own pyck schemas from Shopify, or keep them under pyck's control

Sync to more than one pyck tenant, or steer specific records at one tenant

Let pyck own your Shopify stock counts

Check a connection is healthy

Connections, then Validate on the connection's card

Deleting your last connection reopens setup, and syncing stops until you connect one again.

Last updated

Was this helpful?