Envia Shipping API

https://docs.envia.com/
Admin
Envia's Shipping API connects e-commerce businesses with over 100 couriers worldwide, simplifying...
Tokens:138,903
Snippets:992
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Pickup Scheduling Response Example

Source: https://docs.envia.com/docs/workflows

An example of a successful response when scheduling a pickup, confirming the carrier, confirmation number, and scheduled time.

```json
{
  "meta": "pickup",
  "data": {
    "carrier": "dhl",
    "confirmation": "PKP-2025-001",
    "status": "scheduled",
    "date": "2025-10-10",
    "timeFrom": 10,
    "timeTo": 16
  }
}
```

--------------------------------

### Rate Response Example (JSON)

Source: https://docs.envia.com/docs/workflows

Example JSON response for a rate quote, detailing carrier, service, estimated delivery time, price, and currency.

```json
{
  "meta": "rate",
  "data": [
    {
      "carrier": "dhl",
      "service": "ground",
      "serviceDescription": "DHL Economy",
      "deliveryEstimate": "3-5 business days",
      "totalPrice": "185.20",
      "currency": "MXN"
    }
  ]
}
```

--------------------------------

### Pickup Confirmation Response Example

Source: https://docs.envia.com/docs/domestic-shipping-workflow

This is an example of the JSON response received after successfully scheduling a pickup. It includes meta information, carrier details, a confirmation number, status, and the scheduled date and time window.

```json
{
  "meta": "pickup",
  "data": {
    "carrier": "estafeta",
    "confirmation": "PKP-2025-001",
    "status": "scheduled",
    "date": "2025-01-27",
    "timeFrom": 10,
    "timeTo": 14
  }
}
```

--------------------------------

### Shipping Rate Response Example

Source: https://docs.envia.com/docs/quickstart

This is an example of the JSON response you can expect when requesting shipping rates.

```json
{
  "meta": "rate",
  "data": [
    {
      "carrier": "dhl",
      "service": "ground",
      "serviceDescription": "DHL Economy",
      "deliveryEstimate": "3-5 business days",
      "deliveryDate": {
        "date": "2025-10-11",
        "timeUnit": "days",
        "dateDifference": 3
      },
      "totalPrice": "185.20",
      "currency": "MXN"
    }
  ]
}
```

--------------------------------

### Shipping Manifest Response Example

Source: https://docs.envia.com/docs/shipping-multiple-packages

This is an example of the JSON response received after successfully creating a shipping manifest. It includes the manifest ID, a URL to the manifest document, the total number of packages, and the carrier.

```json
{
  "meta": "manifest",
  "data": {
    "manifestId": "MAN-2025-001",
    "manifestUrl": "https://files.envia.com/manifests/MAN-2025-001.pdf",
    "totalPackages": 3,
    "carrier": "dhl"
  }
}
```

--------------------------------

### Authenticate API Request with Bearer Token (Python)

Source: https://docs.envia.com/docs/authentication

Example of how to authenticate a GET request to the queries API using a Bearer token in the Authorization header. Ensure the ENVIA_TOKEN environment variable is set.

```python
import os
import requests

response = requests.get(
    "https://queries-test.envia.com/webhook-types",
    headers={"Authorization": f"Bearer {os.environ['ENVIA_TOKEN']}"},
)
data = response.json()
```

--------------------------------

### Shipment Creation Response Example

Source: https://docs.envia.com/docs/quickstart

JSON structure returned after successfully creating a shipping label.

```json
{
    "meta": "generate",
    "data": [
        {
            "carrier": "dhl",
            "service": "ground",
            "shipmentId": 166819,
            "trackingNumber": "7072262094",
            "folio": "",
            "trackUrl": "https:\/\/test.envia.com\/rastreo?label=7072262094&cntry_code=mx",
            "label": "https:\/\/s3.us-east-2.amazonaws.com\/envia-staging\/uploads\/dhl\/70722620941331699ce80043013.pdf",
            "packages": [
                {
                    "trackingNumber": "7072262094",
                    "trackUrl": "https:\/\/test.envia.com\/rastreo?label=7072262094&cntry_code=mx",
                    "content": "paquete 2",
                    "weight": 1,
                    "weightUnit": "KG"
                }
            ],
            "additionalFiles": [],
            "totalPrice": 271.65,
            "currentBalance": 9840370,
            "currency": "MXN"
        }
    ]
}
```

--------------------------------

### Domestic Shipment Example

Source: https://docs.envia.com/docs/mcp-overview

This example demonstrates a conversation flow for a domestic shipment within Mexico, including address validation, rate comparison, and label creation.

