Store API

Basic Information

BaseURL

Phase	KIC	AIC	EIC	Description
OP	https://kic-laundry-ext.lgthinq.com	https://aic-laundry-ext.lgthinq.com	https://eic-laundry-ext.lgthinq.com	Operation
QA	https://kic-laundry-ext-qa.lgthinq.com	https://aic-laundry-ext-qa.lgthinq.com	https://eic-laundry-ext-qa.lgthinq.com	Development & Test

API List

Method	End-point	Response Format	Summary
GET	{{BASE_URL}}/stores	JSON	View the store list.
GET	{{BASE_URL}}/stores/{store-id}/devices	JSON	View the list of devices in a store.

Get Store List

GET {{BASE_URL}}/stores

View the store list.

Request

Parameter

Location	Name		Required	Type	Description	Example
Header	Common Header		Mandatory	-	-	-
Body	None		-	-	-	-

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Name			Type	Required	Description	Example
resultCode			string	Mandatory	Result code	"0000"
result			list	Mandatory	Result data	-
└	storeId		string	Mandatory	Store ID
└	address		dict	Mandatory	-
	└	zipcode	string	Mandatory	zipcode
	└	address1	boolean	Mandatory	Street address or mailbox
	└	address2	string	Mandatory	Apartment, suite, unit, building floor, etc.
	└	city	string	Mandatory	City name
	└	states	string	Mandatory	State name
└	storeName		string	Mandatory	Store name
└	country		string	Mandatory	Country
└	createdDate		string	Mandatory	Creation date
└	lastModifyDate		string	Mandatory	Edited date
└	longitude		string	Mandatory	Latitude, longitude information

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/stores

Response

{{BASE_URL}}/stores

{
  "resultCode": "0000",
  "result": [{
    "storeId": "1f2a012cd98045bdb9773cf803de0d17",
    "address": {
      "zipcode": "07336",
      "address1": "128, Yeoui-daero",
      "address2": "5th",
      "city": "seoul",
      "states": "Yeongdeungpo-gu"
    },
    "storeName": "test",
    "country": "KR",
    "createDate": "2021-03-26 01:56:14",
    "lastmodifyDate": "2021-03-26 01:56:14",
    "longitude": [
      "37.527947",
      "126.929143"
    ],
    "deviceId": ["4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e"]
  }]
}

Get List of Devices in Store

GET {{BASE_URL}}/stores/{store-id}/devices

View the list of devices in a store.

Request

Parameter

Location	Name	Required	Type	Description	Default	Example
Header	Common Header	Mandatory	-	-		-
Body	None	-
Query	searchType	Mandatory	String	Designate the type when viewing device. If there is no corresponding field, operate with default.	info	reserved, ready, info
Query	additionalInfo	Mandatory	String	Designate additional information needed Separate by comma (,) when entering `detail`: detailed device information `history`: device history information (last 10 times) `error`: device error information (last 10 times) `settings`: device setting information	None	detail, history, error, settings

Response

Success

Upon success, resultCode is returned as normal code (0000). For the result data, refer to the result of the response message.

Settings for each course

For a washer, there are two types; heater model and nonheater model. The former provides 6 courses, while the latter provides 4 courses.

Use list as a factor to differentiate settings by course.

For example, NonHeater model has the setting value is [1, 1, 4, 4], it means as follows:

course1 settings = 1, course2 settings = 1, course3 settings = 4, course4 settings = 4

RatingMoney

When viewing price, RatingMoney in description is the value to mark the amount by country and has a fixed value by country (region).

Europe: 5
Australia: 5
America: 5
China: 1
Korea: 100
Japan: 100
Philippines: 5

When calculating prices of currency unit, refer to the RatingMoney value.

