Stores

Stores are an essential part of Mercantive — they contain all the information about your business, branding, currency, and other configurations. On this page, we’ll dive into the different store endpoints you can use to manage stores programmatically. We’ll look at how to query, create, update, and delete stores.

The store object

The store model contains all the essential information about your business on Mercantive, including its branding, support email, currency, and country. The store object also provides links to media assets such as the logo and favicon.

Properties

Name
id
Type
uuid
Description
Unique identifier for the store.
Name
name
Type
string
Description
Name of the store.
Name
status
Type
string
Description
The current status of the store (e.g., ACTIVE, PENDING, DISABLED, SUSPENDED, IN_REVIEW, REVIEW_REJECTED).
Name
support_email
Type
string
Description
Email address used for customer support.
Name
primary_domain
Type
string
Description
The primary domain associated with the store.
Name
logo_url
Type
string
Description
URL of the store's logo image.
Name
favicon_url
Type
string
Description
URL of the store's favicon image.
Name
currency
Type
object
Description
Object containing currency information such as the ID, name, code, and symbol.
Name
country
Type
object
Description
Object containing country information such as the ID, code, name, and flag URL.
Name
created_at
Type
timestamp
Description
Timestamp of when the store was created.
Name
updated_at
Type
timestamp
Description
Timestamp of when the store was last updated.

GET/stores

Store details

This endpoint allows you to retrieve the details of a store by token.

Request

GET

/stores

curl -X GET https://api.mercantive.com/v1/stores \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Response

{
  "data": {
      "id": "9d1c9180-fe08-4fe4-abf6-50aee88940ea",
      "name": "Store Name",
      "status": "ACTIVE",
      "support_email": "[email protected]",
      "primary_domain": "https://mystore.mercantive.com",
      "logo_url": "https://cdn.mercantive.com/images/mercantive/logo-color-bg-white.svg",
      "favicon_url": "https://api.mercantive.com/images/mercantive/logo-color-bg-black.svg",
      "currency": {
        "id": "9d1c915b-8b78-44aa-8b8a-923373687074",
        "name": "US Dollar",
        "code": "usd",
        "symbol": "$",
        "label": "USD - US Dollar",
        "created_at": "2024-09-27T18:03:53.000000Z",
        "updated_at": "2024-09-27T18:03:53.000000Z"
      },
      "country": {
        "id": "9d1c915b-8d4a-4362-8c60-d5210eb1f7dd",
        "code": "US",
        "name": "United States",
        "flag": "https://cdn.mercantive.com/images/countries/us.png"
      },
      "created_at": "2024-09-27T18:04:17.000000Z",
      "updated_at": "2024-09-27T18:33:08.000000Z"
    }
}