The Square connector pulls Square orders and locations into the app, and sends fulfillments, product updates, and inventory between the app and Square.
With this connector, you can:
- Pull your active Square locations into the app.
- Pull Square orders: point-of-sale pickup and delivery orders, regular shipping orders, or both.
- Push fulfillments with tracking to Square for shipping orders.
- Push product updates to Square.
- Pull inventory from Square, or push inventory to Square.
- Pull specific orders on demand by order ID or by date.
Setup
Before you begin, make sure you have:
- A Square seller account you can sign in to, with permission to connect apps.
- Pop-up blockers turned off in your browser, so the Square sign-in window can open.
Approve the connection in Square
- You don’t create any keys in Square. When you click Connect in the app, Square opens.
- Sign in to Square with the seller account you want to connect.
- Review the permissions and approve them. Finish within 15 minutes, or the connection times out.
Note: To disconnect later, in Square Dashboard, go to Settings > App integrations, and disconnect the app. This stops the integration.
To learn more, see Square’s OAuth API overview.
Connect Square in the app
- Navigate to Integrations and click Add integration.
- Search for Square and select it. The Connect Square pop-up opens.
- In Select Square environment, keep Production. Use Demo only with a Square sandbox test account.
- Click Connect, and approve the connection in Square.
Note: If you aren’t ready to sign in yet, click Add without credentials. The integration is added but doesn’t sync until you connect it from its Connection Details tab.
Confirm the connection
- Navigate to Integrations. Square shows Connected. If it shows Error or Not Configured, open it, check the connection on the Connection Details tab, and click Save.
- Make sure the switch on the integration’s row is on.
- On the Settings tab, turn on Pull locations from Square and click Save. Your active physical Square locations appear in Inventory > Locations. To include online locations, turn on Pull all locations.
- Test with one order. Set Exclude orders created before this date to the current date and time. In Order types to pull, choose the type of order you’ll test with. The default is point-of-sale orders only. Turn on Pull orders from Square, click Save, and place a test order in Square. The order appears in Orders within about 5 minutes.
Note: Square has no order ID filter. To pull one specific order, use the Pull orders from Square by external order ID action on the Integration Actions tab.
Note: By default, the app pulls regular orders that are Open or Canceled, and point-of-sale orders that are Completed.
Settings
These settings are on the integration’s Settings tab.
| Setting | Options/Default |
|---|---|
| Pull locations from Square | On/Off. Default: Off |
| Pull all locations | On/Off. Default: Off |
| Pull orders from Square | On/Off. Default: Off |
| Exclude orders created before this date | Optional |
| Order types to pull | POS ('pickup' or 'delivery'), Regular, Both. Default: POS ('pickup' or 'delivery') |
|
Pull exchanges Enable to pull orders that are exchanges, containing both new and returned items |
On/Off. Default: Off |
|
Skip empty orders Do not pull empty orders (with zero total and no order lines). |
On/Off. Default: Off |
| Pull regular orders with these statuses only: | Draft, Open, Completed, Canceled. Default: Open, Canceled |
| Pull POS orders with these statuses only: | Draft, Open, Completed, Canceled. Default: Completed |
| Push fulfillments to Square | On/Off. Default: Off |
| Push product catalog updates to Square | On/Off. Default: Off |
| Process only products with specific SKUs | Optional |
| Maintain Square options for variant products | On/Off. Default: Off |
|
Manage 'Stock/Tracking' flag Disable this option to keep the 'Tracking' flag intact. Enable to allow Pipe17 to control the flag. |
On/Off. Default: Off |
| Force product catalog resync | On/Off. Default: Off |
| Process inventory information | Disabled, Pull inventory from Square, Push inventory to Square, Process inventory according to location attributes. Default: Disabled |
| Process inventory information only for products with specific SKUs | Optional |
| Force inventory resync | On/Off. Default: Off |
Troubleshooting
- The integration fails with “Authorization timed out”
The Square approval wasn’t finished within 15 minutes. Click Connect again and finish in Square. - The integration stops with “invalid_token” or “invalid_refresh_token”
Access was removed in Square, for example under Settings > App integrations. Click Connect and approve again. - A Square order isn’t pulled
Check Order types to pull and the status settings, and that the order was created after Exclude orders created before this date. If the order has no lines, turn off Skip empty orders. - Online store locations are missing
By default, the app pulls only active physical locations. Turn on Pull all locations.
Need Help?
If you need additional assistance:
- Use Ask Pippen, our AI agent, located at the top of the platform page.
- Submit a support request with as much relevant detail as possible. Learn how to submit a request.
We’re here to help you succeed with your operations.
Comments
0 comments