APIs to be used in Servitium app
- Anushi Dhaketa
- Susmit Rao (Unlicensed)
Call the below API for input fields
Url: https://{{accountSlug}}.auperator.co/api/v1/appinstall/304/fields
API : GET
Authorization: Bearer token
Sample Response:
{
"appId": 29,
"installationId": 304,
"fields": [
{
"isRequired": true,
"unEditableActions": [
"oauth2_29"
],
"buildingBlock": "oauth2_29",
"isCore": false,
"description": "Enter your merchant ID",
"placeHolderText": "eg. A2L90Y32FJK5L6",
"isHidden": true,
"createdAt": "2021-03-30T08:40:06.397Z",
"sortKey": 2.0,
"isEditable": false,
"name": "merchantId",
"action": "oauth2_29",
"handleBar": "merchantId",
"id": "6062e3e6e5201d100b6cd134",
"validations": {
"minLength": "12",
"isUnique": true,
"acceptSpecificPattern": true,
"format": "^(\\w+)",
"hasCustomLength": true,
"patternType": "CUSTOM_PATTERN",
"maxLength": "123"
},
"fieldType": "SHORT_TEXT",
"hasMultipleValues": false,
"updatedAt": "2021-05-11T07:58:47.213Z"
},
{
"isRequired": true,
"unEditableActions": [
"oauth2_29"
],
"buildingBlock": "oauth2_29",
"isCore": false,
"description": "Enter your secret key",
"placeHolderText": "eg. arn:aws:kms:eu-west-1:859001003592:alias/A2L90Y54FJK6W9",
"isHidden": false,
"createdAt": "2021-04-30T13:26:42.992Z",
"sortKey": 3.0,
"isEditable": false,
"name": "kmsKey",
"action": "oauth2_29",
"handleBar": "kmsKey",
"id": "608c05929a31d0297af6b437",
"validations": {
"minLength": "10",
"isUnique": true,
"acceptSpecificPattern": true,
"format": "^(\\w+)",
"hasCustomLength": true,
"patternType": "CUSTOM_PATTERN",
"maxLength": "100"
},
"fieldType": "SHORT_TEXT",
"hasMultipleValues": false,
"updatedAt": "2021-05-11T08:00:42.209Z"
}
],
"version": "1.0.0"
}Populate the description, placeholder on Front end from the response of the above API.
2. Call the below API on the connect button on first step.
url : https://{{accountSlug}}.auperator.co/api/v1/connection/start
API: POST
Authorization: Bearer token
requestBody:
{
"appId": 513,
"installationId": 563,
"authFields": {
"userid": "",
"tokenid": ""
},
"connectionName": "Servitium",
"isSellerOfRecord": "0"
}
3. Call the below API on the click of save button of 2nd and 3rd step.
url: https://{{accountSlug}}.auperator.co/api/v1/appinstall/config/toggle
API: PUT
Authorization: Bearer token
Sample request:
{
"data": [
{
"id": 1619,
"appAutomationStepId": 117,
"appId": 513,
"connectionId": 556,
"isActive": "1",
"appInstallationId": 300,
"stepTitle": "Configure Servitium CRM request",
"stepDescription": "Configure Servitium CRM request",
"otherDetails": {"daysToCallServitiumAPI": "7","filter": {"AND": [{"AND": [{"property":"salesChannel", "operator": "is","value": ["CH5865"]},{"property":"sku", "operator": "is","value": ["demoP1"]}]}]}}
"isRequired": "0",
"createdAt": "2022-12-14 15:50:30.0",
"updatedAt": "2022-12-14 15:50:30.0"
},
{
"id": 1619,
"appAutomationStepId": 118,
"appId": 513,
"connectionId": 556,
"isActive": "1",
"appInstallationId": 300,
"stepTitle": "Map additional detail",
"stepDescription": "Map additional detail",
,
"otherDetails": {"brandCode": {"customField": "Productsku_2495","defaultValue": "test"},"productCategoryCode": {"customField": "Productsku_2495","defaultValue": "test"},"productCode": {"customField": "Productsku_2495","defaultValue": "test"}}
"isRequired": "0",
"createdAt": "2022-12-14 15:50:30.0",
"updatedAt": "2022-12-14 15:50:30.0"
}
]
}
4. For the 2nd step, to populate the dropdown, we need to call the below API
staging URL: https://{{accountSlug}}.auperator.co/product-engine/api/v1/key
Prod URL: https://{{accountSlug}}.myeshopbox.com/product-engine/api/v1/key
API: GET
Authorization: Bearer token
We need to show the displayKey in the dropdown.
In the middle dropdown on condition, we need to show the conditions for the particular displayKey. We can map the items in the list by their key.
Filter Out the following fields from the response:
weight
weightUnit
dimensionUnit
dimensionLength
dimensionWidth
dimensionHeight
createdAt
updatedAt
sample response:
{
"items": [
{
"displayKey": "Name of the Product(sku)",
"condition": [
"is",
"is not"
],
"fieldType": "String",
"key": "sku"
},
{
"displayKey": "ESIN",
"condition": [
"is",
"is not"
],
"fieldType": "String",
"key": "esin"
}
]
}
We might not be getting salesChannel as a key in this API’s response. So we need to add another value in dropdown for salesChannel.
The condition for salesChannel field will be ‘is', 'isNot'.
The API for salesChannel dropdown is:
URL: https://{{accountSlug}}.auperator.co/api/v1/channel?page=1&perPage=1000
API: GET
Authorization: Bearer token
We have to show the channelLabel in salesChannel dropdown.
Sample Response:
{
"total": 7,
"perPage": 1000,
"data": [
{
"accountName": "Monte Carlo Fashion Ltd.",
"externalChannelId": "CH5784",
"channelStatus": "0",
"integrationModelName": "custom_test09Feb",
"createdAt": "2018-08-01T12:45:11.000Z",
"integrationType": "6",
"portalName": "Amazon",
"fulfillmentChannels": [
{
"channelSubscriptionId": "2256",
"warehouseId": "653",
"enrollmentStatus": "INACTIVE",
"fulfillmentChannelId": "1847",
"opsVerificationStatus": "0",
"externalWmsChannelName": "JIOMART_TEST_TEST_AJEET_653_1847",
"warehouseName": "STAGE(TEST)",
"status": "0"
}
],
"brandRegistrationStatus": "1",
"portalId": 2,
"markUnavailableTemplateUrl": null,
"accountSlug": "montecarlo",
"channelSlug": "testYashika",
"integrationModelId": 236,
"id": 5784,
"channelProductCode": null,
"channelAccountId": null,
"updatedAt": "2023-02-01T00:11:43.000Z",
"markAvailableTemplateUrl": null,
"warehouseCheck": true,
"channelLabel": null,
"channelAccountName": null,
"uniwareSync": "0",
"additionalDetails": {},
"enrollmentStatus": "ACTIVE"
},
{
"accountName": "test_test_ajeet",
"externalChannelId": "CH5838",
"channelStatus": "2",
"integrationModelName": "Shopify Test Store",
"createdAt": "2022-10-28T15:28:40.000Z",
"integrationType": "11",
"portalName": "Shopify",
"fulfillmentChannels": [
{
"channelSubscriptionId": "2202",
"warehouseId": "18",
"enrollmentStatus": "INACTIVE",
"fulfillmentChannelId": "1790",
"opsVerificationStatus": "0",
"externalWmsChannelName": "TEST-AJEET_SHOPIFY_TEST_TEST_AJEET_18_1790",
"warehouseName": "GGNA",
"status": "0"
}
],
"brandRegistrationStatus": "1",
"portalId": 37,
"markUnavailableTemplateUrl": "https://storage.googleapis.com/eshopbox-client-portal-prod.appspot.com/Product%20availability%20template/Make%20products%20unavailable.csv",
"accountSlug": "test_test_ajeet",
"channelSlug": "test_test_ajeet46",
"integrationModelId": 35,
"id": 5838,
"channelProductCode": "shopify_2462,shopify_handle_2462",
"channelAccountId": 0,
"updatedAt": "2022-12-22T14:36:08.000Z",
"markAvailableTemplateUrl": null,
"warehouseCheck": false,
"channelLabel": "test-ajeet Shopify",
"channelAccountName": "test-ajeet Shopify",
"uniwareSync": "0",
"additionalDetails": {},
"enrollmentStatus": "IN PROCESS"
}
],
"page": 1
}
5. To populate the dropdown in the 3rd step we will use the below API:
URL: https://{{accountSlug}}.auperator.co/platform/api/v1/property?page=1&perPage=1000
API: GET
Headers: Authorization token
We need to show the internalName in the dropdown. Filter out the internalName on the basis of Scope. Show the internalNames with scope = 'Product'.
Sample response:
{
"data": [
{
"accountSlug": "clarks",
"label": "Ajio Unicommerce SKU code on Unicommerce",
"internalName": "SKU_code_on_Unicommerce_954",
"isUnique": "Yes",
"fieldType": "Short_Text",
"scope": [
"Product"
],
"createdAt": "2022-04-25T08:14:55.079Z",
"updatedAt": "2022-04-25T08:14:55.079Z"
},
{
"accountSlug": "clarks",
"label": "Ajio Unicommerce SKU code on Unicommerce",
"internalName": "SKU_code_on_Unicommerce_978",
"isUnique": "Yes",
"fieldType": "Short_Text",
"scope": [
"Product"
],
"createdAt": "2022-05-05T07:15:16.912Z",
"updatedAt": "2022-05-05T07:15:16.912Z"
}
],
"page": 1,
"perPage": 1000,
"total": "2"
}
API doc: App Integration API
installing servitium link: https://auth.auperator.co/public/app-url/14839c69e83b52c487dc2284cba93ac5
Hit the above url directly on browser to install the app. Make sure you have opened the workspace you want to install the app in the adjacent tab.