Yedpay API Documentation

Description (Update Store)

Update information of the selected store. (PUT)

End Point

https://api.yedpay.com/v1/stores/{{store_id}}

Variable

Variable
#	Name	Type	Description
1	store_id	String	Store's ID

Request Header

Request Header
#	Key	Value	Description
1	Authorization	Bearer {{access_token}}	Login Token
2	Content-Type	application/x-www-form-urlencoded	x-www-form-urlencoded Format

Body

Body
#	Name	Type	Description
1	name	String	(Optional) Store's Name
2	phone	String	(Optional) Store's Phone
3	address	String	Store's Address
4	logo	String	(Optional) ID of documentation
5	district_id	Integer	(Optional) Unique Identifier of the District

Response

Response
#	Name	Type	Description
1	success	Boolean	Update Store's Information Success or Fail
2	data	Array	Include Store's Information (id, name, phone, etc..)

Success Response - data

Success Response - data
#	Name	Type	Description
1	id	String	Id of the Store
2	name	String	Name of the Store
3	phone	String	Phone of the Store
4	district_id	Integer	Unique Identifier of the District
5	address	String	Address of the Store
6	store_identifier	String	Store Identifier
7	type	Integer	Store Type: 1 - OFFLINE 2 - ONLINE
8	logo	String	Logo of the Store
9	logo_url	String	Url of the Logo
10	created_at	String	Date when the Store was created "YYYY-mm-dd h:i:s"

Example Success Response

            {
                "success": true,
                "data": {
                    "id": "KzoONpJE",
                    "name": "xxxx",
                    "phone": "xxxx",
                    "district_id": "",
                    "address": "xxxx",
                    "store_identifier": "LZXE",
                    "type": 1,
                    "logo": "xxxx",
                    "logo_url": "xxxx",
                    "created_at": "2099-01-02 12:00:00"
                }
            }

Example Error Response

            {
                "success": false,
                "message": "Unauthenticated.",
                "status": 500
            }