Shopify

1. APP MODULE (UI prompt)

Module Entities (6)

Entity	Alias	Module	Global Schema
(1) App	*App*	AppModule	Shopify
(2) AppCategory	*AppCategory*	AppModule	Shopify
(3) AppCategoryAssignment	*AppCategoryAssignment*	AppModule	Shopify
(4) Company	*Company*	CompanyModule	Shopify
(5) Merchant	*Merchant*	AppModule	Shopify
(6) MerchantAppInstallation	*MerchantAppInstallation*	AppModule	Shopify

Module Interfaces (31)

Remote Method	Local Method	Module	HTTP-Method	References
(1) /merchantappinstallation/{id}	*updateMerchantAppInstallationById(merchantappinstallation)*	AppModule	*PUT*	MerchantAppInstallation
(2) /merchant/{id}	*updateMerchantById(merchant)*	AppModule	*PUT*	Merchant
(3) /merchantappinstallation	*findAllMerchantAppInstallation()*	AppModule	*GET*	MerchantAppInstallation
(4) /merchantappinstallation/{id}	*findMerchantAppInstallationById(id)*	AppModule	*GET*	MerchantAppInstallation
(5) /appcategoryassignment	*insertAppCategoryAssignment(appcategoryassignment)*	AppModule	*POST*	AppCategoryAssignment
(6) /merchantappinstallation/merchant/{id}	*findAllMerchantAppInstallationOfMerchant(id)*	AppModule	*GET*	Merchant MerchantAppInstallation
(7) /merchant/company/{id}	*findAllMerchantOfCompany(id)*	AppModule	*GET*	Company Merchant
(8) /appcategory/{id}	*findAppCategoryById(id)*	AppModule	*GET*	AppCategory
(9) /app/developercompany/{id}	*findAllAppOfDeveloperCompany(id)*	AppModule	*GET*	Company App
(10) /appcategoryassignment/{id}	*updateAppCategoryAssignmentById(appcategoryassignment)*	AppModule	*PUT*	AppCategoryAssignment
(11) /merchantappinstallation	*insertMerchantAppInstallation(merchantappinstallation)*	AppModule	*POST*	MerchantAppInstallation
(12) /appcategoryassignment/{id}	*findAppCategoryAssignmentById(id)*	AppModule	*GET*	AppCategoryAssignment
(13) /appcategoryassignment/appcategory/{id}	*findAllAppCategoryAssignmentOfAppCategory(id)*	AppModule	*GET*	AppCategory AppCategoryAssignment
(14) /appcategoryassignment/app/{id}	*findAllAppCategoryAssignmentOfApp(id)*	AppModule	*GET*	App AppCategoryAssignment
(15) /app/{id}	*updateAppById(app)*	AppModule	*PUT*	App
(16) /app	*insertApp(app)*	AppModule	*POST*	App
(17) /merchant	*insertMerchant(merchant)*	AppModule	*POST*	Merchant
(18) /appcategory/{id}	*deleteAppCategoryById(id)*	AppModule	*DELETE*	AppCategory
(19) /appcategory/{id}	*updateAppCategoryById(appcategory)*	AppModule	*PUT*	AppCategory
(20) /app/{id}	*deleteAppById(id)*	AppModule	*DELETE*	App
(21) /merchantappinstallation/app/{id}	*findAllMerchantAppInstallationOfApp(id)*	AppModule	*GET*	App MerchantAppInstallation
(22) /app/{id}	*findAppById(id)*	AppModule	*GET*	App
(23) /merchant/{id}	*deleteMerchantById(id)*	AppModule	*DELETE*	Merchant
(24) /app	*findAllApp()*	AppModule	*GET*	App
(25) /appcategory	*findAllAppCategory()*	AppModule	*GET*	AppCategory
(26) /appcategoryassignment/{id}	*deleteAppCategoryAssignmentById(id)*	AppModule	*DELETE*	AppCategoryAssignment
(27) /merchantappinstallation/{id}	*deleteMerchantAppInstallationById(id)*	AppModule	*DELETE*	MerchantAppInstallation
(28) /appcategoryassignment	*findAllAppCategoryAssignment()*	AppModule	*GET*	AppCategoryAssignment
(29) /appcategory	*insertAppCategory(appcategory)*	AppModule	*POST*	AppCategory
(30) /merchant	*findAllMerchant()*	AppModule	*GET*	Merchant
(31) /merchant/{id}	*findMerchantById(id)*	AppModule	*GET*	Merchant

1.1 APP

App

AppModule

Shopify

Properties (6)