Name			Type	Required	Description	Default	Example
resultCode			string	Mandatory	Result code	-	"0000"
result			list	-	Result data	-	-
└	deviceId		string	Mandatory	Device ID	-	-
	deviceStatus		string	Mandatory	Device status	-	-
	modelNm		string	Mandatory	Model Name	-	-
	deviceType		string	Mandatory	Device type	-	-
	status		string	Optional	Booked status or ready for use status	-	-
	expirationTime		string	Optional	It is used only in the booked status. The booking expiration time (UTC) may differ depending on the server status.	-	-
	detail		dict	Optional	-	-	-
	└	alias	string	Optional	Device name	-	-
	└	online	boolean	Optional	Whether connected to the server	-	-
	└	ssid	string	Optional	ssid connected to the Internet	-	-
	└	error	string	Optional	Error status `ERROR_NO` is the status without an error.	ERRROR_NO	-
	└	state	string	Optional	Operation state	POWEROFF	-
	└	course	string	Optional	Operation course	NOT_SELECTED	-
	└	remain	number	Optional	Remaining time	0	0
	└	reservable	boolean	Optional	Whether the device can be booked	-	true, false
	└	payable	boolean	Optional	Whether the device price can be paid	-	true, false
└	history		list	Optional	History list	-	-
	└	event	string	Optional	Occurred event	-	POWEROFF : 0
	└	date	string	Optional	Event date	-	-
	└	type	string	Optional	Event type (general event or event)	-	S, E
	└	detail	string	Optional	History description	-	-
└	error		list	Optional	History list	-	-
	└	todo	string	Optional	List of actions to take to resolve the error	-	-
	└	code	string	Optional	Error code	-	-
	└	date	string	Optional	Error date	-	-
	└	detail	string	Optional	Error code description	-	-
└	settings		dict	Optional	-	-	-
	└	washingTime	list	Optional	Laundry time by course Settings for each course NonHeater: [Course1, Course2, Course3, Course 4] Heater: [Course1, Course2, Course3, Course 4, Course5, Course6]	8	NonHeater : [10, 11, 8, 7] Heater : [5, 5, 8, 7, 11, 11]
	└	waterLevel	list	Optional	Water level by course `1`: Low `2`: Middle `3`: High Settings for each course NonHeater: [Course1, Course2, Course3, Course 4] Heater: [Course1, Course2, Course3, Course 4, Course5, Course6]	1	NonHeater : [1, 1, 1, 1] Heater : [1, 1, 1, 1, 1, 1]
	└	rinsingTime	list	Optional	Rinsing time by course Range: 8-16 Settings for each course NonHeater: [Course1, Course2, Course3, Course 4] Heater: [Course1, Course2, Course3, Course 4, Course5, Course6]	8	NonHeater : [8, 8, 8, 8] Heater: [8, 8, 8, 8, 8, 8]
	└	rinsingCount	list	Optional	Number of rinsing by course Range: 1-5 Settings for each course NonHeater: [Course1, Course2, Course3, Course 4] Heater: [Course1, Course2, Course3, Course 4, Course5, Course6]	2	NonHeater : [1, 1, 1, 1] Heater: [1, 1, 1, 1, 1, 1]
	└	spinSpeed	list	Optional	Dehydration MAX RPM by course Range: 500-1000, Max (increments of 100) Settings for each course NonHeater: [Course1, Course2, Course3, Course 4] Heater: [Course1, Course2, Course3, Course 4, Course5, Course6]	Max	NonHeater : ['Max', 'Max', 'Max', 'Max'] Heater: ['Max', 'Max', 'Max', 'Max', 'Max', 'Max']
	└	dropCount	number	Optional	Data range: 25-50 As the MAX Count of the number of stops by UB during dehydration condition, UE occurs when exceeding the set number of times.	50	50
	└	twinSprary	string	Optional	Whether to use the Circulation Pump option `'0'`: Disable `'1'`: Enable	‘0’	‘0’
	└	price	list	Optional	Data range 0-199 When set to 0, it is set equally to the price of defaultPrice. The first value of the price by course is defaultPrice that represents the price of all courses Defaultprice & price by course NonHeater : [defaultPrice , course1, course2, course3, course4] Heater: [defaultPrice , course1, course2, course3, course4, course5, course6] To convert to monetary price, multiply by RatingMoney. price x RatingMoney	-	NonHeater : [20, 0, 0, 0, 30] Heater: [20, 0, 0, 0, 0, 0, 30]
	└	coin	number	Optional	Value of minimum currency unit `1`: Korea, Japan, China, Philippines `2`: Europe `5`: North America, Canada `20`: Australia To convert to monetary price, multiply by RatingMoney. coin x RatingMoney	5	5
	└	addSuperWash	number	Optional	Price of Add Super wash Range: 0-199 To convert to monetary price, multiply by RatingMoney. addSuperWash x RatingMoney	5	5
	└	dryCycleTime	list	Optional	Drying time by course Range: 5-99 (increments of 1) Courses 1-4 data, [Course1, Course2, Course3, Course 4]	45	[45, 45, 45, 45]
	└	topOffTime	list	Optional	topOff time by course Range: 1-99 (increments of 1) Courses 1-4 data, [Course1, Course2, Course3, Course 4]	5	[5, 5, 5, 5]
	└	topOff	string	Optional	Whether to activate adding drying time during operation `'0'`: Disable `'1'`: Enable	‘0’
	└	sensingDry	string	Optional	Whether to activate the automatic drying time adjustment function by humidity value `'0'`: Disable `'1'`: Enable	‘0’
	└	regularPrice	list	Optional	Data range: 0-199 When set to 0, it is set equally to the price of defaultPrice. The first value of the price by course is defaultPrice that represents the price of all courses. [defaultPrice , course1, course2, course3, course4] To convert to monetary price, multiply by RatingMoney. regularPriceⅹRatingMoney	-	[20, 0, 0, 0, 0]
	└	topOffPrice	list	Optional	Price by unit when setting topOff	-	[10, 10, 10, 10]
	└	coin1	number	Optional	Value of minimum currency unit `1`: Korea, Japan, China, Philippines `2`: Europe `5`: North America, Canada `20`: Australia To convert to monetary price, multiply by RatingMoney. coin1 x RatingMoney	5	5

