Skip to main content
GET
/
stores
/
{storeId}
Get store by ID
curl --request GET \
  --url https://api.komerza.com/stores/{storeId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "url": "\n                store\n            ",
    "currencyCode": "<string>",
    "prependProductNameToReceipt": true,
    "isAutomaticReviewsEnabled": true,
    "rating": 123,
    "domain": "<string>",
    "isCustomerBalanceEnabled": true,
    "branding": {
      "isAutomaticCurrencyConversionEnabled": true,
      "bannerFileName": "<string>",
      "iconFileName": "<string>",
      "accentColor": "<string>"
    },
    "customDomain": "<string>",
    "scopes": [
      "<string>"
    ],
    "maintenanceReason": "<string>",
    "affiliateOptions": {
      "isEnabled": true,
      "defaultReturnPercentage": 50,
      "canConvertAffiliateBalance": true,
      "isPublicRegistrationEnabled": true,
      "isLinkEditingEnabled": true,
      "defaultPercentageOff": 50
    }
  }
}

Authorizations

​
Authorization
string
header
required

Your API key goes here

Path Parameters

​
storeId
string<uuid>
required

The ID of the store to retrieve.

Response

The object was successfully returned.

Represents a default generic response for API endpoints.

​
success
boolean
required

Indicates whether the operation or response was successful.

​
message
string | null

A descriptive message providing additional context or information about the response.

​
code
string | null

The error code (if there was an error) to use when referencing the error

​
data
object

A reference to a store which is owned by a merchant that can be used as a front for selling products to customers