PUT /external/api/stores

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://developers.fygi.io/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "External MCP server": {
    "url": "https://developers.fygi.io/mcp"
  }
}
Close
PUT /external/api/stores
Authorization key

Body

  • id string Required

    Minimum length is 1.

  • title string Required

    Minimum length is 1.

  • handle string Required

    Minimum length is 1.

  • subTitle string | null
  • relatedProductsTitle string | null
  • active boolean
  • address string Required

    Minimum length is 1.

  • postalCode string Required

    Minimum length is 1.

  • city string Required

    Minimum length is 1.

  • 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
  • currencyCode string Required

    Minimum length is 1.

  • cultureName string Required

    Minimum length is 1.

  • legalIdentifier string Required

    Minimum length is 1.

  • customerServiceEmail string Required

    Minimum length is 1.

  • selfCheckoutThresholdAmount integer(int32) | null
  • selfCheckoutPercent integer(int32) | null
  • adjustmentTypes array[string(uuid)] | null
  • storeProfileId string(uuid) Required

Body

  • id string Required

    Minimum length is 1.

  • title string Required

    Minimum length is 1.

  • handle string Required

    Minimum length is 1.

  • subTitle string | null
  • relatedProductsTitle string | null
  • active boolean
  • address string Required

    Minimum length is 1.

  • postalCode string Required

    Minimum length is 1.

  • city string Required

    Minimum length is 1.

  • 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
  • currencyCode string Required

    Minimum length is 1.

  • cultureName string Required

    Minimum length is 1.

  • legalIdentifier string Required

    Minimum length is 1.

  • customerServiceEmail string Required

    Minimum length is 1.

  • selfCheckoutThresholdAmount integer(int32) | null
  • selfCheckoutPercent integer(int32) | null
  • adjustmentTypes array[string(uuid)] | null
  • storeProfileId string(uuid) Required

Body

  • id string Required

    Minimum length is 1.

  • title string Required

    Minimum length is 1.

  • handle string Required

    Minimum length is 1.

  • subTitle string | null
  • relatedProductsTitle string | null
  • active boolean
  • address string Required

    Minimum length is 1.

  • postalCode string Required

    Minimum length is 1.

  • city string Required

    Minimum length is 1.

  • 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
  • currencyCode string Required

    Minimum length is 1.

  • cultureName string Required

    Minimum length is 1.

  • legalIdentifier string Required

    Minimum length is 1.

  • customerServiceEmail string Required

    Minimum length is 1.

  • selfCheckoutThresholdAmount integer(int32) | null
  • selfCheckoutPercent integer(int32) | null
  • adjustmentTypes array[string(uuid)] | null
  • storeProfileId string(uuid) Required

Responses

  • 200

    Success

PUT /external/api/stores 
curl \
 --request PUT 'http://test.api.fygi.store/external/api/stores' \
 --header "authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '[
  {
    "id": "string",
    "title": "string",
    "handle": "string",
    "subTitle": "string",
    "relatedProductsTitle": "string",
    "active": true,
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "enterMessage": {
      "message": "string",
      "active": true
    },
    "exitMessage": {
      "message": "string",
      "active": true
    },
    "checkoutMessage": {
      "message": "string",
      "active": true
    },
    "currencyCode": "string",
    "cultureName": "string",
    "legalIdentifier": "string",
    "customerServiceEmail": "string",
    "selfCheckoutThresholdAmount": 42,
    "selfCheckoutPercent": 42,
    "adjustmentTypes": [
      "string"
    ],
    "storeProfileId": "string"
  }
]'
curl \
 --request PUT 'http://test.api.fygi.store/external/api/stores' \
 --header "authorization: $API_KEY" \
 --header "Content-Type: text/json"
curl \
 --request PUT 'http://test.api.fygi.store/external/api/stores' \
 --header "authorization: $API_KEY" \
 --header "Content-Type: application/*+json"
Request examples 
[
  {
    "id": "string",
    "title": "string",
    "handle": "string",
    "subTitle": "string",
    "relatedProductsTitle": "string",
    "active": true,
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "enterMessage": {
      "message": "string",
      "active": true
    },
    "exitMessage": {
      "message": "string",
      "active": true
    },
    "checkoutMessage": {
      "message": "string",
      "active": true
    },
    "currencyCode": "string",
    "cultureName": "string",
    "legalIdentifier": "string",
    "customerServiceEmail": "string",
    "selfCheckoutThresholdAmount": 42,
    "selfCheckoutPercent": 42,
    "adjustmentTypes": [
      "string"
    ],
    "storeProfileId": "string"
  }
]
Request examples 
[
  {
    "id": "string",
    "title": "string",
    "handle": "string",
    "subTitle": "string",
    "relatedProductsTitle": "string",
    "active": true,
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "enterMessage": {
      "message": "string",
      "active": true
    },
    "exitMessage": {
      "message": "string",
      "active": true
    },
    "checkoutMessage": {
      "message": "string",
      "active": true
    },
    "currencyCode": "string",
    "cultureName": "string",
    "legalIdentifier": "string",
    "customerServiceEmail": "string",
    "selfCheckoutThresholdAmount": 42,
    "selfCheckoutPercent": 42,
    "adjustmentTypes": [
      "string"
    ],
    "storeProfileId": "string"
  }
]
Request examples 
[
  {
    "id": "string",
    "title": "string",
    "handle": "string",
    "subTitle": "string",
    "relatedProductsTitle": "string",
    "active": true,
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "enterMessage": {
      "message": "string",
      "active": true
    },
    "exitMessage": {
      "message": "string",
      "active": true
    },
    "checkoutMessage": {
      "message": "string",
      "active": true
    },
    "currencyCode": "string",
    "cultureName": "string",
    "legalIdentifier": "string",
    "customerServiceEmail": "string",
    "selfCheckoutThresholdAmount": 42,
    "selfCheckoutPercent": 42,
    "adjustmentTypes": [
      "string"
    ],
    "storeProfileId": "string"
  }
]