GET/v1/tenants/{tenantId}/loyalty_programs/{loyaltyProgramId}/retail_stores

Get retail stores for loyalty program

Only stores with RELEASED status are included.

200Response

application/jsonobjectnon-null

retailStoresarray of objectnon-nullrequired

Show item fields

addressesarray of objectnon-nullrequired

Show item fields

citystringnon-nullrequired: Example"Oslo"
countryIsoCodestringnon-nullrequired: ISO 3166-1 alpha-2 country code
Example"NO"
postCodestringnon-nullrequired: Example"0154"
streetstringnon-nullrequired: Street address including number
Example"Karl Johans gate 1"
typestringnon-nullrequired: Example"VISIT"

emailstringnullableoptional

Example"oslo.city@example.com"

idstringnon-nullrequired

Example"01234567-89ab-cdef-0123-456789abcdef"

namestringnon-nullrequired

Example"Oslo City Store"

numberstringnon-nullrequired

Example"STORE-001"

phonestringnullableoptional

Example"+4722123456"

webAddressstringnullableoptional

Example"https://store.example.com"

401

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

403

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

404Loyalty program doesn't exist

Loyalty program doesn't exist

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

500

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"