Failure

Upon failure, the resultCode is returned as an error code. For a description of each error code, refer to Common Response.

Example

Request

[GET] {{BASE_URL}}/stores/{store-id}/devices

Response

{{BASE_URL}}/stores/{store-id}/devices?searchType=reserved

{
  "resultCode": "0000",
  "result": [{
    "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
    "deviceStatus": "T",
    "modelNm": "FH069FD_T",
    "deviceType": "211",
    "status": "reserved"
  }]
}


{{BASE_URL}}/stores/{store-id}/devices?additionalInfo=detail

{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "FH069FD_T",
            "deviceType": "211",
            "status": "ready",
            "detail": {
                "alias": "Dryer_new",
                "online": true,
                "ssid": null,
                "error": "ERROR_NO",
                "state": "POWEROFF",
                "course": "Hot",
                "remain": 0
            }
        }
    ]
}


{{BASE_URL}}/stores/{store-id}/devices?additionalInfo=history

{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "211",
            "deviceType": "211",
            "status": "ready",
            "history": [
                {
                    "date": "2020-12-17 02:57:11",
                    "event": "INITIAL",
                    "type": "S",
                    "detail": "NOT_SELECTED / Twin spray"
                },
                {
                    "date": "2020-12-17 02:56:58",
                    "event": "END",
                    "type": "S",
                    "detail": "NOT_SELECTED"
                },
                {
                    "date": "2020-12-17 02:47:11",
                    "event": "SPINNING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-17 02:29:32",
                    "event": "RINSING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-17 02:22:09",
                    "event": "WASHING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:35:39",
                    "event": "INITIAL",
                    "type": "S",
                    "detail": "NOT_SELECTED / Twin spray / Super wash"
                },
                {
                    "date": "2020-12-16 11:35:26",
                    "event": "END",
                    "type": "S",
                    "detail": "NOT_SELECTED"
                },
                {
                    "date": "2020-12-16 11:25:50",
                    "event": "SPINNING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:08:56",
                    "event": "RINSING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:01:45",
                    "event": "WASHING",
                    "type": "S",
                    "detail": "Hot"
                }
            ]
        }
    ]
}



{{BASE_URL}}/stores/{store-id}/devices?additionalInfo=error

{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "211",
            "deviceType": "211",
            "status": "ready",
            "error": [
                {
                    "date": "2020-12-13 00:55:21",
                    "code": "ERROR_DE1",
                    "detail": "Door Open Error",
                    "todo": [
                        "Close the door completely.",
                        "If it will not open, call for service."
                    ]
                },
                {
                    "date": "2020-11-28 22:15:13",
                    "code": "ERROR_DE2",
                    "detail": "Door Lock Error",
                    "todo": [
                        "Check the door switch"
                    ]
                }
            ]
        }
    ]
}


