Integrations

API reference › Team settings

Connections to suppliers, Twilio, GoShippo, QuickBooks Online, Square and Shopify.

11 operations

• GETList integrations/v1/api/store/{team_slug}/setting/external_integrationReturns the team's integrations: suppliers, Twilio, GoShippo, QuickBooks Online, Square and Shopify.
• GETList an integration's error log/v1/api/store/{team_slug}/setting/external_integration/{id}/logsReturns the sync errors an integration recorded, newest first, a page at a time (the team's page size).
• POSTSearch integrations/v1/api/store/{team_slug}/setting/external_integration/filterReturns the team's integrations that match filters, a page at a time (the team's page size, 50 by default).
• GETGet an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}Returns one integration with its settings.
• PUTRead data from an integration's provider/v1/api/store/{team_slug}/setting/external_integration/{id}/dataReads live data from the provider through the integration.
• POSTConnect an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}Connects an integration.
• PUTUpdate an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}Changes an integration's settings or credentials.
• PATCHUpdate an integration (same as PUT)/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}Changes an integration's settings or credentials.
• DELETEDisconnect an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}Disconnects an integration.
• PUTRun an integration action/v1/api/store/{team_slug}/setting/external_integration/{id}/actionRuns a one-off action on an integration.
• PATCHRestore a removed Shopify store/v1/api/store/{team_slug}/setting/external_integration/{id}/restoreBrings back a removed Shopify store connection and turns it on again.

Legacy and internal (5)

Prefer the operations above. Legacy operations name their replacement; internal ones are built for YoPrint's own apps.

• PUTSearch QuickBooks, or sync records to itInternal/v1/api/store/{team_slug}/setting/external_integration/{id}/public_actionBuilt for YoPrint's web app, which uses it to link YoPrint records to QuickBooks Online and to push them there.
• PUTRead Shopify orders through the integrationInternal/v1/api/store/{team_slug}/setting/external_integration/{id}/proxy_requestBuilt for YoPrint's web app, to browse orders in a connected Shopify store before importing them.
• POSTCheck a Shopify install signatureInternal/v1/api/store/{team_slug}/setting/external_integration/shopify/verify-signatureBuilt for YoPrint's web app, during a Shopify install that starts from the Shopify admin.
• PATCHRetry a logged integration errorInternal/v1/api/store/{team_slug}/setting/external_integration/retry_action/{id}Asks YoPrint to retry the step behind one error log entry.
• POSTFinish a Shopify installInternal/v1/api/store/{team_slug}/setting/external_integration/shopify/finalize-installBuilt for YoPrint's web app.