```text
You: Ship a 2 kg box (30×20×15 cm) from postal code 64000 in Monterrey
     to 03100 in Mexico City. Compare DHL and Estafeta rates.

AI:  [calls envia_validate_address for both postal codes]
     [calls envia_get_shipping_rates with carriers: dhl,estafeta]

     Here are your options:
       DHL Economy:      $185.20 MXN — 3-5 business days
       Estafeta Express: $210.00 MXN — 1-2 business days

     Would you like me to create a label with one of these?

You: Yes, go with DHL Economy.

AI:  [calls envia_create_label]

     Label created!
       Tracking: 7520610403
       Label PDF: https://...
```

--------------------------------

### cURL GET Request to Retrieve Shop Info

Source: https://docs.envia.com/reference/shop-by-url

Use this cURL command to make a GET request to the shop-info endpoint. Ensure you include the 'accept' header for JSON responses.

```Shell
curl --request GET \
     --url https://queries-test.envia.com/shop-info \
     --header 'accept: application/json'
```

--------------------------------

### Webhook registration response

Source: https://docs.envia.com/docs/webhooks

Example JSON response received after successfully registering a webhook.

```json
{
  "meta": "webhook_created",
  "data": {
    "id": 4421,
    "type": "...",
    "url": "https://your-app.com/webhooks/envia",
    "active": 1
  }
}
```

--------------------------------

### GET /carrier-action

Source: https://docs.envia.com/docs/pickups

Retrieves a list of supported actions for each carrier, including pickup capabilities.

```APIDOC
## GET /carrier-action

### Description
Retrieves a list of supported actions for each carrier, including pickup capabilities. This endpoint is crucial for determining how to schedule pickups for a specific carrier.

### Method
GET

### Endpoint
https://queries.envia.com/carrier-action

### Query Parameters
- **carrier_name** (string) - Optional - The name of the carrier to filter actions for.

### Response
#### Success Response (200)
- **data** (array) - An array of carrier action objects.
  - **id** (integer) - The unique identifier for the action.
  - **name** (string) - The name of the carrier.
  - **country_code** (string) - The country code associated with the carrier.
  - **action_id** (integer) - The ID of the action.
  - **action_name** (string) - The name of the action (e.g., 'pickup', 'rate', 'generate').

### Response Example
```json
[
  { "id": 184, "name": "fedex", "country_code": "MX", "action_id": 5, "action_name": "pickup" },
  { "id": 185, "name": "fedex", "country_code": "MX", "action_id": 1, "action_name": "rate" },
  { "id": 186, "name": "fedex", "country_code": "MX", "action_id": 2, "action_name": "generate" }
]
```
```

--------------------------------

### International Customs Classification Example

Source: https://docs.envia.com/docs/mcp-overview

This example shows how to get the correct HS code for international shipments, which is necessary for customs documentation.

```text
You: I need to ship handmade ceramic mugs from Mexico to the US.
     What HS code should I use?

AI:  [calls envia_classify_hscode]

     Recommended HS code: 6912.00 — Ceramic tableware
     This code is required for customs when creating an international label.
```

--------------------------------

### POST /all-packages

Source: https://docs.envia.com/reference/create-package

Creates a new package with the specified dimensions and weight. Requires authentication.

```APIDOC
## POST /all-packages

### Description
Creates a new package with specified dimensions and weight.

### Method
POST

### Endpoint
https://queries-test.envia.com/all-packages

### Parameters
#### Request Body
- **name** (string) - Required - Package name
- **length** (number) - Required - Package length
- **width** (number) - Required - Package width
- **height** (number) - Required - Package height
- **weight** (number) - Required - Package weight

### Request Example
```json
{
  "name": "Example Package",
  "length": 10,
  "width": 5,
  "height": 5,
  "weight": 2
}
```

### Response
#### Success Response (200)
- **message** (string) - Description of the success or details of the created package.

#### Response Example
```json
{
  "message": "Package created successfully."
}
```
```

--------------------------------

### Get Shipping Quote Request

Source: https://docs.envia.com/docs/international-shipping-workflow

This is an example of a request payload to get a shipping quote. It includes sender and receiver addresses, package details, and shipment settings.

```json
{
            "address": {
                "street": "123 Ocean Drive",
                "city": "Miami Beach",
                "state": "FL",
                "country": "US",
                "postalCode": "33139"
            },
            "packages": [{
                "type": "box",
                "content": "Leather wallet",
                "amount": 1,
                "declaredValue": 85,
                "weight": 0.2,
                "weightUnit": "KG",
                "lengthUnit": "CM",
                "dimensions": {
                    "length": 12,
                    "width": 9,
                    "height": 2
                },
                "items": [{
                    "description": "Handmade leather wallet",
                    "hsCode": "4202.31",
                    "quantity": 1,
                    "price": 85,
                    "countryOfManufacture": "MX"
                }]
            }],
            "shipment": {
                "type": 1,
                "carrier": "dhl"
            },
            "customsSettings": {
                "dutiesPaymentEntity": "envia_guaranteed",
                "exportReason": "sale"
            }
        }
```

