Shopify Custom App Creation

Step 1. Add a Integration Model Code in `eshopbox_wms_production.integration_models` table which will be required at the time of App Creation. Model code will look like as shown below

Or

Create integration model using API 
curl --location 'https://partners.myeshopbox.com/api/v1/integration-model' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik1UaERRamxDUlRJelJVUTRRVU0wUVRJNU1FSkVOVGszUVVFeU5qVXdSa1JDTmpBeU16WTROQSJ9.eyJodHRwczovL2FwcERhdGEiOnt9LCJodHRwczovL3VzZXJEZXRhaWxzIjp7ImlkIjozMzYxLCJ1c2VyVHlwZSI6ImRlZmF1bHQiLCJlbWFpbCI6InN1ZGlwLmRhc0Blc2hvcGJveC5jb20ifSwiaHR0cHM6Ly9hY2NvdW50cyI6WyJxdWFudHVteC12ZW50dXJlcyJdLCJodHRwczovL3dhcmVob3VzZVdvcmtzcGFjZXMiOltdLCJodHRwczovL3dhcmVob3VzZXMiOltdLCJodHRwczovL3BhcnRuZXJzIjpbXSwiaXNzIjoiaHR0cHM6Ly9lc2hvcGJveC5hdXRoMC5jb20vIiwic3ViIjoiZW1haWx8NjMyOTUzNWFjZmQ4Y2VkZjJkYmNmNmY0IiwiYXVkIjpbImh0dHBzOi8vd21zLm15ZXNob3Bib3guY29tIiwiaHR0cHM6Ly9lc2hvcGJveC5hdXRoMC5jb20vdXNlcmluZm8iXSwiaWF0IjoxNzI0NDAxMzk2LCJleHAiOjE3MjQ0ODc3OTYsInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwiLCJhenAiOiJJSU5KNmtuM0VCRktkMmVURnpNb1lnS2ZobDY1NDAyTCJ9.dXrx1LU4l1W8LEAPYwfzKLSC3W64CeYeFy4E9L3rsv97229vi8NsIvlP68oz4zV51BNTTAWzjrHX2Rn4XvLoERzkE4kdGCjQIWV_-6t5O2hFENFHt1OSTDipBK7o_X2YsYWZrU_hfuLfPDHLGq01hklIHq4wb1HAwJCRPGewg3Bu20gQOatAjKwk25aNBAHVyg6PzpKXal0P1YnFHrO6KvQiiXwU-TD_MNcUG6RIt8Q38kh-sT-d1J3yOHl-8i78VkJwuYSbpMZXN84V_MCGR_1JVge0SrJztyKhlEY-0zKqmid6a1p4pvsDpAWZaEN05Rm0soL5lsjYbtTYoO6NrQ' \
--header 'Content-Type: application/json' \
--data '{
    "portalId": 27,
    "integrationModelName": "goshopin Shopify Store",
    "code": "GOSHSHOP",
    "subText": "Fulfilled by Shopify Model",
    "channelProductCode": "inventory_item_id",
    "otherChannelDetails": "shopify_handle",
    "status": 1
}'

Step 1.1: Update the mandetory details to integration Models table

UPDATE integration_models
SET channelProductCode = 'inventory_item_id',
otherChannelDetails = 'shopify_handle',
STATUS = '1',
uniware_sync = '0'
WHERE id IN ( '549')

Step 2. Call Create App API using the following Request Body:

POST API:

Headers:

Authorization: Bearer "Token"

partnerCode: 431895

https://partners.myeshopbox.com/api/v1/app

Request Body:

{
    "title": "BrizeCooler Shopify Store",
    "description": "The all-in-one commerce platform to start, run, and grow a business",
    "logoUrl": "https://storage.googleapis.com/esb-integration-engine-staging.appspot.com/App%20logos/shopify-logo.svg",
    "intendedAudience": "private",
    "homepageUrl": "https://www.shopify.in",
    "appCategory": "ecommerce",
    "appType": "sales_channel_app",
    "status": "pending",
    "appUrl": "https://www.shopify.in",
    "whitelistedRedirectionUrls": [
        "https://google.com"
    ],
    "externalPortalId": "SHP",
    "integrationModelCode": "BZCLRSHOP"
}

Response:

