.dev
Partner Dashboard

Get store details ​

Last updated View as Markdown

Endpoint: https://api.youcan.shop/me

Method: GET

Required Scopes ​

  • view-store-info

Response ​

[200]

json
{
    "id": "5a58178a-1142-450e-bfc6-6f9d8ba32656",
    "store_id": "5a58178a-1142-450e-bfc6-6f9d8ba32656",
    "slug": "my-store",
    "name": "My store",
    "is_staff": false,
    "email": "zechariah11@example.org",
    "store_email": "contact@my-store.example",
    "due_amount": "0.00",
    "balance": 0,
    "unpaid_invoices_amount": "0.00",
    "currency": {
        "code": "USD",
        "symbol": "$"
    },
    "domain": "my-store.youcan.store",
    "status": 1,
    "status_text": "active",
    "closed_at": 1718000000,
    "pack_id": "028af582-df7e-43bd-bcba-725ef7531c57",
    "logo": "http://cdn.youcan.shop/stores/default/theme-settings/c8lBte0uft2xTkJKfULkZGNL24vU5jJzYB4ZYO7e.png",
    "first_name": "Mohamed",
    "last_name": "Ali",
    "full_name": "Mohamed Ali",
    "phone": "+15555555555",
    "bio": null,
    "website": null,
    "notices": {
        "active_gateways":"Please activate your payment gateway"
    },
    "is_active": true,
    "is_email_verified": true,
    "can_request": true,
    "can_cancel": false,
    "is_dev": false,
    "is_covered_by_account_pack": false,
    "theme": {
        "system": "themes",
        "id": "3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6b",
        "base_theme_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
    }
}

Notes ​

  • closed_at is a unix timestamp (integer) when the store has a scheduled deletion, or null if no deletion is pending.
  • theme.system is themes for a store on the theme system, or classic for a store on the classic theme. On classic, theme.id and theme.base_theme_id are null. Use Get the classic theme for its customization.
  • is_covered_by_account_pack is true when the pack of the seller account covers the store.
  • email, first_name, last_name, full_name and phone are the account details of the store owner.
  • store_email is the contact email of the store, from General settings.
  • is_email_verified is the verification state of store_email.
  • bio and website are always null.