Get a store group

GET

api

{team_slug}

{app_slug}

store-groups

{store_group_slug}

Error

A valid request URL is required to generate request examples

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

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Path Parameters

store_group_slug

string

required

Store group slug

app_slug

string

required

App slug

team_slug

string

required

Team slug

Response

Store group retrieved successfully

data

object

Show child attributes

details

string[]

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

Delete a store groupDeletes a store group by its slug. The store group must not have any markets attached or merchant users associated with it. This operation also removes any related product pricing for the store group.

Error

A valid request URL is required to generate request examples

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

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Management API

Shopper API

Customers API

Digital Assets Management API

Path Parameters

Response