Registering an App

Sample File Format for Registering App in Single Upload

{
“createAppRequest”: {
“businessType”: “B2C”,
“appName”: “SampleProductUpdateApp”,
“appShortDescription”: “This is a sample product app to demonstrate the asynchronous webhooks in Equinox appmarketplace.”,
“appSummary”: “This is a sample product app to demonstrate the asynchronous webhooks in Equinox appmarketplace. New product creation in Equinox catalog service will be notified to the app.The app will do a callback to Equinox catalog service on receiving the product creation webhook. “,
“appCategory”: “Catalog”,
“pricingType”: “FREE”,
“appDisplayType”: “DESKTOP”,
“visibilityType”: “PUBLIC”,
“developerOrg”: “EquinoxAppTeam”,
“appVersion”: “1.1.0”,
“appGoal”: “”,
“tags”: [
“catalog”
],
“appSupport”: {
“email”: “equinoxgmctest@gmail.com”,
“phoneNumber”: “”
},
“appImages”: [
{
“type”: “Image”,
“url”: “https://intsmbadmin-simba.skavacommerce.com/smbadmin/static/images/noImage.jpg”,
“remarks”: “AppImage”
}
],
“properties”: [
{
“locale”: “en_us”,
“name”: “string”,
“value”: “string”
}
]
},
“appConfigurationRequest”: {
“createAppConfig”: {
“apiConfig”: [
{
“action”: “baseUrl”,
“apiUrl”: “https://tys4yolnkb.execute-api.us-east-1.amazonaws.com/target”
}
],
“appScopes”: {
“roles”: [
“ROLE_CATALOG_ADMIN”
],
“services”: [
“Catalog”
]
},
“properties”: [
{
“name”: “string”,
“value”: “string”
}
],
“webhooksConfig”: [
{
“entity”: “catalog”,
“url”: “https://tys4yolnkb.execute-api.us-east-1.amazonaws.com/target”,
“webhookType”: “ASYNC”,
“events”: [
“catalogservice/product/create”
]
},
{
“entity”: “appmarketplace”,
“url”: “https://tys4yolnkb.execute-api.us-east-1.amazonaws.com/target”,
“webhookType”: “ASYNC”,
“events”: [
“appmarketplaceservices/apps/updateinstallation”
]
}
]
},
“createAppDescription”: {
“appDescriptionList”: {
“en”: {
“ataGlance”: “This is a sample product app to demonstrate the asynchronous webhooks in Equinox appmarketplace.”,
“readMoreDescription”: {
“section1”: “App has registered for product create webhook of catalog service”,
“section2”: “New product creation in Equinox catalog service will be notified to the app”,
“section3”: “The app will do a callback to Equinox catalog service on receiving the product creation webhook.”,
“section4”: “string”
},
“characteristics”: {
“category”: “Catalog”,
“goal”: “The goal of the app is to update the product”,
“helpCenterUrl”: “string”,
“developedBy”: “EquinoxAppTeam”,
“displayArea”: “string”,
“activity”: “B2C”
}
}
}
},
“appActivationInputData”: {
“uiSchema”: {
“title”: “Catalog app Configurations”,
“elements”: [
{
“uiElement”: “checkbox”,
“label”: “Enable new attribute creation”,
“required”: “true”,
“default”: “false”,
“key”: “isNewAttributeRequired”
}
]
}
}
}
}