Update a store group

Updates an existing store group's name, slug, store type, and associated markets. Markets specified in the payload will be added to the store group.

PATCH/api/v1/{team_slug}/{app_slug}/store-groups/{store_group_slug}
API
Management
Updated
Apr 26, 2026

management-api:PATCH:/api/v1/{team_slug}/{app_slug}/store-groups/{store_group_slug}

Updates an existing store group's name, slug, store type, and associated markets. Markets specified in the payload will be added to the store group.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: PATCH
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/store-groups/\{store_group_slug\}
  • Summary: Update a store group
  • Description: Updates an existing store group's name, slug, store type, and associated markets. Markets specified in the payload will be added to the store group.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
store_group_slugpathYesstringStore group slug
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyDocumented body
  • Required: Yes
  • Description: Store group data
  • Content: application/json (object)

Input Store Group

PropertyTypeRequiredDetails
country_of_salestringYesCountry value needs to follow ISO3166_1_alpha2, which means we want a country value written in alpha-2 two-letter country codes, Example: SE or FI
descriptionstringNo-
marketsstring[]NoThe slug of the markets which should be related to this store group
namestringYes-
slugstringYes-
store_typeenum("b2c", "b2b", "d2c", "d2b")No-

Generated example (synthetic):

{
  "country_of_sale": "string",
  "description": "string",
  "markets": [
    "string"
  ],
  "name": "string",
  "slug": "string",
  "store_type": "b2c"
}
Responses4 statuses
StatusDescriptionContent
200Store group updated successfullyapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Store Group Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Store Group With Markets
PropertyTypeRequiredDetails
country_of_salestringNo-
created_atstringNo-
descriptionstringNo-
idstringNo-
marketsobject[]No-
namestringNo-
slugstringNo-
store_typestringNo-
updated_atstringNo-
Store Group Market
PropertyTypeRequiredDetails
activebooleanNo-
country_codesstring[]No-
created_atstringNo-
currency_codestringNo-
idstringNo-
is_tax_exemption_eligiblebooleanNo-
is_tax_included_in_pricebooleanNo-
localestringNo-
namestringNo-
slugstringNo-
updated_atstringNo-

Generated example (synthetic):

{
  "data": {
    "country_of_sale": "string",
    "created_at": "string",
    "description": "string",
    "id": "string",
    "markets": [
      {
        "active": false,
        "country_codes": [],
        "created_at": "string",
        "currency_code": "string",
        "id": "string",
        "is_tax_exemption_eligible": false,
        "is_tax_included_in_price": false,
        "locale": "string",
        "name": "string",
        "slug": "string",
        "updated_at": "string"
      }
    ],
    "name": "string",
    "slug": "string",
    "store_type": "string",
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: PATCH
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/store-groups/\{store_group_slug\}
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: StoreGroups
  • OpenAPI summary: Update a store group

Update a store group

# Update a store group Updates an existing store group's name, slug, store type, and associated markets. Markets specified in the payload will be added to the store group.
PATCH /api/v1/{team_slug}/{app_slug}/store-groups/{store_group_slug}
Purpose

Updates an existing store group's name, slug, store type, and associated markets.

Required inputs

store_group_slug path app_slug path team_slug path

Primary response

200 ยท Store group updated successfully

Operation key

management-api:PATCH:/api/v1/{team_slug}/{app_slug}/store-groups/{store_group_slug}

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `PATCH` - Path: `/api/v1/{team_slug}/{app_slug}/store-groups/{store_group_slug}` - Summary: Update a store group - Description: Updates an existing store group's name, slug, store type, and associated markets. Markets specified in the payload will be added to the store group. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PATCH:/api/v1/{team_slug}/{app_slug}/store-groups/{store_group_slug}` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | store_group_slug | path | Yes | string | Store group slug | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body - Required: Yes - Description: Store group data - Content: application/json (object) ### Input Store Group | Property | Type | Required | Details | | --- | --- | --- | --- | | `country_of_sale` | string | Yes | Country value needs to follow ISO3166_1_alpha2, which means we want a country value written in alpha-2 two-letter country codes, Example: SE or FI | | `description` | string | No | - | | `markets` | string[] | No | The slug of the markets which should be related to this store group | | `name` | string | Yes | - | | `slug` | string | Yes | - | | `store_type` | enum("b2c", "b2b", "d2c", "d2b") | No | - | **Generated example (synthetic):** ```json { "country_of_sale": "string", "description": "string", "markets": [ "string" ], "name": "string", "slug": "string", "store_type": "b2c" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Store group updated successfully | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Store Group Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Store Group With Markets | Property | Type | Required | Details | | --- | --- | --- | --- | | `country_of_sale` | string | No | - | | `created_at` | string | No | - | | `description` | string | No | - | | `id` | string | No | - | | `markets` | object[] | No | - | | `name` | string | No | - | | `slug` | string | No | - | | `store_type` | string | No | - | | `updated_at` | string | No | - | ##### Store Group Market | Property | Type | Required | Details | | --- | --- | --- | --- | | `active` | boolean | No | - | | `country_codes` | string[] | No | - | | `created_at` | string | No | - | | `currency_code` | string | No | - | | `id` | string | No | - | | `is_tax_exemption_eligible` | boolean | No | - | | `is_tax_included_in_price` | boolean | No | - | | `locale` | string | No | - | | `name` | string | No | - | | `slug` | string | No | - | | `updated_at` | string | No | - | **Generated example (synthetic):** ```json { "data": { "country_of_sale": "string", "created_at": "string", "description": "string", "id": "string", "markets": [ { "active": false, "country_codes": [], "created_at": "string", "currency_code": "string", "id": "string", "is_tax_exemption_eligible": false, "is_tax_included_in_price": false, "locale": "string", "name": "string", "slug": "string", "updated_at": "string" } ], "name": "string", "slug": "string", "store_type": "string", "updated_at": "string" }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `PATCH` - Path: `/api/v1/{team_slug}/{app_slug}/store-groups/{store_group_slug}` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PATCH:/api/v1/{team_slug}/{app_slug}/store-groups/{store_group_slug}` - OpenAPI tag: StoreGroups - OpenAPI summary: Update a store group