find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/envia:envia-configuration-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Envia Queries Configuration API
  version: v2.3.1
  description: Read-only service for lookups, lists, and account utilities. This API provides access to countries, states, cities, carriers, services, and address structure information needed for shipping operations. Use this API to get the required information for building shipping forms and validating addresses. The Queries API is designed for developers who need read-only access to reference data such as supported carriers, available services, shipment history, and user account settings. It serves as the lookup layer of the Envia platform, enabling applications to populate dropdowns, validate inputs, and retrieve shipment details without modifying any data.
  contact:
    name: Envia API Support
    url: https://docs.envia.com/discuss
  license:
    name: Proprietary
    url: https://www.envia.com/terminos-y-condiciones
  termsOfService: https://www.envia.com/terminos-y-condiciones
servers:
- url: https://queries.test.envia.com/
  description: Sandbox/Test
- url: https://queries.envia.com/
  description: Production
security:
- bearerAuth: []
tags:
- name: Configuration
paths:
  /config/{shop_id}/shipping-rules:
    post:
      tags:
      - Configuration
      summary: Create shipping rule for shop
      description: Create shipping rules for the specified shop id. Requires Bearer JWT authentication.
      operationId: create-shop-shipping-rule
      parameters:
      - name: shop_id
        in: path
        required: true
        description: Shop ID
        schema:
          type: integer
          example: 123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - conditions
              - actions
              properties:
                name:
                  type: string
                  description: Rule name
                  example: Standard Box
                conditions:
                  type: object
                  description: Rule conditions
                  example:
                    min_weight: 0
                    max_weight: 10
                    country: MX
                actions:
                  type: object
                  description: Rule actions
                  example:
                    carrier: fedex
                    service: express
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates if the request was successful
                  data:
                    type: object
                    description: Created rule information
    get:
      tags:
      - Configuration
      summary: Get shipping rules for shop
      description: Get shipping rules configuration for a specific shop.
      operationId: shop-shipping-rules
      parameters:
      - name: shop_id
        in: path
        required: true
        description: Shop ID
        schema:
          type: integer
          example: 123
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates if the request was successful
                  data:
                    type: array
                    description: List of shipping rules
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Rule ID
                        name:
                          type: string
                          description: Rule name
                        conditions:
                          type: object
                          description: Rule conditions
                        actions:
                          type: object
                          description: Rule actions
    put:
      tags:
      - Configuration
      summary: Update shipping rules for shop
      description: Update shipping rules configuration for a specific shop.
      operationId: update-shop-shipping-rules
      parameters:
      - name: shop_id
        in: path
        required: true
        description: Shop ID
        schema:
          type: integer
          example: 123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                rules:
                  type: array
                  description: Updated rules array
                  example:
                  - name: Heavy packages
                    conditions:
                      min_weight: 10
                    actions:
                      carrier: dhl
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates if the request was successful
                  message:
                    type: string
                    description: Success message
  /config/{shop_id}/shipping-rules/select/{order_id}:
    post:
      tags:
      - Configuration
      summary: Select shipping rule for order
      description: Apply shipping rules to select the best option for an order.
      operationId: select-shipping-rule-for-order
      parameters:
      - name: shop_id
        in: path
        required: true
        description: Shop ID
        schema:
          type: integer
          example: 123
      - name: order_id
        in: path
        required: true
        description: Order ID
        schema:
          type: integer
          example: 789
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - order_data
              properties:
                order_data:
                  type: object
                  description: Order information
                  example:
                    order_id: ORD-2026-5678
                    total_weight: 5
                    destination_country: MX
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates if the request was successful
                  data:
                    type: object
                    description: Selected shipping option
  /config/{shop_id}/shipping-rules/{rule_id}:
    get:
      tags:
      - Configuration
      summary: Get specific shipping rule
      description: Retrieve shipping rules for the specified shop id and rule id. Requires Bearer JWT authentication.
      operationId: shop-shipping-rule
      parameters:
      - name: shop_id
        in: path
        required: true
        description: Shop ID
        schema:
          type: integer
          example: 123
      - name: rule_id
        in: path
        required: true
        description: Rule ID
        schema:
          type: integer
          example: 456
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates if the request was successful
                  data:
                    type: object
                    description: Rule information
  /default-shop-services/{shop_id}:
    get:
      tags:
      - Configuration
      summary: Get default shop services
      description: Retrieve default shop services for the specified shop id. Requires Bearer JWT authentication.
      operationId: default-shop-services
      parameters:
      - name: shop_id
        in: path
        required: true
        description: Shop ID
        schema:
          type: integer
          example: 123
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates if the request was successful
                  data:
                    type: array
                    description: List of default services
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Full Envia API Documentation
  url: https://docs.envia.com
