Skip to main content
API docs by Redocly

Enviame API (2.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

General Concepts

In this documentation you will find all the endpoints available in our API. To use them you will need your own Company/Seller ID (id_seller) and its respective API Key. If you are working in Marketplace mode, you will also need the Marketplace ID (marketplace_id) and use its API Key.

API Keys can be found in the My Company/Seller or My Marketplace section of the Enviame platform.

If you have questions about this documentation, write to us at support@enviame.io

Deliveries

Create delivery as seller

Endpoint that allows creating deliveries for a Company/Seller

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json
Content-Type
required
string
Default: application/json
Request Body schema: application/json

Create a new delivery

object
object
object
object
object
Array of objects

Custom additional fields

Responses

Request samples

Content type
application/json
Example
{
  • "shipping_order": {
    },
  • "shipping_origin": {
    },
  • "shipping_destination": {
    },
  • "dimensions": {
    },
  • "carrier": {
    }
}

Response samples

Content type
application/json
Example
Loading...

View seller's deliveries

Endpoint that allows viewing the information of all deliveries of your Seller/Company/Seller. Includes additional filters to narrow down the list

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

query Parameters
delivery_status_id
integer <int64>

Optional field - Enviame status ID

date_from
string <date>

Optional field - Search range start date, format "YYYY-MM-DD"

date_to
string <date>

Optional field - Search range end date, format "YYYY-MM-DD"

page
integer <int64>

Optional field - Page number to query

limit
integer <int64>

Optional field - Number of results per page

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{}

Create multi-package delivery as seller

Endpoint that allows creating deliveries with multiple packages (up to 50) in a single request for a Company/Seller.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json
Content-Type
required
string
Default: application/json
Request Body schema: application/json

Create a new multi-package delivery

type
required
string
Value: "delivery"

Required / Delivery type. Only 'delivery' is supported for now

required
object

How the general information (order) and each package's information (packages) is processed:

Received Result
Weight, volume or declared amount in order and in every package, even if they do not match (e.g. 8 kg overall and five 2 kg packages) Kept: both levels are stored exactly as sent. The difference does not cause a rejection.
Weight, volume or declared amount only in order Completed: the overall value is split evenly across packages (e.g. 10 kg and 5 packages: 2 kg each). The overall value is kept.
Weight, volume or declared amount only in every package Completed: the overall value is the sum of the packages.
A field your account requires, reported in some packages and not in others Rejected (422): the response names the field and the missing packages. Send it in every package or only in order.
order.info and no package with info Completed: the overall description is copied to every package.
info in some packages and not in others Rejected (422): even if order.info exists, missing ones are not filled in.
No package with package_reference and imported_id provided Completed: imported_id-001, imported_id-002, … are generated by package position.
package_reference in some packages and not in others Rejected (422): missing ones are not generated. Send it in every package or only imported_id.
Length, width and height Kept at the level where you sent them. They are never added, divided, copied between levels or deduced from volume. They are optional per package.
object
required
object (DeliveryPointV1)
required
object (DeliveryPointV1)
dispatch_now
boolean
Default: true

Whether the shipment is injected into the carrier right away. With false the shipment is created without being dispatched (Only Create). If your account has Only Create set in the default settings, dispatch_now is always taken as false, even if you send true. Default settings apply to the whole shipment and not to each package, and they override the overall value you send.

extra_fields
object

Custom additional fields. Free-form key/value structure.

Responses

Request samples

Content type
application/json
Example
{
  • "type": "delivery",
  • "dispatch_now": true,
  • "order": {
    },
  • "carrier": {
    },
  • "origin": {
    },
  • "destination": {
    }
}

Response samples

Content type
application/json
{
  • "code": "success",
  • "message": "Created OK",
  • "errors": [ ],
  • "data": {
    }
}

Create delivery in seller as marketplace

Endpoint that allows creating deliveries in a Company/Seller associated with a Marketplace, using the marketplace's api-key for this purpose

Authorizations:
api-key
path Parameters
marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Content-Type
required
string
Default: application/json

Not modified

Request Body schema: application/json

Create a new delivery as MKP

object
object
object
object
object
Array of objects

Responses

Request samples

Content type
application/json
Example
{
  • "shipping_order": {
    },
  • "shipping_origin": {
    },
  • "shipping_destination": {
    },
  • "dimensions": {
    },
  • "carrier": {
    }
}

Response samples

Content type
application/json
Example
Loading...

Transform to multi-package from Seller

Endpoint that allows modifying the number of packages (n_packages) of a delivery already created with the carrier.

Authorizations:
api-key
path Parameters
delivery_id
required
integer <int64>

Delivery ID, generated by Enviame

id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json

Change packages of a delivery

n_package
integer

Required / Number of packages to transform

Responses

Request samples

Content type
application/json
{
  • "n_package": 3
}

Response samples

Content type
application/json
{}

View delivery

Endpoint that allows viewing the information of a Company/Seller delivery

Authorizations:
api-key
path Parameters
delivery_id
required
integer <int64>

Delivery ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{}

Print label and add to manifest

Endpoint that allows generating the label for one or more deliveries in Ready for dispatch status (ID 5), setting them to Ready for dispatch - printed status (ID 26) and assigning them to a manifest.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json

Print label and add to manifest

deliveries
required
Array of strings

Delivery IDs to generate label.

type
string
Default: "pdf"
Enum: "pdf" "zpl" "letter"

Label format

labelsPerPage
integer

Number of labels per page.

async
boolean
Default: false

Defines whether adding the delivery to a manifest is processed asynchronously.

  • false: keeps the current synchronous processing.
  • true: queues the assignment request and returns only the delivery label. deliveries must contain exactly one ID.

Responses

Request samples

Content type
application/json
{
  • "deliveries": [
    ],
  • "type": "pdf",
  • "labelsPerPage": 1,
  • "async": false
}

View delivery tracking

Endpoint that allows viewing the status history of a Company/Seller delivery.

Authorizations:
api-key
path Parameters
delivery_id
required
integer <int64>

Delivery ID, generated by Enviame o referencia

query Parameters
all_matches
boolean

This parameter can be used to search by a reference that is not the delivery ID, and a list of deliveries matching the provided reference will be returned.

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete delivery

Endpoint that allows deleting deliveries by assigning them the Deleted status (ID 12)

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

delivery_id
required
integer <int64>

Delivery ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "data": "El envío se ha eliminado correctamente"
}

