PRE-CONDITIONS

Parameter

Description

Example

mandatory

auth

Interface-ID and Interface-Password, separated by pipe (|)

665|FMJuyuC8uEbo3WxRa5aG

required

interface_id

Can be used together with interface_pw instead of auth

665

optional

interface_pw

Can be used together with interface_id instead of auth

FMJuyuC8uEbo3WxRa5aG

optional

type

Output type. Either “serialized” or “json” (Default)

json

optional

Charset

Character encoding. Either "utf-8" or "iso-8859-1" (default)

utf-8

optional

POST-CONDITIONS

Parameter

details

Sub-Parameter

Description

name

Shop's name

url

Shop's URL

logo_url

Shop's logo URL

streetAddress

Shop's street address

addressCountry

Shop's country

telephone

Shop's telephone number

postalCode

Shop's postal code

addressLocality

Shop's locality

addressRegion

Shop's region

templateLanguage

Template's language

ekomi_certificate_id

Shop's Certificate id

done

If the serialized array is done, this will be always 1

done_at

Value contains a UNIX timestamp from the moment when the request succeeds

ERRORS

CODE

Name

Description

NonAuth

Missing auth parameter

InvalidFunction

Invalid function name used in API instead of getShopDetails

Access denied

Invalid auth value

type is not valid. Possible options: ([json]) and [serialized].

Type is invalid. The type should either be [json] or [serialized].

Not Found

Data not found.