1. OAuth2
4. Point of sale - Device registration
5. Point of sale - Execution of transaction

Show/hide List Operations Expand Operations

1. OAuth2

/oauth/v2/token

POST http://api.testing.myshop.mobi/oauth/v2/token

Authorization

Parameters

Parameter	Type	Required?	Format	Description
grant_type	string	true
client_id	string	true
client_secret	string	true

Status Codes

Status Code	Description
200	Access token
302	The user is not registered
400	The client credentials are invalid

Show/hide List Operations Expand Operations

4. Point of sale - Device registration

/point-of-sale

POST http://api.testing.myshop.mobi/point-of-sale

Registering point of sale in the myshop.mobi system.

/point-of-sale/{point_of_sale_token}

GET http://api.testing.myshop.mobi/point-of-sale/{point_of_sale_token}

Get information about the point of sale in the myshop.mobi system.

Requirements

Name	Requirement	Type	Description
point_of_sale_token

Return

Parameter	Type	Versions	Description
200 - Successfully
status	string	*	Example: ACTIVE, INACTIVE
network	object (Network)	*
network[name]	string	*
network[logo]	object (Media)	*
network[logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
network[logo][width]	integer	*	Photo width (px)
network[logo][height]	integer	*	Photo height (px)
shop	object (Shop)	*
shop[name]	string	*
name	string	*
pairing_date	DateTime	*

Status Codes

Status Code	Description
200	Successfully

Show/hide List Operations Expand Operations

5. Point of sale - Execution of transaction

/point-of-sale/{point_of_sale_token}/check-use-reward/card/{card_number}

POST http://api.testing.myshop.mobi/point-of-sale/{point_of_sale_token}/check-use-reward/card/{card_number}

Check if the transaction meets the conditions for redeeming the reward.

Requirements

Name	Requirement	Type	Description
point_of_sale_token	true	string	...
card_number	true	string	Card number or phone number

Parameters

Parameter	Type	Required?	Format	Description
reward	string	false
receipt	object (ReceiptModel)	false
receipt[number]	string	false

Status Codes

Status Code	Description
200	Transaction meets requirements to claim reward
400	Validation Failed - form error
404	code: 26000, message: Point of sale not found code: 13000, message: Card not found
409	code: 26010, message: Point of sale not pairing code: 14201, message: Reward does not exist code: 14202, message: Reward is used code: 14203, message: Transaction does not qualify for the reward

/point-of-sale/{point_of_sale_token}/checking/card/{card_number}

GET http://api.testing.myshop.mobi/point-of-sale/{point_of_sale_token}/checking/card/{card_number}

Checking customers by card number

Requirements

Name	Requirement	Type	Description
point_of_sale_token	true	string	...
card_number	true	string	Card number or phone number

Return

Parameter	Type	Versions	Description
200 - Created

Status Codes

Status Code	Description
200	Created
400	Validation Failed
404	code: 13000, message: Card not found

/point-of-sale/{point_of_sale_token}/checkout/card/{card_number}

POST http://api.testing.myshop.mobi/point-of-sale/{point_of_sale_token}/checkout/card/{card_number}

Checkout customers by card number.

Requirements

Name	Requirement	Type	Description
point_of_sale_token	true	string	...
card_number	true	string	Card number or phone number

Parameters

Parameter	Type	Required?	Format	Description
reward	string	false
receipt	object (ReceiptModel)	false
receipt[number]	string	false

Status Codes

Status Code	Description
201	Created
400	Validation Failed

Documentation auto-generated on Tue, 16 Dec 25 02:46:02 +0100