{
    "id": 218,
    "appUrl": "https://www.shopify.in",
    "title": "BrizeCooler Shopify Store",
    "description": "The all-in-one commerce platform to start, run, and grow a business",
    "logoUrl": "https://storage.googleapis.com/esb-integration-engine-staging.appspot.com/App%20logos/shopify-logo.svg",
    "homepageUrl": "https://www.shopify.in",
    "appCategory": "ecommerce",
    "intendedAudience": "private",
    "status": "draft",
    "slug": "app218",
    "externalPortalId": "SHP",
    "integrationModelCode": "BZCLRSHOP",
    "credentials": {
        "clientId": "bbf81b47ed3651ec300696f17aa41d6d",
        "clientSecrets": [
            {
                "clientSecret": "a3cb19f29d37673d43250ca0ac85331a",
                "createDate": "2023-02-03T05:54:14.786Z"
            }
        ]
    },
    "whitelistedRedirectionUrls": [
        "https://google.com",
        "https://auth.myeshopbox.com/public/app-redirecturl/bbf81b47ed3651ec300696f17aa41d6d"
    ],
    "versions": {
        "latestVersion": "1.0.0",
        "allVersions": [
            "1.0.0"
        ]
    },
    "createdAt": "2023-02-03T05:54:14.786Z",
    "updatedAt": "2023-02-03T05:54:14.786Z",
    "partnerCode": "431895"
}

Step 3. Call Update Version API using the above `App ID` in the request body

PUT API:

https://partners.myeshopbox.com/api/v1/app/218/version/1.0.0

Request Body:

{
    "appId": 218,
    "version": "1.0.0",
    "authentication": {
        "test": {
            "headers": {
                "Authorization": "Bearer {{bundle.authData.access_token}}"
            },
            "method": "GET",
            "params": {
                "clientId": "{{process.env.CLIENT_ID}}",
                "accountSlug": "{{bundle.authData.account_slug}}"
            },
            "body": {},
            "removeMissingValuesFrom": {},
            "url": "https://partners.myeshopbox.com/api/v1/testAuth"
        },
        "fields": [],
        "oauth2Config": {
            "refreshAccessToken": {
                "body": {},
                "url": "",
                "removeMissingValuesFrom": {},
                "headers": {},
                "params": {},
                "method": ""
            },
            "authorizeUrl": {
                "method": "GET",
                "url": "https://{{bundle.inputData.store_name}}.myshopify.com/admin/oauth/authorize",
                "params": {
                    "state": "{{bundle.inputData.state}}",
                    "redirect_uri": "{{bundle.inputData.redirect_uri}}",
                    "response_type": "code",
                    "client_id": "{{process.env.CLIENT_ID}}"
                }
            },
            "redirectUrl": "https://auth.myeshopbox.com/app/connection/redirecturl/app218",
            "autoRefresh": true,
            "scope": "write_orders,write_fulfillments,write_assigned_fulfillment_orders,write_inventory,read_product_listings,write_products,write_assigned_fulfillment_orders,write_merchant_managed_fulfillment_orders,write_third_party_fulfillment_orders,read_locations,read_draft_orders,read_locations,write_shipping,read_gift_cards,write_gift_cards",
            "getAccessToken": {
                "body": {
                    "client_id": "{{process.env.CLIENT_ID}}",
                    "client_secret": "{{process.env.CLIENT_SECRET}}",
                    "code": "{{bundle.inputData.code}}"
                },
                "url": "https://{{bundle.inputData.store_name}}.myshopify.com/admin/oauth/access_token",
                "removeMissingValuesFrom": {},
                "headers": {
                    "content-type": "application/x-www-form-urlencoded",
                    "accept": "application/json"
                },
                "params": {},
                "method": "POST"
            }
        },
        "basicConfig": null,
        "type": "oauth2",
        "connectionLabel": "{{bundle.inputData.account_slug}}",
        "handleBar": "oauth2_218"
    },
    "isDeprecated": false
}

Response:

