All error responses follow this structure:
\n{\n \"status\": false,\n \"message\": \"Error message.\",\n \"error_code\": 1000\n}\n\nValidation errors may include a details field:
{\n \"status\": false,\n \"message\": \"Validation failed.\",\n \"error_code\": 1100,\n \"details\": {\n \"mobile\": [\"The mobile field is required.\"]\n }\n}\n\nThis API return all customers groups.
\ntoken : This parameter is mandatory. you can get it from shokolat panel in this link: https://my.shokolat.app/store/services/list
id : group id
name : group name
is_starting_group : boolean If the group is the default group the value is : 1 and else the value is 0
Example response on success:
\n{\n \"success\": true,\n \"result\": [\n {\n \"id\": 1,\n \"name\": \"گروه برنزی\",\n \"is_starting_group\": 1\n },\n {\n \"id\": 2,\n \"name\": \"طلایی\",\n \"is_starting_group\": 0\n }\n ]\n}\n\nExample response on failure:
\n{\n \"success\": false,\n \"message\": \"token is not valid\"\n}\ntoken is mandatory
\n","type":"text/plain"},"key":"token","value":""}],"variable":[]}},"response":[],"_postman_id":"7dd3414a-9d80-4f9d-97de-14d4aedba486"}],"id":"ef3c8fed-6d00-4bc0-b793-34390e162291","_postman_id":"ef3c8fed-6d00-4bc0-b793-34390e162291","description":""},{"name":"Customers","item":[{"name":"PushCustomers","id":"b57cffa1-bb64-423e-ab5a-5d762596d732","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"data\": [\n {\n \"mobile\": \"09000000000\",\n \"email\": \"\",\n \"group_id\": \"\",\n \"name\": \"test\",\n \"family\": \"\",\n \"gender\": \"\",\n \"national_code\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"birthday\": \"\",\n \"tags\": [],\n \"referralCode\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://my.shokolat.app/api/webhook/v3/push_customers","description":"You can send a list of customers to this API .Shokolat will registering the customers and return customer_id .
We recommend that save the customer_id in your customers table for later use.
Also you can use this API for registering one customer.
\nImportant note:
\nAt least , one of the mobile or email is necessary and mandatory.
If you set only email parameter , the mobile value will register by 09000000000 value.
token: mandatory , shokolat token
data : you must set your parameters in data array.
mobile : must be 11 digits. sample: 09123456789
email : valid email. sample : info@shokolat.app
group_id : optional . If you want to register the customer in a group, you can set group_id. shokolat will register customer in default group if this parameter was not set.
name : optional
family : optional
gender : optional. only give \"male\" or \"female\" value.
national_code : optional . numeric
address : optional
city : optional
province : optional
birthday : optional. must be Jalalian date with this format: YYYY-mm-dd sample: 1364-12-22
tags: optional . customer tag ids in array.sample: [1,2,9]
note: You can get the list of tags from PullCustomersTags API and.
Sample request:
\n{\n \"token\" : \"\",\n \"data\" : [\n {\n \"mobile\" : \"09122566137\",\n \"email\" : \"almaitco@gmail.com\",\n \"group_id\" : \"1\",\n \"name\" : \"مهران\",\n \"family\" : \"سعادت\",\n \"gender\" : \"male\",\n \"national_code\" : \"1234567890\",\n \"address\" : \"خیابان میرزای شیرازی\",\n \"city\" : \"تهران\",\n \"province\" : \"تهران\",\n \"birthday\" : \"1364-12-22\",\n \"tags\" : [1,2,9]\n },\n ]\n}\n\nSample response on success:
\n{\n \"success\": true,\n \"result\": {\n \"registered_customers\": [\n {\n \"mobile\": \"09123456789\",\n \"email\": \"almaitco@gmail.com\",\n \"customer_id\": 45\n }\n ],\n \"not_registered_customers\": [\n {\n \"mobile\": \"09654\",\n \"email\": \"abc@hjk\"\n }\n ],\n \"exists_customers\": [\n {\n \"mobile\": \"09122566137\",\n \"customer_id\": 21\n }\n ]\n }\n}\n\nregistered_customer :
This array contains successfully registered customers.
\ncustomer_id : customer id in shokolat.
not_registered_customers :
This array contains unsuccessful register customer.
\nIf registration process contains error or parameters was incorrect, the data will show in this array.
\nexists_customers :
This array contains exists customers of your list.
\nIf any customer exists by mobile or email , shokolat will not register it again and return the list of exists customers.
This API return all customers.
\nAlso you can get a group's customers by set group_id parameter.
Each page contains 50 records and you can access to other pages by set page parameter.
token : Mandatory
group_id : Optional
page : Optional - page number
Response sample on success:
\n{\n \"success\": true,\n \"result\": [\n {\n \"customer_id\": 1,\n \"group_id\": 1,\n \"group_name\" : \"طلایی\",\n \"name\": \"مهران\",\n \"family\": \"سعادت\",\n \"mobile\": \"09122566137\",\n \"email\": almaitco@gmail.com,\n \"national_code\": null,\n \"gender\": \"male\",\n \"birthday\": \"1364-12-22\",\n \"address\": null,\n \"province\": \"تهران\",\n \"city\": \"تهران\",\n \"credit_in_store\": \"4972000\",\n \"customerCards\": [\n \"68864008783995933\",\n \"7884845257646094\",\n \"32741703244636346\"\n ]\n },\n ],\n \"totalCustomers\": 150,\n \"currentPage\": 1,\n \"hasMorePages\": true\n}\n\nResponse sample on failure:
\n{\n \"success\": false,\n \"message\": \"group_id not found\"\n}\n\n{\n \"success\": false,\n \"message\": \"token is not valid\"\n}\n\ntoken is mandatory
\n","type":"text/plain"},"key":"token","value":""},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"group_id","value":""},{"description":{"content":"Optional- page number
\n","type":"text/plain"},"key":"page","value":null}],"variable":[]}},"response":[],"_postman_id":"8c97be3e-bc2f-4708-a9d4-8258b0bcaa89"},{"name":"PutCustomers","id":"09489c4a-1c88-4e8f-b68f-7aee3da2344f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"data\": [\n {\n \"customer_id\": \"\",\n \"mobile\": \"\",\n \"cardNumber\": \"\",\n \"email\": \"\",\n \"change_list\": [\n {\n \"name\": \"\",\n \"family\": \"\",\n \"mobile\": \"\",\n \"email\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"national_code\": \"\",\n \"description\": \"\",\n \"group_id\": \"\"\n }\n ]\n },\n {\n \"customer_id\": \"\",\n \"change_list\": [\n {\n \"name\": \"\",\n \"family\": \"\",\n \"mobile\": \"\",\n \"email\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"address\": \"\",\n \"phone\": \"\",\n \"national_code\": \"\",\n \"description\": \"\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://my.shokolat.app/api/webhook/v3/put_customers","description":"You can update customers info by this Api.
\nThis Api can use for one or many customers at same time.
\nYou can use at least one of `mobile` , `email` , `customer_id` to find a customer and making change for it.
\nThe order of priority of the parameters is as follows:
\ncustomer_id
mobile
cardNumber
email
change_list array : you must put the parameters that need to be changed in this array.
Note: You don't have to enter all the parameters and you can set only the parameters that need to be changed.
\n{\n \"token\" : \"\",\n \"data\" : [\n {\n \"customer_id\" : \"\",\n \"mobile\" : \"\",\n \"email\" : \"\",\n \"change_list\" : [\n {\n \"name\" : \"\",\n \"family\" : \"\",\n \"mobile\" : \"\",\n \"email\" : \"\",\n \"city\" : \"\",\n \"province\" : \"\",\n \"address\" : \"\",\n \"phone\" : \"\",\n \"national_code\" : \"\",\n \"description\" : \"\",\n \"group_id\": \"\"\n }\n ]\n },\n {\n \"customer_id\" : \"\",\n \"change_list\" : [\n {\n \"name\" : \"\",\n \"family\" : \"\"\n }\n ]\n }\n ]\n}\n\nYou can delete one or some customers by this API.
\ndata array : customers arrays must place in this array.
customer_id array : delete customers by customer_id.
mobile array : delete customers by mobile no.
email array : delete customers by email address.
{\n \"token\": \"\",\n \"data\": [\n {\n \"customer_id\": [\n 1,\n 65\n ],\n \"mobile\": [\n \"09122566137\",\n \"09305547040\"\n ],\n \"email\": [\n \"mehran@saadat.org\",\n \"sample@test.com\"\n ]\n }\n ]\n}\n\n{\n \"successful_deleted\": [\n {\n \"mobile\": \"09122566137\"\n }\n ],\n \"errors\": [\n {\n \"customer_id\": 1,\n \"error\": \"customer not found\"\n },\n {\n \"mobile\": \"0912365\",\n \"error\": \"mobile format not correct\"\n },\n {\n \"mobile\": \"09122566117\",\n \"error\": \"customer not found\"\n },\n {\n \"email\": \"mehran@saadat.org\",\n \"error\": \"customer not found\"\n },\n {\n \"mobile\": \"chgh@fgh\",\n \"error\": \"email format not correct\"\n }\n ]\n}\n\nYou can get full details of a customer by this API.
\nPlus the customer profile details , you can get the credits and points of the customer.
\ntoken : This parameter is mandatory.
At least one of these parameters is required:
\ncustomer_id : optional - shokolat customer_id
mobile : optional - sample 09123456789
email : optional - sample@shokolat.app
card_number : optional
{\n \"success\": true,\n \"result\": {\n \"name\": \"مهران\",\n \"family\": \"سعادت\",\n \"mobile\": \"09122566137\",\n \"email\": \"mehran@saadat.org\",\n \"group_id\": null,\n \"group_name\": null,\n \"birthday\": \"1364-12-22\",\n \"gender\": \"male\",\n \"national_code\": \"1234567890\",\n \"registration_code\": null,\n \"address\": \"خیابان میرزای شیرازی\",\n \"city\": \"تهران\",\n \"province\": \"تهران\",\n \"points\": 26,\n \"points_can_use\": 26,\n \"credit_in_store\": \"100,000\",\n \"credit_in_this_branch\": \"6,000\"\n }\n}\n\ntoken is mandatory
\n","type":"text/plain"},"key":"token","value":null},{"disabled":true,"key":"customer_id","value":""},{"disabled":true,"description":{"content":"09123456789
\n","type":"text/plain"},"key":"mobile","value":""},{"disabled":true,"description":{"content":"\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"card number
\n","type":"text/plain"},"key":"card_number","value":""}],"variable":[]}},"response":[],"_postman_id":"739c44db-a396-4e79-a584-bb380eb8f271"}],"id":"f45157fd-46a3-4771-8995-abdf73a7f7b6","_postman_id":"f45157fd-46a3-4771-8995-abdf73a7f7b6","description":""},{"name":"Tags","item":[{"name":"PullCustomersTags","id":"cc804219-9aab-4d70-9761-434759cc9790","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.shokolat.app/api/webhook/v3/customers/tags/pull?token","urlObject":{"protocol":"https","path":["api","webhook","v3","customers","tags","pull"],"host":["my","shokolat","app"],"query":[{"key":"token","value":null}],"variable":[]}},"response":[],"_postman_id":"cc804219-9aab-4d70-9761-434759cc9790"}],"id":"3d3bd290-42e3-468c-bba6-7e08b99e28e5","_postman_id":"3d3bd290-42e3-468c-bba6-7e08b99e28e5","description":""},{"name":"Cards","item":[{"name":"PullCustomerCards","id":"7384da14-c673-40da-8973-0fb964e7243d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"my.shokolat.app/api/webhook/v3/customer/cards/pull?token=&customerId=&mobile=","urlObject":{"path":["api","webhook","v3","customer","cards","pull"],"host":["my","shokolat","app"],"query":[{"key":"token","value":""},{"key":"customerId","value":""},{"key":"mobile","value":""}],"variable":[]}},"response":[],"_postman_id":"7384da14-c673-40da-8973-0fb964e7243d"},{"name":"PushCustomerCard","id":"4447329c-395f-4e98-be03-b98078059970","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"data\": {\n \"customerId\": \"\",\n \"mobile\": \"09122566137\",\n \"cardNumber\": \"123456789\",\n \"password\": \"1111\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"my.shokolat.app/api/webhook/v3/customer/card/push","urlObject":{"path":["api","webhook","v3","customer","card","push"],"host":["my","shokolat","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"4447329c-395f-4e98-be03-b98078059970"},{"name":"ChangeCardPassword","id":"a7ca02fa-cdcd-48e0-baee-6558f71f103e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"data\": {\n \"customerId\": \"\",\n \"mobile\": \"09122566137\",\n \"cardNumber\": \"123456789\",\n \"oldPassword\": \"1111\",\n \"newPassword\": \"2222\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"my.shokolat.app/api/webhook/v3/customer/card/change_password","urlObject":{"path":["api","webhook","v3","customer","card","change_password"],"host":["my","shokolat","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7ca02fa-cdcd-48e0-baee-6558f71f103e"},{"name":"DeleteCustomerCard","id":"f92f97aa-94df-4829-9466-971d42ff2468","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"token\": \"\",\n \"data\": {\n \"cardNumber\": \"123456789\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"my.shokolat.app/api/webhook/v3/customer/card/delete","urlObject":{"path":["api","webhook","v3","customer","card","delete"],"host":["my","shokolat","app"],"query":[],"variable":[]}},"response":[],"_postman_id":"f92f97aa-94df-4829-9466-971d42ff2468"}],"id":"e0a5b785-2129-4b59-a015-571a473ee769","_postman_id":"e0a5b785-2129-4b59-a015-571a473ee769","description":""}],"id":"8b5dfa55-a604-48ff-b82b-e4e7c904ce58","_postman_id":"8b5dfa55-a604-48ff-b82b-e4e7c904ce58","description":""},{"name":"Products","item":[{"name":"Product Group","item":[{"name":"PullProductGroups","id":"ce8ae376-57be-4ec0-affe-e80512464326","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.shokolat.app/api/webhook/v3/products/groups/pull?token","description":"This API return all product groups.
\nparameters:
\ntoken : mandatory
{\n \"success\": true,\n \"result\": [\n {\n \"product_group_id\": 1,\n \"product_group_name\": \"گروه محصولات 5\"\n },\n {\n \"product_group_id\": 2,\n \"product_group_name\": \"گروه محصولات 8\"\n },\n {\n \"product_group_id\": 3,\n \"product_group_name\": \"گروه محصولات 5\"\n },\n {\n \"product_group_id\": 4,\n \"product_group_name\": \"گروه محصولات 1\"\n },\n {\n \"product_group_id\": 5,\n \"product_group_name\": \"گروه محصولات 9\"\n },\n {\n \"product_group_id\": 6,\n \"product_group_name\": \"گروه محصولات 7\"\n },\n {\n \"product_group_id\": 7,\n \"product_group_name\": \"گروه محصولات 1\"\n },\n {\n \"product_group_id\": 8,\n \"product_group_name\": \"گروه محصولات 7\"\n },\n {\n \"product_group_id\": 9,\n \"product_group_name\": \"گروه محصولات 6\"\n },\n {\n \"product_group_id\": 10,\n \"product_group_name\": \"گروه محصولات 10\"\n }\n ]\n}\n\nparameters:
\ntoken:
\ndata: [ \"product_group_name\" : \" \"]
\n{\n \"token\" : \"\",\n \"data\" : [\n {\n \"product_group_name\" : \"طلایی\"\n },\n {\n \"product_group_name\" : \"Bronze 123\"\n }\n ]\n}\n\n{\n \"success\": true,\n \"result\": [\n {\n \"product_group_name\": \"طلایی\",\n \"product_group_id\": 11\n },\n {\n \"product_group_name\": \"Bronze 123\",\n \"product_group_id\": 12\n }\n ]\n}\n\nThis API will update a product group.
\nYou can update only the name of product group.
\nParameters:
\ntoken
data: [product_group_id, product_group_name]
This API return the list of all products in a branch with full details.
\nParameter:
\ntoken
{\n \"success\": true,\n \"result\": [\n {\n \"product_id\": 1,\n \"name\": \"محصول 5\",\n \"price\": 7580985,\n \"barcode\": \"1234567890\",\n \"description\": \",bjgjvh\",\n \"stock_count\": 10,\n \"product_groups_id\": [\n [\n 1\n ]\n ]\n },\n {\n \"product_id\": 4,\n \"name\": \"محصول 2\",\n \"price\": 5111581,\n \"barcode\": \"2319\",\n \"description\": null,\n \"stock_count\": -4,\n \"product_groups_id\": [\n [\n 2\n ]\n ]\n },\n {\n \"product_id\": 5,\n \"name\": \"محصول 6\",\n \"price\": 4287163,\n \"barcode\": null,\n \"description\": null,\n \"stock_count\": 0,\n \"product_groups_id\": [\n [\n 8\n ]\n ]\n },\n {\n \"product_id\": 6,\n \"name\": \"محصول 3\",\n \"price\": 7747202,\n \"barcode\": null,\n \"description\": null,\n \"stock_count\": -3,\n \"product_groups_id\": [\n [\n 5\n ],\n [\n 7\n ]\n ]\n },\n {\n \"product_id\": 7,\n \"name\": \"محصول 1\",\n \"price\": 6214046,\n \"barcode\": null,\n \"description\": null,\n \"stock_count\": 0,\n \"product_groups_id\": [\n [\n 2\n ],\n [\n 3\n ]\n ]\n },\n {\n \"product_id\": 8,\n \"name\": \"محصول 6\",\n \"price\": 5296723,\n \"barcode\": null,\n \"description\": null,\n \"stock_count\": 154,\n \"product_groups_id\": [\n [\n 8\n ]\n ]\n },\n {\n \"product_id\": 9,\n \"name\": \"محصول 7\",\n \"price\": 5222673,\n \"barcode\": null,\n \"description\": null,\n \"stock_count\": -3,\n \"product_groups_id\": []\n },\n {\n \"product_id\": 10,\n \"name\": \"محصول 4\",\n \"price\": 5484608,\n \"barcode\": null,\n \"description\": null,\n \"stock_count\": -1,\n \"product_groups_id\": [\n [\n 9\n ]\n ]\n }\n ]\n}\n\nmandatory
\n","type":"text/plain"},"key":"token","value":null}],"variable":[]}},"response":[],"_postman_id":"451e9907-5268-4576-9b48-c16b0ba6611f"},{"name":"PushProducts","id":"65d2613f-2a50-427e-9a42-7c384da0f067","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"token\" : \"\",\n \"data\" : [\n {\n \"product_group_id\" : \"\",\n \"name\" : \"\",\n \"barcode\" : \"\",\n \"price\" : \"\",\n \"description\" : \"\",\n \"stock_count\" : \"\"\n }\n ]\n\n}","options":{"raw":{"language":"json"}}},"url":"https://my.shokolat.app/api/webhook/v3/products/push","description":"Sample request:
\n{\n \"token\" : \"4545fghhf456\",\n \"data\" : [\n {\n \"product_group_id\" : \"1\",\n \"name\" : \"پاور بانک\",\n \"barcode\" : \"12365498\",\n \"price\" : \"15000\",\n \"description\" : \"پاور بانک با ظرفیت 10000 \",\n \"stock_count\" : \"15\"\n },\n {\n \"product_group_id\" : \"1\",\n \"name\" : \"کیف زنانه\",\n \"barcode\" : \"6666\",\n \"price\" : \"258000\",\n \"description\" : \"کیف زنانه مدل چرمی\",\n \"stock_count\" : \"10\"\n }\n ]\n}\n\nSample Response:
\n{\n \"successfully_registered\": [\n {\n \"product_id\": 16,\n \"product_group_id\": 1,\n \"name\": \"کیف زنانه\",\n \"barcode\": \"6666\",\n \"stock_count\": \"10\",\n \"description\": \"کیف زنانه مدل چرمی\"\n }\n ],\n \"errors\": [\n {\n \"success\": false,\n \"barcode\": \"12365498\",\n \"message\": \"barcode is registered by another product\"\n }\n ]\n}\n\nBy this API you can get the amount of discount and etc before save the invoice.
\nFor Example, you need to know that the customer how much discount will give for entire invoice before saving the invoice.
\nParameters:
\ntoken
customerId -> if mobile is null , this parametes is mandatory
mobile -> if customerId is null , this parameter is mandatory
invoiceDate -> optional (if be null , current date-time will be apply)
amount -> mandatory
payByCreditAmount -> Optional (If you know how much the customer want to pay by credit, you cand set this parameters for advanced Loyalty plan proceess.)
cardNumber -> Optional. You can use cardNumber instead of customerId or mobile. if this parameter was set, you don't need to set cardNumber or customerId
Response:
\ndiscount -> amount of discount for this invoice
creditCanUse -> amount of customer's credits that can use to pay this invoice
cashBack -> amount of gift credit that add to customer's wallet for this invoice
earnPoints -> amount of points that customer can earn for this invoice
payableAmount -> Final amount to pay.
acceptedCreditToPayThisBuy -> If you set the payByCreditAmount, we process all conditions for paying by credit and return you accepted credit to pay as this parameter.
sample of response:
\n{\n \"status\": true,\n \"result\": {\n \"discount\": 100,\n \"creditCanUse\": 890000,\n \"cashBack\": 90,\n \"earnPoints\": 10,\n \"payableAmount\": 700,\n \"acceptedCreditToPayThisBuy\": 200\n }\n}\n\nBy this API you can send quick invoice to the shokolat and shokolat will process the invoice and give points,gift credit and discount.
\nQuick invoice have not any productId and only work with the sum .
Afrer calling the api , discount will calculate by system and and save in the invoice.
\nWe highly recommend you to use ProcessInvoiceQuick and get all of discount and credits of customer for the invoice befor using this API.
Parameters:
\ncustomerId : one of customerId or mobile is mandatory
mobile : one of customerId ,mobile or cardNumber is mandatory
invoiceDate : Optional .format: 1402/05/15 12:13 . If this parameter be null , the curent date time will be apply.
sum : mandatory . It's the sum of invoice before discount and pay by credit.
payByCreditAmount : must be 0 or amount of credit to pay invoice.
description : Optional.
cardNumber : Optional
cardPin : Optional (If you use cardNumber and payByCreditAmount is > 0 , you must set the card pin for credit withdraw transaction)
invoiceNumber : Optional. You can set your local invoice/order number
sample of response:
\n{\n \"success\": true,\n \"result\": {\n \"invoiceId\": 21,\n \"discount\": 1000,\n \"payedByCredit\": 500,\n \"payableAmount\": 2000,\n \"giftCreditAmount\": 0,\n \"giftCreditExpireDate\": null,\n \"points\": 0\n }\n}\n\nResponse fields:
\ndiscount : Amount of discount for invoice
payedByCredit : amount of credit that used for paying the invoice
payableAmount : amount of invoice that custopmer must pay.
giftCreditAmount: Gift credit for use on next buy.
giftCreditExpireDate : The expire date of gift credit.
points : the amount of points that customer gived for this invoice.
This api return all customer's credits in store with full details such as: creditExpireDate and branchCanUse
Request Parameters:
\ntoken
customerId
customerMobile
customerCard
Note: You can request by one of customer parametrs.For example if you set customerMobile , no need to set other parametrs except token.
token is mandatory
\nSample response:
\n{\n \"success\": true,\n \"result\": {\n \"totalCreditInStore\": \"36,624,000\",\n \"creditDetails\": [\n {\n \"creditAmount\": 36590000,\n \"creditExpireDate\": \"2023-10-25 23:59:59\",\n \"branchIdCanUse\": [\n \"شعبه مرکزی\",\n \"شعبه تهران\"\n ],\n \"description\": \"افزایش اعتبار دستی در فروشگاه بیدینگ شعبه ی شعبه مرکزی\"\n },\n {\n \"creditAmount\": 34000,\n \"creditExpireDate\": \"2023-10-21 23:59:59\",\n \"branchIdCanUse\": [\n \"شعبه مرکزی\"\n ],\n \"description\": \"اعتبار هدیه بابت خرید\"\n }\n ]\n }\n}\n\nShokolat token
\n","type":"text/plain"},"key":"token","value":null},{"description":{"content":"optional
\n","type":"text/plain"},"key":"customerId","value":null},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"customerMobile","value":null},{"disabled":true,"description":{"content":"optional
\n","type":"text/plain"},"key":"customerCard","value":null}],"variable":[]}},"response":[],"_postman_id":"140666da-ae5a-4687-8708-d46faf5835c7"},{"name":"PullCustomerCreditTransactions","id":"13d66b73-8cec-4fa5-a132-4f8a41be6476","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.shokolat.app/api/webhook/v3/transactions/pull/?token=&customerId=&customerMobile=","description":"Pull credit transactions for a customer.
\nParameters:
\ntoken : shokolat token
customerId : customer id in shokolat
customerMobile: customer's mobile. sample: 09122566137
Note: you can use one of customerId or customerMobile
Response:
\nincrease : 0 or 1 (0 for decreament and 1 for increment)
credit : amount of credit
branch_name: In which branch was credit increased or decreased?
sample result:
\n{\n \"success\": true,\n \"result\": [\n {\n \"increase\": 0,\n \"credit\": 2000,\n \"branch_name\": \"شعبه مرکزی\",\n \"description\": \"کاهش اعتبار بابت فاکتور شماره 15\",\n \"dateTime\": 1402-05-16 01:05\n },\n {\n \"increase\": 1,\n \"credit\": 1200000,\n \"branch_name\": \"شعبه مرکزی\",\n \"description\": \"افزایش اعتبار بابت هدیه خرید\",\n \"dateTime\": 1402-05-10 01:10\n }\n ]\n}\n\nCredit deposit for customer
\nparameters:
\ntoken: shokolat token
data array: you must provide parameters in data array
customerId: customer id
mobile: customer mobile
Note: Only one of the customerId or mobile should be set.
\ncreditAmount: the amount of credit that you want to deposit for customer
expireDate: the expire date of the credit. The date must be in shamsi and this format: YYYY-mm_dd
branchCanUse: ID of the branches where credit can be used. You can get the list of you store's branches by pullBranchList api. sample:\"branchCanUse\": [1,2]
description: Optional description.
Branch list
\nThis Api return the list of store's branches id and name.
\nsample response:
\n{\n \"success\": true,\n \"result\": [\n {\n \"branchId\": 1,\n \"branchName\": \"شعبه مرکزی\"\n },\n {\n \"branchId\": 2,\n \"branchName\": \"شعبه تهران\"\n }\n ]\n}\n