Property	Type	Entity	Reference	Module
*(1) AppStoreListingUrl*	*STRING*	App
*(2) Description*	*STRING*	App
*(3) DeveloperCompany*	*LONG*	App	Company	CompanyModule
*(4) InitialReleaseDate*	*DATE*	App
*(5) IsShopifyOwned*	*BOOL*	App
*(6) Name*	*STRING*	App

Example:

final App app = (App) invokeModule(APP_MODULE + "/app/" + id, App.class);
if (app != null) {
    final Company developercompany1 = (Company) invokeModule(COMPANY_MODULE + "/company/" + app.getDeveloperCompany().getId(), Company.class);
    if (developercompany1 != null) {
    }
}
return app;

1.2 APP CATEGORY

AppCategory

AppModule

Shopify

Properties (2)

Property	Type	Entity	Reference	Module
*(1) Description*	*STRING*	AppCategory
*(2) Name*	*STRING*	AppCategory

Example:

final AppCategory appcategory = (AppCategory) invokeModule(APP_MODULE + "/appcategory/" + id, AppCategory.class);
if (appcategory != null) {
}
return appcategory;

1.3 APP CATEGORY ASSIGNMENT

AppCategoryAssignment

AppModule

Shopify

Properties (2)

Property	Type	Entity	Reference	Module
*(1) App*	*LONG*	AppCategoryAssignment	App	AppModule
*(2) AppCategory*	*LONG*	AppCategoryAssignment	AppCategory	AppModule

Example:

final AppCategoryAssignment appcategoryassignment = (AppCategoryAssignment) invokeModule(APP_MODULE + "/appcategoryassignment/" + id, AppCategoryAssignment.class);
if (appcategoryassignment != null) {
    final App app1 = (App) invokeModule(APP_MODULE + "/app/" + appcategoryassignment.getApp().getId(), App.class);
    if (app1 != null) {
        final Company developercompany2 = (Company) invokeModule(COMPANY_MODULE + "/company/" + app1.getDeveloperCompany().getId(), Company.class);
        if (developercompany2 != null) {
        }
    }
    final AppCategory appcategory3 = (AppCategory) invokeModule(APP_MODULE + "/appcategory/" + appcategoryassignment.getAppCategory().getId(), AppCategory.class);
    if (appcategory3 != null) {
    }
}
return appcategoryassignment;

1.4 MERCHANT

Merchant

AppModule

Shopify

Properties (7)

Property	Type	Entity	Reference	Module
*(1) Company*	*LONG*	Merchant	Company	CompanyModule
*(2) Country*	*STRING*	Merchant
*(3) Industry*	*STRING*	Merchant
*(4) IsActive*	*BOOL*	Merchant
*(5) IsShopifyPlus*	*BOOL*	Merchant
*(6) MerchantSize*	*STRING*	Merchant
*(7) OnboardingDate*	*DATE*	Merchant

Example:

final Merchant merchant = (Merchant) invokeModule(APP_MODULE + "/merchant/" + id, Merchant.class);
if (merchant != null) {
    final Company company1 = (Company) invokeModule(COMPANY_MODULE + "/company/" + merchant.getCompany().getId(), Company.class);
    if (company1 != null) {
    }
}
return merchant;

1.5 MERCHANT APP INSTALLATION

MerchantAppInstallation

AppModule

Shopify

Properties (5)

Property	Type	Entity	Reference	Module
*(1) App*	*LONG*	MerchantAppInstallation	App	AppModule
*(2) InstallDate*	*DATE*	MerchantAppInstallation
*(3) Merchant*	*LONG*	MerchantAppInstallation	Merchant	AppModule
*(4) MonthlyRevenueShareUsd*	*STRING*	MerchantAppInstallation
*(5) UninstallDate*	*DATE*	MerchantAppInstallation

Example:

final MerchantAppInstallation merchantappinstallation = (MerchantAppInstallation) invokeModule(APP_MODULE + "/merchantappinstallation/" + id, MerchantAppInstallation.class);
if (merchantappinstallation != null) {
    final App app1 = (App) invokeModule(APP_MODULE + "/app/" + merchantappinstallation.getApp().getId(), App.class);
    if (app1 != null) {
        final Company developercompany2 = (Company) invokeModule(COMPANY_MODULE + "/company/" + app1.getDeveloperCompany().getId(), Company.class);
        if (developercompany2 != null) {
        }
    }
    final Merchant merchant3 = (Merchant) invokeModule(APP_MODULE + "/merchant/" + merchantappinstallation.getMerchant().getId(), Merchant.class);
    if (merchant3 != null) {
        final Company company4 = (Company) invokeModule(COMPANY_MODULE + "/company/" + merchant3.getCompany().getId(), Company.class);
        if (company4 != null) {
        }
    }
}
return merchantappinstallation;