{
    "id": 215,
    "appId": 218,
    "version": "1.0.0",
    "authentication": {
        "test": {
            "headers": {
                "Authorization": "Bearer {{bundle.authData.access_token}}"
            },
            "method": "GET",
            "params": {
                "clientId": "{{process.env.CLIENT_ID}}",
                "accountSlug": "{{bundle.authData.account_slug}}"
            },
            "body": {},
            "removeMissingValuesFrom": {},
            "url": "https://partners.myeshopbox.com/api/v1/testAuth"
        },
        "fields": [],
        "oauth2Config": {
            "refreshAccessToken": {
                "body": {},
                "url": "",
                "removeMissingValuesFrom": {},
                "headers": {},
                "params": {},
                "method": ""
            },
            "authorizeUrl": {
                "method": "GET",
                "url": "https://{{bundle.inputData.store_name}}.myshopify.com/admin/oauth/authorize",
                "params": {
                    "state": "{{bundle.inputData.state}}",
                    "redirect_uri": "{{bundle.inputData.redirect_uri}}",
                    "response_type": "code",
                    "client_id": "{{process.env.CLIENT_ID}}"
                }
            },
            "redirectUrl": "https://auth.myeshopbox.com/app/connection/redirecturl/app218",
            "autoRefresh": true,
            "scope": "write_orders,write_fulfillments,write_assigned_fulfillment_orders,write_inventory,read_product_listings,write_products,write_assigned_fulfillment_orders,write_merchant_managed_fulfillment_orders,write_third_party_fulfillment_orders,read_locations,read_draft_orders,read_locations,write_shipping,read_gift_cards,write_gift_cards",
            "getAccessToken": {
                "body": {
                    "client_id": "{{process.env.CLIENT_ID}}",
                    "client_secret": "{{process.env.CLIENT_SECRET}}",
                    "code": "{{bundle.inputData.code}}"
                },
                "url": "https://{{bundle.inputData.store_name}}.myshopify.com/admin/oauth/access_token",
                "removeMissingValuesFrom": {},
                "headers": {
                    "content-type": "application/x-www-form-urlencoded",
                    "accept": "application/json"
                },
                "params": {},
                "method": "POST"
            }
        },
        "basicConfig": null,
        "type": "oauth2",
        "connectionLabel": "{{bundle.inputData.account_slug}}",
        "handleBar": "oauth2_218",
        "createdAt": "2023-02-03T06:12:29.059+0000",
        "updatedAt": "2023-02-03T06:12:29.059+0000"
    },
    "isDeprecated": false,
    "createdAt": "2023-02-03T11:24:10.000Z",
    "updatedAt": "2023-02-03T11:24:10.000Z"
}

Step 4. Call Create Field API

POST API:

https://building-blocks-dot-esb-platform-prod.appspot.com/_ah/api/esb/v1/oauth2_218/field

{
    "name": "Enter your Shopify store name",
    "handleBar": "store_name",
    "description": "Let us know your shopfy store url like your-store-url.myshopify.com even if you use a custom domain like your-store.com. Do not use https:// while ebntring the URL.",
    "placeHolderText": ".myshopify.com",
    "fieldType": "SHORT_TEXT",
    "hasMultipleValues": false,
    "isRequired": true,
    "isEditable": true,
    "unEditableActions": [
        "oauth2_178"
    ],
    "isHidden": true,
    "sortKey": 1,
    "validations": {
        "isUnique": true,
        "acceptSpecificPattern": true,
        "patternType": "CUSTOM_PATTERN",
        "format": "^(\\w+)",
        "hasCustomLength": true,
        "maxLength": "123",
        "minLength": "12"
    }
}

Response:

{
    "id": "63dca61d4f12cf559f538dd0",
    "isCore": false,
    "buildingBlock": "oauth2_218",
    "action": "oauth2_218",
    "name": "Enter your Shopify store name",
    "handleBar": "store_name",
    "description": "Let us know your shopfy store url like your-store-url.myshopify.com even if you use a custom domain like your-store.com. Do not use https:// while ebntring the URL.",
    "placeHolderText": ".myshopify.com",
    "fieldType": "SHORT_TEXT",
    "hasMultipleValues": false,
    "isRequired": true,
    "isEditable": true,
    "isHidden": true,
    "sortKey": 1,
    "validations": {
        "isUnique": true,
        "acceptSpecificPattern": true,
        "patternType": "CUSTOM_PATTERN",
        "format": "^(\\w+)",
        "hasCustomLength": true,
        "maxLength": "123",
        "minLength": "12"
    },
    "isVisible": true,
    "createdAt": "2023-02-03T06:13:49.312Z",
    "updatedAt": "2023-02-03T06:13:49.312Z"
}

Step 5. Now login to Shopify Partner Account and Create one `custom app` Click on Create App

