GET /external/api/stores

GET /external/api/stores
Authorization key

Responses

  • 200

    Success

    Hide response attributes Show response attributes object
    • id string(uuid)
    • externalId string | null
    • title string | null
    • subTitle string | null
    • handle string | null
    • relatedProductsTitle string | null
    • currencyCode string | null
    • cultureName string | null
    • countryCode string

      Values are no, se, de, dk, or fi.

    • storeChain object

      Additional properties are NOT allowed.

      Hide storeChain attributes Show storeChain attributes object
      • id string(uuid)
      • name string | null
      • handle string | null
      • hasMembership boolean
      • hasCoupon boolean
      • privacyPolicyUrl string(uri) | null
      • termsAndConditionsUrl string(uri) | null
      • fulfillmentOptions array[object] | null
        Hide fulfillmentOptions attributes Show fulfillmentOptions attributes object
        • id string(uuid)
        • name string | null
        • type string

          Values are locally or shipment.

        • default boolean
    • active boolean
    • address string | null
    • postalCode string | null
    • city string | null
    • legalIdentifier string | null
    • timeZoneId string | null
    • storeFrontImage object

      Additional properties are NOT allowed.

      Hide storeFrontImage attributes Show storeFrontImage attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • headerImage object

      Additional properties are NOT allowed.

      Hide headerImage attributes Show headerImage attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • expandedImage object

      Additional properties are NOT allowed.

      Hide expandedImage attributes Show expandedImage attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • enterMessage object

      Additional properties are NOT allowed.

      Hide enterMessage attributes Show enterMessage attributes object
      • message string | null
      • active boolean
    • exitMessage object

      Additional properties are NOT allowed.

      Hide exitMessage attributes Show exitMessage attributes object
      • message string | null
      • active boolean
    • checkoutMessage object

      Additional properties are NOT allowed.

      Hide checkoutMessage attributes Show checkoutMessage attributes object
      • message string | null
      • active boolean
    • storeProfile object

      Additional properties are NOT allowed.

      Hide storeProfile attributes Show storeProfile attributes object
      • id string(uuid)
      • name string | null
      • primaryColor string | null
      • backgroundColor string | null
      • primaryTextColor string | null
      • logoImage object

        Additional properties are NOT allowed.

        Hide logoImage attributes Show logoImage attributes object
        • id string(uuid)
        • fileName string | null
        • url string | null
        • externalImageId string | null
        • sizes object | null
          Hide sizes attribute Show sizes attribute object | null
          • * string | null Additional properties
    Hide response attributes Show response attributes object
    • id string(uuid)
    • externalId string | null
    • title string | null
    • subTitle string | null
    • handle string | null
    • relatedProductsTitle string | null
    • currencyCode string | null
    • cultureName string | null
    • countryCode string

      Values are no, se, de, dk, or fi.

    • storeChain object

      Additional properties are NOT allowed.

      Hide storeChain attributes Show storeChain attributes object
      • id string(uuid)
      • name string | null
      • handle string | null
      • hasMembership boolean
      • hasCoupon boolean
      • privacyPolicyUrl string(uri) | null
      • termsAndConditionsUrl string(uri) | null
      • fulfillmentOptions array[object] | null
        Hide fulfillmentOptions attributes Show fulfillmentOptions attributes object
        • id string(uuid)
        • name string | null
        • type string

          Values are locally or shipment.

        • default boolean
    • active boolean
    • address string | null
    • postalCode string | null
    • city string | null
    • legalIdentifier string | null
    • timeZoneId string | null
    • storeFrontImage object

      Additional properties are NOT allowed.

      Hide storeFrontImage attributes Show storeFrontImage attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • headerImage object

      Additional properties are NOT allowed.

      Hide headerImage attributes Show headerImage attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • expandedImage object

      Additional properties are NOT allowed.

      Hide expandedImage attributes Show expandedImage attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • enterMessage object

      Additional properties are NOT allowed.

      Hide enterMessage attributes Show enterMessage attributes object
      • message string | null
      • active boolean
    • exitMessage object

      Additional properties are NOT allowed.

      Hide exitMessage attributes Show exitMessage attributes object
      • message string | null
      • active boolean
    • checkoutMessage object

      Additional properties are NOT allowed.

      Hide checkoutMessage attributes Show checkoutMessage attributes object
      • message string | null
      • active boolean
    • storeProfile object

      Additional properties are NOT allowed.

      Hide storeProfile attributes Show storeProfile attributes object
      • id string(uuid)
      • name string | null
      • primaryColor string | null
      • backgroundColor string | null
      • primaryTextColor string | null
      • logoImage object

        Additional properties are NOT allowed.

        Hide logoImage attributes Show logoImage attributes object
        • id string(uuid)
        • fileName string | null
        • url string | null
        • externalImageId string | null
        • sizes object | null
          Hide sizes attribute Show sizes attribute object | null
          • * string | null Additional properties
    Hide response attributes Show response attributes object
    • id string(uuid)
    • externalId string | null
    • title string | null
    • subTitle string | null
    • handle string | null
    • relatedProductsTitle string | null
    • currencyCode string | null
    • cultureName string | null
    • countryCode string

      Values are no, se, de, dk, or fi.

    • storeChain object

      Additional properties are NOT allowed.

      Hide storeChain attributes Show storeChain attributes object
      • id string(uuid)
      • name string | null
      • handle string | null
      • hasMembership boolean
      • hasCoupon boolean
      • privacyPolicyUrl string(uri) | null
      • termsAndConditionsUrl string(uri) | null
      • fulfillmentOptions array[object] | null
        Hide fulfillmentOptions attributes Show fulfillmentOptions attributes object
        • id string(uuid)
        • name string | null
        • type string

          Values are locally or shipment.

        • default boolean
    • active boolean
    • address string | null
    • postalCode string | null
    • city string | null
    • legalIdentifier string | null
    • timeZoneId string | null
    • storeFrontImage object

      Additional properties are NOT allowed.

      Hide storeFrontImage attributes Show storeFrontImage attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • headerImage object

      Additional properties are NOT allowed.

      Hide headerImage attributes Show headerImage attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • expandedImage object

      Additional properties are NOT allowed.

      Hide expandedImage attributes Show expandedImage attributes object
      • id string(uuid)
      • fileName string | null
      • url string | null
      • externalImageId string | null
      • sizes object | null
        Hide sizes attribute Show sizes attribute object | null
        • * string | null Additional properties
    • enterMessage object

      Additional properties are NOT allowed.

      Hide enterMessage attributes Show enterMessage attributes object
      • message string | null
      • active boolean
    • exitMessage object

      Additional properties are NOT allowed.

      Hide exitMessage attributes Show exitMessage attributes object
      • message string | null
      • active boolean
    • checkoutMessage object

      Additional properties are NOT allowed.

      Hide checkoutMessage attributes Show checkoutMessage attributes object
      • message string | null
      • active boolean
    • storeProfile object

      Additional properties are NOT allowed.

      Hide storeProfile attributes Show storeProfile attributes object
      • id string(uuid)
      • name string | null
      • primaryColor string | null
      • backgroundColor string | null
      • primaryTextColor string | null
      • logoImage object

        Additional properties are NOT allowed.

        Hide logoImage attributes Show logoImage attributes object
        • id string(uuid)
        • fileName string | null
        • url string | null
        • externalImageId string | null
        • sizes object | null
          Hide sizes attribute Show sizes attribute object | null
          • * string | null Additional properties