--------------------------------

### Create Manifest using Python

Source: https://docs.envia.com/docs/shipping-multiple-packages

This Python script shows how to create a shipping manifest by making a POST request to the Envia API. It uses the `requests` library and expects the ENVIA_TOKEN to be set as an environment variable. The response contains the manifest ID and URL.

```python
import requests
import os
import json

# Tracking numbers from the label response
tracking_numbers = [
    "7520610403",  # Laptop
    "7520610404",  # Mouse and bag
    "7520610405"   # Warranty documents
]

response = requests.post(
    "https://api-test.envia.com/ship/manifest",
    headers={
        "Authorization": f"Bearer {os.getenv('ENVIA_TOKEN')}",
        "Content-Type": "application/json"
    },
    json={
        "trackingNumbers": tracking_numbers
    }
)

manifest = response.json()
print("Manifest ID:", manifest.get("manifestId"))
print("Manifest URL:", manifest.get("manifestUrl"))
# Returns manifest document with all tracking numbers listed
```

--------------------------------

### Get Shipping Quote with JavaScript

Source: https://docs.envia.com/docs/domestic-shipping-workflow

Use the fetch API in JavaScript to get a shipping quote. This example demonstrates how to set the Authorization header with your token and construct the JSON payload for the request. The response contains available services, prices, and delivery times.

```javascript
const response = await fetch("https://api-test.envia.com/ship/rate/", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ENVIA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    origin: {
      name: "Jessica Rodriguez",
      "company": "Jessica Boutique",
      phone: "+52 5551234567",
      email: "jessica@jessicaboutique.com",
      street: "Av. Insurgentes Sur 1647",
      city: "Ciudad de Mexico",
      state: "CX",
      country: "MX",
      postalCode: "03920",
    },
    destination: {
      name: "Ana Lopez",
      phone: "+52 8181234567",
      street: "Av. Constitución 123",
      city: "Monterrey",
      state: "NL",
      country: "MX",
      postalCode: "64060",
    },
    packages: [
      {
        type: "box",
        content: "Clothing",
        amount: 1,
        declaredValue: 450,
        weight: 0.5,
        weightUnit: "KG",
        lengthUnit: "CM",
        dimensions: {
          length: 30,
          width: 20,
          height: 10,
        },
      },
    ],
    shipment: {
      type: 1,
      carrier: "estafeta",
    },
  }),
});

const quote = await response.json();
console.log("Shipping quote:", quote);
// Response includes available services with prices and delivery times
```

--------------------------------

### Authenticate API Request with Bearer Token (cURL)

Source: https://docs.envia.com/docs/authentication

Example of how to authenticate a GET request to the queries API using a Bearer token in the Authorization header.

```bash
curl --request GET \
  --url https://queries-test.envia.com/webhook-types \
  --header "Authorization: Bearer $ENVIA_TOKEN"
```

--------------------------------

### Get Shipping Quote Response

Source: https://docs.envia.com/docs/international-shipping-workflow

This is an example of a shipping quote response. It includes carrier information, service details, delivery estimates, and total cost including duties and taxes.

```json
{
  "meta": "rate",
  "data": [
    {
      "carrier": "dhl",
      "service": "int_express",
      "serviceDescription": "DHL Express International",
      "deliveryEstimate": "2-3 business days",
      "totalPrice": "245.80",
      "currency": "USD",
      "shippingCost": "185.50",
      "dutiesAndTaxes": "60.30"
    }
  ]
}
```

--------------------------------

### Create a Multi-Package Shipment

Source: https://docs.envia.com/docs/shipping-multiple-packages

This example demonstrates creating a shipment with multiple packages. The API will calculate a combined shipping cost for all packages in the shipment.

