Envia.com User Management API

openapi: 3.2.0
info:
  title: Envia Queries User Management 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: User Management
paths:
  /all-addresses:
    get:
      tags:
      - User Management
      summary: Get All Addresses
      description: 'Returns the complete list of addresses saved in the authenticated user''s address book. These are reusable origin and destination addresses that can be referenced when creating shipments.


        **When to use:** Call this endpoint to populate address selection dropdowns in your shipping forms, display the user''s address book for management, or retrieve saved addresses for auto-fill during shipment creation.


        **Prerequisites:**

        - Valid JWT token in the Authorization header


        **Key behaviors:**

        - Returns all addresses associated with the authenticated user''s account

        - Each address includes its `address_id`, which can be used to update (`PUT /user-address/{address_id}`) or delete (`DELETE /user-address/{address_id}`) the entry

        - Results are not paginated; all addresses are returned in a single response

        - To filter addresses by type (e.g., origin vs destination), use `GET /all-addresses/{type}` instead'
      operationId: all-addresses
      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 addresses
                    items:
                      type: object
                      properties:
                        address_id:
                          type: integer
                          description: Address ID
                        user_id:
                          type: integer
                          description: User ID
                        address:
                          type: object
                          description: Address information
  /all-addresses/{type}:
    get:
      tags:
      - User Management
      summary: Get Addresses by Type
      description: Retrieve all addresses for the specified type. Requires Bearer JWT authentication.
      operationId: addresses-by-type
      parameters:
      - name: type
        in: path
        required: true
        description: Address type
        schema:
          type: string
          enum:
          - origin
          - destination
          - return
          example: origin
      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 addresses by type
  /default-user-address/{user_id}:
    get:
      tags:
      - User Management
      summary: Get Default User Address
      description: Retrieve default user address for the specified user id. Requires Bearer JWT authentication.
      operationId: default-user-address
      parameters:
      - name: user_id
        in: path
        required: true
        description: User 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: object
                    description: Default address information
  /default-user-print/{carrier_id}:
    get:
      tags:
      - User Management
      summary: Get Default Print Settings
      description: Get default print settings for a user and carrier.
      operationId: default-user-print
      parameters:
      - name: carrier_id
        in: path
        required: true
        description: Carrier identificator
        schema:
          type: integer
          example: 1
      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: Print settings information
  /user-address:
    post:
      tags:
      - User Management
      summary: Create Address
      description: 'Creates and saves a new address entry in the user''s address book. Saved addresses can be quickly reused when creating shipments, eliminating the need to re-enter full address details each time.


        **When to use:** Call this endpoint when a user wants to store a frequently used origin or destination address for future shipments, or when onboarding a new customer whose address should be saved for repeat orders.


        **Prerequisites:**

        - Valid JWT token in the Authorization header

        - A `user_id` identifying the address owner

        - A complete `address` object with required fields: `name`, `street`, `city`, `state`, `zipcode`, and `country`


        **Key behaviors:**

        - Returns the newly created `address_id` which can be referenced in future shipment creation calls

        - The `country` field must be a valid two-letter ISO country code (e.g., `MX`, `US`, `CO`)

        - Optional fields include `company`, `street2`, and `phone`

        - Duplicate addresses are not automatically detected; the same address can be saved multiple times

        - Saved addresses can be retrieved with `GET /all-addresses` and managed with `PUT /user-address/{address_id}` or `DELETE /user-address/{address_id}`'
      operationId: create-user-address
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - user_id
              - address
              properties:
                user_id:
                  type: integer
                  description: User ID
                  example: 1024
                address:
                  type: object
                  description: Address information
                  required:
                  - name
                  - street
                  - city
                  - state
                  - zipcode
                  - country
                  properties:
                    name:
                      type: string
                      description: Full name
                      example: Juan Pérez
                    company:
                      type: string
                      description: Company name
                      example: Warehouse Operations
                    street:
                      type: string
                      description: Street address
                      example: Av. Industrial 500
                    street2:
                      type: string
                      description: Street address line 2
                      example: Int. 4B
                    city:
                      type: string
                      description: City
                      example: Monterrey
                    state:
                      type: string
                      description: State/Province
                      example: NL
                    zipcode:
                      type: string
                      description: ZIP/Postal code
                      example: '64000'
                    country:
                      type: string
                      description: Country code
                      example: MX
                    phone:
                      type: string
                      description: Phone number
                      example: '8180000000'
      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 address information
                    properties:
                      address_id:
                        type: integer
                        description: Address ID
                      user_id:
                        type: integer
                        description: User ID
                      address:
                        type: object
                        description: Address information
  /user-address/{address_id}:
    delete:
      tags:
      - User Management
      summary: Delete Address
      description: Delete user address for the specified address id. Requires Bearer JWT authentication.
      operationId: remove-user-address
      parameters:
      - name: address_id
        in: path
        required: true
        description: Address 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
                  message:
                    type: string
                    description: Success message
    put:
      tags:
      - User Management
      summary: Update Address
      description: Update user address for the specified address id. Requires Bearer JWT authentication.
      operationId: update-user-address
      parameters:
      - name: address_id
        in: path
        required: true
        description: Address ID
        schema:
          type: integer
          example: 123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                address:
                  type: object
                  description: Updated address information
                  example:
                    name: Juan Pérez
                    street: Av. Revolución 500
                    city: Monterrey
                    state: NL
                    zipcode: '64000'
                    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: Updated address information
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