API Documentation
User
Products
Categories
Variants
- GETGet Variant
- GETGet License Keys
- POSTCreate Variant
- POSTCreate Field
- POSTCreate Field Option
- PUTAdd License Keys
- PUTUpdate Variant
- PUTUpdate Delivery Settings
- PUTUpdate Field
- PUTUpdate Field Option
- PATCHOrder Variant Images
- DELDelete License Keys
- DELClear License Keys
- DELDelete Variant
- DELDelete Field
- DELDelete Field Option
Coupons
Customers
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
}
}
}Get Store
Retrieves the specified store’s reference information.
Requires the stores.view permission.
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
Your API key goes here
Path Parameters
The ID of the store to retrieve.
Response
The object was successfully returned.
Represents a default generic response for API endpoints.
Indicates whether the operation or response was successful.
A descriptive message providing additional context or information about the response.
The error code (if there was an error) to use when referencing the error
A reference to a store which is owned by a merchant that can be used as a front for selling products to customers
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created
The name of the store
The description of the store, shown on their about page and on the home of their store page
The subdomain for the store, ONLY the subdomain, not the fully qualified domain
"\n store\n "
The stores preferred currency
Whether the name of the product should be prepended to the start of delivery receipts to customers
Whether automatic review leaving is enabled
The combined average rating for all their products
The domain the store is associated with
Whether the customer balance system is enabled on the stores
Represents the configurable branding options for a store.
Show child attributes
Show child attributes
Indicates whether automatic currency conversion is enabled, this is strictly for displaying on the checkout which improves conversion
Represents the file name of the banner associated with the checkout options.
64The icon file name, used for favicon
64Represents the accent color used in the checkout options.
9The custom domain set for the store, will be null if not set
The permission scopes that the current user can use for the store, only returned on the /user endpoint for stores visible due to team permissions, will also be null on /user if the store is owned by the user and therefore has every (permissions)
The reason the store is in maintenance, if this is null then the store is not in maintenance mode
Represents the configuration options for affiliate settings in a store.
Show child attributes
Show child attributes
Determines if the affiliate settings are active for the store.
Specifies the default return percentage for affiliates within a store, ranging from 0 to 100.
0 <= x <= 100Whether the store allows affiliate balance to be converted into customer balance to be used on the store, when enabled any affiliate can convert their affiliate balance into customer balance automatically
Determines whether public registration is enabled for affiliates within the store.
Indicates whether link editing capabilities are enabled within the affiliate options for a store.
Represents the default percentage off value used in affiliate settings, where the value must be between 0 and 100.
0 <= x <= 100Was this page helpful?