```python
from shipping_api import Client

client = Client(api_key="YOUR_API_KEY")

shipment = {
    "origin": {
        "name": "Carlos Mendez",
        "company": "TechStore",
        "phone": "+52 5559876543",
        "email": "carlos@techstore.com",
        "street": "Av. Reforma 350",
        "city": "Ciudad de Mexico",
        "state": "CX",
        "country": "MX",
        "postalCode": "06500"
    },
    "destination": {
        "name": "Roberto Silva",
        "phone": "+52 3331234567",
        "street": "Av. Revolucion 456",
        "city": "Guadalajara",
        "state": "JA",
        "country": "MX",
        "postalCode": "44100"
    },
    "packages": [
        {
            "type": "box",
            "content": "Laptop",
            "amount": 1,
            "declaredValue": 15000,
            "weight": 2.5,
            "weightUnit": "KG",
            "lengthUnit": "CM",
            "dimensions": {
                "length": 40,
                "width": 30,
                "height": 5
            }
        },
        {
            "type": "box",
            "content": "Mouse and laptop bag",
            "amount": 1,
            "declaredValue": 1200,
            "weight": 0.8,
            "weightUnit": "KG",
            "lengthUnit": "CM",
            "dimensions": {
                "length": 25,
                "width": 20,
                "height": 10
            }
        },
        {
            "type": "envelope",
            "content": "Warranty documents",
            "amount": 1,
            "declaredValue": 0,
            "weight": 0.1,
            "weightUnit": "KG",
            "lengthUnit": "CM",
            "dimensions": {
                "length": 22,
                "width": 16,
                "height": 2
            }
        }
    ],
    "shipment": {
        "type": 1,
        "carrier": "dhl"
    }
}

response = client.create_shipment(shipment)
quote = response.json()
print("Multi-package quote:", quote)
# Response includes total cost for shipping all packages together
```

--------------------------------

### Configure Envia API Base URLs and Token (Python)

Source: https://docs.envia.com/docs/marketplace-multi-seller

Set up the base URLs for Envia's API endpoints and retrieve your authentication token from environment variables. Defaults to sandbox environment.

```python
# Configuration — defaults to sandbox
ENVIA_BASE   = "https://api-test.envia.com"
QUERIES_BASE = "https://queries-test.envia.com"
GEOCODES_BASE = "https://geocodes.envia.com"
ENVIA_TOKEN  = os.environ["ENVIA_TOKEN"]
```

--------------------------------

### Create Multi-Package Shipping Label

Source: https://docs.envia.com/docs/shipping-multiple-packages

Examples for generating a shipping label for multiple packages using cURL, JavaScript, and Python.

```bash
curl --request POST \
  --url "https://api-test.envia.com/ship/generate/" \
  --header "Authorization: Bearer $ENVIA_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "origin": {
      "name": "Carlos Mendez",
      "company": "TechStore",
      "phone": "+52 5559876543",
      "email": "carlos@techstore.com",
      "street": "Av. Reforma 350",
      "city": "Ciudad de Mexico",
      "state": "CX",
      "country": "MX",
      "postalCode": "06500"
    },
    "destination": {
      "name": "Roberto Silva",
      "phone": "+52 3331234567",
      "street": "Av. Revolucion 456",
      "city": "Guadalajara",
      "state": "JA",
      "country": "MX",
      "postalCode": "44100"
    },
    "packages": [
      {
        "type": "box",
        "content": "Laptop",
        "amount": 1,
        "declaredValue": 15000,
        "weight": 2.5,
        "weightUnit": "KG",
        "lengthUnit": "CM",
        "dimensions": {
          "length": 40,
          "width": 30,
          "height": 5
        }
      },
      {
        "type": "box",
        "content": "Mouse and laptop bag",
        "amount": 1,
        "declaredValue": 1200,
        "weight": 0.8,
        "weightUnit": "KG",
        "lengthUnit": "CM",
        "dimensions": {
          "length": 25,
          "width": 20,
          "height": 10
        }
      },
      {
        "type": "envelope",
        "content": "Warranty documents",
        "amount": 1,
        "declaredValue": 0,
        "weight": 0.1,
        "weightUnit": "KG",
        "lengthUnit": "CM",
        "dimensions": {
          "length": 22,
          "width": 16,
          "height": 2
        }
      }
    ],
    "shipment": {
      "type": 1,
      "carrier": "dhl",
      "service": "ground"
    }
  }'
```

```javascript
const response = await fetch("https://api-test.envia.com/ship/generate/", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ENVIA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    origin: {
      name: "Carlos Mendez",
      company: "TechStore",
      phone: "+52 5559876543",
      email: "carlos@techstore.com",
      street: "Av. Reforma 350",
      city: "Ciudad de Mexico",
      state: "CX",
      country: "MX",
      postalCode: "06500",
    },
    destination: {
      name: "Roberto Silva",
      phone: "+52 3331234567",
      street: "Av. Revolucion 456",
      city: "Guadalajara",
      state: "JA",
      country: "MX",
      postalCode: "44100",
    },
    packages: [
      {
        type: "box",
        content: "Laptop",
        amount: 1,
        declaredValue: 15000,
        weight: 2.5,
        weightUnit: "KG",
        lengthUnit: "CM",
        dimensions: {
          length: 40,
          width: 30,
          height: 5,
        },
      },
      {
        type: "box",
        content: "Mouse and laptop bag",
        amount: 1,
        declaredValue: 1200,
        weight: 0.8,
        weightUnit: "KG",
        lengthUnit: "CM",
        dimensions: {
          length: 25,
          width: 20,
          height: 10,
        },
      },
      {
        type: "envelope",
        content: "Warranty documents",
        amount: 1,
        declaredValue: 0,
        weight: 0.1,
        weightUnit: "KG",
        lengthUnit: "CM",
        dimensions: {
          length: 22,
          width: 16,
          height: 2,
        },
      },
    ],
    shipment: {
      type: 1,
      carrier: "dhl",
      service: "ground", // Service code from quote
    },
  }),
});

const label = await response.json();
console.log("Tracking numbers:", label.trackingNumbers);
console.log("Label PDF:", label.label);
// Response includes tracking numbers for all packages and combined label
```

