Show/hide List Operations Expand Operations

1. OAuth2

/oauth/v2/token

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

Authorization

Parameters

Parameter	Type	Required?
grant_type	string	true
client_id	string	true
client_secret	string	true
username	string	false
password	string	false
refresh_token	string	false
facebook_access_token	string	false
google_access_token	string	false

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

10. Questionnaires

/cards/{card_id}/questionnaires

GET http://api.myshop.mobi/cards/{card_id}/questionnaires

Get Questionnaires

Requirements

Name	Requirement	Type	Description
card_id	true	integer	Card Id

Return

Parameter	Type	Versions	Description
200 - Questionnaires
items[]	array of objects (Questionnaire)	*
items[][name]	string	*	Field Name
items[][label]	string	*	Field Label
items[][placeholder]	string	*	Placeholder
items[][type]	string	*	Field Type: text, integer, checkbox, radio, select, date, textarea
items[][required]	boolean	*	Field required
items[][choices]	array	*	choices, label and value

Status Codes

Status Code	Description
200	Questionnaires
404	code: 13000, message: Card not found code: 17000, message: Questionnaires not found

POST http://api.myshop.mobi/cards/{card_id}/questionnaires

Set Questionnaires

Requirements

Name	Requirement	Type	Description
card_id	true	integer	Card Id

Parameters

Parameter	Type	Required?	Format	Description
time_of_residence	choice	true	{"kr\u00f3cej ni\u017c p\u00f3\u0142 roku":"1","p\u00f3\u0142 roku - rok":"2","rok - 2 lata":"3","2 lata - 5 lat":"4","powy\u017cej 5 lat":"5"}	Od jak dawna mieszkasz w obecnym miejscu zamieszkania?
measurement	choice	true	{"poni\u017cej 40m2":"1","40-70m2":"2","70-120m2":"3","120-250m2":"4","powy\u017cej 250m2":"6"}	Jaki jest metraż Twojego domu/mieszkania?
interest[]	array of choices	true	{"Sypialni":"1","Pokoju dziennego":"2","Jadalni":"3","Przedpokoju":"4","Biura":"5"}	Wyposażenie których pomieszczeń Cię interesuje?
interest2[]	array of choices	true	{"Drzwi":"1","Pod\u0142ogi":"2","Artyku\u0142y dekoracyjne":"3","Dla dzieci":"4","Dla m\u0142odzie\u017cy":"5"}	Którymi z poniższych artykułów jesteś zainteresowany?
planned_renovation	choice	false	{"w ci\u0105gu najbli\u017cszych 3 miesi\u0119cy":"1","za 3 miesi\u0105ce - rok":"2","za rok - 2 lata":"3","powy\u017cej 2 lat":"4"}	Kiedy planujesz remont?

Status Codes

Status Code	Description
200	Questionnaires
404	code: 13000, message: Card not found code: 17000, message: Questionnaires not found

Show/hide List Operations Expand Operations

11. Contests

/cards/{card_id}/offers/contests

GET http://api.myshop.mobi/cards/{card_id}/offers/contests

Get Contests

Requirements

