Get store by external id

GET

/dr/v1/stores

curl --request GET \
  --url https://sender.sandbox-api.kivra.com/dr/v1/stores

• Test environment (uses test data)
• Production environment

Fetch information on the given store using external store ID

Access scope

• PARTNER
• CHAIN
• STORE

Parameters

Query Parameters

external_id

string

External ID of the store

owner_id

string

Represents the id of the chain the store belongs to. Only required when using partner token

Responses

200

Successfully fetched store

Media typeapplication/json

GetStoreResponse

object

store_id

string

external_id

string

owner_id

string

partner_id

string

name

string

vat

string

phone

string

icon_url

string

logo_url

string

address

object

street1

string

street2

string

street3

string

postalcode

string

city

string

state

string

country

string

Example

{
  "store_id": "012345678901234567890123456789012345678901",
  "external_id": "ex000001",
  "owner_id": "8a499ffb488d9ca501488dc3fba0005b",
  "name": "Demo Store",
  "vat": "SE012345678989",
  "address": {
    "street1": "Gatan 1",
    "postalcode": "13254",
    "city": "One Buying",
    "country": "SWE"
  },
  "icon_url": "https://test.url.net/api/v1/resources/156257243392d65d706e044b56b168c452809d68f6",
  "logo_url": "https://test.url.net/api/v1/resources/156257243392d65d706e044b56b168c452809d68f6"
}

401

Unauthorized

Media typeapplication/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Examples

Exampleunauthorized

{
  "error_code": "40100",
  "short_message": "unauthorized",
  "long_message": "permission denied"
}

404

Not found

Media typeapplication/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Examples

Exampleresource_not_found

{
  "error_code": "40400",
  "short_message": "not found",
  "long_message": "the requested resource could not be found"
}

500

Internal server error

Media typeapplication/json

ErrorResponse

object

error_code

string

short_message

string

long_message

string

error_detail

Array<string>

Example

{
  "error_code": "50000",
  "short_message": "internal server error",
  "long_message": "unknown error ocurred"
}