```python
import requests
import os
import json

response = requests.post(
    "https://api-test.envia.com/ship/generate/",
    headers={
```

--------------------------------

### GET /country - Get all countries

Source: https://docs.envia.com/reference/all-countries

Retrieves a list of countries from which you can ship products. This endpoint also provides the current exchange rate from USD to other currencies.

```APIDOC
## GET /country

### Description
Envia.com has integrations with couriers around the world. With this request you can obtain a list of countries you can Ship **From**. You will be able to ship your products domestically and internationally from these countries. Use this request to obtain the current exchange rate from USD to other currencies.

### Method
GET

### Endpoint
/country

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - List of countries
  - **id** (integer) - The id of the country in Envia.com
  - **value** (number) - The current exchange rate against USD
  - **currency** (string) - Currency Code
  - **country_code** (string) - Iso Country Code in two digits
  - **country_name** (string) - Country Name

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "value": 1.0,
      "currency": "USD",
      "country_code": "US",
      "country_name": "United States"
    },
    {
      "id": 2,
      "value": 0.92,
      "currency": "EUR",
      "country_code": "DE",
      "country_name": "Germany"
    }
  ]
}
```
```

--------------------------------

### Schedule Pickup using JavaScript

Source: https://docs.envia.com/docs/domestic-shipping-workflow

Schedule a package pickup with the Envia API using JavaScript's fetch API. This example demonstrates setting the Authorization header and sending a JSON payload. The response contains pickup confirmation details.

```javascript
const response = await fetch("https://api-test.envia.com/ship/pickup/", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ENVIA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    carrier: "estafeta",
    pickupAddress: {
      name: "Jessica Rodriguez",
      company: "Jessica Boutique",
      phone: "+52 5551234567",
      email: "jessica@jessicaboutique.com",
      street: "Av. Insurgentes Sur 1647",
      city: "Ciudad de Mexico",
      state: "CX",
      country: "MX",
      postalCode: "03920",
    },
    pickupDate: "2025-01-27",
    pickupTimeStart: "10:00",
    pickupTimeEnd: "14:00",
    trackingNumbers: [
      "EST123456789", // Monterrey order
      "EST987654321", // Guadalajara order
      "EST456789123", // Cancún order
    ],
  }),
});

const pickup = await response.json();
console.log("Pickup scheduled:", pickup);
// Returns pickup confirmation with expected arrival time
```

--------------------------------

### Get Shipping Rate (Python)

Source: https://docs.envia.com/docs/quickstart

This Python script uses the requests library to get shipping rates. It retrieves the API token from environment variables.

```python
import os
import requests

payload = {
    "origin": {
        "name": "Warehouse MX",
        "phone": "+52 8180000000",
        "street": "Av. Benito Juarez",
        "city": "Monterrey",
        "state": "NL",
        "country": "MX",
        "postalCode": "64060",
    },
    "destination": {
        "name": "Luis Perez",
        "phone": "+52 5511111111",
        "street": "Insurgentes Sur",
        "city": "Ciudad de Mexico",
        "state": "CX",
        "country": "MX",
        "postalCode": "03100",
    },
    "packages": [
        {
            "type": "box",
            "content": "T-shirts",
            "amount": 1,
            "declaredValue": 1200,
            "lengthUnit": "CM",
            "weightUnit": "KG",
            "weight": 2.5,
            "dimensions": {"length": 30, "width": 20, "height": 10},
        }
    ],
    "shipment": {"type": 1, "carrier": "dhl"},
}