{{BASE_URL}}/stores/{store-id}/devices?additionalInfo=settings

{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "211",
            "deviceType": "211",
            "status": "ready",
            "settings": {
                "washingTime": [
                    10,
                    10,
                    10,
                    10
                ],
                "waterLevel": [
                    1,
                    1,
                    1,
                    1
                ],
                "rinsingTime": [
                    8,
                    8,
                    8,
                    8
                ],
                "rinsingCount": [
                    2,
                    2,
                    2,
                    2
                ],
                "dropCount": 50,
                "twinSpray": "0",
                "price": [
                    0,
                    20,
                    15,
                    10,
                    5
                ],
                "coin": 1,
                "addSuperWash": 5,
                "nonStopRinsing": false,
                "spinSpeed": [
                    "Max",
                    "Max",
                    "Max",
                    "Max"
                ]
            }
        }
    ]
}


{{BASE_URL}}/stores/{store-id}/devices?additionalInfo=settings, history, error, detail

{
    "resultCode": "0000",
    "result": [
        {
            "deviceId": "4138737e7eb621c26138f89f60b646671b03cf30817a7f55a7eb1e0af4aa501e",
            "deviceStatus": "E",
            "modelNm": "211",
            "deviceType": "211",
            "status": "ready",
            "settings": {
                "washingTime": [
                    10,
                    10,
                    10,
                    10
                ],
                "waterLevel": [
                    1,
                    1,
                    1,
                    1
                ],
                "rinsingTime": [
                    8,
                    8,
                    8,
                    8
                ],
                "rinsingCount": [
                    2,
                    2,
                    2,
                    2
                ],
                "dropCount": 50,
                "twinSpray": "0",
                "price": [
                    0,
                    20,
                    15,
                    10,
                    5
                ],
                "coin": 1,
                "addSuperWash": 5,
                "nonStopRinsing": false,
                "spinSpeed": [
                    "Max",
                    "Max",
                    "Max",
                    "Max"
                ]
            },
            "history": [
                {
                    "date": "2020-12-17 02:57:11",
                    "event": "INITIAL",
                    "type": "S",
                    "detail": "NOT_SELECTED / Twin spray"
                },
                {
                    "date": "2020-12-17 02:56:58",
                    "event": "END",
                    "type": "S",
                    "detail": "NOT_SELECTED"
                },
                {
                    "date": "2020-12-17 02:47:11",
                    "event": "SPINNING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-17 02:29:32",
                    "event": "RINSING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-17 02:22:09",
                    "event": "WASHING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:35:39",
                    "event": "INITIAL",
                    "type": "S",
                    "detail": "NOT_SELECTED / Twin spray / Super wash"
                },
                {
                    "date": "2020-12-16 11:35:26",
                    "event": "END",
                    "type": "S",
                    "detail": "NOT_SELECTED"
                },
                {
                    "date": "2020-12-16 11:25:50",
                    "event": "SPINNING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:08:56",
                    "event": "RINSING",
                    "type": "S",
                    "detail": "Hot"
                },
                {
                    "date": "2020-12-16 11:01:45",
                    "event": "WASHING",
                    "type": "S",
                    "detail": "Hot"
                }
            ],
            "error": [
                {
                    "date": "2020-12-13 00:55:21",
                    "code": "ERROR_DE1",
                    "detail": "Door Open Error",
                    "todo": [
                        "Close the door completely.",
                        "If it will not open, call for service."
                    ]
                },
                {
                    "date": "2020-11-28 22:15:13",
                    "code": "ERROR_DE2",
                    "detail": "Door Lock Error",
                    "todo": [
                        "Check the door switch"
                    ]
                }
            ],
            "detail": {
                "alias": "Dryer_new",
                "online": false,
                "ssid": null,
                "error": "ERROR_NO",
                "state": "POWEROFF",
                "course": "Hot",
                "remain": 0
            }
        }
    ]
}

[Action Required: Windows XP OS users] End of Support for 3DES Cipher

Store API

Basic Information

BaseURL

API List

Get Store List

Request

Parameter

Response

Success

Failure

Example

Request

Response

Get List of Devices in Store

Request

Parameter

Response

Success

Failure

Example

Request

Response