Step 6. Click on `create app manually` and Provide app name

Step 7. Once the App is created, copy the `client_id` and `client_secret` and use them in Step 8.

Step 8. Call the following Create Environment API:

POST API:

https://partners.myeshopbox.com/api/v1/app/version/environment

Request Body:

{
    "appId": 218,
    "version": "1.0.0",
    "environmentVariables": [
        {
            "key": "CLIENT_ID",
            "value": "d3f7196f99e2d63579f2b8679e26511e"
        },
        {
            "key": "CLIENT_SECRET",
            "value": "227b484830806d34c8efa53a063550ca"
        }
    ]
}

Response:

{
    "environmentVariables": [
        {
            "id": "151",
            "value": "d3f7196f99e2d63579f2b8679e26511e",
            "key": "CLIENT_ID"
        },
        {
            "id": "152",
            "value": "227b484830806d34c8efa53a063550ca",
            "key": "CLIENT_SECRET"
        }
    ],
    "appId": "218",
    "version": "1.0.0"
}

Step 9. Now we need to setup the App created both on Shopify as well as in Eshopbox. Lets first setup the app on Shopify by clicking on `App Setup`

App URL	Value	Final Value to be inserted in App Setup

App URL	Value	Final Value to be inserted in App Setup
https://auth.eshopbox.com/appinstall/shopify/{{client_id_in_ie_app table}}	37d5b4d7b65b297f73de21a94e0f2b07	https://auth.eshopbox.com/appinstall/shopify/37d5b4d7b65b297f73de21a94e0f2b07
https://auth.myeshopbox.com/app/connection/redirecturlapp{{app_id}}	https://auth.myeshopbox.com/app/connection/redirecturl/app218	https://auth.myeshopbox.com/app/connection/redirecturl/app218

Now click on save and release and the settings will be saved automatically.

Step 10. Now go to `integration_engine_prod.ie_app_automation_steps` and filter for App id `53` This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 11. Now go to `integration_engine_prod.ie_app_setup_steps` and filter for App id 53 This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 12. Now go to `integration_engine_prod.ie_app_install_connection_clean_cache`and filter for App id 53 This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 13. Now go to `integration_engine_prod.ie_app_version` and Search for your newly created app_id and change the status from `draft` to `enable`

Before:

After:

Step 14. Once the setup is done, cut a new branch from here

Gitlab Link: Branches · Eshopbox Admin Team / Eshopbox Client Portal Frontend · GitLab
Search for file: app-id-config.model.ts
Now enter the App_id which you have just created in the list as shown below and deploy it on Production

steps for MR
1. feature to version - give MR to any frontend SDE2
2. After merge
3. version to master
4. feature to stable
5. feature to staging

Step 15. Now the same deployment needs to be done in the backend API also where we need to append `integration_model_code` using which we created the app, so cut a new branch and follow the steps:

Cut a branch from here: Branches · Eshopbox Admin Team / Esb-Integration-Engine · GitLab
Search for file: ChannelService.java
Append the integration model in the list where other shopify integration model code are present like shown below and deploy the code

Step 16. Once the setup is done in the Eshopbox backend, go to your Shopify custom app and click on `Distribution` and then click on `Choose single-merchant install link`

Step 17. Now provide the `Shopify Store Name` provided to you by the brand team.

Make sure the shopify store name look-like as shown below in the screenshot, because custom app settings cannot be changed later on and will have build new app all over again if anything goes wrong.

make sure that tick box must be empty otherwise shopify might give 500 error

Step 18. After entering the Shopify store name it will provide you `Installation Link` which you need to share to the Brand Team

Before:

After:

provide the link to mail reply

Apps and Automations

Shopify Custom App Creation

Step 1. Add a Integration Model Code in `eshopbox_wms_production.integration_models` table which will be required at the time of App Creation. Model code will look like as shown below

Or

Step 1.1: Update the mandetory details to integration Models table

Step 2. Call Create App API using the following Request Body:

Step 3. Call Update Version API using the above `App ID` in the request body

Step 4. Call Create Field API

Step 5. Now login to Shopify Partner Account and Create one `custom app` Click on Create App

Step 6. Click on `create app manually` and Provide app name

Step 7. Once the App is created, copy the `client_id` and `client_secret` and use them in Step 8.

Step 8. Call the following Create Environment API:

Step 9. Now we need to setup the App created both on Shopify as well as in Eshopbox. Lets first setup the app on Shopify by clicking on `App Setup`

Step 10. Now go to `integration_engine_prod.ie_app_automation_steps` and filter for App id `53` This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 11. Now go to `integration_engine_prod.ie_app_setup_steps` and filter for App id 53 This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 12. Now go to `integration_engine_prod.ie_app_install_connection_clean_cache`and filter for App id 53 This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 13. Now go to `integration_engine_prod.ie_app_version` and Search for your newly created app_id and change the status from `draft` to `enable`

Step 14. Once the setup is done, cut a new branch from here

Step 15. Now the same deployment needs to be done in the backend API also where we need to append `integration_model_code` using which we created the app, so cut a new branch and follow the steps:

Step 16. Once the setup is done in the Eshopbox backend, go to your Shopify custom app and click on `Distribution` and then click on `Choose single-merchant install link`

Step 17. Now provide the `Shopify Store Name` provided to you by the brand team.

Step 18. After entering the Shopify store name it will provide you `Installation Link` which you need to share to the Brand Team

Related content

Shopify Custom App Creation

Step 1. Add a Integration Model Code in eshopbox_wms_production.integration_models table which will be required at the time of App Creation. Model code will look like as shown below

Or

Step 1.1: Update the mandetory details to integration Models table

Step 2. Call Create App API using the following Request Body:

Step 3. Call Update Version API using the above App ID in the request body

Step 4. Call Create Field API

Step 5. Now login to Shopify Partner Account and Create one custom app Click on Create App

Step 6. Click on create app manually and Provide app name

Step 7. Once the App is created, copy the client_id and client_secret and use them in Step 8.

Step 8. Call the following Create Environment API:

Step 9. Now we need to setup the App created both on Shopify as well as in Eshopbox. Lets first setup the app on Shopify by clicking on App Setup

Step 10. Now go to integration_engine_prod.ie_app_automation_steps and filter for App id 53 This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 11. Now go to integration_engine_prod.ie_app_setup_steps and filter for App id 53 This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 12. Now go to integration_engine_prod.ie_app_install_connection_clean_cacheand filter for App id 53 This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 13. Now go to integration_engine_prod.ie_app_version and Search for your newly created app_id and change the status from draft to enable

Step 14. Once the setup is done, cut a new branch from here

Step 15. Now the same deployment needs to be done in the backend API also where we need to append integration_model_code using which we created the app, so cut a new branch and follow the steps:

Step 16. Once the setup is done in the Eshopbox backend, go to your Shopify custom app and click on Distribution and then click on Choose single-merchant install link

Step 17. Now provide the Shopify Store Name provided to you by the brand team.

Step 18. After entering the Shopify store name it will provide you Installation Link which you need to share to the Brand Team

Related content

Step 1. Add a Integration Model Code in `eshopbox_wms_production.integration_models` table which will be required at the time of App Creation. Model code will look like as shown below

Step 3. Call Update Version API using the above `App ID` in the request body

Step 5. Now login to Shopify Partner Account and Create one `custom app` Click on Create App

Step 6. Click on `create app manually` and Provide app name

Step 7. Once the App is created, copy the `client_id` and `client_secret` and use them in Step 8.

Step 9. Now we need to setup the App created both on Shopify as well as in Eshopbox. Lets first setup the app on Shopify by clicking on `App Setup`

Step 10. Now go to `integration_engine_prod.ie_app_automation_steps` and filter for App id `53` This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 11. Now go to `integration_engine_prod.ie_app_setup_steps` and filter for App id 53 This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 12. Now go to `integration_engine_prod.ie_app_install_connection_clean_cache`and filter for App id 53 This App Id can be used to replicate the steps in the mentioned table for a newly app created. Once replicated, it will look like below

Step 13. Now go to `integration_engine_prod.ie_app_version` and Search for your newly created app_id and change the status from `draft` to `enable`

Step 15. Now the same deployment needs to be done in the backend API also where we need to append `integration_model_code` using which we created the app, so cut a new branch and follow the steps:

Step 16. Once the setup is done in the Eshopbox backend, go to your Shopify custom app and click on `Distribution` and then click on `Choose single-merchant install link`

Step 17. Now provide the `Shopify Store Name` provided to you by the brand team.

Step 18. After entering the Shopify store name it will provide you `Installation Link` which you need to share to the Brand Team