Update status of an internal transport delivery

Endpoint to update the status of deliveries belonging to the Internal Transport operator

Authorizations:
api-key
path Parameters
delivery_id
required
integer <int64>

Delivery ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json

Change delivery status

code
string

Required / Status ID to apply to the delivery

comment
string

Optional / Comment to be added to the status update record.

changed_at
string

Optional / Date that will be recorded as the status update date

Responses

Request samples

Content type
application/json
{
  • "code": 7,
  • "comment": "Status change made for testing",
  • "changed_at": "2025-03-18 10:00:00"
}

Response samples

Content type
application/json
{}

Manifests

List manifests

Endpoint that allows listing the manifests of a Company/Seller.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

query Parameters
status_code[]
Array of strings
Items Enum: "OPEN" "CLOSED" "CONFIRMED"

Optional field / Filters by one or more manifest status codes. Available values according to the manifest service.

with[]
Array of strings
Items Value: "deliveries"

Optional field / Allows including additional relationships in the response.

created_at_from
string <date-time>

Optional field / Manifest creation start date.

created_at_to
string <date-time>

Optional field / Manifest creation end date.

updated_at_to
string <date-time>

Optional field / Manifest update end date.

group_code
string

Optional field / Manifest grouping code.

carrier_code
string

Optional field / Carrier code.

organization_id
integer

Optional field / Associated organization ID.

pudo_id
integer

Optional field / Associated PUDO point ID.

creator_email
string <email>

Optional field / Manifest creator user email.

summary_origin
string

Optional field / Manifest creation origin.

