Welcome to Codat's API Documentation

Develop against the Codat API.

Guides    API Reference

Set up Shopify in UAT

Before you can pull commerce data from companies using Shopify, you need to set up an integration in Codat's environments, starting with UAT.

You'll need to:

  • Create an account in the Codat UAT Portal.
  • Create a Shopify application in the Shopify developer portal and retrieve your secure credentials (API key and secret).
  • Send your app to Shopify for approval.
  • Add your secure credentials to the Codat Portal in UAT and enable your test Shopify integration.
  • Check your sync settings.

Create a Shopify application and retrieve your secure credentials

Shopify's app requirements

  • All public applications created in Shopify must meet Shopify's requirements and be approved by Shopify. Please be advised that it may take the Shopify Review team up to 2 weeks to review your app.
  • As part of Shopify's app requirements, Codat clients must make a request to access to all of a merchant's orders. Please be advised that it may take up to 7 business days for Shopify to process your request.

Please note Codat cannot guarantee that access to order data is granted or that your app is approved by Shopify.

Developer account details

  • If you already have a Shopify developer account, have your account details to hand.

  • If you don't, create an account before you start to create your application.

  1. Go to the Shopify developer portal and log in.
  2. Click Apps, then Create app, and choose Public app. Although your app will be public, you can choose whether you want it to be listed (fully visible in the Shopify App Store) or unlisted (it will not appear in Shopify App Store search engines or results, but will have a Shopify App Store URL). To change this setting go to App visibility.
  3. Fill in your app details (note that your app name and URL cannot contain "Shopify"):
    • App name
    • App URL (for example, your homepage address. The URL will not be visible to merchants during Codat's linking process.)
    • in the Redirection URLs box, paste the following: https://commerceintegration-uat.codat.io/oauth/callback.
  4. Click Create app. You should now see the API key and API secret key of your app in the API keys section. You will use these to link the app to the Codat Portal.
  5. Click App setup.
  6. In the Orders section, click Request access to send a request to Shopify to access all orders for your store. You will receive an email from Shopify once the request has been processed, which may take up to 7 business days.
  7. Scroll to GDPR mandatory webhooks and enter the following URLs:
    Customer data request endpoint: https://commerceintegration-uat.codat.io/webhooks/customer/request
    Customer data erasure endpoint: https://commerceintegration-uat.codat.io/webhooks/customer/delete
    Shop data erasure endpoint: https://commerceintegration-uat.codat.io/webhooks/shop/delete
  8. Save your changes.

Send your app to Shopify for approval

  1. Go to your app dashboard and click App listing.
  2. Under App visibility choose the English listing section, fill out the required application details and save your changes.
  3. On the App listing page click Submit app to send it to Shopify for review and approval. Note that the review might take up to two weeks.

Add your secure credentials to the Codat Portal and enable your test Shopify application

  1. Open the Codat Portal and log in.
  2. Go to Integrations > Commerce.
  3. Find Shopify, and select the Manage button next to it.
  4. From the API keys page on the Shopify developer portal, copy and paste:
    • API key value into Client Key
    • API secret key value into Client Secret.
  5. In the Codat Portal, click Save.
  6. Go back to Integrations > Commerce, and use the toggle to update the Shopify integration from Disabled to Enabled.

Check your sync settings in the Codat Portal

If this is your first commerce integration, update your sync settings to enable commerce data types.

Now follow the instructions in Test Shopify to test your setup.

Updated about a month ago

Set up Shopify in UAT

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.