> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/panel-api/resources/dealer.md). # Dealer In Navixy, a Dealer is an entity that acts as a reseller or distributor of the Navixy platform services. Dealers have access to the Navixy Admin Panel, where they can manage various aspects of the platform, including users, devices, and service plans. ## Dealer object ## The Dealer object ```json {"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"components":{"schemas":{"Dealer":{"type":"object","description":"A dealer: a reseller or distributor of Navixy platform services, with access to the Admin Panel.","readOnly":true,"properties":{"id":{"type":"integer","description":"Dealer ID."},"seller_id":{"type":"integer","description":"ID of the seller this dealer buys from."},"parent_dealer_id":{"type":"integer","description":"Parent dealer ID."},"contract_type":{"type":"string","description":"Contract type.","enum":["PARTNER","AGENT","PAAS"]},"tariff_id":{"type":"integer","description":"PaaS plan ID."},"tariff":{"$ref":"#/components/schemas/PaasTariff"},"demo_tariff":{"type":"boolean","description":"`true` for trial PaaS plans."},"tracker_tariff_end_date":{"type":["string","null"],"description":"End date of the tracker plan.","format":"date"},"store_period":{"type":"string","description":"Maximum data store period for users on a `demo_tariff`, as an ISO 8601 duration."},"demo_ends":{"type":["string","null"],"description":"Trial period end date, or `null` if not on a trial."},"title":{"type":"string","description":"Dealer display name."},"block_status":{"type":"string","description":"Block status of the panel and its end users.","enum":["NOT_BLOCKED","INITIAL_BLOCK","BLOCK_LOGIN","CLIENTS_BLOCKED"]},"legal_name":{"type":"string","description":"Dealer legal name."},"active_amount":{"type":"integer","description":"Total number of active trackers, including those of sub-dealers."},"active_amount_own":{"type":"integer","description":"Number of active trackers, excluding those of sub-dealers."},"active_amount_subpaas":{"type":"integer","description":"Number of active trackers belonging to sub-dealers."},"active_limit":{"type":"integer","description":"Maximum number of active trackers allowed."},"locale":{"type":"string","description":"Dealer's default locale."},"domain":{"type":"string","description":"Dealer's domain."},"favicon":{"type":["string","null"],"description":"Path or URL to the dealer's interface favicon."},"logo":{"type":["string","null"],"description":"Path or URL to the dealer's logotype."},"subpaas":{"type":"boolean","description":"`true` if this dealer is itself a sub-dealer of another."},"allow_branding":{"type":"boolean","description":"`true` if the dealer's plan permits branding customization."},"password_policy":{"$ref":"#/components/schemas/PasswordPolicy"},"paas_activation_date":{"type":["string","null"],"description":"Date the activation payment was made.","format":"date"},"license_balance":{"type":"number","description":"Current license balance."},"seller_currency":{"type":"string","description":"Currency the seller bills this dealer in."},"features":{"type":"array","description":"Enabled dealer features.","items":{"type":"string"}},"default_user_time_zone":{"type":"string","description":"Time zone ID applied to users created through the user upload operation, and preselected when creating a user in the Admin Panel."},"standalone_token":{"type":"string","description":"Service token, present only on standalone (on-premise) installations. Omitted entirely on Navixy-hosted platforms.","readOnly":true}}},"PaasTariff":{"type":"object","description":"The PaaS plan a dealer is on.","readOnly":true,"properties":{"id":{"type":"integer","description":"Plan ID."},"name":{"type":"string","description":"Plan name."},"type":{"type":"string","description":"Billing period type."},"algorithm":{"type":"string","description":"Charging algorithm applied by this plan."},"gis_package":{"type":"string","description":"GIS package included with this plan."},"currency":{"type":"string","description":"Plan currency."},"license_price":{"type":["number","null"],"description":"Price per license."},"min_license_pay":{"type":["number","null"],"description":"Minimum license payment."},"vat":{"type":"boolean","description":"`true` if prices include VAT."},"trial":{"type":"boolean","description":"`true` if this is a trial plan."},"premium_gis":{"type":"boolean","description":"`true` if premium GIS is enabled."},"service_prices":{"allOf":[{"$ref":"#/components/schemas/ServicePrices"}],"description":"Per-unit prices for chargeable services on the dealer's own PaaS plan."},"store_period":{"type":"string","description":"Maximum data store period for users, as an ISO 8601 duration."}}},"ServicePrices":{"type":"object","description":"Per-unit prices for chargeable services.","properties":{"incoming_sms":{"type":"number","description":"Price per incoming SMS."},"outgoing_sms":{"type":"number","description":"Price per outgoing SMS."},"service_sms":{"type":"number","description":"Price per service SMS."},"traffic":{"type":"number","description":"Price per 1 MB of traffic."}}},"PasswordPolicy":{"type":"object","description":"Password complexity rules enforced for this dealer. Applies to the dealer password update operation and to end user passwords.","readOnly":true,"properties":{"min_length":{"type":"integer","description":"Minimum number of characters."},"max_length":{"type":"integer","description":"Maximum number of characters."},"special_chars":{"type":"string","description":"The characters that count as special."},"min_special_chars_count":{"type":"integer","description":"Minimum number of special characters required."},"min_digits_count":{"type":"integer","description":"Minimum number of digits required."},"min_uppercase_count":{"type":"integer","description":"Minimum number of uppercase letters required."},"min_lowercase_count":{"type":"integer","description":"Minimum number of lowercase letters required."}}}}}} ``` Notes on individual fields: * `features` lists the allowed [dealer features](/docs/navixy-api/user-api/backend-api/resources/commons/dealer.md#dealer-features). * `default_user_time_zone` is a [time zone ID](/docs/navixy-api/panel-api/resources/timezone.md) applied to users created via [user/upload](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-upload). The same zone is preselected when creating a user in the Navixy Admin Panel. * `store_period` on the dealer applies to users on a `demo_tariff`. The `store_period` inside `tariff` is the plan's own maximum data store period. The two are separate values. * `password_policy` reports the complexity rules enforced for this dealer, and applies to [dealer/password/update](/docs/navixy-api/panel-api/resources/dealer/password.md) as well as to end user passwords. ## API Actions **API Path**: `panel/dealer/` *** **Required Permissions:** * `base: "get_dealer_info"`. ## Get dealer info > Read information about the authorized dealer: PaaS plan and its service prices, balance, active tracker counts and limits, branding paths, block status, enabled features, and defaults applied to newly created users. Takes no parameters beyond the session credential. Note that the dealer fields are returned at the top level of the response rather than nested under a \`value\` key. ```json {"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"tags":[{"name":"Dealer","description":"Operations for reading dealer information, managing activation codes, changing the dealer password, and reading or updating panel settings covering service configuration, notification originators, and branding images. All resources under the /panel/dealer/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Enter the panel session hash with the \"NVX \" prefix, e.g. \"NVX fa7bf873fab9333144e171372a321b06\". Obtain the hash from the accountAuth operation.","name":"Authorization","in":"header"}},"schemas":{"Dealer":{"type":"object","description":"A dealer: a reseller or distributor of Navixy platform services, with access to the Admin Panel.","readOnly":true,"properties":{"id":{"type":"integer","description":"Dealer ID."},"seller_id":{"type":"integer","description":"ID of the seller this dealer buys from."},"parent_dealer_id":{"type":"integer","description":"Parent dealer ID."},"contract_type":{"type":"string","description":"Contract type.","enum":["PARTNER","AGENT","PAAS"]},"tariff_id":{"type":"integer","description":"PaaS plan ID."},"tariff":{"$ref":"#/components/schemas/PaasTariff"},"demo_tariff":{"type":"boolean","description":"`true` for trial PaaS plans."},"tracker_tariff_end_date":{"type":["string","null"],"description":"End date of the tracker plan.","format":"date"},"store_period":{"type":"string","description":"Maximum data store period for users on a `demo_tariff`, as an ISO 8601 duration."},"demo_ends":{"type":["string","null"],"description":"Trial period end date, or `null` if not on a trial."},"title":{"type":"string","description":"Dealer display name."},"block_status":{"type":"string","description":"Block status of the panel and its end users.","enum":["NOT_BLOCKED","INITIAL_BLOCK","BLOCK_LOGIN","CLIENTS_BLOCKED"]},"legal_name":{"type":"string","description":"Dealer legal name."},"active_amount":{"type":"integer","description":"Total number of active trackers, including those of sub-dealers."},"active_amount_own":{"type":"integer","description":"Number of active trackers, excluding those of sub-dealers."},"active_amount_subpaas":{"type":"integer","description":"Number of active trackers belonging to sub-dealers."},"active_limit":{"type":"integer","description":"Maximum number of active trackers allowed."},"locale":{"type":"string","description":"Dealer's default locale."},"domain":{"type":"string","description":"Dealer's domain."},"favicon":{"type":["string","null"],"description":"Path or URL to the dealer's interface favicon."},"logo":{"type":["string","null"],"description":"Path or URL to the dealer's logotype."},"subpaas":{"type":"boolean","description":"`true` if this dealer is itself a sub-dealer of another."},"allow_branding":{"type":"boolean","description":"`true` if the dealer's plan permits branding customization."},"password_policy":{"$ref":"#/components/schemas/PasswordPolicy"},"paas_activation_date":{"type":["string","null"],"description":"Date the activation payment was made.","format":"date"},"license_balance":{"type":"number","description":"Current license balance."},"seller_currency":{"type":"string","description":"Currency the seller bills this dealer in."},"features":{"type":"array","description":"Enabled dealer features.","items":{"type":"string"}},"default_user_time_zone":{"type":"string","description":"Time zone ID applied to users created through the user upload operation, and preselected when creating a user in the Admin Panel."},"standalone_token":{"type":"string","description":"Service token, present only on standalone (on-premise) installations. Omitted entirely on Navixy-hosted platforms.","readOnly":true}}},"PaasTariff":{"type":"object","description":"The PaaS plan a dealer is on.","readOnly":true,"properties":{"id":{"type":"integer","description":"Plan ID."},"name":{"type":"string","description":"Plan name."},"type":{"type":"string","description":"Billing period type."},"algorithm":{"type":"string","description":"Charging algorithm applied by this plan."},"gis_package":{"type":"string","description":"GIS package included with this plan."},"currency":{"type":"string","description":"Plan currency."},"license_price":{"type":["number","null"],"description":"Price per license."},"min_license_pay":{"type":["number","null"],"description":"Minimum license payment."},"vat":{"type":"boolean","description":"`true` if prices include VAT."},"trial":{"type":"boolean","description":"`true` if this is a trial plan."},"premium_gis":{"type":"boolean","description":"`true` if premium GIS is enabled."},"service_prices":{"allOf":[{"$ref":"#/components/schemas/ServicePrices"}],"description":"Per-unit prices for chargeable services on the dealer's own PaaS plan."},"store_period":{"type":"string","description":"Maximum data store period for users, as an ISO 8601 duration."}}},"ServicePrices":{"type":"object","description":"Per-unit prices for chargeable services.","properties":{"incoming_sms":{"type":"number","description":"Price per incoming SMS."},"outgoing_sms":{"type":"number","description":"Price per outgoing SMS."},"service_sms":{"type":"number","description":"Price per service SMS."},"traffic":{"type":"number","description":"Price per 1 MB of traffic."}}},"PasswordPolicy":{"type":"object","description":"Password complexity rules enforced for this dealer. Applies to the dealer password update operation and to end user passwords.","readOnly":true,"properties":{"min_length":{"type":"integer","description":"Minimum number of characters."},"max_length":{"type":"integer","description":"Maximum number of characters."},"special_chars":{"type":"string","description":"The characters that count as special."},"min_special_chars_count":{"type":"integer","description":"Minimum number of special characters required."},"min_digits_count":{"type":"integer","description":"Minimum number of digits required."},"min_uppercase_count":{"type":"integer","description":"Minimum number of uppercase letters required."},"min_lowercase_count":{"type":"integer","description":"Minimum number of lowercase letters required."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API (not a HTTP code)"},"description":{"type":"string","description":"An error description"}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/panel/dealer/get_info":{"post":{"tags":["Dealer"],"summary":"Get dealer info","description":"Read information about the authorized dealer: PaaS plan and its service prices, balance, active tracker counts and limits, branding paths, block status, enabled features, and defaults applied to newly created users. Takes no parameters beyond the session credential. Note that the dealer fields are returned at the top level of the response rather than nested under a `value` key.","operationId":"dealerGetInfo","responses":{"200":{"description":"Dealer information","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}},{"$ref":"#/components/schemas/Dealer"}]}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Operation not permitted, error code 13: the session lacks the required permission.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` #### Errors * `201` - Not found in the database. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/panel-api/resources/dealer.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.