sort_by
string
Example: sort_by=[{"field":"updated_at","order":"desc"}]

Optional field / Sorting criteria in JSON format.

without_deliveries_in_movement
boolean

Optional field / Excludes manifests with deliveries in transit.

delivery_ids[]
Array of integers

Optional field / Delivery IDs to filter manifests.

page
integer >= 1

Optional field / Page number.

limit
integer >= 1

Optional field / Number of records per page.

timezone
string
Default: "etc/utc"

Optional field / Timezone for formatting dates.

services[]
Array of strings

Optional field / Carrier services to filter manifests.

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{}

View manifest

Endpoint that allows querying a manifest of a Company/Seller.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame.

summary_id
required
integer <int64>

Manifest ID, generated by Enviame.

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{}

Generate a manifest

Endpoint that allows generating a manifest for a Company/Seller, with deliveries from the same carrier and source warehouse.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json
required

Create a manifest

deliveries
Array of strings

Required / Delivery IDs to generate the manifest.

custom
boolean

Optional / Indicates whether the manifest should be generated based on Marketcenter

Responses

Request samples

Content type
application/json
{
  • "deliveries": [
    ],
  • "custom": true
}

Close manifest

Endpoint that allows closing a manifest, preventing more deliveries from being added to it.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

id_manifiesto
required
integer <int64>

Manifest ID, generado by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json
optional
close_type
string or null
Enum: "CLOSE_ANYWAY" "CLOSE_ONE" "CLOSE_BOTH"

Optional / Manifest close type:

  • CLOSE_ANYWAY: closes the manifest including deliveries in transit.
  • CLOSE_ONE: splits deliveries into two manifests; the original manifest keeps only deliveries in transit and is closed, while a new open manifest is created with non-moving deliveries.
  • CLOSE_BOTH: applies the same split as CLOSE_ONE, but also closes the new manifest created with non-moving deliveries.
async
boolean
Default: false

Optional / Defines whether file generation is processed asynchronously.

  • false: waits for the label strip and PDF manifest to be generated before responding.
  • true: generates files in the background and the labels_url and summary_url property URLs will be returned as null.

It is recommended to use this parameter as true if the manifest has a considerable number of deliveries or if you don't need any of the files immediately, as this way the endpoint will respond faster.

Responses

Request samples

Content type
application/json
{
  • "close_type": "CLOSE_ANYWAY",
  • "async": false
}

Response samples

Content type
application/json
{}

Company/Seller

Create Company/Seller Warehouse

Endpoint that allows creating warehouses for a Company/Seller. At least one warehouse must be created in order to generate deliveries.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Content-Type
required
string
Default: application/json

Not modified

Request Body schema: application/json
required
name
required
string

Warehouse name

code
required
string

Alphanumeric code of the warehouse

place
required
string

Commune (CL) - City/Municipality (CO) - District (PE) - Neighborhood (MX) - Municipality (AR) where the warehouse is located

full_address
required
string

Full address of the warehouse, excluding commune

information
string

Additional information or address complement

contact_name
string

Warehouse contact name

contact_phone
string

Contact phone number

contact_email
string

Contact email

Responses

Request samples

Content type
application/json
{
  • "name": "Bodega Prueba Docu",
  • "code": "bod_prueba_docu",
  • "place": "Cerrillos",
  • "full_address": "Avenida Siempreviva 987",
  • "information": "Bodega B5",
  • "contact_name": "Cosme Fulanito",
  • "contact_phone": "998769876",
  • "contact_email": "bodega-prueba@enviame.io"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { },
  • "errors": [ ]
}

List Company/Seller warehouses

Lists Company/Seller warehouses with filtering and pagination.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

query Parameters
name
string

Warehouse name.

contact_name
string

Warehouse contact name.

contact_email
string

Warehouse contact email.

contact_phone
string

Warehouse contact phone.

place
string

Name of the place where the warehouse is located.

place_id
string

Internal place ID.

full_address
string

Full warehouse address.

information
string

Additional address information.

zip_code
string