Name	Requirement	Type	Description
card_id	true	integer	Card Id

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Return items
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][network]	object (Network)	*
items[][network][id]	integer	*
items[][network][name]	string	*
items[][network][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][network][logo]	object (Media)	*
items[][network][logo][id]	integer	*
items[][network][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][network][logo][width]	integer	*	Photo width (px)
items[][network][logo][height]	integer	*	Photo height (px)
items[][network][logo][main_color]	string	*
items[][network][is_card]	boolean	*
items[][contest]	object (Contest)	*
items[][contest][id]	integer	*
items[][contest][date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
items[][contest][date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
items[][contest][photo]	object (Media)	*
items[][contest][photo][id]	integer	*
items[][contest][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][contest][photo][width]	integer	*	Photo width (px)
items[][contest][photo][height]	integer	*	Photo height (px)
items[][contest][photo][main_color]	string	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*
items[][photo]	object (Media)	*
items[][photo][id]	integer	*
items[][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo][width]	integer	*	Photo width (px)
items[][photo][height]	integer	*	Photo height (px)
items[][photo][main_color]	string	*

Status Codes

Status Code	Description
200	Return items
404	code: 13000, message: Card not found

/contests/{offer_id}

GET http://api.myshop.mobi/contests/{offer_id}

Get Contest

Requirements

Name	Requirement	Type	Description
contest_id	true	integer	Contest Id
offer_id

Return

Parameter	Type	Versions	Description
200 - Contest
id	integer	*
type	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
title	string	*	Offer Title, Max 255 characters
message	string	*	Offer Message, Max 400 characters
network	object (Network)	*
network[id]	integer	*
network[name]	string	*
network[type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
network[logo]	object (Media)	*
network[logo][id]	integer	*
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)
network[logo][main_color]	string	*
network[is_card]	boolean	*
contest	object (Contest)	*
contest[id]	integer	*
contest[date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
contest[date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
contest[photo]	object (Media)	*
contest[photo][id]	integer	*
contest[photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
contest[photo][width]	integer	*	Photo width (px)
contest[photo][height]	integer	*	Photo height (px)
contest[photo][main_color]	string	*
restrict_message	string	*
formatted_expiration_date	string	*
rules	string	*
photo	object (Media)	*
photo[id]	integer	*
photo[url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
photo[width]	integer	*	Photo width (px)
photo[height]	integer	*	Photo height (px)
photo[main_color]	string	*

Status Codes

Status Code	Description
200	Contest
404	code: 19000, message: Contest not found

Show/hide List Operations Expand Operations

12.3.Offers by group

/dashboard/sections/cards/{section_name}

GET http://api.myshop.mobi/dashboard/sections/cards/{section_name}

.....

Requirements

Name	Requirement	Type	Description
section_name	\s+	string	Section name

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully. Returned when results were found or not
items[]	array of objects (Offer)	*

Status Codes

Status Code	Description
200	Successfully. Returned when results were found or not

/dashboard/sections/offers/{section_name}

GET http://api.myshop.mobi/dashboard/sections/offers/{section_name}

.....

Requirements

Name	Requirement	Type	Description
section_name	\s+	string	Section name

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully. Returned when results were found or not
items[]	array of objects (Offer)	*

Status Codes

Status Code	Description
200	Successfully. Returned when results were found or not

/dashboard/sections/shops/{section_name}

GET http://api.myshop.mobi/dashboard/sections/shops/{section_name}

.....

Requirements

Name	Requirement	Type	Description
section_name	\s+	string	Section name

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully. Returned when results were found or not
items[]	array of objects (Offer)	*

Status Codes

Status Code	Description
200	Successfully. Returned when results were found or not

Show/hide List Operations Expand Operations

13 Search

/search

GET http://api.myshop.mobi/search

Search offers, products, loyalty program and shops near given coordinates

Filters

Name

Information

query

Datatype	string
Description	query phrase

lat

Datatype	duble
Default
Description	latitude range from -90 to 90

lon

Datatype	duble
Default
Description	longitude range from -180 to 180

Return

Parameter	Type	Versions	Description
200 - Returned when results were found or not
[]	array of objects (Section)	*
[][id]	integer	*
[][title]	string	*	Tag name, Max 255 characters
[][section_name]	string	*
[][type]	string	*	Example: SECTION_CARDS, SECTION_CONTESTS, SECTION_SLIDERS, SECTION_OFFERS, SECTION_LEAFLETS
[][vertical]	boolean	*
[][offers][]	array of objects (Offer)	*
[][offers][][id]	integer	*
[][offers][][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
[][offers][][title]	string	*	Offer Title, Max 255 characters
[][offers][][message]	string	*	Offer Message, Max 400 characters
[][offers][][network]	object (Network)	*
[][offers][][network][id]	integer	*
[][offers][][network][name]	string	*
[][offers][][network][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
[][offers][][network][logo]	object (Media)	*
[][offers][][network][logo][id]	integer	*
[][offers][][network][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
[][offers][][network][logo][width]	integer	*	Photo width (px)
[][offers][][network][logo][height]	integer	*	Photo height (px)
[][offers][][network][logo][main_color]	string	*
[][offers][][network][is_card]	boolean	*
[][offers][][leaflet]	object (Leaflet)	*
[][offers][][leaflet][id]	integer	*
[][offers][][leaflet][url]	string	*
[][offers][][leaflet][date_start]	DateTime	*
[][offers][][leaflet][date_end]	DateTime	*
[][offers][][contest]	object (Contest)	*
[][offers][][contest][id]	integer	*
[][offers][][contest][date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
[][offers][][contest][date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
[][offers][][contest][photo]	object (Media)	*
[][offers][][contest][photo][id]	integer	*
[][offers][][contest][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
[][offers][][contest][photo][width]	integer	*	Photo width (px)
[][offers][][contest][photo][height]	integer	*	Photo height (px)
[][offers][][contest][photo][main_color]	string	*
[][offers][][restrict_message]	string	*
[][offers][][formatted_expiration_date]	string	*
[][offers][][rules]	string	*
[][offers][][photo]	object (Media)	*
[][offers][][photo][id]	integer	*
[][offers][][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
[][offers][][photo][width]	integer	*	Photo width (px)
[][offers][][photo][height]	integer	*	Photo height (px)
[][offers][][photo][main_color]	string	*
[][shops][]	array of objects (Shop)	*
[][shops][][id]	integer	*
[][shops][][external_number]	string	*
[][shops][][name]	string	*
[][shops][][status]	string	*	Example: ACTIVE, INACTIVE
[][shops][][category]	object (Category)	*
[][shops][][category][id]	integer	*
[][shops][][category][name]	string	*
[][shops][][networks][]	array of objects (Network)	*
[][shops][][networks][][id]	integer	*
[][shops][][networks][][name]	string	*
[][shops][][networks][][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
[][shops][][networks][][logo]	object (Media)	*
[][shops][][networks][][logo][id]	integer	*
[][shops][][networks][][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
[][shops][][networks][][logo][width]	integer	*	Photo width (px)
[][shops][][networks][][logo][height]	integer	*	Photo height (px)
[][shops][][networks][][logo][main_color]	string	*
[][shops][][networks][][is_card]	boolean	*
[][shops][][photo]	object (Media)	*
[][shops][][photo][id]	integer	*
[][shops][][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
[][shops][][photo][width]	integer	*	Photo width (px)
[][shops][][photo][height]	integer	*	Photo height (px)
[][shops][][photo][main_color]	string	*
[][shops][][formatted_location]	string	*	@var string
[][shops][][address]	object (Address)	*
[][shops][][address][id]	integer	*
[][shops][][address][country]	string	*
[][shops][][address][district]	string	*
[][shops][][address][city]	string	*
[][shops][][address][street]	string	*
[][shops][][address][house_number]	string	*
[][shops][][address][apartment_number]	string	*
[][shops][][address][post_code]	string	*
[][shops][][address][latitude]	double	*
[][shops][][address][longitude]	double	*
[][shops][][address][map_image_url]	string	*
[][shops][][address][distance]	string	*
[][shops][][address][formatted_address]	string	*
[][shops][][contact]	object (Contact)	*
[][cards][]	array of objects (Card)	*
[][cards][][photo_number]	object (Media)	*
[][cards][][photo_number][id]	integer	*
[][cards][][photo_number][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
[][cards][][photo_number][width]	integer	*	Photo width (px)
[][cards][][photo_number][height]	integer	*	Photo height (px)
[][cards][][photo_number][main_color]	string	*
[][cards][][status]	string	*
[][cards][][created_at]	DateTime	*
[][cards][][used_at]	DateTime	*
[][cards][][id]	integer	*	Card id
[][cards][][name]	string	*	Card name
[][cards][][description]	string	*	Card description
[][cards][][show_contest]	boolean	*	Show Contest
[][cards][][external_registration]	boolean	*	External registration, true - is required
[][cards][][number_type]	string	*	Number type: EAN13, STRING, QRCODE
[][cards][][network]	object (Network)	*
[][cards][][network][id]	integer	*
[][cards][][network][name]	string	*
[][cards][][network][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
[][cards][][network][logo]	object (Media)	*
[][cards][][network][is_card]	boolean	*
[][cards][][card_provider]	string	*
[][cards][][photo]	object (Media)	*
[][cards][][show_transaction]	boolean	*
[][cards][][show_offers]	boolean	*	Show offers
[][cards][][show_offers_for_me]	boolean	*	Show Offers for Me
[][cards][][show_shops_type]	string	*	Example: NONE, LIST_TEXT, LIST_IMAGE

Status Codes

Status Code	Description
200	Returned when results were found or not
400	Validation Failed incorrect search parameters

/search/autocomplete

GET http://api.myshop.mobi/search/autocomplete

Suggest a query phrase

Filters

Name

Information

query

Datatype	string
Description	query phrase

lat

Datatype	duble
Default
Description	latitude range from -90 to 90

lon

Datatype	duble
Default
Description	longitude range from -180 to 180

Return

Parameter	Type	Versions	Description
200 - Returned when results were found or not
items[]	array of objects (Shop)	*
items[][id]	integer	*
items[][external_number]	string	*
items[][name]	string	*
items[][status]	string	*	Example: ACTIVE, INACTIVE
items[][category]	object (Category)	*
items[][category][id]	integer	*
items[][category][name]	string	*
items[][category][icon]	object (Media)	*
items[][category][icon][id]	integer	*
items[][category][icon][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][category][icon][width]	integer	*	Photo width (px)
items[][category][icon][height]	integer	*	Photo height (px)
items[][category][icon][main_color]	string	*
items[][networks][]	array of objects (Network)	*
items[][networks][][id]	integer	*
items[][networks][][name]	string	*
items[][networks][][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][networks][][logo]	object (Media)	*
items[][networks][][logo][id]	integer	*
items[][networks][][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][networks][][logo][width]	integer	*	Photo width (px)
items[][networks][][logo][height]	integer	*	Photo height (px)
items[][networks][][logo][main_color]	string	*
items[][networks][][photo]	object (Media)	*
items[][networks][][is_card]	boolean	*
items[][photo]	object (Media)	*
items[][photo][id]	integer	*
items[][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo][width]	integer	*	Photo width (px)
items[][photo][height]	integer	*	Photo height (px)
items[][photo][main_color]	string	*
items[][address]	object (Address)	*
items[][address][id]	integer	*
items[][address][country]	string	*
items[][address][district]	string	*
items[][address][city]	string	*
items[][address][street]	string	*
items[][address][house_number]	string	*
items[][address][apartment_number]	string	*
items[][address][post_code]	string	*
items[][address][latitude]	double	*
items[][address][longitude]	double	*
items[][address][map_image_url]	string	*
items[][address][distance]	string	*
items[][address][formatted_address]	string	*
items[][contact]	object (Contact)	*
items[][contact][id]	integer	*
items[][contact][phone]	string	*
items[][contact][email]	string	*
items[][contact][website_url]	string	*
items[][contact][facebook_url]	string	*

Status Codes

Status Code	Description
200	Returned when results were found or not

Show/hide List Operations Expand Operations

2. Users

/users/me

DELETE http://api.myshop.mobi/users/me

Sending request to delete account authenticated User

GET http://api.myshop.mobi/users/me deprecated

Getting information about the authenticated User

Return

Parameter	Type	Versions	Description
200 - User object
email	string	*
first_name	string	*	User first name, max 32 characters
last_name	string	*	User last name, max 32 characters
gender	string	*	Gender, Example: MALE, FEMALE
birth_date	DateTime	*	Format: YYYY-MM-DD
facebook_id	string	*
google_id	string	*
apple_id	string	*
phone_number	string	*
legal_phone	boolean	*
legal_internal_marketing	boolean	*
legal_external_marketing	boolean	*
legal_data_sharing	boolean	*
legal_profiling	boolean	*
verified_phone_number	string	*
is_verified_email	boolean	*	Whether the user has verified your email address

Status Codes

Status Code	Description
200	User object
403	Access denied

PUT http://api.myshop.mobi/users/me deprecated

Edit data authenticated User

Parameters

Parameter	Type	Required?	Format
first_name	string	false
last_name	string	false
gender	choice	true	{"male":"MALE","female":"FEMALE"}
birth_date	date	true	yyyy-MM-dd

Return

Parameter	Type	Versions	Description
200 - User update
email	string	*
first_name	string	*	User first name, max 32 characters
last_name	string	*	User last name, max 32 characters
gender	string	*	Gender, Example: MALE, FEMALE
birth_date	DateTime	*	Format: YYYY-MM-DD
facebook_id	string	*
google_id	string	*
apple_id	string	*
phone_number	string	*
legal_phone	boolean	*
legal_internal_marketing	boolean	*
legal_external_marketing	boolean	*
legal_data_sharing	boolean	*
legal_profiling	boolean	*
verified_phone_number	string	*
is_verified_email	boolean	*	Whether the user has verified your email address

Status Codes

Status Code	Description
200	User update
400	Validation Failed
403	Access denied

PUT http://api.myshop.mobi/password/recovery

Password recovery account

Parameters

Parameter	Type	Required?	Format	Description
email	string	true

Status Codes

Status Code	Description
200	Email sent
400	Validation Failed
409	code: 10103, message: Email address is not registered code: 10104, message: Too many calls in a short time code: 10105, message: The password for this user has already been requested within the last 24 hours

POST http://api.myshop.mobi/users deprecated

Register user

Parameters

Parameter	Type	Required?	Format
first_name	string	false
last_name	string	false
email	string	true
password	string	false
gender	choice	true	{"male":"MALE","female":"FEMALE"}
birth_date	date	true	yyyy-MM-dd
facebook_access_token	string	false
google_access_token	string	false

Status Codes

Status Code	Description
201	User created
400	Validation Failed
409	code: 10100, message: Access token is invalid code: 10101, message: The facebook account is registered code: 10102, message: The google account is registered

Show/hide List Operations Expand Operations

20.2.Offers by group

/dashboard/cards/{card_id}

GET http://api.myshop.mobi/dashboard/cards/{card_id}

Dashboard for cards

/dashboard/offers/{offer_id}

GET http://api.myshop.mobi/dashboard/offers/{offer_id}

................ ..............

Requirements

Name	Requirement	Type	Description
offer_id

Return

Parameter	Type	Versions	Description
200 - Successfully
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][leaflet]	object (Leaflet)	*
items[][leaflet][id]	integer	*
items[][leaflet][url]	string	*
items[][leaflet][date_start]	DateTime	*
items[][leaflet][date_end]	DateTime	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*

Status Codes

Status Code	Description
200	Successfully
403	Access denied

/dashboard/shops/{shop_id}

GET http://api.myshop.mobi/dashboard/shops/{shop_id}

Dashboard for shops

Requirements

Name	Requirement	Type	Description
shop_id

Return

Parameter	Type	Versions	Description
200 - Successfully
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][leaflet]	object (Leaflet)	*
items[][leaflet][id]	integer	*
items[][leaflet][url]	string	*
items[][leaflet][date_start]	DateTime	*
items[][leaflet][date_end]	DateTime	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*

Status Codes

Status Code	Description
200	Successfully
403	Access denied

Show/hide List Operations Expand Operations

3. Shops

/shops/search

GET http://api.myshop.mobi/shops/search

Search shops near given coordinates

Filters

Name

Information

lat

Datatype	duble
Default
Description	latitude range from -90 to 90

lon

Datatype	duble
Default
Description	longitude range from -180 to 180

distance

Datatype	string
Default	600km
Description	Distance

q

Datatype	string
Description

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Returned when results were found or not
items[]	array of objects (Shop)	*
items[][id]	integer	*
items[][external_number]	string	*
items[][name]	string	*
items[][status]	string	*	Example: ACTIVE, INACTIVE
items[][category]	object (Category)	*
items[][category][id]	integer	*
items[][category][name]	string	*
items[][category][icon]	object (Media)	*
items[][category][icon][id]	integer	*
items[][category][icon][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][category][icon][width]	integer	*	Photo width (px)
items[][category][icon][height]	integer	*	Photo height (px)
items[][category][icon][main_color]	string	*
items[][networks][]	array of objects (Network)	*
items[][networks][][id]	integer	*
items[][networks][][name]	string	*
items[][networks][][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][networks][][logo]	object (Media)	*
items[][networks][][logo][id]	integer	*
items[][networks][][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][networks][][logo][width]	integer	*	Photo width (px)
items[][networks][][logo][height]	integer	*	Photo height (px)
items[][networks][][logo][main_color]	string	*
items[][networks][][photo]	object (Media)	*
items[][networks][][is_card]	boolean	*
items[][photo]	object (Media)	*
items[][photo][id]	integer	*
items[][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo][width]	integer	*	Photo width (px)
items[][photo][height]	integer	*	Photo height (px)
items[][photo][main_color]	string	*
items[][address]	object (Address)	*
items[][address][id]	integer	*
items[][address][country]	string	*
items[][address][district]	string	*
items[][address][city]	string	*
items[][address][street]	string	*
items[][address][house_number]	string	*
items[][address][apartment_number]	string	*
items[][address][post_code]	string	*
items[][address][latitude]	double	*
items[][address][longitude]	double	*
items[][address][map_image_url]	string	*
items[][address][distance]	string	*
items[][address][formatted_address]	string	*
items[][contact]	object (Contact)	*
items[][contact][id]	integer	*
items[][contact][phone]	string	*
items[][contact][email]	string	*
items[][contact][website_url]	string	*
items[][contact][facebook_url]	string	*

Status Codes

Status Code	Description
200	Returned when results were found or not
400	Validation Failed incorrect search parameters

/shops/{shop_id}

GET http://api.myshop.mobi/shops/{shop_id}

Returns details about a single store

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Return

Parameter	Type	Versions	Description
200 - Shop object
id	integer	*
external_number	string	*
name	string	*
status	string	*	Example: ACTIVE, INACTIVE
category	object (Category)	*
category[id]	integer	*
category[name]	string	*
category[icon]	object (Media)	*
category[icon][id]	integer	*
category[icon][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
category[icon][width]	integer	*	Photo width (px)
category[icon][height]	integer	*	Photo height (px)
category[icon][main_color]	string	*
networks[]	array of objects (Network)	*
networks[][card]	object (Card)	*	Get card
networks[][card][photo_number]	object (Media)	*
networks[][card][photo_number][id]	integer	*
networks[][card][photo_number][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
networks[][card][photo_number][width]	integer	*	Photo width (px)
networks[][card][photo_number][height]	integer	*	Photo height (px)
networks[][card][photo_number][main_color]	string	*
networks[][card][status]	string	*
networks[][card][created_at]	DateTime	*
networks[][card][used_at]	DateTime	*
networks[][card][id]	integer	*	Card id
networks[][card][name]	string	*	Card name
networks[][card][description]	string	*	Card description
networks[][card][show_contest]	boolean	*	Show Contest
networks[][card][external_registration]	boolean	*	External registration, true - is required
networks[][card][number_type]	string	*	Number type: EAN13, STRING, QRCODE
networks[][card][card_provider]	string	*
networks[][card][photo]	object (Media)	*
networks[][card][show_transaction]	boolean	*
networks[][card][show_offers]	boolean	*	Show offers
networks[][card][show_offers_for_me]	boolean	*	Show Offers for Me
networks[][card][show_shops_type]	string	*	Example: NONE, LIST_TEXT, LIST_IMAGE
networks[][id]	integer	*
networks[][name]	string	*
networks[][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
networks[][logo]	object (Media)	*
networks[][logo][id]	integer	*
networks[][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
networks[][logo][width]	integer	*	Photo width (px)
networks[][logo][height]	integer	*	Photo height (px)
networks[][logo][main_color]	string	*
networks[][photo]	object (Media)	*
networks[][is_card]	boolean	*
photo	object (Media)	*
photo[id]	integer	*
photo[url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
photo[width]	integer	*	Photo width (px)
photo[height]	integer	*	Photo height (px)
photo[main_color]	string	*
opening_hours	object (OpeningHours)	*
opening_hours[open_now]	boolean	*	Value indicating if the place is open at the current time
opening_hours[periods][]	array of arrays	*
employees[]	array of objects (Employee)	*
employees[][first_name]	string	*
employees[][last_name]	string	*
employees[][photo]	object (Media)	*
address	object (Address)	*
address[id]	integer	*
address[country]	string	*
address[district]	string	*
address[city]	string	*
address[street]	string	*
address[house_number]	string	*
address[apartment_number]	string	*
address[post_code]	string	*
address[latitude]	double	*
address[longitude]	double	*
address[map_image_url]	string	*
address[formatted_address]	string	*
contact	object (Contact)	*
contact[id]	integer	*
contact[phone]	string	*
contact[email]	string	*
contact[website_url]	string	*
contact[facebook_url]	string	*

Status Codes

Status Code	Description
200	Shop object
404	code: 12001, message: Shop not found

Show/hide List Operations Expand Operations

3.1 Shops/Favorites

/shops/{shop_id}/favorites

DELETE http://api.myshop.mobi/shops/{shop_id}/favorites

Removes shop favorites

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Status Codes

Status Code	Description
204	Empty answer when successful
404	code: 12001, message: Shop not found
409	code: 12003, message: Shop is not in favorites

PUT http://api.myshop.mobi/shops/{shop_id}/favorites

Adds to the favorites store

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Status Codes

Status Code	Description
204	Empty answer when successful
404	code: 12001, message: Shop not found
409	code: 12002, message: Shop was already added to your favorites

/shops/{shop_id}/favorites/notification

DELETE http://api.myshop.mobi/shops/{shop_id}/favorites/notification

Disable notifications from the store

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Status Codes

Status Code	Description
204	Empty answer when successful
404	code: 12001, message: Shop not found code: 12003, message: Shop is not added to favorites
409	code: 12002, message: Shop was already added to your favorites

PUT http://api.myshop.mobi/shops/{shop_id}/favorites/notification

Enabling notifications from the store

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Status Codes

Status Code	Description
204	Empty answer when successful
404	code: 12001, message: Shop not found
409	code: 12003, message: Shop is not added to favorites

/users/me/shops/favorites

GET http://api.myshop.mobi/users/me/shops/favorites

Favorites

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page

limit

Datatype	integer
Default	20
Description	How many items to return

Status Codes

Status Code	Description
200	Get collection of favorite stores
403	Forbidden

Show/hide List Operations Expand Operations

3.2 Shops/Feedback

/shops/{shop_id}/feedback

POST http://api.myshop.mobi/shops/{shop_id}/feedback

Feedback

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Parameters

Parameter	Type	Required?	Format	Description
message	string	true

Status Codes

Status Code	Description
204	Empty answer when successful
400	Validation Failed

Show/hide List Operations Expand Operations

3.3 Shops/Rating

/shops/{shop_id}/ratings

GET http://api.myshop.mobi/shops/{shop_id}/ratings

Get ratings user for shop

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Return

Parameter	Type	Versions	Description
200
[]	array of objects (Rating)	*
[][type]	string	*	Example: PRODUCT, SERVICE
[][value]	integer	*	Rating permitted values are from -1 to 1

Status Codes

Status Code	Description
204	Empty answer when successful
400	Validation Failed

/shops/{shop_id}/ratings/{type}

PUT http://api.myshop.mobi/shops/{shop_id}/ratings/{type}

Setting rating user for shop

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id
type	PRODUCT\|SERVICE	string	Type

Parameters

Parameter	Type	Required?	Format	Description
value	integer	true		User Rating permitted values are from -1 to 1

Status Codes

Status Code	Description
204	Empty answer when successful
400	Validation Failed

Show/hide List Operations Expand Operations

3.4. Shops in Card

/cards/{card_id}/shops

GET http://api.myshop.mobi/cards/{card_id}/shops

Returns a collection of shops where the card is available

Requirements

Name	Requirement	Type	Description
card_id	\d+	integer	Card Id

Filters

Name

Information

lat

Datatype	duble
Default
Description	latitude range from -90 to 90

lon

Datatype	duble
Default
Description	longitude range from -180 to 180

Return

Parameter	Type	Versions	Description
200 - Returned when results were found or not
items[]	array of objects (Shop)	*
items[][id]	integer	*
items[][external_number]	string	*
items[][name]	string	*
items[][status]	string	*	Example: ACTIVE, INACTIVE
items[][category]	object (Category)	*
items[][category][id]	integer	*
items[][category][name]	string	*
items[][category][icon]	object (Media)	*
items[][category][icon][id]	integer	*
items[][category][icon][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][category][icon][width]	integer	*	Photo width (px)
items[][category][icon][height]	integer	*	Photo height (px)
items[][category][icon][main_color]	string	*
items[][networks][]	array of objects (Network)	*
items[][networks][][id]	integer	*
items[][networks][][name]	string	*
items[][networks][][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][networks][][logo]	object (Media)	*
items[][networks][][logo][id]	integer	*
items[][networks][][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][networks][][logo][width]	integer	*	Photo width (px)
items[][networks][][logo][height]	integer	*	Photo height (px)
items[][networks][][logo][main_color]	string	*
items[][networks][][photo]	object (Media)	*
items[][networks][][is_card]	boolean	*
items[][photo]	object (Media)	*
items[][photo][id]	integer	*
items[][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo][width]	integer	*	Photo width (px)
items[][photo][height]	integer	*	Photo height (px)
items[][photo][main_color]	string	*
items[][formatted_location]	string	*	@var string
items[][address]	object (Address)	*
items[][address][id]	integer	*
items[][address][country]	string	*
items[][address][district]	string	*
items[][address][city]	string	*
items[][address][street]	string	*
items[][address][house_number]	string	*
items[][address][apartment_number]	string	*
items[][address][post_code]	string	*
items[][address][latitude]	double	*
items[][address][longitude]	double	*
items[][address][map_image_url]	string	*
items[][address][distance]	string	*
items[][address][formatted_address]	string	*
items[][contact]	object (Contact)	*
items[][contact][id]	integer	*
items[][contact][phone]	string	*
items[][contact][email]	string	*
items[][contact][website_url]	string	*
items[][contact][facebook_url]	string	*

Status Codes

Status Code	Description
200	Returned when results were found or not
404	code: 13000, message: Card not found

Show/hide List Operations Expand Operations

4. Offers

/offers/{offer_id}

GET http://api.myshop.mobi/offers/{offer_id}

Returns details of the offer

Requirements

Name	Requirement	Type	Description
offer_id	\d+	integer	offer Id

Return

Parameter	Type	Versions	Description
200 - Successfully
id	integer	*
status	string	*	Example: ACTIVE, INACTIVE
type	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
title	string	*	Offer Title, Max 255 characters
message	string	*	Offer Message, Max 400 characters
network	object (Network)	*
network[id]	integer	*
network[name]	string	*
network[type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
network[logo]	object (Media)	*
network[logo][id]	integer	*
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)
network[logo][main_color]	string	*
network[photo]	object (Media)	*
network[is_card]	boolean	*
leaflet	object (Leaflet)	*
leaflet[id]	integer	*
leaflet[url]	string	*
leaflet[date_start]	DateTime	*
leaflet[date_end]	DateTime	*
leaflet[pages][]	array of objects (LeafletPage)	*
leaflet[pages][][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
leaflet[pages][][height]	integer	*
leaflet[pages][][width]	integer	*
promotion	object (Promotion)	*
promotion[id]	integer	*	Promotion Id
promotion[date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
promotion[date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
promotion[type]	string	*	Promotion type. Example: NO_CODE, CARD, CODE_USE_IN_APPLICATION, CODE_USE_IN_SHOP, LINK
promotion[code_type]	string	*	Presentation code type. Example: BARCODE, QRCODE, STRING, CODE_39, CODE_128
promotion[gift]	string	*	Gift text
promotion[discount_type]	string	*	Promotion type of discount: PERCENT, VALUE
promotion[value]	integer	*	Promotion value, percent or value. Example: 10.54
promotion[code_comment]	string	*	Promotion code comment
promotion[active_days]	object (ActiveDay)	*
promotion[link]	object (Link)	*
restrict_message	string	*
formatted_expiration_date	string	*
rules	string	*
photos[]	array of objects (Media)	*
photos[][id]	integer	*
photos[][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
photos[][width]	integer	*	Photo width (px)
photos[][height]	integer	*	Photo height (px)
photos[][main_color]	string	*

Status Codes

Status Code	Description
200	Successfully
404	code: 14003, message: Offer not found

/offers/{offer_id}/shops

GET http://api.myshop.mobi/offers/{offer_id}/shops deprecated

Returns a collection of shops where the offer is available

Requirements

Name	Requirement	Type	Description
offer_id		int

Filters

Name

Information

lat

Datatype	duble
Default
Description	latitude range from -90 to 90

lon

Datatype	duble
Default
Description	longitude range from -180 to 180

Return

Parameter	Type	Versions	Description
200 - Returned when results were found or not
items[]	array of objects (Shop)	*
items[][id]	integer	*
items[][external_number]	string	*
items[][name]	string	*
items[][status]	string	*	Example: ACTIVE, INACTIVE
items[][category]	object (Category)	*
items[][category][id]	integer	*
items[][category][name]	string	*
items[][category][icon]	object (Media)	*
items[][category][icon][id]	integer	*
items[][category][icon][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][category][icon][width]	integer	*	Photo width (px)
items[][category][icon][height]	integer	*	Photo height (px)
items[][category][icon][main_color]	string	*
items[][networks][]	array of objects (Network)	*
items[][networks][][id]	integer	*
items[][networks][][name]	string	*
items[][networks][][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][networks][][logo]	object (Media)	*
items[][networks][][logo][id]	integer	*
items[][networks][][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][networks][][logo][width]	integer	*	Photo width (px)
items[][networks][][logo][height]	integer	*	Photo height (px)
items[][networks][][logo][main_color]	string	*
items[][networks][][photo]	object (Media)	*
items[][networks][][is_card]	boolean	*
items[][photo]	object (Media)	*
items[][photo][id]	integer	*
items[][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo][width]	integer	*	Photo width (px)
items[][photo][height]	integer	*	Photo height (px)
items[][photo][main_color]	string	*
items[][address]	object (Address)	*
items[][address][id]	integer	*
items[][address][country]	string	*
items[][address][district]	string	*
items[][address][city]	string	*
items[][address][street]	string	*
items[][address][house_number]	string	*
items[][address][apartment_number]	string	*
items[][address][post_code]	string	*
items[][address][latitude]	double	*
items[][address][longitude]	double	*
items[][address][map_image_url]	string	*
items[][address][distance]	string	*
items[][address][formatted_address]	string	*
items[][contact]	object (Contact)	*
items[][contact][id]	integer	*
items[][contact][phone]	string	*
items[][contact][email]	string	*
items[][contact][website_url]	string	*
items[][contact][facebook_url]	string	*

Status Codes

Status Code	Description
200	Returned when results were found or not
404	code: 14003, message: Offer not found

/promotions/{promotion_id}/codes

GET http://api.myshop.mobi/promotions/{promotion_id}/codes

Get code

Requirements

Name	Requirement	Type	Description
promotion_id	\d+	integer	Promotion Id

Return

Parameter	Type	Versions
200 - Success
code	string	*
used_at	DateTime	*

Status Codes

Status Code	Description
200	Success
403	Access denied
404	code: 14100, message: Promotion not found
409	code: 14101, message: Promotion does not have a code code: 14104, message: Promotion has expired code: 14105, message: Promotion currently unavailable code: 14106, message: User account unconfirmed

PUT http://api.myshop.mobi/promotions/{promotion_id}/codes

Use code

Requirements

Name	Requirement	Type	Description
promotion_id	\d+	integer	Promotion Id

Status Codes

Status Code	Description
204	No content
403	Access denied
404	code: 14100, message: Promotion not found code: 14102, message: Code not found code: 14105, message: Promotion currently unavailable
409	code: 14101, message: Promotion does not have a code code: 14103, message: Code already used code: 14104, message: Promotion has expired

Show/hide List Operations Expand Operations

4.1. Offers Stream

/users/me/offers/codes

GET http://api.myshop.mobi/users/me/offers/codes

Returns a collection of promotions with code from your favorite shops

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][promotion]	object (Promotion)	*
items[][promotion][id]	integer	*	Promotion Id
items[][promotion][date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
items[][promotion][date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
items[][promotion][type]	string	*	Promotion type. Example: NO_CODE, CARD, CODE_USE_IN_APPLICATION, CODE_USE_IN_SHOP, LINK
items[][promotion][code_type]	string	*	Presentation code type. Example: BARCODE, QRCODE, STRING, CODE_39, CODE_128
items[][promotion][gift]	string	*	Gift text
items[][promotion][discount_type]	string	*	Promotion type of discount: PERCENT, VALUE
items[][promotion][value]	integer	*	Promotion value, percent or value. Example: 10.54
items[][promotion][code_comment]	string	*	Promotion code comment
items[][promotion][active_days]	object (ActiveDay)	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*

Status Codes

Status Code	Description
200	Successfully
403	Access denied

/users/me/offers/leaflets

GET http://api.myshop.mobi/users/me/offers/leaflets

Returns a collection of leaflets for your favorite shops

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][leaflet]	object (Leaflet)	*
items[][leaflet][id]	integer	*
items[][leaflet][url]	string	*
items[][leaflet][date_start]	DateTime	*
items[][leaflet][date_end]	DateTime	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*

Status Codes

Status Code	Description
200	Successfully
403	Access denied

/users/me/offers/promotions

GET http://api.myshop.mobi/users/me/offers/promotions

Returns a collection of promotions without code from your favorite shops

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][promotion]	object (Promotion)	*
items[][promotion][id]	integer	*	Promotion Id
items[][promotion][date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
items[][promotion][date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
items[][promotion][type]	string	*	Promotion type. Example: NO_CODE, CARD, CODE_USE_IN_APPLICATION, CODE_USE_IN_SHOP, LINK
items[][promotion][code_type]	string	*	Presentation code type. Example: BARCODE, QRCODE, STRING, CODE_39, CODE_128
items[][promotion][gift]	string	*	Gift text
items[][promotion][discount_type]	string	*	Promotion type of discount: PERCENT, VALUE
items[][promotion][value]	integer	*	Promotion value, percent or value. Example: 10.54
items[][promotion][code_comment]	string	*	Promotion code comment
items[][promotion][active_days]	object (ActiveDay)	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*

Status Codes

Status Code	Description
200	Successfully
403	Access denied

Show/hide List Operations Expand Operations

4.2. Offers in Shops

/shops/{shop_id}/offers

GET http://api.myshop.mobi/shops/{shop_id}/offers

Returns a collection of offers for store

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][network]	object (Network)	*
items[][network][id]	integer	*
items[][network][name]	string	*
items[][network][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][network][logo]	object (Media)	*
items[][network][logo][id]	integer	*
items[][network][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][network][logo][width]	integer	*	Photo width (px)
items[][network][logo][height]	integer	*	Photo height (px)
items[][network][logo][main_color]	string	*
items[][network][photo]	object (Media)	*
items[][network][is_card]	boolean	*
items[][leaflet]	object (Leaflet)	*
items[][leaflet][id]	integer	*
items[][leaflet][url]	string	*
items[][leaflet][date_start]	DateTime	*
items[][leaflet][date_end]	DateTime	*
items[][promotion]	object (Promotion)	*
items[][promotion][id]	integer	*	Promotion Id
items[][promotion][date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
items[][promotion][date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
items[][promotion][type]	string	*	Promotion type. Example: NO_CODE, CARD, CODE_USE_IN_APPLICATION, CODE_USE_IN_SHOP, LINK
items[][promotion][code_type]	string	*	Presentation code type. Example: BARCODE, QRCODE, STRING, CODE_39, CODE_128
items[][promotion][gift]	string	*	Gift text
items[][promotion][discount_type]	string	*	Promotion type of discount: PERCENT, VALUE
items[][promotion][value]	integer	*	Promotion value, percent or value. Example: 10.54
items[][promotion][code_comment]	string	*	Promotion code comment
items[][promotion][active_days]	object (ActiveDay)	*
items[][promotion][active_days][is_active]	boolean	*	Value indicating if the promotion is active at the current time
items[][promotion][active_days][periods][]	array of arrays	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*

Status Codes

Status Code	Description
200	Successfully

/users/me/shops/{shop_id}/offers

GET http://api.myshop.mobi/users/me/shops/{shop_id}/offers

Returns a collection of offers for you from shop

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][network]	object (Network)	*
items[][network][id]	integer	*
items[][network][name]	string	*
items[][network][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][network][logo]	object (Media)	*
items[][network][logo][id]	integer	*
items[][network][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][network][logo][width]	integer	*	Photo width (px)
items[][network][logo][height]	integer	*	Photo height (px)
items[][network][logo][main_color]	string	*
items[][network][is_card]	boolean	*
items[][leaflet]	object (Leaflet)	*
items[][leaflet][id]	integer	*
items[][leaflet][url]	string	*
items[][leaflet][date_start]	DateTime	*
items[][leaflet][date_end]	DateTime	*
items[][promotion]	object (Promotion)	*
items[][promotion][id]	integer	*	Promotion Id
items[][promotion][date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
items[][promotion][date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
items[][promotion][type]	string	*	Promotion type. Example: NO_CODE, CARD, CODE_USE_IN_APPLICATION, CODE_USE_IN_SHOP, LINK
items[][promotion][code_type]	string	*	Presentation code type. Example: BARCODE, QRCODE, STRING, CODE_39, CODE_128
items[][promotion][gift]	string	*	Gift text
items[][promotion][discount_type]	string	*	Promotion type of discount: PERCENT, VALUE
items[][promotion][value]	integer	*	Promotion value, percent or value. Example: 10.54
items[][promotion][code_comment]	string	*	Promotion code comment
items[][promotion][active_days]	object (ActiveDay)	*
items[][promotion][active_days][is_active]	boolean	*	Value indicating if the promotion is active at the current time
items[][promotion][active_days][periods][]	array of arrays	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*
items[][photo]	object (Media)	*
items[][photo][id]	integer	*
items[][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo][width]	integer	*	Photo width (px)
items[][photo][height]	integer	*	Photo height (px)
items[][photo][main_color]	string	*

Status Codes

Status Code	Description
200	Successfully
403	Access denied

Show/hide List Operations Expand Operations

4.3. My Offers in Cards

/users/me/cards/{card_id}/offers

GET http://api.myshop.mobi/users/me/cards/{card_id}/offers

Returns a collection of offers for you from cards

Requirements

Name	Requirement	Type	Description
card_id	\d+	integer	Card Id

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully. Returned when results were found or not
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][network]	object (Network)	*
items[][network][id]	integer	*
items[][network][name]	string	*
items[][network][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][network][logo]	object (Media)	*
items[][network][logo][id]	integer	*
items[][network][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][network][logo][width]	integer	*	Photo width (px)
items[][network][logo][height]	integer	*	Photo height (px)
items[][network][logo][main_color]	string	*
items[][network][is_card]	boolean	*
items[][leaflet]	object (Leaflet)	*
items[][leaflet][id]	integer	*
items[][leaflet][url]	string	*
items[][leaflet][date_start]	DateTime	*
items[][leaflet][date_end]	DateTime	*
items[][promotion]	object (Promotion)	*
items[][promotion][id]	integer	*	Promotion Id
items[][promotion][date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
items[][promotion][date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
items[][promotion][type]	string	*	Promotion type. Example: NO_CODE, CARD, CODE_USE_IN_APPLICATION, CODE_USE_IN_SHOP, LINK
items[][promotion][code_type]	string	*	Presentation code type. Example: BARCODE, QRCODE, STRING, CODE_39, CODE_128
items[][promotion][gift]	string	*	Gift text
items[][promotion][discount_type]	string	*	Promotion type of discount: PERCENT, VALUE
items[][promotion][value]	integer	*	Promotion value, percent or value. Example: 10.54
items[][promotion][code_comment]	string	*	Promotion code comment
items[][promotion][active_days]	object (ActiveDay)	*
items[][promotion][active_days][is_active]	boolean	*	Value indicating if the promotion is active at the current time
items[][promotion][active_days][periods][]	array of arrays	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*
items[][photo]	object (Media)	*
items[][photo][id]	integer	*
items[][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo][width]	integer	*	Photo width (px)
items[][photo][height]	integer	*	Photo height (px)
items[][photo][main_color]	string	*

Status Codes

Status Code	Description
200	Successfully. Returned when results were found or not
403	Access denied
404	code: 13000, message: Card not found

Show/hide List Operations Expand Operations

4.4.Offers in Cards

/cards/{card_id}/offers

GET http://api.myshop.mobi/cards/{card_id}/offers

Returns a collection of offers from cards

Requirements

Name	Requirement	Type	Description
card_id	\d+	integer	Card Id

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully. Returned when results were found or not
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][network]	object (Network)	*
items[][network][id]	integer	*
items[][network][name]	string	*
items[][network][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][network][logo]	object (Media)	*
items[][network][logo][id]	integer	*
items[][network][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][network][logo][width]	integer	*	Photo width (px)
items[][network][logo][height]	integer	*	Photo height (px)
items[][network][logo][main_color]	string	*
items[][network][is_card]	boolean	*
items[][leaflet]	object (Leaflet)	*
items[][leaflet][id]	integer	*
items[][leaflet][url]	string	*
items[][leaflet][date_start]	DateTime	*
items[][leaflet][date_end]	DateTime	*
items[][promotion]	object (Promotion)	*
items[][promotion][id]	integer	*	Promotion Id
items[][promotion][date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
items[][promotion][date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
items[][promotion][type]	string	*	Promotion type. Example: NO_CODE, CARD, CODE_USE_IN_APPLICATION, CODE_USE_IN_SHOP, LINK
items[][promotion][code_type]	string	*	Presentation code type. Example: BARCODE, QRCODE, STRING, CODE_39, CODE_128
items[][promotion][gift]	string	*	Gift text
items[][promotion][discount_type]	string	*	Promotion type of discount: PERCENT, VALUE
items[][promotion][value]	integer	*	Promotion value, percent or value. Example: 10.54
items[][promotion][code_comment]	string	*	Promotion code comment
items[][promotion][active_days]	object (ActiveDay)	*
items[][promotion][active_days][is_active]	boolean	*	Value indicating if the promotion is active at the current time
items[][promotion][active_days][periods][]	array of arrays	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*
items[][photo]	object (Media)	*
items[][photo][id]	integer	*
items[][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo][width]	integer	*	Photo width (px)
items[][photo][height]	integer	*	Photo height (px)
items[][photo][main_color]	string	*

Status Codes

Status Code	Description
200	Successfully. Returned when results were found or not
403	Access denied
404	code: 13000, message: Card not found

Show/hide List Operations Expand Operations

4.52.Offers by leaflets

/offers/leaflets

GET http://api.myshop.mobi/offers/leaflets

Returns a collection of offers by leaflets

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully. Returned when results were found or not
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][network]	object (Network)	*
items[][network][id]	integer	*
items[][network][name]	string	*
items[][network][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][network][logo]	object (Media)	*
items[][network][logo][id]	integer	*
items[][network][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][network][logo][width]	integer	*	Photo width (px)
items[][network][logo][height]	integer	*	Photo height (px)
items[][network][logo][main_color]	string	*
items[][network][is_card]	boolean	*
items[][leaflet]	object (Leaflet)	*
items[][leaflet][id]	integer	*
items[][leaflet][url]	string	*
items[][leaflet][date_start]	DateTime	*
items[][leaflet][date_end]	DateTime	*
items[][promotion]	object (Promotion)	*
items[][promotion][id]	integer	*	Promotion Id
items[][promotion][date_start]	DateTime	*	Date Start, Example: 2016-05-10T11:48:16 0000
items[][promotion][date_end]	DateTime	*	Date End, Example: 2016-05-10T11:48:16 0000
items[][promotion][type]	string	*	Promotion type. Example: NO_CODE, CARD, CODE_USE_IN_APPLICATION, CODE_USE_IN_SHOP, LINK
items[][promotion][code_type]	string	*	Presentation code type. Example: BARCODE, QRCODE, STRING, CODE_39, CODE_128
items[][promotion][gift]	string	*	Gift text
items[][promotion][discount_type]	string	*	Promotion type of discount: PERCENT, VALUE
items[][promotion][value]	integer	*	Promotion value, percent or value. Example: 10.54
items[][promotion][code_comment]	string	*	Promotion code comment
items[][promotion][active_days]	object (ActiveDay)	*
items[][promotion][active_days][is_active]	boolean	*	Value indicating if the promotion is active at the current time
items[][promotion][active_days][periods][]	array of arrays	*
items[][restrict_message]	string	*
items[][formatted_expiration_date]	string	*
items[][rules]	string	*
items[][photo]	object (Media)	*
items[][photo][id]	integer	*
items[][photo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo][width]	integer	*	Photo width (px)
items[][photo][height]	integer	*	Photo height (px)
items[][photo][main_color]	string	*

Status Codes

Status Code	Description
200	Successfully. Returned when results were found or not
403	Access denied
404	code: 13000, message: Card not found

Show/hide List Operations Expand Operations

499. Poster

/poster/screen

POST http://api.myshop.mobi/poster/screen

Register screen

/poster/screen-new/{screen_token}

GET http://api.myshop.mobi/poster/screen-new/{screen_token}

Get screen data test

/poster/screen/{screen_token}

GET http://api.myshop.mobi/poster/screen/{screen_token}

Get screen data

/poster/screen/{screen_token}/playlist

GET http://api.myshop.mobi/poster/screen/{screen_token}/playlist deprecated

......

Show/hide List Operations Expand Operations

5. Messages

/messages/{messages_id}

PATCH http://api.myshop.mobi/messages/{messages_id}

Marking a message as read

Requirements

Name	Requirement	Type	Description
messages_id	\d+	integer	Message Id

Status Codes

Status Code	Description
204	Empty answer when successful
403	Access denied
404	code: 14001, message: Message not found
409	code: 14002, message: Message has already been read

/shops/{shop_id}/messages

GET http://api.myshop.mobi/shops/{shop_id}/messages

Returns a collection of messages for store

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][created_at]	DateTime	*
items[][read]	boolean	*

Status Codes

Status Code	Description
200	Successfully

/users/me/messages

GET http://api.myshop.mobi/users/me/messages

Returns a collection of messages for your favorite shops

Requirements

Name	Requirement	Type	Description
shop_id	\d+	integer	Shop Id

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Successfully
items[]	array of objects (Offer)	*
items[][id]	integer	*
items[][title]	string	*	Offer Title, Max 255 characters
items[][message]	string	*	Offer Message, Max 400 characters
items[][created_at]	DateTime	*
items[][read]	boolean	*

Status Codes

Status Code	Description
200	Successfully
403	Access denied

Show/hide List Operations Expand Operations

6. Article

/articles/{article_id}

GET http://api.myshop.mobi/articles/{article_id}

Returning single article

Requirements

Name	Requirement	Type	Description
article_id	\d+

Return

Parameter	Type	Versions
200 - Returns details about a single article
id	integer	*
title	string	*
content	string	*
created_at	DateTime	*

Status Codes

Status Code	Description
200	Returns details about a single article
404	code: 15000, message: Article not found

/articles/{section_name}

GET http://api.myshop.mobi/articles/{section_name}

Returning a collection of articles

Requirements

Name	Requirement	Type	Description
section_name	FAQ\|ABOUT_US

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions
200 - Returned when results were found or not
items[]	array of objects (Article)	*
items[][id]	integer	*
items[][title]	string	*
items[][created_at]	DateTime	*

Status Codes

Status Code	Description
200	Returned when results were found or not

Show/hide List Operations Expand Operations

7. Cards

/cards/{card_id}

GET http://api.myshop.mobi/cards/{card_id}

Get card

Requirements

Name	Requirement	Type	Description
card_id

Return

Parameter	Type	Versions	Description
200 - Card object
photo_number	object (Media)	*
status	string	*
created_at	DateTime	*
used_at	DateTime	*
id	integer	*	Card id
name	string	*	Card name
description	string	*	Card description
show_contest	boolean	*	Show Contest
external_registration	boolean	*	External registration, true - is required
number_type	string	*	Number type: EAN13, STRING, QRCODE
card_provider	string	*
photo	object (Media)	*
show_transaction	boolean	*
show_offers	boolean	*	Show offers
show_offers_for_me	boolean	*	Show Offers for Me
show_shops_type	string	*	Example: NONE, LIST_TEXT, LIST_IMAGE

Status Codes

Status Code	Description
200	Card object
404	code: 13000, message: Card not found

PUT http://api.myshop.mobi/cards/{card_id}

Edit card

Requirements

Name	Requirement	Type	Description
card_id

Parameters

Parameter	Type	Required?	Format	Description
email	string	true	name@tld	Email address
phone_number	string	true	example: 732580425	Phone number
first_name	string	true	example: Robert	First name
last_name	string	true	example: Lewandowski	Last name
city	string	false	example: Warszawa	City
street	string	false	example: Marszałkowska	Street
number	string	false	example: 34	Number
post_code	string	false	example: 01-023	Post code
gender	choice	false	{"male":"MALE","female":"FEMALE"}	Gender
birth_date	date	false	YYYY-MM-DD	Birth date
country	string	true	example: PL, DE, ES	Country

Status Codes

Status Code	Description
204	No content
400	Validation Failed
404	code: 13000, message: Card not found

/networks/{network_id}/cards/add

POST http://api.myshop.mobi/networks/{network_id}/cards/add

Adding an existing card (plastic card)

Requirements

Name	Requirement	Type	Description
network_id

Parameters

Parameter	Type	Required?	Format	Description
card	string	true
phone_number	string	true

Return

Parameter	Type	Versions	Description
200
photo_number	object (Media)	*
status	string	*
created_at	DateTime	*
used_at	DateTime	*
id	integer	*	Card id
name	string	*	Card name
description	string	*	Card description
show_contest	boolean	*	Show Contest
external_registration	boolean	*	External registration, true - is required
number_type	string	*	Number type: EAN13, STRING, QRCODE
card_provider	string	*
photo	object (Media)	*
show_transaction	boolean	*
show_offers	boolean	*	Show offers
show_offers_for_me	boolean	*	Show Offers for Me
show_shops_type	string	*	Example: NONE, LIST_TEXT, LIST_IMAGE

Status Codes

Status Code	Description
201	Created
400	Validation Failed
404	code: 12100, message: Network not found code: 12101, message: Network is not active code: 12102, message: Network not found card code: 13000, message: Card not found
409	code: 13001, message: User already have a card

/networks/{network_id}/cards/create

POST http://api.myshop.mobi/networks/{network_id}/cards/create

Create new card (virtual card)

Requirements

Name	Requirement	Type	Description
network_id

Parameters

Parameter	Type	Required?	Format	Description
email	string	true	name@tld	Email address
phone_number	string	true	example: 732580425	Phone number
first_name	string	true	example: Robert	First name
last_name	string	true	example: Lewandowski	Last name
city	string	false	example: Warszawa	City
street	string	false	example: Marszałkowska	Street
number	string	false	example: 34	Number
post_code	string	false	example: 01-023	Post code
gender	choice	false	{"male":"MALE","female":"FEMALE"}	Gender
birth_date	date	false	YYYY-MM-DD	Birth date
country	string	true	example: PL, DE, ES	Country

Return

Parameter	Type	Versions	Description
200
photo_number	object (Media)	*
status	string	*
created_at	DateTime	*
used_at	DateTime	*
id	integer	*	Card id
name	string	*	Card name
description	string	*	Card description
show_contest	boolean	*	Show Contest
external_registration	boolean	*	External registration, true - is required
number_type	string	*	Number type: EAN13, STRING, QRCODE
card_provider	string	*
photo	object (Media)	*
show_transaction	boolean	*
show_offers	boolean	*	Show offers
show_offers_for_me	boolean	*	Show Offers for Me
show_shops_type	string	*	Example: NONE, LIST_TEXT, LIST_IMAGE

Status Codes

Status Code	Description
201	Created
400	Validation Failed
404	code: 12100, message: Network not found code: 12101, message: Network is not active code: 12102, message: Network not found card
409	code: 13001, message: User already have a card

/users/me/cards

GET http://api.myshop.mobi/users/me/cards

Get the user cards

Return

Parameter	Type	Versions	Description
200 - Return items
items[]	array of objects (CardUser)	*
items[][card]	string	*
items[][network]	object (Network)	*	Virtual method API v1.0
items[][network][id]	integer	*
items[][network][name]	string	*
items[][network][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][network][is_card]	boolean	*
items[][status]	string	*	Card status, example: not_registred, required_questionnaire, processed, error, active, blocked
items[][first_name]	string	*	User first name, max 32 characters
items[][last_name]	string	*	User last name, max 32 characters
items[][city]	string	*	City, max 32 characters
items[][street]	string	*	Street, max 32 characters
items[][number]	string	*	Number, max 15 characters
items[][post_code]	string	*	Postcode
items[][phone_number]	integer	*	Phone number
items[][gender]	string	*	Gender, Example: MALE, FEMALE
items[][birth_date]	DateTime	*	Birth date, example: YYYY-MM-DD
items[][email]	string	*	Email address
items[][country]	string	*	Country, example: PL - Poland
items[][created_at]	DateTime	*	Created datetime
items[][updated_at]	DateTime	*	Updated datetime

Status Codes

Status Code	Description
200	Return items

Show/hide List Operations Expand Operations

8. Sliders

/sliders

GET http://api.myshop.mobi/sliders

Sliders

Return

Parameter	Type	Versions	Description
200 - Returned when results were found or not
id	integer	*
title	string	*
type	string	*	Example: STATIC_BANNER, SHOP, URL, BIRTH_DATE
url	string	*
shop	object (Shop)	*
photo	object (Media)	*
photo[id]	integer	*
photo[url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
photo[width]	integer	*	Photo width (px)
photo[height]	integer	*	Photo height (px)
photo[main_color]	string	*

Status Codes

Status Code	Description
200	Returned when results were found or not

Show/hide List Operations Expand Operations

9. Transactions

/cards/{card_id}/shops/{shop_id}/transactions

GET http://api.myshop.mobi/cards/{card_id}/shops/{shop_id}/transactions

Get transactions

Requirements

Name	Requirement	Type	Description
card_id	true	integer	Card Id
shop_id	true	integer	Shop Id

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Transactions
items[]	array of objects (Transaction)	*
items[][id]	integer	*
items[][type]	string	*
items[][shop]	object (Shop)	*
items[][shop][id]	integer	*
items[][shop][external_number]	string	*
items[][shop][name]	string	*
items[][shop][status]	string	*	Example: ACTIVE, INACTIVE
items[][shop][networks][]	array of objects (Network)	*
items[][shop][networks][][card]	object (Card)	*	Get card
items[][shop][networks][][id]	integer	*
items[][shop][networks][][name]	string	*
items[][shop][networks][][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][shop][networks][][logo]	object (Media)	*
items[][shop][networks][][logo][id]	integer	*
items[][shop][networks][][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][shop][networks][][logo][width]	integer	*	Photo width (px)
items[][shop][networks][][logo][height]	integer	*	Photo height (px)
items[][shop][networks][][logo][main_color]	string	*
items[][receipt_number]	string	*	Receipt number
items[][transaction_at]	DateTime	*	Transaction datetime, mask: YYYY-MM-DD H:i:s
items[][created_at]	DateTime	*	Created datetime

Status Codes

Status Code	Description
200	Transactions
404	code: 13000, message: Card not found code: 12001, message: Shop not found

/cards/{card_id}/transactions

GET http://api.myshop.mobi/cards/{card_id}/transactions

Get transactions

Requirements

Name	Requirement	Type	Description
card_id	true	integer	Card ID

Filters

Name

Information

page

Datatype	integer
Default	1
Description	Current page.

limit

Datatype	integer
Default	20
Description	How many items to return.

Return

Parameter	Type	Versions	Description
200 - Transactions
items[]	array of objects (Transaction)	*
items[][id]	integer	*
items[][type]	string	*
items[][shop]	object (Shop)	*
items[][shop][id]	integer	*
items[][shop][external_number]	string	*
items[][shop][name]	string	*
items[][shop][status]	string	*	Example: ACTIVE, INACTIVE
items[][shop][networks][]	array of objects (Network)	*
items[][shop][networks][][card]	object (Card)	*	Get card
items[][shop][networks][][id]	integer	*
items[][shop][networks][][name]	string	*
items[][shop][networks][][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
items[][shop][networks][][logo]	object (Media)	*
items[][shop][networks][][logo][id]	integer	*
items[][shop][networks][][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][shop][networks][][logo][width]	integer	*	Photo width (px)
items[][shop][networks][][logo][height]	integer	*	Photo height (px)
items[][shop][networks][][logo][main_color]	string	*
items[][receipt_number]	string	*	Receipt number
items[][transaction_at]	DateTime	*	Transaction datetime, mask: YYYY-MM-DD H:i:s
items[][created_at]	DateTime	*	Created datetime

Status Codes

Status Code	Description
200	Transactions
404	code: 13000, message: Card not found

/transactions/{transaction_id}

GET http://api.myshop.mobi/transactions/{transaction_id}

Get transaction

Requirements

Name	Requirement	Type	Description
transaction_id	true	integer	Transaction Id

Return

Parameter	Type	Versions	Description
200 - Transactions
id	integer	*
type	string	*
shop	object (Shop)	*
shop[id]	integer	*
shop[external_number]	string	*
shop[name]	string	*
shop[status]	string	*	Example: ACTIVE, INACTIVE
shop[networks][]	array of objects (Network)	*
shop[networks][][card]	object (Card)	*	Get card
shop[networks][][id]	integer	*
shop[networks][][name]	string	*
shop[networks][][type]	string	*	Example: NETWORK, POINT, SHOPPING_CENTER, ONLINE, SUBNETWORK, BILLING, FRANCHISE
shop[networks][][logo]	object (Media)	*
shop[networks][][logo][id]	integer	*
shop[networks][][logo][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
shop[networks][][logo][width]	integer	*	Photo width (px)
shop[networks][][logo][height]	integer	*	Photo height (px)
shop[networks][][logo][main_color]	string	*
shop[address]	object (Address)	*
shop[address][id]	integer	*
shop[address][country]	string	*
shop[address][district]	string	*
shop[address][city]	string	*
shop[address][street]	string	*
shop[address][house_number]	string	*
shop[address][apartment_number]	string	*
shop[address][post_code]	string	*
shop[address][latitude]	double	*
shop[address][longitude]	double	*
shop[address][map_image_url]	string	*
shop[address][formatted_address]	string	*
shop[contact]	object (Contact)	*
shop[contact][id]	integer	*
shop[contact][phone]	string	*
shop[contact][email]	string	*
shop[contact][website_url]	string	*
shop[contact][facebook_url]	string	*
details[]	array of objects (TransactionDetail)	*
details[][id]	integer	*	Id
details[][code]	string	*	Product Code
details[][name]	string	*	Product name
details[][unit]	string	*
details[][discount_amount]	string	*
details[][quantity]	string	*
details[][tax]	float	*
details[][offer]	object (Offer)	*
details[][offer][id]	integer	*
details[][offer][type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
details[][offer][title]	string	*	Offer Title, Max 255 characters
details[][offer][message]	string	*	Offer Message, Max 400 characters
details[][offer][restrict_message]	string	*
details[][offer][formatted_expiration_date]	string	*
details[][offer][rules]	string	*
uid	string	*	Unique identifier transaction
receipt_number	string	*	Receipt number
tax_id	string	*	TAX Id
header	string	*	Header
cash_register_id	string	*	Cash Register Id
cashier_id	string	*	Cashier Id
payments[]	array of arrays	*
offer	object (Offer)	*
offer[id]	integer	*
offer[type]	string	*	Example: PROMOTION, LEAFLET, MESSAGE, CONTEST
offer[title]	string	*	Offer Title, Max 255 characters
offer[message]	string	*	Offer Message, Max 400 characters
offer[restrict_message]	string	*
offer[formatted_expiration_date]	string	*
offer[rules]	string	*
transaction_at	DateTime	*	Transaction datetime, mask: YYYY-MM-DD H:i:s
created_at	DateTime	*	Created datetime

Status Codes

Status Code	Description
200	Transactions
404	code: 16000, message: Transaction not found

Myshop.mobi API Documentation

1. OAuth2

/oauth/v2/token

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

Parameters

Status Codes

10. Questionnaires

/cards/{card_id}/questionnaires

GET http://api.myshop.mobi/cards/{card_id}/questionnaires

Requirements

Return

200 - Questionnaires

Status Codes

POST http://api.myshop.mobi/cards/{card_id}/questionnaires

Requirements

Parameters

Status Codes

11. Contests

/cards/{card_id}/offers/contests

GET http://api.myshop.mobi/cards/{card_id}/offers/contests

Requirements

Filters

Return

200 - Return items

Status Codes

/contests/{offer_id}

GET http://api.myshop.mobi/contests/{offer_id}

Requirements

Return

200 - Contest

Status Codes

12.3.Offers by group

/dashboard/sections/cards/{section_name}

GET http://api.myshop.mobi/dashboard/sections/cards/{section_name}

Requirements

Filters

Return

200 - Successfully. Returned when results were found or not

Status Codes

/dashboard/sections/offers/{section_name}

GET http://api.myshop.mobi/dashboard/sections/offers/{section_name}

Requirements

Filters

Return

200 - Successfully. Returned when results were found or not

Status Codes

/dashboard/sections/shops/{section_name}

GET http://api.myshop.mobi/dashboard/sections/shops/{section_name}

Requirements

Filters

Return

200 - Successfully. Returned when results were found or not

Status Codes

13 Search

/search

GET http://api.myshop.mobi/search

Filters

Return

200 - Returned when results were found or not

Status Codes

/search/autocomplete

GET http://api.myshop.mobi/search/autocomplete

Filters

Return

200 - Returned when results were found or not

Status Codes

2. Users

/users/me

DELETE http://api.myshop.mobi/users/me

Status Codes

GET http://api.myshop.mobi/users/me deprecated

Return

200 - User object

Status Codes

PUT http://api.myshop.mobi/users/me deprecated

Parameters

Return

200 - User update

Status Codes

PUT http://api.myshop.mobi/password/recovery