response = requests.post(
    "https://api-test.envia.com/ship/rate/",
    headers={"Authorization": f"Bearer {os.environ['ENVIA_SANDBOX_TOKEN']}"},
    json=payload,
)
print(response.json())
```

--------------------------------

### Example API Rate Response

Source: https://docs.envia.com/docs/concepts

A sample JSON response showing both the simple deliveryEstimate string and the detailed deliveryDate object.

```json
{
  "carrier": "fedex",
  "service": "express",
  "deliveryEstimate": "1-2 days",
  "deliveryDate": {
    "date": "2026-03-06",
    "dateDifference": 2,
    "timeUnit": "days",
    "time": "18:00"
  },
  "totalPrice": "285.50"
}
```

--------------------------------

### Configure Envia API Base URLs and Token (JavaScript)

Source: https://docs.envia.com/docs/marketplace-multi-seller

Set up the base URLs for Envia's API endpoints and ensure your authentication token is configured. Defaults to sandbox environment.

```javascript
// Configuration — defaults to sandbox
const ENVIA_BASE   = "https://api-test.envia.com";
const QUERIES_BASE = "https://queries-test.envia.com";
const GEOCODES_BASE = "https://geocodes.envia.com";
// Set ENVIA_TOKEN as an environment variable (see Authentication guide)
```

--------------------------------

### Shipping API Response Example

Source: https://docs.envia.com/docs/shipping-multiple-packages

This is an example of a successful response from the Shipping API when requesting a quote. It details the carrier, service, delivery estimate, and total price.

```json
{
  "meta": "rate",
  "data": [
    {
      "carrier": "dhl",
      "service": "ground",
      "serviceDescription": "DHL Economy",
      "deliveryEstimate": "3-5 business days",
      "totalPrice": "285.40",
      "currency": "MXN"
    }
  ]
}
```

--------------------------------

### Schedule Shipment Pickup with Python

Source: https://docs.envia.com/docs/core-workflow

Use the requests library in Python to schedule a shipment pickup. Ensure the ENVIA_TOKEN environment variable is set.

```python
import os
import requests

requests.post(
    "https://api-test.envia.com/ship/pickup/",
    headers={"Authorization": f"Bearer {os.environ['ENVIA_TOKEN']}"},
    json={
        "origin": {
            "name": "Warehouse MX",
            "phone": "+52 8180000000",
            "street": "Av. Benito Juarez",
            "city": "Monterrey",
            "state": "NL",
            "country": "MX",
            "postalCode": "64060",
        },
        "shipment": {
            "type": 1,
            "carrier": "dhl",
            "pickup": {
                "weightUnit": "KG",
                "totalWeight": 2.5,
                "totalPackages": 1,
                "date": "2025-10-10",
                "timeFrom": 10,
                "timeTo": 16,
                "carrier": "dhl",
                "trackingNumbers": ["7520610403"],
                "instructions": "Ring the loading dock bell",
            },
        },
    },
)
```

--------------------------------

### onShipmentStatusUpdate Payload Example

Source: https://docs.envia.com/reference/webhooks

Example JSON payload for the legacy v1 onShipmentStatusUpdate webhook type. Use this for basic integrations requiring only carrier, tracking, and status information.

```json
{
  "carrierName": "fedex",
  "trackingNumber": "100000",
  "status": "Delivered"
}
```

--------------------------------

### Schedule Daily Pickup using cURL

Source: https://docs.envia.com/docs/pickup-manifest-workflow

Use this cURL command to schedule a pickup. Ensure your ENVIA_TOKEN is set and verify the request shape against the API reference.

```bash
curl --request POST \
  --url "https://api-test.envia.com/ship/pickup/" \
  --header "Authorization: Bearer $ENVIA_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{ \
    "carrier": "estafeta", \
    "pickupAddress": { \
      "name": "Ana Garcia", \
      "company": "MegaStore Warehouse", \
      "phone": "+52 5551112233", \
      "email": "ana@megastore.com", \
      "street": "Av. Industrial 500", \
      "city": "Ciudad de Mexico", \
      "state": "CX", \
      "country": "MX", \
      "postalCode": "07800" \
    }, \
    "pickupDate": "2025-01-27", \
    "pickupTimeStart": "16:00", \
    "pickupTimeEnd": "18:00", \
    "trackingNumbers": [ \
      "EST123456789", \
      "EST123456790", \
      "EST123456791" \
      # ... (all 50+ tracking numbers) \
    ] \
  }'
```

--------------------------------

### cURL Request to Get Country Locale

Source: https://docs.envia.com/reference/country-locale

Use this cURL command to make a GET request to the locale API. Ensure you replace 'country_code' with the desired two-digit country code.

```shell
curl --request GET \
     --url https://queries-test.envia.com/locale/country_code \
     --header 'accept: application/json'
```

--------------------------------

### Schedule Daily Pickup using Python

Source: https://docs.envia.com/docs/pickup-manifest-workflow

Schedule a pickup for all packages using Python. This function requires the ENVIA_TOKEN to be set as an environment variable and accepts a list of tracking numbers.

```python
import requests
import os
import json