Warehouse postal code.

identifier
string

Warehouse identifier.

code
string

Warehouse code.

marketplace_creator
string

Marketplace creator identifier.

boolean or integer or string (WarehouseBooleanValue)

Warehouse active or inactive status.

latitude
string

Warehouse location latitude.

longitude
string

Warehouse location longitude.

page
integer >= 1
Default: 1

Page number.

per_page
integer [ 2 .. 400 ]
Default: 15

Number of warehouses per page.

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {},
  • "errors": [ ]
}

View Company/Seller

Endpoint that allows viewing the information of a Company/Seller

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{}

View a Company/Seller warehouse

Endpoint that allows viewing the data of an existing warehouse in a Company/Seller.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

warehouse_identifier
required
string

Warehouse identifier: alphanumeric code or numeric ID.

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    },
  • "errors": [ ]
}

Edit Seller/Company/Seller warehouse

Partially updates an existing warehouse. Omitted fields preserve their current values.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

warehouse_identifier
required
string

Warehouse identifier: alphanumeric code or numeric ID.

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json
optional

Editable fields. Omitted fields preserve their current values.

name
string

Warehouse name.

code
string

Alphanumeric warehouse code.

place
string

Name of the place where the warehouse is located.

level1
string or null

Higher administrative level. Required only for Colombia and Peru.

level2
string or null

Intermediate administrative level.

full_address
string

Full warehouse address.

information
string or null

Additional address information.

zip_code
string or null

Postal code.

latitude
string or null

Latitude.

longitude
string or null

Longitude.

contact_name
string or null

Contact name.

contact_phone
string or null

Contact phone.

contact_email
string or null <email>

Contact email address.

boolean or integer or string

Indicates whether the warehouse is active or inactive.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "place": "string",
  • "level1": "string",
  • "level2": "string",
  • "full_address": "string",
  • "information": "string",
  • "zip_code": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "contact_name": "string",
  • "contact_phone": "string",
  • "contact_email": "user@example.com",
  • "activated": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { },
  • "errors": [ ]
}

Delete a seller warehouse

Endpoint that allows deleting warehouses from a Company/Seller

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

warehouse_identifier
required
string

Warehouse identifier: alphanumeric code or numeric ID.

header Parameters
Accept
required
string
Default: application/json

Not modified

Content-Type
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    },
  • "errors": [ ]
}

List Company/Seller Employees/Users

Endpoint to list users created as employees of a Company/Seller

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ],
  • "meta": {
    }
}

List of active carriers in Company/Seller

Endpoint that allows listing the carriers assigned to a Company/Seller.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Content-Type
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ],
  • "meta": {
    },
  • "errors": ""
}

Retiros

Create pickup as a Marketplace seller

Endpoint to schedule pickups using a Marketplace api-key. The response depends on each carrier's cutoff schedule.

Authorizations:
api-key
path Parameters
marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json
required
carrier_code
required
string

Carrier code to request the pickup from.

warehouse_code
required
string

Warehouse code where products will be picked up.

qty
required
integer <int64>

Total number of packages to pick up.

contact_name
required
string

Name of the pickup contact person (employee).

contact_phone
required
string

Phone number of the pickup contact person (employee).

range_time
required
string
Enum: "AM" "PM"

Pickup time range: before or after 12 PM.

pickup_date
string <date>

Pickup date in YYYY-MM-DD format / If empty, it is scheduled for the next day.

weight
required
integer

Approximate total weight (Kg.) of the packages.

size
required
string
Enum: "xs" "s" "m" "l" "c"

Total size of the packages.

custom_size
string

Only applies for size = C / Pallet or full load dimensions.

Responses

Request samples

Content type
application/json
{
  • "carrier_code": "BLX",
  • "warehouse_code": "bod_ruka1",
  • "qty": 4,
  • "contact_name": "Usuario Bodega",
  • "contact_phone": "123456789",
  • "range_time": "AM",
  • "pickup_date": "2025-03-21",
  • "weight": 5,
  • "size": "s"
}

