docs.envia.com Open in urlscan Pro
52.72.19.111  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (0)

 * Body
 * Headers (14)




Public


Documentation Settings

ENVIRONMENT
prod

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Shipping API - Multi Carrier Solution for Ecommerce | Envia Shipping Software
Introduction
Authentication
Shipping Methods
Address Validation
Couriers
Shipments & Pickups Logs
Addresses
Packages
Shops / E-commerce
Payment
Webhooks
Oauth
Login
Notifications
Colombia Specifics
NDR (India)


SHIPPING API - MULTI CARRIER SOLUTION FOR ECOMMERCE | ENVIA SHIPPING SOFTWARE


SHIPPING API TO CONNECT WITH OVER 100 COURIERS WORLDWIDE.

Shipping made simple for e-commerces and enterprises.

Envia's Shipping Web Services, offers solutions that applications can use to
quote, create labels, request pickups, track packages, cancel shipments and many
other logistics operations in USA, Mexico, Colombia, India, Canada, Spain,
Argentina, Uruguay, Chile and Guatemala.

Integrate your online store, application or any business with over 100 shipping
couriers in the world instantly.

Connect your Ecommerce or App and simplify your logistics with multiple shipping
couriers. Our API lets you create shipments in a dynamic and automated way. Use
a JSON type request/response for easier management and control of the
information.

You can find examples in the right hand side panel. You can also find the
requests of the API in various programming languages such as Curl, Ruby, Python,
PHP, Java, Node JS.

Do you need help?

Contact an IT consultant.

AUTHORIZATIONBasic Auth


AUTHENTICATION

Sandbox/test Environment

Free and easy to use test environment.

Follow the following steps to set your Sandbox account:

1. Sign up:

https://ship-test.envia.com/

2. Create you API Token:

https://ship-test.envia.com/configuraciones/integraciones

This token is needed for all api methods.

3. API Endpoint (base url):

https://api-test.envia.com/

4. Queries Endpoint (base url):

https://queries-test.envia.com/

*Be sure you have everything fully integrated and working properly in the
Sandbox Environment, before using the Production Environment.

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

PRODUCTION

After you have successfully tested your development. Proceed to use our
production environment.

For Production, follow the next steps:

1. Sign up in:

https://ship.envia.com/

2. Get API Token:

https://ship.envia.com/configuraciones/integraciones

3. API Endpoint (base url):

https://api.envia.com/

4. Queries Endpoint (base url):

https://queries.envia.com/

Authentication Type: Bearer Token

Ex:

CURLOPT_HTTPHEADER => array('
Content-Type: application/json',
'Authorization: Bearer
a8263479582e3cd732a0963b243126d26675273cc0be27cd3xx81d2a8xxxxxxx’
)

AUTHORIZATIONBearer Token
Token


SHIPPING METHODS

Shipping actions let you make requests to Quote, Generate, Cancel, Pickup, Track
or Create Bill of Lading.

You can dynamically create shipping labels with over 100 carriers:

Get the supported carrier list by country here: Carrier list

AUTHORIZATIONBearer Token




POSTQUOTE SHIPMENT


https://api.envia.com/ship/rate/

Get a quote with multiple carriers and choose the best one for your shipment!
Find pre established examples in the right hand side section.

Important Information:

 * State codes must be 2 digits.

 * Country codes must be 2 digits.

 * Validate the shipping address structure.

 * Make sure the zip code or locality are correct.

Carriers and Services:

   
 * Available Carriers.
   
 * Available Services by Carrier. (Service type = name)
   

*Address input vary by country. To obtain the required information for each
country you should use the following endpoint.

Address Information.

Custom Keys (optional):

Custom Keys are used when you have a direct account with a carrier. This way you
create labels with your rates with an additional small fee for service.

Click here to update your clients keys.

This will automatically change the requests directly to the carrier, using your
own account.

View More