x-provenance:
  method: searched
  source: https://docs.envia.com/reference
  harvested: '2026-10-27'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.envia.com/reference/active-notifications.md
  - https://docs.envia.com/reference/additional-services-by-locale.md
  - https://docs.envia.com/reference/additional-services.md
  - https://docs.envia.com/reference/addresses-by-type.md
  - https://docs.envia.com/reference/all-addresses.md
  - https://docs.envia.com/reference/all-countries.md
  - https://docs.envia.com/reference/all-packages.md
  - https://docs.envia.com/reference/all-provinces.md
  - https://docs.envia.com/reference/all-webhooks.md
  - https://docs.envia.com/reference/available-carriers-by-shipment-type.md
  - https://docs.envia.com/reference/available-couriers-detailed.md
  - https://docs.envia.com/reference/available-services.md
  - https://docs.envia.com/reference/cancel-dce.md
  - https://docs.envia.com/reference/carrier-actions-by-carrier.md
  - https://docs.envia.com/reference/carrier-branches.md
  - https://docs.envia.com/reference/carrier-by-id.md
  - https://docs.envia.com/reference/carrier-print-options.md
  - https://docs.envia.com/reference/carriers-by-country.md
  - https://docs.envia.com/reference/country-address-structure.md
  - https://docs.envia.com/reference/country-by-code.md
  - https://docs.envia.com/reference/country-locale.md
  - https://docs.envia.com/reference/create-ndr-request.md
  - https://docs.envia.com/reference/create-package.md
  - https://docs.envia.com/reference/create-shop-shipping-rule.md
  - https://docs.envia.com/reference/create-user-address.md
  - https://docs.envia.com/reference/create-webhook.md
  - https://docs.envia.com/reference/deactivate-company-notifications.md
  - https://docs.envia.com/reference/default-shop-services.md
  - https://docs.envia.com/reference/default-user-address.md
  - https://docs.envia.com/reference/default-user-print.md
  - https://docs.envia.com/reference/download-labels-bulk.md
  - https://docs.envia.com/reference/estafeta-branches-mexico.md
  - https://docs.envia.com/reference/generate-dce.md
  - https://docs.envia.com/reference/get-orders.md
  - https://docs.envia.com/reference/invoice-detail.md
  - https://docs.envia.com/reference/ndr-history.md
  - https://docs.envia.com/reference/ndr-shipment-actions.md
  - https://docs.envia.com/reference/payment-history.md
  - https://docs.envia.com/reference/province-by-code.md
  - https://docs.envia.com/reference/remove-package.md
  - https://docs.envia.com/reference/remove-user-address.md
  - https://docs.envia.com/reference/select-shipping-rule-for-order.md
  - https://docs.envia.com/reference/serviceable-countries.md
  - https://docs.envia.com/reference/services-by-carrier-and-country.md
  - https://docs.envia.com/reference/services-by-carrier.md
  - https://docs.envia.com/reference/shipment-by-tracking.md
  - https://docs.envia.com/reference/shipment-types.md
  - https://docs.envia.com/reference/shipments-by-month-year.md
  - https://docs.envia.com/reference/shop-by-url.md
  - https://docs.envia.com/reference/shop-shipping-rule.md
  - https://docs.envia.com/reference/shop-shipping-rules.md
  - https://docs.envia.com/reference/state-by-code.md
  - https://docs.envia.com/reference/states-by-country.md
  - https://docs.envia.com/reference/update-package.md
  - https://docs.envia.com/reference/update-shop-shipping-rules.md
  - https://docs.envia.com/reference/update-user-address.md
  - https://docs.envia.com/reference/update-webhook.md
  - https://docs.envia.com/reference/webhook-types.md
  merge:
    pages: 58
    deduped: 57
    conflicts_kept_first: 0