Response samples

Content type
application/json
{
  • "code": 201,
  • "data": {
    }
}

List pickups as Seller

Lists pickups for the specified Company/Seller. The query is scoped to id_seller and filters only apply to that company.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

query Parameters
carrier
string
Example: carrier=BLX

Carrier code used to filter pickups.

pickup_date
string <date>
Example: pickup_date=2026-10-23

Exact pickup date in YYYY-MM-DD format.

limit
integer
Default: 10

Number of pickups per page. Defaults to 10.

page
integer
Default: 1

Page number. Defaults to 1.

order_by
string
Default: "status.code"

Field used to sort the results. Defaults to status.code.

order_type
string
Default: "desc"
Enum: "asc" "desc"

Sort direction.

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": [
    ],
  • "pagination": {
    }
}

Create pickup as Company/Seller

Endpoint to schedule pickups using a Company/Seller api-key. The response depends on each carrier's cutoff schedule.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json
required
carrier_code
required
string

Carrier code to request the pickup from.

warehouse_code
required
string

Warehouse code where products will be picked up.

qty
required
integer <int64>

Total number of packages to pick up.

contact_name
required
string

Name of the pickup contact person (employee).

contact_phone
required
string

Phone number of the pickup contact person (employee).

range_time
required
string
Enum: "AM" "PM"

Pickup time range: before or after 12 PM.

pickup_date
string <date>

Pickup date in YYYY-MM-DD format / If empty, it is scheduled for the next day.

weight
required
integer

Approximate total weight (Kg.) of the packages.

size
required
string
Enum: "xs" "s" "m" "l" "c"

Total size of the packages.

custom_size
string

Only applies for size = C / Pallet or full load dimensions.

Responses

Request samples

Content type
application/json
{
  • "carrier_code": "BLX",
  • "warehouse_code": "bod_ruka1",
  • "qty": 4,
  • "contact_name": "Usuario Bodega",
  • "contact_phone": "123456789",
  • "range_time": "AM",
  • "pickup_date": "2025-03-21",
  • "weight": 5,
  • "size": "s"
}

Response samples

Content type
application/json
{
  • "code": 201,
  • "data": {
    }
}

List pickups for a Marketplace

Lists pickups belonging to the companies/sellers associated with the specified Marketplace. The response format and filters match the Seller pickups listing.

Authorizations:
api-key
path Parameters
marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

query Parameters
carrier
string
Example: carrier=BLX

Carrier code used to filter pickups.

pickup_date
string <date>
Example: pickup_date=2026-10-23

Exact pickup date in YYYY-MM-DD format.

limit
integer
Default: 10

Number of pickups per page. Defaults to 10.

page
integer
Default: 1

Page number. Defaults to 1.

order_by
string
Default: "status.code"

Field used to sort the results. Defaults to status.code.

order_type
string
Default: "desc"
Enum: "asc" "desc"

Sort direction.

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "data": [
    ],
  • "pagination": {
    }
}

Returns

Create return

Authorizations:
api-key
path Parameters
id_seller
required
integer

Seller ID

Request Body schema: application/json
required
required
object or object

Return origin (home or PUDO/agency)

required
object or object

Return destination (home or warehouse)

required
object
required
object
object

Custom additional fields

Responses

Request samples

Content type
application/json
Example
{
  • "origin": {
    },
  • "destination": {
    },
  • "order": {
    },
  • "carrier": {
    }
}

Response samples

Content type
application/json
{
  • "code": "Success",
  • "message": "creation success",
  • "data": {}
}

Get return tracking

Authorizations:
api-key
path Parameters
imported_id
required
string

Return identifier (imported_id)

Responses

Response samples

Content type
application/json
{
  • "code": "Success",
  • "message": "ok",
  • "data": {
    }
}

Create return from an existing delivery

Authorizations:
api-key
path Parameters
id_seller
required
integer

Seller ID

delivery_id
required
integer

Original delivery ID

Request Body schema: application/json
required
object
object

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "carrier": {
    }
}

Response samples