FieldOptions(origin or
destination).countryhttps://queries.envia.com/country(origin or
destination).statehttp://queries.envia.com/state?country_code=MXpackage.typeenvelope,
box, palletpackage.lenghtUnitCM, INpackage.weightUnitKG,
LBshipment.carrierhttp://queries.envia.com/carrier?country_code=MXshipment.servicehttps://queries.envia.com/service?country_code=MXshipment.residential
(default=true)true, falseshipment.customsTaxes (International Shipments
default=recipient)sender, recipient, third_partyshipment.deliverySignature
(International Shipments default=nsr)asr (Adult Signature), nsr (No Signature),
dsr (Direct Signature), isr (Indirect Signature)settings.currencyUSD, MXN, CLP,
COP, INR(Get full list)settings.printFormatPDF, PNG,
ZPLIIsettings.printSizePAPER_7X4.75, STOCK_4X6settings.cashOnDelivery
(Optional)2000.00 (Integer)settings.comments (Optional)Blue house with big
trees.

AUTHORIZATIONBearer Token
Token

HEADERS
Content-Type

application/json

Authorization

Bodyraw
View More

{
    "origin": {
        "name": "Alex",
        "company": "envia",
        "email": "noreply@envia.com",
        "phone": "8110000ewdased000",
        "street": "shreeji sadan 24 bhandarkar rd",
        "number": "opposite matunga kabutar khana",
        "district": "",
        "city": "Monterrey",
        "state": "NL",
        "category": 1,
        "country": "MX",
        "postalCode": "66236",
        "reference": "",
        "coordinates": {
            "latitude": "19.027686",
            "longitude": "72.853462"
        }
    },
    "destination": {
        "name": "new delhi",
        "company": "new delhi",
        "email": "new@delhi.com",
        "phone": "8180000000",
        "street": "yashwant place commercial complex",
        "number": "123",
        "district": "",
        "city": "Monterrey",
        "state": "NL",
        "category": 1,
        "country": "MX",
        "postalCode": "66236",
        "reference": "",
        "coordinates": {
            "latitude": "28.578938",
            "longitude": "77.165053"
        }
    },
    "packages": [
        {
            "content": "shoes",
            "boxCode": "",
            "amount": 1,
            "type": "box",
            "weight": 1,
            "insurance": 0,
            "declaredValue": 0,
            "weightUnit": "KG",
            "lengthUnit": "CM",
            "dimensions": {
                "length": 11,
                "width": 15,
                "height": 20
            }
        }
    ],
    "shipment": {
        "carrier": "fedex",
        "service": "ground",
        "type": 1
    },
    "settings": {
        "printFormat": "PDF",
        "printSize": "STOCK_4X6",
        "currency": "USD",
        "cashOnDelivery" :"1000.00",
        "comments": ""
    },
    "additionalServices": []
}

Example Request
USA

View More
curl


curl --location 'https://api.envia.com/ship/rate/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "origin": {
        "name": "USA",
        "company": "enviacommarcelo",
        "email": "juanpedrovazez@hotmail.com",
        "phone": "8182000536",
        "street": "351523",
        "number": "crescent ave",
        "district": "other",
        "city": "dallas",
        "state": "tx",
        "country": "US",
        "postalCode": "75205",
        "reference": "",
        "coordinates": {
            "latitude": "32.776272",
            "longitude": "-96.796856"
        }
    },
    "destination": {
        "name": "francisco",
        "company": "",
        "email": "",
        "phone": "8180180543",
        "street": "4th street",
        "number": "24",
        "district": "other",
        "city": "reno",
        "state": "nv",
        "country": "US",
        "postalCode": "89503",
        "reference": "",
        "coordinates": {
            "latitude": "39.512132",
            "longitude": "-119.906585"
        }
    },
    "packages": [
        {
            "content": "zapatos",
            "amount": 1,
            "type": "box",
            "weight": 1,
            "insurance": 0,
            "declaredValue": 0,
            "weightUnit": "LB",
            "lengthUnit": "IN",
            "dimensions": {
                "length": 11,
                "width": 15,
                "height": 20
            }
        }
    ],
    "shipment": {
        "carrier": "usps",
        "type": 1
    },
    "settings": {
        "currency": "USD"
    }
}'

