Event Details for Services

Accounts

HTTP MethodCall Detail Event Type Response Payload
POST Create Account accountservice/account/create {"comments":"active","createdBy":9856,"dunsNumber":"skava123","name":"Account 1","parentAccountId":1,"phoneNumber":"+919876543210","properties":[{"attributeId":"attribute1","value":"value"}],"referenceAttribute":"string","referenceAttribute1":"string","referenceAttribute2":1,"size":"<500","status":"active","taxNumber":"skava123","typeId":1,"updatedBy":9856}
PUT Update Account accountservice/account/update PATCH in swagger not PUT
POST Create Account Buyer accountservice/accountbuyer/create {"teamId":1,"userId":"user_100"}
POST Create Account Seller accountservice/accountseller/create {"accountId":1,"createdBy":9856,"updatedBy":9856,"userId":"user_seller_1"}
POST Create Account Type accountservice/accounttype/create {"description":"Entertainment","name":"Entertainment/Construction"}
POST Create Address accountservice/address/create {"city":"CBE","country":"IN","county":"CBE","createdBy":9856,"default":true,"email":"abc@skava.com","name":"john","phone":"98765 43210","properties":{"deliveryInstruction":"Call me from gate."},"state":"TN","street1":"tidelPark","street2":"hopes","street3":"peelamedu","type":"(BillingAddreess / ShippingAddress)","updatedBy":9856,"validated":false,"zipCode":"624, 641014"}
POST Create Attribute accountservice/attribute/create {"defaultValue":"string","fieldtype":"BOOLEAN","identifier":"string","name":"string","required":true,"sequence":0,"status":"ACTIVE","type":"ACCOUNTS","validation":"string"}
POST Create Contract accountservice/contract/create {"catalogId":1,"createdBy":9856,"creditLimit":1000000,"documents":[{"content":"string","createdBy":9856,"name":"document1","type":".pdf, .img","updatedBy":9856,"url":"https://www.skava.com"}],"endTime":1546524199000,"merchNavigationId":1,"name":"contractName","paymentMethod":"credit card","paymentTermId":1,"priceListId":1,"priceRuleId":1,"pricingMethod":"string","properties":[{"attributeId":"string","value":"value"}],"startTime":1346524199000,"updatedBy":9856}
POST Create Cost Centre accountservice/costcentre/create {"budgets":[{"createdBy":9856,"endDate":1546524199000,"startDate":1346524199000,"totalBudget":1000000,"updatedBy":9856,"usedBudget":1000000}],"createdBy":9856,"name":"costCentre","status":"active","updatedBy":9856}
POST Create Payment accountservice/payment/create {"createdBy":9856,"paymentId":101,"paymentItemId":1001,"paymentMethod":"creditcard","updatedBy":9856}
POST Create Payment Term accountservice/paymentterm/create {"createdBy":9856,"name":"Net30","term":30,"updatedBy":9856}
POST Create Team accountservice/team/create {"costCentreId":1,"createdBy":9856,"description":"platform team","name":"platform","status":"active","teamBuyer":[{"teamId":1,"userId":"user_100"}],"updatedBy":9856}
DELETE Delete Account Buyer accountservice/accountbuyer/delete No payload
DELETE Delete Account Properties accountservice/accountproperties/delete No payload
DELETE Delete Account Seller accountservice/accountseller/delete No payload
DELETE Delete Account accountservice/account/delete No payload
DELETE Delete Account Type accountservice/accounttype/delete No payload
DELETE Delete Address accountservice/address/delete No payload
DELETE Delete Attribute accountservice/attribute/delete No payload
DELETE Delete Budget accountservice/budget/delete No payload
DELETE Delete Contract Properties accountservice/contractproperties/delete No payload
DELETE Delete Contract accountservice/contract/delete No payload
DELETE Delete Cost Centre accountservice/costcentre/delete No payload
DELETE Delete Document accountservice/document/delete No payload
DELETE Delete Payment accountservice/payment/delete No payload
DELETE Delete Payment Term accountservice/paymentterm/delete No payload
DELETE Delete Team accountservice/team/delete No payload
PATCH Patch Update Account Type accountservice/accounttype/patch {"description":"Entertainment","name":"Entertainment/Construction"}
PATCH Patch Update Attributes accountservice/attributes/patch {"defaultValue":"string","fieldtype":"BOOLEAN","identifier":"string","name":"string","required":true,"sequence":0,"status":"ACTIVE","type":"ACCOUNTS","validation":"string"}
PUT Update Account Properties accountservice/accountproperties/update [{"attributeId":"accountProperty","value":"value"}]
PUT Update Contract Properties accountservice/contractproperties/update [{"attributeId":"string","value":"value"}]
PUT Update Properties accountservice/properties/update [{"attributeId":"accountProperty","value":"value"}]
PATCH Update Account Buyer accountservice/accountbuyer/patch {"teamId":1,"userId":"user_100"}
PATCH Update Account Seller accountservice/accountbuyer/patch {"accountId":1,"createdBy":9856,"updatedBy":9856,"userId":"user_seller_1"}
PATCH Update Address accountservice/address/patch {"city":"CBE","country":"IN","county":"CBE","createdBy":9856,"default":true,"email":"abc@skava.com","name":"john","phone":"98765 43210","properties":{"deliveryInstruction":"Call me from gate."},"state":"TN","street1":"tidelPark","street2":"hopes","street3":"peelamedu","type":"(BillingAddreess / ShippingAddress)","updatedBy":9856,"validated":false,"zipCode":"624, 641014"}
PATCH Update Contract accountservice/contract/patch {"catalogId":1,"createdBy":9856,"creditLimit":1000000,"documents":[{"content":"string","createdBy":9856,"name":"document1","type":".pdf, .img","updatedBy":9856,"url":"https://www.skava.com"}],"endTime":1546524199000,"merchNavigationId":1,"name":"contractName","paymentMethod":"credit card","paymentTermId":1,"priceListId":1,"priceRuleId":1,"pricingMethod":"string","properties":[{"attributeId":"string","value":"value"}],"startTime":1346524199000,"updatedBy":9856}
PATCH Update Cost Centre accountservice/costcentre/patch {"budgets":[{"createdBy":9856,"endDate":1546524199000,"startDate":1346524199000,"totalBudget":1000000,"updatedBy":9856,"usedBudget":1000000}],"createdBy":9856,"name":"costCentre","status":"active","updatedBy":9856}
PATCH Update Payment accountservice/payment/patch 
PATCH Update Payment Term accountservice/paymentterm/patch 
PATCH Update Properties accountservice/properties/patch 
PATCH Update Team accountservice/team/patch 

Address

HTTP MethodCall detailEvent TypeResponse Payload
POSTAddress Validationaddressservice/address/create{"id":1,"addressLine1":"MARY ROE","addressLine2":"MEGASYSTEMS INC","addressLine3":"799 E DRAGRAM SUITE 5A","canReceiveSMS":false,"city":"Boulder","companyName":"Figo","country":"Angola","county":"Boulder","email":"","lastName":"Velazquez","middleName":"Valentine Rodriquez","mobileNumber":"414-463-6677","phone":"414-463-6677","requestType":"","state":"Indiana","zip":"76674-8244"}
DELETEDelete Address Validationaddressservice/address/deleteNo payload

Admin Orchestrataion

HTTP MethodCall DetailEvent Type Response Payload
POST Create Secret Key adminorchestration/rest/CreateSecret 
DELETE Delete all API Gateway Keys for a Business adminorchestration/rest/DeleteAllAPIGatewayKeys 
DELETE Delete API Gateway Key adminorchestration/rest/DeleteAPIGatewayKey 
POST Run Publish Feed adminorchestration/foundationFedRunReindexer 
POST Create Store Service adminorchestration/createStore {"businessId":2153,"name":"store4982r65o72E4v","status":1,"type":2,"timeZone":"UTC","previewUrl":"https://www.skava.com","launchUrl":"https://www.skava.com","logoUrl":"https://www.skava.com/logo.png","defaultLocale":"en_US","defaultShippingRegion":"US","defaultCurrency":"USD","properties":[],"associations":[],"locales":["en_CA"],"currencies":["INR"],"shippings":["US"]}
PUT Update Store Service adminorchestration/updateStore {"businessId":2153,"name":"store339521I4gF1","status":1,"type":2,"timeZone":"UTC","previewUrl":"https://www.test.com","launchUrl":"https://www.skava.com","logoUrl":"https://www.skava.com/logo.png","defaultLocale":"en_US","defaultShippingRegion":"US","defaultCurrency":"USD","properties":[{"name":"Budget","value":"1000$","description":"Store Budget","custom":true}],"associations":[{"name":"loyalty","collectionId":1,"properties":[{"name":"catalogId","value":"ASX5789"}]}],"locales":["en_CA"],"currencies":["USD"],"shippings":["US"]}
POST Run Reindexer Feed adminorchestration/feedRunReindexer 
POST Add Multiple Promocodes in a Cart adminorchestration/csr/AddPromocodesToBagRoute 
DELETE Delete a Promocode from Cart adminorchestration/delete/PromocodeFromBag 
POST Create an Order from a Cart adminorchestration/create/OrderForCart 
PUT Edit Order by Order IDadminorchestration/route/EditOrderById 
PATCH Update Order Details adminorchestration/route/UpdateOrderById 
PATCH Link the Guest Order to the Register User adminorchestration/route/LinkGuestOrder 
POST Create User Payment adminorchestration/route/CreatePaymentsForUser 
DELETE Delete Payment by IDadminorchestration/route/DeletePaymentForUser 
POST Reset Password of a User adminorchestration/route/ResetPassword { "email" : "brendan.carson@gmail.us"}
PATCH Update Subscription Preferences adminorchestration/customersubscriptionPreferencePatchRest
PATCH Get a Business User Property adminorchestration/patch/UserPropertyByName {"firstName": "Yes"}
PATCH Update a Rewards Bank adminorchestration/loyalty/RewardUpdate { "status":"INACTIVE", "type":"FhLsvDp", "symbol":"%"}
POST User Registration adminorchestration/auth/RegisterUser {"firstName":"","lastName":"","phoneNumber":"","customProperties":{"additionalProp1":"","additionalProp2":"","additionalProp3":""},"languagePreference":"","newPassword":<Password>,"confirmNewPassword":<Password> }
PATCH Update Profile - My Account adminorchestration/authUserProfileUpdate 
POST Generate Activation Param for a User adminorchestration/auth/SendActivationParam {"email": "lesley.morgan@hotmail.us"}
POST Create Pricelist and Map Pricefacets adminorchestration/create/PriceListAndFacetMap 
PUT Update Pricelist and Map Pricefacets adminorchestration/update/PriceListAndFacetMap 
POST Publish Price Rules adminorchestration/refresh/PriceRules 
PATCH Partial Update Subscription adminorchestration/update/Subscription 
POST Subscription Address Validation adminorchestration/subscriptionAddressValidate/Route 
POST Create Rule Set adminorchestration/create/LoyaltyRuleSet 

Authorization

HTTP MethodCall detail Event Type Response Payload
POST Add Roles To Auth Groupauthservice/authgroup/addroles [{"userId":436,"roles":[{"businessId":1,"collection":1468,"roleName":"183eecba-787c-47ea-8e41-7f59cc57be4b","category":"STANDARD","roleAttribute":"BoPhcL"},{"businessId":1,"collection":1468,"roleName":"183eecba-787c-47ea-8e41-7f59cc57be4b","category":"CUSTOM","roleAttribute":"BoPhcL"}]}]
POST Add Users To Auth Groupauthservice/authgroup/addusers Need valid identifiers
POST Create Auth Groupauthservice/authgroup/create {"collectionId":1,"description":"lH63K5d0","id":0,"name":"Kuwait895ccb27-0c6f-4345-be78-f7306063dfb5"}
DELETE Delete Auth Groupauthservice/authgroup/delete No payload
DELETE Remove Roles From Auth Groupauthservice/authgroup/removeroles No payload
DELETE Remove Users From Auth Groupauthservice/authgroup/removeusers No payload
PUT Update Auth Groupauthservice/authgroup/update {"collectionId":1,"description":"lH63K5d0","id":0,"name":"Kuwait895ccb27-0c6f-4345-be78-f7306063dfb5"}
POST Create Dynamic Privilege authservice/dynamicprivilege/create {"level":2,"privilegeSetId":10085,"service":"PIM"}
DELETE Delete Dynamic Privilege authservice/dynamicprivilege/delete No payload
PUT Update Dynamic Privilegeauthservice/dynamicprivilege/update {"level":2,"privilegeSetId":10085,"service":"PIM"}
POST Create Group Attribute authservice/groupattribute/create {"attribueValue":"test","authGroupId":"2069","privilegeId":"10440"}
DELETE Delete Group Attributeauthservice/groupattribute/delete No payload
PUT Update Group Attributeauthservice/groupattribute/update {"attribueValue":"test","authGroupId":"2069","privilegeId":"10440"}
POST Create OAuth Clientauthservice/oauthclient/create {"applicationType":"web","clientName":"788b7461-bedb-49fc-9ddf-3adfc01cbce34/1/2013 04:46:24 AM","contactEmail":"darius.clark@hotmail.net","logoUri":"https://www.skava.com","redirectUris":"https://www.skava.com"}
DELETE Delete OAuth Clientauthservice/oauthclient/delete {"email": "dev@skava.com","userName": "Skava User"}
POST OAuth Client Authorizationauthservice/oauthclient/authorization {"email": "dev@skava.com","userName": "Skava User"}
PATCH Update OAuth Clientauthservice/oauthclient/patch {"clientName":"885e98b170-87c2-43f1-83c6-2a3c4f85a1d4"}
POST Create Privilegeauthservice/privilege/create {"collectionId":2,"description":"87.172.102.72walker.pena@yandex.us","name":"66630896-62f5-4c46-bcf6-06b94b6e56d1"}
DELETE Delete Privilegeauthservice/privilege/delete No payload
PUT Update Privilegeauthservice/privilege/update {"collectionId":2,"description":"87.172.102.72walker.pena@yandex.us","name":"66630896-62f5-4c46-bcf6-06b94b6e56d1"}
POST Add Privileges To Privilege Setauthservice/privilegeset/addprivileges [{"collectionId":[1468],"privilegeId":10442}]
POST Create Privilege Setauthservice/privilegeset/create {"collectionId":2,"description":"175.27.66.88sara.castillo@hotmail.us","name":"6f23e103-1d99-46c9-8f01-c85fb6fffabe"}
DELETE Delete Privilege Setauthservice/privilegeset/delete No payload
DELETE Remove Privileges From Privilege Setauthservice/privilegeset/removeprivileges No payload
PUT Update Privilege Setauthservice/privilegeset/update {"collectionId":2,"description":"175.27.66.88sara.castillo@hotmail.us","name":"6f23e103-1d99-46c9-8f01-c85fb6fffabe"}
POST Add Privilege Sets To Roleauthservice/role/addprivilege [10077,10078,10079,10080,10081,10082,10083,10084,10085,10086]
POST Create Roleauthservice/role/create {"collectionId":1,"description":"47Ventura93","name":"70Georgia74","businessId":0}
DELETE Delete Roleauthservice/role/delete No payload
PATCH Modify Roleauthservice/role/patch {"collectionId":1,"description":"47Ventura93","name":"70Georgia74","businessId":0}
DELETE Remove Privilege Sets From Roleauthservice/role/removeprivilege [10077,10086]
PUT Update Role authservice/role/update {"collectionId":1,"description":"47Ventura93","name":"70Georgia74","businessId":0}
POST Create Session authservice/session/create No payload
DELETE Delete Session authservice/session/delete No payload
PATCH Refresh Session authservice/session/patch {"refreshToken":"85fd895268e21707b3d4e175b06e4b2a12d062f09c3c7fa5543aa72ecf9a6bad29a5c290229d873ec4eecb08f886f7c9"}
POST Create User Attribute authservice/userattribute/create {"attribueValue":"Puerto RicoHiram Ellison","collectionId":"1468","privilegeId":"10443","userId":34}
DELETE Delete User Attribute authservice/userattribute/delete No payload
PUT Update User Attribute authservice/userattribute/update {"attribueValue":"Puerto RicoHiram Ellison","collectionId":"1468","privilegeId":"10443","userId":34}
POST Add Roles To Users authservice/userrole/create [{"userId":436,"roles":[{"businessId":1,"collection":1468,"roleName":"183eecba-787c-47ea-8e41-7f59cc57be4b","category":"STANDARD","roleAttribute":"BoPhcL"},{"businessId":1,"collection":1468,"roleName":"183eecba-787c-47ea-8e41-7f59cc57be4b","category":"CUSTOM","roleAttribute":"BoPhcL"}]}]
DELETE Delete User Roles authservice/userrole/delete No payload
PUT Update All User Rolesauthservice/userrole/update [{"userId":436,"roles":[{"businessId":1,"collection":1468,"roleName":"183eecba-787c-47ea-8e41-7f59cc57be4b","category":"STANDARD","roleAttribute":"BoPhcL"},{"businessId":1,"collection":1468,"roleName":"183eecba-787c-47ea-8e41-7f59cc57be4b","category":"CUSTOM","roleAttribute":"BoPhcL"}]}]

Cart