Content type
application/json
{
  • "code": "Success",
  • "message": "creation success",
  • "data": {
    }
}

Marketplace

Create Warehouse in Company/Seller as Marketplace

Endpoint that allows creating warehouses for a Company/Seller using the associated Marketplace's API Key. At least one warehouse must be created in order to generate deliveries.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json
required
name
required
string

Warehouse name

code
required
string

Alphanumeric code of the warehouse

place
required
string

Commune (CL) - City/Municipality (CO) - District (PE) - Neighborhood (MX) - Municipality (AR) where the warehouse is located

full_address
required
string

Full address of the warehouse, excluding commune

information
string

Additional information or address complement

contact_name
string

Warehouse contact name

contact_phone
string

Contact phone number

contact_email
string

Contact email

Responses

Request samples

Content type
application/json
{
  • "name": "Bodega Prueba Docu",
  • "code": "bod_prueba_docu",
  • "place": "Cerrillos",
  • "full_address": "Avenida Siempreviva 987",
  • "information": "Bodega B5",
  • "contact_name": "Cosme Fulanito",
  • "contact_phone": "998769876",
  • "contact_email": "bodega-prueba@enviame.io"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    },
  • "errors": [ ]
}

Edit Company/Seller Warehouse from Marketplace

Partially updates an existing warehouse from a Marketplace. Omitted fields preserve their current values.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

warehouse_identifier
required
string

Warehouse identifier: alphanumeric code or numeric ID.

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json
optional

Editable fields. Omitted fields preserve their current values.

name
string

Warehouse name.

code
string

Alphanumeric warehouse code.

place
string

Name of the place where the warehouse is located.

level1
string or null

Higher administrative level. Required only for Colombia and Peru.

level2
string or null

Intermediate administrative level.

full_address
string

Full warehouse address.

information
string or null

Additional address information.

zip_code
string or null

Postal code.

latitude
string or null

Latitude.

longitude
string or null

Longitude.

contact_name
string or null

Contact name.

contact_phone
string or null

Contact phone.

contact_email
string or null <email>

Contact email address.

boolean or integer or string

Indicates whether the warehouse is active or inactive.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "place": "string",
  • "level1": "string",
  • "level2": "string",
  • "full_address": "string",
  • "information": "string",
  • "zip_code": "string",
  • "latitude": "string",
  • "longitude": "string",
  • "contact_name": "string",
  • "contact_phone": "string",
  • "contact_email": "user@example.com",
  • "activated": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { },
  • "errors": [ ]
}

Delete Company/Seller Warehouse from Marketplace

Endpoint that allows deleting one of the warehouses of a Company/Seller associated with a Marketplace.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

warehouse_identifier
required
string

Warehouse identifier: alphanumeric code or numeric ID.

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": {
    },
  • "errors": [ ]
}

List Marketplace warehouses

Lists warehouses belonging to Company/Seller accounts associated with a Marketplace.

Authorizations:
api-key
path Parameters
marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

query Parameters
name
string

Warehouse name.

contact_name
string

Warehouse contact name.

contact_email
string

Warehouse contact email.

contact_phone
string

Warehouse contact phone.

place
string

Name of the place where the warehouse is located.

place_id
string

Internal place ID.

full_address
string

Full warehouse address.

information
string

Additional address information.

zip_code
string

Warehouse postal code.

identifier
string

Warehouse identifier.

code
string

Warehouse code.

marketplace_creator
string

Marketplace creator identifier.

boolean or integer or string (WarehouseBooleanValue)

Warehouse active or inactive status.

latitude
string

Warehouse location latitude.

longitude
string

Warehouse location longitude.

page
integer >= 1
Default: 1

Page number.

per_page
integer [ 2 .. 400 ]
Default: 15

Number of warehouses per page.

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {},
  • "errors": [ ]
}

List Sellers

Endpoint that allows listing all Company/Sellers associated with a Marketplace.

Authorizations:
api-key
path Parameters
marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Responses

Response samples

Content type
application/json
{}