Example Response
 * Body
 * Headers (0)

View More
json


{
  "meta": "rate",
  "data": [
    {
      "carrier": "usps",
      "service": "priority_cpp",
      "serviceDescription": "Usps Priority CPP",
      "zone": null,
      "deliveryEstimate": "1-3 días",
      "deliveryDate": {
        "date": "2021-06-07",
        "time": "22:00",
        "dateDifference": 3,
        "timeUnit": "days"
      },
      "quantity": 1,
      "basePrice": 65.42,
      "extendedFare": 0,
      "insurance": 0,
      "additionalServices": 0,
      "totalPrice": 5.42,
      "currency": "USD",
      "customKey": false,
      "importFee": 0,
      "taxes": 0,
      "cashOnDeliveryCommission": 0,
      "cashOnDeliveryAmount": 0,
      "customKeyCost": 0,
      "smsCost": 0,
      "whatsappCost": 0,
      "costSummary": [
        {
          "quantity": 1,
          "basePrice": 5.42,
          "extendedFare": 0,
          "insurance": 0,
          "additionalServices": 0,
          "totalPrice": 5.42,
          "currency": "USD",
          "customKey": false,
          "cashOnDeliveryCommission": 0,
          "cashOnDeliveryAmount": 0,
          "customKeyCommission": 0,
          "smsCommission": 0,
          "importFee": 0,
          "taxes": 0,
          "whatsappCommission": 0,
          "folio": null
        }
      ]
    },
    {
      "carrier": "usps",
      "service": "priority_mail_express_cpp",
      "serviceDescription": "Usps Priority Mail Express CPP",
      "zone": null,
      "deliveryEstimate": "1-2 días",
      "deliveryDate": {
        "date": "2021-06-04",
        "time": "22:00",
        "dateDifference": 2,
        "timeUnit": "days"
      },
      "quantity": 1,
      "basePrice": 38.24,
      "extendedFare": 0,
      "insurance": 0,
      "additionalServices": 0,
      "totalPrice": 38.24,
      "currency": "USD",
      "customKey": false,
      "importFee": 0,
      "taxes": 0,
      "cashOnDeliveryCommission": 0,
      "cashOnDeliveryAmount": 0,
      "customKeyCost": 0,
      "smsCost": 0,
      "whatsappCost": 0,
      "costSummary": [
        {
          "quantity": 1,
          "basePrice": 38.24,
          "extendedFare": 0,
          "insurance": 0,
          "additionalServices": 0,
          "totalPrice": 38.24,
          "currency": "USD",
          "customKey": false,
          "cashOnDeliveryCommission": 0,
          "cashOnDeliveryAmount": 0,
          "customKeyCommission": 0,
          "smsCommission": 0,
          "importFee": 0,
          "taxes": 0,
          "whatsappCommission": 0,
          "folio": null
        }
      ]
    },
    {
      "carrier": "usps",
      "service": "parcel_select_ground",
      "serviceDescription": "Usps Parcel Select Ground",
      "zone": null,
      "deliveryEstimate": "2-8 días",
      "deliveryDate": {
        "date": "2021-06-14",
        "time": "22:00",
        "dateDifference": 8,
        "timeUnit": "days"
      },
      "quantity": 1,
      "basePrice": 6.78,
      "extendedFare": 0,
      "insurance": 0,
      "additionalServices": 0,
      "totalPrice": 6.78,
      "currency": "USD",
      "customKey": false,
      "importFee": 0,
      "taxes": 0,
      "cashOnDeliveryCommission": 0,
      "cashOnDeliveryAmount": 0,
      "customKeyCost": 0,
      "smsCost": 0,
      "whatsappCost": 0,
      "costSummary": [
        {
          "quantity": 1,
          "basePrice": 6.78,
          "extendedFare": 0,
          "insurance": 0,
          "additionalServices": 0,
          "totalPrice": 6.78,
          "currency": "USD",
          "customKey": false,
          "cashOnDeliveryCommission": 0,
          "cashOnDeliveryAmount": 0,
          "customKeyCommission": 0,
          "smsCommission": 0,
          "importFee": 0,
          "taxes": 0,
          "whatsappCommission": 0,
          "folio": null
        }
      ]
    },
    {
      "carrier": "usps",
      "service": "priority_mail_cubic",
      "serviceDescription": "Usps Priority Mail Cubic",
      "zone": null,
      "deliveryEstimate": "1-3 días",
      "deliveryDate": {
        "date": "2021-06-07",
        "time": "22:00",
        "dateDifference": 3,
        "timeUnit": "days"
      },
      "quantity": 1,
      "basePrice": 9.86,
      "extendedFare": 0,
      "insurance": 0,
      "additionalServices": 0,
      "totalPrice": 9.86,
      "currency": "USD",
      "customKey": false,
      "importFee": 0,
      "taxes": 0,
      "cashOnDeliveryCommission": 0,
      "cashOnDeliveryAmount": 0,
      "customKeyCost": 0,
      "smsCost": 0,
      "whatsappCost": 0,
      "costSummary": [
        {
          "quantity": 1,
          "basePrice": 9.86,
          "extendedFare": 0,
          "insurance": 0,
          "additionalServices": 0,
          "totalPrice": 9.86,
          "currency": "USD",
          "customKey": false,
          "cashOnDeliveryCommission": 0,
          "cashOnDeliveryAmount": 0,
          "customKeyCommission": 0,
          "smsCommission": 0,
          "importFee": 0,
          "taxes": 0,
          "whatsappCommission": 0,
          "folio": null
        }
      ]
    }
  ]
}

