Show/hide List Operations Expand Operations

2. Users

/users/me

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

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_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

Edit data authenticated User

Parameters

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

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_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/users/me/confirm-phone-number

Confirm phone number data authenticated User

Parameters

Parameter	Type	Required?	Format	Description
verified_phone_number_token	string	true		token
phone_number	string	true		phone number

Status Codes

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

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

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
apple_id_token	string	false
phone_number	float	false
legal_internal_marketing	boolean	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

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
number	string	*
photo_number	object (Media)	*
photo_number[id]	integer	*
photo_number[url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
photo_number[width]	integer	*	Photo width (px)
photo_number[height]	integer	*	Photo height (px)
photo_number[main_color]	string	*
status	string	*
created_at	DateTime	*
used_at	DateTime	*
form_definition[]	array of objects (CardDataElement)	*
form_definition[][name]	string	*	Field Name
form_definition[][label]	string	*	Field Label
form_definition[][placeholder]	string	*	Placeholder
form_definition[][type]	string	*	Field Type: text, integer, checkbox, radio, select, date, textarea
form_definition[][required]	boolean	*	Field required
form_definition[][choices]	array	*	choices, label and value
form_definition[][value]	string	*
form_definition[][helper]	string	*
form_definition[][enabled]	boolean	*
marketing_policies[]	array of objects (MarketingPolicy)	*	Get marketingPolicies
marketing_policies[][name]	string	*	Field name
marketing_policies[][label]	string	*	Label
marketing_policies[][type]	string	*
marketing_policies[][description]	string	*	Description
marketing_policies[][required]	boolean	*	Required
marketing_policies[][url_rules]	string	*	URL rules
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
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[photo]	object (Media)	*
card_provider	string	*
photos[]	array of objects (Media)	*
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

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

Create card

Requirements

Name	Requirement	Type	Description
card_id

Return

Parameter	Type	Versions	Description
200
number	string	*
photo_number	object (Media)	*
photo_number[id]	integer	*
photo_number[url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
photo_number[width]	integer	*	Photo width (px)
photo_number[height]	integer	*	Photo height (px)
photo_number[main_color]	string	*
status	string	*
created_at	DateTime	*
used_at	DateTime	*
form_definition[]	array of objects (CardDataElement)	*
form_definition[][name]	string	*	Field Name
form_definition[][label]	string	*	Field Label
form_definition[][placeholder]	string	*	Placeholder
form_definition[][type]	string	*	Field Type: text, integer, checkbox, radio, select, date, textarea
form_definition[][required]	boolean	*	Field required
form_definition[][choices]	array	*	choices, label and value
form_definition[][value]	string	*
form_definition[][helper]	string	*
form_definition[][enabled]	boolean	*
marketing_policies[]	array of objects (MarketingPolicy)	*	Get marketingPolicies
marketing_policies[][name]	string	*	Field name
marketing_policies[][label]	string	*	Label
marketing_policies[][type]	string	*
marketing_policies[][description]	string	*	Description
marketing_policies[][required]	boolean	*	Required
marketing_policies[][url_rules]	string	*	URL rules
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
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[photo]	object (Media)	*
card_provider	string	*
photos[]	array of objects (Media)	*
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: 13000, message: Card not found
409	code: 13001, message: User already have a card

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

Edit card

Requirements

Name	Requirement	Type	Description
card_id

Return

Parameter	Type	Versions	Description
200 - Success
number	string	*
photo_number	object (Media)	*
photo_number[id]	integer	*
photo_number[url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
photo_number[width]	integer	*	Photo width (px)
photo_number[height]	integer	*	Photo height (px)
photo_number[main_color]	string	*
status	string	*
created_at	DateTime	*
used_at	DateTime	*
form_definition[]	array of objects (CardDataElement)	*
form_definition[][name]	string	*	Field Name
form_definition[][label]	string	*	Field Label
form_definition[][placeholder]	string	*	Placeholder
form_definition[][type]	string	*	Field Type: text, integer, checkbox, radio, select, date, textarea
form_definition[][required]	boolean	*	Field required
form_definition[][choices]	array	*	choices, label and value
form_definition[][value]	string	*
form_definition[][helper]	string	*
form_definition[][enabled]	boolean	*
marketing_policies[]	array of objects (MarketingPolicy)	*	Get marketingPolicies
marketing_policies[][name]	string	*	Field name
marketing_policies[][label]	string	*	Label
marketing_policies[][type]	string	*
marketing_policies[][description]	string	*	Description
marketing_policies[][required]	boolean	*	Required
marketing_policies[][url_rules]	string	*	URL rules
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
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[photo]	object (Media)	*
card_provider	string	*
photos[]	array of objects (Media)	*
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	Success
400	Validation Failed
404	code: 13000, message: Card not found

/cards/{card_id}/form-definition

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

Get card data

Requirements

Name	Requirement	Type	Description
card_id

Return

Parameter	Type	Versions	Description
200 - Card data object
register[]	array of objects (CardDataElement)	*	Elements data register card
register[][name]	string	*	Field Name
register[][label]	string	*	Field Label
register[][placeholder]	string	*	Placeholder
register[][type]	string	*	Field Type: text, integer, checkbox, radio, select, date, textarea
register[][required]	boolean	*	Field required
register[][choices]	array	*	choices, label and value
register[][value]	string	*
register[][helper]	string	*
register[][enabled]	boolean	*
import[]	array of objects (CardDataElement)	*	Elements data import card

Status Codes

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

/cards/{card_id}/import

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

Import card

Requirements

Name	Requirement	Type	Description
card_id

Parameters

Parameter	Type	Required?	Description
card_number	string	true	Numer KSK Arkadia
email	string	true	E-mail
submit	string	false	Dodaj Kartę

Status Codes

Status Code	Description
201	Created
400	Validation Failed
404	code: 13000, message: Card not found
409	code: 13001, message: User already have a card code: 13011, message: The card has already been registered

/cards/{card_id}/register

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

Requirements

Name	Requirement	Type	Description
card_id

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		E-mail
password	string	true		Hasło
first_name	string	true		Imię
last_name	string	true		Nazwisko
gender	choice	true	{"male":"MALE","female":"FEMALE"}	Płeć
post_code	string	true		Kod pocztowy
phone_number	float	false		Numer telefonu
birth_date	date	true	yyyy-MM-dd	Data urodzenia
submit	string	false		Dodaj Kartę

Status Codes

Status Code	Description
201	Created
400	Validation Failed
404	code: 13000, message: Card not found code: 13020, message: API Partner Card Exception
409	code: 13001, message: User already have a card code: 13019, message: Email Is Already Used

/users/me/cards

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

Get the user cards

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 (Card)	*
items[][number]	string	*
items[][photo_number]	object (Media)	*
items[][photo_number][id]	integer	*
items[][photo_number][url]	string	*	URL file, Example: https://static.myshop.mobi/media/offer/20744c395e0c1d13c4a1b9b2b866f54c.png
items[][photo_number][width]	integer	*	Photo width (px)
items[][photo_number][height]	integer	*	Photo height (px)
items[][photo_number][main_color]	string	*
items[][status]	string	*
items[][created_at]	DateTime	*
items[][used_at]	DateTime	*
items[][id]	integer	*	Card id
items[][name]	string	*	Card name
items[][description]	string	*	Card description
items[][show_contest]	boolean	*	Show Contest
items[][external_registration]	boolean	*	External registration, true - is required
items[][number_type]	string	*	Number type: EAN13, STRING, QRCODE
items[][network]	object (Network)	*
items[][network][card]	object (Card)	*	Get card
items[][network][card][number]	string	*
items[][network][card][photo_number]	object (Media)	*
items[][network][card][status]	string	*
items[][network][card][created_at]	DateTime	*
items[][network][card][used_at]	DateTime	*
items[][network][card][id]	integer	*	Card id
items[][network][card][name]	string	*	Card name
items[][network][card][description]	string	*	Card description
items[][network][card][show_contest]	boolean	*	Show Contest
items[][network][card][external_registration]	boolean	*	External registration, true - is required
items[][network][card][number_type]	string	*	Number type: EAN13, STRING, QRCODE
items[][network][card][network]	object (Network)	*
items[][network][card][card_provider]	string	*
items[][network][card][photo]	object (Media)	*
items[][network][card][show_transaction]	boolean	*
items[][network][card][show_offers]	boolean	*	Show offers
items[][network][card][show_offers_for_me]	boolean	*	Show Offers for Me
items[][network][card][show_shops_type]	string	*	Example: NONE, LIST_TEXT, LIST_IMAGE
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][photo]	object (Media)	*
items[][card_provider]	string	*
items[][photo]	object (Media)	*
items[][show_transaction]	boolean	*
items[][show_offers]	boolean	*	Show offers
items[][show_offers_for_me]	boolean	*	Show Offers for Me
items[][show_shops_type]	string	*	Example: NONE, LIST_TEXT, LIST_IMAGE

Status Codes

Status Code	Description
200	Return items

Myshop.mobi API Documentation

2. Users

/users/me

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

Return

200 - User object

Status Codes

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

Parameters

Return

200 - User update

Status Codes

PUT http://api.myshop.mobi/users/me/confirm-phone-number

Parameters

Status Codes

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

Parameters

Status Codes

7. Cards

/cards/{card_id}

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

Requirements

Return

200 - Card object

Status Codes

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

Requirements

Return

200

Status Codes

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

Requirements

Return

200 - Success

Status Codes

/cards/{card_id}/form-definition

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

Requirements

Return

200 - Card data object

Status Codes

/cards/{card_id}/import

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

Requirements

Parameters

Status Codes

/cards/{card_id}/register

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

Requirements

Parameters

Status Codes

/users/me/cards

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

Filters

Return

200 - Return items

Status Codes