Assign carrier to Company/Seller

Endpoint that allows assigning a carrier to a Company/Seller, from those already assigned to the Marketplace.

Authorizations:
api-key
path Parameters
id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json
required

Assign a carrier to a Company/Seller

code
string

Required / Carrier code

Responses

Request samples

Content type
application/json
{
  • "code": "BLX"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ],
  • "meta": {
    },
  • "errors": [ ]
}

Edit Seller as Marketplace

Endpoint that allows editing data of a Company/Seller belonging to a Marketplace

Authorizations:
api-key
path Parameters
marketplace_id
required
integer <int64>

Marketplace ID, generated by Enviame

id_seller
required
integer <int64>

Company/Seller ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: multipart/form-data
name
string

Company/Seller name

corporate_name
string

Corporate name / Legal name

code
string

Alphanumeric code of the Company/Seller

dni
string

Company/Seller RUT (DNI)

website
string

Company/Seller website

Responses

Request samples

Content type
multipart/form-data
{
  "name": "Team Akagi",
  "corporate_name": "Akagi Team",
  "code": "akagi",
  "dni": "11.111.111-1",
  "website": "www.akagiteam.cl"
}

Response samples

Content type
application/json
{}

Create Seller as Marketplace

Endpoint that allows creating a Company/Seller in a Marketplace

Authorizations:
api-key
path Parameters
marketplace_id_
required
integer <int64>

Marketplace ID, generated by Enviame

header Parameters
Accept
required
string
Default: application/json

Not modified

Request Body schema: application/json

Crear seller como marketplace

name
string

Required / Company/Seller name

corporate_name
string

Required / Corporate name / Legal name

code
string

Alphanumeric code to be assigned to the Company/Seller

dni
string

Required / Company/Seller RUT (DNI)

rule
integer

Rule ID to assign, not used

carrier_code
Array of strings

List of couriers to add to the Company/Seller

Responses

Request samples

Content type
application/json
{
  • "name": "Team Mitsui",
  • "corporate_name": "Mitsui Team",
  • "code": "mitsui_team",
  • "dni": "111111111111",
  • "rule": 0,
  • "carrier_code": [
    ]
}

Response samples

Content type
application/json
{}

Rates

Query rates

This endpoint allows querying shipping rates based on various parameters. Supports queries by weight (kilograms - kg) and by distance (kilometers - km).

Authorizations:
x-api-key
query Parameters
from_place_code
required
string

Origin code (CL commune code, CO DANE code, PE ubigeo, MX postal code).

to_place_code
required
string

Destination code (CL commune code, CO DANE code, PE ubigeo, MX postal code).

from_place
string

Origin place name, available for Chile, Colombia and Peru.

to_place
string

Destination place name, available for Chile, Colombia and Peru.

from_address
string

Delivery origin address. Only for KM rates (Chile).

to_address
string

Delivery destination address. Only for KM rates (Chile).

weight
required
number

Product weight in kilograms (kg).

length
number

Product length in centimeters (cm).

width
number

Product width in centimeters (cm).

height
number

Product height in centimeters (cm).

volume
number

Product volume in cubic meters (m³), only for Chile.

type
string
Example: type=nextday&type=estandar

Service category.

carrier
string

Filters by a specific carrier code.

service
string

Filters by a specific carrier service code. Requires the carrier parameter.

carriers[]
Array of strings

Filters by a list of carriers. Combined with type. Ejemplo: carriers[]=CARRIER1&carriers[]=CARRIER2.

km_distance
number

Distance in kilometers.

declared_value
number

Declared product value. Required for CO

Responses

Request samples 

curl -X GET "https://api.enviame.io/api/v1/prices?weight=1&length=1&width=1&height=1&to_address=HERNANDO%20DE%20AGUIRRE%20268%20OF%20202&from_address=Avenida%20Manquehue%20Norte%201337,%20Local%2011&from_place_code=13101&to_place_code=13101" \
-H "x-api-key: YOUR_API_KEY"

Response samples

Content type
application/json
Example
Loading...