No response headers
This request doesn't return any response headers


POSTCREATE LABEL


https://api.envia.com/ship/generate/

Create a shipping label with a carrier, select if you would like express or
ground shipping.

Important Information:

   States and Countries:

 * State codes must be 2 digits.

 * Country codes must be 2 digits.

   
   Carriers and Services:

 * Available Carriers.

 * Available Services by Carrier.(Service type = name)

Custom Keys (optional):

Custom Keys are used when you have a direct account with a carrier. This way you
create labels with your rates with an additional small fee for service.

Click here to update your clients keys.

This will automatically change the requests directly to the carrier, using your
own account.

FieldOptions(origin or
destination).countryhttps://queries.envia.com/country(origin or
destination).statehttp://queries.envia.com/state?country_code=MXpackage.typeenvelope,
box, palletpackage.lenghtUnitCM, INpackage.weightUnitKG,
LBshipment.carrierhttp://queries.envia.com/carrier?country_code=MXshipment.servicehttps://queries.envia.com/service?country_code=MXsettings.printFormat
and printSizehttps://queries.envia.com/carrier-print-optionadditionalServices
(LTL or FTL ONLY)https://queries.envia.com/additional-services

AUTHORIZATIONBearer Token
Token

HEADERS
Content-Type

application/json

Bodyraw
View More

