{"info":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","description":"

Who is SoftTouch?

In 1999, the time had come: SoftTouch was born. At that time it was unthinkable that the then one-man business would grow into what SoftTouch is today. \"Because I was responsible for the development, sales and installation of the POS system, I got to know the market through and through.\" This was the basis for the exceptional service we offer today.

It was in the year 2009 that the company experienced explosive growth: a new office with ample demonstration space was built, and new employees were hired. Today, SoftTouch has grown into a business with in-depth know-how of both POS systems and the fashion world.

What does this API?

This API is build using RESTful methods returning JSON and can be used to fetch and put data from and into the clients database.

How to retrieve an account id and token?

The client has to request an offer for using this API. As soon as they confirm this offer, a test environment can be provided. Once development is completed, we need customer aproval before live credentials can be provided. (There will also be a double check from SoftTouch as well, to check if everything is realistically in order when looking at the API calls.)

Any questions regarding the use of this API can be sent to dev@softtouch.be

The SoftTouch API does not work with web hooks. What follows are three simple steps to keep the web shop up to date with the current stock.

Full sync overnight

It is a good idea to synchronise all online products over night. The same can be done for the other product related models. Following models can be useful: stores, seasons, brands, categories, colors, sizetables and discounts. Make sure to set discount_date if the sync starts on the evening before. Like so the correct discounts can be displayed on the website.
A full sync should only be used overnight and perhaps on demand when something could be changed in the stock. The latter should not be used in a loop during the day or when the visitor clicks on an article. The following methods cover how to handle this in a better way.
As with every model the API will only fetch the first 100 products by default. This can be altered with the \"take\" parameter, which can receive an integer value with a maximum of 500. The \"skip\" parameter, which also takes an integer value, will ignore those first products and retrieve the following take-amount of products. For example “take”: 500 and “skip”: 1500 will retrieve 500 products starting from the 1501st.
An important note about nightly syncs: on our server side, a backup of the data is made during a certain point at night. As you can imagine this can lock the data and might result in calls with a connection error. It needs no saying that each call should always be validated on an expected result. It is even more true in this case.

Ten minute sync

Let us repeat an important statement. During the day it is overkill to do a full sync of the products and is strongly frowned upon. A better way to keep the stock up to date is to get the products every ten minutes with the parameter \"since\". Another parameter which is very useful here is the parameter “detail” with the value “stock”. For most web shops it should be sufficient to run this every ten minutes.

On click sync

Since it is very important, I will repeat myself once again. Never do a full sync during the day. Not even when a visitor visits a page. It is important however that the visitor sees the correct available stock. So when the visitor clicks through to a specific article it Is a good idea to get the product with the parameter “detail” and the value “stock”. Since the stock can still change before the visitor checks out, another check is advisable. It is not fun to disappoint a customer at this point, but better do it at this point than at the point where the articles are already paid.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5301532","collectionId":"f59c3410-b180-46ea-8714-23dfc77b0376","publishedId":"2s935iumQW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"28A9E0"},"publishDate":"2023-03-31T07:45:09.000Z"},"item":[{"name":"V1","item":[{"name":"Brands","item":[{"name":"Brands","event":[{"listen":"test","script":{"id":"5ea368ce-72b2-4748-9377-0c069bd35b76","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"88a8a0e4-4508-458b-b2a6-b7b417066c06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/brands?display=full","description":"

This endpoint fetches all brands as all calls it has to be done in steps with a maximum amount of 500 brands.

Used parameters:

display (full)
\n
take
\n
skip
\n

A brief explanation of return values:

key: The unique identifier
\n
name: The brand name
\n
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
\n
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.
\n

If display full is used some extra info is availble like the address and contact information.

This endpoint fetches a specific brand by id.

Used parameters:

display (full)
\n
take
\n
skip
\n

A brief explanation of return values:

key: The unique identifier
\n
name: The brand name
\n
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
\n
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.
\n

If display full is used some extra info is availble like the address and contact information.

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","brands"],"host":["api","softtouch","eu"],"query":[],"variable":[]}},"response":[{"id":"671429e9-b486-4c63-9292-f16f44e5594f","name":"Brands","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"5b6d895b0d33d38ff81a0ad12823ee9d11e58a1a"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"999\",\r\n \"name\": \"SoftTouch\",\r\n \"alias\": \"\",\r\n \"supplier\":\t \"\",\r\n \"address\": \"\", \r\n \"postal_code\": \"\", \r\n \"city\": \"\", \r\n \"country_iso\": \"\", \r\n \"telephone\": \"\", \r\n \"telephone_2\": \"\", \r\n \"fax\": \"\", \r\n \"email\": \"\", \r\n \"website\": \"\", \r\n \"vat\": \"\",\r\n \"category1\": \"0101\",\r\n \"category2\": \"0201\",\r\n \"category3\": \"0301\",\r\n \"category4\": \"0401\",\r\n \"category5\": \"0501\",\r\n \"miscellaneous\": \"\",\r\n \"margin\": 2.7, \r\n \"size_table_id\": 10,\r\n \"commercial_discount\": 1, \r\n \"on_customer_card\": true, \r\n \"customer_card_percentage\": 0, \r\n \"article_discount_allowed\": true,\r\n \"active\": true,\r\n \"stockbase\": false\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.softtouch.eu/1/accounts/1/brands","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","1","brands"],"query":[{"key":"id","value":"","description":"size:3","type":"text","disabled":true},{"key":"name","value":null,"description":"required","type":"text","disabled":true},{"key":"country_iso","value":null,"description":"size:2","type":"text","disabled":true},{"key":"email","value":null,"description":"email","type":"text","disabled":true},{"key":"category1","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category2","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category3","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category4","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category5","value":null,"description":"size:4","type":"text","disabled":true},{"key":"margin","value":null,"description":"numeric","type":"text","disabled":true},{"key":"size_table_id","value":null,"description":"size:2","type":"text","disabled":true},{"key":"commercial_discount","value":null,"description":"boolean","type":"text","disabled":true},{"key":"on_customer_card","value":null,"description":"boolean","type":"text","disabled":true},{"key":"customer_card_percentage","value":null,"description":"numeric","type":"text","disabled":true},{"key":"article_discount_allowed","value":null,"description":"boolean","type":"text","disabled":true},{"key":"active","value":null,"description":"boolean","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Fri, 23 Apr 2021 10:01:05 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6InJCbmJlcjdDbWhuVE5KenQ3VmxaUXc9PSIsInZhbHVlIjoiRXhcL1VOelFKMEdJQ1BYUE9KVWp2ajhYaG1iaHp3VzdYZVk3THlZRnpLempTWllFcmdEd1NaeHRIaUYxeFlkczkxcVc1OStad3Z4Mzl6aFZnMFVOTUdBPT0iLCJtYWMiOiI1Yzc2NDc4YzkzYjUyZTMzZDk5MzhhYTBjMmVmN2FhMjczOTdiZGNhYzVlYmQ5MmExMDk0MWQwMTg2ODNkMzM5In0%3D; expires=Fri, 23-Apr-2021 12:01:05 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"249\",\n \"name\": \"SoftTouch\",\n \"alias\": \"\",\n \"category1\": \"0101\",\n \"category2\": \"0201\",\n \"category3\": \"0301\",\n \"category4\": \"0401\",\n \"category5\": \"0501\"\n}"}],"_postman_id":"323d0a31-029e-4636-b156-9d187172f607"},{"name":"Brands/bulk_insert","event":[{"listen":"test","script":{"id":"5ea368ce-72b2-4748-9377-0c069bd35b76","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript","packages":{}}}],"id":"7e616b31-a607-4828-b3b4-0bbb6d20ab26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"brands\":[\r\n {\r\n \"id\": \"010\",\r\n \"name\": \"BulkImport1\",\r\n \"alias\": \"\",\r\n \"supplier\":\t \"\",\r\n \"address\": \"\", \r\n \"postal_code\": \"\", \r\n \"city\": \"\", \r\n \"country_iso\": \"\", \r\n \"telephone\": \"\", \r\n \"telephone_2\": \"\", \r\n \"fax\": \"\", \r\n \"email\": \"\", \r\n \"website\": \"\", \r\n \"vat\": \"\",\r\n \"category1\": \"0101\",\r\n \"category2\": \"0201\",\r\n \"category3\": \"0301\",\r\n \"category4\": \"0401\",\r\n \"category5\": \"0501\",\r\n \"miscellaneous\": \"\",\r\n \"margin\": 2.7, \r\n \"size_table_id\": 10,\r\n \"commercial_discount\": 1, \r\n \"on_customer_card\": true, \r\n \"customer_card_percentage\": 0, \r\n \"article_discount_allowed\": true,\r\n \"active\": true\r\n },\r\n {\r\n \"id\": \"011\",\r\n \"name\": \"BulkImport2\",\r\n \"alias\": \"\",\r\n \"supplier\":\t \"\",\r\n \"address\": \"\", \r\n \"postal_code\": \"\", \r\n \"city\": \"\", \r\n \"country_iso\": \"\", \r\n \"telephone\": \"\", \r\n \"telephone_2\": \"\", \r\n \"fax\": \"\", \r\n \"email\": \"\", \r\n \"website\": \"\", \r\n \"vat\": \"\",\r\n \"category1\": \"0101\",\r\n \"category2\": \"0201\",\r\n \"category3\": \"0301\",\r\n \"category4\": \"0401\",\r\n \"category5\": \"0501\",\r\n \"miscellaneous\": \"\",\r\n \"margin\": 2.7, \r\n \"size_table_id\": 10,\r\n \"commercial_discount\": 1, \r\n \"on_customer_card\": true, \r\n \"customer_card_percentage\": 0, \r\n \"article_discount_allowed\": true,\r\n \"active\": true\r\n }\r\n ]\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/brands/bulk_insert","description":"

To create multiple new brands this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

To update a brand this endpoint should be used.

PARAMS:

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

The brands endpoint can be used to fetch brands/ suppliers. Those contain basic information like the name, alias, status. A brand can be linked to a product by it's key.

\n","event":[{"listen":"prerequest","script":{"id":"cae1ebe0-8137-4254-8d9a-ac52ebff7ad7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"06177007-0711-4aad-9b08-6e19e73006aa","type":"text/javascript","exec":[""]}}],"_postman_id":"2f48d36d-5b8d-4c77-9c94-1c0fbb3938ea","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Brand categories","item":[{"name":"Brand_categories","event":[{"listen":"test","script":{"id":"5ea368ce-72b2-4748-9377-0c069bd35b76","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"e3929e2c-b9e8-43d3-8341-bf6428361256","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/brand_categories","description":"

The brand_categories endpoint can be used with the brand endpoint, linked by the key.

The categories used are defined by the client and usage should be discussed with the client as such.

soap;

\n","type":"text/plain"},"key":"display","value":"soap"},{"disabled":true,"key":"take","value":"500"},{"disabled":true,"key":"skip","value":"0"}],"variable":[]}},"response":[{"id":"a9e84c32-b285-4037-ae68-2da35d55b592","name":"Brand_categories","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/brand_categories","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","brand_categories"],"query":[{"key":"display","value":"soap","description":"soap;","type":"text","disabled":true},{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Mon, 24 Apr 2023 07:00:23 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlNORk04QVdvR3VZSzFhK1BiczFIU1E9PSIsInZhbHVlIjoiWXlVOU9TdkV0RzNJRXRcL05xTmM1YW1rNEFkU2R3QWRVeUliTXpJR1kzanhFWVEyeDlPSU1JcXpaUnBcLzR2RCs1YkRBNWZUTUExeStcL2QrdkRYN0VcL0JRPT0iLCJtYWMiOiJiZjlhOTg2YzI3MDA0Y2QwZWE2Zjk4N2E5YTE2Y2U2NjU2NmI2NmVkYzFkNzZiZDI4NTBlNzFkYWUxMDM5ZmIwIn0%3D; expires=Mon, 24-Apr-2023 09:00:23 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": \"0101\",\n \"group\": \"01\",\n \"description\": \"Placeholder category 1\",\n \"active\": true\n },\n {\n \"key\": \"0102\",\n \"group\": \"01\",\n \"description\": \"Placeholder category 1\",\n \"active\": true\n },\n {\n \"key\": \"0201\",\n \"group\": \"02\",\n \"description\": \"Placeholder category 2\",\n \"active\": true\n }\n]"}],"_postman_id":"e3929e2c-b9e8-43d3-8341-bf6428361256"}],"id":"3cc89be6-11fc-47c0-a0fa-f07ff7b2a257","_postman_id":"3cc89be6-11fc-47c0-a0fa-f07ff7b2a257","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Categories","item":[{"name":"Categories","event":[{"listen":"test","script":{"id":"4d77d947-92dc-4813-a71b-1ca51ee9cfb9","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript","packages":{}}}],"id":"fa712a3e-2879-460b-806d-fe5954970804","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/categories","description":"

This endpoint fetches all categories as all calls it has to be done in steps with a maximum amount of 500 categories.

Used parameters:

display (full)
take
skip
group_ids (the level of the category)

A brief explanation of return values:

key: The unique identifier
group_id: The level of the category
description: The name of the category
alias: An alias which can be used to display on the webshop.
lang1-5: Can be used as a different language for the category
active: boolean if this category is active or not, a category that is inactive is still visible but can't be attached to new products

CommaSeperated: 01,02,03,04,05,06,07,08,09,10,11,12,13,14,15,16,17,18,19,20

\n","type":"text/plain"},"key":"group_ids","value":"01"}],"variable":[]}},"response":[{"id":"7834b2f4-1d5a-4f78-874d-502d6e136ab0","name":"Categories","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/categories","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","categories"],"query":[{"key":"display","value":"full","disabled":true},{"key":"take","value":"500","disabled":true},{"key":"skip","value":"0","disabled":true},{"key":"group_ids","value":"02","description":"CommaSeperatedIn:01,02,03,04,05,06,07","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Tue, 20 Jun 2023 07:29:06 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IklFc1dWRjVxZUJmMzlmTlBPVTdCaWc9PSIsInZhbHVlIjoiK2JrZVNmdUZ2SkJyRk90RVlwcGZZMVc2QUZzRTk0Mmp1a3h1dElNNWlvOGJ4Mk9Ld0NxaGZkMkt1T0t2N1NtKzcrazNcL1wvWTEyYVZlY1ZzVHJaUlVQQT09IiwibWFjIjoiNDgwOWI3ZDE1NTUzNDBiOWIyNTU4ZjA5YjBkOTRkZDUzZTVhYzlhY2ZmNjc4NmJkYTEwNThmMzhkYWNhZGJmYyJ9; expires=Tue, 20-Jun-2023 09:29:06 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": \"0101\",\n \"group_id\": \"01\",\n \"description\": \"Heren\",\n \"alias\": \"Heren\",\n \"lang1\": \"Heren\",\n \"lang2\": \"Men\",\n \"lang3\": \"Hommes\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n },\n {\n \"key\": \"0102\",\n \"group_id\": \"01\",\n \"description\": \"Dames\",\n \"alias\": \"Dames\",\n \"lang1\": \"Dames\",\n \"lang2\": \"Ladies\",\n \"lang3\": \"Femmes\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n },\n {\n \"key\": \"0201\",\n \"group_id\": \"02\",\n \"description\": \"Kleding\",\n \"alias\": \"\",\n \"lang1\": \"Kleding\",\n \"lang2\": \"\",\n \"lang3\": \"\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n },\n {\n \"key\": \"0202\",\n \"group_id\": \"02\",\n \"description\": \"Accessoires\",\n \"alias\": \"Accessoires\",\n \"lang1\": \"Accessoires\",\n \"lang2\": \"Accessories\",\n \"lang3\": \"Accessoires\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n },\n {\n \"key\": \"0301\",\n \"group_id\": \"03\",\n \"description\": \"Pull\",\n \"alias\": \"\",\n \"lang1\": \"Pull\",\n \"lang2\": \"\",\n \"lang3\": \"\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n },\n {\n \"key\": \"0302\",\n \"group_id\": \"03\",\n \"description\": \"T-shirt\",\n \"alias\": \"\",\n \"lang1\": \"T-shirt\",\n \"lang2\": \"\",\n \"lang3\": \"\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n },\n {\n \"key\": \"0303\",\n \"group_id\": \"03\",\n \"description\": \"Broek\",\n \"alias\": \"Broek\",\n \"lang1\": \"Broek\",\n \"lang2\": \"Pants\",\n \"lang3\": \"Pantalon\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n },\n {\n \"key\": \"0304\",\n \"group_id\": \"03\",\n \"description\": \"Armband\",\n \"alias\": \"Armband\",\n \"lang1\": \"Armband\",\n \"lang2\": \"Bracelet\",\n \"lang3\": \"Bracelet\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n },\n {\n \"key\": \"0401\",\n \"group_id\": \"04\",\n \"description\": \"Lange mouw\",\n \"alias\": \"\",\n \"lang1\": \"Lange mouw\",\n \"lang2\": \"\",\n \"lang3\": \"\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n },\n {\n \"key\": \"0402\",\n \"group_id\": \"04\",\n \"description\": \"Korte mouw\",\n \"alias\": \"Korte mouw\",\n \"lang1\": \"Korte mouw\",\n \"lang2\": \"Short sleeve\",\n \"lang3\": \"Manches courtes\",\n \"lang4\": \"\",\n \"lang5\": \"\",\n \"active\": true\n }\n]"}],"_postman_id":"fa712a3e-2879-460b-806d-fe5954970804"},{"name":"Categories/{{id}}","event":[{"listen":"test","script":{"id":"53833c09-5dd2-4799-b792-77249c2d2ae5","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"15fc6f1a-e069-4b8a-b0b2-51d0ba9becc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/categories/0101","description":"

This endpoint fetches a specific category.

Used parameters:

display (full)

A brief explanation of return values:

key: The unique identifier
group_id: The level of the category
description: The name of the category
alias: An alias which can be used to display on the webshop.
lang1-5: Can be used as a different language for the category
active: boolean if this category is active or not, a category that is inactive is still visible but can't be attached to new products

To create a new category this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
group_id	string	string between 01 - 07, required
description	string
alias	string
lang1	string
lang2	string
lang3	string
lang4	string
lang5	string
active	boolean	default true

To create multiple categories this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
categories	array	list of categories
group_id	string	string between 01 - 07, required
description	string	required
alias	string
lang1	string
lang2	string
lang3	string
lang4	string
lang5	string
active	boolean	default: true
force_update	boolean	default: true

To update a category this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
description	string
alias	string
lang1	string
lang2	string
lang3	string
lang4	string
lang5	string
active	boolean	default true

After removal this call will return true if categorie is deleted.

Articles can be filed in different categories. The values for these categories should be recurring to many products and not specific to one or a few products. Good examples would be the sex – male, female, etc. – and article group – trousers, t-shirts, etc. These categories can be found in the category model. Currently there are seven possible categories. The id of each category exists of four characters. The first two characters represent which group it belongs to – ‘0102’ belongs to category 1 while ‘0245’ belongs to category 2. The last two characters is the id within the group. This is mostly numeric, but can be alphabetic. For most SoftTouch represents the first category the sex and the second category the article group.

\n","_postman_id":"73082641-3818-44f9-8f3b-aa85bb2b0735","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Cheques","item":[{"name":"Cheques","event":[{"listen":"test","script":{"id":"5ea368ce-72b2-4748-9377-0c069bd35b76","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"0a390a34-5660-4c9a-9301-e8e9b9fd6499","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/cheques","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
\n
take
\n
skip
\n
id (fetch a specific cheque)
\n
checksum (required with cheque)
\n
cheque (with checksum)
\n
custom_code (only with id starting with 999907)
\n
customer_id (fetch cheques for specific customer)
\n
label_barcode
\n
claimed
\n
created_store_ids
\n
since (date)
\n
updated_since_minutes (minutes since last change)
\n

A brief explanation of return values:

key: The unique identifier
\n
id: The kind of cheque
\n
customer: The id of the customer the cheque is made for. If type is 999907 this cheque is only usable for this customer.
\n
checksum: Every cheque has a checksum an this is mandatory for processing (except type is 999907 and custom_code is used)
\n
value: the value of the cheque, note this can be a percentage depending the value of is_percentage
\n
description: Internal description
\n
fromdate: From this date (date included) the cheque is valid
\n
todate: Until (date included) the cheque is valid
\n
claimed: If true the cheque is allready used
\n
label_barcode: The barcode used on the label
\n
custom_card_value: If set this value is reduced from the customer card if the cheque is used.
\n
one_scan_per_customer: If true this cheque can only be used once per customer (only used for type 999907)
\n
unlimited_scans: If true the cheque can be used multiple times by the same customer (only for type 999907)
\n
custom_code: A custom code can be used for easier usage by the customer for example \"summer20\"
\n
type:
\n

soap;

\n","type":"text/plain"},"key":"display","value":"full"},{"disabled":true,"key":"take","value":"500"},{"disabled":true,"key":"skip","value":"0"},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

required_with:cheque

\n","type":"text/plain"},"key":"checksum","value":""},{"disabled":true,"description":{"content":"

required_with:checksum

\n","type":"text/plain"},"key":"cheque","value":""},{"disabled":true,"description":{"content":"

OnlyUsedWithOtherFields:id,999907

\n","type":"text/plain"},"key":"custom_code","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

integer|between:9000000000000,9999999999999

\n","type":"text/plain"},"key":"label_barcode","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"claimed","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:2

\n","type":"text/plain"},"key":"created_store_ids","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"since","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"updated_since_minutes","value":null}],"variable":[]}},"response":[{"id":"e5f0a2a5-5380-40af-a6d3-8c464a5a93fe","name":"Cheques","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/cheques","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","cheques"],"query":[{"key":"display","value":"full","description":"soap;","type":"text","disabled":true},{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true},{"key":"id","value":"","type":"text","disabled":true},{"key":"checksum","value":"","type":"text","disabled":true},{"key":"cheque","value":"","type":"text","disabled":true},{"key":"custom_code","value":"","type":"text","disabled":true},{"key":"customer_id","value":"","type":"text","disabled":true},{"key":"label_barcode","value":"","type":"text","disabled":true},{"key":"claimed","value":"","type":"text","disabled":true},{"key":"created_store_ids","value":"","type":"text","disabled":true},{"key":"since","value":"","disabled":true},{"key":"updated_since_minutes","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Mon, 17 Jul 2023 13:27:36 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlZqQWNzT3c1dnVSVWZ5TlhTK1ZEaHc9PSIsInZhbHVlIjoic2xMdllQTjBHcjFWTTZ1TW4yeXN0WFJaVnlaVTBwXC9vcCtwbFFCQmRhYm5TOVVadHpXTE1adFNnOWJ5b2NZTExnajJjVW9wdFBsRXB4TktlK3ZpWjVRPT0iLCJtYWMiOiJlMDhkODM2N2EwMDA3OTI3OWM1ZGRmNDU3ZDBlYWY5ZTIyYzJjNjA0NDkxMmU4NDc1NWZlMzY0NDVmNGZlZDZhIn0%3D; expires=Mon, 17-Jul-2023 15:27:36 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": 99999902001000,\n \"id\": 999902,\n \"customer\": 2,\n \"checksum\": \"b7313c8b\",\n \"value\": 50,\n \"description\": \"Cadeaucheque [001000]\",\n \"fromdate\": \"2023-07-17\",\n \"todate\": \"9999-12-31\",\n \"claimed\": false,\n \"label_barcode\": \"9999020010001\",\n \"customer_card_value\": 0,\n \"one_scan_per_customer\": false,\n \"unlimited_scans\": false,\n \"is_percentage\": false,\n \"custom_code\": \"001000\",\n \"type\": \"\"\n },\n {\n \"key\": 99999902001001,\n \"id\": 999902,\n \"customer\": 2,\n \"checksum\": \"a1bcdda1\",\n \"value\": 75,\n \"description\": \"Cadeaucheque [001001]\",\n \"fromdate\": \"2023-07-17\",\n \"todate\": \"9999-12-31\",\n \"claimed\": false,\n \"label_barcode\": \"9999020010018\",\n \"customer_card_value\": 0,\n \"one_scan_per_customer\": false,\n \"unlimited_scans\": false,\n \"is_percentage\": false,\n \"custom_code\": \"001001\",\n \"type\": \"\"\n },\n {\n \"key\": 99999907001001,\n \"id\": 999907,\n \"customer\": 2,\n \"checksum\": \"03B48916\",\n \"value\": 5,\n \"description\": \"Verjaardagsbon\",\n \"fromdate\": \"2023-05-27\",\n \"todate\": \"2024-06-27\",\n \"claimed\": false,\n \"label_barcode\": \"9999070010013\",\n \"customer_card_value\": 0,\n \"one_scan_per_customer\": false,\n \"unlimited_scans\": false,\n \"is_percentage\": true,\n \"custom_code\": \"L83I8JOJZSJDFAYCMMEE\",\n \"type\": \"\"\n },\n {\n \"key\": 99999907001002,\n \"id\": 999907,\n \"customer\": 3,\n \"checksum\": \"97a4dc1b\",\n \"value\": 5,\n \"description\": \"Verjaardagsbon\",\n \"fromdate\": \"2023-07-17\",\n \"todate\": \"2023-08-17\",\n \"claimed\": false,\n \"label_barcode\": \"9999070010020\",\n \"customer_card_value\": 0,\n \"one_scan_per_customer\": false,\n \"unlimited_scans\": false,\n \"is_percentage\": false,\n \"custom_code\": \"happy_birthday\",\n \"type\": \"\"\n },\n {\n \"key\": 99999907001003,\n \"id\": 999907,\n \"customer\": 0,\n \"checksum\": \"b9f7fc48\",\n \"value\": 5,\n \"description\": \"1-time discount code\",\n \"fromdate\": \"2023-07-17\",\n \"todate\": \"2024-07-16\",\n \"claimed\": false,\n \"label_barcode\": \"9999070010037\",\n \"customer_card_value\": 0,\n \"one_scan_per_customer\": true,\n \"unlimited_scans\": false,\n \"is_percentage\": false,\n \"custom_code\": \"\",\n \"type\": \"\"\n }\n]"}],"_postman_id":"0a390a34-5660-4c9a-9301-e8e9b9fd6499"},{"name":"Cheques","event":[{"listen":"test","script":{"id":"5ea368ce-72b2-4748-9377-0c069bd35b76","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"8f804297-d580-450a-b480-99bd43a1a1e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 999907,\r\n \"value\": 5.00,\r\n \"customer\": 3,\r\n \"description\": \"Verjaardagsbon\",\r\n \"days_valid\": 31,\r\n \"customer_card_value\": 0,\r\n \"one_scan_per_customer\": false,\r\n \"unlimited_scans\": false,\r\n \"is_percentage\": false,\r\n \"custom_code\": \"happy_birthday\",\r\n \"pos_id\": \"0101\",\r\n \"store_id\": \"01\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/cheques","description":"

Create a new cheque.

id, as described before is the type of cheque.
Value is how much the cheque is worth. This should be a positive value.
The customer id is compulsory for advances and customer discounts and desirable for article vouchers. For commercial vouchers it depends on the case. For gift vouchers it is not required, but, for the sake of completion, a good practice to add the customer id.
All cheques have a default description generated. It is not necessary to add a description, however, if this is done the text will be added at the end of the default description. The commercial voucher is an exception on this rule. When no description is given a default description will be generated, however, when one is given the default description will not be generated and the given description is also the description. We encourage the developer to add a meaningful description for commercial vouchers.
days_valid will only work for commercial vouchers. As default commercial voucher will be one year valid. The other cheques are either unlimited in time or limited by a pre-set limit.
customer_card_value is also only used when creating a commercial voucher. Usually the value of the article or cheque is taken into account for the customer card. This can be manipulated with this value.
one_scan_per_user is another parameter only used for commercial vouchers. Usually a voucher can be used only once. When this parameter is set to true the commercial voucher will be useable more than once, but only once by the same customer.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
id	int	required
value	double	required
customer	int
description	string	required
days_valid	int
customer_card_value	int
one_scan_per_customer	boolean	only with type (id) 999907
unlimited_scans	boolean	only with type (id) 999907
is_percentage	boolean	only with type (id) 999907
custom_code	string	only with type (id) 999907
pos_id	string	length: 4
store_id	string	length: 2

Process a specific cheque, only use this endpoint if needed. When using reservation and the cheque is used on the reservation this call can not be used!

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
receipt_id	int
date	string
pos_id	string	length: 4
store_id	string	length: 2

The SoftTouch API uses different kind of cheques. Because it is important that the correct type of cheque is used the following should be read thoroughly when using cheques.

There are different types of cheques which are all represented by a 6 digit number, starting with 99990. The ids can be one of the following:
999902 = gift voucher. The customer buys a gift voucher for family or friends and pays the value of the cheque. When a gift voucher is used, the value is reduced from the price to pay.
999904 = article voucher. With all vouchers and discounts a customer it is possible that the total to pay of the reservation can get negative. Obviously a customer will not get money back, but will receive an article voucher, which can be used on the next purchase. This is the only type which should be used for such a case. Even if the customer gets a negative value by using a gift voucher an article voucher should be created and not another gift voucher.
999907 = commercial voucher. This is a special kind of gift voucher. While a gift voucher is a present from one customer to another, a commercial voucher is a gift from the store itself. Therefore, a commercial voucher should never have a positive value on a reservation. When the developer creates a commercial voucher, the voucher should be sent separately, or given by the shop.
999903 = advance. An advance has a value equal to what the customer pays in advance. Web developers usually won’t have anything to do with this, since the customer will pay the full amount.
999905 and 999909 = customer discount. Loyal customers often get an extra discount. Depending on how the customer discount works it will be one of these ids. In the rare case the web developer also creates customer discounts, it has to be discussed in advance what type should be used.

A cheque always has a unique cheque number and a checksum. The cheque number is always 14 characters long starting with ‘99’ + id (e.g. 99999902 for a gift voucher). The checksum is a more random combination of 8 characters. When a customer wants to use a cheque, the developer should always check if the combination cheque + checksum is valid.

Each voucher shows a from and to date. It is important that the developer knows whether the dates should be taken into account. More often than not the decision is taken by the sales person if the valid date should be taken in account.
Next to the cheque + checksum validation the developer should also make sure the cheque is not already claimed (used on another reservation or already sold). Obviously the developer should also be sure that the same cheque is not used twice on the same reservation.
To make the cheque scan-able, an EAN13 bacode is needed. Label_barcode is just that. When a scan-able barcode is generated based on this number, make sure the generator is set to EAN13. We also advice to make it human readable.
customer_card_value and one_scan_per_customer are special variables only used for commercial vouchers. More information follows at the creating cheques section.

\n","_postman_id":"b3943201-c3b8-478e-bdb3-604a3e002c73","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Colors","item":[{"name":"Colors","event":[{"listen":"test","script":{"id":"5b0fb2f2-ce0c-41e2-adde-c4545a26a51b","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"d3686149-a365-42dd-88b3-95db2a611277","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/colors","description":"

This endpoint fetches all colors as all calls it has to be done in steps with a maximum amount of 500 colors.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

id: The unique identifier
description: The color name
color_long: The rgb color code
color_hex: The hex color code
active: Is the color available for new products.

If display full is used some extra info is availble.

note: The color description \"Multi color\" is used if a product has multiple colors. The colorlong and colorhex values should be ignored!

This endpoint fetches a specific color.

Used parameters:

display (full)

A brief explanation of return values:

id: The unique identifier
description: The color name
color_long: The rgb color code
color_hex: The hex color code
active: Is the color available for new products.

If display full is used some extra info is availble.

note: The color description \"Multi color\" is used if a product has multiple colors. The colorlong and colorhex values should be ignored!

To create a new color this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
id	string	required, length: 4
description	string	required
colorhex	string	hex value of the color

To uppdate a color this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
description	string	required
colorhex	string	hex value of the color

Often the supplier has for each colour its own code, something like ‘A458’. In the API this can be found in colorbrand as ‘A458 - red'.
When suppliers use many different names for almost the same colour, it might be easier to refer to them with the same name. For the colour red there might be the description cherry, rose, jam, merlot, garnet, crimson, etc. They could all be linked to one of the colours in the color model. The id of such a colour exists of four characters, usually numbers. The use of these colours is not mandatory, so the color parameter for a product might be an empty string.
A product with different colours or variants can use the same id with a different variant number. This is a numeric value not higher than 99.

\n","_postman_id":"f72b78aa-170d-4382-9d89-63eb431bc372","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Corporations","item":[{"name":"Corporations","event":[{"listen":"test","script":{"id":"8d6884bc-947b-4535-93c9-c93229f8f03d","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"ab5af140-e8fb-4a31-9d65-ab1e220d563d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/corporations","description":"

This endpoint fetches all corporations as all calls it has to be done in steps with a maximum amount of 500 corporations.

These corporations are linked to warehouses and used for invoices etc.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

name: The corporation name
address_1: The address of the corporation
address_2: A second address of the corporation
postal_code: Zip code of the corporation
city: The city where the corporation is based
country_iso: The country (ISO) of the corporation
vat: The vat number of the corporation
active: If the corporation is still in use

If display full is used some extra info is availble.

Get corporations, these are linked to warehouses and used for invoices.

\n","_postman_id":"c3a16d9a-38a8-4408-9bf7-b50429385cfd","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Countries","item":[{"name":"Countries","event":[{"listen":"test","script":{"id":"fd525088-476f-4a82-9969-965b18e28b88","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"48b601fe-669f-41d6-b695-92c138d5511d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/countries","description":"

This endpoint fetches all countries as all calls it has to be done in steps with a maximum amount of 500 countries.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

id: The unique identifier (ISO)
name: The full writen country name (in English)

If display full is used some extra info is availble.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","countries"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"key":"display","value":"full"},{"disabled":true,"key":"take","value":"500"},{"disabled":true,"key":"skip","value":"0"}],"variable":[]}},"response":[{"id":"7bcdc023-c97f-42b8-b744-22b95e9829a8","name":"Countries","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/countries","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","countries"],"query":[{"key":"display","value":"full","type":"text","disabled":true},{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 22 Jun 2023 09:00:14 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6InBNbUNKQkxoUVlFb1BIWDR4XC8yVjJ3PT0iLCJ2YWx1ZSI6IlQrNHYzQkpNWFl2akowNGdaM3Rqbm0zVGFoOVFaZ1wvU2tsa2RHaXRDR2gxTFFCSE02YWdjeDJpbW9NVXpxYUNiUUlvcVkxM29hVTVnc2hLbzA2d3FXQT09IiwibWFjIjoiMGZiYWNkMzk4NzQ3MGU4YTIxNTFmYjc5YTIwZDEzY2U5ZTQ1YWExOTc3ZDhkNjQ0OGYwNDM5NWZjZTE1NmM5ZSJ9; expires=Thu, 22-Jun-2023 11:00:14 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"AD\",\n \"name\": \"Andorra\"\n },\n {\n \"id\": \"AE\",\n \"name\": \"United Arab Emirates\"\n },\n {\n \"id\": \"AF\",\n \"name\": \"Afghanistan\"\n },\n {\n \"id\": \"AG\",\n \"name\": \"Antigua and Barbuda\"\n },\n {\n \"id\": \"AI\",\n \"name\": \"Anguilla\"\n },\n {\n \"id\": \"AL\",\n \"name\": \"Albania\"\n },\n {\n \"id\": \"AM\",\n \"name\": \"Armenia\"\n },\n {\n \"id\": \"AN\",\n \"name\": \"Netherlands Antilles\"\n },\n {\n \"id\": \"AO\",\n \"name\": \"Angola\"\n },\n {\n \"id\": \"AQ\",\n \"name\": \"Antarctica\"\n },\n {\n \"id\": \"AR\",\n \"name\": \"Argentina\"\n },\n {\n \"id\": \"AS\",\n \"name\": \"American Samoa\"\n },\n {\n \"id\": \"AT\",\n \"name\": \"Austria\"\n },\n {\n \"id\": \"AU\",\n \"name\": \"Australia\"\n },\n {\n \"id\": \"AW\",\n \"name\": \"Aruba\"\n },\n {\n \"id\": \"AZ\",\n \"name\": \"Azerbaijan\"\n },\n {\n \"id\": \"BA\",\n \"name\": \"Bosnia and Herzegovina\"\n },\n {\n \"id\": \"BB\",\n \"name\": \"Barbados\"\n },\n {\n \"id\": \"BD\",\n \"name\": \"Bangladesh\"\n },\n {\n \"id\": \"BE\",\n \"name\": \"Belgium\"\n },\n {\n \"id\": \"BF\",\n \"name\": \"Burkina Faso\"\n },\n {\n \"id\": \"BG\",\n \"name\": \"Bulgaria\"\n },\n {\n \"id\": \"BH\",\n \"name\": \"Bahrain\"\n },\n {\n \"id\": \"BI\",\n \"name\": \"Burundi\"\n },\n {\n \"id\": \"BJ\",\n \"name\": \"Benin\"\n },\n {\n \"id\": \"BL\",\n \"name\": \"St. Martin\"\n },\n {\n \"id\": \"BM\",\n \"name\": \"Bermuda\"\n },\n {\n \"id\": \"BN\",\n \"name\": \"Brunei Darussalam\"\n },\n {\n \"id\": \"BO\",\n \"name\": \"Bolivia\"\n },\n {\n \"id\": \"BQ\",\n \"name\": \"Caribbean Netherlands\"\n },\n {\n \"id\": \"BR\",\n \"name\": \"Brazil\"\n },\n {\n \"id\": \"BS\",\n \"name\": \"Bahamas\"\n },\n {\n \"id\": \"BT\",\n \"name\": \"Bhutan\"\n },\n {\n \"id\": \"BV\",\n \"name\": \"Bouvet Island\"\n },\n {\n \"id\": \"BW\",\n \"name\": \"Botswana\"\n },\n {\n \"id\": \"BY\",\n \"name\": \"Belarus\"\n },\n {\n \"id\": \"BZ\",\n \"name\": \"Belize\"\n },\n {\n \"id\": \"CA\",\n \"name\": \"Canada\"\n },\n {\n \"id\": \"CC\",\n \"name\": \"Cocos (Keeling) Islands\"\n },\n {\n \"id\": \"CD\",\n \"name\": \"Congo, the Democratic Republic of the\"\n },\n {\n \"id\": \"CF\",\n \"name\": \"Central African Republic\"\n },\n {\n \"id\": \"CG\",\n \"name\": \"Congo\"\n },\n {\n \"id\": \"CH\",\n \"name\": \"Switzerland\"\n },\n {\n \"id\": \"CI\",\n \"name\": \"Cote D'Ivoire\"\n },\n {\n \"id\": \"CK\",\n \"name\": \"Cook Islands\"\n },\n {\n \"id\": \"CL\",\n \"name\": \"Chile\"\n },\n {\n \"id\": \"CM\",\n \"name\": \"Cameroon\"\n },\n {\n \"id\": \"CN\",\n \"name\": \"China\"\n },\n {\n \"id\": \"CO\",\n \"name\": \"Colombia\"\n },\n {\n \"id\": \"CR\",\n \"name\": \"Costa Rica\"\n },\n {\n \"id\": \"CS\",\n \"name\": \"Serbia and Montenegro\"\n },\n {\n \"id\": \"CU\",\n \"name\": \"Cuba\"\n },\n {\n \"id\": \"CV\",\n \"name\": \"Cape Verde\"\n },\n {\n \"id\": \"CW\",\n \"name\": \"Curaçao\"\n },\n {\n \"id\": \"CX\",\n \"name\": \"Christmas Island\"\n },\n {\n \"id\": \"CY\",\n \"name\": \"Cyprus\"\n },\n {\n \"id\": \"CZ\",\n \"name\": \"Czech Republic\"\n },\n {\n \"id\": \"DE\",\n \"name\": \"Germany\"\n },\n {\n \"id\": \"DJ\",\n \"name\": \"Djibouti\"\n },\n {\n \"id\": \"DK\",\n \"name\": \"Denmark\"\n },\n {\n \"id\": \"DM\",\n \"name\": \"Dominica\"\n },\n {\n \"id\": \"DO\",\n \"name\": \"Dominican Republic\"\n },\n {\n \"id\": \"DZ\",\n \"name\": \"Algeria\"\n },\n {\n \"id\": \"EC\",\n \"name\": \"Ecuador\"\n },\n {\n \"id\": \"EE\",\n \"name\": \"Estonia\"\n },\n {\n \"id\": \"EG\",\n \"name\": \"Egypt\"\n },\n {\n \"id\": \"EH\",\n \"name\": \"Western Sahara\"\n },\n {\n \"id\": \"ER\",\n \"name\": \"Eritrea\"\n },\n {\n \"id\": \"ES\",\n \"name\": \"Spain\"\n },\n {\n \"id\": \"ET\",\n \"name\": \"Ethiopia\"\n },\n {\n \"id\": \"FI\",\n \"name\": \"Finland\"\n },\n {\n \"id\": \"FJ\",\n \"name\": \"Fiji\"\n },\n {\n \"id\": \"FK\",\n \"name\": \"Falkland Islands (Malvinas)\"\n },\n {\n \"id\": \"FM\",\n \"name\": \"Micronesia, Federated States of\"\n },\n {\n \"id\": \"FO\",\n \"name\": \"Faroe Islands\"\n },\n {\n \"id\": \"FR\",\n \"name\": \"France\"\n },\n {\n \"id\": \"GA\",\n \"name\": \"Gabon\"\n },\n {\n \"id\": \"GB\",\n \"name\": \"United Kingdom\"\n },\n {\n \"id\": \"GD\",\n \"name\": \"Grenada\"\n },\n {\n \"id\": \"GE\",\n \"name\": \"Georgia\"\n },\n {\n \"id\": \"GF\",\n \"name\": \"French Guiana\"\n },\n {\n \"id\": \"GH\",\n \"name\": \"Ghana\"\n },\n {\n \"id\": \"GI\",\n \"name\": \"Gibraltar\"\n },\n {\n \"id\": \"GL\",\n \"name\": \"Greenland\"\n },\n {\n \"id\": \"GM\",\n \"name\": \"Gambia\"\n },\n {\n \"id\": \"GN\",\n \"name\": \"Guinea\"\n },\n {\n \"id\": \"GP\",\n \"name\": \"Guadeloupe\"\n },\n {\n \"id\": \"GQ\",\n \"name\": \"Equatorial Guinea\"\n },\n {\n \"id\": \"GR\",\n \"name\": \"Greece\"\n },\n {\n \"id\": \"GS\",\n \"name\": \"South Georgia and the South Sandwich Islands\"\n },\n {\n \"id\": \"GT\",\n \"name\": \"Guatemala\"\n },\n {\n \"id\": \"GU\",\n \"name\": \"Guam\"\n },\n {\n \"id\": \"GW\",\n \"name\": \"Guinea-Bissau\"\n },\n {\n \"id\": \"GY\",\n \"name\": \"Guyana\"\n },\n {\n \"id\": \"HK\",\n \"name\": \"Hong Kong\"\n },\n {\n \"id\": \"HM\",\n \"name\": \"Heard Island and Mcdonald Islands\"\n },\n {\n \"id\": \"HN\",\n \"name\": \"Honduras\"\n },\n {\n \"id\": \"HR\",\n \"name\": \"Croatia\"\n },\n {\n \"id\": \"HT\",\n \"name\": \"Haiti\"\n },\n {\n \"id\": \"HU\",\n \"name\": \"Hungary\"\n }\n]"}],"_postman_id":"48b601fe-669f-41d6-b695-92c138d5511d"},{"name":"Countries/{{id}}","event":[{"listen":"test","script":{"id":"b5307a7c-2254-4613-b2e3-af44ac6b91b8","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"b248001f-5b8a-4fd6-b637-3d77a15ef104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/countries/BE","description":"

This endpoint fetches a specific country.

Used parameters:

display (full)

A brief explanation of return values:

id: The unique identifier (ISO)
name: The full writen country name (in English)

If display full is used some extra info is availble.

This endpoint fetches all customers as all calls it has to be done in steps with a maximum amount of 500 customers.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
firstname: The firstname of the customer
name: The lastname of the customer
company: The company name of the customer
address: The address of the customer
zip: The zip code of the customer
city: The city of the customer
county: The country of the customer
telephone: The phone number of the customer
mobile: The mobile phone number of the customer
email: The email address of the customer
birthday: The date of birth of the customer
vatid: The customers vat identification number
firstvisit: The first date the customer has been to the store/ webshop
lastvisit: The last date the customer has been to the store/ webshop
accepted_gdpr_at: The date the customer has accepted the gdpr policy (not always used)
faultysms: If true, the mobilephone number is faulty
sendsms: The customer wants to receive sms mailings
faultyemail: If true, the email address of the customer is faulty
sendemail: The customer wants to receive email newsletters
faultymail: If true, the address of the customer is faulty
sendmail: The customer wants to receive newsletters
active: If true the customer can be used
login: The login of the customer
lastLogin: The date of the last login
created: The date of creation
createdby: The userid of the the user creating the customer
modified: The date of modification
modifiedby: The userid of the user modifying the customer
pos_id: The pos id where the customer is created
store_id: The store id where the customer is created
salutation_id: Linked to the customer_categories endpoint, used for the salutation
category1 - 10: Linked to the customer_categories endpoint. No default values available, can be used for language eg
miscellaneous: Some miscellaneous data about the client can be stored here
timestamp: The datetime of last edit of the client
gets_direct_discount: Also known as VIP customers, this customer recieves a direct discount if true
direct_discount_percentage: If above is true, this percentage is the discount the customer revieves. Not if a product allready has a discount the highest discount is used.
customer_card_revenue: The amount the customer has spend to calculate the customer discount (depending the customer card type)
customer_card_percentage: The percentage of customer discount the client receives (depending the customer card type)
customer_card_discount: The value of customer discount the client receives (depending the customer card type)
customer_card_lines: The amount of products the customer has bought or visits the customer has done (depening the customer card type)
customer_card_point: The amount of points the customer has saved (depending the customer card type)
cards: If set a customer card per store can be made, in this case above has to be ignored an setting per store need to be fetched
is_b2b: The customer can only be used for b2b purposes

StartFragment

If display full is used some extra info is availble.

EndFragmen=

alphanum | size:2

\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"key":"telephone","value":""},{"disabled":true,"key":"mobile","value":""},{"disabled":true,"key":"phone_number","value":""},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"key":"email_like","value":""},{"disabled":true,"key":"login","value":""},{"disabled":true,"description":{"content":"

date_period

\n","type":"text/plain"},"key":"birthdays","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"created_since","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"modified_since","value":""},{"disabled":true,"key":"miscellaneous","value":""},{"disabled":true,"key":"company","value":""},{"disabled":true,"description":{"content":"

integer | between:10000000000,100000000000

\n","type":"text/plain"},"key":"national_register_id","value":""},{"disabled":true,"description":{"content":"

Comma seperated | Size:4

\n","type":"text/plain"},"key":"pos_ids","value":""},{"disabled":true,"description":{"content":"

Comma seperated | Size:2

\n","type":"text/plain"},"key":"accepted_gdpr","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"is_b2b","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"check_pg","value":"1"},{"disabled":true,"description":{"content":"

size:2 (only impacts pg)

\n","type":"text/plain"},"key":"store_id","value":"01"},{"disabled":true,"description":{"content":"

size:4 (only impacts pg)

\n","type":"text/plain"},"key":"pos_id","value":""}],"variable":[]}},"response":[{"id":"aa59eb5f-d793-4a4d-8945-0983b650adc1","name":"Customers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","customers"],"query":[{"key":"display","value":"full","type":"text","disabled":true},{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true},{"key":"name","value":"","type":"text","disabled":true},{"key":"first_name","value":"","type":"text","disabled":true},{"key":"last_name","value":"","type":"text","disabled":true},{"key":"address","value":"","type":"text","disabled":true},{"key":"postal_code","value":"","type":"text","disabled":true},{"key":"city","value":"","type":"text","disabled":true},{"key":"country","value":"","description":"alphanum | size:2","type":"text","disabled":true},{"key":"telephone","value":"","type":"text","disabled":true},{"key":"mobile","value":"","type":"text","disabled":true},{"key":"phone_number","value":"","type":"text","disabled":true},{"key":"email","value":"","description":"email","type":"text","disabled":true},{"key":"email_like","value":"","type":"text","disabled":true},{"key":"login","value":"","type":"text","disabled":true},{"key":"birthdays","value":"","description":"date_period","type":"text","disabled":true},{"key":"created_since","value":"","description":"date","type":"text","disabled":true},{"key":"modified_since","value":"","description":"date","type":"text","disabled":true},{"key":"miscellaneous","value":"","type":"text","disabled":true},{"key":"company","value":"","type":"text","disabled":true},{"key":"national_register_id","value":"","description":"integer | between:10000000000,100000000000","type":"text","disabled":true},{"key":"pos_ids","value":"","description":"Comma seperated | Size:4","type":"text","disabled":true},{"key":"accepted_gdpr","value":"","description":"Comma seperated | Size:2","type":"text","disabled":true},{"key":"is_b2b","value":"","description":"boolean","type":"text","disabled":true},{"key":"check_pg","value":"","description":"boolean","disabled":true},{"key":"store_id","value":"","description":"size:2 (only impacts pg)","type":"text","disabled":true},{"key":"pos_id","value":"","description":"size:4 (only impacts pg)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 19 Jul 2023 07:24:35 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6ImU1ZWM5WGlPSW92eFkxdGVVU0RLZWc9PSIsInZhbHVlIjoicklJN29wNG1DMDJnQ3c1VFBGYXRjMFRYeWJFeGpqWlh2VGxUQnpuYmVIVDhWXC9GblF3RDlINzFuN3JicVwvVm1OUGtyS0NPVWw4UDRLenhUbkl3bk1Ydz09IiwibWFjIjoiYTg4MGRhMWViYjBkMDU5OWFkZmQ0MDRkOWI3YjQ1ZThiMmFiYjQ4ZjllMzBlMWU3NTNiZTBhZjdlNTI3NGM4OCJ9; expires=Wed, 19-Jul-2023 09:24:35 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": 1,\n \"firstname\": \"\",\n \"name\": \"Algemene klant\",\n \"company\": \"\",\n \"address\": \"\",\n \"zip\": \"\",\n \"city\": \"\",\n \"country\": \"\",\n \"telephone\": \"\",\n \"mobile\": \"\",\n \"email\": \"\",\n \"birthday\": \"2001-01-01\",\n \"vatid\": \"\",\n \"firstvisit\": \"2016-07-01\",\n \"lastvisit\": \"2023-03-13\",\n \"accepted_gdpr_at\": null,\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": null,\n \"login\": null,\n \"lastlogin\": null,\n \"created\": \"2016-07-01\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-03-13\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"00\",\n \"salutation_id\": \"9000\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-03-13 11:54:46\",\n \"gets_direct_discount\": false,\n \"direct_discount_percentage\": 0,\n \"customer_card_revenue\": 0,\n \"customer_card_percentage\": 0,\n \"customer_card_discount\": 0,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n },\n {\n \"key\": 2,\n \"firstname\": \"Stefan\",\n \"name\": \"de Bakker\",\n \"company\": \"SoftTouch BV\",\n \"address\": \"Ambachtenlaan 6A\",\n \"zip\": \"9080\",\n \"city\": \"Lochristi\",\n \"country\": \"BE\",\n \"telephone\": \"09/219.00.83\",\n \"mobile\": \"\",\n \"email\": \"dev@softtouch.be\",\n \"birthday\": \"1989-05-27\",\n \"vatid\": \"\",\n \"firstvisit\": \"2016-01-11\",\n \"lastvisit\": \"2023-07-17\",\n \"accepted_gdpr_at\": \"2021-04-23 00:00:00\",\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": true,\n \"login\": \"stefan@softtouch.be\",\n \"lastlogin\": \"2023-07-20 00:00:00\",\n \"created\": \"2023-04-11\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-17\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"01\",\n \"salutation_id\": \"9001\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-07-17 12:42:41\",\n \"gets_direct_discount\": true,\n \"direct_discount_percentage\": 10,\n \"customer_card_revenue\": 743,\n \"customer_card_percentage\": 5,\n \"customer_card_discount\": 37.15,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n },\n {\n \"key\": 3,\n \"firstname\": \"Jeremy\",\n \"name\": \"Clarkson\",\n \"company\": \"\",\n \"address\": \"Chipping Norton Road 5\",\n \"zip\": \"OX7 3PE\",\n \"city\": \"Chadlington\",\n \"country\": \"GB\",\n \"telephone\": \"\",\n \"mobile\": \"\",\n \"email\": \"\",\n \"birthday\": \"2001-01-01\",\n \"vatid\": \"\",\n \"firstvisit\": \"2023-07-03\",\n \"lastvisit\": \"2023-07-03\",\n \"accepted_gdpr_at\": null,\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": null,\n \"login\": null,\n \"lastlogin\": null,\n \"created\": \"2023-07-03\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-03\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"00\",\n \"salutation_id\": \"9001\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-07-03 10:58:21\",\n \"gets_direct_discount\": false,\n \"direct_discount_percentage\": 0,\n \"customer_card_revenue\": 0,\n \"customer_card_percentage\": 0,\n \"customer_card_discount\": 0,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n },\n {\n \"key\": 4,\n \"firstname\": \"John\",\n \"name\": \"Doe\",\n \"company\": \"\",\n \"address\": \"Hoofdstraat 123\",\n \"zip\": \"1000\",\n \"city\": \"Bruxelles\",\n \"country\": \"BE\",\n \"telephone\": \"\",\n \"mobile\": \"\",\n \"email\": \"\",\n \"birthday\": \"2001-01-01\",\n \"vatid\": \"\",\n \"firstvisit\": \"2023-07-03\",\n \"lastvisit\": \"2023-07-03\",\n \"accepted_gdpr_at\": null,\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": null,\n \"login\": null,\n \"lastlogin\": null,\n \"created\": \"2023-07-03\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-03\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"00\",\n \"salutation_id\": \"9001\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-07-03 10:59:27\",\n \"gets_direct_discount\": false,\n \"direct_discount_percentage\": 0,\n \"customer_card_revenue\": 0,\n \"customer_card_percentage\": 0,\n \"customer_card_discount\": 0,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n },\n {\n \"key\": 5,\n \"firstname\": \"Bert\",\n \"name\": \"Van de Vyver\",\n \"company\": \"SoftTouch BV\",\n \"address\": \"Ambachtenlaan 6A\",\n \"zip\": \"9080\",\n \"city\": \"Lochristi\",\n \"country\": \"BE\",\n \"telephone\": \"\",\n \"mobile\": \"\",\n \"email\": \"bert.vdv@softtouch.be\",\n \"birthday\": \"1995-09-21\",\n \"vatid\": \"\",\n \"firstvisit\": \"2021-04-23\",\n \"lastvisit\": \"2021-04-23\",\n \"accepted_gdpr_at\": \"2021-04-23 00:00:00\",\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": true,\n \"login\": \"bert.vandevyver@softtouch.be\",\n \"lastlogin\": \"2021-04-23 00:00:00\",\n \"created\": \"2023-07-03\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-03\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"01\",\n \"salutation_id\": \"9001\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-07-03 11:07:36\",\n \"gets_direct_discount\": false,\n \"direct_discount_percentage\": 0,\n \"customer_card_revenue\": 0,\n \"customer_card_percentage\": 0,\n \"customer_card_discount\": 0,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n }\n]"}],"_postman_id":"f396afa5-98c6-489c-a48e-5ff353644dd3"},{"name":"Customers/{{id}}","event":[{"listen":"test","script":{"id":"de54257f-84f2-406c-85bf-f8235aa4186b","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"60b52642-cf8b-4dd9-8f33-91bd83d65834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2","description":"

This endpoint fetches specific customer.

Used parameters:

display (full)

A brief explanation of return values:

key: The unique identifier
firstname: The firstname of the customer
name: The lastname of the customer
company: The company name of the customer
address: The address of the customer
zip: The zip code of the customer
city: The city of the customer
county: The country of the customer
telephone: The phone number of the customer
mobile: The mobile phone number of the customer
email: The email address of the customer
birthday: The date of birth of the customer
vatid: The customers vat identification number
firstvisit: The first date the customer has been to the store/ webshop
lastvisit: The last date the customer has been to the store/ webshop
accepted_gdpr_at: The date the customer has accepted the gdpr policy (not always used)
faultysms: If true, the mobilephone number is faulty
sendsms: The customer wants to receive sms mailings
faultyemail: If true, the email address of the customer is faulty
sendemail: The customer wants to receive email newsletters
faultymail: If true, the address of the customer is faulty
sendmail: The customer wants to receive newsletters
active: If true the customer can be used
login: The login of the customer
lastLogin: The date of the last login
created: The date of creation
createdby: The userid of the the user creating the customer
modified: The date of modification
modifiedby: The userid of the user modifying the customer
pos_id: The pos id where the customer is created
store_id: The store id where the customer is created
salutation_id: Linked to the customer_categories endpoint, used for the salutation
category1 - 10: Linked to the customer_categories endpoint. No default values available, can be used for language eg
miscellaneous: Some miscellaneous data about the client can be stored here
timestamp: The datetime of last edit of the client
gets_direct_discount: Also known as VIP customers, this customer recieves a direct discount if true
direct_discount_percentage: If above is true, this percentage is the discount the customer revieves. Not if a product allready has a discount the highest discount is used.
customer_card_revenue: The amount the customer has spend to calculate the customer discount (depending the customer card type)
customer_card_percentage: The percentage of customer discount the client receives (depending the customer card type)
customer_card_discount: The value of customer discount the client receives (depending the customer card type)
customer_card_lines: The amount of products the customer has bought or visits the customer has done (depening the customer card type)
customer_card_point: The amount of points the customer has saved (depending the customer card type)
cards: If set a customer card per store can be made, in this case above has to be ignored an setting per store need to be fetched
is_b2b: The customer can only be used for b2b purposes

StartFragment

If display full is used some extra info is availble.

EndFragmen=

Creating a new customer with a login can be done with one POST controller ‘customers’. If the login does not exist yet and nothing else fails the customer, with its login, will be created and the details of the new customer will be given as a result. When the customer tries to use a login that already exists an error code 409 with message “Login already exists” will be given and the customer will not be created.

Note: A customer should at least have a name and address.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
salutation_id	string	length: 4
firstname	string
name	string	required
company	string
address	string
zip	string
city	string
country	string	ISO value, length: 2
telephone	striing
mobile	string
email	string
email2	string
birthday	date
vatid	string
firstvisit	date
lastvisit	date
accepted_gdpr_at	null or date
faultysms	boolean
sendsms	boolean
faultyemail	boolean
sendemail	boolean
faultymail	boolean
sendmail	boolean
send_eticket	boolean
active	boolean	default: true
login	string	required with password
password	string	required with login
lastLogin	date
category1	string	length: 4
category2	string	length: 4
category3	string	length: 4
category4	string	length: 4
category5	string	length: 4
category6	string	length: 4
category7	string	length: 4
category8	string	length: 4
category9	string	length: 4
category10	string	length: 4
miscellaneous	string
pos_id	string	length: 4
store_id	string	length: 2
is_b2b	boolean	default: false

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","customers"],"host":["api","softtouch","eu"],"query":[],"variable":[]}},"response":[{"id":"95b04151-f7d8-446b-9876-fcdbb277661c","name":"Customers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"salutation_id\": \"9001\",\r\n \"firstname\": \"Bert\",\r\n \"name\": \"Van de Vyver\",\r\n \"company\": \"SoftTouch BV\",\r\n \"address\": \"Ambachtenlaan 6A\",\r\n \"zip\": \"9080\",\r\n \"city\": \"Lochristi\",\r\n \"country\": \"BE\",\r\n \"telephone\": \"\",\r\n \"mobile\": \"\",\r\n \"email\": \"dev@softtouch.be\",\r\n \"email2\": \"bert.vdv@softtouch.be\",\r\n \"birthday\": \"1995/09/21\",\r\n \"vatid\": \"\",\r\n \"firstvisit\": \"2021/04/23\",\r\n \"lastvisit\": \"2021/04/23\",\r\n \"accepted_gdpr_at\": \"2021/04/23\",\r\n \"faultysms\": false,\r\n \"sendsms\": true,\r\n \"faultyemail\": false,\r\n \"sendemail\": true,\r\n \"faultyemail2\": false,\r\n \"sendemail2\": true,\r\n \"faultymail\": false,\r\n \"sendmail\": true,\r\n \"send_eticket\": true,\r\n \"active\": true,\r\n \"login\": \"bert.vdv@softtouch.be\",\r\n \"password\": \"1234soft\",\r\n \"lastlogin\": \"2023/07/03\",\r\n \"category1\": \"0100\",\r\n \"category2\": \"0200\",\r\n \"category3\": \"0300\",\r\n \"category4\": \"0400\",\r\n \"category5\": \"0500\",\r\n \"category6\": \"0600\",\r\n \"category7\": \"0700\",\r\n \"category8\": \"0800\",\r\n \"category9\": \"0900\",\r\n \"category10\": \"1000\",\r\n \"miscellaneous\": \"\",\r\n \"pos_id\": \"0101\",\r\n \"store_id\": \"01\",\r\n \"is_b2b\": false\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Mon, 03 Jul 2023 09:03:57 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6ImxcL1cydkt5VnNoUjI1M1kxUWx6dkhnPT0iLCJ2YWx1ZSI6InUrN2hmWWFwK2NvSGhoN3VSbnQ5RUo3VmlUSWQxaGlnbldGN3V1S0pTWmRKXC80MnpmSlJtTzZVYTBFaUJBa3BDaWRiOTI3YVhubVFhQzVtTEZ1WmZEZz09IiwibWFjIjoiMjVmMjY0YzViNDBhMDIwNTkwNjExMzA5ZTk2NDVjMzI0MDQzNWMwMTM2ZDgyOTgzODJmODBmZTM5YjNhOGNiNSJ9; expires=Mon, 03-Jul-2023 11:03:57 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 5,\n \"firstname\": \"Bert\",\n \"name\": \"Van de Vyver\",\n \"company\": \"SoftTouch BV\",\n \"address\": \"Ambachtenlaan 6A\",\n \"zip\": \"9080\",\n \"city\": \"Lochristi\",\n \"country\": \"BE\",\n \"telephone\": \"\",\n \"mobile\": \"\",\n \"email\": \"dev@softtouch.be\",\n \"birthday\": \"1995/09/21\",\n \"vatid\": \"\",\n \"firstvisit\": \"2021/04/23\",\n \"lastvisit\": \"2021/04/23\",\n \"accepted_gdpr_at\": \"2021/04/23\",\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": true,\n \"login\": \"bert.vdv@softtouch.be\",\n \"lastlogin\": \"2023/07/03\",\n \"created\": \"2023-07-03 00:00:00\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-03 00:00:00\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"01\",\n \"salutation_id\": \"9001\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-07-03 11:03:57\",\n \"gets_direct_discount\": false,\n \"direct_discount_percentage\": 0,\n \"customer_card_revenue\": 0,\n \"customer_card_percentage\": 0,\n \"customer_card_discount\": 0,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n}"}],"_postman_id":"2ceb7b11-ceba-4a49-87ba-a9aeeeb4a4a6"},{"name":"Customers/validate-login","event":[{"listen":"test","script":{"id":"a2376525-f2d0-4590-b93a-56223c9f21c0","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"a378008f-fa99-421a-9c0f-0eebdee357c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/validate-login?login=stefan@softtouch.be&password=pass1234","description":"

To check if the combination ‘login’ and ‘password’ are valid, the POST controller ‘validate-login’ can be used. When the combination is valid the customer with all its details will be given as a result. If not, a 404 error “Model not found” will be given.

boolean

\n","type":"text/plain"},"key":"is_b2b","value":"0"},{"key":"login","value":"stefan@softtouch.be"},{"key":"password","value":"pass1234"}],"variable":[]}},"response":[{"id":"61356c27-eaaf-43c4-bc07-7eee65843ecc","name":"Customers/validate-login","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/validate-login?login=stefan@softtouch.be&password=pass1234","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","customers","validate-login"],"query":[{"key":"is_b2b","value":"0","description":"boolean","type":"text","disabled":true},{"key":"login","value":"stefan@softtouch.be"},{"key":"password","value":"pass1234"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Mon, 03 Jul 2023 09:09:48 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6InRQTXlRUFZCU2JBcmdvdVdOXC9tMG13PT0iLCJ2YWx1ZSI6InNPQ3JQVmR2SEh5ZlAxTVAweFZQVXN3SWFFXC9BTjQ1MkRHZGd6WkZwUFFqTlM5Q2hSeDNSXC9JSkhOYXNpWktlQVdNTlFpRnJhdWNram0wYTFqU0dacmc9PSIsIm1hYyI6ImI5ZDk2MTdiNmU2MjE3ZTA2ZjYxOTQ4MzFiYzdjMWY1MzI5MWIxOTkyNGNhMjhiY2JiOTFlNWFiYjBiNWI4YmYifQ%3D%3D; expires=Mon, 03-Jul-2023 11:09:48 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 2,\n \"firstname\": \"Stefan\",\n \"name\": \"de Bakker\",\n \"company\": \"SoftTouch Vlaanderen BV\",\n \"address\": \"Ambachtenlaan 6A\",\n \"zip\": \"9080\",\n \"city\": \"Lochristi\",\n \"country\": \"BE\",\n \"telephone\": \"09/219.00.83\",\n \"mobile\": \"\",\n \"email\": \"stefan@softtouch.be\",\n \"birthday\": \"1989-05-27\",\n \"vatid\": \"\",\n \"firstvisit\": \"2016-01-13\",\n \"lastvisit\": \"2023-07-20\",\n \"accepted_gdpr_at\": \"2021-04-23 00:00:00\",\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": true,\n \"login\": \"stefan@softtouch.be\",\n \"lastlogin\": \"2023-07-03 11:09:48\",\n \"created\": \"2023-04-11\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-03\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"01\",\n \"salutation_id\": \"9001\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-07-03 11:09:07\",\n \"gets_direct_discount\": true,\n \"direct_discount_percentage\": 10,\n \"customer_card_revenue\": 743,\n \"customer_card_percentage\": 5,\n \"customer_card_discount\": 37.15,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n}"}],"_postman_id":"a378008f-fa99-421a-9c0f-0eebdee357c5"},{"name":"Customers/{{id}}/add_value_to_discount","event":[{"listen":"test","script":{"id":"477dfe5d-35fd-4032-b1ae-94e44fb04f45","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"42641dcc-faf1-4b8c-a762-63064dfcb00f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2/add_value_to_discount?value=32.15","description":"

Add a specific value to the customer card.

required|numeric

\n","type":"text/plain"},"key":"value","value":"32.15"}],"variable":[]}},"response":[{"id":"20e74a96-848b-4d2e-8e36-083bffe35667","name":"Customers/{{id}}/add_value_to_discount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2/add_value_to_discount?value=32.15","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","customers","2","add_value_to_discount"],"query":[{"key":"value","value":"32.15","description":"required|numeric"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Mon, 03 Jul 2023 09:09:07 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6Impsc2RSUkZOWGtjZDVtclNRTFlkN1E9PSIsInZhbHVlIjoiSkxxMzJMdGhJUVwvTTR4b1lQTG12M1lRVXQwbnF5TG11bGYyTW9CbkE0TXh6a0lSVVRGdFlVc2ZrOFZ3aXVWcHJKaGhuVEZxNFJMQ1huWVR5Z1l0YnlBPT0iLCJtYWMiOiJmMzVjYmYxZThjMWVhMThjNGEwZDU3MDA4OWQzOTUzODBlNjQ1ZGYzNjJiMTliNDJlZWIzYTE3M2IyOTYyMzgzIn0%3D; expires=Mon, 03-Jul-2023 11:09:07 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 2,\n \"firstname\": \"Stefan\",\n \"name\": \"de Bakker\",\n \"company\": \"SoftTouch Vlaanderen BV\",\n \"address\": \"Ambachtenlaan 6A\",\n \"zip\": \"9080\",\n \"city\": \"Lochristi\",\n \"country\": \"BE\",\n \"telephone\": \"09/219.00.83\",\n \"mobile\": \"\",\n \"email\": \"stefan@softtouch.be\",\n \"birthday\": \"1989-05-27\",\n \"vatid\": \"\",\n \"firstvisit\": \"2016-01-13\",\n \"lastvisit\": \"2023-07-20\",\n \"accepted_gdpr_at\": \"2021-04-23 00:00:00\",\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": true,\n \"login\": \"stefan@softtouch.be\",\n \"lastlogin\": \"2023-07-20 00:00:00\",\n \"created\": \"2023-04-11\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-03 00:00:00\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"01\",\n \"salutation_id\": \"9001\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-07-03 11:09:07\",\n \"gets_direct_discount\": true,\n \"direct_discount_percentage\": 10,\n \"customer_card_revenue\": 743,\n \"customer_card_percentage\": 5,\n \"customer_card_discount\": 37.15,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n}"}],"_postman_id":"42641dcc-faf1-4b8c-a762-63064dfcb00f"},{"name":"Customers/{{id}}/customer_card","event":[{"listen":"test","script":{"id":"477dfe5d-35fd-4032-b1ae-94e44fb04f45","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"58922b95-c63d-43c4-8d01-31cf9b1d55f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"klk_discount\": 5,\r\n \"klk_total\": 100,\r\n \"klk_pct\": 5,\r\n \"hist_remark\": \"BERT\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2/customer_card","description":"

To alter the customer card following endpoint can be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
klk_discount	int
klk_total	int
klk_pct	int
hist_remark	string

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","customers","2","customer_card"],"host":["api","softtouch","eu"],"query":[],"variable":[]}},"response":[{"id":"1f0fe98a-9517-4989-a4da-ae1be4f211a8","name":"Customers/{{id}}/customer_card","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"klk_discount\": 5,\r\n \"klk_total\": 100,\r\n \"klk_pct\": 5,\r\n \"hist_remark\": \"BERT\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2/customer_card"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Mon, 03 Jul 2023 09:08:36 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlNFRmxaUG13dWNOSXVvSUtrSjZLeXc9PSIsInZhbHVlIjoiZlFcL2hVMXlubVwvQTdNSVRtc1FzS3JYVEwwRTZkTlk0NWx6N1M0amZkXC8zWEd3QkZBM1djTHVzc0xNcjlaTVVJbUJBNzZBNktIOXczQWp5bEJvRVpjOUE9PSIsIm1hYyI6ImNmOTUzZGZhNzA2NDBkNThjNjg0ZDBlYjVmOWRkOWRmNjk1ZGNhZWU4YjljM2YzYTIyZGZkY2VjNTE0NzI0NGEifQ%3D%3D; expires=Mon, 03-Jul-2023 11:08:36 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 2,\n \"firstname\": \"Stefan\",\n \"name\": \"de Bakker\",\n \"company\": \"SoftTouch Vlaanderen BV\",\n \"address\": \"Ambachtenlaan 6A\",\n \"zip\": \"9080\",\n \"city\": \"Lochristi\",\n \"country\": \"BE\",\n \"telephone\": \"09/219.00.83\",\n \"mobile\": \"\",\n \"email\": \"stefan@softtouch.be\",\n \"birthday\": \"1989-05-27\",\n \"vatid\": \"\",\n \"firstvisit\": \"2016-01-13 00:00:00\",\n \"lastvisit\": \"2023-07-20 00:00:00\",\n \"accepted_gdpr_at\": \"2021-04-23 00:00:00\",\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": true,\n \"login\": \"stefan@softtouch.be\",\n \"lastlogin\": \"2023-07-20 00:00:00\",\n \"created\": \"2023-04-11\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-03 00:00:00\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"01\",\n \"salutation_id\": \"9001\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-07-03 11:08:36\",\n \"gets_direct_discount\": true,\n \"direct_discount_percentage\": 10,\n \"customer_card_revenue\": 100,\n \"customer_card_percentage\": 5,\n \"customer_card_discount\": 5,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n}"}],"_postman_id":"58922b95-c63d-43c4-8d01-31cf9b1d55f8"},{"name":"Customers/bulk_update","event":[{"listen":"test","script":{"id":"f9d3e6d2-314c-4c2d-bd95-1c35ea755875","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"418e52e4-3783-4ca2-a850-6bbb44ca74f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customers\": [\r\n {\r\n \"id\": 5,\r\n \"salutation_id\": \"9001\",\r\n \"firstname\": \"Bert\",\r\n \"name\": \"Van de Vyver\",\r\n \"company\": \"SoftTouch BV\",\r\n \"address\": \"Ambachtenlaan 6A\",\r\n \"zip\": \"9080\",\r\n \"city\": \"Lochristi\",\r\n \"country\": \"BE\",\r\n \"telephone\": \"\",\r\n \"mobile\": \"\",\r\n \"email\": \"bert.vdv@softtouch.be\",\r\n \"email2\": \"bert.vandevyver@softtouch.be\",\r\n \"birthday\": \"1995/09/21\",\r\n \"vatid\": \"\",\r\n \"firstvisit\": \"2021/04/23\",\r\n \"lastvisit\": \"2021/04/23\",\r\n \"accepted_gdpr_at\": \"2021/04/23\",\r\n \"faultysms\": false,\r\n \"sendsms\": true,\r\n \"faultyemail\": false,\r\n \"sendemail\": true,\r\n \"faultyemail2\": false,\r\n \"sendemail2\": true,\r\n \"faultymail\": false,\r\n \"sendmail\": true,\r\n \"send_eticket\": true,\r\n \"active\": true,\r\n \"login\": \"bert.vandevyver@softtouch.be\",\r\n \"password\": \"1234pass\",\r\n \"lastlogin\": \"2021/04/23\",\r\n \"category1\": \"0100\",\r\n \"category2\": \"0200\",\r\n \"category3\": \"0300\",\r\n \"category4\": \"0400\",\r\n \"category5\": \"0500\",\r\n \"category6\": \"0600\",\r\n \"category7\": \"0700\",\r\n \"category8\": \"0800\",\r\n \"category9\": \"0900\",\r\n \"category10\": \"1000\",\r\n \"miscellaneous\": \"\",\r\n \"pos_id\": \"0101\",\r\n \"store_id\": \"01\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"salutation_id\": \"9001\",\r\n \"firstname\": \"Stefan\",\r\n \"name\": \"de Bakker\",\r\n \"company\": \"SoftTouch Vlaanderen BV\",\r\n \"address\": \"Ambachtenlaan 6A\",\r\n \"zip\": \"9080\",\r\n \"city\": \"Lochristi\",\r\n \"country\": \"BE\",\r\n \"telephone\": \"09/219.00.83\",\r\n \"mobile\": \"\",\r\n \"email\": \"stefan@softtouch.be\",\r\n \"email2\": \"dev@softtouch.be\",\r\n \"birthday\": \"1989/05/27\",\r\n \"vatid\": \"\",\r\n \"firstvisit\": \"2016/01/13\",\r\n \"lastvisit\": \"2023/07/20\",\r\n \"accepted_gdpr_at\": \"2021/04/23\",\r\n \"faultysms\": false,\r\n \"sendsms\": true,\r\n \"faultyemail\": false,\r\n \"sendemail\": true,\r\n \"faultyemail2\": false,\r\n \"sendemail2\": true,\r\n \"faultymail\": false,\r\n \"sendmail\": true,\r\n \"send_eticket\": true,\r\n \"active\": true,\r\n \"login\": \"stefan@softtouch.be\",\r\n \"password\": \"pass1234\",\r\n \"lastlogin\": \"2023/07/20\",\r\n \"category1\": \"0100\",\r\n \"category2\": \"0200\",\r\n \"category3\": \"0300\",\r\n \"category4\": \"0400\",\r\n \"category5\": \"0500\",\r\n \"category6\": \"0600\",\r\n \"category7\": \"0700\",\r\n \"category8\": \"0800\",\r\n \"category9\": \"0900\",\r\n \"category10\": \"1000\",\r\n \"miscellaneous\": \"\",\r\n \"pos_id\": \"0101\",\r\n \"store_id\": \"01\"\r\n }\r\n ]\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/bulk_update","description":"

To update multiple customer at once

A customer should at least have a name and address.

name	type
customers	array	array of customers
salutation_id	string	length: 4
firstname	string
name	string	required
company	string
address	string
zip	string
city	string
country	string	ISO value, length: 2
telephone	striing
mobile	string
email	string
email2	string
birthday	date
vatid	string
firstvisit	date
lastvisit	date
accepted_gdpr_at	null or date
faultysms	boolean
sendsms	boolean
faultyemail	boolean
sendemail	boolean
faultymail	boolean
sendmail	boolean
send_eticket	boolean
active	boolean	default: true
login	string	required with password
password	string	required with login
lastLogin	date
category1	string	length: 4
category2	string	length: 4
category3	string	length: 4
category4	string	length: 4
category5	string	length: 4
category6	string	length: 4
category7	string	length: 4
category8	string	length: 4
category9	string	length: 4
category10	string	length: 4
miscellaneous	string
pos_id	string	length: 4
store_id	string	length: 2
is_b2b	boolean	default: false

required|array|max:500

\n","type":"text/plain"},"key":"customers","value":null}],"variable":[]}},"response":[{"id":"2e65ac77-df4c-48fc-836e-4cafa352cb1f","name":"Customers/bulk_update","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customers\": [\r\n {\r\n \"id\": 5,\r\n \"salutation_id\": \"9001\",\r\n \"firstname\": \"Bert\",\r\n \"name\": \"Van de Vyver\",\r\n \"company\": \"SoftTouch BV\",\r\n \"address\": \"Ambachtenlaan 6A\",\r\n \"zip\": \"9080\",\r\n \"city\": \"Lochristi\",\r\n \"country\": \"BE\",\r\n \"telephone\": \"\",\r\n \"mobile\": \"\",\r\n \"email\": \"bert.vdv@softtouch.be\",\r\n \"email2\": \"bert.vandevyver@softtouch.be\",\r\n \"birthday\": \"1995/09/21\",\r\n \"vatid\": \"\",\r\n \"firstvisit\": \"2021/04/23\",\r\n \"lastvisit\": \"2021/04/23\",\r\n \"accepted_gdpr_at\": \"2021/04/23\",\r\n \"faultysms\": false,\r\n \"sendsms\": true,\r\n \"faultyemail\": false,\r\n \"sendemail\": true,\r\n \"faultyemail2\": false,\r\n \"sendemail2\": true,\r\n \"faultymail\": false,\r\n \"sendmail\": true,\r\n \"send_eticket\": true,\r\n \"active\": true,\r\n \"login\": \"bert.vandevyver@softtouch.be\",\r\n \"password\": \"1234pass\",\r\n \"lastlogin\": \"2021/04/23\",\r\n \"category1\": \"0100\",\r\n \"category2\": \"0200\",\r\n \"category3\": \"0300\",\r\n \"category4\": \"0400\",\r\n \"category5\": \"0500\",\r\n \"category6\": \"0600\",\r\n \"category7\": \"0700\",\r\n \"category8\": \"0800\",\r\n \"category9\": \"0900\",\r\n \"category10\": \"1000\",\r\n \"miscellaneous\": \"\",\r\n \"pos_id\": \"0101\",\r\n \"store_id\": \"01\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"salutation_id\": \"9001\",\r\n \"firstname\": \"Stefan\",\r\n \"name\": \"de Bakker\",\r\n \"company\": \"SoftTouch Vlaanderen BV\",\r\n \"address\": \"Ambachtenlaan 6A\",\r\n \"zip\": \"9080\",\r\n \"city\": \"Lochristi\",\r\n \"country\": \"BE\",\r\n \"telephone\": \"09/219.00.83\",\r\n \"mobile\": \"\",\r\n \"email\": \"stefan@softtouch.be\",\r\n \"email2\": \"dev@softtouch.be\",\r\n \"birthday\": \"1989/05/27\",\r\n \"vatid\": \"\",\r\n \"firstvisit\": \"2016/01/13\",\r\n \"lastvisit\": \"2023/07/20\",\r\n \"accepted_gdpr_at\": \"2021/04/23\",\r\n \"faultysms\": false,\r\n \"sendsms\": true,\r\n \"faultyemail\": false,\r\n \"sendemail\": true,\r\n \"faultyemail2\": false,\r\n \"sendemail2\": true,\r\n \"faultymail\": false,\r\n \"sendmail\": true,\r\n \"send_eticket\": true,\r\n \"active\": true,\r\n \"login\": \"stefan@softtouch.be\",\r\n \"password\": \"pass1234\",\r\n \"lastlogin\": \"2023/07/20\",\r\n \"category1\": \"0100\",\r\n \"category2\": \"0200\",\r\n \"category3\": \"0300\",\r\n \"category4\": \"0400\",\r\n \"category5\": \"0500\",\r\n \"category6\": \"0600\",\r\n \"category7\": \"0700\",\r\n \"category8\": \"0800\",\r\n \"category9\": \"0900\",\r\n \"category10\": \"1000\",\r\n \"miscellaneous\": \"\",\r\n \"pos_id\": \"0101\",\r\n \"store_id\": \"01\"\r\n }\r\n ]\r\n}"},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/bulk_update","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","customers","bulk_update"],"query":[{"key":"customers","value":null,"description":"required|array|max:500","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Mon, 03 Jul 2023 09:07:36 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlRjZGVNS1VGclwveHp5ZTlDVXlQYWR3PT0iLCJ2YWx1ZSI6InJsT3pBOXU4ZHlpM2djQ1dxblB1UlhwNUFcL2paNEdCMlRnVnF0QTJueEs3ZzlkRVl2RXA0QkJUelZEdHJ4TkRWSUZtZFpKVm9pNUFmd3lxeXdodzRmZz09IiwibWFjIjoiNjZjNmU3M2RkZDQzYjQ4ZmM0OGRkZGY2ODFjMzEwMWEwOTdmMGVmMTBhYWM1Zjk4NTNlMzM4NDVkMGFmNTRmZCJ9; expires=Mon, 03-Jul-2023 11:07:36 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"418e52e4-3783-4ca2-a850-6bbb44ca74f0"},{"name":"Customers","event":[{"listen":"test","script":{"id":"1cd57818-f071-41a1-8ca9-6d8e24453bcc","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"2b93820a-9e85-4295-91a9-fced6337dd6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"salutation_id\": \"9001\",\r\n \"firstname\": \"Stefan\",\r\n \"name\": \"de Bakker\",\r\n \"company\": \"SoftTouch BV\",\r\n \"address\": \"Ambachtenlaan 6A\",\r\n \"zip\": \"9080\",\r\n \"city\": \"Lochristi\",\r\n \"country\": \"BE\",\r\n \"telephone\": \"09/219.00.83\",\r\n \"mobile\": \"\",\r\n \"email\": \"dev@softtouch.be\",\r\n \"email2\": \"\",\r\n \"birthday\": \"1989/05/27\",\r\n \"vatid\": \"\",\r\n \"firstvisit\": \"2016/01/11\",\r\n \"lastvisit\": \"2023/07/20\",\r\n \"accepted_gdpr_at\": \"2021/04/23\",\r\n \"faultysms\": false,\r\n \"sendsms\": true,\r\n \"faultyemail\": false,\r\n \"sendemail\": true,\r\n \"faultyemail2\": false,\r\n \"sendemail2\": true,\r\n \"faultymail\": false,\r\n \"sendmail\": true,\r\n \"send_eticket\": true,\r\n \"active\": true,\r\n \"login\": \"stefan@softtouch.be\",\r\n \"password\": \"pass1234\",\r\n \"lastlogin\": \"2023/07/20\",\r\n \"category1\": \"0100\",\r\n \"category2\": \"0200\",\r\n \"category3\": \"0300\",\r\n \"category4\": \"0400\",\r\n \"category5\": \"0500\",\r\n \"category6\": \"0600\",\r\n \"category7\": \"0700\",\r\n \"category8\": \"0800\",\r\n \"category9\": \"0900\",\r\n \"category10\": \"1000\",\r\n \"miscellaneous\": \"\",\r\n \"pos_id\": \"0101\",\r\n \"store_id\": \"01\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2","description":"

Update a customer by id.

A customer should at least have a name and address.

name	type
salutation_id	string	length: 4
firstname	string
name	string	required
company	string
address	string
zip	string
city	string
country	string	ISO value, length: 2
telephone	striing
mobile	string
email	string
email2	string
birthday	date
vatid	string
firstvisit	date
lastvisit	date
accepted_gdpr_at	null or date
faultysms	boolean
sendsms	boolean
faultyemail	boolean
sendemail	boolean
faultymail	boolean
sendmail	boolean
send_eticket	boolean
active	boolean	default: true
login	string	required with password
password	string	required with login
lastLogin	date
category1	string	length: 4
category2	string	length: 4
category3	string	length: 4
category4	string	length: 4
category5	string	length: 4
category6	string	length: 4
category7	string	length: 4
category8	string	length: 4
category9	string	length: 4
category10	string	length: 4
miscellaneous	string
pos_id	string	length: 4
store_id	string	length: 2
is_b2b	boolean	default: false

size:4

\n","type":"text/plain"},"key":"salutation_id","value":null},{"disabled":true,"description":{"content":"

alpha|size:2

\n","type":"text/plain"},"key":"country","value":null},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"email","value":null},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"email2","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"birthday","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"firstvisit","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"lastvisit","value":null},{"disabled":true,"description":{"content":"

NullOrDate

\n","type":"text/plain"},"key":"accepted_gdpr","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"faultysms","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"sendsms","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"faultyemail","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"sendemail","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"faultyemail2","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"sendemail2","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"faultymail","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"sendmail","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"send_eticket","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"active","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"lastlogin","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category1","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category2","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category3","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category4","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category5","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category6","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category7","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category8","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category9","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category10","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"pos_id","value":null},{"disabled":true,"description":{"content":"

size:2

\n","type":"text/plain"},"key":"store_id","value":null}],"variable":[]}},"response":[{"id":"ff1b9a68-66a9-4964-873d-d99650e6d07b","name":"Customers","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"salutation_id\": \"9001\",\r\n \"firstname\": \"Stefan\",\r\n \"name\": \"de Bakker\",\r\n \"company\": \"SoftTouch BV\",\r\n \"address\": \"Ambachtenlaan 6A\",\r\n \"zip\": \"9080\",\r\n \"city\": \"Lochristi\",\r\n \"country\": \"BE\",\r\n \"telephone\": \"09/219.00.83\",\r\n \"mobile\": \"\",\r\n \"email\": \"dev@softtouch.be\",\r\n \"email2\": \"\",\r\n \"birthday\": \"1989/05/27\",\r\n \"vatid\": \"\",\r\n \"firstvisit\": \"2016/01/11\",\r\n \"lastvisit\": \"2023/07/20\",\r\n \"accepted_gdpr_at\": \"2021/04/23\",\r\n \"faultysms\": false,\r\n \"sendsms\": true,\r\n \"faultyemail\": false,\r\n \"sendemail\": true,\r\n \"faultyemail2\": false,\r\n \"sendemail2\": true,\r\n \"faultymail\": false,\r\n \"sendmail\": true,\r\n \"send_eticket\": true,\r\n \"active\": true,\r\n \"login\": \"stefan@softtouch.be\",\r\n \"password\": \"pass1234\",\r\n \"lastlogin\": \"2023/07/20\",\r\n \"category1\": \"0100\",\r\n \"category2\": \"0200\",\r\n \"category3\": \"0300\",\r\n \"category4\": \"0400\",\r\n \"category5\": \"0500\",\r\n \"category6\": \"0600\",\r\n \"category7\": \"0700\",\r\n \"category8\": \"0800\",\r\n \"category9\": \"0900\",\r\n \"category10\": \"1000\",\r\n \"miscellaneous\": \"\",\r\n \"pos_id\": \"0101\",\r\n \"store_id\": \"01\"\r\n}"},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","customers","2"],"query":[{"key":"salutation_id","value":null,"description":"size:4","type":"text","disabled":true},{"key":"country","value":null,"description":"alpha|size:2","type":"text","disabled":true},{"key":"email","value":null,"description":"email","type":"text","disabled":true},{"key":"email2","value":null,"description":"email","type":"text","disabled":true},{"key":"birthday","value":null,"description":"date","type":"text","disabled":true},{"key":"firstvisit","value":null,"description":"date","type":"text","disabled":true},{"key":"lastvisit","value":null,"description":"date","type":"text","disabled":true},{"key":"accepted_gdpr","value":null,"description":"NullOrDate","type":"text","disabled":true},{"key":"faultysms","value":null,"description":"boolean","type":"text","disabled":true},{"key":"sendsms","value":null,"description":"boolean","type":"text","disabled":true},{"key":"faultyemail","value":null,"description":"boolean","type":"text","disabled":true},{"key":"sendemail","value":null,"description":"boolean","type":"text","disabled":true},{"key":"faultyemail2","value":null,"description":"boolean","type":"text","disabled":true},{"key":"sendemail2","value":null,"description":"boolean","type":"text","disabled":true},{"key":"faultymail","value":null,"description":"boolean","type":"text","disabled":true},{"key":"sendmail","value":null,"description":"boolean","type":"text","disabled":true},{"key":"send_eticket","value":null,"description":"boolean","type":"text","disabled":true},{"key":"active","value":null,"description":"boolean","type":"text","disabled":true},{"key":"lastlogin","value":null,"description":"date","type":"text","disabled":true},{"key":"category1","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category2","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category3","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category4","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category5","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category6","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category7","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category8","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category9","value":null,"description":"size:4","type":"text","disabled":true},{"key":"category10","value":null,"description":"size:4","type":"text","disabled":true},{"key":"pos_id","value":null,"description":"size:4","type":"text","disabled":true},{"key":"store_id","value":null,"description":"size:2","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Mon, 03 Jul 2023 09:15:18 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6ImdVSzlEQVwvWkJqQXZlZFdXUjhLQUVBPT0iLCJ2YWx1ZSI6ImZxdEZJN1hoblNadHhSOFpYeERtRXJmSVlqdklpbFVuV25RUXJSWGlDNjh4ZTNJbnZlNUM3S09JXC9nQnJNRXBBeWs5TkFcL2g3bXoyUjVRdnVFeENaTmc9PSIsIm1hYyI6IjQ1ZWZjMzc4ZmExZmIyNWNiMjZkYTI1OWI1MjRjYjhiOWRjZWFlNjg2OGI2NzhiYTY2MDQ0Y2I4YmUzMTQ5NzEifQ%3D%3D; expires=Mon, 03-Jul-2023 11:15:18 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 2,\n \"firstname\": \"Stefan\",\n \"name\": \"de Bakker\",\n \"company\": \"SoftTouch BV\",\n \"address\": \"Ambachtenlaan 6A\",\n \"zip\": \"9080\",\n \"city\": \"Lochristi\",\n \"country\": \"BE\",\n \"telephone\": \"09/219.00.83\",\n \"mobile\": \"\",\n \"email\": \"dev@softtouch.be\",\n \"birthday\": \"1989/05/27\",\n \"vatid\": \"\",\n \"firstvisit\": \"2016/01/11\",\n \"lastvisit\": \"2023/07/20\",\n \"accepted_gdpr_at\": \"2021-04-23 00:00:00\",\n \"faultysms\": false,\n \"sendsms\": true,\n \"faultyemail\": false,\n \"sendemail\": true,\n \"faultymail\": false,\n \"sendmail\": true,\n \"active\": true,\n \"login\": \"stefan@softtouch.be\",\n \"lastlogin\": \"2023/07/20\",\n \"created\": \"2023-04-11\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-03 00:00:00\",\n \"modifiedby\": \"1001\",\n \"pos_id\": \"0101\",\n \"store_id\": \"01\",\n \"salutation_id\": \"9001\",\n \"category1\": \"0100\",\n \"category2\": \"0200\",\n \"category3\": \"0300\",\n \"category4\": \"0400\",\n \"category5\": \"0500\",\n \"category6\": \"0600\",\n \"category7\": \"0700\",\n \"category8\": \"0800\",\n \"category9\": \"0900\",\n \"category10\": \"1000\",\n \"miscellaneous\": \"\",\n \"timestamp\": \"2023-07-03 11:15:18\",\n \"gets_direct_discount\": true,\n \"direct_discount_percentage\": 10,\n \"customer_card_revenue\": 743,\n \"customer_card_percentage\": 5,\n \"customer_card_discount\": 37.15,\n \"customer_card_lines\": 0,\n \"customer_card_points\": 0,\n \"cards\": [],\n \"is_b2b\": false\n}"}],"_postman_id":"2b93820a-9e85-4295-91a9-fced6337dd6a"}],"id":"bc4d08c0-5cb7-44e4-8ab6-1fe65d1b989e","description":"

Customers are used to link to various things. When ordering, these are needed to link a delivery address and possibly billing address, among other things.
In addition, a customer can be used to maintain a login to the web shop, any specific information about this customer or a customer card.

In many cases, if a order is made without a customer it is set to a \"general customer\". Often this is customer number 1, but this can vary.

Basic login flow:

$\"\n<br>\n<br>\"$

Advanced login flow:

","_postman_id":"bc4d08c0-5cb7-44e4-8ab6-1fe65d1b989e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Customer categories","item":[{"name":"Customer_categories","event":[{"listen":"test","script":{"id":"586affbd-892e-401b-bdc3-5bb9feed0f86","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"11615498-e640-4eef-a584-b77e1731bc68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customer_categories","description":"

This endpoint fetches all customer categories as all calls it has to be done in steps with a maximum amount of 500 customer categories.

Used parameters:

display (full)
take
skip
group

A brief explanation of return values:

key: The unique identifier
group: The level of the category
description: The description of the category
description2: The description of the category
description3: The description of the category
description4: The description of the category
description5: The description of the category
colorcode: A custom colorcode for internal use
active: If the category can be attached to new customers

To create a new customer category this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
grou	string	length: 2, required
description	string	required
active	boolean	default true

Customers can be linked to different categories. This can be anything, from the language to the sex of the customer or anything that has a limited category options.

key of a category always starts with the group id.
The description of the category should be short and concise.
The active parameter should be true when it should be used.

Note that the logic behind customer categories is very similar to product categories.

\n","_postman_id":"b4840d01-5a3b-4c9b-89b9-786208679670","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Customer family","item":[{"name":"Customers/{{customerId}}/family","event":[{"listen":"test","script":{"id":"2e31df1f-e299-49e6-9cdc-c745b413ebcc","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"8b4b4847-0302-4b86-aa8c-b72919a453ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2/family","description":"

This endpoint fetches a family for a customer.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
customer: The main customer id
text1-5: Free fields, mostly used for name eg
status1 -5: Free fields
date1-3: Free fields, mostly used for date of birth eg
active: If true, this family member can be used

This endpoint fetches a specific familymember for a customer.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
customer: The main customer id
text1-5: Free fields, mostly used for name eg
status1 -5: Free fields
date1-3: Free fields, mostly used for date of birth eg
active: If true, this family member can be used

To create a new family member use this endpoint.

\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status1","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status2","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status3","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date1","value":"21/07/2023"},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date2","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date3","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"active","value":""}],"variable":[]}},"response":[],"_postman_id":"ff176d68-5806-464b-957d-cb65a8db9619"},{"name":"Customers/{{customerId}}/family","event":[{"listen":"test","script":{"id":"547f9eed-ddaf-4810-86a9-634aa4455716","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"adc2af5b-c145-408f-a60a-3010f2afde1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2/family/1","description":"

Update customer family by id.

\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status1","value":null},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status2","value":null},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status3","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date1","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date2","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date3","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"active","value":null}],"variable":[]}},"response":[],"_postman_id":"adc2af5b-c145-408f-a60a-3010f2afde1a"},{"name":"Customers/{{customerId}}/family","event":[{"listen":"test","script":{"id":"f0589007-9074-4a86-9957-134ca5b22e1a","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"7947338b-5885-40d8-b04a-a8cf56089c1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customers/2/family/1","description":"

Delete customer family member.

A customer can have family members, for example a mother is the main customer.

The childeren are the family members.

Note: This function is not often used en should be discussed before implementation.

\n","_postman_id":"3c5ee955-7d35-4762-b7e7-dd13ef0b0fed","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Customer order status todo","item":[{"name":"Customer_order_statuses","event":[{"listen":"test","script":{"id":"5ea368ce-72b2-4748-9377-0c069bd35b76","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"2e94db35-ee66-4c08-844b-18739de12fa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customer_order_statuses","description":"

This endpoint fetches all customer order status as all calls it has to be done in steps with a maximum amount of 500 customer order status.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

required_with:receipt_line|integer|between:1000000000,9999999999

\n","type":"text/plain"},"key":"receipt_id","value":null},{"disabled":true,"description":{"content":"

integer|between:1,65535

\n","type":"text/plain"},"key":"receipt_line","value":null},{"disabled":true,"description":{"content":"

required_with:reservation_line|integer|between:999100000,999199999

\n","type":"text/plain"},"key":"reservation_id","value":null},{"disabled":true,"description":{"content":"

integer|between:1,65535

\n","type":"text/plain"},"key":"reservation_line","value":null},{"disabled":true,"description":{"content":"

integer|between:1,16777215

\n","type":"text/plain"},"key":"transfer_request_item_id","value":null},{"disabled":true,"description":{"content":"

integer|between:1,16777215

\n","type":"text/plain"},"key":"transfer_item_id","value":null},{"disabled":true,"description":{"content":"

size:2

\n","type":"text/plain"},"key":"end_point_warehouse_id","value":null}],"variable":[]}},"response":[],"_postman_id":"2e94db35-ee66-4c08-844b-18739de12fa5"},{"name":"Customer_order_statuses/{{id}}","event":[{"listen":"test","script":{"id":"5ea368ce-72b2-4748-9377-0c069bd35b76","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"9cb13570-70e2-467f-886c-7d760e0c4905","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customer_order_statuses/1","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

required|integer

\n","type":"text/plain"},"key":"id","value":null}],"variable":[]}},"response":[],"_postman_id":"9cb13570-70e2-467f-886c-7d760e0c4905"},{"name":"Customer_order_statuses","event":[{"listen":"test","script":{"id":"5ea368ce-72b2-4748-9377-0c069bd35b76","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"2313b49d-6b78-4418-8dff-aaf82f118481","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"receipt_id\": \t 1234567890,\r\n \"receipt_line\": 1,\r\n \"reservation_id\": 999100001,\r\n \"reservation_line\": 1,\r\n \"transfer_request_item_id\": 1,\r\n \"transfer_item_id\": 1,\r\n \"type_id\": \"00001\",\r\n \"status_id\": \"00001\",\r\n \"end_point_warehouse_id\": \"01\",\r\n \"user_id\": \"1001\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customer_order_statuses","description":"

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

integer|between:1000000000,9999999999

\n","type":"text/plain"},"key":"receipt_id","value":null},{"disabled":true,"description":{"content":"

required_with:receipt_id|integer|between:1,65535

\n","type":"text/plain"},"key":"receipt_line","value":null},{"disabled":true,"description":{"content":"

integer|between:999100000,999199999

\n","type":"text/plain"},"key":"reservation_id","value":null},{"disabled":true,"description":{"content":"

required_with:reservation_id|integer|between:1,65535

\n","type":"text/plain"},"key":"reservation_line","value":null},{"disabled":true,"description":{"content":"

integer|between:1,16777215

\n","type":"text/plain"},"key":"transfer_request_item_id","value":null},{"disabled":true,"description":{"content":"

integer|between:1,16777215

\n","type":"text/plain"},"key":"transfer_item_id","value":null},{"disabled":true,"description":{"content":"

required|size:5

\n","type":"text/plain"},"key":"type_id","value":null},{"disabled":true,"description":{"content":"

required|size:5

\n","type":"text/plain"},"key":"status_id","value":null},{"disabled":true,"description":{"content":"

size:2

\n","type":"text/plain"},"key":"end_point_warehouse_id","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"user_id","value":null}],"variable":[]}},"response":[],"_postman_id":"2313b49d-6b78-4418-8dff-aaf82f118481"},{"name":"Customer_order_statuses/{{id}}","event":[{"listen":"test","script":{"id":"5ea368ce-72b2-4748-9377-0c069bd35b76","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"46437f83-a488-4195-b805-5177953cccaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"receipt_id\": \t 1234567890,\r\n \"receipt_line\": 1,\r\n \"reservation_id\": 999100001,\r\n \"reservation_line\": 1,\r\n \"transfer_request_item_id\": 1,\r\n \"transfer_item_id\": 1,\r\n \"type_id\": \"00001\",\r\n \"status_id\": \"00001\",\r\n \"end_point_warehouse_id\": \"01\",\r\n \"user_id\": \"1001\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customer_order_statuses/1","description":"

Update a customer order status

required|intege

\n","type":"text/plain"},"key":"id","value":null},{"disabled":true,"description":{"content":"

integer|between:1000000000,9999999999

\n","type":"text/plain"},"key":"receipt_id","value":null},{"disabled":true,"description":{"content":"

required_with:receipt_id|integer|between:1,65535

\n","type":"text/plain"},"key":"receipt_line","value":null},{"disabled":true,"description":{"content":"

integer|between:999100000,999199999

\n","type":"text/plain"},"key":"reservation_id","value":null},{"disabled":true,"description":{"content":"

required_with:reservation_id|integer|between:1,65535

\n","type":"text/plain"},"key":"reservation_line","value":null},{"disabled":true,"description":{"content":"

integer|between:1,16777215

\n","type":"text/plain"},"key":"transfer_request_item_id","value":null},{"disabled":true,"description":{"content":"

integer|between:1,16777215

\n","type":"text/plain"},"key":"transfer_item_id","value":null},{"disabled":true,"description":{"content":"

required|size:5

\n","type":"text/plain"},"key":"type_id","value":null},{"disabled":true,"description":{"content":"

required|size:5

\n","type":"text/plain"},"key":"status_id","value":null},{"disabled":true,"description":{"content":"

size:2

\n","type":"text/plain"},"key":"end_point_warehouse_id","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"user_id","value":null}],"variable":[]}},"response":[],"_postman_id":"46437f83-a488-4195-b805-5177953cccaf"}],"id":"4c627334-dbea-49ae-8128-7f7081c570dc","_postman_id":"4c627334-dbea-49ae-8128-7f7081c570dc","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Customer memos","item":[{"name":"Customer_memos","event":[{"listen":"test","script":{"id":"e13afd6b-c3bb-4e92-995a-1f2f68c747be","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"af42c5f9-d2d1-4782-94f9-85aa5db22f93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customer_memos","description":"

This endpoint fetches all customer memo's as all calls it has to be done in steps with a maximum amount of 500 customer memos.

Used parameters:

display (full)
take
skip
customer_id

A brief explanation of return values:

customer_id: The specific customer id
memo: The memo for a specific customer

integer

\n","type":"text/plain"},"key":"customer_id","value":"2"}],"variable":[]}},"response":[],"_postman_id":"af42c5f9-d2d1-4782-94f9-85aa5db22f93"},{"name":"Customer_memos/{{id}}","event":[{"listen":"test","script":{"id":"47b75c90-6e28-4810-bea9-812567a9d123","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"1ccc78d0-0dd7-4bef-a8b6-1a6e9a1c091f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customer_memos/{{id}}","description":"

This endpoint fetches a specific customers memo's as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip
customer_id

A brief explanation of return values:

customer_id: The specific customer id
memo: The memo for a specific customer

To create a new customer memo this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
customer_id	int	required
memo	string	required

To update a customer memo this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
memo	string	required

required

\n","type":"text/plain"},"key":"memo","value":""}],"variable":[]}},"response":[],"_postman_id":"9819fb65-0eeb-4f45-bf49-392d50b7e4a7"},{"name":"Customer_memos","event":[{"listen":"test","script":{"id":"54194850-2114-4337-adac-6e63d01d0532","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"63656432-b5f3-4709-b229-31d83ac0e157","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/customer_memos/2","description":"

List all colors.

This endpoint fetches all delivery addresses as all calls it has to be done in steps with a maximum amount of 500 delivery addresses.

Used parameters:

display (full)
take
skip
id
customer_ids

A brief explanation of return values:

key: The unique identifier
customer: The specific customer
name: The customer delivery name
surname: The customer delivery surname
address: The delivery address
address2: Extra address line
zip: The delivery zip address
city: The delivery city
country: The delivery country
telephone: The delivery phone number
mobile: A mobile phone number for delivery
fax: A fax number for delivery
email: A email address used for delivery
remarks: If the customer has some specific delivery instructions
vatid: If the delivery is for a specific company (doens't relate to an invoice)
created: The creation date of the delivery address
createdby: The userid of the creator
modified: The date of modification
modifiedby: The userid of te modifier

integer

\n","type":"text/plain"},"key":"id","value":null},{"disabled":true,"description":{"content":"

commaSeperatedInteger

\n","type":"text/plain"},"key":"customer_ids","value":null}],"variable":[]}},"response":[{"id":"985cc1a2-d60c-4218-850d-46456a115b68","name":"Deliveryaddresses","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/deliveryaddresses","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","deliveryaddresses"],"query":[{"key":"display","value":"full","type":"text","disabled":true},{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true},{"key":"id","value":null,"description":"integer","type":"text","disabled":true},{"key":"customer_ids","value":null,"description":"commaSeperatedInteger","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 19 Jul 2023 13:36:58 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6Im4zZUwzSjVKSXVQXC9vQnAzcnpDN3FBPT0iLCJ2YWx1ZSI6ImNTRU5aaEVaR0RoYkFER1k2dUNxMmFcL1l1TkNHVGdlMndwTUlDSStjbkJFSUliaUNWVTdMWm9tWmdxc09xeithRUVHdm9INFZEdGZib0xubFJVOFdtZz09IiwibWFjIjoiZTNkNTc5ZmQyZDYwNTQzMGJjZTFmNTFmZjZhOGI2YTE2NzcyYjkwYWJiODMxMjZkMDU0ZmI4YWFhYjQ0Y2I5NyJ9; expires=Wed, 19-Jul-2023 15:36:58 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": 1,\n \"customer\": 2,\n \"name\": \"Stefan\",\n \"surname\": \"de Bakker\",\n \"address\": \"Ambachtenlaan 6A\",\n \"address2\": \"\",\n \"zip\": \"9080\",\n \"city\": \"Lochristi\",\n \"country\": \"BE\",\n \"telephone\": \"092190083\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"email\": \"test@softtouch.be\",\n \"remarks\": \"\",\n \"vatid\": \"0\",\n \"created\": \"2023-07-19\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-19\",\n \"modifiedby\": \"1001\"\n }\n]"}],"_postman_id":"980831a0-5d84-4213-86db-4f2ad3513945"},{"name":"Deliveryaddresses/{{id}}","event":[{"listen":"test","script":{"id":"9ee00b01-0ea5-46ec-ac2f-2583cda01fda","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"47caab92-7ba6-4af0-afa1-ba464824a35c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/deliveryaddresses/1","description":"

This endpoint fetches a specific delivery addresses.

Used parameters:

display (full)
take
skip
id
customer_ids

A brief explanation of return values:

key: The unique identifier
customer: The specific customer
name: The customer delivery name
surname: The customer delivery surname
address: The delivery address
address2: Extra address line
zip: The delivery zip address
city: The delivery city
country: The delivery country
telephone: The delivery phone number
mobile: A mobile phone number for delivery
fax: A fax number for delivery
email: A email address used for delivery
remarks: If the customer has some specific delivery instructions
vatid: If the delivery is for a specific company (doens't relate to an invoice)
created: The creation date of the delivery address
createdby: The userid of the creator
modified: The date of modification
modifiedby: The userid of te modifier

To create a new delivery address this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
customer	int
name	string	required
surname	string
address	string
address2	string
zip	string
city	string
country	string	length: 2
telephone	striing
mobile	string
fax	string
email	string
remarks	string
vatid	string

required|integer

\n","type":"text/plain"},"key":"customer","value":null},{"disabled":true,"key":"name","value":""},{"disabled":true,"key":"surname","value":null},{"disabled":true,"key":"address","value":null},{"disabled":true,"key":"address2","value":null},{"disabled":true,"key":"zip","value":null},{"disabled":true,"key":"city","value":null},{"disabled":true,"description":{"content":"

alpha|size:2

\n","type":"text/plain"},"key":"country","value":null},{"disabled":true,"key":"telephone","value":null},{"disabled":true,"key":"mobile","value":null},{"disabled":true,"key":"fax","value":null},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"email","value":null},{"disabled":true,"key":"remarks","value":null},{"disabled":true,"key":"vatid","value":null}],"variable":[]}},"response":[{"id":"5e44fad0-cacc-4e64-9c4e-bab592d992b4","name":"Deliveryaddresses","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customer\": 2,\r\n \"name\": \"Stefan\",\r\n \"surname\": \"de Bakker\",\r\n \"address\": \"Ambachtenlaan 6A\",\r\n \"address2\": \"\",\r\n \"zip\": \"9080\",\r\n \"city\": \"Lochristi\",\r\n \"country\": \"BE\",\r\n \"telephone\": \"092190083\",\r\n \"mobile\": \"\",\r\n \"fax\": \"\",\r\n \"email\": \"test@softtouch.be\",\r\n \"remarks\": \"\",\r\n \"vatid\": \"0\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/deliveryaddresses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 19 Jul 2023 13:34:15 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IkN5d3hUaThPZzdXMW5qcWxcL0VSa1dBPT0iLCJ2YWx1ZSI6Imd0UTJtVkpsYUpiN2N4dUR1WkRDa0lYbUpUcTUremJKSEZYT2xTdW0zWkROT2ZpckdXR05zMFdNNExxMTZqZGprRDk5aGM1Mk05NTZTeFdRYk9GeFhnPT0iLCJtYWMiOiI0NTcwMTY0YzcyMWMxMmM0YTU5YTAwYjQyMzdjODc2Y2E1OTU3ZTJmMmZmYzgxNjkxODZkZjA3YzYwYmZlNWZmIn0%3D; expires=Wed, 19-Jul-2023 15:34:15 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 1,\n \"customer\": 2,\n \"name\": \"Stefan\",\n \"surname\": \"de Bakker\",\n \"address\": \"Ambachtenlaan 6A\",\n \"address2\": \"\",\n \"zip\": \"9080\",\n \"city\": \"Lochristi\",\n \"country\": \"BE\",\n \"telephone\": \"092190083\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"email\": \"test@softtouch.be\",\n \"remarks\": \"\",\n \"vatid\": \"0\",\n \"created\": \"2023-07-19 00:00:00\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-19 00:00:00\",\n \"modifiedby\": \"1001\"\n}"}],"_postman_id":"59ea65c1-7b62-4b9f-920d-942079cf69ba"},{"name":"Deliveryaddresses","event":[{"listen":"test","script":{"id":"a7f77bd3-385b-4c26-bfe2-d3f8c63a8a48","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"9418ac19-2bbb-4680-a14b-c127a9545ccc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customer\": 2,\r\n \"name\": \"Stefan\",\r\n \"surname\": \"de Bakker\",\r\n \"address\": \"Ambachtenlaan 6a\",\r\n \"address2\": \"\",\r\n \"zip\": \"9080\",\r\n \"city\": \"Zeveneken\",\r\n \"country\": \"BE\",\r\n \"telephone\": \"09/219.00.83\",\r\n \"mobile\": \"\",\r\n \"fax\": \"\",\r\n \"email\": \"stefan@softtouch.be\",\r\n \"remarks\": \"If not home, package can be delivered at the door.\",\r\n \"vatid\": \"\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/deliveryaddresses/1","description":"

To update a delivery address this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
customer	int
name	string	required
surname	string
address	string
address2	string
zip	string
city	string
country	string	length: 2
telephone	striing
mobile	string
fax	string
email	string
remarks	string
vatid	string

To delete a specific delivery address.

A reservation or receipt should have a delivery address id if the order needs to be shipped.

A delivery address does not have to be the same address as the customer's address, for example, if a customer has the package delivered to his work.

\n","_postman_id":"e86db9ef-bbf5-4a3e-a6ca-e1c63671d7f1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Discount types","item":[{"name":"Discount_types","event":[{"listen":"test","script":{"id":"277f3bd8-a1f0-4a29-a883-b094d2cca013","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"3d50b65f-7968-4d44-8d13-a14b12aebc2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/discount_types","description":"

This endpoint fetches all discount types as all calls it has to be done in steps with a maximum amount of 500 discount types.

Used parameters:

display (full)
take
skip

This should be discussed with the client as this is a custom setting.

This endpoint fetches all file_presets as all calls it has to be done in steps with a maximum amount of 500 file_presets.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

id: The unique identifier
description: The description of the file type

This should be discussed with the client as this is a custom setting.

This endpoint fetches all file_presets as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

id: The unique identifier
description: The description of the file type

This should be discussed with the client as this is a custom setting.

This endpoint fetches all text presets as all calls it has to be done in steps with a maximum amount of 500 text presets.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

id: The unique identifier
description: The description of the file type

This should be discussed with the client as this is a custom setting. Not types starting with S are fixed SoftTouch types.

This endpoint fetches a specific text presets as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

id: The unique identifier
description: The description of the file type

This should be discussed with the client as this is a custom setting. Not types starting with S are fixed SoftTouch types.

This endpoint is deprecated, please consult the V2 gift_list_headers endpoint.

max:60

\n","type":"text/plain"},"key":"webuser","value":null},{"disabled":true,"description":{"content":"

CommaSeperatedSize:5

\n","type":"text/plain"},"key":"statuses","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"online","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:5

\n","type":"text/plain"},"key":"gifts/statuses","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"gifts/online","value":null}],"variable":[]}},"response":[{"id":"5e2b6708-0c12-40a8-8db2-efbd3aea14bd","name":"Giftlists - DEPRECATED","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","giftlists"],"query":[{"key":"display","value":"full","type":"text","disabled":true},{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true},{"key":"webuser","value":null,"description":"max:60","type":"text","disabled":true},{"key":"statuses","value":null,"description":"CommaSeperatedSize:5","type":"text","disabled":true},{"key":"online","value":"","description":"boolean","type":"text","disabled":true},{"key":"gifts/statuses","value":null,"description":"CommaSeperatedSize:5","type":"text","disabled":true},{"key":"gifts/online","value":null,"description":"boolean","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 31 Oct 2024 12:28:06 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlhaWnBiekdZakE1SGkzb2ZaUmpkcGc9PSIsInZhbHVlIjoiNkdaQUhxSGNldDh0RVNQTVQ0aG5kUnNvVzhZWDdnVWZwUmRtNzg1Z2hcL1hKeks2cjJHczY2YVdwbHNoOUpaNnJCSWFMU0RGQ09iaGw1dTlLR1BJRE5BPT0iLCJtYWMiOiI3YjhhNmI3NjEzMDY4MTE1M2ViMTkwOTkzNjQ5NDQyNzE5N2E3MzdhZmNlYTQ0ZGQ3YTNlMTg2MjI3ZGFjMWQ5In0%3D; expires=Thu, 31-Oct-2024 14:28:06 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": 1,\n \"customer\": 4,\n \"surname\": \"Doe\",\n \"address\": \"Hoofdstraat 123\",\n \"postcode\": \"1000\",\n \"city\": \"Bruxelles\",\n \"mother\": \"Mother name\",\n \"father\": \"Father name\",\n \"baby_name\": \"Baby name\",\n \"brothers_sisters\": \"Sibling names\",\n \"sex\": \"Sex of the baby\",\n \"free_text\": \"\",\n \"date1\": \"2024-10-06\",\n \"date2\": \"2024-10-08\",\n \"date3\": \"2024-11-30\",\n \"date4\": \"2024-10-28\",\n \"remark\": \"\",\n \"status\": \"01000\",\n \"value1\": 0,\n \"value2\": 0,\n \"value3\": 0,\n \"created\": \"2024-10-28\",\n \"modified\": \"0000-00-00\",\n \"online\": true,\n \"store\": \"02\",\n \"webuser\": \"johndoe_245@fictional.com\",\n \"webpass\": \"Twh43*sLK\",\n \"created_at\": \"2024-10-28 14:19:39\",\n \"updated_at\": \"2024-10-28 14:19:39\",\n \"gifts\": [\n {\n \"key\": 1,\n \"line\": \"1\",\n \"product\": 10000301030102,\n \"buyer_name\": \"\",\n \"buyer_id\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"product_desc\": \"Heren Kleding SoftTouch\",\n \"sales_date\": \"2024-10-28\",\n \"date2\": \"2024-10-28\",\n \"date3\": \"2024-10-28\",\n \"date4\": \"2024-10-28\",\n \"remark\": \"\",\n \"status\": \"01500\",\n \"status2\": \"\",\n \"status3\": \"\",\n \"total\": 19.95,\n \"discount\": 0,\n \"due\": 19.95,\n \"created\": \"2024-10-28\",\n \"modified\": \"2024-10-28\",\n \"online\": true,\n \"location\": \"01700\",\n \"mustbuy\": false,\n \"must_buy\": false,\n \"ticket\": 0,\n \"timestamp\": \"2024-10-28 14:20:49\",\n \"stockstatus\": \"01800\",\n \"pickupby\": \"\",\n \"pre_deliver\": false\n }\n ]\n }\n]"}],"_postman_id":"c18e26cf-f3a0-476d-bfcf-c06c843ed1cc"},{"name":"Giftlists/{{id}} - DEPRECATED","event":[{"listen":"test","script":{"id":"5ff4827c-dccc-4aa1-ad16-12aa53d69d28","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"2b81be3f-c072-42c0-8c80-50a22a03a2a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists/1","description":"

This endpoint is deprecated, please consult the V2 gift_list_headers endpoint.

To create a new giftlist this endpoint should be used.

Warning for all giftlist related endpoints:
Please note that the giftlist module can be very different per client. This module is usually customised a lot for each client individually, which makes it hard to make 100% accurate documentation for every client...
We have tried to make a \"default\" usage, and the explanation below is based on this default.

name	type	Descr.
customer	integer	Customer id to assign to the giftlist
surname	required string	The surname used as the name of the giftlist
address	string	The address of the parents
postcode	string	The postal code of the parents
city	string	The city of the parents
mother	string	The mothers name
father	striing	The fathers name
baby_name	string	The baby's name
brothers_sisters	string	The names of any siblings
sex	string	The sex of the baby
free_text	string	Free text field
date1	date	The expected date of birth of the baby
date2	date	The actual date of birth of the baby
date3	date	The date the list is closed
date4	date	Extra date field
remark	string	Remark field
value1	numeric	Not used.
value2	numeric	Not used.
value3	numeric	Not used.
status	required string	The status of the giftlist. By default the status can be set to the following: 01000 - OPEN 01001 - INACTIVE 01002 - ACTIVE 01003 - CLOSED
online	boolean	True or false, when marked true, the giftlist is available online
store	required string	The store which the giftlist should be created and managed in
webuser	required_with:webpass string	The username / login email used to access the list or buy something from the list.
webpass	required_with:webuser string	The password used to access the list or buy something from the list.

Webuser and webpass are free fields, in case you choose to make use of these fields, you do have to encrypt / hash the webpass yourself. The usage of these fields can also be decided for each project individually... Do you want to use these credentials to allow the parants to manage the list online, or would you like to use these credentials to let other people access the list to buy items from it? The choice is up to your client.

integer

\n","type":"text/plain"},"key":"customer","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"surname","value":null},{"disabled":true,"key":"address","value":null},{"disabled":true,"key":"postcode","value":null},{"disabled":true,"key":"city","value":null},{"disabled":true,"key":"mother","value":null},{"disabled":true,"key":"father","value":null},{"disabled":true,"key":"baby_name","value":null},{"disabled":true,"key":"brothers_sisters","value":null},{"disabled":true,"key":"sex","value":null},{"disabled":true,"key":"free_text","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date1","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date2","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date3","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date4","value":null},{"disabled":true,"key":"remark","value":null},{"disabled":true,"description":{"content":"

required|size:5

\n","type":"text/plain"},"key":"status","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"value1","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"value2","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"value3","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"online","value":null},{"disabled":true,"description":{"content":"

required|size:2

\n","type":"text/plain"},"key":"store","value":null},{"disabled":true,"description":{"content":"

required_with:webpass|max:60

\n","type":"text/plain"},"key":"webuser","value":null},{"disabled":true,"description":{"content":"

required_with:webuser|max:30

\n","type":"text/plain"},"key":"webpass","value":null}],"variable":[]}},"response":[{"id":"6bdc637c-dd77-4742-92e3-4e401d28dea9","name":"Giftlists","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customer\": 1,\r\n \"surname\": \"surname\",\r\n \"address\": \"\",\r\n \"postcode\": \"\",\r\n \"city\": \"\",\r\n \"mother\": \"\",\r\n \"father\": \"\",\r\n \"baby_name\": \"\",\r\n \"brothers_sisters\": \"\",\r\n \"sex\": \"\",\r\n \"free_text\": \"\",\r\n \"date1\": \"2021-08-26\",\r\n \"date2\": \"2021-08-26\",\r\n \"date3\": \"2021-08-26\",\r\n \"date4\": \"2021-08-26\",\r\n \"remark\": \"\",\r\n \"status\": \"01000\",\r\n \"value1\": 0,\r\n \"value2\": 0,\r\n \"value3\": 0,\r\n \"online\": 1,\r\n \"store\": \"01\",\r\n \"webuser\": \"user@softtouch.be\",\r\n \"webpass\": \"THISISTHEPASSWORD\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","giftlists"],"query":[{"key":"customer","value":null,"description":"integer","type":"text","disabled":true},{"key":"surname","value":null,"description":"required","type":"text","disabled":true},{"key":"address","value":null,"type":"text","disabled":true},{"key":"postcode","value":null,"type":"text","disabled":true},{"key":"city","value":null,"type":"text","disabled":true},{"key":"mother","value":null,"type":"text","disabled":true},{"key":"father","value":null,"type":"text","disabled":true},{"key":"baby_name","value":null,"type":"text","disabled":true},{"key":"brothers_sisters","value":null,"type":"text","disabled":true},{"key":"sex","value":null,"type":"text","disabled":true},{"key":"free_text","value":null,"type":"text","disabled":true},{"key":"date1","value":null,"description":"date","type":"text","disabled":true},{"key":"date2","value":null,"description":"date","type":"text","disabled":true},{"key":"date3","value":null,"description":"date","type":"text","disabled":true},{"key":"date4","value":null,"description":"date","type":"text","disabled":true},{"key":"remark","value":null,"type":"text","disabled":true},{"key":"status","value":null,"description":"required|size:5","type":"text","disabled":true},{"key":"value1","value":null,"description":"numeric","type":"text","disabled":true},{"key":"value2","value":null,"description":"numeric","type":"text","disabled":true},{"key":"value3","value":null,"description":"numeric","type":"text","disabled":true},{"key":"online","value":null,"description":"boolean","type":"text","disabled":true},{"key":"store","value":null,"description":"required|size:2","type":"text","disabled":true},{"key":"webuser","value":null,"description":"required_with:webpass|max:60","type":"text","disabled":true},{"key":"webpass","value":null,"description":"required_with:webuser|max:30","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 31 Oct 2024 13:26:23 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IkVpUzNLODMyN2dTMjZEN1pXbHFybFE9PSIsInZhbHVlIjoiMjRCeFN4enJ0OExtRVNIZDhmSHNmZUQ3MGpJTzhpTzYrSk5tNm95UFRlUWU3UWU0ajl6bkdPcGhSY2hvaU5BVE53dTVGQUo3QWhMamd2a1NiT3lTWUE9PSIsIm1hYyI6IjdhZjQ5YmZiMWQ4Y2U5MThmZGQwNDk4MTY5YmI5ZmQ0Y2M5ODg2NmYyMTA1ZDE2NWNiNjM0MTUyZTE3ZDZmMjQifQ%3D%3D; expires=Thu, 31-Oct-2024 15:26:23 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 2,\n \"customer\": 1,\n \"surname\": \"surname\",\n \"address\": \"\",\n \"postcode\": \"\",\n \"city\": \"\",\n \"mother\": \"\",\n \"father\": \"\",\n \"baby_name\": \"\",\n \"brothers_sisters\": \"\",\n \"sex\": \"\",\n \"free_text\": \"\",\n \"date1\": \"0001-01-01\",\n \"date2\": \"0001-01-01\",\n \"date3\": \"0001-01-01\",\n \"date4\": \"0001-01-01\",\n \"remark\": \"\",\n \"status\": \"01000\",\n \"value1\": 0,\n \"value2\": 0,\n \"value3\": 0,\n \"created\": \"2024-10-31 00:00:00\",\n \"modified\": \"2024-10-31 00:00:00\",\n \"online\": true,\n \"store\": \"01\",\n \"webuser\": \"user@softtouch.be\",\n \"webpass\": \"THISISTHEPASSWORD\",\n \"created_at\": null,\n \"updated_at\": null,\n \"gifts\": []\n}"}],"_postman_id":"659df713-0313-49b3-851f-1344cb5d5297"},{"name":"Giftlists/validate-webuser","event":[{"listen":"test","script":{"id":"0ae22b42-6c4a-405f-b5bd-64415a5a8301","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"b457353e-6ad8-4ce4-8894-a7a5229a0bb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"webuser\": \"johndoe_245@fictional.com\",\r\n \"webpass\": \"Twh43*sLK\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists/validate-webuser","description":"

To verify a giftlist login, you may use this endpoint.

The response will validate the webuser and webpass login credentials and return the coresponding giftlist.

required|max:60

\n","type":"text/plain"},"key":"webuser","value":null},{"disabled":true,"description":{"content":"

required|max:30

\n","type":"text/plain"},"key":"webpass","value":null}],"variable":[]}},"response":[{"id":"f8824259-c21e-496b-8371-d4504eb0bf75","name":"Giftlists/validate-webuser","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"webuser\": \"johndoe_245@fictional.com\",\r\n \"webpass\": \"Twh43*sLK\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists/validate-webuser","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","giftlists","validate-webuser"],"query":[{"key":"webuser","value":null,"description":"required|max:60","type":"text","disabled":true},{"key":"webpass","value":null,"description":"required|max:30","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 31 Oct 2024 15:07:53 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlhFbTd3M3FtNU13SmxhZmlvUExiQ1E9PSIsInZhbHVlIjoiNk5mem5RUFJTZFVlNTAyaDMrN3NoTklKbmtJOHZcL2hnalhIdDdlVTZPRFhwdXBwRWxOanc5VjU3U0VaVERZZkhiT0g3NHpndldDcUZ5VzQrMFwvTUVWQT09IiwibWFjIjoiNzFhNzQxYTVjYWMzYjMzYWFhNDM5YmViOTU1MzUwZGFkNTg3NjZiZDk4MGMzNmVkMzk5OTc2NzNjNjk5ZDE5NCJ9; expires=Thu, 31-Oct-2024 17:07:53 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 1,\n \"customer\": 4,\n \"surname\": \"Doe\",\n \"address\": \"Hoofdstraat 123\",\n \"postcode\": \"1000\",\n \"city\": \"Bruxelles\",\n \"mother\": \"Mother name\",\n \"father\": \"Father name\",\n \"baby_name\": \"Baby name\",\n \"brothers_sisters\": \"Sibling names\",\n \"sex\": \"Sex of the baby\",\n \"free_text\": \"\",\n \"date1\": \"2024-10-06\",\n \"date2\": \"2024-10-08\",\n \"date3\": \"2024-11-30\",\n \"date4\": \"2024-10-28\",\n \"remark\": \"\",\n \"status\": \"01000\",\n \"value1\": 0,\n \"value2\": 0,\n \"value3\": 0,\n \"created\": \"2024-10-28\",\n \"modified\": \"0000-00-00\",\n \"online\": true,\n \"store\": \"02\",\n \"webuser\": \"johndoe_245@fictional.com\",\n \"webpass\": \"Twh43*sLK\",\n \"created_at\": \"2024-10-28 14:19:39\",\n \"updated_at\": \"2024-10-28 14:19:39\",\n \"gifts\": [\n {\n \"key\": 1,\n \"line\": \"1\",\n \"product\": 10000301030102,\n \"buyer_name\": \"\",\n \"buyer_id\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"product_desc\": \"Heren Kleding SoftTouch\",\n \"sales_date\": \"2024-10-28\",\n \"date2\": \"2024-10-28\",\n \"date3\": \"2024-10-28\",\n \"date4\": \"2024-10-28\",\n \"remark\": \"\",\n \"status\": \"01500\",\n \"status2\": \"\",\n \"status3\": \"\",\n \"total\": 19.95,\n \"discount\": 0,\n \"due\": 19.95,\n \"created\": \"2024-10-28\",\n \"modified\": \"2024-10-28\",\n \"online\": true,\n \"location\": \"01700\",\n \"mustbuy\": false,\n \"must_buy\": false,\n \"ticket\": 0,\n \"timestamp\": \"2024-10-28 14:20:49\",\n \"stockstatus\": \"01800\",\n \"pickupby\": \"\",\n \"pre_deliver\": false\n }\n ]\n}"}],"_postman_id":"b457353e-6ad8-4ce4-8894-a7a5229a0bb2"},{"name":"Gifts","event":[{"listen":"test","script":{"id":"ca1023ea-8cb6-47b6-b7a8-d190f77c5ce7","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"83d482be-a75f-4f2c-b672-36804c0c128a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product\": 10000301030101,\r\n \"buyer_name\": \"\",\r\n \"buyer_id\": \"\",\r\n \"text3\": \"\",\r\n \"text4\": \"\",\r\n \"text5\": \"\",\r\n \"text6\": \"\",\r\n \"text7\": \"\",\r\n \"text8\": \"\",\r\n \"text9\": \"\",\r\n \"product_desc\": \"This is a description.\",\r\n \"remark\": \"\",\r\n \"status\": \"01500\",\r\n \"total\": 100,\r\n \"discount\": 25,\r\n \"due\": 75,\r\n \"online\": true,\r\n \"location\": \"01700\",\r\n \"mustbuy\": false,\r\n \"ticket\": \"\",\r\n \"stockstatus\": \"01802\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists/2/gifts","description":"

To create a new gift on a giftlist this endpoint should be used.

name	type
product	required product	The product (uid / key) of the gift
buyer_name	string	The name of the buyer
buyer_id	string	The customer id of the buyer
text3	string
text4	string
text5	string
text6	string
text7	string
text8	string
text9	string
product_desc	string	The product description for the gift
sales_date	date	The date the gift was purchased
date2	date
date3	date
date4	date
remark	string
status	required size: 5	The status of the gift, this should be one of the following: 01500 - OPEN 01501 - RESERVED 01502 - SOLD
total	required numeric	The total value of the gift before discount
discount	required numeric	The total discount of the gift
due	required numeric	The total value of the gift after discount
online	boolean	If true, the gift should be shown online
must_buy	boolean	If true, the gift HAS to be purchased by the end of the giftlist
ticket	string	The receipt or reservation id the gift got purchased on
stockstatus	size: 5	The status of the stock for this gift, this can be one of the following: 01800 - OPEN 01801 ORDER 01802 - STOCK
pickupby	size: 5	The choice of who will pickup the gift, this can be one of the following: 01600 - GIFTER 01601 - LIST OWNER
location	size: 5	The location of the gift, this can be one of the following: 01700 - STORE 01701 - GIFTER 01702 - LIST OWNER
pre_deliver	boolean	TODO
status2	size:5	This is a custom status field, values can vary per client, however for status2 the values will always start with \"013\".
status3	size:5	This is a custom status field, values can vary per client, however for status2 the values will always start with \"014\".

In order to create a gift, you will need an existing giftlist.

A gift is also required to have a product, which should always be a barcode (product key) that exists within the store of the giftlist.
Furthermore, it's also required to put a product description, status, total, discount and due amount.

The status, by default, should be 01500 (OPEN), unless you're adding a gift voucher to a gift list, in which case the status will immediately be 01501 (RESERVED, for reservations) or 01502 (SOLD, for receipts).

The total, discount and due amount should always be calculated alongside eachother.

In most cases, once an item has been added on the list, the total, discount and due should not change (even if the article price changes due to sales), this means that when you're selling a gift, you have to use the due price of the gift, and not the current price.

When selling a gift on a receipt, it is very important you assign the \"ticket\" (that being either the reservation id or the receipt id) and also the \"pickupby\" field. In most cases the pickup will be done by either the parents themselves (LIST OWNER - 01601) or by the gifter (01701), you should provide the customer the choice unless otherwise specified.

Meanwhile, if a shipping label is created or the item will be picked up in the store, you should also choose the corresponding \"location\", this is the CURRENT location of the gift.
If you have a shipping integration and the gift gets shipped, you should update the location accordingly, otherwise you should default the location to 01700 (STORE).

Any other field can be freely used according to its usage, don't hesitate to ask for more information via dev@softtouch.be when something is unclear or seems to deviate from the default.

required|integer|between:10000000000000,99999999999999

\n","type":"text/plain"},"key":"product","value":""},{"disabled":true,"key":"buyer_name","value":""},{"disabled":true,"key":"buyer_id","value":""},{"disabled":true,"key":"text3","value":""},{"disabled":true,"key":"text4","value":""},{"disabled":true,"key":"text5","value":""},{"disabled":true,"key":"text6","value":""},{"disabled":true,"key":"text7","value":""},{"disabled":true,"key":"text8","value":""},{"disabled":true,"key":"text9","value":""},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"product_desc","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"sales_date","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date2","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date3","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date4","value":""},{"disabled":true,"key":"remark","value":""},{"disabled":true,"description":{"content":"

required|size:5

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

required|numeric

\n","type":"text/plain"},"key":"total","value":""},{"disabled":true,"description":{"content":"

required|numeric

\n","type":"text/plain"},"key":"discount","value":""},{"disabled":true,"description":{"content":"

required|numeric

\n","type":"text/plain"},"key":"due","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"online","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"location","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"mustbuy","value":""},{"disabled":true,"key":"ticket","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"stockstatus","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"pickupby","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"pre_deliver","value":null},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status2","value":null},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status3","value":null}],"variable":[]}},"response":[{"id":"51ac5852-1ca5-4dc6-aa50-c020484db1e6","name":"Gifts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product\": 10000301030101,\r\n \"buyer_name\": \"\",\r\n \"buyer_id\": \"\",\r\n \"text3\": \"\",\r\n \"text4\": \"\",\r\n \"text5\": \"\",\r\n \"text6\": \"\",\r\n \"text7\": \"\",\r\n \"text8\": \"\",\r\n \"text9\": \"\",\r\n \"product_desc\": \"This is a description.\",\r\n \"remark\": \"\",\r\n \"status\": \"01500\",\r\n \"total\": 100,\r\n \"discount\": 25,\r\n \"due\": 75,\r\n \"online\": true,\r\n \"location\": \"01700\",\r\n \"mustbuy\": false,\r\n \"ticket\": \"\",\r\n \"stockstatus\": \"01802\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists/2/gifts","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","giftlists","2","gifts"],"query":[{"key":"product","value":null,"description":"required|integer|between:10000000000000,99999999999999","type":"text","disabled":true},{"key":"buyer_name","value":null,"type":"text","disabled":true},{"key":"buyer_id","value":null,"type":"text","disabled":true},{"key":"text3","value":null,"type":"text","disabled":true},{"key":"text4","value":null,"type":"text","disabled":true},{"key":"text5","value":null,"type":"text","disabled":true},{"key":"text6","value":null,"type":"text","disabled":true},{"key":"text7","value":null,"type":"text","disabled":true},{"key":"text8","value":null,"type":"text","disabled":true},{"key":"text9","value":null,"type":"text","disabled":true},{"key":"product_desc","value":null,"description":"required","type":"text","disabled":true},{"key":"sales_date","value":null,"description":"date","type":"text","disabled":true},{"key":"date2","value":null,"description":"date","type":"text","disabled":true},{"key":"date3","value":null,"description":"date","type":"text","disabled":true},{"key":"date4","value":null,"description":"date","type":"text","disabled":true},{"key":"remark","value":null,"type":"text","disabled":true},{"key":"status","value":null,"description":"required|size:5","type":"text","disabled":true},{"key":"total","value":null,"description":"required|numeric","type":"text","disabled":true},{"key":"discount","value":null,"description":"required|numeric","type":"text","disabled":true},{"key":"due","value":null,"description":"required|numeric","type":"text","disabled":true},{"key":"online","value":null,"description":"boolean","type":"text","disabled":true},{"key":"location","value":null,"description":"size:5","type":"text","disabled":true},{"key":"mustbuy","value":null,"description":"boolean","type":"text","disabled":true},{"key":"ticket","value":null,"type":"text","disabled":true},{"key":"stockstatus","value":null,"description":"size:5","type":"text","disabled":true},{"key":"pickupby","value":null,"description":"size:5","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 31 Oct 2024 16:26:14 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IkNsNHJQOFwvMzNsNVhyeDhEVnhjcUtBPT0iLCJ2YWx1ZSI6ImcxXC95RG9cL3E2M3B1VUJsNjZOTmNnUVNyb0NVVkpvVHI4eXIrWFQ4Tk8xMnErVFN4NWNsWmUyandFZTMrYkxqeGZlbitlMDZ1NEN3SXVldk1cL0t2aVhnPT0iLCJtYWMiOiJjYjBkNDQ2ODg4ZjUxMzhiNmJiYjQwNmNkZDBjZjgxNDliMzY0N2NkMjBiZjc5NzExYTdjYTg0YjczMmEzZGRlIn0%3D; expires=Thu, 31-Oct-2024 18:26:14 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 2,\n \"line\": \"1\",\n \"product\": 10000301030101,\n \"buyer_name\": \"\",\n \"buyer_id\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"product_desc\": \"This is a description.\",\n \"sales_date\": \"2024-10-31\",\n \"date2\": \"2024-10-31\",\n \"date3\": \"2024-10-31\",\n \"date4\": \"2024-10-31\",\n \"remark\": \"\",\n \"status\": \"01500\",\n \"status2\": \"\",\n \"status3\": \"\",\n \"total\": 100,\n \"discount\": 25,\n \"due\": 75,\n \"created\": \"2024-10-31 00:00:00\",\n \"modified\": \"2024-10-31 00:00:00\",\n \"online\": true,\n \"location\": \"01700\",\n \"mustbuy\": false,\n \"must_buy\": false,\n \"ticket\": 0,\n \"timestamp\": \"2024-10-31 17:26:14\",\n \"stockstatus\": \"01802\",\n \"pickupby\": \"\",\n \"pre_deliver\": false\n}"}],"_postman_id":"83d482be-a75f-4f2c-b672-36804c0c128a"},{"name":"Giftlists","event":[{"listen":"test","script":{"id":"1da3e07f-6f70-4103-9d5e-d4267eede376","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"b2a1b664-77c1-4f8b-be4d-8dcab3f10611","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"date2\": \"2024-09-30\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists/1","description":"

To update an existing giftlist, use this endpoint.

For more information of the fields you can update, please check the POST endpoint for giftlists.

integer

\n","type":"text/plain"},"key":"customer","value":null},{"disabled":true,"description":{"content":"

required

date

\n","type":"text/plain"},"key":"date1","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date2","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date3","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date4","value":null},{"disabled":true,"key":"remark","value":null},{"disabled":true,"description":{"content":"

required|size:5

\n","type":"text/plain"},"key":"status","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"value1","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"value2","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"value3","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"online","value":null},{"disabled":true,"description":{"content":"

required|size:2

\n","type":"text/plain"},"key":"store","value":null},{"disabled":true,"description":{"content":"

required_with:webpass|max:60

\n","type":"text/plain"},"key":"webuser","value":null},{"disabled":true,"description":{"content":"

required_with:webuser|max:30

\n","type":"text/plain"},"key":"webpass","value":null}],"variable":[]}},"response":[{"id":"78dfef03-afc4-4338-bf24-1b2441201d42","name":"Giftlists","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"date2\": \"2024-09-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists/1","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","giftlists","1"],"query":[{"key":"customer","value":null,"description":"integer","type":"text","disabled":true},{"key":"surname","value":null,"description":"required","type":"text","disabled":true},{"key":"address","value":null,"type":"text","disabled":true},{"key":"postcode","value":null,"type":"text","disabled":true},{"key":"city","value":null,"type":"text","disabled":true},{"key":"mother","value":null,"type":"text","disabled":true},{"key":"father","value":null,"type":"text","disabled":true},{"key":"baby_name","value":null,"type":"text","disabled":true},{"key":"brothers_sisters","value":null,"type":"text","disabled":true},{"key":"sex","value":null,"type":"text","disabled":true},{"key":"free_text","value":null,"type":"text","disabled":true},{"key":"date1","value":null,"description":"date","type":"text","disabled":true},{"key":"date2","value":null,"description":"date","type":"text","disabled":true},{"key":"date3","value":null,"description":"date","type":"text","disabled":true},{"key":"date4","value":null,"description":"date","type":"text","disabled":true},{"key":"remark","value":null,"type":"text","disabled":true},{"key":"status","value":null,"description":"required|size:5","type":"text","disabled":true},{"key":"value1","value":null,"description":"numeric","type":"text","disabled":true},{"key":"value2","value":null,"description":"numeric","type":"text","disabled":true},{"key":"value3","value":null,"description":"numeric","type":"text","disabled":true},{"key":"online","value":null,"description":"boolean","type":"text","disabled":true},{"key":"store","value":null,"description":"required|size:2","type":"text","disabled":true},{"key":"webuser","value":null,"description":"required_with:webpass|max:60","type":"text","disabled":true},{"key":"webpass","value":null,"description":"required_with:webuser|max:30","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 07 Nov 2024 08:07:29 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlgzWnVpYTBOTDRLZHhnRDE4WWlOK3c9PSIsInZhbHVlIjoieHBtXC9pSTN6UStZQ2pDYWVBRDFlZkhDaEpEUFFFd1U4NEFzYjFPNDNIKzJpZXNJSm1zZ1RTdTdcL1VYa1Z3cVZPZWpGY3htVHRtMHQxZE9xQnRWbmRoZz09IiwibWFjIjoiZDgyMWFhMTgxODZlNjJiODBmODZiNTNmNGJjNjE2YmRmMmI4YzhkMDIxZDJlZmRlNTg2NjJiNTM4MWY5YjI3ZCJ9; expires=Thu, 07-Nov-2024 10:07:29 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 1,\n \"customer\": 4,\n \"surname\": \"Doe\",\n \"address\": \"Hoofdstraat 123\",\n \"postcode\": \"1000\",\n \"city\": \"Bruxelles\",\n \"mother\": \"Mother name\",\n \"father\": \"Father name\",\n \"baby_name\": \"Baby name\",\n \"brothers_sisters\": \"Sibling names\",\n \"sex\": \"Sex of the baby\",\n \"free_text\": \"\",\n \"date1\": \"2024-10-06\",\n \"date2\": \"2024-09-30\",\n \"date3\": \"2024-11-30\",\n \"date4\": \"2024-10-28\",\n \"remark\": \"\",\n \"status\": \"01000\",\n \"value1\": 0,\n \"value2\": 0,\n \"value3\": 0,\n \"created\": \"2024-10-28\",\n \"modified\": \"2024-11-07 00:00:00\",\n \"online\": true,\n \"store\": \"02\",\n \"webuser\": \"johndoe_245@fictional.com\",\n \"webpass\": \"Twh43*sLK\",\n \"created_at\": \"2024-10-28 14:19:39\",\n \"updated_at\": \"2024-10-28 14:19:39\",\n \"gifts\": [\n {\n \"key\": 1,\n \"line\": \"1\",\n \"product\": 10000301030102,\n \"buyer_name\": \"\",\n \"buyer_id\": \"\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"product_desc\": \"Heren Kleding SoftTouch\",\n \"sales_date\": \"2024-10-28\",\n \"date2\": \"2024-10-28\",\n \"date3\": \"2024-10-28\",\n \"date4\": \"2024-10-28\",\n \"remark\": \"\",\n \"status\": \"01500\",\n \"status2\": \"\",\n \"status3\": \"\",\n \"total\": 19.95,\n \"discount\": 0,\n \"due\": 19.95,\n \"created\": \"2024-10-28\",\n \"modified\": \"2024-10-28\",\n \"online\": true,\n \"location\": \"01700\",\n \"mustbuy\": false,\n \"must_buy\": false,\n \"ticket\": 0,\n \"timestamp\": \"2024-10-28 14:20:49\",\n \"stockstatus\": \"01800\",\n \"pickupby\": \"\",\n \"pre_deliver\": false\n }\n ]\n}"}],"_postman_id":"b2a1b664-77c1-4f8b-be4d-8dcab3f10611"},{"name":"Gifts","event":[{"listen":"test","script":{"id":"1b690f7d-f3ad-4afe-88ce-c815da335ad4","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"e09ba8fd-4795-48e3-bcb0-ef9b1a331cc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"buyer_name\": \"Uncle John\",\r\n \"buyer_id\": \"4\",\r\n \"sales_date\": \"2024-10-30\",\r\n \"remark\": \"Hope you enjoy this little gift!\",\r\n \"status\": \"01502\",\r\n \"ticket\": \"1000000002\",\r\n \"location\": \"01700\",\r\n \"pickupby\": \"01601\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists/2/gifts/2","description":"

To update an existing gift on a giftlist, use this endpoint.

Most parameters that can be updated have already been explained in the gifts POST endpoint, please take a look at the POST endpoint for more information on most parameters.

The patch call will most often be used after a gift has been purchased, a couple of things need to be updated when this happens:

The buyer_name and buyer_id should be updated, the buyer_id is the customer_id of the buyer and the buyer_name is just a string field in which you could technically put whatever the buyer wants to be called.
\n
Sales_date needs to be updated to the date the gift was purchased.
\n
Remark could be filled in with a message from the buyer (optional, but often requested)
\n
The status, pickupby and possibly location needs to be updated as well, for more information on this, please check the POST endpoint for gifts.
\n
The ticket field must be updated to the receipt or reservation id (the id of whichever transaction you are using)
\n

integer|between:10000000000000,99999999999999

date

\n","type":"text/plain"},"key":"sales_date","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date2","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date3","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date4","value":""},{"disabled":true,"key":"remark","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status2","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"status3","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"stockstatus","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"pickupby","value":""},{"disabled":true,"description":{"content":"

size:5

\n","type":"text/plain"},"key":"location","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"total","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"discount","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"due","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"online","value":""},{"disabled":true,"key":"ticket","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"mustbuy","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"pre_deliver","value":""}],"variable":[]}},"response":[{"id":"3aa2e82e-32e7-476e-9f8a-64ab74c2cc61","name":"Gifts","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"buyer_name\": \"Uncle John\",\r\n \"buyer_id\": \"4\",\r\n \"sales_date\": \"2024-10-30\",\r\n \"remark\": \"Hope you enjoy this little gift!\",\r\n \"status\": \"01502\",\r\n \"ticket\": \"1000000002\",\r\n \"location\": \"01700\",\r\n \"pickupby\": \"01601\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/giftlists/2/gifts/2","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","giftlists","2","gifts","2"],"query":[{"key":"product","value":"","description":"integer|between:10000000000000,99999999999999","type":"text","disabled":true},{"key":"buyer_name","value":"","type":"text","disabled":true},{"key":"buyer_id","value":"","type":"text","disabled":true},{"key":"text3","value":"","type":"text","disabled":true},{"key":"text4","value":"","type":"text","disabled":true},{"key":"text5","value":"","type":"text","disabled":true},{"key":"text6","value":"","type":"text","disabled":true},{"key":"text7","value":"","type":"text","disabled":true},{"key":"text8","value":"","type":"text","disabled":true},{"key":"text9","value":"","type":"text","disabled":true},{"key":"product_desc","value":"","type":"text","disabled":true},{"key":"sales_date","value":"","description":"date","type":"text","disabled":true},{"key":"date2","value":"","description":"date","type":"text","disabled":true},{"key":"date3","value":"","description":"date","type":"text","disabled":true},{"key":"date4","value":"","description":"date","type":"text","disabled":true},{"key":"remark","value":"","type":"text","disabled":true},{"key":"status","value":"","description":"size:5","type":"text","disabled":true},{"key":"status2","value":"","description":"size:5","type":"text","disabled":true},{"key":"status3","value":"","description":"size:5","type":"text","disabled":true},{"key":"stockstatus","value":"","description":"size:5","type":"text","disabled":true},{"key":"pickupby","value":"","description":"size:5","type":"text","disabled":true},{"key":"location","value":"","description":"size:5","type":"text","disabled":true},{"key":"total","value":"","description":"numeric","type":"text","disabled":true},{"key":"discount","value":"","description":"numeric","type":"text","disabled":true},{"key":"due","value":"","description":"numeric","type":"text","disabled":true},{"key":"online","value":"","description":"boolean","type":"text","disabled":true},{"key":"ticket","value":"","type":"text","disabled":true},{"key":"mustbuy","value":"","description":"boolean","type":"text","disabled":true},{"key":"pre_deliver","value":"","description":"boolean","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 07 Nov 2024 07:59:53 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6InNYejJONHZrMGJ6a1RTY1JRbmZtcUE9PSIsInZhbHVlIjoiRmtaVnJBTzJ3MHVkMVE5SmVTUFB1Yml4a0dKcEtid3RMVjRUdThXN3lhT2FUK1FkYjFqMU8yUzVcL0JDZWpBa1loNWtrSjduNUdaeHJSWHBuc2FBbU13PT0iLCJtYWMiOiJkMDA3NDhiODBlYTQ4NjliNjRhN2JkYTRmMmQzMGY1YmIzMjZmZGMyMDYyZTY4M2VkODA1NDJhZTg3OTAzMzdjIn0%3D; expires=Thu, 07-Nov-2024 09:59:53 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 2,\n \"line\": \"1\",\n \"product\": 10000301030101,\n \"buyer_name\": \"Uncle John\",\n \"buyer_id\": \"4\",\n \"text3\": \"\",\n \"text4\": \"\",\n \"text5\": \"\",\n \"text6\": \"\",\n \"text7\": \"\",\n \"text8\": \"\",\n \"text9\": \"\",\n \"product_desc\": \"This is a description.\",\n \"sales_date\": \"2024-10-30\",\n \"date2\": \"2024-10-31\",\n \"date3\": \"2024-10-31\",\n \"date4\": \"2024-10-31\",\n \"remark\": \"Hope you enjoy this little gift!\",\n \"status\": \"01502\",\n \"status2\": \"\",\n \"status3\": \"\",\n \"total\": 100,\n \"discount\": 25,\n \"due\": 75,\n \"created\": \"2024-10-31\",\n \"modified\": \"2024-11-07 00:00:00\",\n \"online\": true,\n \"location\": \"01700\",\n \"mustbuy\": false,\n \"must_buy\": false,\n \"ticket\": 1000000002,\n \"timestamp\": \"2024-11-07 08:59:53\",\n \"stockstatus\": \"01802\",\n \"pickupby\": \"01601\",\n \"pre_deliver\": false\n}"}],"_postman_id":"e09ba8fd-4795-48e3-bcb0-ef9b1a331cc6"}],"id":"b7db477e-cbb5-4700-9004-2ae10e2fb842","description":"

Warning for all giftlist related endpoints:
Please note that the giftlist module can be very different per client. This module is usually customised a lot for each client individually, which makes it hard to make 100% accurate documentation for every client...
We have tried to make a \"default\" usage, anything mentioned in this documentation is by the rules of this default.

\n","_postman_id":"b7db477e-cbb5-4700-9004-2ae10e2fb842","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Invoices","item":[{"name":"Invoices","event":[{"listen":"test","script":{"id":"fd6cf32b-0e0c-4b9f-bb06-c93b2393e4c0","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"323d49cc-7520-4782-9dd1-62ec5939c8c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/corporations/01/invoices","description":"

This endpoint fetches all invoices as all calls it has to be done in steps with a maximum amount of 500 invoices.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
corporation_id: The customer corporation id
name_1: The customers brand name
name_2: A second name of the customer, mostely used for the specific customer name.
address_1: The company's address
address_2: The company's address
country_iso: The company's country ISO code
vat_number: The company's vat number
net_sales_price: The total sales price
net_discount: The total discount
net_total: The total of the invoice
vat_price: The total vat amount
gross_total: The total including vat
structured_communication: The invoice reference for payment
items: Array of items
items -> key: Line number
items -> description: Product description
items -> quantity: The amount of this product
items -> net_unit_price: The netto price of this product
items -> discount: The item discount
items -> net_total: The total of this product
items -> vat_percentage: The vat percentage of this product

This endpoint fetches a specific invoice.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
corporation_id: The customer corporation id
name_1: The customers brand name
name_2: A second name of the customer, mostely used for the specific customer name.
address_1: The company's address
address_2: The company's address
country_iso: The company's country ISO code
vat_number: The company's vat number
net_sales_price: The total sales price
net_discount: The total discount
net_total: The total of the invoice
vat_price: The total vat amount
gross_total: The total including vat
structured_communication: The invoice reference for payment
items: Array of items
items -> key: Line number
items -> description: Product description
items -> quantity: The amount of this product
items -> net_unit_price: The netto price of this product
items -> discount: The item discount
items -> net_total: The total of this product
items -> vat_percentage: The vat percentage of this product

To create a new invoice this endpoint should be used.

Note if a receipt_id is used all items of the receipt will be added to the invoice.

name	type
receipt_id	string
customer_id	int	required
invoice_address_id	int	required
name_1	string
name_2	string
address_1	string
address_2	string
postal_code	string	length: 2
city	striing
country_iso	string	length: 2
vat_number	string
expire_date	date
delivery_date	date
pay_date	date
total_paid	double
miscellaneous	string
remark	string
items	array
items -> product_uid	int
items -> description	string
items -> quantity	int
items ->net_unit_price	double
items -> net_discount	double
items -> net_total	double
items -> gross_unit_price	double
items -> gross_discount	double
items -> gross_total	double
items -> vat_percentage	int

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","corporations","01","invoices"],"host":["api","softtouch","eu"],"query":[],"variable":[]}},"response":[{"id":"68c6ca22-1622-4ecc-9308-cb868d1eb9b6","name":"Invoices","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"receipt_id\": 1000000001,\r\n\t\"customer_id\": 2,\r\n\t\"invoice_address_id\": 2,\r\n\t\"name_1\": \"SoftTouch Vlaanderen BV\",\r\n\t\"name_2\": \"Stefan de Bakker\",\r\n\t\"address_1\": \"Ambachtenlaan 6a\",\r\n \"address_2\": \"\",\r\n \"postal_code\": \"9080\",\r\n \"city\": \"Zeveneken\",\r\n \"country_iso\": \"BE\",\r\n \"vat_number\": \"BE 0506.847.665\",\r\n\t\"expire_date\": \"2023-08-20\",\r\n \"delivery_date\": \"2023-07-20\",\r\n \"pay_date\": \"2023-07-20\",\r\n \"total_paid\": 100.50,\r\n \"miscellaneous_1\": \"\",\r\n \"remark\": \"\",\r\n\t\"items\": [\r\n {\r\n \"description\": \"This is the description for the item.\",\r\n \"quantity\": 1,\r\n \"net_unit_price\": 100,\r\n \"net_discount\": 0,\r\n \"net_total\": 100,\r\n \"gross_unit_price\": 121,\r\n \"gross_discount\": 0,\r\n \"gross_total\": 121,\r\n \"vat_percentage\": 21\r\n }\r\n ]\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/corporations/01/invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 19 Jul 2023 14:49:00 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlV6eGZ4Rlp0NGpybGM4b3d2YlhkaXc9PSIsInZhbHVlIjoibkhaYXE1bWk5eG5wZFAwSktneGp1WmhLS0Nhb01NbXl4M1FMTFkrcjNDY3pINWRYc240R0hiaVwvbmpSZUlEMXdtV3VHK3NSdlJmUnBFaGtlY3Q0bW5BPT0iLCJtYWMiOiIwZTljZjE1YmFkNDgzYTY0Y2YwN2JiYTA3YTYzOTEyYTBlZmEwOWI5NDRiOTRhZjNhMTZmMjhiYjk0MTY5YzRkIn0%3D; expires=Wed, 19-Jul-2023 16:49:00 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 20230002,\n \"corporation_id\": \"01\",\n \"name_1\": \"SoftTouch Vlaanderen BV\",\n \"name_2\": \"Stefan de Bakker\",\n \"address_1\": \"Ambachtenlaan 6a\",\n \"address_2\": \"\",\n \"postal_code\": \"9080\",\n \"city\": \"Zeveneken\",\n \"country_iso\": \"BE\",\n \"vat_number\": \"BE 0506.847.665\",\n \"net_sales_price\": 141.32229999999998,\n \"net_discount\": 0,\n \"net_total\": 141.32229999999998,\n \"vat_price\": 79.677683,\n \"gross_total\": 220.999983,\n \"structured_communication\": \"012/0230/00254\",\n \"items\": [\n {\n \"key\": 1,\n \"description\": \"Cadeaucheque [001000]\",\n \"quantity\": 1,\n \"net_unit_price\": 41.3223,\n \"net_discount\": 0,\n \"net_total\": 41.3223,\n \"vat_percentage\": 21\n },\n {\n \"key\": 2,\n \"description\": \"Ticket no°: 1000000001\",\n \"quantity\": 0,\n \"net_unit_price\": 0,\n \"net_discount\": 0,\n \"net_total\": 0,\n \"vat_percentage\": 0\n },\n {\n \"key\": 3,\n \"description\": \"This is the description for the item.\",\n \"quantity\": 1,\n \"net_unit_price\": 100,\n \"net_discount\": 0,\n \"net_total\": 100,\n \"vat_percentage\": 21\n }\n ]\n}"}],"_postman_id":"8dc00f9c-148b-483a-87ad-bddb83ed6195"}],"id":"4e4f622c-1d9c-4b74-8faa-02434cae3b38","_postman_id":"4e4f622c-1d9c-4b74-8faa-02434cae3b38","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Invoice adresses","item":[{"name":"invoiceaddresses","event":[{"listen":"test","script":{"id":"f75a3ba7-02a8-478e-ae82-9585bd8ef60d","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"e80b1166-8825-4b40-94ff-53eb97ae2e2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/invoiceaddresses","description":"

This endpoint fetches all invoice addresses as all calls it has to be done in steps with a maximum amount of 500 invoice addresses.

Used parameters:

display (full)
take
skip
customer_ids

A brief explanation of return values:

key: The unique identifier
customer: The customer id
name: The company name
surname: A second name for the company or contact name
address: The company's address
address2: A second address line
zip: The company's postal code
city: The company's city
country: The company's ISO country code
telefphone: The company's phone number
mobile: The company's mobile phone number
fax: The company's fax number
email: The company's email address, used for sending invoices via email
remarks: Specific remarks for this company
vatid: The company's vat id
created: The creation date of the company's invoice address
created_by: The user id of creation
modified: The modification date
modified_by: The user id of modification

commaSeperatedInteger

\n","type":"text/plain"},"key":"customer_ids","value":""}],"variable":[]}},"response":[{"id":"4bd798cb-cbba-4daa-a952-12ea14f384a4","name":"invoiceaddresses","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/invoiceaddresses","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","invoiceaddresses"],"query":[{"key":"display","value":"full","type":"text","disabled":true},{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true},{"key":"customer_ids","value":"","description":"commaSeperatedInteger","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 19 Jul 2023 14:58:37 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IndIREJwWVJtcjkzbUhIWmhibEg4SVE9PSIsInZhbHVlIjoiUmc1bmdKcHJIQzNyeUFcL0trdHUwQytoQmxNSUxtVkUwdGpGU0V1dnIzOUxhRUI5a2hiZ2NxbXFwd0F4MXBxQks0MkttNTlLTys2ampJbVJoMHRGNVlBPT0iLCJtYWMiOiI5NjE1NWMzNWI5NmFmMGRkZDA1MWM5ZDFkZGNjZTEzODY0ZjBhMTBiYzdmNzM2NzJkYzk2OWZkOTg3ZTdiZTcyIn0%3D; expires=Wed, 19-Jul-2023 16:58:37 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": 2,\n \"customer\": 2,\n \"name\": \"SoftTouch Vlaanderen BV\",\n \"surname\": \"\",\n \"address\": \"Ambachtenlaan 6a\",\n \"address2\": \"\",\n \"zip\": \"9080\",\n \"city\": \"Zeveneken\",\n \"country\": \"BE\",\n \"telephone\": \"09/219.00.83\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"email\": \"dev@softtouch.be\",\n \"remarks\": \"\",\n \"vatid\": \"BE 0506.847.665\",\n \"vat_liable\": true,\n \"created\": \"2023-04-11\",\n \"createdby\": \"1001\",\n \"modified\": \"2023-07-19\",\n \"modifiedby\": \"1001\"\n },\n {\n \"key\": 3,\n \"customer\": 3,\n \"name\": \"Diddly Squat Farm Shop\",\n \"surname\": \"\",\n \"address\": \"Chipping Norton Road 5\",\n \"address2\": \"\",\n \"zip\": \"OX7 3PE\",\n \"city\": \"Chadlington\",\n \"country\": \"GB\",\n \"telephone\": \"\",\n \"mobile\": \"\",\n \"fax\": \"\",\n \"email\": \"\",\n \"remarks\": \"\",\n \"vatid\": \"370 4719 94\",\n \"vat_liable\": true,\n \"created\": \"2023-07-03\",\n \"createdby\": \"1001\",\n \"modified\": \"0000-00-00\",\n \"modifiedby\": \"\"\n }\n]"}],"_postman_id":"e80b1166-8825-4b40-94ff-53eb97ae2e2d"},{"name":"invoiceaddresses/{{id}}","event":[{"listen":"test","script":{"id":"3fe8558a-342b-4624-9fe6-6bc43ba156f7","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"6a403255-6faa-4fcc-9818-e2190f9c029d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/invoiceaddresses/2","description":"

This endpoint fetches a specific invoice address.

Used parameters:

display (full)
take
skip
customer_ids

A brief explanation of return values:

key: The unique identifier
customer: The customer id
name: The company name
surname: A second name for the company or contact name
address: The company's address
address2: A second address line
zip: The company's postal code
city: The company's city
country: The company's ISO country code
telefphone: The company's phone number
mobile: The company's mobile phone number
fax: The company's fax number
email: The company's email address, used for sending invoices via email
remarks: Specific remarks for this company
vatid: The company's vat id
created: The creation date of the company's invoice address
created_by: The user id of creation
modified: The modification date
modified_by: The user id of modification

To create a new invoice address this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
customer	int	required
name	string	required
surname	string
address	string
address2	string
zip	string
city	string
country	string	length: 2
telephone	striing
mobile	string
fax	string
email	string
remarks	string
vatid	string
vat_liable	int

To update a invoice address this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
customer	int	required
name	string	required
surname	string
address	string
address2	string
zip	string
city	string
country	string	length: 2
telephone	striing
mobile	string
fax	string
email	string
remarks	string
vatid	string
vat_liable	int

Remove a invoice address

This endpoint fetches all messages as all calls it has to be done in steps with a maximum amount of 500 messages.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
store: The store id
pos: The pos id
user: The user id
subject: The message subject
message: The message body
date: The date of the message
time: The time of the message
acknowledged: The message is received

This endpoint fetches a specific message.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
store: The store id
pos: The pos id
user: The user id
subject: The message subject
message: The message body
date: The date of the message
time: The time of the message
acknowledged: The message is received

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

size:2

\n","type":"text/plain"},"key":"from_store_id","value":""},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"from_pos_id","value":""},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"from_user_id","value":""},{"disabled":true,"description":{"content":"

required_without_all:pos,user|size:2

\n","type":"text/plain"},"key":"store","value":""},{"disabled":true,"description":{"content":"

required_without_all:store,user|size:4

\n","type":"text/plain"},"key":"pos","value":""},{"disabled":true,"description":{"content":"

required_without_all:store,pos|size:4

\n","type":"text/plain"},"key":"user","value":""},{"disabled":true,"key":"subject","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"message","value":""}],"variable":[]}},"response":[{"id":"fda10ca5-7b78-4064-a8ad-bdbe56a715a7","name":"Messages","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"from_store_id\": \"01\",\r\n \"from_pos_id\": \"0101\",\r\n \"from_user_id\": \"1001\",\r\n \"store\": \"01\",\r\n \"pos\": \"0101\",\r\n \"user\": \"1001\",\r\n \"subject\": \"PRINT TICKET\",\r\n \"message\": \"2010000930\"\r\n}"},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/messages","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","messages"],"query":[{"key":"from_store_id","value":"","description":"size:2","type":"text","disabled":true},{"key":"from_pos_id","value":"","description":"size:4","type":"text","disabled":true},{"key":"from_user_id","value":"","description":"size:4","type":"text","disabled":true},{"key":"store","value":"","description":"required_without_all:pos,user|size:2","type":"text","disabled":true},{"key":"pos","value":"","description":"required_without_all:store,user|size:4","type":"text","disabled":true},{"key":"user","value":"","description":"required_without_all:store,pos|size:4","type":"text","disabled":true},{"key":"subject","value":null,"type":"text","disabled":true},{"key":"message","value":"","description":"required","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 19 Jul 2023 15:16:10 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6Ilh3ZVR6cUdCOVkxMFhLb1F1dDJHRXc9PSIsInZhbHVlIjoiTjlNRnFXRG90dmVvZERKU2hRNmRTeVpCNzlXRmsyT1Zxb2I5Wk9VNG0zbWVsRHRUd1hadjhRSUpPNGV1b2w2NllzSHF6ZnNNU0d4MTNjSlBORzN2M1E9PSIsIm1hYyI6IjczOWM0YTAwMTI5NTVlZjY1OGYxNjI4YTYwMjZiYmIyZWVkZjE0N2FmOTM2MDdjYzA3MjcwMGFlMWRiOGQyMTgifQ%3D%3D; expires=Wed, 19-Jul-2023 17:16:10 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": 5,\n \"store\": \"01\",\n \"pos\": \"0101\",\n \"user\": \"1001\",\n \"subject\": \"PRINT TICKET\",\n \"message\": \"2010000930\",\n \"date\": \"2023-07-19 00:00:00\",\n \"time\": \"17:16:10\",\n \"acknowledged\": \"0\"\n}"}],"_postman_id":"619217ef-58a0-4b48-ae1d-b6afdc34f778"}],"id":"1366507a-7e19-4280-9dc5-47b9c2404559","description":"

When a reservation has been made, there is the possibility to send a message to the point of sales. A reservation ticket will be printed automatically.
Via the messages endpoint a POST call can be made. The full parameter list can be found in the API docs. To make this work the subject must have the value “PRINT RESERVATION” and the message value must be the key of the reservation.

\n","_postman_id":"1366507a-7e19-4280-9dc5-47b9c2404559","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"POS","item":[{"name":"POS","event":[{"listen":"test","script":{"id":"41dd305d-9f45-4bc4-a0ca-88353275066c","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"3ef6e334-6917-4d0d-af18-3d8986c9923d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/pos","description":"

This endpoint fetches all pos as all calls it has to be done in steps with a maximum amount of 500 pos.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
txt: The description of the pos
store_id: The store id
active: If true, the pos is still used

This endpoint fetches all postal codes as all calls it has to be done in steps with a maximum amount of 500 postal codes.

Used parameters:

display (full)
take
skip
city
country

A brief explanation of return values:

id: The unique identifier
postal_code: The postal code
city: The city of the postal code
country: The country of the postal code

string

\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"

alpha

\n","type":"text/plain"},"key":"country","value":""}],"variable":[]}},"response":[{"id":"bc8c31e5-01ee-4ec9-ada5-a2355a2cedb7","name":"Postal_codes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/postal_codes","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","postal_codes"],"query":[{"key":"display","value":"full","type":"text","disabled":true},{"key":"take","value":"500","disabled":true},{"key":"skip","value":"0","disabled":true},{"key":"city","value":"","description":"string","type":"text","disabled":true},{"key":"country","value":"","description":"alpha","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 20 Jul 2023 07:29:22 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6Ilc1Y3hvQk4yYWE2TkpVNllzYnM0WVE9PSIsInZhbHVlIjoiTytsZ1hMc0xKMFk3UTV4ZTN4S0ExWXJDcTlOT0VJSGM2cXM1UG85dFo2REdYUzczMTFZWXViZ2VHZDRQYnJoaWpURFVYanlhVitSYXRFUzc3cWJXV0E9PSIsIm1hYyI6IjU5NWNkNDU2ZTQ3OTU5NWU5NTI2M2NlOWY3OTg0NTE1ZTMyZWI0YzhhN2FjNWVjYWZhYjFmZWYwNDA1NmVjNDMifQ%3D%3D; expires=Thu, 20-Jul-2023 09:29:22 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"postal_code\": \"1331\",\n \"city\": \"Rosieres\",\n \"country\": \"BE\"\n },\n {\n \"id\": 2,\n \"postal_code\": \"1082\",\n \"city\": \"Bruxelles\",\n \"country\": \"BE\"\n },\n {\n \"id\": 3,\n \"postal_code\": \"1000\",\n \"city\": \"Bruxelles\",\n \"country\": \"BE\"\n },\n {\n \"id\": 4,\n \"postal_code\": \"1000\",\n \"city\": \"Brussel\",\n \"country\": \"BE\"\n },\n {\n \"id\": 5,\n \"postal_code\": \"9992\",\n \"city\": \"Middelburg\",\n \"country\": \"BE\"\n },\n {\n \"id\": 6,\n \"postal_code\": \"9991\",\n \"city\": \"Adegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 7,\n \"postal_code\": \"9990\",\n \"city\": \"Maldegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 8,\n \"postal_code\": \"9988\",\n \"city\": \"Watervliet\",\n \"country\": \"BE\"\n },\n {\n \"id\": 9,\n \"postal_code\": \"9988\",\n \"city\": \"Waterland-Oudeman\",\n \"country\": \"BE\"\n },\n {\n \"id\": 10,\n \"postal_code\": \"9982\",\n \"city\": \"Sint-Jan-In-Eremo\",\n \"country\": \"BE\"\n },\n {\n \"id\": 11,\n \"postal_code\": \"9981\",\n \"city\": \"Sint-Margriete\",\n \"country\": \"BE\"\n },\n {\n \"id\": 12,\n \"postal_code\": \"9980\",\n \"city\": \"Sint-Laureins\",\n \"country\": \"BE\"\n },\n {\n \"id\": 13,\n \"postal_code\": \"9971\",\n \"city\": \"Lembeke\",\n \"country\": \"BE\"\n },\n {\n \"id\": 14,\n \"postal_code\": \"9970\",\n \"city\": \"Kaprijke\",\n \"country\": \"BE\"\n },\n {\n \"id\": 15,\n \"postal_code\": \"9968\",\n \"city\": \"Oosteeklo\",\n \"country\": \"BE\"\n },\n {\n \"id\": 16,\n \"postal_code\": \"9968\",\n \"city\": \"Bassevelde\",\n \"country\": \"BE\"\n },\n {\n \"id\": 17,\n \"postal_code\": \"9961\",\n \"city\": \"Boekhoute\",\n \"country\": \"BE\"\n },\n {\n \"id\": 18,\n \"postal_code\": \"9960\",\n \"city\": \"Assenede\",\n \"country\": \"BE\"\n },\n {\n \"id\": 19,\n \"postal_code\": \"9950\",\n \"city\": \"Waarschoot\",\n \"country\": \"BE\"\n },\n {\n \"id\": 20,\n \"postal_code\": \"9940\",\n \"city\": \"Sleidinge\",\n \"country\": \"BE\"\n },\n {\n \"id\": 21,\n \"postal_code\": \"9940\",\n \"city\": \"Kluizen\",\n \"country\": \"BE\"\n },\n {\n \"id\": 22,\n \"postal_code\": \"9940\",\n \"city\": \"Evergem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 23,\n \"postal_code\": \"9940\",\n \"city\": \"Ertvelde\",\n \"country\": \"BE\"\n },\n {\n \"id\": 24,\n \"postal_code\": \"9932\",\n \"city\": \"Ronsele\",\n \"country\": \"BE\"\n },\n {\n \"id\": 25,\n \"postal_code\": \"9931\",\n \"city\": \"Oostwinkel\",\n \"country\": \"BE\"\n },\n {\n \"id\": 26,\n \"postal_code\": \"9930\",\n \"city\": \"Zomergem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 27,\n \"postal_code\": \"9921\",\n \"city\": \"Vinderhoute\",\n \"country\": \"BE\"\n },\n {\n \"id\": 28,\n \"postal_code\": \"9920\",\n \"city\": \"Lovendegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 29,\n \"postal_code\": \"9910\",\n \"city\": \"Ursel\",\n \"country\": \"BE\"\n },\n {\n \"id\": 30,\n \"postal_code\": \"9910\",\n \"city\": \"Knesselare\",\n \"country\": \"BE\"\n },\n {\n \"id\": 31,\n \"postal_code\": \"9900\",\n \"city\": \"Eeklo\",\n \"country\": \"BE\"\n },\n {\n \"id\": 32,\n \"postal_code\": \"9890\",\n \"city\": \"Vurste\",\n \"country\": \"BE\"\n },\n {\n \"id\": 33,\n \"postal_code\": \"9890\",\n \"city\": \"Semmerzake\",\n \"country\": \"BE\"\n },\n {\n \"id\": 34,\n \"postal_code\": \"9890\",\n \"city\": \"Gavere\",\n \"country\": \"BE\"\n },\n {\n \"id\": 35,\n \"postal_code\": \"9890\",\n \"city\": \"Dikkelvenne\",\n \"country\": \"BE\"\n },\n {\n \"id\": 36,\n \"postal_code\": \"9890\",\n \"city\": \"Baaigem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 37,\n \"postal_code\": \"9890\",\n \"city\": \"Asper\",\n \"country\": \"BE\"\n },\n {\n \"id\": 38,\n \"postal_code\": \"9881\",\n \"city\": \"Bellem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 39,\n \"postal_code\": \"9880\",\n \"city\": \"Poeke\",\n \"country\": \"BE\"\n },\n {\n \"id\": 40,\n \"postal_code\": \"9880\",\n \"city\": \"Lotenhulle\",\n \"country\": \"BE\"\n },\n {\n \"id\": 41,\n \"postal_code\": \"9880\",\n \"city\": \"Aalter\",\n \"country\": \"BE\"\n },\n {\n \"id\": 42,\n \"postal_code\": \"9870\",\n \"city\": \"Zulte\",\n \"country\": \"BE\"\n },\n {\n \"id\": 43,\n \"postal_code\": \"9870\",\n \"city\": \"Olsene\",\n \"country\": \"BE\"\n },\n {\n \"id\": 44,\n \"postal_code\": \"9870\",\n \"city\": \"Machelen (o.-Vl.)\",\n \"country\": \"BE\"\n },\n {\n \"id\": 45,\n \"postal_code\": \"9860\",\n \"city\": \"Scheldewindeke\",\n \"country\": \"BE\"\n },\n {\n \"id\": 46,\n \"postal_code\": \"9860\",\n \"city\": \"Oosterzele\",\n \"country\": \"BE\"\n },\n {\n \"id\": 47,\n \"postal_code\": \"9860\",\n \"city\": \"Moortsele\",\n \"country\": \"BE\"\n },\n {\n \"id\": 48,\n \"postal_code\": \"9860\",\n \"city\": \"Landskouter\",\n \"country\": \"BE\"\n },\n {\n \"id\": 49,\n \"postal_code\": \"9860\",\n \"city\": \"Gijzenzele\",\n \"country\": \"BE\"\n },\n {\n \"id\": 50,\n \"postal_code\": \"9860\",\n \"city\": \"Balegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 51,\n \"postal_code\": \"9850\",\n \"city\": \"Vosselare\",\n \"country\": \"BE\"\n },\n {\n \"id\": 52,\n \"postal_code\": \"9850\",\n \"city\": \"Poesele\",\n \"country\": \"BE\"\n },\n {\n \"id\": 53,\n \"postal_code\": \"9850\",\n \"city\": \"Nevele\",\n \"country\": \"BE\"\n },\n {\n \"id\": 54,\n \"postal_code\": \"9850\",\n \"city\": \"Merendree\",\n \"country\": \"BE\"\n },\n {\n \"id\": 55,\n \"postal_code\": \"9850\",\n \"city\": \"Landegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 56,\n \"postal_code\": \"9850\",\n \"city\": \"Hansbeke\",\n \"country\": \"BE\"\n },\n {\n \"id\": 57,\n \"postal_code\": \"9840\",\n \"city\": \"Zevergem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 58,\n \"postal_code\": \"9840\",\n \"city\": \"De Pinte\",\n \"country\": \"BE\"\n },\n {\n \"id\": 59,\n \"postal_code\": \"9831\",\n \"city\": \"Deurle\",\n \"country\": \"BE\"\n },\n {\n \"id\": 60,\n \"postal_code\": \"9830\",\n \"city\": \"Sint-Martens-Latem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 61,\n \"postal_code\": \"9820\",\n \"city\": \"Schelderode\",\n \"country\": \"BE\"\n },\n {\n \"id\": 62,\n \"postal_code\": \"9820\",\n \"city\": \"Munte\",\n \"country\": \"BE\"\n },\n {\n \"id\": 63,\n \"postal_code\": \"9820\",\n \"city\": \"Merelbeke\",\n \"country\": \"BE\"\n },\n {\n \"id\": 64,\n \"postal_code\": \"9820\",\n \"city\": \"Melsen\",\n \"country\": \"BE\"\n },\n {\n \"id\": 65,\n \"postal_code\": \"9820\",\n \"city\": \"Lemberge\",\n \"country\": \"BE\"\n },\n {\n \"id\": 66,\n \"postal_code\": \"9820\",\n \"city\": \"Bottelare\",\n \"country\": \"BE\"\n },\n {\n \"id\": 67,\n \"postal_code\": \"9810\",\n \"city\": \"Nazareth\",\n \"country\": \"BE\"\n },\n {\n \"id\": 68,\n \"postal_code\": \"9810\",\n \"city\": \"Eke\",\n \"country\": \"BE\"\n },\n {\n \"id\": 69,\n \"postal_code\": \"9800\",\n \"city\": \"Zeveren\",\n \"country\": \"BE\"\n },\n {\n \"id\": 70,\n \"postal_code\": \"9800\",\n \"city\": \"Wontergem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 71,\n \"postal_code\": \"9800\",\n \"city\": \"Vinkt\",\n \"country\": \"BE\"\n },\n {\n \"id\": 72,\n \"postal_code\": \"9800\",\n \"city\": \"Sint-Martens-Leerne\",\n \"country\": \"BE\"\n },\n {\n \"id\": 73,\n \"postal_code\": \"9800\",\n \"city\": \"Petegem-Aan-De-Leie\",\n \"country\": \"BE\"\n },\n {\n \"id\": 74,\n \"postal_code\": \"9800\",\n \"city\": \"Meigem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 75,\n \"postal_code\": \"9800\",\n \"city\": \"Grammene\",\n \"country\": \"BE\"\n },\n {\n \"id\": 76,\n \"postal_code\": \"9800\",\n \"city\": \"Gottem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 77,\n \"postal_code\": \"9800\",\n \"city\": \"Deinze\",\n \"country\": \"BE\"\n },\n {\n \"id\": 78,\n \"postal_code\": \"9800\",\n \"city\": \"Bachte-Maria-Leerne\",\n \"country\": \"BE\"\n },\n {\n \"id\": 79,\n \"postal_code\": \"9800\",\n \"city\": \"Astene\",\n \"country\": \"BE\"\n },\n {\n \"id\": 80,\n \"postal_code\": \"9790\",\n \"city\": \"Wortegem-Petegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 81,\n \"postal_code\": \"9790\",\n \"city\": \"Wortegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 82,\n \"postal_code\": \"9790\",\n \"city\": \"Petegem-Aan-De-Schelde\",\n \"country\": \"BE\"\n },\n {\n \"id\": 83,\n \"postal_code\": \"9790\",\n \"city\": \"Ooike (wortegem-Petegem)\",\n \"country\": \"BE\"\n },\n {\n \"id\": 84,\n \"postal_code\": \"9790\",\n \"city\": \"Moregem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 85,\n \"postal_code\": \"9790\",\n \"city\": \"Elsegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 86,\n \"postal_code\": \"9772\",\n \"city\": \"Wannegem-Lede\",\n \"country\": \"BE\"\n },\n {\n \"id\": 87,\n \"postal_code\": \"9771\",\n \"city\": \"Nokere\",\n \"country\": \"BE\"\n },\n {\n \"id\": 88,\n \"postal_code\": \"9770\",\n \"city\": \"Kruishoutem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 89,\n \"postal_code\": \"9750\",\n \"city\": \"Zingem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 90,\n \"postal_code\": \"9750\",\n \"city\": \"Ouwegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 91,\n \"postal_code\": \"9750\",\n \"city\": \"Huise\",\n \"country\": \"BE\"\n },\n {\n \"id\": 92,\n \"postal_code\": \"9700\",\n \"city\": \"Welden\",\n \"country\": \"BE\"\n },\n {\n \"id\": 93,\n \"postal_code\": \"9700\",\n \"city\": \"Volkegem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 94,\n \"postal_code\": \"9700\",\n \"city\": \"Oudenaarde\",\n \"country\": \"BE\"\n },\n {\n \"id\": 95,\n \"postal_code\": \"9700\",\n \"city\": \"Ooike (oudenaarde)\",\n \"country\": \"BE\"\n },\n {\n \"id\": 96,\n \"postal_code\": \"9700\",\n \"city\": \"Nederename\",\n \"country\": \"BE\"\n },\n {\n \"id\": 97,\n \"postal_code\": \"9700\",\n \"city\": \"Mullem\",\n \"country\": \"BE\"\n },\n {\n \"id\": 98,\n \"postal_code\": \"9700\",\n \"city\": \"Melden\",\n \"country\": \"BE\"\n },\n {\n \"id\": 99,\n \"postal_code\": \"9700\",\n \"city\": \"Mater\",\n \"country\": \"BE\"\n },\n {\n \"id\": 100,\n \"postal_code\": \"9700\",\n \"city\": \"Leupegem\",\n \"country\": \"BE\"\n }\n]"}],"_postman_id":"5ce7123d-a6b5-411e-978f-b3b76a5e9142"},{"name":"Postal_codes/{{id}}","event":[{"listen":"test","script":{"id":"7291a624-f395-439e-92b9-9a680aa6937d","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"7b4c12db-dd5e-447f-b542-b95d7ae719e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/postal_codes/291","description":"

This endpoint fetches a specific postal code.

Used parameters:

display (full)

A brief explanation of return values:

id: The unique identifier
postal_code: The postal code
city: The city of the postal code
country: The country of the postal code

To create a new postal code this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
postal_code	string	required
city	string	required
country	string	required

To update a postal code this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type
postal_code	string	required
city	string	required
country	string	required

Delete a postal code

Retrieve product data

At the end of the previous chapter the data for one product was received by its unique product_uid. Before we can do this, we first need to know this information. As a simple GET to the /1/accounts/1/products/ resource, the information of all products will be returned. It might be helpful to add some restrictions to this selection.
id: an integer value representing the id of an article. This should always be between 100000 and 900000. Only products with this id will be in the result set.
uid: an integer value representing a part of, or the entire uid. The value can be between 100000 and 90000000000000. This can be useful for example to find products with a certain id and variant. In this case an integer with 8 digits needs to be set as a value to the parameter. For example “uid”: 10024602 will return all products with id 100246 and variant 2.
ids: this parameter works in the same way as the uid parameter, with the difference that multiple integers can be passed, separated by a comma. For example “ids”: “10024602,100247” will return all products with id 100246 and variant 2 together with all the products with id 100247.
seasons, brands, detailXs, categoryXs, foreign_ids: These parameters filter on respectively the season, brand, detail1 through detail5, category1 through category7 and the foreign_id of the products. Note that for detailXs and categoryXs the ‘X’ needs to be replaced by a number. All parameters are comma separated. The seasons and brands parameters expect three characters per id. The stores parameter expects two characters per id and the categoryXs expects four characters per id.
withstock: These parameter is useful to receive only the products that have actual stock to sell. Note that if a product might still be physically in stock, but is reserved for a customer, it will not be in stock. The value of this parameter should be a boolean.
online: This parameter makes sure that only products for online use are returned. The value is an integer, usually 1. In rare cases this might be another value, but this will be indicated by SoftTouch.
since, until: Returns the products that are changed respectively since or until a certain date. The product parameter timestamp is taken as a reference. While this is accurate to a certain extent, it is important to know how to use this. There is a separate chapter dedicated to this, which is a must read when relying on these parameters.
discount_date: In the previous chapter the discount_ parameters are introduced. By default the discount_date will be set as the current date. With this parameter, however, the discount and netto price on another date can be retrieved.
detail: The result of the request can quickly become quite large. When you are only interested in the stock of the products this parameter can be used with the value “stock”. The result will only show the key, edi, store and stock parameters.
since_first_delivery, until_first_delivery, since_last_delivery, until_last_delivery: These parameters expect a date value.

More about timestamp

The timestamp parameter is not reliable for everything! Since this is very important, let us repeat this. The timestamp parameter and the since and until parameters are not reliable for everything!
First things first. The timestamp parameter did not cover everything in the past. When the description was changed or the physical stock was changed, the article was also changed. However, when an article was reserved, the actual product or stock was not changed, and therefore the timestamp was not updated. After all, the product did not change, the availability, however, did. The same logic applies to the online parameter or the texts, files and related parameters. The newest DB version however will make sure that, whenever a reservation is made or an article is set online, the timestamp will also be updated.
“So it is reliable after all?” To a certain extent, yes. However there is one thing that is not taken into account. There is a possibility to set a sales period based on different levels such as brands, seasons and categories. The main reason why the timestamp of the products are not updated is because, when the sales are set, it most likely it will be for the future. When the time comes the sales period takes effect on a product, the timestamp will stay the same because no data has been changed.

in:stock,articles,articles_with_sizes,max_sizes

\n","type":"text/plain"},"key":"detail","value":""},{"disabled":true,"description":{"content":"

min:3

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

boolean (only when combined with search)

\n","type":"text/plain"},"key":"get_all_results","value":""},{"disabled":true,"key":"barcode","value":""},{"disabled":true,"description":{"content":"

integer|between:100000,90000000000000

\n","type":"text/plain"},"key":"uid","value":"111785"},{"disabled":true,"description":{"content":"

CommaSeperatedInteger|CommaSeperatedBetween:100000,90000000000000

\n","type":"text/plain"},"key":"ids","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:3

\n","type":"text/plain"},"key":"seasons","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:2

\n","type":"text/plain"},"key":"stores","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:3

\n","type":"text/plain"},"key":"brands","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"stock_greater_than","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"backorder_greater_than","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"order_greater_than","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"delivery_greater_than","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedBetween:0,5

\n","type":"text/plain"},"key":"online","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"since","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"updated_since_minutes","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"until","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"since_first_delivery","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"until_first_delivery","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"since_last_delivery","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"until_last_delivery","value":""},{"disabled":true,"key":"detail1s","value":""},{"disabled":true,"key":"detail2s","value":""},{"disabled":true,"key":"detail3s","value":""},{"disabled":true,"key":"detail4s","value":""},{"disabled":true,"key":"detail5s","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:4

\n","type":"text/plain"},"key":"category1s","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:4

\n","type":"text/plain"},"key":"category2s","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:4

\n","type":"text/plain"},"key":"category3s","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:4

\n","type":"text/plain"},"key":"category4s","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:4

\n","type":"text/plain"},"key":"category5s","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:4

\n","type":"text/plain"},"key":"category6s","value":""},{"disabled":true,"description":{"content":"

CommaSeperatedSize:4

\n","type":"text/plain"},"key":"category7s","value":""},{"disabled":true,"key":"foreign_ids","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"discount_date","value":""},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"pos_id","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"stop_on_first_resultset","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"all_stores","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"create_new_from_key","value":""},{"disabled":true,"description":{"content":"

boolean || UNIMPLEMENTED

\n","type":"text/plain"},"key":"with_files","value":""},{"disabled":true,"description":{"content":"

boolean || UNIMPLEMENTED

\n","type":"text/plain"},"key":"with_texts","value":""},{"disabled":true,"description":{"content":"

boolean || UNIMPLEMENTED

\n","type":"text/plain"},"key":"with_related","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"withstock","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"full_stock","value":""}],"variable":[]}},"response":[],"_postman_id":"6eeb4e08-893e-4002-af64-1da22824c502"},{"name":"Products/{{id}}","event":[{"listen":"test","script":{"id":"cd2a1902-e71e-4806-a057-7f7842f01668","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"4bdababc-47e5-4c3d-b1c2-144cad104fc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/products/55556101040101","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","products","55556101040101"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"key":"display","value":"full"}],"variable":[]}},"response":[],"_postman_id":"4bdababc-47e5-4c3d-b1c2-144cad104fc8"},{"name":"Products","event":[{"listen":"test","script":{"id":"3fb4b5e7-7048-4eaa-a7da-1a9da0350d2f","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"00a688ae-6738-469d-bc28-40dfa1231a92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"key\": 12345601010101,\r\n \"id\": 123456,\r\n \"variant\": 1,\r\n \"sizeX\": \"01\",\r\n \"sizeY\": \"01\",\r\n \"store\": \"01\",\r\n \"order\": 123456789,\r\n \"direct_delivery\": 0,\r\n \"history_module\": \"API\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/products","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","products"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

integer|between:10000000000000,90000000000000

\n","type":"text/plain"},"key":"key","value":null},{"disabled":true,"description":{"content":"

required_if:key,|integer|between:100000,900000

\n","type":"text/plain"},"key":"id","value":null},{"disabled":true,"description":{"content":"

required_if:key,|integer|between:1,99

\n","type":"text/plain"},"key":"variant","value":null},{"disabled":true,"description":{"content":"

required_if:key,|size:2

\n","type":"text/plain"},"key":"sizeX","value":null},{"disabled":true,"description":{"content":"

required_if:key,|size:2

\n","type":"text/plain"},"key":"sizeY","value":null},{"disabled":true,"description":{"content":"

required_if:key,|size:2

\n","type":"text/plain"},"key":"store","value":null},{"disabled":true,"description":{"content":"

required|integer

\n","type":"text/plain"},"key":"order","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"direct_delivery","value":null},{"disabled":true,"description":{"content":"

size:3

\n","type":"text/plain"},"key":"history_module","value":null}],"variable":[]}},"response":[],"_postman_id":"00a688ae-6738-469d-bc28-40dfa1231a92"},{"name":"Products/create_article","event":[{"listen":"test","script":{"id":"5c21a91b-b637-434b-a1c3-d5d722baf82f","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"4def1a1d-d24a-43ab-954e-2b5d0c6a8b7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 123456,\r\n \"season\": \"NOS\",\r\n \"brand\": \"001\",\r\n \"sizetable\": \"01\",\r\n \"category1\": \"0101\",\r\n \"category2\": \"0201\",\r\n \"category3\": \"0301\",\r\n \"category4\": \"0401\",\r\n \"category5\": \"0501\",\r\n \"category6\": \"0601\",\r\n \"category7\": \"0701\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"description\": \"\",\r\n \"description2\": \"\",\r\n \"description3\": \"\",\r\n \"description4\": \"\",\r\n \"description5\": \"\",\r\n \"order_number\": \"\",\r\n \"ultimate_delivery\": \"2021-08-26\",\r\n \"expected_delivery\": \"2021-08-26\",\r\n \"vat\": 21,\r\n \"original_purchase_price\": 10.00,\r\n \"commercial_discount\": 0.00,\r\n \"purchase_price\": 10.00,\r\n \"original_markup\": 2.00,\r\n \"markup\": 2.00,\r\n \"price\": 20.00,\r\n \"on_customer_card\": 1,\r\n \"customer_card_percentage\": 5,\r\n \"customer_card_price\": 0.50,\r\n \"article_discount_allowed\": 1,\r\n \"history_module\": \"API\",\r\n \"direct_delivery\": 0,\r\n \"colors\": [\r\n {\r\n \"color\": \"0001\",\r\n \"colorbrand\": \"NAVY 516\",\r\n \"stores\": [\r\n {\r\n \"store\": \"01\",\r\n \"detail\": [\r\n {\r\n \"sizeX\": \"01\",\r\n \"sizeY\": \"01\",\r\n \"edi\": \"\",\r\n \"order\": 1,\r\n \"original_purchase_price\": 10.00,\r\n \"commercial_discount\": 0.00,\r\n \"purchase_price\": 10.00,\r\n \"original_markup\": 2.00,\r\n \"markup\": 2.00,\r\n \"price\": 20.00\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/products/create_article","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","products","create_article"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

integer|between:100000,900000

\n","type":"text/plain"},"key":"id","value":null},{"disabled":true,"description":{"content":"

required_without:id|size:3

\n","type":"text/plain"},"key":"season","value":null},{"disabled":true,"description":{"content":"

required_without:id|size:3

\n","type":"text/plain"},"key":"brand","value":null},{"disabled":true,"description":{"content":"

required_without:id|size:2

\n","type":"text/plain"},"key":"sizetable","value":null},{"disabled":true,"key":"detail1","value":null},{"disabled":true,"key":"detail2","value":null},{"disabled":true,"key":"detail3","value":null},{"disabled":true,"key":"detail4","value":null},{"disabled":true,"key":"detail5","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category1","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category2","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category3","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category4","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category5","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category6","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category7","value":null},{"disabled":true,"key":"description","value":null},{"disabled":true,"key":"description2","value":null},{"disabled":true,"key":"description3","value":null},{"disabled":true,"key":"description4","value":null},{"disabled":true,"key":"description5","value":null},{"disabled":true,"key":"order_number","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"ultimate_delivery","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"expected_delivery","value":null},{"disabled":true,"description":{"content":"

numeric|between:0,100

\n","type":"text/plain"},"key":"vat","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"original_purchase_price","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"commercial_discount","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"purchase_price","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"original_markup","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"markup","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"price","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"on_customer_card","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"customer_card_percentage","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"customer_card_price","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"article_discount_allowed","value":null},{"disabled":true,"description":{"content":"

size:3

\n","type":"text/plain"},"key":"history_module","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"direct_delivery","value":null},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"colors","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"colors:color","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"colors:colorbrand","value":null},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"colors:stores","value":null},{"disabled":true,"description":{"content":"

required|size:2

\n","type":"text/plain"},"key":"colors:stores:store","value":null},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"colors:stores:detail","value":null},{"disabled":true,"description":{"content":"

required|size:

\n","type":"text/plain"},"key":"colors:stores:detail:sizeX","value":null},{"disabled":true,"description":{"content":"

required|size:

\n","type":"text/plain"},"key":"colors:stores:detail:sizeY","value":null},{"disabled":true,"key":"colors:stores:detail:edi","value":null},{"disabled":true,"description":{"content":"

required|integer

\n","type":"text/plain"},"key":"colors:stores:detail:order","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"colors:stores:detail:original_purchase_price","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"colors:stores:detail:commercial_discount","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"colors:stores:detail:purchase_price","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"colors:stores:detail:original_markup","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"colors:stores:detail:markup","value":null},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"colors:stores:detail:price","value":null}],"variable":[]}},"response":[],"_postman_id":"4def1a1d-d24a-43ab-954e-2b5d0c6a8b7d"},{"name":"Products/update_article","event":[{"listen":"test","script":{"id":"536fb956-8dec-4d2b-9bfd-cac24affec49","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"1e8f414b-81dd-419f-bb88-bc555cf3debc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 123456,\r\n \"variant\": 1,\r\n \"sizeX\": \"01\",\r\n \"sizeY\": \"01\",\r\n \"store\": \"01\",\r\n \"season\": \"NOS\",\r\n \"brand\": \"001\",\r\n \"sizetable\": \"01\",\r\n \"category1\": \"0101\",\r\n \"category2\": \"0201\",\r\n \"category3\": \"0301\",\r\n \"category4\": \"0401\",\r\n \"category5\": \"0501\",\r\n \"category6\": \"0601\",\r\n \"category7\": \"0701\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"description\": \"\",\r\n \"description2\": \"\",\r\n \"description3\": \"\",\r\n \"description4\": \"\",\r\n \"description5\": \"\",\r\n \"order_number\": \"\",\r\n \"ultimate_delivery\": \"2021-08-26\",\r\n \"vat\": 21,\r\n \"color\": \"0001\",\r\n \"colorbrand\": \"Navy 456\",\r\n \"edi\": \"\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/products/update_article","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","products","update_article"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

required_without:id|integer|between:10000000000000,90000000000000

\n","type":"text/plain"},"key":"product_uid","value":null},{"disabled":true,"description":{"content":"

required_without:product_uid|integer|between:100000,900000

\n","type":"text/plain"},"key":"id","value":null},{"disabled":true,"description":{"content":"

integer|between:1,99

\n","type":"text/plain"},"key":"variant","value":null},{"disabled":true,"description":{"content":"

size:2

\n","type":"text/plain"},"key":"sizeX","value":null},{"disabled":true,"description":{"content":"

size:2

\n","type":"text/plain"},"key":"sizeY","value":null},{"disabled":true,"description":{"content":"

size:2

\n","type":"text/plain"},"key":"store","value":null},{"disabled":true,"description":{"content":"

size:3

\n","type":"text/plain"},"key":"season","value":null},{"disabled":true,"description":{"content":"

size:3

\n","type":"text/plain"},"key":"brand","value":null},{"disabled":true,"description":{"content":"

size:2

size:4

\n","type":"text/plain"},"key":"category1","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category2","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category3","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category4","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category5","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"category6","value":null},{"disabled":true,"description":{"content":"

size:4

date

\n","type":"text/plain"},"key":"ultimate_delivery","value":null},{"disabled":true,"description":{"content":"

numeric|between:0,100

\n","type":"text/plain"},"key":"vat","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"color","value":""},{"disabled":true,"key":"colorbrand","value":null},{"disabled":true,"key":"edi","value":null}],"variable":[]}},"response":[],"_postman_id":"1e8f414b-81dd-419f-bb88-bc555cf3debc"},{"name":"Products/stock_action","event":[{"listen":"test","script":{"id":"faaf7917-227a-4172-b8ac-ae40b5a1683b","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"e4f5e072-ca2b-4adf-8f1c-433cf2ad120d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/products/stock_action","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","products","stock_action"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

required|in:order,delivery,stock_correction

\n","type":"text/plain"},"key":"action","value":""},{"disabled":true,"description":{"content":"

OnlyUsedWithOtherFields:action,stock_correction|size:2

\n","type":"text/plain"},"key":"stock_correction_id","value":""},{"disabled":true,"key":"remark","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"date","value":""},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

size:3

\n","type":"text/plain"},"key":"history_module","value":""},{"disabled":true,"description":{"content":"

OnlyUsedWithOtherFields:action,order|boolean

\n","type":"text/plain"},"key":"direct_delivery","value":""},{"disabled":true,"description":{"content":"

OnlyUsedWithOtherFields:action,order|boolean

\n","type":"text/plain"},"key":"is_reorder","value":""},{"disabled":true,"description":{"content":"

OnlyUsedWithOtherFields:action,delivery|boolean

\n","type":"text/plain"},"key":"remove_backorder","value":""},{"disabled":true,"description":{"content":"

OnlyUsedWithOtherFields:action,stock_correction|boolean

\n","type":"text/plain"},"key":"ignore_check","value":null},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"products","value":""},{"disabled":true,"description":{"content":"

required|integer|between:10000000000000,90000000000000

\n","type":"text/plain"},"key":"products:product_uid","value":""},{"disabled":true,"description":{"content":"

required|integer|not_in:0

\n","type":"text/plain"},"key":"products:quantity","value":""}],"variable":[]}},"response":[],"_postman_id":"e4f5e072-ca2b-4adf-8f1c-433cf2ad120d"}],"id":"2273766d-f973-482b-814f-ad0598ff3288","description":"

Introduction

Products are the essence of every shop. In the end, a shop without products would not attract many customers and without customers there is no income. Let us start with an example and see how it is build up in the SoftTouch API. As example we take a red t-shirt.

General information

The brand name of this particular product is SoftTouch. All the information about this brand can be found in the brand model. The id of this brand, which is used to refer to in the product, exists of three characters, usually numbers.
In the fashion it is quite common that each half a year is a new season, usually following the latest fashion trends. Winter 2023 and Summer 2023 are two examples of such seasons. The red t-shirt is a product that is probably not entitled to a particular season, since the design of the shirt won’t change for a long time. The use of a so called ‘Never out of Stock’ season is appropriate here. The seasons and their information can be found in the season model. The id of a season exists of three characters, usually referring to the season somehow. The id for Summer 2023 could be ‘S23’ for example or, to make ordering easier, ‘123’. Winter 2023 could be ‘W23’ or ‘123’. Never out of stock seasons often have the id ‘NOS’ or ‘999’.
Articles can be filed in different categories. The values for these categories should be recurring to many products and not specific to one or a few products. Good examples would be the sex – male, female, etc. – and article group – trousers, t-shirts, etc. These categories can be found in the category model. There are seven possible categories. The id of each category exists of four characters. The first two characters represent which group it belongs to – ‘0102’ belongs to category 1 while ‘0245’ belongs to category 2. The last two characters is the id within the group. This is mostly numeric, but can be alphabetic. For most clients the first category is the sex and the second category the article group.
A product usually has a unique article number or reference and often an article name. The latter is mostly, but not always unique for the article. For our shirt the reference might be ‘ABC-123’ and the name might be ‘Red t-shirt’. This information can be found in the detail of the article. The article reference can usually be found in the first detail and the name of the article in the second. If there is no reference, the name could be found in the first. There are five detail fields to store product specific data.
A product can also have a description. This is usually some limited information to aid the sales person in order to recognise the article in a quick glance. ‘Red t-shirt short sleeve’ could be an example for our shirt. While there are five description fields, usually only the first is used. While the description can contain any data, it should not be a long text which is used to show on a web shop for instance. There are other places for this, which will be covered later.
Most articles have different sizes. This will be covered in more depth later. For now it is enough to know that each product needs a link to a size table. The information of the size tables can be found in the size table model. Each size table has an id of two characters, usually numeric.
To make the product unique, there exist an id, which has no link to any data of the supplier. This is a numeric value with six digits, i.e. higher or equal to 100000 and lower than 900000.

Colours and variants

From our example red t-shirt ther is also a yellow and blue version. Often the supplier has for each colour its own code, something like ‘R001’. In the API this can be found in colorbrand as ‘R001 - red'.
When suppliers use many different names for almost the same colour, it might be easier to refer to them with the same name. For the colour red there might be the description cherry, rose, jam, merlot, garnet, crimson, etc. They could all be linked to one of the colours in the color model. The id of such a colour exists of four characters, usually numbers. The use of these colours is not mandatory, so the color parameter for a product might be an empty string.
A product with different colours or variants can use the same id with a different variant number. This is a numeric value not higher than 99.

Sizes

As mentioned before, most products have different sizes. For our shirt the size table that is being used might look something like this:

\n\n

In the SoftTouch API each size has a position on the size table. It always starts from position one and increments with one for each following size. The positions on this size table might look something like this:

\n\n

Size tables in the SoftTouch API can be 2-dimentional. Good examples for such size tables are those for trousers with leg length sizes or bras with cup sizes:

\n\n

The first dimension of a size table is represented by the X size, while the second dimension is represented by the Y size. In the last size table size 38/L34 would be represented by sizeX ‘04’ and sizeY ‘03’. When a size table represents one dimensional sizes sizeY will always be ‘01’. Some products don’t have a size or exist only in one size. In this case a size table with one size is needed. The one size on the size table is often referred to as ‘TU’, which is an abbreviation for Taille Unique.

Stores

The details of the stores can be found in the store model. The id referring to the store in a product exists of two characters, always numeric. This seems like a simple issue to dedicate a separate chapter to it. True, but it brings us to the key of a product.
The key of a product is the combination of five parameters, the id, the variant, sizeX, sizeY and the store. It is a numeric value existing of 14 digits. The first 6 represent the id, The following two represent the variant. The ninth and tenth and the eleventh and twelfth digits represent sizeX and sizeY. The last two digits represent the store.
Since these five parameters make a product unique, it is technically possible that some of the other parameters might differ for the same product, having another key. For example the VAT percentage of a product might be 21 in one store, while in another it might be 20 – this store will be located in another country. While this theory could work for all other parameters, it should not be so for many parameters – season, brand and the category parameters to name a few.

More information

What follows are a few more parameters a product can have.
edi: Suppliers often provide barcodes for the products. These barcodes can be found in the edi field.

stock, backorder: The stock is the amount of pieces available to sell. Sometimes products can be physically in stock, but are reserved by customers. Those products will not be available. The backorder are the amount of pieces yet to be delivered by the supplier.

price: The selling price of the product. Note that this can differ over different sizes and even stores.

salesprice, salesdiscount, salesstart, salesend: These four parameters have everything to do with the sales period and the discount on the product during this period. The price would be the new price of the article while the discount is a percentage. When the price is not 0, the discount parameter will be ignored. The sales period starts on the start date and ends on the end date, the end date not including (this contradicts with the logic at many other places)! Note that there is the discount model which is used to set a discount period on a group of articles. If a discount is set on a product level, this will get the priority. Know that these parameters are not the only ones that might have an impact on the discount of an article. To make sure it is better to use the following four parameters.

discount_date, discount_percentage, discount_value, netto_price: On a certain date – represented by the discount_date parameter – the article might be entitled to a discount. The percentage and the value of the discount are respectively represented by the percentage and discount_value. The new price is represented by the parameter netto_price. These parameters take all possible modifiers for the discount in account. Therefore it could as well be that a discount is taking effect while the previous four sales parameters seem to contradict this.

vat: The VAT percentage of the product

online: A Boolean value determining if the product is available online or not

status: The status of an article. There are three possible values, being A (active), I (inactive) and D (deleted). Only articles with the active status should be used.

timestamp: The moment an article has been changed the last time. There is a separate chapter that covers this parameter in more depth. Since it has some subtle nuances, it is very important that this chapter is covered when relying on this parameter.

texts, files, related: These three parameters are arrays with data usually used by web designers. The texts are used for large texts in order to give customers more information about the product. The files are mostly used for pictures, but can in theory be any file format. The related array contains the combination of ids and variants to other products which are related in some way to the product. In the example this could be a Star Trek trousers which fits perfectly with the shirt. These three parameters are explained in more depth in the following part of this chapter.

first_delivery, last_delivery: The first and last date a product has been delivered. This is the same for all sizes in all stores of the same product.

Text, files and relations

A product has a few array parameters which are typically used for web shops. These parameters are the texts, files and related parameter. An example can be found in the following part of this chapter.
In one of the previous chapters we covered that the description parameters can contain some small text describing the article. While this is mostly sufficient for the sales person, it usually is not enough for a buying customer. A better place for long texts is the, well…, texts parameter. The length of the text in each of the array items should be more than enough.
But there is more. Each item can be linked to a type. The type represents for example a title, a description or even some information about the fabric or some washing instructions. Since the types indicates what the information is about, the web developer can decide where and how the information can be displayed on the web shop.
Since there can be multiple text items for the same type it might be useful to know in what order they should be displayed. The sort parameter can be used for that. Use this parameter with caution, however. Since a text item can be linked to either one variant (colour) of a certain product, or all variants the sort parameter does not always make sense. So, when it is used, it is best to agree with stock managers of the shop that texts are either linked to either one variant or all variants of a product. Also take in account that the default value of the sort parameter is 1, unless the stock manager changes this value.
The files parameter represent all file names linked to the product. Usually these files are pictures. File items have a type and sort parameter, which work in the same way as with the text items. Also, just like text items, file items can be linked to either one variant of a product or all variants of the product.
Products can be related to other products in some way. The cool Star Trek shirt might for example have perfectly matching trousers. The related parameter lists these articles in an array. In these items the related parameter represents the first 8 characters of the product uid (id + variant) that relates with the article. It is important to know that the relation does not go in two ways by default. When a product (A) has a related product (B), this related product (B) does not have the original product (A) as a related product, unless it is explicitly linked by the stock manager.

\n","_postman_id":"2273766d-f973-482b-814f-ad0598ff3288","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Product memos todo","item":[{"name":"Product_memos","event":[{"listen":"test","script":{"id":"e13afd6b-c3bb-4e92-995a-1f2f68c747be","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"01361d3a-2ff2-49a9-a088-e04d03936287","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/product_memos","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

integer|between:100000,999999

\n","type":"text/plain"},"key":"product_id","value":null},{"disabled":true,"description":{"content":"

integer|between:0,99

\n","type":"text/plain"},"key":"product_variant","value":null},{"disabled":true,"description":{"content":"

in:30000,30001

\n","type":"text/plain"},"key":"type","value":null},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"valid_at","value":null}],"variable":[]}},"response":[],"_postman_id":"01361d3a-2ff2-49a9-a088-e04d03936287"},{"name":"Product_memos/{{id}}","event":[{"listen":"test","script":{"id":"47b75c90-6e28-4810-bea9-812567a9d123","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"7ce5825e-7831-4e68-bd25-0fd4441be5a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/product_memos/1","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

required|integer|between:100000,999999

\n","type":"text/plain"},"key":"product_id","value":null},{"disabled":true,"description":{"content":"

required|integer|between:0,99

\n","type":"text/plain"},"key":"product_variant","value":null},{"disabled":true,"description":{"content":"

required|in:30000,30001

\n","type":"text/plain"},"key":"type","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"memo","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"user_id","value":null},{"disabled":true,"description":{"content":"

required_if:type,30001|date

\n","type":"text/plain"},"key":"valid_from","value":null},{"disabled":true,"description":{"content":"

required_if:type,30001|date

\n","type":"text/plain"},"key":"valid_to","value":null}],"variable":[]}},"response":[],"_postman_id":"74846bb8-61cb-42b1-99cf-fc9ee9bfd2dd"},{"name":"Product_memos","event":[{"listen":"test","script":{"id":"5deaf267-79c9-4a84-aaf5-406299d43273","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"2a668890-8c84-4f87-afd2-f0b9b1fbfc0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product_id\": 123456,\r\n \"product_variant\": 1,\r\n \"type\": 30001,\r\n \"memo\": \"Memo text\",\r\n \"user_id\": \"1001\",\r\n \"valid_from\": \"2021-08-26\",\r\n \"valid_unril\": \"2021-08-26\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/product_memos/1","description":"

List all colors.

required

\n","type":"text/plain"},"key":"memo","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"user_id","value":null},{"disabled":true,"description":{"content":"

required_if:type,30001|date

\n","type":"text/plain"},"key":"valid_from","value":null},{"disabled":true,"description":{"content":"

required_if:type,30001|date

\n","type":"text/plain"},"key":"valid_to","value":null}],"variable":[]}},"response":[],"_postman_id":"2a668890-8c84-4f87-afd2-f0b9b1fbfc0b"},{"name":"Product_memos","event":[{"listen":"test","script":{"id":"54194850-2114-4337-adac-6e63d01d0532","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"57a4d890-b1fb-4875-b2be-efc4acb013be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/product_memos/1","description":"

List all colors.

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

CommaSeperatedSize:8

\n","type":"text/plain"},"key":"barbodycolors","value":null},{"disabled":true,"description":{"content":"

CommaSeperatedSize:6

\n","type":"text/plain"},"key":"barbody","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"wash_and_care_instruction_id","value":null}],"variable":[]}},"response":[],"_postman_id":"23a9ef18-69cd-4151-8e7b-d61a4327c985"}],"id":"72b2615e-c3f9-4d47-a985-1c17ce0e9d20","_postman_id":"72b2615e-c3f9-4d47-a985-1c17ce0e9d20","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Program variables todo","item":[{"name":"Prog_variables","event":[{"listen":"test","script":{"id":"96170990-10d9-4962-8787-caed4a4e9276","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"5f8666d7-cbae-48c9-90ce-35a2904ad50f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/prog_variables","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

size:2

\n","type":"text/plain"},"key":"store_id","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"pos_id","value":null}],"variable":[]}},"response":[],"_postman_id":"5f8666d7-cbae-48c9-90ce-35a2904ad50f"}],"id":"78b71361-6700-481e-9ff9-957aa0cd0d6a","_postman_id":"78b71361-6700-481e-9ff9-957aa0cd0d6a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Reservations","item":[{"name":"Reservations","event":[{"listen":"test","script":{"id":"52771dd8-a212-4f65-b4a1-571c7b507757","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"a4d67db6-5f13-41f3-bfd1-db4e020e570a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/reservations/999100002","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","reservations","999100002"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"key":"display","value":"full"}],"variable":[]}},"response":[],"_postman_id":"a4d67db6-5f13-41f3-bfd1-db4e020e570a"},{"name":"Reservations","event":[{"listen":"test","script":{"id":"5337e118-ce7d-4953-8af8-b303c38d6a01","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"b77b5065-3587-4ea8-a7e1-6e89e65300a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": 2,\r\n \"delivery_address_id\": 6,\r\n \"invoice_address_id\": 4,\r\n \"payment_type\": 9,\r\n \"giftlist_id\": 1,\r\n \"store_id\": \"01\",\r\n \"pos_id\": \"0101\",\r\n \"remarks\": \"This is a remark.\",\r\n \"items\": [\r\n {\r\n \"product_uid\": \"55559002030201\",\r\n \"quantity\": 1,\r\n \"discount\": 50.00,\r\n \"discount_type_id\": 99999908000002,\r\n \"description\": \"This is a test.\",\r\n \"vat_percentage\": 21,\r\n \"art_external_order_status\": 28001\r\n },\r\n {\r\n \"product_uid\": \"55559002030201\",\r\n \"quantity\": 1,\r\n \"price_to_pay\": 25\r\n },\r\n {\r\n \"product_uid\": \"55559001030301\",\r\n \"quantity\": 2,\r\n \"net_price\": 50\r\n }\r\n ]\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/reservations","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","reservations"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

required|integer

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"payment_type","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"invoice_address_id","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"delivery_address_id","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"giftlist_id","value":""},{"disabled":true,"description":{"content":"

size:2

\n","type":"text/plain"},"key":"store_id","value":""},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"pos_id","value":""},{"disabled":true,"key":"remarks","value":""},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"items","value":""},{"disabled":true,"description":{"content":"

required|integer|between:10000000000000,99999999999999

\n","type":"text/plain"},"key":"items:product_uid","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"items:quantity","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"items:discount","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"items:price_to_pay","value":""},{"disabled":true,"description":{"content":"

integer|between:99999908000000,99999908999999

\n","type":"text/plain"},"key":"items:discount_type_id","value":""},{"disabled":true,"key":"items:description","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"items:vat_percentage","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"items:net_price","value":""},{"disabled":true,"description":{"content":"

integer|between:28000,28099

\n","type":"text/plain"},"key":"items:art_external_order_status","value":""},{"disabled":true,"key":"display","value":"full"}],"variable":[]}},"response":[],"_postman_id":"b77b5065-3587-4ea8-a7e1-6e89e65300a3"},{"name":"Reservations/process","event":[{"listen":"test","script":{"id":"b70ed095-66a9-419f-8137-20f3bd825a8f","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"58f2280e-c5ef-4837-9080-1f6d39ab6df0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/reservations/999100002/process?payment_type=9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","reservations","999100002","process"],"host":["api","softtouch","eu"],"query":[{"description":{"content":"

required|integer|between:1,30

\n","type":"text/plain"},"key":"payment_type","value":"9"}],"variable":[]}},"response":[],"_postman_id":"58f2280e-c5ef-4837-9080-1f6d39ab6df0"}],"id":"0524de2c-b120-4ceb-a88f-931ede9dcb98","description":"

Reservations may look a bit daunting if one does not know how it works. To limit the network traffic, an entire reservation with all its items can be created in one call.

A basic example

\n\n

Result:

","_postman_id":"0524de2c-b120-4ceb-a88f-931ede9dcb98","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Receipts todo","item":[{"name":"Receipts","event":[{"listen":"test","script":{"id":"3e8d385b-b459-4238-93c3-31836924e149","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"12358913-6c90-4958-9ab4-47159d81d1d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/receipts","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

date_period

\n","type":"text/plain"},"key":"date_period","value":null},{"disabled":true,"description":{"content":"

CommaSeperatedInteger|CommaSeperatedBetween:10000000000000,99999999999999

\n","type":"text/plain"},"key":"product_uids","value":null},{"disabled":true,"description":{"content":"

CommaSeperatedInteger

\n","type":"text/plain"},"key":"customer_ids","value":null},{"disabled":true,"description":{"content":"

CommaSeperatedSize:2

\n","type":"text/plain"},"key":"store_ids","value":null},{"disabled":true,"description":{"content":"

CommaSeperatedSize:4

\n","type":"text/plain"},"key":"pos_ids","value":null},{"disabled":true,"description":{"content":"

CommaSeperatedInteger|CommaSeperatedBetween:1000000000,9999999999

\n","type":"text/plain"},"key":"receipt_id_range","value":null},{"disabled":true,"key":"tracking_number","value":null},{"disabled":true,"key":"remark","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"is_webshop_order","value":null}],"variable":[]}},"response":[],"_postman_id":"12358913-6c90-4958-9ab4-47159d81d1d4"},{"name":"Receipts/{{id}}","event":[{"listen":"test","script":{"id":"7f30219f-7c6c-4d91-9438-3630383f7842","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"fa4f7297-96b6-401a-983c-b4c47b6dc87d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/receipts/2000158889","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

integer|required_if:create_invoice,true

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"invoice_address_id","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"delivery_address_id","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"price_paid","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"no_direct_discount","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"generate_customer_discount","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"create_voucher_when_negative","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"force_unit_price_calculation","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"process","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"create_invoice","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"is_webshop_order","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"webshop_order_processed","value":""},{"disabled":true,"description":{"content":"

size:2

\n","type":"text/plain"},"key":"store_id","value":""},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"pos_id","value":""},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

max:255

\n","type":"text/plain"},"key":"tracking_number","value":""},{"disabled":true,"key":"remark","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"reservation_id","value":""},{"disabled":true,"description":{"content":"

array

\n","type":"text/plain"},"key":"payment","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:1","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:2","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:3","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:4","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:5","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:6","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:7","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:8","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:9","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"payment:10","value":""},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"items","value":""},{"disabled":true,"description":{"content":"

required|integer|BetweenOrIn:10000000000000,99999999999999,999902,999903,999904,999905,999909

\n","type":"text/plain"},"key":"items:product_uid","value":""},{"disabled":true,"description":{"content":"

size:8

\n","type":"text/plain"},"key":"items:checksum","value":""},{"disabled":true,"description":{"content":"

date

\n","type":"text/plain"},"key":"items:ready_date","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"items:quantity","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"items:discount","value":""},{"disabled":true,"description":{"content":"

required_if:product_uid,99999999999996,99999999999997,99999999999998,99999999999999,999902,999903,999904,999905,999909|numeric

\n","type":"text/plain"},"key":"items:price_to_pay","value":""},{"disabled":true,"key":"items:description","value":""},{"disabled":true,"key":"items:long_description","value":""},{"disabled":true,"description":{"content":"

integer|between:99999908000000,99999908999999

\n","type":"text/plain"},"key":"items:discount_type_id","value":""},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"items:user_sold_id","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"items:vat_percentage","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"items:on_customer_card","value":""},{"disabled":true,"description":{"content":"

numeric

\n","type":"text/plain"},"key":"items:customer_card_percentage","value":""},{"disabled":true,"description":{"content":"

in:28000,28001,28002

\n","type":"text/plain"},"key":"items:art_external_order_status","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"items:webshop_order_processed","value":""},{"disabled":true,"description":{"content":"

only with product_uid 999902

\n","type":"text/plain"},"key":"items:custom_code","value":null}],"variable":[]}},"response":[],"_postman_id":"a5a73fb8-2b85-41a8-b182-82b59d49009a"},{"name":"Receipts","event":[{"listen":"test","script":{"id":"3bb5cd59-df83-4943-a819-4ca429ef7ec2","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"52ee9874-43da-487b-be26-356b29d7217d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"tracking_number\": \"EX47868BA4\",\r\n \"remark\": \"You can update the remark here.\"\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/receipts/2000158889","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","receipts","2000158889"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

max:255

\n","type":"text/plain"},"key":"tracking_number","value":null},{"disabled":true,"key":"remark","value":null}],"variable":[]}},"response":[],"_postman_id":"52ee9874-43da-487b-be26-356b29d7217d"}],"id":"dcda4e35-d002-44f7-990d-af495ac8e9cd","_postman_id":"dcda4e35-d002-44f7-990d-af495ac8e9cd","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Seasons","item":[{"name":"Seasons","event":[{"listen":"test","script":{"id":"53f9dbdf-eb98-4e14-96c8-02c4a1966f19","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"a4fc4eb2-32a3-4d95-9e99-7239f8ba7433","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/seasons?display=full","description":"

This endpoint retrieves all available seasons. Similar to other paginated endpoints, the request must be made in steps, with a maximum of 500 seasons per call.

Used parameters:

display (full)
\n
take
\n
skip
\n

A brief explanation of return values:

id: The unique identifier for the seasons (e.g., \"W21\" for Winter 2021).
\n
description: A description of the season (e.g., \"Winter 2021\").
\n
detail1-5: Customizable fields for additional season details. These fields can store metadata or client-specific information.
\n
active: A boolean indicating whether the season is currently active (true) or inactive (false)
\n
visible: A boolean indicating wheter the season is visible (true) or hidden (false).
\n
from_date: The start date of the season, formatted as YYYY-MM-DD
\n
to_date: The end date of the season, formatted as YYYY-MM-DD.
\n

When display=full is used, additional detailed information will be included :

lang1-5: Multilingual descriptions for the season, allowing localization in up to five languages. These may be null if not set.
\n
web_visible: Indicates if the season is visible on web-related platforms (true or false).
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","seasons"],"host":["api","softtouch","eu"],"query":[{"key":"display","value":"full"},{"disabled":true,"key":"take","value":"500"},{"disabled":true,"key":"skip","value":"0"}],"variable":[]}},"response":[{"id":"4213b830-5e76-4232-8f32-b7e438a8825a","name":"Seasons","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/seasons","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","seasons"],"query":[{"key":"display","value":"full","disabled":true},{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 06 Nov 2024 09:29:05 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6InV3c2w2bG5kXC9qUlZlYUpYVVg0OFZnPT0iLCJ2YWx1ZSI6IlBSaTVEaW9sTnpYWVwvMU9lUHkzdWQrOEdUUGJlVE5aMUV3XC90cUdrS0Irc1pwTXJidGlZWmRJNmIyUjFNemJKNWpjc0NoY0tIbDhXS0czYkZ5TStJcEE9PSIsIm1hYyI6ImY3YzMzZjc2Mjk1ZTI3OGQxZjQ3N2ZhZTc1NmUzOTVmMjBhMWM4MTQ5Nzk1MmFjYTI5MjZkNmYzNjdjMmRkOGYifQ%3D%3D; expires=Wed, 06-Nov-2024 11:29:05 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"999\",\n \"description\": \"Doorlopend/NOS\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": true,\n \"visible\": true\n },\n {\n \"id\": \"W19\",\n \"description\": \"Winter 2019\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W20\",\n \"description\": \"Winter 2020\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W21\",\n \"description\": \"Winter 2021\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W22\",\n \"description\": \"Winter 2022\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"T\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W23\",\n \"description\": \"Winter 2023\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"T\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W24\",\n \"description\": \"Winter 2024\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"T\",\n \"detail5\": \"\",\n \"active\": true,\n \"visible\": true\n },\n {\n \"id\": \"W25\",\n \"description\": \"Winter 2025\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": true,\n \"visible\": true\n },\n {\n \"id\": \"Z19\",\n \"description\": \"Zomer 2019\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z20\",\n \"description\": \"Zomer 2020\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z21\",\n \"description\": \"Zomer 2021\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z22\",\n \"description\": \"Zomer 2022\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z23\",\n \"description\": \"Zomer 2023\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"T\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z24\",\n \"description\": \"Zomer 2024\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"T\",\n \"active\": false,\n \"visible\": true\n },\n {\n \"id\": \"Z25\",\n \"description\": \"Zomer 2025\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": true,\n \"visible\": true\n }\n]"}],"_postman_id":"a4fc4eb2-32a3-4d95-9e99-7239f8ba7433"},{"name":"Seasons/{{id}}","event":[{"listen":"test","script":{"id":"8124b312-f361-492e-b25c-6e3017244e02","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"f4c94128-200d-47b6-80b4-2498ab7cdbd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/seasons/Z24","description":"

This endpoint fetches a specific season

Used parameters:

display (full)
\n
take
\n
skip
\n

A brief explanation of return values:

id: The unique identifier for the seasons (e.g., \"W21\" for Winter 2021).
\n
description: A description of the season (e.g., \"Winter 2021\").
\n
detail1- 5: Customizable fields for additional season details. These fields can store metadata or client-specific information.
\n
active: A boolean indicating whether the season is currently active (true) or inactive (false)
\n
visible: A boolean indicating wheter the season is visible (true) or hidden (false).
\n
from_date: The start date of the season, formatted as YYYY-MM-DD
\n
to_date: The end date of the season, formatted as YYYY-MM-DD.
\n

When display=full is used, additional detailed information will be included :

lang1-5: Multilingual descriptions for the season, allowing localization in up to five languages. These may be null if not set.
\n
web_visible: Indicates if the season is visible on web-related platforms (true or false).
\n

To create a new season this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	constraints
id	string	length:3
description	string	required
detail1	string
detail2	string
detail3	string
detail4	string
detail5	string
from_date	date	required, format: `YYYY-MM-DD`
to_date	date	required, format: `YYYY-MM-DD`
active	string	default: `true`
visible	string	default: `true`
lang1	string
lang2	string
lang3	string
lang4	string
lang5	string

required|string|size:3

\n","type":"text/plain"},"key":"id","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"description","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"active","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"visible","value":null}],"variable":[]}},"response":[{"id":"8666e2e5-102b-4ee7-9242-0da20e439692","name":"Seasons","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"W26\",\r\n \"description\": \"Winter 2026\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"from_date\": \"2026-12-01\",\r\n \"to_date\": \"2026-12-31\",\r\n \"active\": true,\r\n \"visible\": true,\r\n \"lang1\": \"Winter\",\r\n \"lang2\": \"L'hiver\",\r\n \"lang3\": \"Winter\",\r\n \"lang4\": \"Invierno\",\r\n \"lang5\": \"Inverno\"\r\n}"},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/seasons","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","seasons"],"query":[{"key":"id","value":null,"description":"required|string|size:3","type":"text","disabled":true},{"key":"description","value":null,"description":"required","type":"text","disabled":true},{"key":"active","value":null,"description":"boolean","type":"text","disabled":true},{"key":"visible","value":null,"description":"boolean","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 06 Nov 2024 11:10:31 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6InZZZWZjdFRkZ0xKMzFcLzBLV2h3ZFZBPT0iLCJ2YWx1ZSI6IldxaTBKQXhSWmdDSjRQQjl6QVZNOHNKSnd6bUZiRkcxd2ExYk8zVkJ1eDFwUjVyZENkbkk0UHdWTjhvNGlMNjVKSHI1aHl0bnRzK2huaE1zTGZTTEd3PT0iLCJtYWMiOiIwNTk5ZDllMTlhZmUzMjQ5NjBkYWUyNjQ0ZDYyYjMxMTZlZWMwNmEzMDZkN2NhNDRmNjdjZWUwNDFlZDhlNTNmIn0%3D; expires=Wed, 06-Nov-2024 13:10:31 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"W26\",\n \"description\": \"Winter 2026\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": true,\n \"visible\": true\n}"}],"_postman_id":"cf0b17d2-fea9-43cf-b795-8e212b452d11"},{"name":"Seasons/bulk_insert","event":[{"listen":"test","script":{"id":"422c0903-108d-4c84-bfc5-24cb0a99fb88","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"9884f68b-61d1-4058-825c-9a0bf8b420dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"seasons\": [\r\n {\r\n \"id\": \"W19\",\r\n \"description\": \"Winter 2019\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W20\",\r\n \"description\": \"Winter 2020\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W21\",\r\n \"description\": \"Winter 2021\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W22\",\r\n \"description\": \"Winter 2022\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"T\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W23\",\r\n \"description\": \"Winter 2023\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"T\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W24\",\r\n \"description\": \"Winter 2024\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"T\",\r\n \"detail5\": \"\",\r\n \"active\": true,\r\n \"visible\": true\r\n },\r\n {\r\n \"id\": \"W25\",\r\n \"description\": \"Winter 2025\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": true,\r\n \"visible\": true\r\n },\r\n {\r\n \"id\": \"Z19\",\r\n \"description\": \"Zomer 2019\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z20\",\r\n \"description\": \"Zomer 2020\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z21\",\r\n \"description\": \"Zomer 2021\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z22\",\r\n \"description\": \"Zomer 2022\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z23\",\r\n \"description\": \"Zomer 2023\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"T\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z24\",\r\n \"description\": \"Zomer 2024\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"T\",\r\n \"active\": false,\r\n \"visible\": true\r\n },\r\n {\r\n \"id\": \"Z25\",\r\n \"description\": \"Zomer 2025\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": true,\r\n \"visible\": true\r\n }\r\n ],\r\n \"force_update\": true\r\n \r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/seasons/bulk_insert","description":"

To create multiple seasons in bulk this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	constraints
id	string	length:3
description	string	required
detail1	string
detail2	string
detail3	string
detail4	string
detail5	string
from_date	date	required, format: YYYY-MM-DD
to_date	date	required, format: YYYY-MM-DD
active	string	default: true
visible	string	default: true
lang1	string
lang2	string
lang3	string
lang4	string
lang5	string

required|array|max:500

\n","type":"text/plain"},"key":"seasons","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"force_update","value":null}],"variable":[]}},"response":[{"id":"3a256e2a-a921-490e-8eb9-4e7ff3a73703","name":"Seasons/bulk_insert","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"seasons\": [\r\n {\r\n \"id\": \"W19\",\r\n \"description\": \"Winter 2019\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W20\",\r\n \"description\": \"Winter 2020\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W21\",\r\n \"description\": \"Winter 2021\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W22\",\r\n \"description\": \"Winter 2022\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"T\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W23\",\r\n \"description\": \"Winter 2023\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"T\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"W24\",\r\n \"description\": \"Winter 2024\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"T\",\r\n \"detail5\": \"\",\r\n \"active\": true,\r\n \"visible\": true\r\n },\r\n {\r\n \"id\": \"W25\",\r\n \"description\": \"Winter 2025\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": true,\r\n \"visible\": true\r\n },\r\n {\r\n \"id\": \"Z19\",\r\n \"description\": \"Zomer 2019\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z20\",\r\n \"description\": \"Zomer 2020\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z21\",\r\n \"description\": \"Zomer 2021\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z22\",\r\n \"description\": \"Zomer 2022\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z23\",\r\n \"description\": \"Zomer 2023\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"T\",\r\n \"active\": false,\r\n \"visible\": false\r\n },\r\n {\r\n \"id\": \"Z24\",\r\n \"description\": \"Zomer 2024\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"T\",\r\n \"active\": false,\r\n \"visible\": true\r\n },\r\n {\r\n \"id\": \"Z25\",\r\n \"description\": \"Zomer 2025\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": true,\r\n \"visible\": true\r\n }\r\n ],\r\n \"force_update\": true\r\n \r\n}"},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/seasons/bulk_insert","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","seasons","bulk_insert"],"query":[{"key":"seasons","value":null,"description":"required|array|max:500","type":"text","disabled":true},{"key":"force_update","value":null,"description":"boolean","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 06 Nov 2024 09:29:00 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6Im10M3NLVVlBTDNUb0lOOURCMW1ub2c9PSIsInZhbHVlIjoiSFNVZDNKc29UWFVodGtHRXZHdkF3NVhzRTBuQXRzb3U5dUpTRU1pN2RnWWhKVnlBcUlYWlA5WnZ5TXRyVDhLNnhWVHNUYXE4MTlQQUQ3cFhrNzd5d3c9PSIsIm1hYyI6ImM2ZTU0NDk1M2RjMGQyNjI4MjhlOGFlYjQ4MDZjNjY2MDgzOTEzNGFjMjU0ZTc4NWUzNGUwZDY0YzdjMjYzMGIifQ%3D%3D; expires=Wed, 06-Nov-2024 11:29:00 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"W19\",\n \"description\": \"Winter 2019\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W20\",\n \"description\": \"Winter 2020\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W21\",\n \"description\": \"Winter 2021\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W22\",\n \"description\": \"Winter 2022\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"T\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W23\",\n \"description\": \"Winter 2023\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"T\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"W24\",\n \"description\": \"Winter 2024\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"T\",\n \"detail5\": \"\",\n \"active\": true,\n \"visible\": true\n },\n {\n \"id\": \"W25\",\n \"description\": \"Winter 2025\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": true,\n \"visible\": true\n },\n {\n \"id\": \"Z19\",\n \"description\": \"Zomer 2019\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z20\",\n \"description\": \"Zomer 2020\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z21\",\n \"description\": \"Zomer 2021\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z22\",\n \"description\": \"Zomer 2022\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z23\",\n \"description\": \"Zomer 2023\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"T\",\n \"active\": false,\n \"visible\": false\n },\n {\n \"id\": \"Z24\",\n \"description\": \"Zomer 2024\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"T\",\n \"active\": false,\n \"visible\": true\n },\n {\n \"id\": \"Z25\",\n \"description\": \"Zomer 2025\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": true,\n \"visible\": true\n }\n]"}],"_postman_id":"9884f68b-61d1-4058-825c-9a0bf8b420dd"},{"name":"Seasons","event":[{"listen":"test","script":{"id":"0202e35f-ac41-420d-85d8-58138f611177","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"fbfd4782-8918-48fa-a39b-71a0c9bc9651","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"Winter 2026 Patched\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": true,\r\n \"visible\": true\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/seasons/W26","description":"

To update a season this endpoint should be used.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	type	constraints
description	string
detail1	string
detail2	string
detail3	string
detail4	string
detail5	string
from_date	date	format: YYYY-MM-DD
to_date	date	format: YYYY-MM-DD
active	string	default: true
visible	string	default: true
lang1	string
lang2	string
lang3	string
lang4	string
lang5	string

required|string|size:3

\n","type":"text/plain"},"key":"id","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"description","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"active","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"visible","value":null}],"variable":[]}},"response":[{"id":"736d4a4e-6332-4357-8205-b45e8a215b16","name":"Seasons","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"description\": \"Winter 2026 Patched\",\r\n \"detail1\": \"\",\r\n \"detail2\": \"\",\r\n \"detail3\": \"\",\r\n \"detail4\": \"\",\r\n \"detail5\": \"\",\r\n \"active\": true,\r\n \"visible\": true\r\n}"},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/seasons/W26","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","seasons","W26"],"query":[{"key":"id","value":null,"description":"required|string|size:3","type":"text","disabled":true},{"key":"description","value":null,"description":"required","type":"text","disabled":true},{"key":"active","value":null,"description":"boolean","type":"text","disabled":true},{"key":"visible","value":null,"description":"boolean","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 06 Nov 2024 12:25:08 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IldUSWZZaHhwbVVRRGtRaHFTTVJTYkE9PSIsInZhbHVlIjoiNjdzWE52ZUVlTnRkWlJNa21zS09JbjNQNmt2RGJoWWR4bXB2SGE3RFM1NytmdmxkWUNnMjhCZG10MzF2anZDK1ZEWWdqSE9kUXo5alNTd2U3NW9wUnc9PSIsIm1hYyI6IjE4NjNhNTBhMWM5MDg2N2MwN2U2MTExY2E0Mjc5N2RjZjZhNjhhOTAwMjhiMGQwNWViMGNjMmZkOWM4MGNmNWIifQ%3D%3D; expires=Wed, 06-Nov-2024 14:25:08 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"W26\",\n \"description\": \"Winter 2026 Patched\",\n \"detail1\": \"\",\n \"detail2\": \"\",\n \"detail3\": \"\",\n \"detail4\": \"\",\n \"detail5\": \"\",\n \"active\": true,\n \"visible\": true\n}"}],"_postman_id":"fbfd4782-8918-48fa-a39b-71a0c9bc9651"},{"name":"Seasons","event":[{"listen":"test","script":{"id":"35a835f0-d928-41ae-b3eb-d0e189e9be0a","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript","packages":{}}}],"id":"9f74aa6f-986e-49df-b200-5bc4510695a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/seasons/W26","description":"

To delete a season

The seasons endpoint allows retrieval of season-specific data, such as description, status, and customizable details. Seasons help organize product collections by time periods, and they can be identified by a unique id (e.g., \"W24\" for Winter 2024).

\n","_postman_id":"8cfcc860-72e5-417b-bc23-5eec0b9ce612","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Stock sale v2 (Sale periods)","item":[{"name":"StockSaleV2","event":[{"listen":"test","script":{"id":"696cf22f-319b-477b-aff4-0256ee1caf37","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"3ff32eb6-9215-4866-a35f-ec2cbcaa281d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/stock_sale_v2","description":"

This endpoint fetches all sale periods, when using the \"date\" parameter, you will only fetch the relevant discount periods for that date.

Be careful however, there are 2 ways of managing sales in the SoftTouch environment. One of which is defined on product level (\"sales_\" fields in the product call), the other is the one we're talking about with this API call: sale periods.

Used parameters:

date
\n
display (full)
\n
take
\n
skip
\n

A brief explanation of return values:

id: The unique ID of the sale period
\n
description: A short description to describe the sale period
\n
barcode_activate: Not yet implemented
\n
sales_type: The type of sale being used for this sale period (more information below)
\n
sales_settings: The settings for a specific sales type (more information below per sales type)
\n
sales_counter_options: The setting which defines what articles count for a specific sale type (more information below per sales type)
\n
from_date: The start date of the sale period (this date is inclusive)
\n
to_date: The end date of the sale period (this date is also inclusive)
\n
percentage: The percentage in effect for this sale period
\n
price: The price in effect for this sales period (this overrules percentage)
\n
product_id: Not yet implemented
\n
product_id2: Not yet implemented
\n
discount_type: The discount type barcode that will be used for this sale period
\n
store: The stores (comma separated) in which this sale period is applied, % meaning all stores
\n
season: The seasons (comma separated) in which the sale period is applied, % meaning all seasons
\n
brand: The brands (comma separated) for which the sale period is applies, % meaning all brands
\n
brand2: Not yet implemented
\n
category1-7: The categories (comma separated, per group) for which the sale period is applied, % meaning all categories of that group
\n
color: The colors (comma separated) for which the sale period is applies, % meaning all colors
\n
online: Tells you if the sale period is to be applied for a certain online environment
\n
Priority: The priority in which the sale period takes effect. If a sale period has priority 1, it will always be active over a sale period with priority 12 for example, the lower the number, the higher the priority. In case of overlapping priority, the best matching sale period should be applied.
\n

You may already know from the product call or the receipt call that the API features a lot of functionality regarding sales. Sales on product level, or sale periods with type 55000 are supported by default, both are processed in the product call (with the \"discount_\" fields) and in the receipt call (when not giving any parameter related to price).

However, there are some more sale period types that are not supported by these calls, below we will go over all sale types and which parameters are relevant for each of them.

Before going any further, it is important to know that for the below described sales types, manual action is required. This means that the receipt call and product call will never change logic based on the below sales types.
This also means that you, the developer, will have to manually change prices in the receipt/reservation calls you are making.

Not only do you have to manually put put the correct discount (or price_to_pay) in the item payload of the receipt / reservation call, but you'll also have to add the discount_type_id parameter to your item payload when you are applying a sales type listed below to that item.
If the \"discount_type_id\" is 0, you do not apply the \"discount_type_id\" parameter in the receipt / reservation call.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

sales type	Rules / description
55000 - Sales	This is the basic sale period type, the simplest of all, any article that has this sale type applied will get the percentage or price discount applied. (Automatically applied in product call \"discount_\" fields, as well as in the receipt call calculations.)
55001 - Tying	Articles included in this sales type should get a discount only when purchasing other articles. Here the following fields are important: - sales_settings: The number of articles required purchase in order for the sale to apply, in our example, 2 articles need to be purchased before 30 % discount can be given (on articles that have the required conditions (the conditions in the example being season = 999 and brand = 005 or 003)). - sales_counter_options: This will define which articles should be counted to hit the condition (in our example the condition being, buy 2 articles to trigger the discount). This will always be one of the following: 1: The easiest option: all articles count. 2: Only articles that have a discount or are part of tying count. This means that any article that does not have any discount on it and also is not part of any sales period using any sale type, will not be counted for the requirement of buying 2 articles (in our example) 3: Only articles that are in tying count. This means that articles with regular discount are excluded from the count, only articles that fall under tying conditions should be counted for the requirement of buying 2 articles (in our example)
55002 - Scale discounts	This sale type is basically the same as 55001 (tying), with the exception that the discount can increase (or technically also decrease) with the amount of articles bought. With tying, you can only define x amount of articles before Y percentage discount is applied to those articles. With scale discounts, you can apply a different percentage the more you buy, in our example: buying 1 piece = 0%, buying 2 pieces = 20%, buying 3 pieces = 30% and buying 4 or 5 pieces (or more) will give you 50%. This means that the \"sales_counter_options\" value is also the same as with the sale type 55001 (tying), however \"sales_settings\" changes a little bit. It will now have the values semicolumn separated. \"0;20;30;50;50\" is our example, and the impact of these values are described above.
55003 - Buy X, get Y for free	When using this sale type, the following fields are important: - sales_settings: 2 semicolumn separated values, the first value is the amount of articles that need to be bought in order to trigger the requirement, the 2nd value is the amount of articles you get for free when buying this amount of articles. in our example you will see \"2;1\", meaning you buy 2, you get 1 for free. - sales_counter_options: 1, 2 or 3, these are the same as described in the Tying section (55001), this has impact on which articles get counted for the requirement. A couple of tips / guidelines for this sale type specifically: - Our current way of handeling this sale type is by giving the article with the lowest value of the 3 articles for free. meaning that if article A costs 100 EUR, article B is also 100 EUR, but article C is 50 EUR, article C will be the free one. You are free to discuss with the client how they want to handle this of course, as they may also choose to divide the discount over all 3 articles (meaning 33% discount per article in our example). - Remember that when you're making receipts, customer card can be calculated depending on how your environment is set up. However, by default you should use the parameter \"on_customer_card\" (value \"false\" of course) on the item payload of the 2 articles that are part of the action, but don't get the discount. The article that will get the 100% discount does not need this parameter as articles that have a discount don't count for the customer card anyway. - There is an exception to the rule above: discount_type_id. When using discount_type_id, you do not put the \"on_customer_card\", but instead just add the \"discount_type_id\" parameter. This is because discount_types can change wether an article with discount has to go on the customer card or not. - BE CAREFUL WHEN DEALING WITH QUANTITY > 1! If you're applying a 100% discount in a receipt item where the quantity is 2, you are essentially giving away 2 articles for free, which (unless the requirement hits twice) is not how it should work. In this case you should apply a 50% discount on the line with quantity 2 (if this is the line you need to apply the sale on to begin with).
55004 - Tying (Ignore article sales)	This is basically the same as tying, with one big caveat. The discount percentage is the sales_percentage defined on product level, this means that any article that fulfills the requirements to be part of this sale type should NOT get the discount by default, but should instead get it only when the tying condition has been fulfilled. The sales_counter_options and sales_settings values have the same impact as sale type 55001 (tying), so please consult above for more information if you haven't already.

sometimes|required|date

\n","type":"text/plain"},"key":"date","value":""}],"variable":[]}},"response":[{"id":"870463d1-a7a6-4393-8363-57c069fd45da","name":"StockSaleV2","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/stock_sale_v2","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","stock_sale_v2"],"query":[{"key":"display","value":"full","disabled":true},{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true},{"key":"date","value":"","description":"sometimes|required|date","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"description\": \"Buy X get Y for free\",\n \"barcode_activate\": \"\",\n \"sales_type\": \"55003\",\n \"sales_settings\": \"2;1\",\n \"sales_counter_options\": 1,\n \"from_date\": \"2024-11-01\",\n \"to_date\": \"2024-11-30\",\n \"percenatage\": 0,\n \"percentage\": 0,\n \"price\": 0,\n \"product_id\": 0,\n \"product_id2\": 0,\n \"discount_type\": 0,\n \"store\": \"%\",\n \"season\": \"%\",\n \"brand\": \",006,001\",\n \"brand2\": \"%\",\n \"category1\": \"%\",\n \"category2\": \"%\",\n \"category3\": \"%\",\n \"category4\": \"%\",\n \"category5\": \"%\",\n \"category6\": \"%\",\n \"category7\": \"%\",\n \"color\": \"%\",\n \"online\": true,\n \"online2\": true,\n \"online3\": true,\n \"online4\": true,\n \"online5\": true\n },\n {\n \"id\": 2,\n \"description\": \"Tying\",\n \"barcode_activate\": \"\",\n \"sales_type\": \"55001\",\n \"sales_settings\": \"2\",\n \"sales_counter_options\": 1,\n \"from_date\": \"2024-12-01\",\n \"to_date\": \"2024-12-15\",\n \"percenatage\": 30,\n \"percentage\": 30,\n \"price\": 0,\n \"product_id\": 0,\n \"product_id2\": 0,\n \"discount_type\": 0,\n \"store\": \"%\",\n \"season\": \",999\",\n \"brand\": \",005,003\",\n \"brand2\": \"%\",\n \"category1\": \"%\",\n \"category2\": \"%\",\n \"category3\": \"%\",\n \"category4\": \"%\",\n \"category5\": \"%\",\n \"category6\": \"%\",\n \"category7\": \"%\",\n \"color\": \"%\",\n \"online\": true,\n \"online2\": true,\n \"online3\": true,\n \"online4\": true,\n \"online5\": true\n }\n]"}],"_postman_id":"3ff32eb6-9215-4866-a35f-ec2cbcaa281d"}],"id":"cd948d6a-947f-4401-9730-608bd3907c6d","_postman_id":"cd948d6a-947f-4401-9730-608bd3907c6d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Stores","item":[{"name":"Stores","event":[{"listen":"test","script":{"id":"51e17512-c3c0-4f77-9aa7-9873bb3196af","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"8de4d7e6-c9e2-4d68-b4a9-362cefbbc28e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/stores?display=full","description":"

This endpoint fetches all stores.
It provides essential information like such as the store name, identifier and the active status.

Used parameters:

display (full)
\n
take
\n
skip
\n

A brief explanation of return values:

key: The unique identifier
\n
txt: The brand name
\n
sort: The sort order of the store, which determines the sequence in which stores are displayed
\n
active: A status indicator where \"T\" represents an active store and \"F\" an inactive store.
\n

When display=full is used, additional detailed information will be included:

customer_card_group: Customer group assigned to the store, if applicable
\n
corporation_id: Corporation identifier associated with the store.
\n
gln: Global Location Number (GLN) for the store, if available.
\n
surface: Surface area of the stroe (e.g., square meters).
\n
rent: Rent amount or cost associated with the store.
\n
value1-2: Customizable fields for additional data.
\n
status1-2: Status field for additional categorization, as needed.
\n
region: Region or area where the store is located.
\n
shipping_name: Name used for shipping to the store.
\n
shipping_company: Shipping company associated with the store.
\n
shipping_street_name: Street name for the store's shipping address.
\n
shipping_street_number: Stret number for the store's shipping address.
\n
shipping_zip: ZIP code for the shpiing address.
\n
shipping_city: City for the shipping address.
\n
shipping_country_iso: ISO country code for the shipping address.
\n
shipping_email: Email address used for the shipping related contact.
\n
shipping_phone: Phone number for the shipping-related contact.
\n
must_use_transfer_code: Boolean indicating if a tranfer code must be used.
\n

The stores endpoint provides access to all stores, encompassing both physical locations (like retail outlets or warehouses) and virtual or online stores. Each store entry serves as a distinct operational unit within the business and includes identifiers, names, and statuses for easy organization and tracking.

\n","_postman_id":"9946b955-bfd9-49ba-85cf-d600c9371429","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Sizetables todo","item":[{"name":"Sizetables","event":[{"listen":"test","script":{"id":"138005f0-85a9-4748-9710-f4398c8454f9","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"2e75ac65-a3d1-46a3-8caa-7db8bef2aaf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/sizetables","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
\n
take
\n
skip
\n

A brief explanation of return values:

key: The unique identifier
\n
name: The brand name
\n
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
\n
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.
\n

If display full is used some extra info is availble like the address and contact information.

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

required

\n","type":"text/plain"},"key":"txt","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"active","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"priority","value":null},{"disabled":true,"description":{"content":"

required|array|max:99

\n","type":"text/plain"},"key":"sizeX","value":null},{"disabled":true,"description":{"content":"

array|max:99

\n","type":"text/plain"},"key":"sizeY","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"size:id","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"size:txt","value":null}],"variable":[]}},"response":[],"_postman_id":"953e4db3-000f-41be-b53a-84cb7bafc8d2"},{"name":"Sizetables/bulk_insert","event":[{"listen":"test","script":{"id":"cbd5148c-9a70-4b1c-a9fc-dfba57d8789f","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"c656bc96-1219-4285-a1d4-4f12b4b0a2cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"sizetables\": [\r\n {\r\n \"txt\": \"S-M-L / 0-1 (1)\",\r\n \"active\": 1,\r\n \"priority\": 1,\r\n \"sizeX\": [\r\n {\r\n \"id\": 1,\r\n \"txt\": \"S\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"txt\": \"M\"\r\n },\r\n {\r\n \"id\": 3,\r\n \"txt\": \"L\"\r\n }\r\n ],\r\n \"sizeY\": [\r\n {\r\n \"id\": 1,\r\n \"txt\": \"0\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"txt\": \"1\"\r\n }\r\n ]\r\n },\r\n {\r\n \"txt\": \"S-M-L / 0-1 (2)\",\r\n \"active\": 1,\r\n \"priority\": 1,\r\n \"sizeX\": [\r\n {\r\n \"id\": 1,\r\n \"txt\": \"S\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"txt\": \"M\"\r\n },\r\n {\r\n \"id\": 3,\r\n \"txt\": \"L\"\r\n }\r\n ],\r\n \"sizeY\": [\r\n {\r\n \"id\": 1,\r\n \"txt\": \"0\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"txt\": \"1\"\r\n }\r\n ]\r\n },\r\n {\r\n \"txt\": \"S-M-L / 0-1 (3)\",\r\n \"active\": 1,\r\n \"priority\": 1,\r\n \"sizeX\": [\r\n {\r\n \"id\": 1,\r\n \"txt\": \"S\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"txt\": \"M\"\r\n },\r\n {\r\n \"id\": 3,\r\n \"txt\": \"L\"\r\n }\r\n ],\r\n \"sizeY\": [\r\n {\r\n \"id\": 1,\r\n \"txt\": \"0\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"txt\": \"1\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/sizetables?sizetables","description":"

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

required|array|max:500

\n","type":"text/plain"},"key":"sizetables","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"sizetables:txt","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"sizetables:active","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"sizetables:priority","value":null},{"disabled":true,"description":{"content":"

required|array|max:99

\n","type":"text/plain"},"key":"sizetables:sizeX","value":null},{"disabled":true,"description":{"content":"

array|max:99

\n","type":"text/plain"},"key":"sizetables:sizeY","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"sizetables:size:id","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"sizetables:size:txt","value":null}],"variable":[]}},"response":[],"_postman_id":"c656bc96-1219-4285-a1d4-4f12b4b0a2cb"},{"name":"Sizetables","event":[{"listen":"test","script":{"id":"6d47acf7-86cf-4087-b85a-38ce0582ea44","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"8ddf3e6f-c482-4c04-b7d0-4877cf95136b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"txt\": \"S-M-L / 0-1\",\r\n \"active\": 1,\r\n \"priority\": 1,\r\n \"sizeX\": [\r\n {\r\n \"id\": 1,\r\n \"txt\": \"S\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"txt\": \"M\"\r\n },\r\n {\r\n \"id\": 3,\r\n \"txt\": \"L\"\r\n }\r\n ],\r\n \"sizeY\": [\r\n {\r\n \"id\": 1,\r\n \"txt\": \"0\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"txt\": \"1\"\r\n }\r\n ]\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/sizetables/48","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","sizetables","48"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"key":"txt","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"active","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"priority","value":null},{"disabled":true,"description":{"content":"

array|max:99

\n","type":"text/plain"},"key":"sizeX","value":null},{"disabled":true,"description":{"content":"

array|max:99

\n","type":"text/plain"},"key":"sizeY","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"size:id","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"size:txt","value":null}],"variable":[]}},"response":[],"_postman_id":"8ddf3e6f-c482-4c04-b7d0-4877cf95136b"},{"name":"Sizetables","event":[{"listen":"test","script":{"id":"e3bacbe5-5cd5-439d-b0a7-1b5f5cf5db55","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"9e34b68b-a34f-4450-9018-d542e7aa58fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/sizetables/12","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","sizetables","12"],"host":["api","softtouch","eu"],"query":[],"variable":[]}},"response":[],"_postman_id":"9e34b68b-a34f-4450-9018-d542e7aa58fd"}],"id":"e155dfde-feb0-482a-866a-fac53cfd4a46","_postman_id":"e155dfde-feb0-482a-866a-fac53cfd4a46","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Transfer todo","item":[{"name":"Transfer","event":[{"listen":"test","script":{"id":"ecbcf8d5-533c-4158-aaba-c01c325cbdcc","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"52698562-1b74-4ac4-9804-f6fbeb3dddba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/transfer","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

required|alpha_num|different:to_store_id|size:2

\n","type":"text/plain"},"key":"from_store_id","value":null},{"disabled":true,"description":{"content":"

required|alpha_num|different:from_store_id|size:2

\n","type":"text/plain"},"key":"to_store_id","value":null},{"disabled":true,"description":{"content":"

max:50

\n","type":"text/plain"},"key":"remark","value":null},{"disabled":true,"description":{"content":"

alpha_num|size:4

\n","type":"text/plain"},"key":"pos_id","value":null},{"disabled":true,"description":{"content":"

required|alpha_num|size:4

\n","type":"text/plain"},"key":"user_id","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"customer_id","value":null},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"transfer_request_id","value":null},{"disabled":true,"description":{"content":"

alpha_num|size:3

\n","type":"text/plain"},"key":"history_module","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"print_ticket","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"direct_transfer","value":null},{"disabled":true,"description":{"content":"

integer|required_with:transfer_line

\n","type":"text/plain"},"key":"transfer_id","value":null},{"disabled":true,"description":{"content":"

integer|required_with:transfer_id

\n","type":"text/plain"},"key":"transfer_line","value":null},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"items","value":null},{"disabled":true,"description":{"content":"

required|integer|between:10000000000000,90000000000000

\n","type":"text/plain"},"key":"items:product_uid","value":null},{"disabled":true,"description":{"content":"

integer|between:100000000000,909999999999

\n","type":"text/plain"},"key":"items:unique_product_id","value":null},{"disabled":true,"description":{"content":"

integer|min:1

\n","type":"text/plain"},"key":"items:quantity","value":null},{"disabled":true,"description":{"content":"

max:50

\n","type":"text/plain"},"key":"items:remark","value":null}],"variable":[]}},"response":[],"_postman_id":"4b0be35a-f45d-4682-bea5-4bde4cdd1561"},{"name":"Transfer/receive","event":[{"listen":"test","script":{"id":"c1d5067c-ab56-4555-81d9-6a298c2ea0f5","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"dd520a18-ef3f-4f61-b899-e3d94e6e5457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"to_store_id\": \"02\",\r\n\t\"pos_id\": \"0201\",\r\n\t\"user_id\": \"1001\",\r\n\t\"history_module\": \"API\",\r\n\t\"items\": [\r\n {\r\n \"id\": 1508,\r\n \"quantity\": 1\r\n }\r\n ]\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/transfer/2006000516/receive","description":"

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

required|alpha_num|different:from_store_id|size:2

\n","type":"text/plain"},"key":"to_store_id","value":null},{"disabled":true,"description":{"content":"

alpha_num|size:4

\n","type":"text/plain"},"key":"pos_id","value":null},{"disabled":true,"description":{"content":"

required|alpha_num|size:4

\n","type":"text/plain"},"key":"user_id","value":null},{"disabled":true,"description":{"content":"

alpha_num|size:3

\n","type":"text/plain"},"key":"history_module","value":null},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"items","value":null},{"disabled":true,"description":{"content":"

required|integer

\n","type":"text/plain"},"key":"items:id","value":null},{"disabled":true,"description":{"content":"

integer|min:1

\n","type":"text/plain"},"key":"items:quantity","value":null}],"variable":[]}},"response":[],"_postman_id":"dd520a18-ef3f-4f61-b899-e3d94e6e5457"}],"id":"4bcdd1ff-18de-4a0d-85a0-839e8df2f6f4","_postman_id":"4bcdd1ff-18de-4a0d-85a0-839e8df2f6f4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Transfer requests (In progress, POST done)","item":[{"name":"Transfer_requests","event":[{"listen":"test","script":{"id":"050719a0-635f-42fe-ae5a-2742dac65cc7","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"df7e6d57-6165-44c6-820d-0c35216e42fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/transfer_requests","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

boolean

\n","type":"text/plain"},"key":"with_trashed","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"only_trashed","value":null}],"variable":[]}},"response":[],"_postman_id":"df7e6d57-6165-44c6-820d-0c35216e42fc"},{"name":"Transfer_requests/{{id}}","event":[{"listen":"test","script":{"id":"8c6f7df4-bd4e-4811-9174-b1ca9265ffd2","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"8133cf84-7de7-4674-a63e-b9077ccbe449","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/transfer_requests/7","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

To create a transfer request, this endpoint should be used.
If an article is not available in a specific store/location for shipping OR if article pickup is selected but not all articles are available in the selected store, a transfer request should be made.

Below are the possible parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Requirements	Description
customer_id	integer	If you are asking a transfer for an article for a specific customer, add the customer_id parameter.
from_store_id	required, size: 2	The store you are asking to transfer an article, the article comes from this store, and will be transfered (if possible) to the to_store.
to_store_id	required, size: 2	The store which will RECEIVE the transfer if it can be sent, this is the store who is asking the question to the from_store.
remark	string	A remark field for the transfer request.
user_id	size: 4	The user who is asking the question, the default is always decided by the API in case you do not add this parameter. (Which under normal circumstances you won't)
transfer_id	integer, between:1000000000,9999999999	Usually this parameter will not be added when creating a transfer request, since this is mostly for when you handle the transfer request. When a transfer request is handled, a transfer_id will be added if applicable.
reservation_id	integer, between:999100000,999199999	If you're creating a transfer request for a specific reservation, add the reservation_id here. This is highly recommended when the customer uses the SoftTouch web module (order follow up).
receipt_id	integer	If you're creating a transfer request for a specific receipt, add the receipt_id here. This is highly recommended when the customer uses the SoftTouch web module (order follow up).
items	required, array	A list of the items you are requesting to be transferred.
items:product_uid	required, integer, between: 10000000000000,89999999999999	The product_uid has to be the full 14 character product_id, the last 2 characters should be the from_store_id.
items:remark	string	A remark on item level specifically.

You can also send a notification to the MyFasMan Mobile app by using the V2/app_notification endpoint (by using the id you get from the response of this request).

integer

\n","type":"text/plain"},"key":"customer_id","value":""},{"disabled":true,"description":{"content":"

required|size:2

\n","type":"text/plain"},"key":"from_store_id","value":""},{"disabled":true,"description":{"content":"

required|size:2

\n","type":"text/plain"},"key":"to_store_id","value":""},{"disabled":true,"key":"remark","value":""},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"user_id","value":""},{"disabled":true,"description":{"content":"

integer|between:1000000000,9999999999

\n","type":"text/plain"},"key":"transfer_id","value":""},{"disabled":true,"description":{"content":"

integer|between:999100000,999199999

\n","type":"text/plain"},"key":"reservation_id","value":""},{"disabled":true,"description":{"content":"

integer

\n","type":"text/plain"},"key":"receipt_id","value":null},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"items","value":""},{"disabled":true,"description":{"content":"

required|integer|between:10000000000000,89999999999999

\n","type":"text/plain"},"key":"items:product_uid","value":""},{"disabled":true,"key":"items:remark","value":""}],"variable":[]}},"response":[{"id":"5416b1ea-47d8-4e37-9f81-a05d05065a98","name":"Transfer_requests","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": \"5\",\r\n \"from_store_id\": \"02\",\r\n \"to_store_id\": \"01\",\r\n \"remark\": \"This is a remark.\",\r\n \"user_id\": \"1001\",\r\n \"items\": [\r\n {\r\n \"product_uid\": 10000301040102,\r\n \"remark\": \"This is the remark for the item.\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.softtouch.eu/1/accounts/{{accountId}}/transfer_requests","protocol":"https","host":["api","softtouch","eu"],"path":["1","accounts","{{accountId}}","transfer_requests"],"query":[{"key":"customer_id","value":null,"description":"integer","type":"text","disabled":true},{"key":"from_store_id","value":null,"description":"required|size:2","type":"text","disabled":true},{"key":"to_store_id","value":null,"description":"required|size:2","type":"text","disabled":true},{"key":"remark","value":null,"type":"text","disabled":true},{"key":"user_id","value":null,"description":"size:4","type":"text","disabled":true},{"key":"transfer_id","value":null,"description":"integer|between:1000000000,9999999999","type":"text","disabled":true},{"key":"reservation_id","value":null,"description":"integer|between:999100000,999199999","type":"text","disabled":true},{"key":"items","value":null,"description":"required|array","type":"text","disabled":true},{"key":"items:product_uid","value":null,"description":"required|integer|between:10000000000000,89999999999999","type":"text","disabled":true},{"key":"items:remark","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 12 Dec 2024 09:46:57 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6InFLa1VTNjE2TEdBazNUQlc0Q2JyWUE9PSIsInZhbHVlIjoib256eU85R1JhaW13OENSMkxHb0VISWpMK1pwTXZOb2lkNmZ2YUh5cmJ5bUl3OE5YUEYrdWowN2E1bnRxXC9LTkkwYStpSHIzR0ljTStYSXlQUk9xeGFnPT0iLCJtYWMiOiIxNTU1NjQzYTQyMTc5ZThhYjhiODJjMGQxOGZhMjIxNjYzOTkwMmZiNjFjYjc5MjVlZjRmNjZmNWRkMjZmYzNlIn0%3D; expires=Thu, 12-Dec-2024 11:46:57 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"customer_id\": 5,\n \"from_store_id\": \"02\",\n \"to_store_id\": \"01\",\n \"remark\": \"This is a remark.\",\n \"status\": \"24000\",\n \"transfer_id\": 0,\n \"reservation_id\": 0,\n \"items\": [\n {\n \"id\": 4,\n \"line\": 1,\n \"product_uid\": 10000301040102,\n \"remark\": \"This is the remark for the item.\",\n \"status\": \"25000\",\n \"customer_order_status\": null\n }\n ]\n}"}],"_postman_id":"a1294144-b50c-4ec6-a505-de8cb9f10a31"},{"name":"Transfer_requests","event":[{"listen":"test","script":{"id":"8b761cd3-bb09-4f9c-8188-993d3bd2fa4e","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"8ca63008-790f-41ff-b4ac-8371c35414f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"status\": \"00000\",\r\n\t\"user_id\": \"1001\",\r\n\t\"transfer_id\": 2006000516,\r\n \"reservation_id\": 999100002,\r\n\t\"items\": [\r\n {\r\n \"id\": 9,\r\n \"line\": 1,\r\n \"status\": \"00000\"\r\n }\r\n ]\r\n}"},"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/transfer_requests/7","description":"

Store new color.

size:5

\n","type":"text/plain"},"key":"status","value":null},{"disabled":true,"description":{"content":"

size:4

\n","type":"text/plain"},"key":"user_id","value":null},{"disabled":true,"description":{"content":"

integer|between:1000000000,9999999999

\n","type":"text/plain"},"key":"transfer_id","value":null},{"disabled":true,"description":{"content":"

integer|between:999100000,999199999

\n","type":"text/plain"},"key":"reservation_id","value":null},{"disabled":true,"description":{"content":"

required|array

\n","type":"text/plain"},"key":"items","value":null},{"disabled":true,"description":{"content":"

OnlyUsedWithOtherFields:line,|integer

\n","type":"text/plain"},"key":"items:id","value":null},{"disabled":true,"description":{"content":"

OnlyUsedWithOtherFields:id,|integer

\n","type":"text/plain"},"key":"items:line","value":null},{"disabled":true,"description":{"content":"

required|size:5

\n","type":"text/plain"},"key":"items:status","value":null}],"variable":[]}},"response":[],"_postman_id":"8ca63008-790f-41ff-b4ac-8371c35414f7"},{"name":"Transfer_requests","event":[{"listen":"test","script":{"id":"a8368e64-c3e9-4ff5-83d2-64e994909697","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"8e1c6c03-b9a3-45f0-a25b-de1201767b89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"https://api.softtouch.eu/1/accounts/{{accountId}}/transfer_requests/7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["1","accounts","{{accountId}}","transfer_requests","7"],"host":["api","softtouch","eu"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e1c6c03-b9a3-45f0-a25b-de1201767b89"}],"id":"c4fae15f-c4a3-4dfe-a9fb-6dd05818bcfa","_postman_id":"c4fae15f-c4a3-4dfe-a9fb-6dd05818bcfa","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}}],"id":"48ffa010-5fc0-4e6c-815a-b81d913396b5","description":"

Version 1 of the API is the most complete of our 2 versions.
Even though we are creating a version 2, this is a long process that will take a lot of time, we do plan on continuing to support version 1 of the API for a long time still so there is no need to specifically adopt version 2 calls just yet.

This might be a good moment to show how each URL is built in our API:

api.softtouch.eu/{{apiVersion}}/accounts/{{accountId}}/{{endpoint}}

\n","_postman_id":"48ffa010-5fc0-4e6c-815a-b81d913396b5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"V2","item":[{"name":"App_notification","item":[{"name":"App_notification","event":[{"listen":"test","script":{"id":"59541068-b2d4-4f09-b3fa-0289268fe021","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"2b4adbd9-d226-4b0f-b8c0-0e14bc26b0b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"webshop\",\r\n \"data\": \"99100644\",\r\n \"title\": \"Test notification To all store 01 users.\",\r\n \"body\": \"Only to store 01\",\r\n \"store_id\": \"01\"\r\n}"},"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/app_notification","description":"

Create App Notification

This endpoint is used to send app (MyFasMan Mobile) notifications to specific accounts.

For context, this application is one that can do many things, handle transfers, make inventory, consult articles and much more. One of its features is handling webshop orders or transfer requests.

Here's where this call can come in use, depending on the wishes of the customer, you can send a notification to the application by using this call, every time there is a webshop order or every time a transfer is requested for an order.

Request Body

action (string) - The action to be performed.
\n
data (string) - The data related to the action.
\n
title (string) - The title of the notification.
\n
body (string) - The body content of the notification.
\n
store_id (string) - The ID of the store you want to send a notification to.
\n
pos_id (string) - The ID of the POS you want to send a notification to.
\n

Either store_id or pos_id should always be used, if not, you will send a notification to ALL devices.

As mentioned above, there are 2 types of notifications you may use:

action = webshop
\n
action = transfer_request
\n

If you put action to webshop, the data parameter should be the reservation id or the receipt id.
If you put the action to transfer_request, the data has to be the id of the transfer request.

For the latter (transfer_request) you do need to make a full barcode of the id. This means adding the id to 9981000000000, be aware that you need to leave 1 character open at the end...

So the formula would be: 9981000000000 + (id * 10)
The checksum of the barcode being incorrect does not matter, the API will take care of this.

Response

In the response you will get 3 objects: firebase, firebaseV1 and expo. These are the 3 services we use to send out notifications to the devices.

There's not much you can do if an error comes from these services, you can contact us if errors occur, but some errors are just because devices have been disconnected, if you're getting an \"Requested entity was not found.\" error, you can safely ignore it.

required

\n","type":"text/plain"},"key":"action","value":""},{"disabled":true,"description":{"content":"

sometimes|required

\n","type":"text/plain"},"key":"data","value":""},{"disabled":true,"description":{"content":"

sometimes|required|string

\n","type":"text/plain"},"key":"store_id","value":""},{"disabled":true,"description":{"content":"

sometimes|required|string

\n","type":"text/plain"},"key":"pos_id","value":""},{"disabled":true,"description":{"content":"

sometimes|required|string

\n","type":"text/plain"},"key":"title","value":""},{"disabled":true,"description":{"content":"

sometimes|required|string

\n","type":"text/plain"},"key":"body","value":""}],"variable":[]}},"response":[{"id":"794f7a77-f677-4ef7-b61f-095d92034910","name":"App_notification","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"{{token}}","type":"default","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"webshop\",\r\n \"data\": \"99100644\",\r\n \"title\": \"Test To all DemoWWW users.\",\r\n \"body\": \"Only to store 01\",\r\n \"store_id\": \"01\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.softtouch.eu/2/accounts/{{accountId}}/app_notification","protocol":"https","host":["api","softtouch","eu"],"path":["2","accounts","{{accountId}}","app_notification"],"query":[{"key":"action","value":"","description":"required","type":"text","disabled":true},{"key":"data","value":"","description":"sometimes|required","type":"text","disabled":true},{"key":"store_id","value":"","description":"sometimes|required|string","type":"text","disabled":true},{"key":"pos_id","value":"","description":"sometimes|required|string","type":"text","disabled":true},{"key":"title","value":"","description":"sometimes|required|string","type":"text","disabled":true},{"key":"body","value":"","description":"sometimes|required|string","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"firebase\": {\n \"message\": \"No notifications to send.\"\n },\n \"firebaseV1\": [\n {\n \"name\": \"projects/myfasman-mobile-v2/messages/0:1730101070523015%3fb82b963fb82b96\"\n },\n {\n \"name\": \"projects/myfasman-mobile-v2/messages/0:1730101070983598%3fb82b963fb82b96\"\n },\n {\n \"error\": {\n \"code\": 404,\n \"message\": \"Requested entity was not found.\",\n \"status\": \"NOT_FOUND\",\n \"details\": [\n {\n \"@type\": \"type.googleapis.com/google.firebase.fcm.v1.FcmError\",\n \"errorCode\": \"UNREGISTERED\"\n }\n ]\n }\n },\n {\n \"name\": \"projects/myfasman-mobile-v2/messages/0:1730101071279124%3fb82b963fb82b96\"\n },\n {\n \"error\": {\n \"code\": 404,\n \"message\": \"Requested entity was not found.\",\n \"status\": \"NOT_FOUND\",\n \"details\": [\n {\n \"@type\": \"type.googleapis.com/google.firebase.fcm.v1.FcmError\",\n \"errorCode\": \"UNREGISTERED\"\n }\n ]\n }\n },\n {\n \"name\": \"projects/myfasman-mobile-v2/messages/0:1730101071558893%3fb82b963fb82b96\"\n },\n {\n \"name\": \"projects/myfasman-mobile-v2/messages/0:1730101071952461%3fb82b963fb82b96\"\n },\n {\n \"name\": \"projects/myfasman-mobile-v2/messages/0:1730101072067258%3fb82b963fb82b96\"\n }\n ],\n \"expo\": {\n \"message\": \"No notifications to send.\"\n }\n}"}],"_postman_id":"2b4adbd9-d226-4b0f-b8c0-0e14bc26b0b3"}],"id":"8c30fc23-f1dc-4ad9-a4a2-2c59701273b0","_postman_id":"8c30fc23-f1dc-4ad9-a4a2-2c59701273b0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Article_texts todo","item":[{"name":"Article_texts","event":[{"listen":"test","script":{"id":"e879a839-6197-4686-88d6-7f490c89682e","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"97d4d361-ab49-4bd1-8d27-aa49a478976a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/article_texts","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["2","accounts","{{accountId}}","article_texts"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"key":"take","value":"500"},{"disabled":true,"key":"skip","value":"0"},{"disabled":true,"description":{"content":"

sometimes|required|integer|product_article|CommaSeperated

\n","type":"text/plain"},"key":"article_ids","value":null},{"disabled":true,"description":{"content":"

sometimes|required|integer|product_article_variant|CommaSeperated

\n","type":"text/plain"},"key":"article_variant_ids","value":null},{"disabled":true,"description":{"content":"

sometimes|required|string|article_text_type

\n","type":"text/plain"},"key":"article_text_type_ids","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_1","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_2","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_3","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_4","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_5","value":null}],"variable":[]}},"response":[],"_postman_id":"97d4d361-ab49-4bd1-8d27-aa49a478976a"},{"name":"Article_texts/{{id}}","event":[{"listen":"test","script":{"id":"a907f9a6-5730-4e35-8594-c66338843d74","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"cc330dcf-f163-498e-a138-e214abf52e87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/article_texts/1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["2","accounts","{{accountId}}","article_texts","1"],"host":["api","softtouch","eu"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc330dcf-f163-498e-a138-e214abf52e87"},{"name":"Article_texts","event":[{"listen":"test","script":{"id":"365bdeaf-0071-4447-8f7a-91af4510dd33","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"bc81e119-2432-4bfc-a9e4-8a717d175121","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"article_variant_id\": 12345601,\r\n \"article_text_type_id\": \"01\",\r\n \"text\": \"This is a test.\",\r\n \"visual_order\": 1,\r\n \"is_online_1\": 1,\r\n \"is_online_2\": 0,\r\n \"is_online_3\": 0,\r\n \"is_online_4\": 0,\r\n \"is_online_5\": 0,\r\n \"user_id\": \"1001\"\r\n}"},"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/article_texts","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["2","accounts","{{accountId}}","article_texts"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

empty_with:article_variant_id|required_without:article_variant_id|product_article|product_active

\n","type":"text/plain"},"key":"article_id","value":null},{"disabled":true,"description":{"content":"

empty_with:article_id|required_without:article_id|product_article_variant|product_active

\n","type":"text/plain"},"key":"article_variant_id","value":null},{"disabled":true,"description":{"content":"

required|article_text_type

\n","type":"text/plain"},"key":"article_text_type_id","value":null},{"disabled":true,"description":{"content":"

required|string

\n","type":"text/plain"},"key":"text","value":null},{"disabled":true,"description":{"content":"

sometimes|required|integer

\n","type":"text/plain"},"key":"visual_order","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_1","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_2","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_3","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_4","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_5","value":null},{"disabled":true,"description":{"content":"

required|user|user_active

\n","type":"text/plain"},"key":"user_id","value":null}],"variable":[]}},"response":[],"_postman_id":"bc81e119-2432-4bfc-a9e4-8a717d175121"},{"name":"Article_texts/supplier_data","event":[{"listen":"test","script":{"id":"f71017fd-e41b-4371-b1bd-7148c822afdf","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"35d271fa-9ad1-461e-86d4-2e43071d8bdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"article_variant_id\": 25007501,\r\n \"article_text_type_id\": \"01\",\r\n \"article_extra_text_type_id\": \"02\",\r\n \"article_eans\": [\r\n 4060938382995,\r\n 4060938383008,\r\n 4060938383015,\r\n 4060938383022,\r\n 4060938383039\r\n ],\r\n \"online_number\": 1,\r\n \"user_id\": \"1001\",\r\n \"language\": \"en\"\r\n}"},"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/article_text/supplier_data","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["2","accounts","{{accountId}}","article_text","supplier_data"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

empty_with:article_variant_id|required_without:article_variant_id|product_article|product_active|product_has_brand

\n","type":"text/plain"},"key":"article_id","value":null},{"disabled":true,"description":{"content":"

empty_with:article_id|required_without:article_id|product_article_variant|product_active|product_has_brand

\n","type":"text/plain"},"key":"article_variant_id","value":null},{"disabled":true,"description":{"content":"

required|article_text_type

\n","type":"text/plain"},"key":"article_file_text_id","value":null},{"disabled":true,"description":{"content":"

sometimes|required|article_text_type

\n","type":"text/plain"},"key":"article_extra_text_type_id","value":null},{"disabled":true,"description":{"content":"

required|array|integer|between:1000000000,9999999999999

\n","type":"text/plain"},"key":"article_eans","value":null},{"disabled":true,"description":{"content":"

sometimes|required|integer|between:1,5

\n","type":"text/plain"},"key":"online_number","value":null},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"user_id","value":null},{"disabled":true,"description":{"content":"

sometimes|required|in:nl,fr,en

\n","type":"text/plain"},"key":"language","value":null}],"variable":[]}},"response":[],"_postman_id":"35d271fa-9ad1-461e-86d4-2e43071d8bdf"},{"name":"Article_texts","event":[{"listen":"test","script":{"id":"7e12c741-c095-46d2-9bfe-c0ce3c1efaa5","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"e0a8a1e9-440f-4bb3-a688-224806257f86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"text\": \"This is a test.\",\r\n \"visual_order\": 1,\r\n \"is_online_1\": 1,\r\n \"is_online_2\": 0,\r\n \"is_online_3\": 0,\r\n \"is_online_4\": 0,\r\n \"is_online_5\": 0,\r\n \"user_id\": \"1001\"\r\n}"},"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/article_texts/1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["2","accounts","{{accountId}}","article_texts","1"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

required|string

\n","type":"text/plain"},"key":"text","value":null},{"disabled":true,"description":{"content":"

sometimes|required|integer

\n","type":"text/plain"},"key":"visual_order","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_1","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_2","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_3","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_4","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"is_online_5","value":null},{"disabled":true,"description":{"content":"

required|user|user_active

\n","type":"text/plain"},"key":"user_id","value":null}],"variable":[]}},"response":[],"_postman_id":"e0a8a1e9-440f-4bb3-a688-224806257f86"},{"name":"Article_texts","event":[{"listen":"test","script":{"id":"3b369ad8-9c1d-40fb-8957-8e2a95c78289","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"f1c072b5-dbef-4e1c-8da2-a276dba9f418","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/article_texts/1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["2","accounts","{{accountId}}","article_texts","1"],"host":["api","softtouch","eu"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1c072b5-dbef-4e1c-8da2-a276dba9f418"}],"id":"817a159f-6622-47ff-b102-836c6373b675","_postman_id":"817a159f-6622-47ff-b102-836c6373b675","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Brand_attribute_values todo","item":[{"name":"Brand_attribute_values","event":[{"listen":"test","script":{"id":"302348eb-5cc4-47e6-9b17-681946c454ab","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"3035089c-529b-43d3-8f16-4baa10858409","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"{{url}}/2/accounts/{{accountId}}/brand_attribute_values","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

sometimes|required

\n","type":"text/plain"},"key":"attribute_id","value":""},{"disabled":true,"description":{"content":"

sometimes|required|CommaSeperated

\n","type":"text/plain"},"key":"attribute_ids","value":null}],"variable":[]}},"response":[],"_postman_id":"3035089c-529b-43d3-8f16-4baa10858409"}],"id":"5d43cd05-f225-46f8-96b8-6a4c1b12715c","_postman_id":"5d43cd05-f225-46f8-96b8-6a4c1b12715c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Gift_list_headers","item":[{"name":"Gift_list_headers","event":[{"listen":"test","script":{"id":"f884e651-5128-4612-aab1-170f5434f117","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"db67f771-8e25-4e60-9bcc-e9be5b037e68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/gift_list_headers?select=*,gift_list_items.*","description":"

This endpoint fetches all gift lists with a maximum amount of 500 gift lists per call.

Warning for all giftlist related endpoints:
Please note that the giftlist module can be very different per client. This module is usually customised a lot for each client individually, which makes it hard to make 100% accurate documentation for every client...
We have tried to make a \"default\" usage, anything mentioned in this documentation is by the rules of this default.

Used parameters:

take
\n
skip
\n
customer_ids (comma seperated)
\n
store_ids (comma seperated)
\n
status_ids (comma seperated)
\n
is_online (boolean)
\n

Possible extra data visible by using the \"select\" parameter:

gift_list_items.*
\n
store.*
\n
customer.*
\n
status.*
\n
created_by_user.*
\n
updated_by_user.*
\n

A brief explanation of return values:

(Most fields are already explained in the V1/giftlists endpoint, please consult there for more information on the fields, below we will map the fields to the V1 fields)

Field	Type	V1 field / Description
id	integer	key
store_id	string (2 characters)	store
customer_id	integer	customer
status_id	string (5 characters)	status
surname	string	surname
address	string	address
postal_code	string	postcode
city	string	city
parent	string	mother
co_parent	string	father
baby	string	baby_name
siblings	string	brothers_sisters
sex	string	sex
miscellaneous	string	free_text
date_1	date	date1
date_2	date	date2
date_3	date	date3
date_4	date	date4
value_1	numeric	value1
value_2	numeric	value2
value_3	numeric	value3
remark	text	remark
is_online	boolean	online
web_user	string	webuser
web_password	string	webpass
created_by_user_id	string (4 characters)	The ID of the user that created the giftlist
updated_by_user_id	string (4 characters)	The ID of the user that most recently updated the giftlist
created_at_date	date	created
updated_at_date	date	modified
gift_list_items.*	array	array of giftlist item objects
store.*	object	object with all information on the store the giftlist is being managed in
customer.*	object	object with all information on the customer that was assigned to the giftlist
status.*	object	object with more information / descriptions about the status assigned to the giftlist
created_by_user.*	object	object with the name and other information of the user that created the giftlist
updated_by_user.*	object	object with the name and other information of the user that most recently updated the giftlist

sometimes|required|customer|CommaSeperated

\n","type":"text/plain"},"key":"customer_ids","value":null},{"disabled":true,"description":{"content":"

sometimes|required|store|CommaSeperated

\n","type":"text/plain"},"key":"store_ids","value":null},{"disabled":true,"description":{"content":"

sometimes|required|gift_list_header_status|CommaSeperated

\n","type":"text/plain"},"key":"status_ids","value":null},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"is_online","value":null},{"key":"select","value":"*,gift_list_items.*"}],"variable":[]}},"response":[{"id":"b81bd00f-39ce-46e1-9c61-225949d74642","name":"Gift_list_headers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/2/accounts/{{accountId}}/gift_list_headers?select=*,gift_list_items.*","protocol":"https","host":["api","softtouch","eu"],"path":["2","accounts","{{accountId}}","gift_list_headers"],"query":[{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true},{"key":"customer_ids","value":null,"description":"sometimes|required|customer|CommaSeperated","type":"text","disabled":true},{"key":"store_ids","value":null,"description":"sometimes|required|store|CommaSeperated","type":"text","disabled":true},{"key":"status_ids","value":null,"description":"sometimes|required|gift_list_header_status|CommaSeperated","type":"text","disabled":true},{"key":"is_online","value":null,"description":"boolean","type":"text","disabled":true},{"key":"select","value":"*,gift_list_items.*"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Thu, 07 Nov 2024 08:22:50 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6InV1V1dWWVJzVllhMVI5aldJTFJDS3c9PSIsInZhbHVlIjoia0hrSjVtVGhOYzFWTXdkbmNwd0tLUzMrQ2NFem41Q3lDZVVOM2QxYUdNOTFyNUdiYzFLQTl6NWJySzhlbVwveldTZTEreFlTTGduUkg2enphTVBtYjVRPT0iLCJtYWMiOiJlMDVhYjAzYWMwOWVhMGFiYTk3ZjQ2MWIxZDBiY2Y3ZjY3YTBiZDU3MGU0ODBjYWU3ZDRiOGIyYTgxMWE3MzYxIn0%3D; expires=Thu, 07-Nov-2024 10:22:50 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"store_id\": \"02\",\n \"customer_id\": 4,\n \"status_id\": \"01000\",\n \"surname\": \"Doe\",\n \"address\": \"Hoofdstraat 123\",\n \"postal_code\": \"1000\",\n \"city\": \"Bruxelles\",\n \"parent\": \"Mother name\",\n \"co_parent\": \"Father name\",\n \"baby\": \"Baby name\",\n \"siblings\": \"Sibling names\",\n \"sex\": \"Sex of the baby\",\n \"miscellaneous\": \"\",\n \"date_1\": \"2024-10-06\",\n \"date_2\": \"2024-09-30\",\n \"date_3\": \"2024-11-30\",\n \"date_4\": \"2024-10-28\",\n \"value_1\": 0,\n \"value_2\": 0,\n \"value_3\": 0,\n \"remark\": null,\n \"is_online\": true,\n \"web_user\": \"johndoe_245@fictional.com\",\n \"web_password\": \"Twh43*sLK\",\n \"created_by_user_id\": \"1001\",\n \"updated_by_user_id\": \"1001\",\n \"created_at_date\": \"2024-10-28\",\n \"updated_at_date\": \"2024-11-07\",\n \"gift_list_items\": [\n {\n \"id\": 1,\n \"gift_list_header_id\": 1,\n \"location_id\": \"01700\",\n \"status_id\": \"01500\",\n \"pickup_by_id\": \"\",\n \"stock_status_id\": \"01800\",\n \"item_id\": 10000301030102,\n \"unique_product_id\": 0,\n \"gift_list_line\": 1,\n \"customer_sold_id\": 9,\n \"receipt_header_sold_id\": 0,\n \"point_of_sale_sold_id\": \"\",\n \"customer_sold_name\": \"\",\n \"description\": \"Heren Kleding SoftTouch\",\n \"date_sold\": \"2024-10-28\",\n \"gross_amount\": 19.95,\n \"discount_amount\": 0,\n \"net_amount\": 19.95,\n \"remark\": null,\n \"is_online\": true,\n \"must_buy\": false,\n \"created_by_user_id\": \"1001\",\n \"updated_by_user_id\": \"1001\",\n \"created_at_date\": \"2024-10-28\",\n \"updated_at_date\": \"2024-10-28\",\n \"updated_at\": \"2024-10-28 14:20:49\",\n \"date_2\": \"2024-10-28\",\n \"date_3\": \"2024-10-28\",\n \"date_4\": \"2024-10-28\"\n }\n ]\n },\n {\n \"id\": 2,\n \"store_id\": \"01\",\n \"customer_id\": 1,\n \"status_id\": \"01000\",\n \"surname\": \"surname\",\n \"address\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"parent\": \"\",\n \"co_parent\": \"\",\n \"baby\": \"\",\n \"siblings\": \"\",\n \"sex\": \"\",\n \"miscellaneous\": \"\",\n \"date_1\": \"0001-01-01\",\n \"date_2\": \"0001-01-01\",\n \"date_3\": \"0001-01-01\",\n \"date_4\": \"0001-01-01\",\n \"value_1\": 0,\n \"value_2\": 0,\n \"value_3\": 0,\n \"remark\": null,\n \"is_online\": true,\n \"web_user\": \"gebruiker@softtouch.be\",\n \"web_password\": \"THISISTHEPASSWORD\",\n \"created_by_user_id\": \"\",\n \"updated_by_user_id\": \"\",\n \"created_at_date\": \"2024-10-31\",\n \"updated_at_date\": \"2024-10-31\",\n \"gift_list_items\": [\n {\n \"id\": 2,\n \"gift_list_header_id\": 2,\n \"location_id\": \"01700\",\n \"status_id\": \"01502\",\n \"pickup_by_id\": \"01601\",\n \"stock_status_id\": \"01802\",\n \"item_id\": 10000301030101,\n \"unique_product_id\": 0,\n \"gift_list_line\": 1,\n \"customer_sold_id\": 9,\n \"receipt_header_sold_id\": 1000000002,\n \"point_of_sale_sold_id\": \"\",\n \"customer_sold_name\": \"Uncle John\",\n \"description\": \"This is a description.\",\n \"date_sold\": \"2024-10-30\",\n \"gross_amount\": 100,\n \"discount_amount\": 25,\n \"net_amount\": 75,\n \"remark\": null,\n \"is_online\": true,\n \"must_buy\": false,\n \"created_by_user_id\": \"\",\n \"updated_by_user_id\": \"1001\",\n \"created_at_date\": \"2024-10-31\",\n \"updated_at_date\": \"2024-11-07\",\n \"updated_at\": \"2024-11-07 08:59:53\",\n \"date_2\": \"2024-10-31\",\n \"date_3\": \"2024-10-31\",\n \"date_4\": \"2024-10-31\"\n }\n ]\n }\n]"}],"_postman_id":"db67f771-8e25-4e60-9bcc-e9be5b037e68"},{"name":"Gift_list_headers/{{id}}","event":[{"listen":"test","script":{"id":"e14095e6-d498-4698-97b9-0c6eff2fbd64","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"3ee072e4-4b4f-45f7-92a4-ef573985928e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/gift_list_headers/1","description":"

This endpoint fetches one specific gift list header.

For more information on the return values, please check the regular GET gift_list_headers endpoint above.

Warning for all giftlist related endpoints:
Please note that the giftlist module can be very different per client. This module is usually customised a lot for each client individually, which makes it hard to make 100% accurate documentation for every client...
We have tried to make a \"default\" usage, anything mentioned in this documentation is by the rules of this default.

\n","_postman_id":"9852ede6-6366-4e26-b053-5e586bfc1b24","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Gift_list_items","item":[{"name":"Gift_list_items","event":[{"listen":"test","script":{"id":"d91d645a-8dc2-4904-89b4-844779e4dc60","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"e7b5a8a8-bd8e-419e-ad1a-8d3b65dd00ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/gift_list_items","description":"

This endpoint fetches all gift list items with a maximum amount of 500 gifts per call.

Warning for all giftlist related endpoints:
Please note that the giftlist module can be very different per client. This module is usually customised a lot for each client individually, which makes it hard to make 100% accurate documentation for every client...
We have tried to make a \"default\" usage, anything mentioned in this documentation is by the rules of this default.

Used parameters:

take
\n
skip
\n
location_ids (comma seperated)
\n
status_ids (comma seperated)
\n
pickup_by_ids (comma seperated)
\n
stock_status_ids (comma seperated)
\n
customer_sold_ids (comma seperated)
\n
receipt_header_sold_ids (comma seperated)
\n
point_of_sale_sold_ids (comma seperated)
\n
is_online (boolean)
\n
must_buy (boolean)
\n

Possible extra data visible by using the \"select\" parameter:

miscellaneous_3 -> miscellaneous_9
\n
status_2_id
\n
status_3_id
\n
pre_deliver
\n
gift_list_header.*
\n
gift_list_header.status.*
\n
gift_list_header.created_by_user.*
\n
gift_list_header.updated_by_user.*
\n
location.*
\n
status.*
\n
status_2.*
\n
status_3.*
\n
pickup_by.*
\n
stock_status.*
\n
product.*
\n
cheque.*
\n
customer_sold.*
\n
receipt_header_sold.*
\n
receipt_header_sold.receipt_items.*
\n
point_of_sale_sold.*
\n
created_by_user.*
\n
updated_by_user.*
\n

A brief explanation of return values:

(Most fields are already explained in the V1/gifts endpoint, please consult there for more information on the fields, below we will map the fields to the V1 fields)

Field	Type	V1 fiield / Description
id	integer	key
gift_list_header_id	integer	The ID of the giftlist this gift belongs to
location_id	string (5 characters)	location
status_id	string (5 characters)	status
pickup_by_id	string (5 characters)	pickupby
stock_status_id	string (5 characters)	stockstatus
item_id	integer	product
unique_product_id	integer	Unique product ids are not used except under very specific circumstances. More information will be given on a need to know basis for this field
gift_list_line	integer	line
customer_sold_id	integer	buyer_id
receipt_header_sold_id	integer	ticket
point_of_sale_sold_id	string (max 4 characters)	The POS ID where the gift was purchased
customer_sold_name	string	buyer_name
description	string	product_desc
date_sold	date	sales_date
gross_amount	numeric	total
discount_amount	numeric	discount
net_amount	numeric	due
remark	string	remark
is_online	boolean	online
must_buy	boolean	mustbuy
created_by_user_id	string (4 characters)	The ID of the user that created this gift
updated_by_user_id	string (4 characters)	The ID of the user that most recently updated the list
created_at_date	date	created
updated_at_date	date	modified
updated_at	timestamp	modified
date_2	date	date2
date_3	date	date3
date_4	date	date4
miscellaneous_3	string	text3
miscellaneous_4	string	text4
miscellaneous_5	string	text5
miscellaneous_6	string	text6
miscellaneous_7	string	text7
miscellaneous_8	string	text8
miscellaneous_9	string	text9
pre_deliver	boolean	pre_deliver
status_2_id	string (5 characters)	status2
status_3_id	string (5 characters)	status3
gift_list_header.*	object	The giftlist object that the gift belongs to
gift_list_header.status.*	object	The status of the giftlist the gift belongs to
gift_list_header.created_by_user.*	object	The user object of the user that created the gift
gift_list_header.updated_by_user.*	object	The user object of the user that most recently updated the gift
location.*	object	An object with more information about the location of the gift
status.*	object	An object with more information about the status of the gift
status_2.*	object	An object with more information about the status 2 of the gift
status_3.*	object	An object with more information about the status 3 of the gift
pickup_by.*	object	An object with more information about who is picking up the gift (after the gift is purchased)
stock_status.*	object	An object with more information about the stock status of the gift
product.*	object	An object with more information about the product that is being gifted
cheque.*	object	An object with the cheque details in case the gift is a cheque
customer_sold.*	object	An object with all information on the customer that purchased the gift
receipt_header_sold.*	object	An object with all information about the receipt header where the gift was purchased
receipt_header_sold.receipt_items.*	array	An array with all articles that were purchased on the receipt where the gift wasa purchased
point_of_sale_sold.*	object	An object with more information about the POS where the gift was purchased
created_by_user.*	object	An object with more information on the user that created the gift
updated_by_user.*	object	An object with more information on the user that most recently updated the gift

sometimes|required|gift_list_item_location|CommaSeperated

\n","type":"text/plain"},"key":"location_ids","value":""},{"disabled":true,"description":{"content":"

sometimes|required|gift_list_item_status|CommaSeperated

\n","type":"text/plain"},"key":"status_ids","value":""},{"disabled":true,"description":{"content":"

sometimes|required|gift_list_item_pickup_by|CommaSeperated

\n","type":"text/plain"},"key":"pickup_by_ids","value":""},{"disabled":true,"description":{"content":"

sometimes|required|gift_list_item_stock_status|CommaSeperated

\n","type":"text/plain"},"key":"stock_status_ids","value":""},{"disabled":true,"description":{"content":"

sometimes|required|customer|CommaSeperated

\n","type":"text/plain"},"key":"customer_sold_ids","value":""},{"disabled":true,"description":{"content":"

sometimes|required|receipt_header|CommaSeperated

\n","type":"text/plain"},"key":"receipt_header_sold_ids","value":""},{"disabled":true,"description":{"content":"

sometimes|required|point_of_sale|CommaSeperated

\n","type":"text/plain"},"key":"point_of_sale_sold_ids","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"is_online","value":""},{"disabled":true,"description":{"content":"

boolean

\n","type":"text/plain"},"key":"must_buy","value":""},{"disabled":true,"key":"select","value":"*"}],"variable":[]}},"response":[{"id":"bb3afbc2-a8c7-4179-bc30-d6ae3c43a5bb","name":"Gift_list_items","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.softtouch.eu/2/accounts/{{accountId}}/gift_list_items?select=*","protocol":"https","host":["api","softtouch","eu"],"path":["2","accounts","{{accountId}}","gift_list_items"],"query":[{"key":"take","value":"500","type":"text","disabled":true},{"key":"skip","value":"0","type":"text","disabled":true},{"key":"location_ids","value":null,"description":"sometimes|required|gift_list_item_location|CommaSeperated","type":"text","disabled":true},{"key":"status_ids","value":null,"description":"sometimes|required|gift_list_item_status|CommaSeperated","type":"text","disabled":true},{"key":"pickup_by_ids","value":null,"description":"sometimes|required|gift_list_item_pickup_by|CommaSeperated","type":"text","disabled":true},{"key":"stock_status_ids","value":null,"description":"sometimes|required|gift_list_item_stock_status|CommaSeperated","type":"text","disabled":true},{"key":"customer_sold_ids","value":null,"description":"sometimes|required|customer|CommaSeperated","type":"text","disabled":true},{"key":"receipt_header_sold_ids","value":null,"description":"sometimes|required|receipt_header|CommaSeperated","type":"text","disabled":true},{"key":"point_of_sale_sold_ids","value":null,"description":"sometimes|required|point_of_sale|CommaSeperated","type":"text","disabled":true},{"key":"is_online","value":null,"description":"boolean","type":"text","disabled":true},{"key":"must_buy","value":null,"description":"boolean","type":"text","disabled":true},{"key":"select","value":"*"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, PATCH, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, Accept, Authorization, X-Request-With"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Fri, 08 Nov 2024 07:20:48 GMT"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlFrM3ZTb2R2eGxmeER5MDFBRXZqbmc9PSIsInZhbHVlIjoiM1BKc0VJc1VoXC94OUdGUHM5NEtqRTdnVmltQnVTTU1kckY3SEMxSUFhdlNmbWFKM2NjZ0hVcEpVMFwvQmViNyt2RVo2WFdXTU43SmxMQ2k3eGJmY0dKUT09IiwibWFjIjoiMjhiMDUyODFlNzVlM2IwNGI1NjA2N2U4N2U1YTY0ZDg2MDRlNzQxMmQ5YzZlOWY0OTM2MGFkZjAyMDFlODAwYSJ9; expires=Fri, 08-Nov-2024 09:20:48 GMT; Max-Age=7200; path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"gift_list_header_id\": 1,\n \"location_id\": \"01700\",\n \"status_id\": \"01500\",\n \"pickup_by_id\": \"\",\n \"stock_status_id\": \"01800\",\n \"item_id\": 10000301030102,\n \"unique_product_id\": 0,\n \"gift_list_line\": 1,\n \"customer_sold_id\": 9,\n \"receipt_header_sold_id\": 0,\n \"point_of_sale_sold_id\": \"\",\n \"customer_sold_name\": \"\",\n \"description\": \"Heren Kleding SoftTouch\",\n \"date_sold\": \"2024-10-28\",\n \"gross_amount\": 19.95,\n \"discount_amount\": 0,\n \"net_amount\": 19.95,\n \"remark\": null,\n \"is_online\": true,\n \"must_buy\": false,\n \"created_by_user_id\": \"1001\",\n \"updated_by_user_id\": \"1001\",\n \"created_at_date\": \"2024-10-28\",\n \"updated_at_date\": \"2024-10-28\",\n \"updated_at\": \"2024-10-28 14:20:49\",\n \"date_2\": \"2024-10-28\",\n \"date_3\": \"2024-10-28\",\n \"date_4\": \"2024-10-28\"\n },\n {\n \"id\": 2,\n \"gift_list_header_id\": 2,\n \"location_id\": \"01700\",\n \"status_id\": \"01502\",\n \"pickup_by_id\": \"01601\",\n \"stock_status_id\": \"01802\",\n \"item_id\": 10000301030101,\n \"unique_product_id\": 0,\n \"gift_list_line\": 1,\n \"customer_sold_id\": 9,\n \"receipt_header_sold_id\": 1000000002,\n \"point_of_sale_sold_id\": \"\",\n \"customer_sold_name\": \"Uncle John\",\n \"description\": \"This is a description.\",\n \"date_sold\": \"2024-10-30\",\n \"gross_amount\": 100,\n \"discount_amount\": 25,\n \"net_amount\": 75,\n \"remark\": null,\n \"is_online\": true,\n \"must_buy\": false,\n \"created_by_user_id\": \"\",\n \"updated_by_user_id\": \"1001\",\n \"created_at_date\": \"2024-10-31\",\n \"updated_at_date\": \"2024-11-07\",\n \"updated_at\": \"2024-11-07 08:59:53\",\n \"date_2\": \"2024-10-31\",\n \"date_3\": \"2024-10-31\",\n \"date_4\": \"2024-10-31\"\n }\n]"}],"_postman_id":"e7b5a8a8-bd8e-419e-ad1a-8d3b65dd00ca"},{"name":"Gift_list_items/{{id}}","event":[{"listen":"test","script":{"id":"a05f7e5b-7d2f-418d-8988-fc0d4a0a8f79","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{}}}],"id":"7603b600-26a5-4527-b7de-b81350e54d85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/gift_list_items/1","description":"

This endpoint fetches one specific gift list item (gift).

For more information on the return values, please check the regular GET gift_list_items endpoint above.

Warning for all giftlist related endpoints:
Please note that the giftlist module can be very different per client. This module is usually customised a lot for each client individually, which makes it hard to make 100% accurate documentation for every client...
We have tried to make a \"default\" usage, anything mentioned in this documentation is by the rules of this default.

\n","_postman_id":"b36640d7-2ee6-4338-8d24-db91ea746583","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Intrastat","item":[{"name":"Intrastat","event":[{"listen":"test","script":{"id":"6e03a771-7591-4b3c-895e-25a872e5199e","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f82b9620-0b3b-47c4-b8bd-0d19e9e759fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.softtouch.eu/2/accounts/{{accountId}}/intrastat?active=1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}},"urlObject":{"protocol":"https","path":["2","accounts","{{accountId}}","intrastat"],"host":["api","softtouch","eu"],"query":[{"disabled":true,"description":{"content":"

Integer

\n","type":"text/plain"},"key":"take","value":"500"},{"disabled":true,"description":{"content":"

Integer

\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"

Boolean

\n","type":"text/plain"},"key":"active","value":"1"},{"disabled":true,"description":{"content":"

comma separated array

\n","type":"text/plain"},"key":"cn","value":null}],"variable":[]}},"response":[],"_postman_id":"f82b9620-0b3b-47c4-b8bd-0d19e9e759fc"}],"id":"1c3f4414-c879-4986-8e99-f264909d2de2","_postman_id":"1c3f4414-c879-4986-8e99-f264909d2de2","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Looks todo","item":[{"name":"Looks","event":[{"listen":"test","script":{"id":"75af1a05-0929-4b81-8b06-c52269e2ef9f","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"9a83ba16-92fa-4889-a252-226a29c38cea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"{{url}}/2/accounts/{{accountId}}/looks","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

sometimes|required|date|after:1980-01-01|before:3000-12-31

\n","type":"text/plain"},"key":"from_date","value":null},{"disabled":true,"description":{"content":"

sometimes|required|date|after:1980-01-01|before:3000-12-31

\n","type":"text/plain"},"key":"to_date","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"active","value":null},{"disabled":true,"description":{"content":"

sometimes|required|integer|min:1|max:5

\n","type":"text/plain"},"key":"online","value":null}],"variable":[]}},"response":[],"_postman_id":"9a83ba16-92fa-4889-a252-226a29c38cea"},{"name":"Looks/{{id}}","event":[{"listen":"test","script":{"id":"18fac300-acc0-4746-871f-698d716493df","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"fd4a8cd7-2db2-462d-be5a-4746165e56d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"{{url}}/2/accounts/{{accountId}}/looks/{{id}}","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

sometimes|required|date|after:1980-01-01|before:3000-12-31

\n","type":"text/plain"},"key":"from_date","value":null},{"disabled":true,"description":{"content":"

sometimes|required|date|after:1980-01-01|before:3000-12-31

\n","type":"text/plain"},"key":"to_date","value":null},{"disabled":true,"description":{"content":"

sometimes|required|boolean

\n","type":"text/plain"},"key":"active","value":null},{"disabled":true,"description":{"content":"

sometimes|required|integer|min:1|max:5

\n","type":"text/plain"},"key":"online","value":null}],"variable":[]}},"response":[],"_postman_id":"fd4a8cd7-2db2-462d-be5a-4746165e56d3"},{"name":"Look_items","event":[{"listen":"test","script":{"id":"502bcefa-392b-4529-b33e-6f32a21d33b7","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"1aeeb12d-d8f7-4dc0-bd08-ba0267edf302","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"url":"{{url}}/2/accounts/{{accountId}}/look_items","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

sometimes|required|corporation|CommaSeperated

\n","type":"text/plain"},"key":"brand_id","value":"193"},{"description":{"content":"

integer|between:1000000000,9999999999999|CommaSeperated

\n","type":"text/plain"},"key":"article_eans","value":"5400508495035,5400508495028,5400508494724,5400508495011"}],"variable":[]}},"response":[],"_postman_id":"77715325-ae36-40d2-9cf5-330384d27d0a"},{"name":"Reservation_headers/supplier_data","event":[{"listen":"test","script":{"id":"779e4e89-8e23-44ad-bd95-de07c67c3458","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"651d7fc0-d69e-4186-afab-3c7c32c224ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"external_attribute_id\": \"7\",\r\n \"first_name\": \"Xandres\",\r\n \"last_name\": \"Sekatle Pontso\",\r\n \"company\": \"Xandres Woluwe\",\r\n \"email\": \"woluwe@xandres.be\",\r\n \"street\": \"St-Lambertusstraat\",\r\n \"street_number\": \"200\",\r\n \"zip\": \"1200\",\r\n \"city\": \"Sint-Lambrechts-Woluwe\",\r\n \"country\": \"BE\",\r\n \"order_id\": \"999107050\",\r\n \"items\": [\r\n {\r\n \"EAN\": \"5414356649793\",\r\n \"quantity\": \"1\",\r\n \"price\": \"269\"\r\n }\r\n ]\r\n}"},"url":"{{url}}/2/accounts/329/reservation_headers/supplier_data","description":"

To create a new brand this endpoint should be used.

name	type
id	string	length: 3
name	string	required
alias	string
supplier	string
address	string
postal_code	string
city	string
country_iso	string	length: 2
telephone	striing
telephone_2	string
fax	string
email	string
website	string
vat	string
category1	string	length: 4, must start with 01
category2	string	length: 4, must start with 02
category3	string	length: 4, must start with 03
category4	string	length: 4, must start with 04
category5	string	length: 4, must start with 05
miscellaneous	string
margin	double
size_table_id	int
commercial_discount	int
on_customer_card	boolean	default: true
article_discount_allowed	boolean	default: true
active	boolean	default: true

required|string

\n","type":"text/plain"},"key":"first_name","value":null},{"disabled":true,"description":{"content":"

required|string

\n","type":"text/plain"},"key":"last_name","value":null},{"disabled":true,"description":{"content":"

string

\n","type":"text/plain"},"key":"company","value":null},{"disabled":true,"description":{"content":"

required|string

\n","type":"text/plain"},"key":"email","value":null},{"disabled":true,"description":{"content":"

required|string

\n","type":"text/plain"},"key":"street","value":null},{"disabled":true,"description":{"content":"

required|string

\n","type":"text/plain"},"key":"street_number","value":null},{"disabled":true,"description":{"content":"

string

\n","type":"text/plain"},"key":"street_number_addition","value":null},{"disabled":true,"description":{"content":"

required|string

\n","type":"text/plain"},"key":"zip","value":null},{"disabled":true,"description":{"content":"

required|string

\n","type":"text/plain"},"key":"city","value":null},{"disabled":true,"description":{"content":"

required|country

\n","type":"text/plain"},"key":"country","value":null},{"disabled":true,"description":{"content":"

required|string

\n","type":"text/plain"},"key":"order_id","value":null},{"disabled":true,"description":{"content":"

required|array|min:1

\n","type":"text/plain"},"key":"items","value":null},{"disabled":true,"description":{"content":"

required|integer|between:1000000000000,9000000000000

\n","type":"text/plain"},"key":"items:EAN","value":null},{"disabled":true,"description":{"content":"

required|integer

\n","type":"text/plain"},"key":"items:quantity","value":null},{"disabled":true,"description":{"content":"

required

\n","type":"text/plain"},"key":"items:price","value":null}],"variable":[]}},"response":[],"_postman_id":"651d7fc0-d69e-4186-afab-3c7c32c224ee"}],"id":"115f4fc4-ea5c-4c77-b2f3-e5feecb76b00","_postman_id":"115f4fc4-ea5c-4c77-b2f3-e5feecb76b00","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f59c3410-b180-46ea-8714-23dfc77b0376","id":"f59c3410-b180-46ea-8714-23dfc77b0376","name":"SoftTouch API docs","type":"collection"}}},{"name":"Wash_instructions todo","item":[{"name":"Wash_instructions","event":[{"listen":"test","script":{"id":"fcc88f14-0a2f-4dd8-8759-30244362657d","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"0561211e-2d78-4db7-9df8-a6cd458c23f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/2/accounts/{{accountId}}/wash_instructions","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.

boolean

\n","type":"text/plain"},"key":"active","value":null}],"variable":[]}},"response":[],"_postman_id":"0561211e-2d78-4db7-9df8-a6cd458c23f5"},{"name":"Wash_instructions/{{id}}","event":[{"listen":"test","script":{"id":"661dcd53-c6e3-4582-9210-42d27e1a5e8e","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r"," postman.setEnvironmentVariable('returnId', pm.response.json().id);\r","});"],"type":"text/javascript"}}],"id":"8c5730f0-c4bf-47ba-970e-2e5ef7ca0315","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"{{url}}/2/accounts/{{accountId}}/wash_instructions/1","description":"

This endpoint fetches all cheques as all calls it has to be done in steps with a maximum amount of 500 cheques.

Used parameters:

display (full)
take
skip

A brief explanation of return values:

key: The unique identifier
name: The brand name
alias: An alias for a brand name, as an example Marie Jo and Marie Jo Swim, this is the same brand but for administrative purposes splitet in the clients database. An alias can be used for those brands so this can be shown as 1 brand. Note: this field will be an empty string if no alias is provided.
category1 -5: These fields are customizable per client, no default value is availble for these but the values can be retrieved using the brand_attributes endpoint.

If display full is used some extra info is availble like the address and contact information.