HTTP MethodCall Detail Event Type Response Payload
DELETE Delete Cart cartservices/cart/delete No payload
PATCH Patch Update Cart cartservices/cart/patchupdate {"communicationPreference":{"contactMethod":"TEXT","email":"test@mailinator.com","firstName":"test","lastName":"test123","phone":"9889876789","zipCode":"64321"},"accountsId":10,"createdBy":"string","customProperties":{"additionalProp1":"Cricket","additionalProp2":"Football","additionalProp3":"Rummy"},"items":[{"customProperties":{"additionalProp1":"Bag","additionalProp2":"Lap","additionalProp3":"Mouse"},"quantity":1,"shipping":{"deliveryInstructions":"Deliver to home","deliveryOnOrBefore":0,"selectedMethod":"stndard","shippingVersion":0,"type":"Home"},"skus":[{"productId":"prod_001","skuId":"sku_001"}]}],"payments":[{"amount":100,"currency":"USD","id":0,"paymentId":"idnehyea","paymentItemId":"dsarere","paymentType":"card","transactionId":"dsaderre213211d"}],"promotions":[{"name":"test promotion","promoCode":"TMdd5"}],"shipping":{"deliveryInstructions":"Deliver to home","deliveryOnOrBefore":0,"selectedMethod":"stndard","shippingVersion":0,"type":"Home"},"status":"ACTIVE","type":"8229","updatedBy":"string","userId":"46"}
CREATE Create Cart cartservices/cart/create {"communicationPreference":{"contactMethod":"TEXT","email":"test@mailinator.com","firstName":"test","lastName":"test123","phone":"9889876789","zipCode":"64321"},"accountsId":10,"createdBy":"string","customProperties":{"additionalProp1":"Cricket","additionalProp2":"Football","additionalProp3":"Rummy"},"items":[{"customProperties":{"additionalProp1":"Bag","additionalProp2":"Lap","additionalProp3":"Mouse"},"quantity":1,"shipping":{"deliveryInstructions":"Deliver to home","deliveryOnOrBefore":0,"selectedMethod":"stndard","shippingVersion":0,"type":"Home"},"skus":[{"productId":"prod_001","skuId":"sku_001"}]}],"payments":[{"amount":100,"currency":"USD","id":0,"paymentId":"idnehyea","paymentItemId":"dsarere","paymentType":"card","transactionId":"dsaderre213211d"}],"promotions":[{"name":"test promotion","promoCode":"TMdd5"}],"shipping":{"deliveryInstructions":"Deliver to home","deliveryOnOrBefore":0,"selectedMethod":"stndard","shippingVersion":0,"type":"Home"},"status":"ACTIVE","type":"8229","updatedBy":"string","userId":"46"}
CREATE Create Cart Address cartservices/cartaddress/create {"address":{"addressLine1":"The White House","addressLine2":"1600 Pennsylvania Avenue","addressLine3":"3/4 Lingam Avenue","addressVersion":0,"canReceiveSMS":false,"city":"string","companyName":"string","country":" ","county":"string","email":" ","firstName":"","lastName":"","middleName":"string","mobile":"","phone":"","profileAddressId":"string","state":"","storeId":"string","zip":"123"}
CREATE Create Cart Item cartservices/cartitem/create [{"address":{"addressLine1":"The White House","addressLine2":"1600 Pennsylvania Avenue","addressLine3":"3/4 Lingam Avenue","addressVersion":0,"canReceiveSMS":false,"city":"string","companyName":"string","country":" ","county":"string","email":" ","firstName":"","lastName":"","middleName":"string","mobile":"","phone":"","profileAddressId":"string","state":"","storeId":"string","zip":""},"customProperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"quantity":1,"shipping":{"deliveryInstructions":"string","deliveryOnOrBefore":0,"selectedMethod":"string","shippingVersion":0,"type":"string"},"skus":[{"productId":"string","skuId":"string"}]}]
CREATE Create Cart Properties cartservices/cartproperty/create {"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}
CREATE Create Cart Shipping cartservices/cartshipping/create {"deliveryInstructions":"string","deliveryOnOrBefore":0,"id":0,"selectedMethod":"string","shippingVersion":0,"type":"string"}
CREATE Create Item Properties cartservices/itemproperty/create {"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}
CREATE Create Other Charges cartservices/othercharges/create [{"cartId":0,"chargeAgainst":"string","chargeSource":"string","chargeType":"string","chargeValue":0,"chargeValueOverridable":true,"createdBy":"string","description":"string","id":0,"itemId":0,"name":"string","otherChargeType":"string","taxable":true,"type":"string","updatedBy":"string","waiveOverridable":true,"waivedByDefault":true}]
CREATE Create Payment cartservices/payment/create [{"amount":0,"createdBy":"string","currency":"string","id":0,"paymentId":"string","paymentItemId":"string","paymentType":"string","transactionId":"string","updatedBy":"string"}]
CREATE Create Promotion cartservices/promotion/create [{"createdBy":"string","name":"string","promoCode":"string"}]
DELETE Delete Cart Address cartservices/cartaddress/delete No payload
DELETE Delete Cart Item Properties cartservices/cartitemproperty/delete No payload
DELETE Delete Cart Item cartservices/cartitem/delete No payload
DELETE Delete Cart Payment cartservices/cartpayment/delete No payload
DELETE Delete Cart Properties cartservices/cartproperty/delete No payload
DELETE Delete Cart Shipping cartservices/cartshipping/delete No payload
DELETE Delete Communication Preference cartservices/communicationpreference/delete No payload
DELETE Delete Other Charges cartservices/othercharges/delete No payload
DELETE Delete Promotion cartservices/promotion/delete No payload
PATCH Patch Update Cart Address cartservices/cartaddress/patch 
PATCH Patch Update Cart Item Properties cartservices/cartitemproperty/patch 
PATCH Patch Update Cart Item cartservices/cartitem/patch 
PATCH Patch Update Cart Payment cartservices/cartpayment/patch 
PATCH Patch Update Cart Properties cartservices/cartproperty/patch 
PATCH Patch Update Cart Shipping cartservices/cartshipping/patch 
PATCH Patch Update Other Charges cartservices/othercharges/patch 
PUT Update Cart Item Properties cartservices/cartitemproperty/update 
PUT Update Cart Properties cartservices/cartproperty/update 
PUT Update Communication Preference cartservices/communicationpreference/update 

Catalog

HTTP MethodCall Detail Event Type Response Payload
DELETE Delete Catalog catalogservice/catalog/delete No payload
POST Create Catalog catalogservice/catalog/create {"identifier":"f249e777f12e4b7386cabbe333f9c4f1_1677483318253","endTime":"2026-02-26T07:34:29+05:30","locked":"FALSE","startTime":"2025-02-26T07:34:29+05:30","status":"ACTIVE","type":"MASTER"}
PUT Update Catalog catalogservice/catalog/update {"endTime":"2023-11-23T14:30:56+05:30","identifier":"salescatalogidpostcatalog14_1606142194753","locked":"FALSE","properties":[{"name":"pyFrDqn","locked":"FALSE","locale":"fr_FR","value":" "},{"name":"pyFrDqn","locked":"FALSE","locale":"en_CA","value":"30"},{"name":"pyFrDqn","locked":"FALSE","locale":"de_CH","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"es_CR","value":"30"},{"name":"pyFrDqn","locked":"FALSE","locale":"ar_KW","value":"30"},{"name":"pyFrDqn","locked":"FALSE","locale":"it_CH","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"de_DE","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"ar_DZ","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"lt_LT","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"ja_JP","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"de_GR","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"zh_CN","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"nl_BE","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"ar_LB","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"en_IN","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"es_MX","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"ru_RU","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"es_HN","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"zh_HK","value":"25"}],"startTime":"2022-11-23T14:30:56+05:30","status":"ACTIVE","type":"SALES"}
POST Create Attribute Group catalogservice/attributegroup/create {"attributeIds":[0],"collection_id":1,"identifier":"1","orderIdx":1,"type":"NORMAL"}
POST Create Attribute catalogservice/attribute/create {"collection_id":0,"dataType":"BOOLEAN","endTime":"string","filterable":false,"identifier":"string","properties":[{"locale":"string","name":"string","validationData":"string"}],"required":false,"searchable":false,"sortable":false,"startTime":"string","status":"ACTIVE","type":"STATIC","validation":"string"}
POST Create Model catalogservice/model/create {"description":"aaa","modelId":"testid01","name":"testid001","properties":[],"status":"ACTIVE","type":"TEMPLATE"}
POST Create Model Value catalogservice/modelvalue/create {"attributes":[{"attributeId":"name2","value":"TRUE","locale":"en_US"}],"modelValueId":"testid2","status":"ACTIVE"}
POST Create Product catalogservice/product/create {"identifier":"f249e777f12e4b7386cabbe333f9c4f1_1677483318253","status":"ACTIVE","visible":"ENABLED","startTime":"2021-03-04T00:00:00-08:00","endTime":"2050-12-31T23:59:59.999-08:00","properties":[{"attributeId":"name","value":"pdt1","isDelete":false,"locale":"en_US"},{"attributeId":"name2","value":"2","isDelete":false,"locale":"en_US"},{"attributeId":"name3","value":"etest","isDelete":false,"locale":"en_US"},{"attributeId":"name4","value":"true","isDelete":false,"locale":"en_US"},{"attributeId":"name5","value":"option2","isDelete":false,"locale":"en_US"},{"attributeId":"name6","value":"2021-03-04T03:45:16","isDelete":false,"locale":"en_US"},{"attributeId":"name7","value":"4","isDelete":false,"locale":"en_US"},{"attributeId":"name8","value":"test@skava.com","isDelete":false,"locale":"en_US"}],"skuIds":["test02","test03"]}
POST Create Project Notes catalogservice/projectnotes/create {"catalogId":"string","collectionId":0,"identifier":"string","itemId":"string","itemType":"CATEGORY","notes":"string","projectId":"string","updatedTime":"2015-07-20T15:49:04-07:00","userId":"string","userName":"string"}
POST Create Project catalogservice/project/create {"actualCompletionDate":"string","catalogId":"string","description":"string","name":"string","notes":"string","state":"OPEN","status":"ACTIVE","targetCompletionDate":"string","type":"MASTER"}
POST Create SKUcatalogservice/sku/create {"endTime":"2025-12-28T11:44:44.797+05:30","identifier":"f249e777f12e4b7386cabbe333f9c4f1_1677483318253","locked":"FALSE","notes":"This is to create a sku","projectStatus":"ACTIVE","properties":[{"attributeId":"name2","isDelete":false,"locale":"en_US","locked":false,"value":10}],"startTime":"2019-05-29T13:03:17.879+05:30","status":"ACTIVE","visible":"ENABLED"}
DELETE Delete Attribute Group catalogservice/attributegroup/delete No payload
DELETE Delete Attribute catalogservice/attribute/delete No payload
DELETE Delete Model catalogservice/model/delete No payload
DELETE Delete Model Value Attribute catalogservice/modelvalueattribute/delete No payload
DELETE Delete Model Value catalogservice/modelvalue/delete No payload
DELETE Delete Product catalogservice/product/delete No payload
DELETE Delete Project catalogservice/project/delete No payload
DELETE Delete SKU catalogservice/sku/delete No payload
PATCH Patch Update Attribute Group catalogservice/attributegroup/patch {"attributeIds":["string"],"collection_id":1,"identifier":"attributegroup","orderIdx":1,"type":"NORMAL"}
PATCH Patch Update Attribute Property catalogservice/attributeproperty/patch {"locale":"string","name":"string","validationData":"string"}
PATCH Patch Update Attribute catalogservice/attribute/patch {"collection_id":0,"dataType":"BOOLEAN","endTime":"string","filterable":false,"identifier":"string","properties":[{"locale":"string","name":"string","validationData":"string"}],"required":false,"searchable":false,"sortable":false,"startTime":"string","status":"ACTIVE","type":"STATIC","validation":"string"}
PATCH Patch Update Catalog Property catalogservice/property/patch {"name":"testproperty ","locked":"FALSE","locale":null,"value":null}
PATCH Patch Update Catalog catalogservice/catalog/patch {"endTime":"2023-11-23T14:30:56+05:30","identifier":"salescatalogidpostcatalog14_1606142194753","locked":"FALSE","properties":[{"name":"pyFrDqn","locked":"FALSE","locale":"fr_FR","value":" "},{"name":"pyFrDqn","locked":"FALSE","locale":"en_CA","value":"30"},{"name":"pyFrDqn","locked":"FALSE","locale":"de_CH","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"es_CR","value":"30"},{"name":"pyFrDqn","locked":"FALSE","locale":"ar_KW","value":"30"},{"name":"pyFrDqn","locked":"FALSE","locale":"it_CH","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"de_DE","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"ar_DZ","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"lt_LT","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"ja_JP","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"de_GR","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"zh_CN","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"nl_BE","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"ar_LB","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"en_IN","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"es_MX","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"ru_RU","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"es_HN","value":"25"},{"name":"pyFrDqn","locked":"FALSE","locale":"zh_HK","value":"25"}],"startTime":"2022-11-23T14:30:56+05:30","status":"ACTIVE","type":"SALES"}
PATCH Patch Update Model catalogservice/model/patch {"description":"aaa","modelId":"testid01","name":"testid001","properties":[],"status":"ACTIVE","type":"TEMPLATE"}
PATCH Patch Update Model Value catalogservice/modelvalue/patch {"status":"INACTIVE"}
PATCH Patch Update Product Property catalogservice/productproperty/patch {"attributeId":"name2","locale":" ","locked":"FALSE","value":"10"
PATCH Patch Update Product catalogservice/product/patch {"catalogId":"string","collectionId":0,"endTime":"string","identifier":"string","locked":"TRUE","notes":"string","projectId":"string","projectStatus":"ACTIVE","properties":[{"attributeId":"string","locale":"string","locked":"TRUE","value":"string"}],"startTime":"string","status":"ACTIVE","visible":"ENABLED"}
PATCH Patch Update Project catalogservice/project/patch {"actualCompletionDate":"string","catalogId":"string","description":"string","name":"string","notes":"string","state":"OPEN","status":"ACTIVE","targetCompletionDate":"string","type":"MASTER"}
PATCH Patch Update SKU Property catalogservice/skuproperty/patch {"attributeId":"name2","locale":" ","locked":"FALSE","notes":"this is a sample ","projectStatus":"ACTIVE","value":"10"}
PATCH Patch Update SKUcatalogservice/sku/patch {"endTime":"2025-12-28T11:44:44.797+05:30","identifier":"f249e777f12e4b7386cabbe333f9c4f1_1677483318253","locked":"FALSE","notes":"This is to udpade a sku","projectStatus":"ACTIVE","properties":[{"attributeId":"name2","isDelete":false,"locale":"en_US","locked":false,"value":10}],"startTime":"2019-05-29T13:03:17.879+05:30","status":"ACTIVE","visible":"ENABLED"}
PUT Update Attribute Group catalogservice/attributegroup/update {"attributeIds":["string"],"collection_id":1,"identifier":"attributegroup","orderIdx":1,"type":"NORMAL"}
PUT Update Attribute Property catalogservice/attributeproperty/update {"locale":"string","name":"string","validationData":"string"}
PUT Update Attribute catalogservice/attribute/update {"collection_id":0,"dataType":"BOOLEAN","endTime":"string","filterable":false,"identifier":"string","properties":[{"locale":"string","name":"string","validationData":"string"}],"required":false,"searchable":false,"sortable":false,"startTime":"string","status":"ACTIVE","type":"STATIC","validation":"string"}
PUT Update Catalog Property catalogservice/property/update {"name":"testproperty ","locked":"FALSE","locale":null,"value":null}
PUT Update Product Property catalogservice/productproperty/update {"attributeId":"name2","locale":" ","locked":"FALSE","value":"10"}
PUT Update Product catalogservice/product/update {"catalogId":"string","collectionId":0,"endTime":"string","identifier":"string","locked":"TRUE","notes":"string","projectId":"string","projectStatus":"ACTIVE","properties":[{"attributeId":"string","locale":"string","locked":"TRUE","value":"string"}],"startTime":"string","status":"ACTIVE","visible":"ENABLED"}
PUT Update Project catalogservice/project/update {"actualCompletionDate":"string","catalogId":"string","description":"string","name":"string","notes":"string","state":"OPEN","status":"ACTIVE","targetCompletionDate":"string","type":"MASTER"}
PUT Update SKU Property catalogservice/skuproperty/update 
PUT Update SKUcatalogservice/sku/update 

Feeds

HTTP MethodCall detail Event Type Response Payload
POST Create Feed Jobfeedservice/feedjob/create {"description":"string","executionType":null,"jobId":"j0012","jobParams":[{"name":"string","stringValue":"string"}],"maxRunTime":0,"name":"string","serviceType":"string","status":"ACTIVE"}
POST Create Feed Run Historyfeedservice/feedrunhistory/create No payload
POST Create Feedfeedservice/feed/create {"allowParllelExecution":true,"description":"string","executionCluster":"string","executionType":null,"feedId":"id001","jobInfo":{"jobId":"job001","jobParams":["string"],"jobPath":"string","scheduleParams":["string"]},"maxRunTime":0,"name":"string","serviceConfigs":["string"],"serviceType":"feed"}
POST Create Schedulefeedservice/schedule/create {"description":"string","endTime":"2025-07-17T20:00:00+05:30","feedInterval":0,"maxRunTime":0,"name":"schedule1","params":[{"name":"S1","stringValue":"first"}],"repeatInterval":0,"scheduleId":"S001","startTime":"2019-07-17T20:00:00+05:30","status":"INACTIVE"}
DELETE Delete Feed Job feedservice/feedjob/delete 
DELETE Delete Feed Run History feedservice/feedrunhistory/delete No payload
DELETE Delete Feedfeedservice/feed/delete No payload
DELETE Delete Schedulefeedservice/schedule/delete No payload
PATCH Patch Update Feed Jobfeedservice/feedjob/patch {"description":"string","executionType":"string","jobId":"string","jobParams":[{"name":"string","stringValue":"string"}],"maxRunTime":0,"name":"string","serviceType":"string","status":"ACTIVE"}
PATCH Patch Update Feed Run History feedservice/feedrunhistory/patch No payload
PATCH Patch Update Feedfeedservice/feed/patch {"description":"string","executionType":null,"jobId":"string","jobParams":[{"name":"job1","stringValue":"p1"}],"maxRunTime":0,"name":"string","serviceType":"string","status":"ACTIVE"}
PATCH Patch Update Schedulefeedservice/schedule/patch {"allowParllelExecution":true,"description":"string","executionCluster":"string","executionType":"string","feedId":"string","jobInfo":{"jobId":"string","jobParams":["string"],"jobPath":"string","scheduleParams":["string"]},"maxRunTime":0,"name":"string","serviceConfigs":["string"],"serviceType":"string"}
POST Stop Schedulefeedservice/schedule/stop 
PUT Update Feed Job feedservice/feedjob/update {"description":"string","executionType":"string","jobId":"string","jobParams":[{"name":"string","stringValue":"string"}],"maxRunTime":0,"name":"string","serviceType":"string","status":"ACTIVE"}
PUT Update Feed Run Historyfeedservice/feedrunhistory/update No payload
PUT Update Feedfeedservice/feed/update {"allowParllelExecution":true,"description":"string","executionCluster":"string","executionType":"string","feedId":"string","jobInfo":{"jobId":"string","jobParams":["string"],"jobPath":"string","scheduleParams":["string"]},"maxRunTime":0,"name":"string","serviceConfigs":["string"],"serviceType":"string"}
PUT Update Schedulefeedservice/schedule/update {"description":"string","feedInterval":0,"maxRunTime":0,"name":"string","params":[{"name":"first schedule","stringValue":"minor"}],"repeatInterval":0,"scheduleId":"string","status":"INACTIVE"}

Feed Job

Service TypeHTTP MethodCall Detail  Event Type Response Payload
AccountPOSTLaunch Account Publish Feedfeedjobservice/account/accountpublish{"feedId":"accountpublish","jobId":"1_accountpublish","scheduleId":"1_accountpublish_Schedule1","feedJobParam":[\{"name":"userId","stringValue":"45"},{"name":"businessId","stringValue":"1"},{"nPayload-ame":"storeId","stringValue":"1"},{"name":"type","stringValue":"FULL"},{"name":"collectionId","stringValue":"1"},{"name":"feedIntervelHR","stringValue":"0"},{"name":"isB2B","stringValue":"false"},{"name":"rollBackVersion","stringValue":""},{"name":"scheduleId","stringValue":"1_accountpublish_Schedule1"}]}
CatalogPOSTLaunch Catalog Approval Feedfeedjobservice/catalog/catalogapproval{"description":"","name":"","feedJobParam":[{"name":"collectionId","stringValue":""},{"name":"projectId","stringValue":""},{"name":"userId","stringValue":""},{"name":"storeId","stringValue":""},{"name":"isDeltaIndexEnabled","stringValue":"true"},{"name":"scheduleId","stringValue":""}],"scheduleId":"","status":"ONDEMAND"}"
CatalogPOSTLaunch Catalog Export Feedfeedjobservice/catalog/catalogexport{"scheduleId":"2743_catalogexport_schedule_1631182139061-1631182139061","name":"Catalog create schedule for catalogexport","description":"Catalog create schedule for catalogexport","status":"ONDEMAND","feedJobParam":[{"name":"collectionId","stringValue":"92","type":"string"},{"name":"userId","stringValue":,"type":"string"},{"name":"locale","stringValue":"en_US","type":"string"},{"name":"projectId","stringValue":"default","type":"string"},{"name":"storeId","stringValue":"3270","type":"string"},{"name":"outputFilePath","stringValue":"/usr/local/skava/","type":"string"},{"name":"fileName","stringValue":"catalogexport","type":"string"},{"name":"sheets","stringValue":"attribute,product,sku,model","type":"string"},{"name":"rules","stringValue":"{"rules":[{"match":"ALL"}]}","type":"string"},{"name":"locale","stringValue":"en_US"}]}
CatalogPOSTLaunch Catalog Import Feedfeedjobservice/catalog/catalogimport{"feedJobParam":[{"name":"scheduleId","stringValue":"schedule1"},{"name":"inputFileCdnUrl","stringValue":"https://d3gqeq5wcctqxw.cloudfront.net/catalogadmin/7a7194eb-7237-426d-9ccd-3f2192f39978/Final_import_Sheet_ModelTemplate.xlsx"},{"name":"collectionId","stringValue":"91"},{"name":"sheets","stringValue":"attribute,model,product,sku,productskumapping,template_modelvalues"},{"name":"projectId","stringValue":"default"},{"name":"catalogId","stringValue":"master"},{"name":"timeZone","stringValue":"EST"},{"name":"userId","stringValue":"112"},{"name":"locale","stringValue":"en_US"},{"name":"defaultLocale","stringValue":"en_US"}],"name":"catalogimport","scheduleId":"schedule1"}"
CatalogPOSTLaunch Catalog Mapping Feedfeedservice/catalog/catalogmapping{"collectionId":"91","businessId":1,"scheduleId":"4917_catalogmapping_schedule_1639049621388","feedId":"catalogmapping","jobId":"91_catalogmapping","name":"Catalog create schedule for catalogmapping","description":"Catalog create schedule for catalogmapping","status":"ONDEMAND","serviceType":"catalog","params":[{"name":"collectionId","stringValue":"91"},{"name":"userId","stringValue":"45"},{"name":"locale","stringValue":"en_US"},{"name":"catalogId","stringValue":"sales"},{"name":"projectId","stringValue":"sales"},{"name":"storeId","stringValue":"4870"}],"
CatalogPOSTLaunch Model Value Export Feedfeedjobservice/catalog/modelvalueexport{"scheduleId":"","collectionId":"","feedId":"modelvalueexport","jobId":" eg: 91_modelvalueexport>","status":"ONDEMAND","state":"RUNNING","feedJobParam":[{"name":"collectionId","stringValue":""},{"name":"userId","stringValue":""},{"name":"locale","stringValue":"en_US"},{"name":"catalogId","stringValue":"master"},{"name":"projectId","stringValue":"default"},{"name":"modelId","stringValue":"MachineParent"},{"name":"collection_id","stringValue":""},{"name":"project_id","stringValue":"default"},{"name":"model_id","stringValue":""},{"name":"rules","stringValue":"{"rules":[{"match":"ALL"}]}"},{"name":"locale","stringValue":"en_US"}],"businessId":1,"name":"Catalog create schedule for name:modelvalueexport","description":""}
CatalogPOSTLaunch Model Value Import Feedfeedjobservice/catalog/modelvalueimport{"scheduleId":"","name":"Catalog create schedule for modelvalueimport","description":"","status":"ONDEMAND","feedJobParam":[{"name":"collectionId","stringValue":"","type":"string"},{"name":"userId","stringValue":,"type":"string"},{"name":"locale","stringValue":"en_US","type":"string"},{"name":"catalogId","stringValue":"master","type":"string"},{"name":"projectId","stringValue":"default","type":"string"},{"name":"modelId","stringValue":"Mobile","type":"string"},{"name":"storeId","stringValue":"","type":"string"},{"name":"fileName","stringValue":"","type":"string"},{"name":"sheets","stringValue":"ModelValue","type":"string"},{"name":"rules","stringValue":"{"rules":[{"match":"ALL"}]}","type":"string"},{"name":"locale","stringValue":"en_US","type":"string"},{"name":"inputFileCdnUrl","stringValue":"
CatalogPOSTLaunch Catalog Publish Feedfeedjobservice/catalog/catalogpublish{"scheduleId":"","collectionId":"","feedId":"catalogpublish","jobId":"","status":"ONDEMAND","state":"COMPLETED","params":[{"name":"catalogId","stringValue":"master"},{"name":"collectionId","stringValue":"91"},{"name":"isB2B","stringValue":"false"},{"name":"type","stringValue":"FULL"},{"name":"versionId","stringValue":"default"},{"name":"userId","stringValue":""}],"businessId":1,"name":"catalogpublish","description":"catalogpublish","repeatInterval":null,"feedInterval":null,"maxRunTime":null,"startTime":"2021-11-08T09:59:08.195","endTime":null,"lastRunTime":"2021-11-08T09:59:13.456"}
PricingPOSTLaunch Price Import Feedfeedjobservice/price/PriceImportJob{"description":"test schedule for PriceImportJob feed","name":"PriceImportJob","params":[{"name":"collectionId","stringValue":"24767"},{"name":"priceListId","stringValue":"42865"},{"name":"projectId","stringValue":""},{"name":"userId","stringValue":45},{"name":"sheetUrl","stringValue":"https://d3gqeq5wcctqxw.cloudfront.net/pricingadmin/fb982697-7f84-4da5-9509-b1e9e35ee8f7/Attribute_ProductSku_withoutmodel%20(3).xlsx"}],"scheduleId":"PriceImportSchedule-1645678939621","status":"ONDEMAND"}
PricingPOSTLaunch Price Export Feedfeedjobservice/price/PriceExportJobNo payload
PricingPOSTLaunch Price List Clone Feedfeedjobservice/price/PriceListClone{"feedJobParam":[{"name":"priceCollectionId","stringValue":""},{"name":"priceListName","stringValue":""},{"name":"priceListId","stringValue":""},{"name":"scheduleId","stringValue":""},{"name":"storeId","stringValue":""}],"scheduleId":""}
PricingPOSTLaunch Price Publish Feedfeedjobservice/price/pricepublish{"feedId":"pricepublish","jobId":"1_pricepublish","scheduleId":"1_pricepublish_Schedule1","feedJobParam":[{"name":"userId","stringValue":""},{"name":"businessId","stringValue":""},{"name":"storeId","stringValue":""},{"name":"type","stringValue":""},{"name":"collectionId","stringValue":""},{"name":"feedIntervelHR","stringValue":"0"},{"name":"isB2B","stringValue":"false"},{"name":"priceListId","stringValue":""},{"name":"rollBackVersion","stringValue":""},{"name":"scheduleId","stringValue":""}
PricingPOSTLaunch Price Approval Feedfeedjobservice/price/PriceApprovalJob{"feedJobParam":[{"name":"status","stringValue":"ONDEMAND"},{"name":"isDeltaIndexEnabled","stringValue":"true"},{"name":"isB2B","stringValue":"true"},{"name":"priceListId","stringValue":""},{"name":"storeId","stringValue":""},{"name":"collectionId","stringValue":""},{"name":"projectId","stringValue":"default"},{"name":"userId","stringValue":""},{"name":"feedId","stringValue":"PriceApprovalJob"},{"name":"feedJobId","stringValue":""},{"name":"scheduleId","stringValue":""},{"name":"historyId","stringValue":""}],"scheduleId":""}
InventoryPOSTLaunch Bin Export Feedfeedjobservice/inventory/binExport{"description":"binExport","maxRunTime":0,"name":"binExport","params":[{"name":"collectionId","stringValue":"124"},{"name":"storeId","stringValue":"770"},{"name":"recipientSuccessMails","stringValue":"feeduser163320211004124304@mailinator.com"},{"name":"fileName","stringValue":"BINEXPORT_ONE"}],"repeatInterval":0,"scheduleId":"inventory_schedule_0001","status":"ONDEMAND"}
InventoryPOSTLaunch Bin Import Feedfeedjobservice/inventory/binImport{"feedJobParam":[{"name":"status","stringValue":"ONDEMAND"},{"name":"fileName","stringValue":"bin_data.xlsx"},{"name":"sheets","stringValue":"bin"},{"name":"inputFileCdnUrl","stringValue":"https://d3gqeq5wcctqxw.cloudfront.net/catalogadmin/18369daa-e2e0-4db9-be44-8192543a1802/Transfer_baseTest_new.xlsx"},{"name":"locale","stringValue":"en_US"},{"name":"storeId","stringValue":"14877"},{"name":"collectionId","stringValue":"3755"},{"name":"feedId","stringValue":"binImport"},{"name":"feedJobId","stringValue":"3755__binImport"},{"name":"scheduleId","stringValue":"3755inventorybinImportfeedschedule0143435445452"},{"name":"historyId","stringValue":"62b74030dad5490009061f21"}],"scheduleId":"3755inventorybinImportfeedschedule0143435445452"}
InventoryPOSTLaunch Bin Item Import Feedfeedjobservice/inventory/binItemImport{"feedJobParam":[{"name":"status","stringValue":"ONDEMAND"},{"name":"fileName","stringValue":"Inventory_FEED_data.xlsx"},{"name":"sheets","stringValue":"bin"},{"name":"inputFileCdnUrl","stringValue":"https://d3gqeq5wcctqxw.cloudfront.net/catalogadmin/cc8e59ae-8950-49e0-b3f7-095977d1bfdc/Inventory_FEED_data3.xlsx"},{"name":"locale","stringValue":"en_US"},{"name":"storeId","stringValue":"14877"},{"name":"collectionId","stringValue":"3755"},{"name":"feedId","stringValue":"binItemImport"},{"name":"feedJobId","stringValue":"3755__binItemImport"},{"name":"scheduleId","stringValue":"3755inventorybinImportfeedschedule0143435445462"},{"name":"historyId","stringValue":"62b74030dad5490009061f21"}],"scheduleId":"3755inventorybinImportfeedschedule0143435445462"}
InventoryPOSTLaunch Bin Item Export Feedfeedjobservice/inventory/binItemExport{"feedJobParam":[{"name":"collectionId","stringValue":"1"},{"name":"fileName","stringValue":"BinItemExport"}],"scheduleId":"4","name":"binItem_export","skipGeneratedFileDelete":true}
InventoryPOSTLaunch Transaction Import Feedfeedjobservice/inventory/transactionImport{"feedJobParam":[{"name":"collectionId","stringValue":"1"},{"name":"inputFileCdnUrl","stringValue":"https://d3gqeq5wcctqxw.cloudfront.net/catalogadmin/f6a85142-a4b4-4957-9e12-0d34c5ed601a/TMobile_Inventory.xlsx"},{"name":"scheduleId","stringValue":"test1234"}],"name":"string","params":[{"name":"string","stringValue":"string"}],"scheduleId":"string","skipGeneratedFileDelete":"string"}
InventoryPOSTLaunch Transaction Export Feedfeedjobservice/inventory/transactionExport{"description":"inventory_transactionExport_feed","params":[{"name":"collectionId","stringValue":"1154"},{"name":"storeId","stringValue":"4882"},{"name":"recipientSuccessMails","stringValue":"feeduser163320211004124304@mailinator.com"},{"name":"fileName","stringValue":"transactionExport_2109_0630"}],"scheduleId":"210920220630","name":"transactionExport","status":"ONDEMAND"}
MerchandisingPOSTLaunch Merchandising Approval Feedfeedjobservice/merchandise/merchandiseapproval{"description":"","name":"merchandiseapprovalschedule","feedJobParam":[{"name":"collectionId","stringValue":""},{"name":"projectId","stringValue":"default"},{"name":"userId","stringValue":""},{"name":"scheduleId","stringValue":""}],"scheduleId":"","status":"ONDEMAND"}
MerchandisingPOSTLaunch Merchandising Import Feedfeedjobservice/merchandise/merchandiseimport{"scheduleId":"","feedJobParam":[{"name":"collectionId","stringValue":""},{"name":"userId","stringValue":},{"name":"locale","stringValue":"en_US"},{"name":"projectId","stringValue":"default"},{"name":"storeId","stringValue":""},{"name":"fileName","stringValue":""},{"name":"sheets","stringValue":"Category_Attributes,Categories,Category_Milestones,SiteNavigations,SiteNavigation_Milestones,SiteNavigation_Hierarchy"},{"name":"inputFileCdnUrl","stringValue":""},{"name":"locale","stringValue":""}]}>
MerchandisingPOSTLaunch Merchandising Export Feedfeedjobservice/merchandise/merchandiseexport{"scheduleId":"","feedJobParam":[{"name":"collectionId","stringValue":},{"name":"userId","stringValue":},{"name":"locale","stringValue":""},{"name":"projectId","stringValue":""},{"name":"storeId","stringValue":""},{"name":"fileName","stringValue":"MerchExportSheet.xlsx"},{"name":"sheets","stringValue":"Category_Attributes,Categories,Category_Milestones,SiteNavigations,SiteNavigation_Milestones,SiteNavigation_Hierarchy"},{"name":"scheduleId","stringValue":""},{"name":"locale","stringValue":""},{"name":"rules","stringValue":"{\"rules\":[{match:\"ALL\"}]}"}]}
MerchandisingPOSTLaunch Merchandising Publish Feedfeedjobservice/merchandise/merchandisepublishparams:[{"name":"storeId","stringValue":"3661"},{"name":"collectionId","stringValue":"4403"},{"name":"isB2B","stringValue":"true"},{"name":"type","stringValue":"FULL"},{"name":"versionId","stringValue":""},{"name":"userId","stringValue":"112"}]
FoundationPOSTLaunch Foundation Publish Feedfeedjobservice/foundation/foundationpublish{"feedJobParam":[{"name":"backupFilePath","stringValue":"/mnt/data-store-b/shared/foundation/backup"},{"name":"validateBusinessStatus","stringValue":"1"},{"name":"userId","stringValue":"1"},{"name":"type","stringValue":"FULL"},{"name":"storeId","stringValue":"1"},{"name":"scheduleId","stringValue":""},{"name":"businessId","stringValue":"1"},{"name":"rollbackVersion","stringValue":""},{"name":"validateBusinessStatus","stringValue":"1"}],"name":"string","scheduleId":"string"}
FoundationPOSTLaunch Master Publish Feedfeedjobservice/foundation/publishmaster{"feedJobParam":[{"name":"collectionId","stringValue":"11430"},{"name":"businessId","stringValue":"4"},{"name":"searchCollectionId","stringValue":"2831"},{"name":"catalogCollectionId","stringValue":"9319"},{"name":"merchandiseCollectionId","stringValue":"4366"},{"name":"promotionCollectionId","stringValue":"5550"},{"name":"priceCollectionId","stringValue":"26372"},{"name":"priceListId","stringValue":"45805"},{"name":"accountCollectionId","stringValue":"6830"},{"name":"storeId","stringValue":"11430"},{"name":"locale","stringValue":"en_US"},{"name":"isB2B","stringValue":"false"}],"name":"publishmaster","scheduleId":"publishmasterSchedule_1651751709657"}
LoyaltyPOSTLaunch Loyalty Cycle Calculation Feedfeedjobservice/loyalty/loyaltycyclecalculation{"scheduleId":"loyaltycyclecalculation_144545_1637920728","name":"Loyalty Cycle Calculation","feedJobParam":[{"name":"limit","stringValue":"100"},{"name":"scheduleId","stringValue":""},{"name":"monthlyScheduleDate","stringValue":""},{"name":"enableDemoMode","stringValue":"true"},{"name":"CSMResetEventName","stringValue":""},{"name":"CSMUpdateEventName","stringValue":""},{"name":"TierUpdateEventName","stringValue":""},{"name":"locale","stringValue":"en_US"},{"name":"validStatus","stringValue":"Shipped,Submitted_to_Fulfilment"},{"name":"storeId","stringValue":""}]}
LoyaltyPOSTLaunch Loyalty Transaction Expiry Feedfeedjobservice/loyalty/loyaltytransactionexpiry[{"name":"limit","stringValue":"100"},{"name":"scheduleId","stringValue":"loyaltytransactionexpiry_144545_1637920728"},{"name":"monthlyScheduleDate","stringValue":"4"},{"name":"enableDemoMode","stringValue":"true"},{"name":"CSMResetEventName","stringValue":"CSM Reset"},{"name":"CSMUpdateEventName","stringValue":"CSM Update"},{"name":"TierUpdateEventName","stringValue":"Tier Update"},{"name":"locale","stringValue":"en_US"},{"name":"validStatus","stringValue":"Shipped,Submitted_to_Fulfilment"},
PromotionsPOSTLaunch Promocode Download Feedfeedjobservice/promotion/promocodesdownload{"feedJobParam":[{"name":"status","stringValue":"ONDEMAND"},{"name":"isB2B","stringValue":"false"},{"name":"promoCodeListId","stringValue":""},{"name":"recipientMails","stringValue":""},{"name":"recipientCCMails","stringValue":""},{"name":"storeId","stringValue":""},{"name":"collectionId","stringValue":""},{"name":"recipientBCCMails","stringValue":""},{"name":"feedId","stringValue":"promocodesdownload"},{"name":"feedJobId","stringValue":""},{"name":"scheduleId","stringValue":""},{"name":"historyId","stringValue":""}],"scheduleId":""}
PromotionsPOSTLaunch Promocode Generate Feedfeedjobservice/promotion/promocodesgenerate{"scheduleId":"","feedJobParam":[{"name":"charLength","stringValue":""},{"name":"codeType","stringValue":""},{"name":"limit","stringValue":""},{"name":"prefix","stringValue":""},{"name":"suffix","stringValue":""},{"name":"promoCodeListId","stringValue":""},{"name":"collectionId","stringValue":""},{"name":"recipientMails","stringValue":""},{"name":"recipientBCCMails","stringValue":""},{"name":"recipientCCMails","stringValue":""},{"name":"scheduleId","stringValue":""}]}"
PromotionsPOSTLaunch Promocode Upload Feedfeedjobservice/promotion/promocodesupload{"description":"","name":"","scheduleId":"","status":"ONDEMAND","feedJobParam":[{"name":"promotionListId","stringValue":""},{"name":"collectionId","stringValue":""},{"name":"recipientMails","stringValue":" "},{"name":"recipientBCCMails","stringValue":""},{"name":"recipientCCMails","stringValue":""},{"name":"uploadFileCdnUrl","stringValue":""},{"name":"scheduleId","stringValue":""}]}
PromotionsPOSTLaunch Promotion List Download Feedfeedjobservice/promotion/promotionlistdownload{"description":"","name":"","scheduleId":"","status":"ONDEMAND","feedJobParam":[{"name":"promoCodeListId","stringValue":""},{"name":"collectionId","stringValue":""},{"name":"recipientMails","stringValue":" "},{"name":"storeId","stringValue":""},{"name":"isB2B","stringValue":"false"},{"name":"recipientBCCMails","stringValue":""},{"name":"recipientCCMails","stringValue":""},{"name":"scheduleId","stringValue":""}]}
PromotionsPOSTLaunch Promotion List Upload Feedfeedjobservice/promotion/promotionlistupload{"description":"","name":"","scheduleId":"","status":"ONDEMAND","feedJobParam":[{"name":"promotionListId","stringValue":""},{"name":"collectionId","stringValue":""},{"name":"recipientMails","stringValue":" "},{"name":"recipientBCCMails","stringValue":""},{"name":"recipientCCMails","stringValue":""},{"name":"uploadFileCdnUrl","stringValue":""},{"name":"scheduleId","stringValue":""}]}
PromotionsPOSTLaunch Publish Promotions Feedfeedjobservice/promotion/publishpromotions{ "scheduleId" : "publishpromotions_16363655445601", "collectionId" : "5334", "feedId" : "publishpromotions", "jobId" : "5334_publishpromotions", "status" : "ONDEMAND", "state" : "RUNNING", "params" : [ { "name" : "collectionId", "stringValue" : "5334" }, { "name" : "isB2B", "stringValue" : "true" }, { "name" : "type", "stringValue" : "FULL" }, { "name" : "versionId", "stringValue" : "" }, { "name" : "userId", "stringValue" : "114" }], "businessId" : 1, "name" : "publishpromotions", "description" : "publishpromotions", "repeatInterval" : null, "feedInterval" : null, "maxRunTime" : null, "startTime" : "2021-11-08T09:59:08.195", "endTime" : null, "lastRunTime" : "2021-11-08T09:59:13.456" }"
Ratings and ReviewsPOSTLaunch Recently Viewed Reviews Export Feedfeedjobservice/ratingsreviews/recentlyviewedreviewsexport{"feedJobParam":[{"name":"collectionId","stringValue":"{{$collectionId}}"},{"name":"catalogcollectionId","stringValue":"{{$catalogcollectionId}}"},{"name":"fileName","stringValue":"{{$fileName}}"},{"name":"scheduleId","stringValue":"{{$scheduleId}}"},{"name":"fromDate","stringValue":"{{$fromDate}}"},{"name":"toDate","stringValue":"{{$toDate}}"},{"name":"outputFilePath","stringValue":"/usr/local/skava/ratingsreviews/backup"},{"name":"locale","stringValue":"en_US"}]}
Ratings and ReviewsPOSTLaunch Reviews Export Feedfeedjobservice/ratingsreviews/reviewsexport{"feedJobParam":[{"name":"collectionId","stringValue":"{{$collectionId}}"},{"name":"catalogcollectionId","stringValue":"{{$catalogcollectionId}}"},{"name":"fileName","stringValue":"{{$fileName}}"},{"name":"scheduleId","stringValue":"{{$scheduleId}}"},{"name":"fromDate","stringValue":"{{$fromDate}}"},{"name":"toDate","stringValue":"{{$toDate}}"},{"name":"outputFilePath","stringValue":"/usr/local/skava/ratingsreviews/backup"},{"name":"locale","stringValue":"en_US"}]
Ratings and ReviewsPOSTLaunch Reviews Import Feedfeedjobservice/ratingsreviews/reviewsimport{"scheduleId":"ReviewImportSchedule_{{$timestamp}}","skipGeneratedFileDelete":"null","status":"ONDEMAND""params":[{"name":"sheetUrl","stringValue":"{{$sheetUrl}}"},{"name":"collectionId","stringValue":"{{$collectionId}}"},{"name":"userCollectionId","stringValue":"{{$userCollectionId}}"},{"name":"storeId","stringValue":"{{$storeId}}"},{"name":"scheduleId","stringValue":"ReviewImportSchedule_{{$timestamp}}"}],}
SearchPOSTLaunch Catalog B2B Event Publisher Feedfeedjobservice/search/CatalogEventB2BPublisher{ "scheduleId" : "CatalogB2BEventPublisher_16363655445601", "collectionId" : "5334", "feedId" : "CatalogB2BEventPublisher", "jobId" : "5334_CatalogB2BEventPublisher", "status" : "ONDEMAND", "state" : "RUNNING", "params" : [ { "name" : "collectionId", "stringValue" : "5334" }, { "name" : "isB2B", "stringValue" : "true" }, { "name" : "businessId", "stringValue" : "1" }, { "name" : "storeId", "stringValue" : "1" }, { "name" : "userId", "stringValue" : "114" }, { "name" : "isFullFeed", "stringValue" : "true" }, { "name" : "versionId", "stringValue" : "default" }, { "name" : "skipPriceCheck", "stringValue" : "false" }, { "name" : "false", "stringValue" : "true" }, { "name" : "catalogCollectionId", "stringValue" : "101" }, { "name" : "accountsCollectionId", "stringValue" : "102" }, { "name" : "feedIntervelHR", "stringValue" : "24" }, { "name" : "searchCollectionId", "stringValue" : "103" }, { "name" : "isFull", "stringValue" : "false" }, { "name" : "isDataImport", "stringValue" : "false" }, { "name" : "solrCollectionName", "stringValue" : "product_sfo_stage" }, { "name" : "isLiveDB", "stringValue" : "false" }], "businessId" : 1, "name" : "publishpromotions", "description" : "publishpromotions", "repeatInterval" : null, "feedInterval" : null, "maxRunTime" : null, "startTime" : "2021-11-08T09:59:08.195", "endTime" : null, "lastRunTime" : "2021-11-08T09:59:13.456" }
SearchPOSTLaunch Catalog Event Publisher Feedfeedjobservice/search/CatalogEventPublisherparams:[{"name":"userId","stringValue":"1"},{"name":"businessId","stringValue":"{{businessid}}"},{"name":"storeId","stringValue":"{{x-store-id}}"},{"name":"isLiveDB","stringValue":"false"},{"name":"solrCollectionName","stringValue":"product_sfo_{{solrsuffix}}"},{"name":"isDataImport","stringValue":"false"},{"name":"isFull","stringValue":"false"},{"name":"searchCollectionId","stringValue":"{{searchcollectionid}}"},{"name":"feedIntervelHR","stringValue":"1"},{"name":"catalogProjectID","stringValue":"default"},{"name":"skipInventoryCheck","stringValue":"true"},{"name":"skipPriceCheck","stringValue":"false"},{"name":"catalogCollectionId","stringValue":"{{catalogcollectionid}}"},{"name":"catalogId","stringValue":"master"},{"name":"priceListId","stringValue":"{{priceListId}}"},{"name":"pricerule_ids","stringValue":"{{priceListId}}"},{"name":"storeId","stringValue":"{{x-store-id}}"}]
SearchPOSTLaunch Merchandising Event Publisher Feedfeedjobservice/search/MerchandiseEventPublisher{"scheduleId":"PriceEventPublisherSchedule_{{$timestamp}}","status":"ONDEMAND","params":[{"name":"userId","stringValue":"112"},{"name":"businessId","stringValue":"{{businessid}}"},{"name":"storeId","stringValue":"{{x-store-id}}"},{"name":"isLiveDB","stringValue":"false"},{"name":"solrCollectionName","stringValue":"product_sfo_{{solrsuffix}}"},{"name":"isDataImport","stringValue":"false"},{"name":"isFull","stringValue":"true"},{"name":"searchCollectionId","stringValue":"{{searchcollectionid}}"},{"name":"feedIntervelHR","stringValue":"24"},{"name":"defaultPriceListId","stringValue":"{{priceListId}}"},{"name":"accountsCollectionId","stringValue":"{{accountcollectionId}}"},{"name":"priceCollectionId","stringValue":"{{priceCollectionId}}"},{"name":"catalogCollectionId","stringValue":"{{catalogcollectionid}}"}]}
SearchPOSTLaunch Price Event Publisher feedfeedjobservice/search/PriceEventPublisher
SearchPOSTLaunch Search Publish Feedfeedjobservice/search/SearchPublish{"scheduleId":"searchpublishSchedule_{{$timestamp}}","status":"ONDEMAND","params":[{"name":"collectionId","stringValue":"{{searchcollectionid}}"},{"name":"isB2B","stringValue":"false"},{"name":"type","stringValue":"FULL"},{"name":"isBackupRestore","stringValue":"false"},{"name":"versionId","stringValue":" "},{"name":"rollbackVersion","stringValue":"1"},{"name":"storeId","stringValue":"{{x-store-id}}"}]}
SubscriptionsPOSTLaunch Subscription Feedfeedjobservice/subscription/subscriptionfeed{"scheduleId":"subscriptionfeedSchedule_0001","businessId":4,"collectionId":"20484","feedId":"subscriptionfeed","jobId":"20484_subscriptionfeed","name":"subscriptionfeed","description":"subscriptionfeed","status":"ONDEMAND","params":[{"name":"authConfig","stringValue":"{"userName":"businessname_1715@skava.com","credentials":"Skava@123"}"},{"name":"disableUserFlagCheck","stringValue":"false"},{"name":"orchestration","stringValue":"{"name":"orchestrationservices","serviceType":"orchestration","endPoint":"https://int.skavacommerce.com"}"},{"name":"auth","stringValue":"{"name":"authservices","serviceType":"auth","endPoint":"https://int.skavacommerce.com"}"},{"name":"customer","stringValue":"{"name":"userservices","serviceType":"customer","endPoint":"https://int.skavacommerce.com"}"},{"name":"isOrderValidationRequired","stringValue":"false"},{"name":"enableDemoMode","stringValue":"false"},{"name":"retryConfig","stringValue":"{"retryCount":"3","notifyRetryCount":"10","disableServerSideExceptionRetry":"false"}"},{"name":"storeId","stringValue":"3471"},{"name":"lastOrderFailedProcessConfig","stringValue":"{"enableLastOrderFailedProcess":"false"}"},{"name":"runWithPVAssist","stringValue":"true"},{"name":"isSubscriptionItemOosCheck","stringValue":"false"},{"name":"daysToAddForSubItemOos","stringValue":"2"},{"name":"userId","stringValue":""},{"name":"currentDay","stringValue":"9"},{"name":"isLoyaltyUsedForRecurranceOrder","stringValue":"true"}],"lastRunTime":null,"serviceType":"subscription"}
SubscriptionsPOSTLaunch Subscription Notification Feedfeedjobservice/subscription/subscriptionnotificationfeed{"scheduleId":"SubscriptionNotificationFeed_{{$timestamp}}","feedId":"SubscriptionNotificationFeed","jobId":"{{subscriptioncollectionId}}SubscriptionNotificationFeed","name":"SubscriptionNotificationFeed","description":"SubscriptionNotificationFeed","status":"ONDEMAND","params":[{"name":"authConfig","stringValue":"{"userName":"feedauthadmin@skava.com","credentials":"Skava@123"}"},{"name":"disableUserFlagCheck","stringValue":"false"},{"name":"orchestration","stringValue":"{"name":"orchestrationservices","serviceType":"orchestration","endPoint":"{{domain}}"}"},{"name":"auth","stringValue":"{"name":"authservices","serviceType":"auth","endPoint":"{{domain}}"}"},{"name":"customer","stringValue":"{"name":"userservices","serviceType":"customer","endPoint":"{{domain}}"}"},{"name":"retryConfig","stringValue":"{"retryCount":"3","notifyRetryCount":"10","disableServerSideExceptionRetry":"false"}"},{"name":"storeId","stringValue":"{{x-store-id}}"},{"name":"isSubscriptionItemOosCheck","stringValue":"false"},{"name":"isPaymentCheckEnabled","stringValue":"true"},{"name":"userId","stringValue":""},{"name":"scheduleId","stringValue":"SubscriptionNotificationFeed{{$timestamp}}"}]}
UserPOSTLaunch GDPR Delete Feedfeedjobservice/search/gdprdelete{"name":"gdprdelete","scheduleId":"16_gdprdelete_schedule_30052022_003","status":"ONDEMAND","params":[{"name":"storeId","stringValue":"5"}]}
UserPOSTLaunch GDPR Export Feedfeedjobservice/search/gdprdexport{"description":"description","name":"promoCodeListId schedule_1649324459434","scheduleId":"","status":"ONDEMAND","params":[{"name":"customerCollectionId","stringValue":""},{"name":"cartcheckoutCollectionId","stringValue":""},{"name":"subscriptionCollectionId","stringValue":""},{"name":"paymentCollectionId","stringValue":""},{"name":"orderCollectionId","stringValue":""},{"name":"userId","stringValue":""},{"name":"businessId","stringValue":"2"},{"name":"storeId","stringValue":"5"},{"name":"services","stringValue":"customer,order,payment,subscription"}]}"

Foundation

HTTP MethodCall Detail Event TypeResponse Payload
POST Create Business foundationservice/business/create {"cdnUrl":"https://d16rliti0tklvn.cloudfront.net","createdBy":0,"createdOn":"","defaultCurrency":"USD","defaultLocale":"en_US","description":"XoYCoxAbDcNDCixBQTCaCQITtPoORIYjYKtfHfxSAjKNeAQKYF","id":0,"name":"businessname_1677473530958","properties":[],"services":[{"name":"cje","status":1},{"name":"cartcheckout","status":1},{"name":"inventory","status":1},{"name":"list","status":1},{"name":"loyalty","status":1},{"name":"marketing"},{"name":"order","status":1},{"name":"catalog","status":1},{"name":"pricing","status":1},{"name":"promotion","status":1},{"name":"customer","status":1},{"name":"subscription","status":1}],"status":1,"storageServiceUrl":"https://s3.amazonaws.com/skava.stage.store.atfingertips.com","updatedBy":0,"updatedOn":""}
PUT Update Business foundationservice/business/update {"cdnUrl":"https://d16rliti0tklvn.cloudfront.net","createdBy":1,"defaultCurrency":"USD","defaultLocale":"en_US","id":1,"logoUrl":"https://www.skava.com/logo.png","name":"Skava","properties":[{"createdBy":1,"name":"prop.username1","updatedBy":1,"value":true}],"services":[{"name":"catalog","status":1}],"status":1,"storageServiceUrl":"https://s3.amazonaws.com/skava.stage.store.atfingertips.com","updatedBy":1}
POST Create Store Association foundationservice/storeassociation/create {"associations":[{"collectionId":"1677474376076","jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"loyalty","properties":[{"name":"BinId","value":"Bin1"}],"type":"microservice"},{"collectionId":"1677474376076","jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"customer","properties":[{"name":"BinId","value":"Bin1"}],"type":"microservice"}]}
PUT Update Store Association foundationservice/storeassociation/patch {"associations":[{"collectionId":"100","jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"loyalty","properties":[{"name":"BinId","value":"Bin1"}],"type":"microservice"},{"collectionId":"100","jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"customer","properties":[{"name":"BinId","value":"Bin1"}],"type":"microservice"}]}
PATCH Patch Store Association foundationservice/storeassociation/update No PATCH CALL present for store association in Swagger
DELETE Delete Store Association foundationservice/storeassociation/delete Need only corresponding IDs
POST Create Store Association Propertyfoundationservice/storeassociationproperties/create {"properties":[{"name":"fHiqVJ","value":"Property_Value_5"}]}
PATCH Patch Store Association Propertyfoundationservice/storeassociationproperties/patch No PATCH CALL present in Swagger
PUT Update Store Association Propertyfoundationservice/storeassociationproperties/update {"properties":[{"name":"Property956557","value":"Property_Value_67"}]}
DELETE Delete Store Association Propertyfoundationservice/storeassociationproperties/delete Need only corresponding IDs
POST Create Business Property foundationservice/businessproperty/create [{"createdBy":1,"name":"prop.username12","updatedBy":1,"value":true}]
PATCH Patch Business Property foundationservice/businessproperty/patch No PATCH CALL present in Swagger
PUT Update Business Property foundationservice/businessproperty/update [{"createdBy":1,"name":"prop.username","updatedBy":1,"value":false}]
POST Create Store Propertyfoundationservice/storeproperty/create {"properties":[{"custom":false,"description":"GRjoNXHDrY","name":"Property157180319866","value":"propertyValue462"}]}
PUT Update Store Propertyfoundationservice/storeproperty/update {"properties":[{"custom":false,"description":"opzajkEzgF","name":"Property526905","value":"propertyValue960"}]}
PATCH Patch Store Propertyfoundationservice/storeproperty/patch No PATCH CALL present for store property in Swagger
DELETE Delete Store Property foundationservice/storeproperty/delete Need only corresponding IDs
POST Create Store foundationservice/store/create {"associations":[{"collectionId":1,"defaultAssociation":false,"id":0,"jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"loyalty","properties":[{"name":"loyaltypoints","value":"yvyVpQYRd"}]}],"businessId":"1","currencies":["USD"],"defaultCurrency":"USD","defaultLocale":"en_US","defaultShippingRegion":"US","id":0,"launchUrl":"https://www.skava.com","locales":["en_US"],"logoUrl":"https://www.store.com/logo.png","name":"EeNci","previewUrl":"https://www.skava.com","properties":[{"description":"Maintenance date of every month","name":"prop_maintenancedate","value":25}],"shippings":["US"],"status":"1","timeZone":"UTC","type":"2"}
PUT Update Store foundationservice/store/update{"associations":[{"collectionId":1,"defaultAssociation":false,"id":0,"jurisdiction":[{"countryCode":"US","documentId":1}],"name":"loyalty","properties":[{"name":"prop_maintenancedate","value":25}]},{"collectionId":2,"defaultAssociation":true,"id":0,"jurisdiction":[{"countryCode":"US","documentId":1}],"name":"subscription","properties":[]},{"collectionId":0,"defaultAssociation":true,"jurisdiction":[{"countryCode":"XincHK","documentId":"XincHK","supported":true}],"name":"XincHK","properties":[{"name":"XincHK","value":"XincHK"}],"storeId":0,"type":"XincHK"}],"businessId":"1","defaultCurrency":"USD","defaultLocale":"en_US","defaultShippingRegion":"US","launchUrl":"https://www.skava.com","name":"SpFyCsyS","previewUrl":"https://www.skava.com","properties":[{"canDelete":true,"description":"XincHK","name":"XincHK","storeId":0,"value":"XincHK"}],"status":"1","timeZone":"UTC","type":"2"}

Inventory

HTTP MethodCall detail Event Type Response Payload
POST Create Bininventoryservice/bin/create{"channel":"Mobile","description":"New Bin","leafBin":true,"name":"21677369600800254","properties":[{"name":"Brand","value":"Adidas"}],"type":"Primary"}
DELETE Delete Bininventoryservice/bin/deleteNo payload
Update Update Bininventoryservice/bin/update{"channel":"Mobile","description":"Updated Bin","leafBin":false,"status":0,"type":"Backup"}
PATCH Patch Update Bininventoryservice/bin/patch {"channel":"Mobile","description":"Updated Bin","leafBin":false,"status":0,"type":"Backup"}
POST Create Bin Iteminventoryservice/binitem/create {"binName":"Active_Bin1","atpQty":100,"backOrderedQty":20,"lowStockThreshold":5,"outOfStockThreshold":3,"skuId":"SKUID_81677369600165759045","status":1}
POST Check Inventoryinventoryservice/inventory/check [{"atpQty":5,"binName":"Active_Bin1","skuId":"Active_Sku1"}]
PATCH Patch Update Bin Iteminventoryservice/binitem/patch {"binName":"Active_Bin1","atpQty":100,"backOrderedQty":20,"lowStockThreshold":5,"outOfStockThreshold":3,"skuId":"SKUID_81677369600165759045","status":0}
POST Create Transactioninventoryservice/transaction/create {"atpQty":20,"backOrderedQty":5,"consignmentCost":"2.5","notes":"Remove Transaction","status":1,"type":2}
POST Create Bulk Transactioninventoryservice/transactionbulk/create {"allOrNone":false,"binItems":[{"binName":"Active_Bin1","skuId":"Active_Sku1","transaction":{"atpQty":500,"backOrderedQty":50,"consignmentCost":"$10.0","notes":"Add Transaction","status":1,"type":1}}]}
PATCH Patch Update Transactioninventoryservice/transaction/patch {"consignmentCost":"3.5","notes":"Status Changed","properties":"Patch Transaction","status":0}

Lists

HTTP MethodCall detail Event Type Response Payload
POST Create Listlistservice/list/create{“accountId”:”string”,”collectionId”:”255″,”itemType”:”SKU”,”listItems”:[{“key”:”string”,”name”:”string”}],”name”:”List1″,”type”:”WISHLIST”,”updatedBy”:”string”,”updatedTime”:”string”,”userId”:”string”}
DELETE Delete Listlistservice/list/delete No payload
POST Create List Itemlistservice/listitem/create [{“createdTime”:1577101220406,”id”:”5e00a7a4a008b5000d9f2f”,”key”:”SKU123″,”name”:”Mywishlist1″,”properties”:{“additionalProp1″:”string”,”additionalProp2″:”string”,”additionalProp3″:”string”},”storeId”:12,”updatedTime”:1677101220406}]
DELETE Delete List Itemlistservice/listitem/delete No payload
POST Create List Properties listservice/listproperties/create {“additionalProp1″:”s01″,”additionalProp2″:”string02″,”additionalProp3″:”string03”}
DELETE Delete List Propertieslistservice/listproperties/delete No payload
POST Create List Item Propertieslistservice/listitemproperties/create {“additionalProp1″:”string01″,”additionalProp2″:”string02″,”additionalProp3″:”string03”}
DELETE Delete List Item Propertieslistservice/listitemproperties/delete response_listItems.id 
PUT Update List Properties listservice/listproperties/update {“additionalProp1″:”string1″,”additionalProp2″:”string2″,”additionalProp3″:”string3”}
PUT Update List Item Propertieslistservice/listitemproperties/update response_listItems.id 
PATCH Patch Update Listlistservice/list/patch {“listItems”:[{“key”:”updated”}]}
PATCH Patch Update List Itemlistservice/listitem/patch name:”Mywishlist1″,”properties”:{“additionalProp1″:”string1″,”additionalProp2″:”string1″,”additionalProp3″:”string1”},
PATCH Patch Update List Propertieslistservice/listproperties/patch {“additionalProp1″:”string1″,”additionalProp2″:”string2″,”additionalProp3″:”string3”}
PATCH Patch Update List Item Propertieslistservice/listitemproperties/patch {“additionalProp1″:”s01″,”additionalProp2″:”s02″,”additionalProp3″:”s03”}

Location

HTTP MethodCall detail Event Type Response Payload
POST Create Locationlocationservice/location/create {"address":{"address1":"#1, 1st Main Road","address2":"Near Chellarams","address3":"Commercial Road","city":"Ooty","latitude":11.4189,"longitude":76.7114,"postalCode":"643001","state":"Tamilnadu"},"binId":"${=System.currentTimeMillis()}","locationType":"Warehouse","hours":[{"description":"Regular business hours of the store","hoursType":"STANDARD","name":"102_LOC1_REG_BIZ_HRS","standardHours":{"monday":[{"description":"monday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"monday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"monday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"tuesday":[{"description":"tuesday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"tuesday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"tuesday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"wednesday":[{"description":"wednesday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"wednesday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"wednesday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"thursday":[{"description":"thursday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"thursday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"thursday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"friday":[{"description":"friday business hours","startTime":"09:00","endTime":"21:00","type":"OPEN"}],"saturday":[{"description":"saturday business hours","startTime":"09:00","endTime":"21:00","type":"OPEN"}],"sunday":[{"description":"sunday business hours","startTime":"09:00","endTime":"14:00","type":"OPEN"}]}}],"overrides":[{"dateStart":"2020-01-01T01:30:00.000+05:30","dateEnd":"2020-06-30T01:30:00.000+05:30","name":"102_LOC1_SPL_BIZ_HRS","description":"Special hours of the store","hours":{"description":"special hours on fridays","startTime":"13:30","endTime":"16:30","type":"CLOSED"}}],"identifier":"asadasf123","images":[{"caption":"store location 001 logo for collection 102","description":"logo of this store 001 for collection 102","url":"https://image.shutterstock.com/image-vector/online-store-logo-small-large-260nw-1087466573.jpg"}],"properties":[{"locale":"en_US","name":"Proprietor","value":"Prabhu M"},{"locale":"en_US","name":"name","value":"Furniche Ooty"}],"status":"ACTIVE"}
POST Create Eventlocationservice/event/create {"collectionId":2040,"endTime":"2025-11-09T11:44:44.797+05:30","identifier":"event02","images":[{"caption":"string","description":"string","url":"string"}],"locationIds":["1676913053065"],"longDescription":"string","name":"string","properties":[{"locale":"en_US","name":"string","value":"string"}],"shortDescription":"string","startTime":"2016-11-09T11:44:44.797+05:30","tags":["string"],"url":"string"}
DELETE Delete Locationlocationservice/location/delete No payload
DELETE Delete Eventlocationservice/event/delete No payload
PATCH Patch Update Eventlocationservice/event/patch {"collectionId":2040,"endTime":"2025-11-09T11:44:44.797+05:30","identifier":"event02","images":[{"caption":"string","description":"string","url":"string"}],"locationIds":["1676913053065"],"longDescription":"string","name":"string","properties":[{"locale":"en_US","name":"string","value":"updated"}],"shortDescription":"string","startTime":"2016-11-09T11:44:44.797+05:30","tags":["string"],"url":"string"}
PATCH Patch Update Location Propertylocationservice/locationproperty/patch [{"isDelete":true,"locale":"en_US","name":"string","value":"string"}]
PATCH Patch Update Locationlocationservice/location/patch {"address":{"address1":"#1, 1st Main Road","address2":"Near Chellarams","address3":"Commercial Road","city":"Ooty","latitude":11.4189,"longitude":76.7114,"postalCode":"643001","state":"Tamilnadu"},"binId":"${=System.currentTimeMillis()}","locationType":"Store","hours":[{"description":"Regular business hours of the store","hoursType":"BUSINESS","name":"102_LOC1_REG_BIZ_HRS","standardHours":{"monday":[{"description":"monday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"monday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"monday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"tuesday":[{"description":"tuesday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"tuesday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"tuesday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"wednesday":[{"description":"wednesday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"wednesday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"wednesday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"thursday":[{"description":"thursday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"thursday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"thursday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"friday":[{"description":"friday business hours","startTime":"09:00","endTime":"21:00","type":"OPEN"}],"saturday":[{"description":"saturday business hours","startTime":"09:00","endTime":"21:00","type":"OPEN"}],"sunday":[{"description":"sunday business hours","startTime":"09:00","endTime":"14:00","type":"OPEN"}]}}],"overrides":[{"dateStart":"2020-01-01T01:30:00.000+05:30","dateEnd":"2020-06-30T01:30:00.000+05:30","name":"102_LOC1_SPL_BIZ_HRS","description":"Special hours of the store","hours":{"description":"special hours on fridays","startTime":"13:30","endTime":"16:30","type":"CLOSED"}}],"identifier":"${=System.currentTimeMillis()}","images":[{"caption":"store location 001 logo for collection 102","description":"logo of this store 001 for collection 102","url":"https://image.shutterstock.com/image-vector/online-store-logo-small-large-260nw-1087466573.jpg"}],"properties":[{"locale":"en_US","name":"Proprietor","value":"Prabhu M"},{"locale":"en_US","name":"name","value":"Furniche Ooty"}],"status":"ACTIVE"}
PUT Update Event locationservice/event/update {"collectionId":2040,"endTime":"2025-11-09T11:44:44.797+05:30","identifier":"event02","images":[{"caption":"string","description":"string","url":"string"}],"locationIds":["1676913053065"],"longDescription":"string","name":"string","properties":[{"locale":"en_US","name":"string","value":"updated"}],"shortDescription":"string","startTime":"2016-11-09T11:44:44.797+05:30","tags":["string"],"url":"string"}
PUT Update Locationlocationservice/location/update {"address":{"address1":"#1, 1st Main Road","address2":"Near Chellarams","address3":"Commercial Road","city":"Ooty","latitude":11.4189,"longitude":76.7114,"postalCode":"643001","state":"Tamilnadu"},"binId":"${=System.currentTimeMillis()}","locationType":"Store","hours":[{"description":"Regular business hours of the store","hoursType":"BUSINESS","name":"102_LOC1_REG_BIZ_HRS","standardHours":{"monday":[{"description":"monday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"monday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"monday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"tuesday":[{"description":"tuesday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"tuesday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"tuesday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"wednesday":[{"description":"wednesday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"wednesday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"wednesday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"thursday":[{"description":"thursday business hours","startTime":"09:00","endTime":"13:00","type":"OPEN"},{"description":"thursday lunch hours","startTime":"13:00","endTime":"14:30","type":"CLOSED"},{"description":"thursday business hours","startTime":"14:30","endTime":"21:00","type":"OPEN"}],"friday":[{"description":"friday business hours","startTime":"09:00","endTime":"21:00","type":"OPEN"}],"saturday":[{"description":"saturday business hours","startTime":"09:00","endTime":"21:00","type":"OPEN"}],"sunday":[{"description":"sunday business hours","startTime":"09:00","endTime":"14:00","type":"OPEN"}]}}],"overrides":[{"dateStart":"2020-01-01T01:30:00.000+05:30","dateEnd":"2020-06-30T01:30:00.000+05:30","name":"102_LOC1_SPL_BIZ_HRS","description":"Special hours of the store","hours":{"description":"special hours on fridays","startTime":"13:30","endTime":"16:30","type":"CLOSED"}}],"identifier":"${=System.currentTimeMillis()}","images":[{"caption":"store location 001 logo for collection 102","description":"logo of this store 001 for collection 102","url":"https://image.shutterstock.com/image-vector/online-store-logo-small-large-260nw-1087466573.jpg"}],"properties":[{"locale":"en_US","name":"Proprietor","value":"Prabhu M"},{"locale":"en_US","name":"name","value":"Furniche Ooty"}],"status":"ACTIVE"}
PUT Update Location Propertylocationservice/locationproperty/update [{"isDelete":true,"locale":"en_US","name":"string","value":"string"}]

Loyalty

HTTP MethodCall Detail Event Type Response Payload
PUT Tier Updateloyaltyservices/loyalty/tierUpdate No Payload
DELETE Delete Loyalty Rewardloyaltyservices/reward/delete No Payload
POST Create Loyalty Rewardloyaltyservices/reward/create {"blockEarning":true,"blockRedemption":true,"collectionId":0,"identifier":"5d95a416e0358b2b344639dc","isManuallyAdded":true,"rewardApprovalRequired":true,"status":"ACTIVE","symbol":"p","transactionInfo":[{"name":"string","value":"string"}],"type":"string"}
POST Create Loyaltyloyaltyservices/loyalty/create No Payload
PUT Update Loyalty Rewardloyaltyservices/reward/update {"blockEarning":true,"blockRedemption":true,"collectionId":0,"identifier":"5d95a416e0358b2b344639dc","isManuallyAdded":true,"rewardApprovalRequired":true,"status":"INACTIVE","symbol":"pi","transactionInfo":[{"name":"string1","value":"string1"}],"type":"string1"}
PUT Update Loyaltyloyaltyservices/loyalty/update No Payload
POST Create Transactionloyaltyservices/transaction/create No Payload
POST Create Loyalty Event loyaltyservices/event/create {"collectionId":2616,"description":"points","eventProperty":[{"name":"string1","type":"BOOLEAN","value":"string"}],"identifier":"5d95a416e0358b2b344639dc","name":"points","status":"ACTIVE"}
POST Create Campaign loyaltyservices/campaign/create {"campaignName":"Onboarding","collectionId":2616,"description":"Test description","endTime":1682037017165,"identifier":"5d95a416e0358b2b344639dc","properties":[{"name":"string1","value":"string1"}],"startTime":1652037017165,"status":"ACTIVE","userId":"ABC12"}
POST Create Rule loyaltyservices/rule/create {"name":"loyaltyset001","startTime":1677426858394,"endTime":2549085798000,"status":"ACTIVE","priority":1}
DELETE Delete Loyalty Event loyaltyservices/event/delete No Payload
DELETE Delete Rule loyaltyservices/rule/delete No Payload
PATCH Patch Update Loyalty loyaltyservices/loyalty/patch No Payload
PUT Update Loyalty Event loyaltyservices/loyaltyevent/update {"collectionId":2616,"description":"point","eventProperty":[{"name":"POINT","type":"BOOLEAN","value":"string"}],"identifier":"5d95a416e0358b2b344639dc","name":"points","status":"ACTIVE"}
PATCH Update Campaign loyaltyservices/campaign/patch {"collectionId":1,"description":"points","eventProperty":[{"name":"string","type":"BOOLEAN","value":"null"}],"identifier":"5d95a416e0358b2b344639dc","name":"points","status":"ACTIVE"}
PATCH Update Loyalty Event loyaltyservices/event/patch {"collectionId":1,"description":"points","eventProperty":[{"name":"string","type":"BOOLEAN","value":"null"}],"identifier":"5d95a416e0358b2b344639dc","name":"points","status":"ACTIVE"}
PATCH Update Rule loyaltyservices/rule/patch {"name":"loyaltyset001","startTime":2234065169000,"endTime":2549085798000,"status":"ACTIVE","priority":1}

Merchandising

HTTP MethodCall detail Event Type Response Payload
POST Create Category Attributemerchandiseservice/categoryattribute/create {"collectionId":5125,"identifier":"b8307b68d2544fd487093526f779abcb","mandatory":true,"properties":[{"locale":"en_US","name":"string"}],"status":"ACTIVE"}
POST Create Categorymerchandiseservice/category/create {"collectionId":5125,"identifier":"string","locked":true,"pageType":"PDP","projectId":"string","properties":[{"attributeId":"catattribute5313512","locale":"en_US","locked":true,"name":"string","value":"string"}],"semantics":["string"],"status":"ACTIVE","type":"DYNAMIC","visible":true}
POST Create Creativemerchandiseservice/creative/create {"description":"vRxGgtHlr","name":"E9Dyr6663075651678686276409","status":"ACTIVE","tags":["cAAn77"],"widgetId":"1","widgetProperties":{"additionalProp1":"nzIpnDleH","additionalProp2":"JyvAyB","additionalProp3":"zLIgSKb"}}
POST Create Milestonemerchandiseservice/milestone/create {"attributes":["size","color"],"endTime":"2025-11-09T11:44:44.797+05:30","itemId":"38910e401238463bac35688bf41bff62","name":"Milestone7v4JblP4gM459Ts1678685935019","priority":38,"products":[123,124,125],"startTime":"2020-11-09T11:44:44.797+05:30","status":"ACTIVE","templateId":"373774511","templateUrl":"https://aws207130.com","type":"CATEGORY"}
POST Create Navigationmerchandiseservice/navigation/create {"name":"NavRSOJe1669572001678686307019","status":"ACTIVE"}
POST Create Project Notesmerchandiseservice/projectnotes/create 
POST Create Projectmerchandiseservice/project/create {"actualCompletionDate":"2018-11-09T11:44:44.797","description":"n5T5AmciBjb4D","name":"Name793XOidkgIp9421678684141716","status":"OPEN","targetCompletionDate":"2059-11-09T11:44:44.797+05:30"}
DELETE Delete Category Attributemerchandiseservice/categoryattribute/delete No payload
DELETE Delete Categorymerchandiseservice/category/delete No payload
DELETE Delete Creativemerchandiseservice/creative/delete No payload
DELETE Delete Milestonemerchandiseservice/milestone/delete No payload
DELETE Delete Navigationmerchandiseservice/navigation/delete No payload
DELETE Delete Project merchandiseservice/project/delete No payload
PATCH Patch Update Category Attributemerchandiseservice/categoryattribute/patch {"mandatory":false,"properties":[{"locale":"en_US","name":"locale"}],"status":"ACTIVE"}
PATCH Patch Update Category Property merchandiseservice/categoryproperty/patch [ { "locale": "en_US", "locked": true, "attributeId": "CategoryAttributeziSV3vdarM8Mypl", "value": "https://www.google.com/image" } ]
PATCH Patch Update Categorymerchandiseservice/category/patch {"locked": false}
PATCH Patch Update Creativemerchandiseservice/creative/patch {"description":"jMSbmAxhE","name":"CreativeRG8fnAvpv4q1vt51678686569094","status":"ACTIVE","tags":["P7aP43FFG"],"widgetId":"1","widgetProperties":{"additionalProp1":"keBqmqzBLf","additionalProp2":"YCIAByEl","additionalProp3":"zGNQge"}}
PATCH Patch Update Milestonemerchandiseservice/milestone/patch {"attributes":["size","color"],"endTime":"2050-11-09T11:44:44.797+05:30","identifier":"9546482266","itemId":"ns9k0Fk0T5","name":"Milestone29BIklogPoo5rD1678686599561","priority":76,"products":[123,124,125],"startTime":"2030-11-09T11:44:44.797+05:30","status":"INACTIVE","type":"CATEGORY"}
PATCH Patch Update Navigation merchandiseservice/navigation/patch {"attributes":["size","color"],"endTime":"2050-11-09T11:44:44.797+05:30","identifier":"9546482266","itemId":"ns9k0Fk0T5","name":"Milestone29BIklogPoo5rD1678686599561","priority":76,"products":[123,124,125],"startTime":"2030-11-09T11:44:44.797+05:30","status":"INACTIVE","type":"CATEGORY"}
PATCH Patch Update Project merchandiseservice/project/patch {"description": "vhImbzrzr"}
PUT Update Category Attributemerchandiseservice/categoryattribute/update {"collectionId":5125,"identifier":"b8307b68d2544fd487093526f779abcb","mandatory":true,"properties":[{"locale":"en_US","name":"string"}],"status":"ACTIVE"}
PUT Update Category Propertymerchandiseservice/categoryproperty/update [{"attributeId":"CategoryAttributeziSV3vdarM8Mypl","locale":"en_US","locked":true,"value":"This is a sample value"}]
PUT Update Categorymerchandiseservice/category/update {"collectionId":5125,"identifier":"string","locked":false,"pageType":"PDP","projectId":"string","properties":[{"attributeId":"catattribute5313512","locale":"en_US","locked":false,"name":"string","value":"string"}],"semantics":["string"],"status":"INACTIVE","type":"DYNAMIC","visible":true}
PUT Update Creativemerchandiseservice/creative/update {"description":"EtTXYFcz","name":"CreativePyQcam9cc2tzdy1678686849552","status":"ACTIVE","tags":["N2jiqK7"],"widgetId":"1","widgetProperties":{"additionalProp1":"Rpslhqy","additionalProp2":"OxaQCvts","additionalProp3":"FcSVt"}}
PUT Update Milestone merchandiseservice/milestone/update {"attributes":["brand","price"],"endTime":"2050-11-09T11:44:44.797+05:30","identifier":"209962635","itemId":"215XSs2en","name":"MilestoneOlnx5fX20Xsv71678686892189","priority":30,"products":[223,224,225],"startTime":"2030-11-09T11:44:44.797+05:30","status":"ACTIVE","type":"CATEGORY"}
PUT Update Navigation merchandiseservice/navigation/update {"name":"2XeA72783863471678686718802","status":"ACTIVE"}
PUT Update Projectmerchandiseservice/project/update {"description": "GopFkhIebQ","name": "fSlsc","notes": "hrzOotfzy","state": "","status": "SUBMITTED","type": ""}

Notification

HTTP MethodCall detail Event Type Response Payload
POST Create Actionnotificationservice/action/create{"configName":"email_subject","description":"P4y8EG","eventId":1,"name":"mEitSNvS","status":"ACTIVE","template":"3df56gfe3sdfasdffdsdf3"}
POST Create Eventnotificationservice/event/create{"createdTime":"2018-05-10 01:16:17","description":"reset password event","id":1,"name":"evt_reset_password","notificationName":"Invite User","serviceName":"UserServices","status":"ACTIVE","updatedTime":"2018-05-10 01:16:17"}
DELETE Delete Actionnotificationservice/action/deleteNo payload
DELETE Delete Eventnotificationservice/event/deleteNo payload
POST Send Notificationsnotificationservice/notifications/send{"name":"USER_INVITEUSER","recipients":[{"attachments":[{"content":"iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAABQVBMVEX///8AMlkAltUAkM0AldQAg70AjckAisYARXEAktAAwAW5A","contentSource":"url","fileName":"SpecialOffers.jpg","url":"http://example.com/wp-content/uploads/2016/03/Special.jpg"}],"bccs":[{"email":"xyz@skava.com","name":"skava"}],"ccs":[{"email":"xyz@skava.com","name":"skava"}],"email":"test@test.com","macros":{},"name":"skava","phone":"09874563211","pushId":"hj7sdf67sqc9","tos":[{"email":"xyz@skava.com","name":"skava"}]}],"sender":{"from":{"email":"xyz@skava.com","name":"skava"},"replyto":{"email":"xyz@skava.com","name":"skava"}}}
PATCH Update Actionnotificationservice/action/update{"configName":"SendEmailConfig","description":"Used to Send Reset Email","eventId":1,"name":"Send Reset Email","status":"ACTIVE","template":"d-1257a7b8169f4d84aa3393cb4437cbcf"}
PATCH Update Eventnotificationservice/event/update{"createdTime":"2018-05-10 01:16:17","description":"reset password event","id":0,"name":"evt_reset_password","notificationName":"Invite User","serviceName":"UserServices","status":"ACTIVE","updatedTime":"2018-05-10 01:16:17"}

Order

HTTP MethodCall Detail Event Type Response Payload
PATCH Patch Order omsservices/orders/patchupdate {"reasoncode":"Others","reasoncode":"Others","status":"Cancelled"}
PUT Update Order omsservices/orders/update {"reasoncode":"Others","reasoncode":"Others","status":"Cancelled"}
POST Create Order omsservices/orders/create math:[{"conversionratio":0.01,"cost":0,"discount":0,"discountcost":0,"esttax":0,"estunittax":0,"fulfilmath":{"estfulfilcost":0,"estfulfilsale":0,"estfulfiltax":0,"fulfilcost":0,"fulfildiscount":0,"fulfilsale":0,"fulfiltax":0,"totalfulfilsale":0},"mode":"Currency","personalizationcost":0,"personalizationdiscount":0,"personalizationsale":0,"roundoff":0,"paymentid":"123","sale":0,"tax":0,"taxable":0,"totalsale":0,"unittax":0}],"orderinfo":{"affiliateid":"string","channel":"string","storeid":"string"},"orderitems":[{"discounts":[{"code":"string","confirmationcode":"123435677976","confirmationcode":"123435677976","description":"string","discountclass":"string","level":"ITEM","mode":"Currency","name":"string","offerid":"string","otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"parentitem":"string","priceinfo":{"taxinfo":{"esttax":0,"tax":0,"taxable":0,"taxrate":0},"totalcost":0,"totaldiscount":0,"unitcost":0,"unitdiscount":0}}],"fulfilmentinfo":{"fulfilmentid":{"id":0,"status":"string"},"responseCode":"string","responseMessage":"string","returnaddress":{"address1":"string","address2":"string","address3":"string","city":"string","companyname":"string","country":"string","county":"string","deliveryinstruction":"string","firstname":"string","lastname":"string","middlename":"string","responseCode":"string","responseMessage":"string","state":"string","timeStamp":0,"type":"string","zip":"string"},"returnmethod":{"code":"string","deliverystore":"string","deliveryterm":"string","name":"string","otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"priceinfo":[{"conversionratio":0.01,"cost":0,"discountinfo":[{"code":"string","description":"string","discountclass":"string","level":"ITEM","mode":"string","name":"string","offerid":"string","otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"parentitem":"string","priceinfo":{"taxinfo":{"esttax":0,"tax":0,"taxable":0,"taxrate":0},"totalcost":0,"totaldiscount":0,"unitcost":0,"unitdiscount":0}}],"estcost":0,"estprice":0,"mode":"string","price":0,"taxinfo":{"esttax":0,"tax":0,"taxable":0,"taxrate":0}}]},"shippingcontact":{"email":"dkrvdilip@gmail.com","phone":"9870543210","preferredcontact":"EMAIL"},"shippingaddress":{"address1":"5thstreet","address2":"string","address3":"string","city":"NY","companyname":"Amazon","country":"USA","county":"NY","deliveryinstruction":"string","firstname":"Dilip","lastname":"Kumar","middlename":"string","responseCode":"string","responseMessage":"string","state":"string","timeStamp":0,"type":"string","zip":"AZ09OP"},"shippingmethod":{"code":"string","deliverystore":"string","deliveryterm":"string","name":"string","otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"priceinfo":[{"conversionratio":0.01,"cost":0,"discountinfo":[{"code":"string","confirmationcode":"123435677976","description":"string","discountclass":"string","level":"ITEM","mode":"Currency","name":"string","offerid":"string","otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"parentitem":"string","priceinfo":{"taxinfo":{"esttax":0,"tax":0,"taxable":0,"taxrate":0},"totalcost":0,"totaldiscount":0,"unitcost":0,"unitdiscount":0}}],"estcost":0,"estprice":0,"mode":"Currency","price":0,"taxinfo":{"esttax":0,"tax":0,"taxable":0,"taxrate":0}}]},"timeStamp":0,"type":"PHYSICAL"},"id":"string","inventory":{"blocktransaction":"string","releasetransaction":"string"},"item":{"binid":"12asdfg34","exppreordershipmentdatetime":0,"info":{"categoryid":"CAT01","color":"Red","description":"Redcolorsportsshoe","dimension":"9inch","fit":"Flexible","image":"https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcRX1vWH4rB69KBISOF7Gz3nudu0FigBkXBmlMS7XJMelgZZ_maTcoOiShVXMub4gioWo8qBMTRgL0R4Yv_MK5hc8LwbOjZMPVfH1_Y_BmXQZx6Z_YP8LRiR&usqp=CAc","link":"www.amazon.com","name":"Redshoe","size":"9inch","style":"Flexible"},"maxpurchasequantity":0,"minpurchasequantity":0,"otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"pid":"Pid01","preordered":false,"priceinfo":[{"conversionratio":0.01,"costprice":0,"mode":"Currency","regprice":0,"roundoff":0,"saleprice":0,"saveprice":0,"taxinfo":{"esttax":0,"tax":0,"taxable":0,"taxrate":0}}],"skuid":"Sku01","taxcode":"string","upc":"string","vendor":"string","weightUnits":"string","weightValue":"string"},"math":[{"conversionratio":0.01,"paymentid":"123","cost":0,"discount":0,"discountcost":0,"esttax":0,"estunittax":0,"fulfilmath":{"estfulfilcost":0,"estfulfilsale":0,"fulfildiscount":0,"estfulfiltax":0,"fulfilcost":0,"fulfilsale":0,"totalfulfilsale":0,"fulfiltax":0},"mode":"Currency","personalizationcost":0,"personalizationdiscount":0,"personalizationsale":0,"roundoff":0,"sale":0,"tax":0,"taxable":0,"totalsale":0,"unittax":0}],"mathordershipping":null,"mathordertax":null,"otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"paymentstatus":"PREAUTHORIZED","personalization":[{"id":"string","message":"string","priceinfo":[{"conversionratio":0.01,"discount":[{"code":"string","confirmationcode":"123435677976","description":"string","discountclass":"string","level":"ITEM","mode":"Currency","name":"string","offerid":"string","otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"parentitem":"string","priceinfo":{"taxinfo":{"esttax":0,"tax":0,"taxable":0,"taxrate":0},"totalcost":0,"totaldiscount":0,"unitcost":0,"unitdiscount":0}}],"mode":"Currency","taxinfo":{"esttax":0,"tax":0,"taxable":0,"taxrate":0},"totalpersonalizationcost":0,"totalpersonalizationprice":0,"unitpersonalizationcost":0,"unitpersonalizationprice":0}],"receipt":false,"skuid":"string","wrap":"string"}],"priceinfo":[{"conversionratio":0.01,"costprice":0,"mode":"Currency","regprice":0,"roundoff":0,"saleprice":0,"saveprice":0,"taxinfo":{"esttax":0,"tax":0,"taxable":0,"taxrate":0}}],"quantity":2,"returnable":false,"status":"string","storeid":"0","timeStamp":0,"type":"SKU"}],"orderdetails":null,"otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"payments":[{"id":"123","chargepriority":0,"format":"0","mode":"Currency","paymentitems":[{"otherproperties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"paymentrefid":100,"status":"PREAUTHORIZED","value":0}],"preauthorizations":[],"refundpriority":0,"type":"string","value":0}],"status":["string"],"usertracking":{"accountid":"A01","firstname":"Dilip","guestuser":"false","guestuserid":"","lastname":"Kumar","usercontact":{"email":"dilipkumar@skava.com","phone":"9600904325","preferredcontact":"EMAIL"},"userid":"User01","zip":"AB001B"}}
DELETE Delete Order omsservices/orders/delete Need only corresponding IDs
POST Create Note omsservices/note/create {"createdby":"Sowmya","createdtime":1537096108,"description":"Contains gift"}
PATCH Update Notification omsservices/notification/patch No payload

Payment

HTTP MethodCall Detail Event Type Response Payload
DELETE Delete Payment paymentservice/payment/delete Need only corresponding IDs
POST Create Transaction paymentservice/transaction/create {"id":461,"billingAddress":{"addressLine1":"1 front street","addressLine2":"2","addressLine3":"string","city":"Sanfransico","country":"US","county":"NY","email":"saran@gmail.com","firstName":"saran","lastName":"si","phoneNumber":"7854621459","state":"US","zipcode":"94111"},"default":true,"name":"GOLD"}
PATCH Patch Transaction paymentservice/transaction/patch {"id":461,"billingAddress":{"addressLine1":"1 front street","addressLine2":"2","addressLine3":"string","city":"Sanfransico","country":"US","county":"NY","email":"saran@gmail.com","firstName":"saran","lastName":"si","phoneNumber":"7854621459","state":"US","zipcode":"94111"},"default":true,"name":"GOLD"}
POST Create Payment paymentservice/payment/create {"accountId":1234,"billingAddress":{"addressLine1":"200 E MAIN ST","addressLine2":"SUITE 5A-1204","addressLine3":"PHOENIX","city":"NEW YORK","country":"USA","county":"Essex","email":"test@test.com","firstName":"William","lastName":"Pitt","phoneNumber":"123-310-6600","state":"NEW YORK","zipcode":10001},"collectionId":6142,"createdBy":"User","createdTime":"2023-02-24T02:06:50.525Z","default":true,"id":1,"name":"payment_name_1","paymentProperties":{},"providers":[{"createdBy":"userName","createdTime":"2018-11-01T15:46:32.522+0000","id":1,"token":234132543545354}],"responseMessage":"Failed due to 3rd party failure","serviceId":"1234ab","showInProfile":true,"status":"ACTIVE","type":"CREDITCARD","updatedBy":"userName","updatedTime":"2018-11-01T15:46:32.522+0000","userId":123}
DELETE Delete Payment Property paymentservice/paymentproperty/delete No payload
PATCH Patch Update Payment paymentservice/payment/patch {"id":461,"billingAddress":{"addressLine1":"1 front street","addressLine2":"2","addressLine3":"string","city":"Sanfransico","country":"US","county":"NY","email":"saran@gmail.com","firstName":"saran","lastName":"si","phoneNumber":"7854621459","state":"US","zipcode":"94111"},"default":true,"name":"GOLD"}
POST Create Payment Item paymentservice/paymentitem/create {"currencyCode":"DOLLAR","paymentId":469,"properties":[{"name":"TEST","value":"1"}],"value":9999}
DELETE Delete PaymentItem Property paymentservice/paymentitem/delete No payload
DELETE Delete Payment Item paymentservice/paymentitem/delete No payload
PATCH Patch Update Payment Item paymentservice/paymentitem/update {"currencyCode":"WELCOME","paymentId":57,"properties":[{"name":"TEST","value":"1"}],"value":2}
POST Create Provider Master paymentservice/providermaster/create {"currencyType":"CASH","name":"GOLD","processorClassName":"com.skava.payment.processor.TestPaymentProcessor","supportedTypes":[{"type":"0"}]}
DELETE Delete Provider Master Property paymentservice/providermasterproperty/delete No payload
DELETE Delete Provider Master paymentservice/providermaster/delete No payload
PATCH Patch Update Provider Master paymentservice/providermaster/update {"currencyType":"CASH"}
POST Default Provider Token paymentservice/providertoken/create {"collectionId":377,"customProperties":{"additionalProp1":"string1","additionalProp2":"string1","additionalProp3":"string1"},"type":"ALIPAY","userId":"string"}
POST Create Bulk Transaction paymentservice/bulktransaction/create {"transactions":[{"paymentItemId":271,"properties":[{"name":"WELCOME","value":"1"}],"type":"PREAUTH","value":1}]}
DELETE Delete Transaction Property paymentservice/transactionproperty/delete No payload
DELETE Delete Transaction paymentservice/transaction/delete No payload

Pricing

HTTP MethodCall Detail Event Type Response Payload
DELETE Delete Price priceservice/price/delete Need corresponding IDs only
PUT Update Price priceservice/price/update {"bundlePrice":2000,"endTime":"2024-02-27T08:32:07.442Z","floorPrice":800,"maxqty":200,"minqty":1,"priceListId":34552,"skuId":"string1","startTime":"2023-02-27T08:32:07.442Z","status":"ACTIVE","subscriptionPercentage":2,"transactionalPrice":1000,"unitOfMeasureId":1,"variableMax":10,"variableMin":1}
GET Find Price priceservice/price/find 
POST Create Price priceservice/price/create {"bundlePrice":2000,"endTime":"2024-02-27T08:32:07.442Z","floorPrice":800,"maxqty":200,"minqty":1,"priceListId":34552,"skuId":"string1","startTime":"2023-02-27T08:32:07.442Z","status":"ACTIVE","subscriptionPercentage":2,"transactionalPrice":1000,"unitOfMeasureId":1,"variableMax":10,"variableMin":1}
POST Create Multiprice priceservice/multiprice/create {"priceRequest":[{"bundlePrice":0,"createdBy":0,"createdOn":"string","endTime":"2024-02-27T08:32:07.442Z","floorPrice":0,"id":0,"maxqty":10,"minqty":1,"priceListId":34556,"projectId":46496,"skuId":"string","startTime":"2023-02-27T08:30:07.442Z","status":"ACTIVE","subscriptionPercentage":2,"transactionalPrice":200,"unitOfMeasureId":1,"updatedBy":0,"updatedOn":"string","values":[{"createdBy":0,"createdOn":"2024-02-27T08:30:07.442Z","priceFacetId":0,"priceFacetName":"string","priceId":0,"updatedBy":0,"updatedOn":"2023-02-27T08:32:07.442Z","value":0}],"variableMax":0,"variableMin":0}]}
POST Create Note priceservice/note/create {"comments":"string","priceId":0}
POST Create Price Facet priceservice/pricefacet/create 
POST Create Price List Facet priceservice/pricelistfacet/create 
POST Create Price List priceservice/pricelist/create {"bundlePrice":"DISABLE","currencySign":"INR","description":"string","floorPrice":"DISABLE","name":"pricelist11","schedulePrice":"DISABLE","status":"ACTIVE","subscription":"DISABLE","tierPrice":"DISABLE","variablePrice":"DISABLE"}
POST Create Price Rule priceservice/pricerule/create 
POST Create Price Value priceservice/pricevalue/create 
POST Create Project priceservice/project/create {"description":"string","name":"PROJECT_1","priceListId":34552,"status":"OPEN","targetCompletionDate":"2023-03-27T08:32:07.442Z"}
DELETE Delete Price Facet priceservice/pricefacet/delete Need corresponding IDs only
DELETE Delete Price List Facet priceservice/pricelistfacet/delete Need corresponding IDs only
DELETE Delete Price List priceservice/pricelist/delete Need corresponding IDs only
DELETE Delete Price Rule priceservice/pricerule/delete Need corresponding IDs only
DELETE Delete Price Value priceservice/pricevalue/delete Need corresponding IDs only
DELETE Delete Project priceservice/project/delete {"description":"string","name":"PROJECT_12","priceListId":34556,"status":"OPEN","targetCompletionDate":"2023-03-27T08:32:07.442Z"}
PATCH Patch Update Price Facet priceservice/pricefacet/patch {"name":"pricefacet_1","status":"ACTIVE"}
PATCH Patch Update Price List Facet priceservice/pricelistfacet/patch {"mandatory":"ENABLE"}
PATCH Patch Update Price List priceservice/pricelist/patch {"bundlePrice":"DISABLE","currencySign":"INR","description":"string","floorPrice":"DISABLE","name":"pricelist11","schedulePrice":"DISABLE","status":"ACTIVE","subscription":"DISABLE","tierPrice":"DISABLE","variablePrice":"DISABLE"}
PATCH Patch Update Price Rule priceservice/pricerule/patch 
PATCH Patch Update Price priceservice/price/patch {"bundlePrice":2000,"endTime":"2024-02-27T08:32:07.442Z","floorPrice":800,"maxqty":200,"minqty":1,"priceListId":34552,"skuId":"string1","startTime":"2023-02-27T08:32:07.442Z","status":"ACTIVE","subscriptionPercentage":2,"transactionalPrice":1000,"unitOfMeasureId":1,"variableMax":10,"variableMin":1}
PATCH Patch Update Price Value priceservice/pricevalue/patch 
PATCH Patch Update Project priceservice/project/patch {"description":"string123","name":"PROJECT_1","priceListId":34552,"status":"OPEN","targetCompletionDate":"2023-03-27T08:32:07.442Z"}
PUT Update Price Facet priceservice/pricefacet/update {"name":"pricefacet_1","status":"ACTIVE"}
PUT Update Price List Facet priceservice/pricelistfacet/update {"mandatory":"ENABLE"}
PUT Update Price List priceservice/pricelist/update {"bundlePrice":"DISABLE","currencySign":"INR","description":"string","floorPrice":"DISABLE","name":"pricelist11","schedulePrice":"DISABLE","status":"ACTIVE","subscription":"DISABLE","tierPrice":"DISABLE","variablePrice":"DISABLE"}
PUT Update Price Value priceservice/pricevalue/update 
PUT Update Project priceservice/project/update {"description":"string123","name":"PROJECT_1","priceListId":34552,"status":"OPEN","targetCompletionDate":"2023-03-27T08:32:07.442Z"}

Promotions

HTTP MethodCall Detail Event Type Response Payload
PUT Update Promotion promotionservice/promotion/update {"name":"SECOM-2326","startDate":"2023-02-27T17:33:58.643Z","endDate":"","status":"ACTIVE","id":"string","notes":"string","offerOn":"1","offerType":"1","stopFurtherProcessing":"NEVER","priority":2,"promotionInformation":{"message":[{"locale":"en_US","text":"string"}]}}
POST Create Promotion promotionservice/promotion/create {"name":"SECOM-2326","startDate":"2023-02-27T17:33:58.643Z","endDate":"","status":"INACTIVE","id":"string","notes":"string","offerOn":"1","offerType":"1","stopFurtherProcessing":"NEVER","priority":2,"promotionInformation":{"message":[{"locale":"en_US","text":"string"}]}}
DELETE Delete Promotion promotionservice/promotion/delete No payload
POST Apply Offer promotionservice/offer/apply 
POST Assign Offer promotionservice/offer/assign [{"confirmationCode":"ASSIGNED","promoCode":"g74or3","responseCode":"string","responseMessage":"string","timeStamp":"string"}]
POST Block Offer promotionservice/offer/block {"items":{"sku":[{"itemId":1,"id":"SECOM-16420","color":"Yellow","categoryIds":["cat123"],"productId":"123","unitPrice":1000,"quantity":2,"shippingCost":500,"shippingPostalCode":"641025","shippingMethod":"free","shippingCity":"cbe","property":{"Type":"Casual","Material":"Cotton","categoryName":"leather"}}],"coupon":[{"code":"MUNTIME1OFF-10"}],"user":[{"id":1}]},"ruleType":["item"]}
POST Clone Promotion Group promotionservice/promotiongroup/clone No payload
POST Clone Promotion promotionservice/promotion/clone No payload
POST Create Project promotionservice/project/create {"description":"string","name":"Black friday offer @ 2023","notes":"string","state":"OPEN","targetCompletionDate":"2050-09-18T05:36:34.755Z"}
POST Create Promocode List promotionservice/promocodelist/create {"id":"abc","name":"SECOM-16942","promoCodes":["cartpromo10","PDPPromo"],"status":"ACTIVE"}
POST Create Promotion Group promotionservice/promotiongroup/create {"name":"SECOM-2326","startDate":"2023-02-27T17:33:58.643Z","endDate":"2035-02-27T17:33:58.643Z","status":"INACTIVE","id":"string","notes":"string","offerOn":"1","offerType":"1","stopFurtherProcessing":"NEVER","priority":2,"promotionInformation":{"message":[{"locale":"en_US","text":"string"}]}}
POST Create Promotion List promotionservice/promotionlist/create {"className":"com.skava.promotion.ecomm.model.PromotionSku","field":"brand","items":["Lee","Puma","Reebok"],"name":"SECOM-23645","status":"INACTIVE"}
DELETE Delete Promcode List promotionservice/promotioncodelist/delete No payload
DELETE Delete Promotion Group promotionservice/promotiongroup/delete No payload
DELETE Delete Promotion List promotionservice/promotionlist/delete No payload
PATCH Patch Update Project promotionservice/project/patch {"description":"string","name":"Black friday offer @ 2023,03","notes":"string1","state":"OPEN","targetCompletionDate":"2050-09-18T05:36:34.755Z"}
PATCH Patch Update Promocode List promotionservice/promocodelist/patch {"duplicatePromoCodes":["string"],"feedId":"string","id":"string","name":"Most Rated Brands1","promoCodes":["string"],"status":"ACTIVE"}
PATCH Patch Update Promotion List promotionservice/promotionlist/patch {"className":"com.skava.promotion.ecomm.model.PromotionSku","createdBy":0,"createdOn":"2023-02-27T08:34:57.400Z","duplicateItems":["string"],"feedId":"string1","field":"brand","id":"string","items":["string"],"name":"Most Rated Brands1","status":"INACTIVE","updatedBy":0,"updatedOn":"2023-02-27T08:34:57.400Z"}
PUT Update Project promotionservice/project/update {"description":"string","name":"Black friday offer @ 2023,03","notes":"string1","state":"OPEN","targetCompletionDate":"2050-09-18T05:36:34.755Z"}
PUT Update Promcode List promotionservice/promocodelist/update {"duplicatePromoCodes":["string"],"feedId":"string1","id":"string","name":"Most Rated Brands1","promoCodes":["string"],"status":"ACTIVE"}
PUT Update Promotion Group promotionservice/promotiongroup/update 
PUT Update Promotion List promotionservice/promotionlist/update 

Ratings and Reviews

HTTP MethodCall detail Event Type Response Payload
POST Create Rating Review ratingsreviewsservice/ratingreview/create{"imageUrl":"https://cdn.shopify.com/s/files/1/1089/8530/products/Brain-Bag-Mars-Red_1024x1024.jpg?v=1558291712","itemId":"LPBG2121","properties":{"minlength":"25"},"rating":3,"rawReview":"Quality of the bag is good","review":"Good quality","status":"APPROVED","updatedBy":"string"}
POST Create Rating Feedback ratingsreviewsservice/ratingfeedback/create {"feedback":"LIKE","properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}}
PUT Update Rating Review ratingsreviewsservice/ratingreview/update {"rating":3}
PUT Update Rating Feedback ratingsreviewsservice/ratingfeedback/update feedback:"LIKE","properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}
PATCH Patch Update Image ratingsreviewsservice/image/patch No payload
DELETE Delete Rating Review Preferenceratingsreviewsservice/ratingreviewpreference/delete No payload

Reporting

HTTP MethodCall detail Event Type Response Payload
POST Create Reportreportservice/report/create {"description":"Reports","name":"Testing","query":"Select","reportProperties":[{"name":"New","value":"1"}],"processorClassName":""}
PATCH Patch Update Reportreportservice/report/patch  {"description":"PATCHReport","name":"Testing","query":"Select","reportProperties":[{"name":"New","value":"1"}]}
DELETE Delete Reportreportservice/report/delete  No payload
DELETE Delete Report Propertyreportservice/reportproperty/delete  No payload

Search

HTTP MethodCall detail Event Type Response Payload
POST Create Indexsearchservices/index/create {"endTime":"2020-11-09T11:44:44.797","groupId":"17","id":"17","locale":"en_US","response":"{\"productid\":\"2\"}","startTime":"2016-11-09T11:44:44.797","values":{"brand":"Woodland","size":"123","model":"S1","productId":"Product_17"}}
DELETE Delete Indexsearchservices/index/delete Need corresponding IDs only
POST Create Links searchservices/links/create {"locale":"en_US","redirectURL":"string","searchTerm":"searchlink"}
POST Create Sort Order searchservice/sortorder/create {"items":"item1","locale":"en_US","searchTerm":"string"}
POST Create Synonym searchservice/synonym/create {"fieldName":"string1","locale":"en_US","searchTerm":"string2","searchType":"KEYWORD","synonymType":"CURATION","words":"string"}
DELETE Delete Linkssearchservice/links/delete Need corresponding IDs only
DELETE Delete Sort Ordersearchservice/sortorder/delete Need corresponding IDs only
DELETE Delete Synonymsearchservice/synonym/delete Need corresponding IDs only
PATCH Patch Update Linkssearchservice/links/patch {"locale":"en_UK","redirectURL":"string","searchTerm":"string"}
PUT Update Linkssearchservice/links/update {"locale":"en_US","redirectURL":"string","searchTerm":"searchlink"}
POST Create Attributesearchservice/attribute/create {"classifierName":"classifiername_16774692435431175","description":"Creating new classifier","properties":[{"name":"historicalsaleboostingpercentage","locale":"en_US","value":"test"}],"searchEngineCollName":"category"}
POST Create Configsearchservice/config/create {"classifierName":"classifiername_16774692435431175","description":"Creating new classifier","properties":[{"name":"historicalsaleboostingpercentage","locale":"en_US","value":"test"}],"searchEngineCollName":"category"}
DELETE Delete Attribute searchservice/attribute/delete Need corresponding IDs only
DELETE Delete Configsearchservice/config/delete Need corresponding IDs only
PATCH Patch Update Attributesearchservice/attribute/patch {"name":"historicalsaleboostingpercentage","locale":"en_US","value":"update Propertyupdate"}
PATCH Patch Update Config Propertiessearchservice/configproperties/patch {"name":"historicalsaleboostingpercentage","locale":"en_US","value":"update Propertyupdate"}
PATCH Patch Update Configsearchservice/config/patch {"properties":[{"name":"historicalsaleboostingpercentage","locale":"en_US","value":"60"}]}
PUT Update Attributesearchservice/attribute/update {"attributeId":"123","filterable":"NONE","searchWeightage":0,"searchable":"NONE","sortable":"NONE","suggestable":false,"suggestionWeightage":0,"values":[{"displayName":"Offers","locale":"en_US"}]}
PUT Update Config Propertiessearchservice/configproperties/update {"name":"historicalsaleboostingpercentage","locale":"en_US","value":"update Propertyupdate"}
PUT Update Configsearchservice/config/update {"properties":[{"name":"historicalsaleboostingpercentage","locale":"en_US","value":"60"}]}

Shipping

HTTP MethodCall detailEvent TypeResponse Payload
POSTShipping Calculationshippingservice/shipping/calculation{"cartValue":0,"deliveryAddress":{"addressLine1":"3/1","addressLine2":"st.patrick's avenue","addressLine3":"Andaman","addressVersion":0,"canReceiveSMS":true,"city":"Andhaman","companyName":"inasolutions","country":"INDIA","county":"string","email":"string@ddfg.com","firstName":"INA","lastName":"solutions","middleName":"for","mobile":"1213123","phone":"3123243","state":"Andhaman","storeId":"21","zip":"11233"},"deliveryType":"DIGITAL","itemDetails":[{"itemDeliveredAlone":true,"itemDeliveryAddress":{"addressLine1":"2-venu street","addressLine2":"trichy","addressLine3":"trichy","addressVersion":0,"canReceiveSMS":true,"city":"trichy","companyName":"afwqhd","country":"india","county":"string","email":"string@d.com","firstName":"string1","lastName":"string2","middleName":"stringsa","mobile":"23234235","phone":"11232435","state":"tamil nadu","storeId":"34","zip":"636345"},"itemDeliveryType":"DIGITAL","itemId":"id120","itemProperties":{"additionalProp1":"string1","additionalProp2":"string2","additionalProp3":"string2"},"itemQuantity":0,"itemVersion":0,"shippingClass":"string","sku":[{"productId":"string123","skuDimension":{"height":0,"length":0,"unit":"string","width":0},"skuDiscount":0,"skuId":"string","skuName":"string","skuPrice":0,"skuQuantity":0,"skuType":"BUNDLE","skuWeight":{"unit":"string","value":0}}]}],"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"shippingDetails":{"calculationTime":0,"cartShippingMethods":[{"cost":0,"description":"string","expectedDaysForDelivery":0,"expectedDeliveryTime":0,"name":"string","properties":{},"shippingMethodId":"method1","taxIncluded":true,"taxationId":"string"}],"itemShippingDetails":[{"itemId":"string","itemShippingMethods":[{"cost":0,"description":"string","expectedDaysForDelivery":0,"expectedDeliveryTime":0,"name":"string","properties":{},"shippingMethodId":"string","taxIncluded":true,"taxationId":"string"}]}],"providedBy":"string","responseCode":"string","responseMessage":"string"},"shippingId":"001"}

Subscription

HTTP MethodCall Detail Event Type Response Payload
PUT Update Subscription Preference subscriptionservice/preference/update {"addressId":4,"clientSubscriptionId":null,"collectionId":18798,"deliveryPeriod":2,"lastOrderStatus":null,"orderProcessingDate":15,"paymentId":"payment123","shippingId":4,"shippingInstruction":"string","shippingMethod":"string","shippingType":"string","userId":"1677402422974"}
DELETE Delete Subscription subscriptionservice/subscription/delete No payload
DELETE Delete Subscription Preference subscriptionservice/preference/delete No payload
POST Create Instance subscriptionservice/instance/create No payload
PATCH Patch Update Instance subscriptionservice/instance/patchupdate [{"action":"COMPLETED","actionDate":1123336655988,"instanceSeq":1,"messages":{"OrderProcessed":"Success","OrderCreated":"Success","NotificationSent":"Success"},"orderId":"myorder1","subscriptionId":56253}]
POST Create Subscription Preference subscriptionservice/preference/create {"description":"SubscriptionCollectionDescription3172","name":"Collectionname_1677402421484","properties":[{"name":"intervalToNotifyUser","value":"1"},{"name":"intervalToProcessForthComingOrder","value":"1"},{"name":"intervalToProcessFirstOrder","value":"1"},{"name":"calendarType","value":"BUSINESS"},{"name":"intervalType","value":"DAYS,WEEKS,MONTHS,YEARS"}],"status":"ACTIVE"}
PATCH Patch Update Instance Transaction subscriptionservice/instance/patchupdate {"actionDate":1123336655988,"messages":{"OrderProcessed":"Success","OrderCreated":"Success","NotificationSent":"Success"},"orderId":"myorder1"}
PATCH Patch Update Subscription subscriptionservice/subscription/patchupdate {"accountId":1001,"addressInfo":{"addressLine1":"SUITE 5A-120456","addressLine2":"799 E DRAGRAM","addressLine3":"New Town","addressVersion":0,"canReceiveSMS":false,"city":"TUCSON","companyName":"SKAVA","country":"USA","county":"AZ","email":"test@skava.com","firstName":"Skava","lastName":"Automation","middleName":"Test","mobile":"9876543210","phone":"5555551234","profileAddressId":"123","state":"AZ","storeId":"123","zip":"85705"},"firstDeliveryDate":1565825133155,"frequencyEndDate":1567825133155,"frequencyEndType":"NEVER","frequencyPeriod":1,"frequencyStartDate":1564725133155,"frequencyType":"MONTHS","itemInfo":[{"preparationPeriod":1,"price":100,"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"quantity":10,"skus":[{"id":"Sku123","name":"TOMS Shoes","optionalQuantity":1,"productId":"Product123","type":"DEFAULT"}]}],"paymentInfo":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"shippingInfo":{"deliveryPeriod":1,"instruction":"string","method":"string","type":"string"},"storeId":"store002","type":"VARIABLE_MULTI_ORDER","status":"CANCELED"}
POST Create Subscription subscriptionservice/subscription/create {"accountId":1001,"addressInfo":{"addressLine1":"2/5 karamadai","addressLine2":"aqse","addressVersion":1566546525000,"canReceiveSMS":false,"city":"Coimbatore","country":"US","email":"dilipkumar@skava.com","firstName":"Dilipkumar","id":227,"lastName":"Viswanathan","middleName":"","phone":"9789787222","state":"AZ","storeId":"1367","zip":"10001"},"firstDeliveryDate":1678265716152,"frequencyEndType":"NEVER","frequencyPeriod":4,"frequencyStartDate":1677401716167,"frequencyType":"DAYS","itemInfo":[{"preparationPeriod":1,"price":0,"properties":{"name":"string","additionalProp2":"string","additionalProp3":"string"},"quantity":2,"skus":[{"id":"110001110","name":"mens long sleeve micro thermal shirt","optionalQuantity":0,"productId":"110001","type":"DEFAULT"}]}],"paymentInfo":{"paymentId":"6022","paymentItemId":"3865","paymentType":"CREDITCARD"},"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"shippingInfo":{"deliveryPeriod":2,"id":227,"method":"Economy","type":"PHYSICAL"},"storeId":"store001","type":"VARIABLE_MULTI_ORDER"}
POST Create Bulk Subscription subscriptionservice/bulksubscription/create [{"accountId":1001,"addressInfo":{"addressLine1":"2/5 karamadai","addressLine2":"","addressVersion":1566546525000,"canReceiveSMS":false,"city":"Coimbatore","country":"US","email":"dilipkumar@skava.com","firstName":"Dilipkumar","id":227,"lastName":"Viswanathan","middleName":"","phone":"9789787222","state":"AZ","storeId":"1367","zip":"10001"},"firstDeliveryDate":1649163512000,"frequencyEndType":"NEVER","frequencyPeriod":2,"frequencyStartDate":1649163512000,"frequencyType":"MONTHS","itemInfo":[{"preparationPeriod":1,"price":0,"properties":{"name":"string","additionalProp2":"string","additionalProp3":"string"},"quantity":2,"skus":[{"id":"110001110","name":"mens long sleeve micro thermal shirt","optionalQuantity":0,"productId":"110001","type":"DEFAULT"}]}],"paymentInfo":{"paymentId":"6022","paymentItemId":"3865","paymentType":"CREDITCARD"},"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"shippingInfo":{"deliveryPeriod":2,"id":227,"method":"Economy","type":"PHYSICAL"},"storeId":"store001","type":"VARIABLE_MULTI_ORDER"},{"accountId":1001,"addressInfo":{"addressLine1":"2/5 karamadai","addressLine2":"","addressVersion":1566546525000,"canReceiveSMS":false,"city":"Coimbatore","country":"US","email":"dilipkumar@skava.com","firstName":"Dilipkumar","id":227,"lastName":"Viswanathan","middleName":"","phone":"9789787222","state":"AZ","storeId":"1367","zip":"10001"},"firstDeliveryDate":1649249912000,"frequencyEndType":"NEVER","frequencyPeriod":2,"frequencyStartDate":1649163512000,"frequencyType":"MONTHS","itemInfo":[{"preparationPeriod":1,"price":0,"properties":{"name":"string","additionalProp2":"string","additionalProp3":"string"},"quantity":2,"skus":[{"id":"110001110","name":"mens long sleeve micro thermal shirt","optionalQuantity":0,"productId":"110001","type":"DEFAULT"}]}],"paymentInfo":{"paymentId":"6022","paymentItemId":"3865","paymentType":"CREDITCARD"},"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"shippingInfo":{"deliveryPeriod":2,"id":227,"method":"Economy","type":"PHYSICAL"},"storeId":"store001","type":"VARIABLE_MULTI_ORDER"}]
DELETE Delete User Subscriptions subscriptionservice/usersubscription/delete No payload
PATCH Patch Update Bulk Instance subscriptionservice/bulkinstance/patch 
PATCH Patch Update Bulk Instance Transaction subscriptionservice/bulkinstancetransaction/patch {"actionDate":1123336655988,"messages":{"OrderProcessed":"Success","OrderCreated":"Success","NotificationSent":"Success"},"orderId":"myorder1"}
PATCH Patch Update User Subscription subscriptionservice/usersubscription/patch { "status" : "CANCELED" }

Storefront Orchestration

DescriptionHTTP MethodEvent TypeResponse Payload
Add a Customer to a Team for an AccountPATCHorchestration/update/account{ "id":"", "timestamp":1680066852687, "payload":{ "id":2, "accountId":2, "costCentreId":2, "name":"string", "description":"string", "status":"active", "teamBuyer":[ { "id":3264, "userId":"2856", "teamId":2, "accountId":2, "userActivationParam":null, "firstName":null, "lastName":null, "userName":null }, { "id":3, "userId":"6", "teamId":2, "accountId":2, "userActivationParam":null, "firstName":null, "lastName":null, "userName":null }, { "id":3265, "userId":"2857", "teamId":2, "accountId":2, "userActivationParam":"11a921dbff52773bbe3f6c0d2f83ed426d32b7f8ead6dd62c333dc96d98ec74f", "firstName":null, "lastName":null, "userName":null } ] }
Create a Cart by Cart TypePOSTorchestration/create/cartbytype [{"quantity":1,"skus":[{"skuId":"GM1000005","productId":"GM100 05","type":"DEFAULT","skuProperties":{"CategoryName":"special ","parentCategories":"game12"}}]}]
Update Cart AttributePATCHorchestration/update/cartbytype {"communicationPreference":{"firstName":"Equinox","lastName": "Skava","email":"equinox.skava@skava.com","phone":"23456789 02","zipCode":"10003","preferredContactMethod":"TEXT"}}
Add multiple Cart ItemsPOSTorchestration/addItems/tobagbytype[{"quantity":1,"skus":[{"skuId":"110001110","productId":"110001","type":"DEFAULT"}],"properties":{"preparationPeriod":"2"},"isSubscription":true,"subscription":{"frequencyPeriod":"1","frequencyType":"MONTHS"}}]
Add Multiple Payments in CartPOSTorchestration/create/cartpayments[{"id":"string","name":"test_payment123","isDefault":true,"status":"active","userId":"1","accountId":1,"billingAddress":{"profileAddressId":"3436123","addressId":3436123,"options":{"addAddressToProfile":false,"overrideAddressValidation":false,"useDefaultAddress":false,"setAsDefaultAddressInProfile":false},"firstName":"John","lastName":"Doe","middleName":"A","companyName":"Skava Systems","addressLine1":"1 Broad Way","addressLine2":"Suite 100","addressLine3":"Lake Township","city":"New York","state":"Illinois","county":"Lake","country":"US","zip":"60010","email":"someone@somemail.com","phone":"2536544564","mobile":"2334454433","canReceiveSMS":false,"validation":[{"type":"PHYSICAL","validated":true,"overridden":true,"recommendation":true}],"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"isDefault":true,"type":"BillingAddreess","deliveryInstruction":"string","addressVersion":0},"type":"CARD","valueType":"string","amount":100,"option":{"addPaymentToProfile":false,"useDefaultPayment":false,"setAsDefaultPaymentInProfile":false},"accountInfo":{"name":"John Doe","cardNumber":"r49g3qy54tr","type":"CASH","expiryMonth":"01","expiryYear":"2020","cvv":"123","id":0,"lastName":"smith","isDefault":true,"provider":"amex","token":"xyzabc","cardToken":"xyzabc","paymentToken":"xyzabc"},"isValid":true,"errorCode":"CNCOxxxxxx","errorResponse":"Payment is invalid","properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"chargePriority":"EFT","format":"Currency payment format","paymentItems":[{"paymentRefId":"123242342","status":"AUTHORIZED","transactionId":"124235435346","value":100,"cardInfo":{"name":"John Doe","cardNumber":"r49g3qy54tr","type":"CASH","expiryMonth":"01","expiryYear":"2020","cvv":"123","id":0,"lastName":"smith","isDefault":true,"provider":"amex","token":"xyzabc","cardToken":"xyzabc","paymentToken":"xyzabc"},"paymentItemId":"363464"}],"refundPriority":"test"}]
Update Multiple Payments in a CartPATCHorchestration/rest/allpatchpayment[{"type":"CREDITCARD","valueType":"CURRENCY","value":8.96,"amount":8.96,"option":{"addPaymentToProfile":false,"useDefaultPayment":"false","setAsDefaultPaymentInProfile":false},"accountInfo":{"cardNumber":"378282246310005","name":"John Doe","expiryMonth":"01","expiryYear":"51","cvv":"123"},"billingAddress":{"firstName":"John","lastName":"Doe","middleName":"A","companyName":"Skava Systems","addressLine1":"1 Broad Way","addressLine2":"Suite 100","addressLine3":"Lake Township","city":"New York","state":"NY","county":"Lake","country":"US","zip":"640001","email":"skavacheck@gmail.com","phone":"2536544564","mobile":"2334454433","canReceiveSMS":false,"validation":[{"type":"PHYSICAL","validated":true,"overridden":true}]}}]
Update a Payment in CartPATCHorchestration/update/cartpaymentbyidNo payload
Add Multiple Promocodes in CartPOSTorchestration/add/promocodestobag[{"code":"SFOITEMPEROFFER"}]
Create an Order from a CartPOSTorchestration/create/orderforcart{"notes":[{"createdby":"user1","createdtime":0,"description":"string"}],"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}}
Create SubscriptionPOSTorchestration/create/subscriptionsrest{"id":0,"userId":"string","accountId":"string","storeId":"string","status":"string","type":"string","frequencyType":"string","frequencyPeriod":0,"frequencyStartDate":0,"frequncyEndType":"string","frequencyEndDate":0,"firstDeliveryDate":0,"revisedDeliveryDate":0,"nextDeliveryEditFreezeDate":0,"nextNotifiatonDate":0,"nextOrderCreationDate":0,"nextDeliveryDate":0,"currentInstance":0,"lastOrderId":"string","lastOrderDate":0,"itemInfo":[{"price":0,"quantity":0,"preparationPeriod":0,"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"skus":[{"type":"BUNDLE","id":"110075278","name":"Mate Finish Tier","optionalSkuQuantity":"5.0","productId":"214006","skuProperties":"sku","skuQuantity":5}]}],"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"deliveryDetails":{"deliveryId":"353SDGDS24","isDeliveredAlone":true,"deliveryType":"DIGITAL","deliveryInstructions":"Leave it at the door steps","deliverOnOrBefore":153129361068312,"deliveryCharge":5.99,"totalDeliveryCharge":5.99,"store":{"storeId":"MyStore"},"address":{"profileAddressId":"3436123","addressId":3436123,"options":{"addAddressToProfile":false,"overrideAddressValidation":false,"useDefaultAddress":false,"setAsDefaultAddressInProfile":false},"firstName":"John","lastName":"Doe","middleName":"A","companyName":"Skava Systems","addressLine1":"1 Broad Way","addressLine2":"Suite 100","addressLine3":"Lake Township","city":"New York","state":"Illinois","county":"Lake","country":"US","zip":"60010","email":"someone@somemail.com","phone":"2536544564","mobile":"2334454433","canReceiveSMS":false,"validation":[{"type":"PHYSICAL","validated":true,"overridden":true,"recommendation":true}],"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"isDefault":true,"type":"BillingAddreess","deliveryInstruction":"string","addressVersion":0},"methods":[{"id":"Economy","name":"Economy Shipping","cost":10.99,"deliveryTime":1531284825860,"deliveryPeriod":5,"isTaxIncluded":false,"taxationId":"SHIPPING","isSelected":false}],"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}},"payments":[{"id":"string","name":"test_payment123","isDefault":true,"status":"active","userId":"1","accountId":1,"billingAddress":{"profileAddressId":"3436123","addressId":3436123,"options":{"addAddressToProfile":false,"overrideAddressValidation":false,"useDefaultAddress":false,"setAsDefaultAddressInProfile":false},"firstName":"John","lastName":"Doe","middleName":"A","companyName":"Skava Systems","addressLine1":"1 Broad Way","addressLine2":"Suite 100","addressLine3":"Lake Township","city":"New York","state":"Illinois","county":"Lake","country":"US","zip":"60010","email":"someone@somemail.com","phone":"2536544564","mobile":"2334454433","canReceiveSMS":false,"validation":[{"type":"PHYSICAL","validated":true,"overridden":true,"recommendation":true}],"properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"isDefault":true,"type":"BillingAddreess","deliveryInstruction":"string","addressVersion":0},"type":"CARD","valueType":"string","amount":100,"option":{"addPaymentToProfile":false,"useDefaultPayment":false,"setAsDefaultPaymentInProfile":false},"accountInfo":{"name":"John Doe","cardNumber":"r49g3qy54tr","type":"CASH","expiryMonth":"01","expiryYear":"2020","cvv":"123","id":0,"lastName":"smith","isDefault":true,"provider":"amex","token":"xyzabc","cardToken":"xyzabc","paymentToken":"xyzabc"},"isValid":true,"errorCode":"CNCOxxxxxx","errorResponse":"Payment is invalid","properties":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"},"chargePriority":"EFT","format":"Currency payment format","paymentItems":[{"paymentRefId":"123242342","status":"AUTHORIZED","transactionId":"124235435346","value":100,"cardInfo":{"name":"John Doe","cardNumber":"r49g3qy54tr","type":"CASH","expiryMonth":"01","expiryYear":"2020","cvv":"123","id":0,"lastName":"smith","isDefault":true,"provider":"amex","token":"xyzabc","cardToken":"xyzabc","paymentToken":"xyzabc"},"paymentItemId":"363464"}],"refundPriority":"test"}],"enableItemLevelProcessing":true}
Get Promotion for special ProductsPOSTorchestration/get/productbyidandpromotionNo payload
Customer LoginPOSTorchestration/login/{
"identity" : "6371679986205720",
"password" : <Password>
}
Create Loyalty Reward based on OptInPOSTorchestration/update/rewardsoptin{"blockRedemption":false,"status":"ACTIVE","notes":"string"}
Share a ListPOSTorchestration/share/listbyid{"name":"My Favlistname","type":"FAVORITES","itemType":"SKU","accessType":"PUBLIC" ,"properties":{"size":"limited list","length":"30"}}
Change Status for B2B Approval WorkflowPATCHorchestration/update/orderbyid{ "status":"Return_Submitted", "otherproperties": { "shipmentid": "id1234", "trackingurl": "sampleurl", "reasoncode": "Others", "reasonmessage": "cancelled" } }
Cancel an order itemDELETEorchestration/cancel/orderitem{"reasonCode": "R001",
"reasonMessage": "Wrongly placed order."
}
Return Order ItemPOSTorchestration/return/orderitem
Return an OrderPOSTorchestration/return/Order{"status":"return submitted","reason":{"reasonCode":"R_001","reasonMessage":"Return Submitted"}}
Process now subscription order for current month By preference IDPOSTorchestration/subscription/preferenceplaceorderrestNo payload
Patch User Subscription by IDPATCHorchestration/user/subscriptionpatchbyIdrest{"id":76, "firstName":"testfname", "lastName":"testlname", "middleName":"testmname", "companyName":"Skava Systems", "addressLine1":"1 front street", "addressLine2":"philadelphia", "addressLine3":"Lake Township", "city":"San Francisco", "state":"CA", "county":null, "country":"US", "zip":"1000", "email":"test01@mailinator.com", "phone":"7888888888", "mobile":"7888888888", "canReceiveSMS":false, "storeId":"5", "profileAddressId":null, "addressVersion":1680650414000 }
Subscription address validation and shipping method by preference IDPOSTorchestration/validate/addressgetshippingmethodrest{"id":76, "firstName":"testfname", "lastName":"testlname", "middleName":"testmname", "companyName":"Skava Systems", "addressLine1":"1 front street", "addressLine2":"philadelphia", "addressLine3":"Lake Township", "city":"San Francisco", "state":"CA", "county":null, "country":"US", "zip":"1000", "email":"test01@mailinator.com", "phone":"7888888888", "mobile":"7888888888", "canReceiveSMS":false, "storeId":"5", "profileAddressId":null, "addressVersion":1680650414000 }
Update all Subscriptions by User IDPATCHorchestration/update/allsubscriptionbyuseridrest{ "deliveryPeriod":0, "orderProcessingDate":4, "shippingId":"76", "shippingInstruction":"null", "shippingMethod":"null", "shippingType":"ECONOMY", "addressId":"76", "paymentId":"string", "lastOrderProcessingDate":0, "processNow":true, "lastOrderStatus":"string", "lastOrderStatusMessage":"string", "hasDonationRoundUp":"string", "donationProgramId":"string", "pvAssistEnabled":true, "pvAssistGoal":0}

Tax

HTTP MethodCall DetailEvent TypeResponse Payload
POSTTax Calculationtaxservice/taxcalculation/create{"billingAddress":{"addressLine1":"ini2tr","addressLine2":"57FB8Z8P","addressLine3":"XefZxtER","addressVersion":0,"canReceiveSMS":true,"city":"Naperville","companyName":"mh0OiLN8","country":"Tunisia","county":"Colombia","email":"shannon.cash@mail.edu","firstName":"Liberty","lastName":"Delgado","middleName":"Hedwig Hansen","mobile":"Sample 3","phone":"913-348-0779","state":"Kentucky","zip":"02458"},"currency":"Sample 3","deliverFromAddress":{"addressLine1":"ini2tr","addressLine2":"57FB8Z8P","addressLine3":"XefZxtER","addressVersion":0,"canReceiveSMS":true,"city":"Naperville","companyName":"mh0OiLN8","country":"Tunisia","county":"Colombia","email":"shannon.cash@mail.edu","firstName":"Liberty","lastName":"Delgado","middleName":"Hedwig Hansen","mobile":"Sample 3","phone":"913-348-0779","state":"Kentucky","zip":"02458"},"deliverToAddress":{"addressLine1":"ini2tr","addressLine2":"57FB8Z8P","addressLine3":"XefZxtER","addressVersion":0,"canReceiveSMS":true,"city":"Naperville","companyName":"mh0OiLN8","country":"Tunisia","county":"Colombia","email":"shannon.cash@mail.edu","firstName":"Liberty","lastName":"Delgado","middleName":"Hedwig Hansen","mobile":"Sample 3","phone":"913-348-0779","state":"Kentucky","zip":"02458"},"itemDetails":[{"deliverToAddress":{"addressLine1":"ini2tr","addressLine2":"57FB8Z8P","addressLine3":"XefZxtER","addressVersion":0,"canReceiveSMS":true,"city":"Naperville","companyName":"mh0OiLN8","country":"Tunisia","county":"Colombia","email":"shannon.cash@mail.edu","firstName":"Liberty","lastName":"Delgado","middleName":"Hedwig Hansen","mobile":"Sample 3","phone":"913-348-0779","state":"Kentucky","zip":"02458"},"id":"16","itemDeliveredAlone":false,"itemProperties":{"additionalProp1":"kz237P","additionalProp2":"7xEcd","additionalProp3":"CTm6veM9E"},"itemVersion":1012,"quantity":7,"shippingDiscount":12,"shippingPrice":25,"shippingTaxationId":"shiptax","skuDetails":[{"skuType":"BUNDLE","discount":21,"id":"F8Pptp","name":"qrnQv8ONaY","price":347,"productId":"69","taxationId":"52"}]}],"shippingDiscount":92.72,"shippingPrice":289.73,"shippingTaxationId":"NLyeSj2e","properties":{"additionalProp1":"kz237P","additionalProp2":"7xEcd","additionalProp3":"CTm6veM9E"},"taxId":"83","taxType":"PERCENTAGE"}

User

HTTP MethodCall Detail Event Type Response Payload
DELETE Delete User userservice/user/delete No payload
POST Create User userservice/user/create {"users":[{"addresses":[{"city":"LOS ANGELES","country":"USA","county":"Ferry","createdBy":9856,"default":true,"email":"abc@skava.com","firstName":"John","id":0,"lastName":"Smith","middleName":"John","overridden":false,"phone":9876543210,"properties":{"deliveryInstruction":"Call me from gate."},"state":"CALIFORNIA","street1":"E MAIN ST","street2":"SUITE 5A-1235","street3":"PHONEIX","type":"BillingAddreess","updatedBy":9856,"validated":false,"validatedOn":100000,"validationType":"testvalidationtype","zipCode":90001}],"collectionId":633,"credentials":{"password":<Password>,"securityQuestions":[{"answer":"Company name is skava","question":"What is your company name ?"}]},"customProperties":{"segment":"gold"},"dateOfBirth":"08-10-1990","email":"dev@skava.com","firstName":"john","gender":"male","guest":false,"id":0,"lastName":"smith","phoneNumber":1234567890,"photo":"string_url","preferences":"email","referenceAttribute":"string","referenceAttribute1":"string","referenceAttribute2":1,"status":"string","type":0,"userName":"testUserName1"}]}
PUT Update User userservice/user/update {"addresses":[{"city":"LOS ANGELES","country":"USA","county":"Ferry","createdBy":9856,"default":true,"email":"abc@skava.com","firstName":"John","id":0,"lastName":"Smith","middleName":"John","overridden":false,"phone":9876543210,"properties":{"deliveryInstruction":"Call me from gate."},"state":"CALIFORNIA","street1":"St.Patrick's Church","street2":"SUITE 5A-1235","street3":"PHONEIX","type":"BillingAddreess","updatedBy":9856,"validated":false,"validatedOn":100000,"validationType":"testvalidationtype","zipCode":90001}],"collectionId":0,"credentials":{"password":<Password>,"securityQuestions":[{"answer":"Company name is skava","question":"What is your company name ?"}]},"customProperties":{"segment":"gold"},"dateOfBirth":"08-10-1990","email":"dev@skava.com","firstName":"john","gender":"female","guest":false,"id":0,"lastName":"smith","phoneNumber":1234567890,"photo":"string_url","preferences":"email","referenceAttribute":"string","referenceAttribute1":"string","referenceAttribute2":1,"status":"ACTIVE","type":0,"userName":"testUserName"}
POST Create Addresses userservice/addresses/create {"type":"billing","firstName":"Chadwick","middleName":"k","lastName":"Cruz","phone":"1675041842","email":"Email_1677058799897@skava.com","street1":"933 SouthEllis Way","street2":"string","street3":"string","city":"Morrison","country":"Bolivia","county":"string","state":"Maine","zipCode":"cq-07330","validated":false,"overridden":true,"validationType":"SfmLIky","validatedOn":57,"createdBy":1,"updatedBy":1,"properties":null,"default":false}
POST Create Consent userservice/consent/create {"requiredFlag":true,"status":"INACTIVE","title":"225Consent07732RMD"}
POST Create Notes userservice/notes/create {"collectionId":1,"createdBy":1,"createdOn":"2023-02-23T03:10:09.436Z","description":"user order notes","id":0,"title":"Notes title","updatedBy":1,"updatedOn":"2023-02-23T03:10:09.436Z","userId":1}
POST Create User Consent userservice/userconsent/create {"userConsent":[{"browser":"IE","consentId":"285","device":"laptop","geoLocation":"Maldives","ipAddress":"245.6.0.111"}]}
DELETE Delete Address userservice/address/delete No payload
DELETE Delete Consent userservice/consent/delete No payload
DELETE Delete Notes userservice/notes/delete No payload
DELETE Delete User Consent userservice/userconsent/delete No payload
PUT Update Security Questionsuserservice/securityquestions/update[{"id":45360,"identity":"1981173809","type":1,"identityType":"DEFAULT","status":"ACTIVE"}, {"id":45361,"identity":"email_1677124735727@skava.com","type":1,"identityType":"DEFAULT","status":"ACTIVE"}, {"id":45362,"identity":"username_1677124735727_637-887-1573","type":1,"identityType":"DEFAULT","status":"ACTIVE"}]
PATCH Update User Password userservice/userpassword/patch 
PATCH Update Address userservice/address/update {"city":"LOS ANGELES","country":"USA","county":"Ferry","createdBy":9856,"default":true,"email":"abc@skava.com","firstName":"John","id":0,"lastName":"Smith","middleName":"John","overridden":false,"phone":9876543210,"properties":{"deliveryInstruction":"Call me from gate."},"state":"CALIFORNIA","street1":"St. Patrick's church","street2":"SUITE 5A-1235","street3":"PHONEIX","type":"BillingAddreess","updatedBy":9856,"validated":false,"validatedOn":100000,"validationType":"testvalidationtype","zipCode":90001}
POST Get all Security Questions userservice/securityquestions/get 

 

 

Revision History

2023-11-14| AN, SD – Merged the payload and event type.
2023-10-16| AN, SD – Created the page and updated for release 8.15.0.