{
    "origin": {
        "name": "oscar mx",
        "company": "envia",
        "email": "noreply@envia.com",
        "phone": "8116300800",
        "street": "av vasconcelos",
        "number": "1400",
        "district": "mirasierra",
        "city": "Monterrey",
        "state": "NL",
        "country": "MX",
        "postalCode": "66236",
        "reference": ""
    },
    "destination": {
        "name": "oscar",
        "company": "empresa",
        "email": "noreply@envia.com",
        "phone": "8116300800",
        "street": "av vasconcelos",
        "number": "1400",
        "district": "palo blanco",
        "city": "monterrey",
        "state": "NL",
        "country": "MX",
        "postalCode": "66240",
        "reference": ""
    },
    "packages": [
        {
            "content": "camisetas rojas",
            "amount": 2,
            "type": "box",
            "dimensions": {
                "length": 2,
                "width": 5,
                "height": 5
            },
            "weight": 63,
            "insurance": 0,
            "declaredValue": 400,
            "weightUnit": "KG",
            "lengthUnit": "CM"
        },
        {
            "content": "camisetas rojas",
            "amount": 2,
            "type": "box",
            "dimensions": {
                "length": 1,
                "width": 17,
                "height": 2
            },
            "weight": 5,
            "insurance": 400,
            "declaredValue": 400,
            "weightUnit": "KG",
            "lengthUnit": "CM"
        }
    ],
    "shipment": {
        "carrier": "fedex",
        "service": "express",
        "type": 1
    },
    "settings": {
        "printFormat": "PDF",
        "printSize": "STOCK_4X6",
        "comments": "comentarios de el envío"
    }
}

Example Request
Create Label

View More
curl


curl --location 'https://api.envia.com/ship/generate/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Token>' \
--data-raw '{
    "origin": {
        "name": "oscar mx",
        "company": "oskys factory",
        "email": "osgosf8@gmail.com",
        "phone": "8116300800",
        "street": "av vasconcelos",
        "number": "1400",
        "district": "mirasierra",
        "city": "Monterrey",
        "state": "NL",
        "country": "MX",
        "postalCode": "66236",
        "reference": ""
    },
    "destination": {
        "name": "oscar",
        "company": "empresa",
        "email": "osgosf8@gmail.com",
        "phone": "8116300800",
        "street": "av vasconcelos",
        "number": "1400",
        "district": "palo blanco",
        "city": "monterrey",
        "state": "NL",
        "country": "MX",
        "postalCode": "66240",
        "reference": ""
    },
    "packages": [
        {
            "content": "camisetas rojas",
            "amount": 2,
            "type": "box",
            "dimensions": {
                "length": 2,
                "width": 5,
                "height": 5
            },
            "weight": 63,
            "insurance": 0,
            "declaredValue": 400,
            "weightUnit": "KG",
            "lengthUnit": "CM"
        },
        {
            "content": "camisetas rojas",
            "amount": 2,
            "type": "box",
            "dimensions": {
                "length": 1,
                "width": 17,
                "height": 2
            },
            "weight": 5,
            "insurance": 400,
            "declaredValue": 400,
            "weightUnit": "KG",
            "lengthUnit": "CM"
        }
    ],
    "shipment": {
        "carrier": "fedex",
        "service": "express",
        "type": 1
    },
    "settings": {
        "printFormat": "PDF",
        "printSize": "STOCK_4X6",
        "comments": "comentarios de el envío"
    }
}'

200 OK
Example Response
 * Body
 * Headers (14)

View More
json


{
  "meta": "generate",
  "data": [
    {
      "carrier": "ups",
      "service": "ground",
      "trackingNumber": "1Z68W99A4297214308",
      "trackUrl": "https://envia.com/rastreo?label=1Z68W99A4297214308&cntry_code=us",
      "label": "https://s3.us-east-2.amazonaws.com/enviapaqueteria/uploads/ups/1Z68W99A42972143081118461362db7dbe1c.pdf",
      "additionalFiles": [],
      "totalPrice": 257.12,
      "currentBalance": 8230.67,
      "currency": "MXN"
    }
  ]
}

Date

Thu, 27 Jun 2019 16:59:35 GMT

Content-Type

text/html; charset=UTF-8

Transfer-Encoding

chunked

Connection

keep-alive

Cache-Control

no-cache, private

Access-Control-Allow-Origin

*

Access-Control-Allow-Methods

DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT

Access-Control-Allow-Headers

Authorization, X-Requested-With, X-Auth-Token, Content-Type

Access-Control-Allow-Credentials

true

Via

1.1 vegur

Expect-CT

max-age=604800,
report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"

Server

cloudflare

CF-RAY

4ed8f8debd0e5c49-STL

Content-Encoding

gzip