# Ana schedules one pickup for all packages
def schedule_daily_pickup(tracking_numbers):
    response = requests.post(
        "https://api-test.envia.com/ship/pickup/",
        headers={
            "Authorization": f"Bearer {os.getenv('ENVIA_TOKEN')}",
            "Content-Type": "application/json"
        },
        json={
            "carrier": "estafeta",
            "pickupAddress": {
                "name": "Ana Garcia",
                "company": "MegaStore Warehouse",
                "phone": "+52 5551112233",
                "email": "ana@megastore.com",
                "street": "Av. Industrial 500",
                "city": "Ciudad de Mexico",
                "state": "CX",
                "country": "MX",
                "postalCode": "07800"
            },
            "pickupDate": "2025-01-27",
            "pickupTimeStart": "16:00",
            "pickupTimeEnd": "18:00",
            "trackingNumbers": tracking_numbers  # All 50+ tracking numbers
        }
    )

    pickup = response.json()
    print("Pickup scheduled:", pickup)
    print("Expected pickup time:", pickup.get("pickupWindow"))
    return pickup

# Ana schedules the pickup
pickup_confirmation = schedule_daily_pickup(all_tracking_numbers)
```

--------------------------------

### Create Manifest with Tracking Numbers (Python)

Source: https://docs.envia.com/docs/pickup-manifest-workflow

This Python function uses the requests library to create a shipping manifest. It requires the ENVIA_TOKEN to be set as an environment variable. The function prints the manifest ID, URL, and total number of packages after a successful request.

```python
import requests
import os
import json

# At end of day, Ana creates manifest with all tracking numbers
def create_daily_manifest(tracking_numbers):
    response = requests.post(
        "https://api-test.envia.com/ship/manifest",
        headers={
            "Authorization": f"Bearer {os.getenv('ENVIA_TOKEN')}",
            "Content-Type": "application/json"
        },
        json={
            "trackingNumbers": tracking_numbers  # List of 50+ tracking numbers
        }
    )

    manifest = response.json()
    print(f"Manifest ID: {manifest['manifestId']}")
    print(f"Manifest URL: {manifest['manifestUrl']}")
    print(f"Total packages: {len(tracking_numbers)}")

    return manifest

# Ana creates the manifest
daily_manifest = create_daily_manifest(all_tracking_numbers)
# Manifest document is ready to print for warehouse and carrier

```

--------------------------------

### Get Available Services cURL Request

Source: https://docs.envia.com/reference/available-services

Use this cURL command to make a GET request to the available services endpoint. Ensure you replace placeholder values with actual data.

```shell
curl --request GET \
     --url https://queries-test.envia.com/available-service/country/international/shipment_type_id \
     --header 'accept: application/json'
```

--------------------------------

### Get Available Carriers cURL Request

Source: https://docs.envia.com/reference/available-carriers-by-shipment-type

Use this cURL command to make a GET request to the available carriers endpoint. Ensure you replace placeholder values with actual data.

```shell
curl --request GET \
     --url https://queries-test.envia.com/available-carrier/country/international/shipment_type_id \
     --header 'accept: application/json'
```

--------------------------------

### Schedule Daily Pickup using JavaScript

Source: https://docs.envia.com/docs/pickup-manifest-workflow

Schedule a pickup for all packages using JavaScript. This function requires the ENVIA_TOKEN to be set in the environment variables and accepts an array of tracking numbers.

```javascript
// Ana schedules one pickup for all packages
async function scheduleDailyPickup(trackingNumbers) {
  const response = await fetch("https://api-test.envia.com/ship/pickup/", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.ENVIA_TOKEN}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      carrier: "estafeta",
      pickupAddress: {
        name: "Ana Garcia",
        company: "MegaStore Warehouse",
        phone: "+52 5551112233",
        email: "ana@megastore.com",
        street: "Av. Industrial 500",
        city: "Ciudad de Mexico",
        state: "CX",
        country: "MX",
        postalCode: "07800",
      },
      pickupDate: "2025-01-27",
      pickupTimeStart: "16:00",
      pickupTimeEnd: "18:00",
      trackingNumbers: trackingNumbers, // All 50+ tracking numbers
    }),
  });

  const pickup = await response.json();
  console.log("Pickup scheduled:", pickup);
  console.log("Expected pickup time:", pickup.pickupWindow);
  return pickup;
}

// Ana schedules the pickup
const pickupConfirmation = await scheduleDailyPickup(allTrackingNumbers);
```

--------------------------------

### Get Services by Carrier and Country (cURL)

Source: https://docs.envia.com/reference/services-by-carrier-and-country

Use this cURL request to retrieve shipping service levels for a specific carrier and country. Omit the carrier parameter to get all services for the country.

```shell
curl --request GET \
     --url https://queries-test.envia.com/service \
     --header 'accept: application/json'