GET /external/api/stores 
curl \
 --request GET 'https://demo.api.fygi.store/external/api/stores' \
 --header "authorization: $API_KEY"
Response examples (200) 
[
  {
    "id": "string",
    "externalId": "string",
    "title": "string",
    "subTitle": "string",
    "handle": "string",
    "relatedProductsTitle": "string",
    "currencyCode": "string",
    "cultureName": "string",
    "countryCode": "no",
    "storeChain": {
      "id": "string",
      "name": "string",
      "handle": "string",
      "hasMembership": true,
      "hasCoupon": true,
      "privacyPolicyUrl": "https://example.com",
      "termsAndConditionsUrl": "https://example.com",
      "fulfillmentOptions": [
        {
          "id": "string",
          "name": "string",
          "type": "locally",
          "default": true
        }
      ]
    },
    "active": true,
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "legalIdentifier": "string",
    "timeZoneId": "string",
    "storeFrontImage": {
      "id": "string",
      "fileName": "string",
      "url": "string",
      "externalImageId": "string",
      "sizes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    },
    "headerImage": {
      "id": "string",
      "fileName": "string",
      "url": "string",
      "externalImageId": "string",
      "sizes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    },
    "expandedImage": {
      "id": "string",
      "fileName": "string",
      "url": "string",
      "externalImageId": "string",
      "sizes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    },
    "enterMessage": {
      "message": "string",
      "active": true
    },
    "exitMessage": {
      "message": "string",
      "active": true
    },
    "checkoutMessage": {
      "message": "string",
      "active": true
    },
    "storeProfile": {
      "id": "string",
      "name": "string",
      "primaryColor": "string",
      "backgroundColor": "string",
      "primaryTextColor": "string",
      "logoImage": {
        "id": "string",
        "fileName": "string",
        "url": "string",
        "externalImageId": "string",
        "sizes": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        }
      }
    }
  }
]
Response examples (200) 
[
  {
    "id": "string",
    "externalId": "string",
    "title": "string",
    "subTitle": "string",
    "handle": "string",
    "relatedProductsTitle": "string",
    "currencyCode": "string",
    "cultureName": "string",
    "countryCode": "no",
    "storeChain": {
      "id": "string",
      "name": "string",
      "handle": "string",
      "hasMembership": true,
      "hasCoupon": true,
      "privacyPolicyUrl": "https://example.com",
      "termsAndConditionsUrl": "https://example.com",
      "fulfillmentOptions": [
        {
          "id": "string",
          "name": "string",
          "type": "locally",
          "default": true
        }
      ]
    },
    "active": true,
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "legalIdentifier": "string",
    "timeZoneId": "string",
    "storeFrontImage": {
      "id": "string",
      "fileName": "string",
      "url": "string",
      "externalImageId": "string",
      "sizes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    },
    "headerImage": {
      "id": "string",
      "fileName": "string",
      "url": "string",
      "externalImageId": "string",
      "sizes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    },
    "expandedImage": {
      "id": "string",
      "fileName": "string",
      "url": "string",
      "externalImageId": "string",
      "sizes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    },
    "enterMessage": {
      "message": "string",
      "active": true
    },
    "exitMessage": {
      "message": "string",
      "active": true
    },
    "checkoutMessage": {
      "message": "string",
      "active": true
    },
    "storeProfile": {
      "id": "string",
      "name": "string",
      "primaryColor": "string",
      "backgroundColor": "string",
      "primaryTextColor": "string",
      "logoImage": {
        "id": "string",
        "fileName": "string",
        "url": "string",
        "externalImageId": "string",
        "sizes": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        }
      }
    }
  }
]