```

--------------------------------

### Create Package cURL Request

Source: https://docs.envia.com/reference/create-package

Use this cURL command to create a new package with specified dimensions and weight. Ensure you include the 'accept' and 'content-type' headers.

```Shell
curl --request POST \
     --url https://queries-test.envia.com/all-packages \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

--------------------------------

### Get All Addresses cURL Request

Source: https://docs.envia.com/reference/all-addresses

Use this cURL command to make a GET request to retrieve all addresses for the authenticated user. Ensure you include a valid JWT token in the Authorization header.

```shell
curl --request GET \
     --url https://queries-test.envia.com/all-addresses \
     --header 'accept: application/json'
```

--------------------------------

### Create Manifest with Tracking Numbers

Source: https://docs.envia.com/docs/pickup-manifest-workflow

Use this endpoint to create a manifest by providing a list of tracking numbers. Ensure all tracking numbers belong to the same carrier and service for a successful manifest creation. This is typically done at the end of the day before carrier pickup.

```bash
# Ana creates manifest with all tracking numbers from the day
curl --request POST \
  --url "https://api-test.envia.com/ship/manifest" \
  --header "Authorization: Bearer $ENVIA_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{ \
    "trackingNumbers": [ \
      "EST123456789", \
      "EST123456790", \
      "EST123456791", \
      "EST123456792", \
      "EST123456793" \
      # ... (50+ tracking numbers) \
    ] \
  }'
```

--------------------------------

### Generate shipping label via API

Source: https://docs.envia.com/docs/core-workflow

Use these examples to purchase a shipping label and receive tracking details. Ensure the ENVIA_TOKEN environment variable is set for authentication.

```bash
curl --request POST \
  --url https://api-test.envia.com/ship/generate/ \
  --header "Authorization: Bearer $ENVIA_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "origin": {
      "name": "Warehouse MX",
      "phone": "+52 8180000000",
      "street": "Av. Benito Juarez",
      "city": "Monterrey",
      "state": "NL",
      "country": "MX",
      "postalCode": "64060"
    },
    "destination": {
      "name": "Luis Perez",
      "phone": "+52 5511111111",
      "street": "Insurgentes Sur",
      "city": "Ciudad de Mexico",
      "state": "CX",
      "country": "MX",
      "postalCode": "03100"
    },
    "packages": [
      {
        "type": "box",
        "content": "T-shirts",
        "amount": 1,
        "declaredValue": 1200,
        "lengthUnit": "CM",
        "weightUnit": "KG",
        "weight": 2.5,
        "dimensions": {"length": 30, "width": 20, "height": 10}
      }
    ],
    "shipment": {"type": 1, "carrier": "dhl", "service": "ground"}
  }'
```

```javascript
await fetch("https://api-test.envia.com/ship/generate/", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ENVIA_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    origin: {
      name: "Warehouse MX",
      phone: "+52 8180000000",
      street: "Av. Benito Juarez",
      city: "Monterrey",
      state: "NL",
      country: "MX",
      postalCode: "64060",
    },
    destination: {
      name: "Luis Perez",
      phone: "+52 5511111111",
      street: "Insurgentes Sur",
      city: "Ciudad de Mexico",
      state: "CX",
      country: "MX",
      postalCode: "03100",
    },
    packages: [
      {
        type: "box",
        content: "T-shirts",
        amount: 1,
        declaredValue: 1200,
        lengthUnit: "CM",
        weightUnit: "KG",
        weight: 2.5,
        dimensions: { length: 30, width: 20, height: 10 },
      },
    ],
    shipment: { type: 1, carrier: "dhl", service: "ground" },
  }),
});
```

```python
import os
import requests

requests.post(
    "https://api-test.envia.com/ship/generate/",
    headers={"Authorization": f"Bearer {os.environ['ENVIA_TOKEN']}"},
    json={
        "origin": {
            "name": "Warehouse MX",
            "phone": "+52 8180000000",
            "street": "Av. Benito Juarez",
            "city": "Monterrey",
            "state": "NL",
            "country": "MX",
            "postalCode": "64060",
        },
        "destination": {
            "name": "Luis Perez",
            "phone": "+52 5511111111",
            "street": "Insurgentes Sur",
            "city": "Ciudad de Mexico",
            "state": "CX",
            "country": "MX",
            "postalCode": "03100",
        },
        "packages": [
            {
                "type": "box",
                "content": "T-shirts",
                "amount": 1,
                "declaredValue": 1200,
                "lengthUnit": "CM",
                "weightUnit": "KG",
                "weight": 2.5,
                "dimensions": {"length": 30, "width": 20, "height": 10},
            }
        ],
        "shipment": {"type": 1, "carrier": "dhl", "service": "ground"},
    },
)
```
Tokens:
Raw