Enviame API (2.0.0)

Download OpenAPI specification:Download

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. These endpoints are configured to be used in the stage testing environment, so they use the API Keys and IDs corresponding to that environment. If instead they will be used against the api production environment, the stage subdomain must be removed from the endpoint and the apikey and Company/Seller ID corresponding to that environment must be used.
Stage: https://stage.api.enviame.io
Production: https://api.enviame.io 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

path Parameters

id_seller

required

integer <int64>

Company/Seller ID, generated by Enviame

header Parameters

api-key required	string Company/Seller API Key, generated by Enviame
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

Payload

Content type

application/json

Example

Delivery in Chile

{"shipping_order": {"n_packages": 1,
"content_description": "Orden 123",
"imported_id": "123",
"order_price": 21990,
"weight": 1,
"volume": 1,
"type": "delivery"
},
"shipping_origin": {"warehouse_code": "bod_sell"
},
"shipping_destination": {"customer": {"name": "Cliente Feliz",
"email": "prueba@enviame.io",
"phone": 987654321
},
"delivery_adress": {"place": "Curicó",
"full_address": "Calle Falsa 123",
"information": "Indicaciones adicionales"
}
},
"dimensions": {"width": 10,
"height": 10,
"length": 10
},
"carrier": {"carrier_code": "SKN",
"carrier_service": "",
"tracking_number": ""
}
}

Response samples

200
401
500

Content type

application/json

Example

Chile delivery response

Loading...

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

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

api-key required	string Marketplace API Key, generated by Enviame
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

Payload

Content type

application/json

Example

Crear_Envio_Como_MKP

{"shipping_order": {"n_packages": 1,
"content_description": "Orden 123",
"imported_id": "123",
"order_price": 21990,
"weight": 1,
"volume": 1,
"type": "delivery"
},
"shipping_origin": {"warehouse_code": "bod_sell"
},
"shipping_destination": {"customer": {"name": "Cliente Feliz",
"email": "prueba@enviame.io",
"phone": 987654321
},
"delivery_address": {"place": "Curicó",
"full_address": "Calle Falsa 123",
"information": "Indicaciones adicionales"
}
},
"dimensions": {"width": 10,
"height": 10,
"length": 10
},
"carrier": {"carrier_code": "SKN",
"carrier_service": "",
"tracking_number": ""
}
}

Response samples

200
401
500

Content type

application/json

Example

MKP delivery response

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.

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

api-key required	string Company/Seller Api-Key, generated by Enviame
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

Payload

Content type

application/json

{"n_package": 3
}

Response samples

200
401
404

Content type

application/json

{"status": "success",
"data": {"identifier": 1812125,
"imported_id": "pruebasoporte1",
"tracking_number": "259682",
"status": {"id": 5,
"name": "Listo para despacho",
"code": "CREATED",
"info": "Envio con tracking_number 259682 se ha reinyectado en el carrier como multibulto. - ",
"created_at": "2025-03-17 09:32:45"
},
"customer": {"full_name": "Prueba Soporte",
"phone": null,
"email": null
},
"shipping_address": {"full_address": "Calle Falsa 2345",
"place": "Santiago",
"type": "home"
},
"country": "CL",
"carrier": "BLUEXPRESS",
"service": "priority",
"label": {"PDF": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.pdf",
"ZPL": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.zpl",
"PNG": null
},
"barcodes": "259682",
"deadline_at": "No informada.",
"created_at": "2025-03-17 09:26:03",
"updated_at": "2025-03-17 09:32:45",
"links": [{"rel": "self",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1812125"
},
{"rel": "tracking",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1812125/tracking"
},
{"rel": "tracking-web",
"href": "https://stage.api.enviame.io/s2/companies/1402/deliveries/1812125/tracking"
}
]
}
}

View delivery

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

path Parameters

delivery_id

required

integer <int64>

Delivery ID, generated by Enviame

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json

Responses

Response samples

200
401
404

Content type

application/json

{"status": "success",
"data": {"identifier": 1812125,
"imported_id": "pruebasoporte1",
"tracking_number": "259682",
"status": {"id": 5,
"name": "Listo para despacho",
"code": "CREATED",
"info": "Envio con tracking_number 259682 se ha reinyectado en el carrier como multibulto. - ",
"created_at": "2025-03-17 09:32:45"
},
"customer": {"full_name": "Prueba Soporte",
"phone": null,
"email": null
},
"shipping_address": {"full_address": "Calle Falsa 2345",
"place": "Santiago",
"type": "home"
},
"country": "CL",
"carrier": "BLUEXPRESS",
"service": "priority",
"label": {"PDF": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.pdf",
"ZPL": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.zpl",
"PNG": null
},
"barcodes": "259682",
"deadline_at": "No informada.",
"created_at": "2025-03-17 09:26:03",
"updated_at": "2025-03-17 09:32:45",
"links": [{"rel": "self",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1812125"
},
{"rel": "tracking",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1812125/tracking"
},
{"rel": "tracking-web",
"href": "https://stage.api.enviame.io/s2/companies/1402/deliveries/1812125/tracking"
}
]
}
}

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

path Parameters

id_seller_ required	integer <int64> Company/Seller ID, generated by Enviame
delivery_status_id	integer <int64> Optional field - Enviame status ID
date_from	date Optional field - Search range start date, format "YYYY-MM-DD"
date_to	date Optional field - Search range end date, format "YYYY-MM-DD"
page	integer <int64> Optional field - Page number to query
limit	int <int64> Optional field - Number of results per page

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

200
401
404

Content type

application/json

{"status": "success",
"data": [{"identifier": 1812125,
"imported_id": "pruebasoporte1",
"tracking_number": "259682",
"status": {"id": 5,
"name": "Listo para despacho",
"code": "CREATED",
"info": "Envio con tracking_number 259682 se ha reinyectado en el carrier como multibulto. - ",
"created_at": "2025-03-17 09:32:45"
},
"customer": {"full_name": "Prueba Soporte",
"phone": null,
"email": null
},
"shipping_address": {"full_address": "Calle Falsa 2345",
"place": "Santiago",
"type": "home"
},
"country": "CL",
"carrier": "BLUEXPRESS",
"service": "priority",
"label": {"PDF": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.pdf",
"ZPL": {"raw": null,
"url": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.zpl"
},
"PNG": null
},
"barcodes": "259682",
"deadline_at": "No informada.",
"created_at": "2025-03-17 09:26:03",
"updated_at": "2025-03-17 09:32:45",
"links": [{"rel": "self",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1812125"
},
{"rel": "tracking",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1812125/tracking"
},
{"rel": "tracking-web",
"href": "https://stage.api.enviame.io/s2/companies/1402/deliveries/1812125/tracking"
}
]
},
{"identifier": 1797285,
"imported_id": "19134",
"tracking_number": "245619",
"status": {"id": 5,
"name": "Listo para despacho",
"code": "CREATED",
"info": "Ya creamos tu envío en: STARKEN  - ",
"created_at": "2024-10-28 13:18:29"
},
"customer": {"full_name": "Daniela karina Fuentes perez",
"phone": "966847822",
"email": "danielakrt@gmail.com"
},
"shipping_address": {"full_address": "TENIENTE MERINO CON HUAQUEN 881",
"place": "La Ligua",
"type": "home"
},
"country": "CL",
"carrier": "STARKEN",
"service": "normal",
"label": {"PDF": "https://storage.googleapis.com/dev-carrier-labels/202410/1797285/245619-label.pdf",
"ZPL": {"raw": null,
"url": "https://storage.googleapis.com/dev-carrier-labels/202410/1797285/245619-label.zpl"
},
"PNG": null
},
"barcodes": "245619",
"deadline_at": "No informada.",
"created_at": "2024-10-28 13:17:10",
"updated_at": "2024-10-28 13:18:29",
"links": [{"rel": "self",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1797285"
},
{"rel": "tracking",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1797285/tracking"
},
{"rel": "tracking-web",
"href": "https://stage.api.enviame.io/s2/companies/1402/deliveries/1797285/tracking"
}
]
},
{"identifier": 1780508,
"imported_id": "848",
"tracking_number": "No informado",
"status": {"id": 4,
"name": "Rechazado por Carrier",
"code": "PENDING",
"info": "Envio rechazado por carrier - ",
"created_at": "2024-05-29 16:35:54"
},
"customer": {"full_name": "Matías Alarcón",
"phone": "940286302",
"email": "matiasyanezalarcon@gmail.com"
},
"shipping_address": {"full_address": "Arlegui 469 Oficina 15",
"place": "Algarrobo",
"type": "home"
},
"country": "CL",
"carrier": "STARKEN",
"service": "normal",
"label": {"PDF": null,
"ZPL": {"raw": null,
"url": null
},
"PNG": null
},
"barcodes": null,
"deadline_at": "No informada.",
"created_at": "2024-04-25 09:34:13",
"updated_at": "2024-05-29 15:35:54",
"links": [{"rel": "self",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1780508"
},
{"rel": "tracking",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1780508/tracking"
},
{"rel": "tracking-web",
"href": "https://stage.api.enviame.io/s2/companies/1402/deliveries/1780508/tracking"
}
]
}
],
"meta": {"pagination": {"total_pages": 10,
"total": 30,
"per_page": 3,
"current_page": 1,
"count": 3
}
}
}

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.

path Parameters

id_seller

required

integer <int64>

Company/Seller ID, generated by Enviame

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Request Body schema: application/json

Print label and add to manifest

deliveries	Array of strings Required / Delivery IDs to generate label.
type	string Required / Label format type (PDF)
labelsPerPage	int Required / Number of labels per page.

Responses

Request samples

Payload

Content type

application/json

{"deliveries": [1812125
],
"type": "pdf",
"labelsPerPage": 1
}

Response samples

200
401

Content type

application/json

{"status": "success",
"data": {"carrier": "BLUEXPRESS",
"url": "https://storage.googleapis.com/hs-carrier-deliveries/202503/1402/blx_20250317_17_22_49_359470634.pdf",
"labels": "https://storage.googleapis.com/hs-carrier-deliveries/202503/1402/blx_20250317_17_22_49_359470634.pdf",
"summary": "https://storage.googleapis.com/hs-carrier-deliveries/202503/1402/dev_20250317_658779_2706.pdf",
"summary_id": 2706
}
}

View delivery tracking

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

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

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

200
401
404

Content type

application/json

{"data": {"identifier": 1812125,
"imported_id": "pruebasoporte1",
"tracking_number": "259682",
"status": {"id": 26,
"name": "Listo para despacho - Impreso",
"code": "CREATED",
"info": "Etiqueta impresa",
"created_at": "2025-03-17 17:22:51"
},
"customer": {"full_name": "Prueba Soporte",
"phone": null,
"email": null
},
"shipping_address": {"full_address": "Calle Falsa 2345",
"place": "Santiago",
"type": "home"
},
"country": "CL",
"carrier": "BLUEXPRESS",
"service": "priority",
"label": {"PDF": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.pdf",
"ZPL": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.zpl",
"PNG": null
},
"barcodes": "259682",
"tracking": [{"status_id": 26,
"code": "CREATED",
"name": "Listo para despacho - Impreso",
"comment": "Etiqueta impresa",
"created_at": "2025-03-17 17:22:51"
},
{"status_id": 5,
"code": "CREATED",
"name": "Listo para despacho",
"comment": "Envio con tracking_number 259682 se ha reinyectado en el carrier como multibulto.",
"created_at": "2025-03-17 09:32:45"
},
{"status_id": 5,
"code": "CREATED",
"name": "Listo para despacho",
"comment": "Ya creamos tu envío en: BLUEXPRESS ",
"created_at": "2025-03-17 09:26:12"
},
{"status_id": 1,
"code": "PENDING",
"name": "Creado",
"comment": "Envio creado por api",
"created_at": "2025-03-17 09:26:04"
}
],
"deadline_at": "No informada.",
"created_at": "2025-03-17 09:26:03",
"updated_at": "2025-03-17 09:32:45"
}
}

List manifests

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

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

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": 3263320,
"shipper": {"id": 0,
"name": "Example Shipper",
"code": "example_shipper",
"country": {"id": 1,
"code": "CL",
"name": "Chile"
}
},
"organization": {"id": 0,
"name": "Example Organization",
"code": "example_organization",
"country": {"id": 1,
"code": "CL",
"name": "Chile"
}
},
"carrier_code": "SKN",
"deliveries": [455258308,
455258356,
455258485,
455258535,
455258621,
455258828
],
"warehouse": {"id": 0,
"name": "Example Warehouse",
"code": "example_warehouse"
},
"status": {"id": 2,
"code": "CLOSED",
"name": "Cerrado"
},
"group_code": "000000_000_SKN_000000_STANDARD",
"files": null,
"labels_url": "https://storage.googleapis.com/hs-carrier-deliveries-prod/000000/000/example_label_000.pdf",
"summary_url": "https://storage.googleapis.com/hs-carrier-deliveries-prod/000000/000/example_summary_000.pdf",
"creator_user": "example@example.com",
"created_at": "2026-05-25T17:43:33.000Z",
"updated_at": "2026-05-25T17:44:41.000Z",
"deleted_at": null,
"created_at_format": "25-05-2026 17:43",
"updated_at_format": "25-05-2026 17:44",
"services": ["normal"
],
"files_statuses": {"labels": {"url": "https://storage.googleapis.com/hs-carrier-deliveries-prod/000000/000/example_label_000.pdf",
"status": "done",
"date": "2026-05-25 17:44:43",
"error": null
},
"summary": {"url": "https://storage.googleapis.com/hs-carrier-deliveries-prod/000000/000/example_summary_000.pdf",
"status": "done",
"date": "2026-05-25 17:44:43",
"error": null
}
}
}
]
}

View manifest

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

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

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": {"id": 3263320,
"shipper": {"id": 0,
"name": "Example Shipper",
"code": "example_shipper",
"country": {"id": 1,
"code": "CL",
"name": "Chile"
}
},
"organization": {"id": 0,
"name": "Example Organization",
"code": "example_organization",
"country": {"id": 1,
"code": "CL",
"name": "Chile"
}
},
"carrier_code": "SKN",
"deliveries": [455258308,
455258356,
455258485,
455258535,
455258621,
455258828
],
"warehouse": {"id": 0,
"name": "Example Warehouse",
"code": "example_warehouse"
},
"status": {"id": 2,
"code": "CLOSED",
"name": "Cerrado"
},
"group_code": "000000_000_SKN_000000_STANDARD",
"files": null,
"labels_url": "https://storage.googleapis.com/hs-carrier-deliveries-prod/000000/000/example_label_000.pdf",
"summary_url": "https://storage.googleapis.com/hs-carrier-deliveries-prod/000000/000/example_summary_000.pdf",
"creator_user": "example@example.com",
"created_at": "2026-05-25T17:43:33.000Z",
"updated_at": "2026-05-25T17:44:41.000Z",
"deleted_at": null,
"created_at_format": "25-05-2026 17:43",
"updated_at_format": "25-05-2026 17:44",
"services": ["normal"
],
"files_statuses": {"labels": {"url": "https://storage.googleapis.com/hs-carrier-deliveries-prod/000000/000/example_label_000.pdf",
"status": "done",
"date": "2026-05-25 17:44:43",
"error": null
},
"summary": {"url": "https://storage.googleapis.com/hs-carrier-deliveries-prod/000000/000/example_summary_000.pdf",
"status": "done",
"date": "2026-05-25 17:44:43",
"error": null
}
}
}
}

Generate a manifest

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

path Parameters

id_seller

required

integer <int64>

Company/Seller ID, generated by Enviame

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Request Body schema: application/json

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

Payload

Content type

application/json

{"deliveries": [1812125
],
"custom": true
}

Response samples

200
401

Content type

application/json

{"data": {"carrier": "BLUEXPRESS",
"url": "https://storage.googleapis.com/hs-carrier-deliveries/202503/1402/blx_20250317_17_22_49_359470634.pdf",
"labels": "https://storage.googleapis.com/hs-carrier-deliveries/202503/1402/blx_20250317_17_22_49_359470634.pdf",
"summary": "https://storage.googleapis.com/hs-carrier-deliveries/202503/1402/dev_20250317_658779_2706.pdf",
"summary_id": 2706
}
}

Close manifest

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

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

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Request Body schema: application/json

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

Payload

Content type

application/json

{"close_type": "CLOSE_ANYWAY",
"async": false
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"id": 2706,
"company_id": 1402,
"carrier_id": 31,
"warehouse_id": 2757,
"delivery_label_print_status_id": 2,
"description": "202503170522_1402_2757_31_SERpriority_express",
"type": 1,
"deliveries": [1812125
],
"carrier_services": ["priority"
],
"labels_url": "https://storage.googleapis.com/hs-carrier-deliveries/202503/1402/blx_20250318_09_41_42_1506856707.pdf",
"summary_url": "https://storage.googleapis.com/hs-carrier-deliveries/202503/1402/dev_20250318_658784_2706.pdf",
"active": false,
"voucher": null,
"has_voucher": false,
"extra_fields": null,
"deleted_at": null,
"created_at": "2025-03-17 17:22:46",
"updated_at": "2025-03-18 09:41:44",
"closed_at": "2025-03-18 09:41:44",
"creator_email": null,
"summary_origin": "api",
"countDeliveries": 1,
"action_code": "CLOSE_ANYWAY",
"new_summary": { }
}
}

Delete delivery

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

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

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

200
401
404

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

path Parameters

delivery_id

required

integer <int64>

Delivery ID, generated by Enviame

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
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

Payload

Content type

application/json

{"code": 7,
"comment": "Status change made for testing",
"changed_at": "2025-03-18 10:00:00"
}

Response samples

200
401

Content type

application/json

{"data": {"identifier": 1812125,
"imported_id": "pruebasoporte1",
"tracking_number": "259682",
"status": {"id": 7,
"name": "En tránsito",
"code": "IN_TRANSIT",
"info": "Status change made for testing - ",
"created_at": "2025-03-18 10:00:00"
},
"customer": {"full_name": "Prueba Soporte",
"phone": null,
"email": null
},
"shipping_address": {"full_address": "Calle Falsa 2345",
"place": "Santiago",
"type": "home"
},
"country": "CL",
"carrier": "BLUEXPRESS",
"service": "priority",
"label": {"PDF": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.pdf",
"ZPL": "https://storage.googleapis.com/dev-carrier-labels/202503/1812125/259682-label.zpl",
"PNG": null
},
"barcodes": "259682",
"deadline_at": "No informada.",
"created_at": "2025-03-17 09:26:03",
"updated_at": "2025-03-17 09:32:45",
"links": [{"rel": "self",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1812125"
},
{"rel": "tracking",
"href": "https://stage.api.enviame.io/api/s2/v2/deliveries/1812125/tracking"
},
{"rel": "tracking-web",
"href": "https://stage.api.enviame.io/s2/companies/1402/deliveries/1812125/tracking"
}
]
}
}

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."

path Parameters

id_seller

required

integer <int64>

Company/Seller ID, generated by Enviame

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified
Content-Type required	string Default: application/json Not modified

Request Body schema: application/json

name	string Required / Warehouse name
code	string Required / Alphanumeric code of the warehouse
place	string Required / Commune (CL) - City/Municipality (CO) - District (PE) - Neighborhood (MX) - Municipality (AR) where the warehouse is located
full_address	string Required / 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

Payload

Content type

application/json

{"value": {"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

201
500

Content type

application/json

{"status": "success",
"data": {"identifier": 18030,
"marketplace_creator": 1402,
"marketplace_exclusive": false,
"is_active": true,
"name": "Bodega Prueba Docu",
"code": "bod_prueba_docu",
"contact_name": "Cosme Fulanito",
"contact_phone": 998769876,
"contact_email": "bodega-prueba@enviame.io",
"address": {"place": "Cerrillos",
"place_id": 105,
"full_address": "Avenida Siempreviva 987",
"information": "Bodega B5",
"zip_code": null,
"latitude": null,
"longitude": null
},
"created_at": "2025-03-18 14:32:54",
"updated_at": "2025-03-18 14:32:54",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/warehouses/18030"
}
]
},
"errors": [ ]
}

View Company/Seller

Endpoint that allows viewing the information of a Company/Seller

path Parameters

id_seller

required

integer <int64>

Company/Seller ID, generated by Enviame

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

200
500

Content type

application/json

{"status": "success",
"data": {"identifier": 1402,
"name": "capsula",
"corporate_name": "capsule corp",
"dni": 199875629,
"website": null,
"activated": 1,
"logo": null,
"code": "capsula",
"country": "CL",
"rule": null,
"created_at": "2021-06-21 18:32:57",
"updated_at": "2023-06-27 18:03:28",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/1402"
},
{"rel": "companies.employees",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/1402/employees"
},
{"rel": "companies.warehouses",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/1402/warehouses"
},
{"rel": "companies.carriers",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/1402/carriers"
}
]
},
"errors": [ ]
}

Edit Seller/Company/Seller warehouse

Endpoint that allows editing an existing warehouse assigned to a Company/Seller.

path Parameters

id_seller required	integer <int64> Company/Seller ID, generated by Enviame
warehouse_code required	string Alphanumeric code of the warehouse

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Request Body schema: application/json

name	string Warehouse name
place	string Required / Commune (CL) - City/Municipality (CO) - District (PE) - Neighborhood (MX) - Municipality (AR) where the warehouse is located
full_address	string Warehouse address, excluding commune

Responses

Request samples

Payload

Content type

application/json

{"name": "Bodega Prueba Docu",
"place": "Cerrillos",
"full_address": "Avenida Siempreviva 9870"
}

Response samples

200
401
500

Content type

application/json

{"status": "success",
"data": {"identifier": 18030,
"marketplace_creator": 1402,
"marketplace_exclusive": false,
"is_active": true,
"name": "Bodega Prueba Docu",
"code": "bod_prueba_docu",
"contact_name": "Cosme Fulanito",
"contact_phone": 998769876,
"contact_email": "bodega-prueba@enviame.io",
"address": {"place": "Cerrillos",
"place_id": 105,
"full_address": "Avenida Siempreviva 9870",
"information": "Bodega B5",
"zip_code": null,
"latitude": null,
"longitude": null
},
"created_at": "2025-03-18 14:32:54",
"updated_at": "2025-03-18 14:32:54",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/warehouses/18030"
}
]
},
"errors": [ ]
}

List Company/Seller Employees/Users

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

path Parameters

id_seller

required

integer <int64>

Company/Seller ID, generated by Enviame

header Parameters

api-key

required

string

Company/Seller Api-Key, generated by Enviame

Responses

Response samples

200
401
500

Content type

application/json

{"status": "success",
"data": [{"identifier": 1311,
"marketplace_creator": null,
"marketplace_exclusive": false,
"is_active": false,
"first_name": "René",
"first_last": null,
"full_name": "René Álvarez",
"email": "rene.alvarez@acroventus.com",
"phone": 56934104505,
"mobile": 56934104505,
"position": null,
"created_at": "2021-07-07 22:08:56",
"updated_at": "2021-07-07 22:08:56",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/employees/1311"
}
]
},
{"identifier": 3288,
"marketplace_creator": null,
"marketplace_exclusive": false,
"is_active": false,
"first_name": "Usuario",
"first_last": null,
"full_name": "Usuario Documentacion",
"email": "documentaciones@enviame.io",
"phone": null,
"mobile": null,
"position": null,
"created_at": "2025-03-19 12:26:56",
"updated_at": "2025-03-19 12:26:56",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/employees/3288"
}
]
}
],
"meta": {"pagination": {"total": 2,
"count": 2,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": { }
}
}
}

View a Company/Seller warehouse

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

path Parameters

id_seller_ required	integer <int64> Company/Seller ID, generated by Enviame
warehouse_code required	string Alphanumeric code of the warehouse

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

200
401
500

Content type

application/json

{"status": "success",
"data": {"identifier": 18030,
"marketplace_creator": 1402,
"marketplace_exclusive": false,
"is_active": true,
"name": "Bodega Prueba Docu",
"code": "bod_prueba_docu",
"contact_name": "Cosme Fulanito",
"contact_phone": 998769876,
"contact_email": "bodega-prueba@enviame.io",
"address": {"place": "Cerrillos",
"place_id": 105,
"full_address": "Avenida Siempreviva 9870",
"information": "Bodega B5",
"zip_code": null,
"latitude": null,
"longitude": null
},
"created_at": "2025-03-18 14:32:54",
"updated_at": "2025-03-18 14:32:54",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/warehouses/18030"
}
]
},
"errors": [ ]
}

List Company/Seller warehouses

Endpoint that allows viewing the complete list of warehouses of a Company/Seller

path Parameters

id_seller_

required

integer <int64>

Company/Seller ID, generated by Enviame

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

201
401
500

Content type

application/json

{"status": "success",
"data": [{"identifier": 3121,
"marketplace_creator": 1402,
"marketplace_exclusive": false,
"is_active": false,
"name": "Bodega Suc1",
"code": 3125060,
"contact_name": null,
"contact_phone": null,
"contact_email": null,
"address": {"place": "Quilicura",
"place_id": 320,
"full_address": "Hidalgo 1208",
"information": null,
"zip_code": null,
"latitude": null,
"longitude": null
},
"created_at": "2022-02-10 17:10:31",
"updated_at": "2022-02-10 17:10:31",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/warehouses/3121"
}
]
},
{"identifier": 18030,
"marketplace_creator": 1402,
"marketplace_exclusive": false,
"is_active": true,
"name": "Bodega Prueba Docu",
"code": "bod_prueba_docu",
"contact_name": "Cosme Fulanito",
"contact_phone": 998769876,
"contact_email": "bodega-prueba@enviame.io",
"address": {"place": "Cerrillos",
"place_id": 105,
"full_address": "Avenida Siempreviva 9870",
"information": "Bodega B5",
"zip_code": null,
"latitude": null,
"longitude": null
},
"created_at": "2025-03-18 14:32:54",
"updated_at": "2025-03-18 14:32:54",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/warehouses/18030"
}
]
}
],
"meta": {"pagination": {"total": 2,
"count": 2,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": { }
}
},
"errors": [ ]
}

List of active carriers in Company/Seller

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

path Parameters

id_seller

required

integer <int64>

Company/Seller ID, generated by Enviame

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified
Content-Type required	string Default: application/json Not modified

Responses

Response samples

201
401
500

Content type

application/json

{"status": "success"
}

Delete a seller warehouse

Endpoint that allows deleting warehouses from a Company/Seller

path Parameters

id_seller required	integer <int64> Company/Seller ID, generated by Enviame
warehouse_id required	integer <int64> Warehouse ID, generated by Enviame

header Parameters

api-key required	string Company/Seller Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified
Content-Type required	string Default: application/json Not modified

Responses

Response samples

201
500

Content type

application/json

{"status": "success",
"data": {"identifier": 2758,
"marketplace_creator": 1402,
"marketplace_exclusive": false,
"is_active": true,
"name": "bodega capsula 2",
"code": "bod_capsula2",
"contact_name": null,
"contact_phone": null,
"contact_email": null,
"address": {"place": "Quilicura",
"place_id": 320,
"full_address": "direccion completa nueva 2",
"information": null,
"zip_code": null,
"latitude": null,
"longitude": null
},
"created_at": "2021-06-21 22:37:57",
"updated_at": "2025-03-20 15:09:38",
"deleted_at": "2025-03-20 15:09:38",
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/warehouses/2758"
}
]
},
"errors": [ ]
}

Pickups

Create pickup as a Marketplace seller

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

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

api-key required	string Marketplace Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Request Body schema: multipart/form-data

carrier_code	string Required / Carrier code to request the pickup from.
warehouse_code	string Required / Warehouse code where products will be picked up.
qty	int <int64> Required / Total number of packages to pick up.
contact_name	string Required / Name of the pickup contact person (employee).
contact_phone	string Required / Phone number of the pickup contact person (employee).
range_time	integer Required (AM or PM) / Can be AM for pickup before 12 PM or PM for after 12 PM.
pickup_date	integer <date> Optional / Pickup date in YYYY-MM-DD format / If empty, it is scheduled for the next day.
weight	integer Required / Approximate total weight (Kg.) of the packages.
size	string Required / "xs, s, m, l, c" / Total size of the packages
custom_size	string Optional / Only applies for size = C / Pallet or full load dimensions.

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "value": {
    "carrier_code": "BLX",
    "warehouse_code": "bod_ruka1",
    "qty": 4,
    "contact_name": "Usuario Bodega",
    "contact_phone": 123456789,
    "range_time": "AM",
    "pickup_date": "21-03-2025",
    "weight": 5,
    "size": "s",
    "custom_size": null
  }
}

Response samples

200
422
500

Content type

application/json

{"code": 201,
"data": {"identifier": "1285372591218",
"company": {"id": 2279,
"code": "DEV",
"name": "Development",
"dni": 106719926
},
"address": {"place_id": 378,
"full_address": "Avenida Vitacura 123",
"place": "Santiago",
"information": "H23",
"place_parents": {"parent1": {"id": 61,
"name": "Santiago",
"level_name": "Provincia"
},
"parent2": {"id": 7,
"name": "Metropolitana de Santiago",
"level_name": "Region"
}
},
"place_level_name": "Comuna",
"zip_code": null
},
"carrier": {"code": "BLX",
"name": "Bluexpress",
"country": "CL",
"is_integrated": 1,
"time_zome": "America/Santiago",
"config": {"time_limit": "10:29",
"time_limit_key": "default"
}
},
"range_time": "13:00 - 18:00",
"qty": 7,
"weight": 10,
"contact": {"name": "John Doe",
"phone": 999999999
},
"status": {"code": "created",
"name": "retiro creado",
"date": "2025-04-04 16:50:11"
},
"created_at": "2025-04-04 16:50:11",
"updated_at": "2025-04-04 16:50:11",
"deleted_at": null,
"uuid": "d3e8a7ae-5a2a-43b3-a77b-e8c0a3e1718a",
"marketplace": {"id": 10,
"code": "enviame",
"name": "Envíame"
},
"type": {"code": "normal",
"name": "retiro normal"
},
"size": "s",
"dimensions": "10cm x 15cm x 5cm",
"pickup_date": "2025-04-07 00:00:00",
"warehouse": {"id": 8710,
"code": "DEV",
"name": "DEV",
"contact": {"name": "Javier Smith",
"phone": 998874910,
"email": "cinthia.garrido@enviame.io"
}
},
"need_evaluation": false,
"carrier_pickup_number": 1285372591218,
"carrier_pickup_created": false,
"max_cancelation_date": null,
"id": "cRr8Kbj8zPAb4OsCyQxU"
}
}

Create pickup as Company/Seller

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

header Parameters

api-key required	string Marketplace Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Request Body schema: multipart/form-data

carrier_code	string Required / Carrier code to request the pickup from.
warehouse_code	string Required / Warehouse code where products will be picked up.
qty	int <int64> Required / Total number of packages to pick up.
contact_name	string Required / Name of the pickup contact person (employee).
contact_phone	string Required / Phone number of the pickup contact person (employee).
range_time	integer Required (AM or PM) / Can be AM for pickup before 12 PM or PM for after 12 PM.
pickup_date	integer <date> Optional / Pickup date in YYYY-MM-DD format / If empty, it is scheduled for the next day.
weight	integer Required / Approximate total weight (Kg.) of the packages.
size	string Required / "xs, s, m, l, c" / Total size of the packages
custom_size	string Optional / Only applies for size = C / Pallet or full load dimensions.

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "value": {
    "carrier_code": "BLX",
    "warehouse_code": "bod_ruka1",
    "qty": 4,
    "contact_name": "Usuario Bodega",
    "contact_phone": 123456789,
    "range_time": "AM",
    "pickup_date": "21-03-2025",
    "weight": 5,
    "size": "s",
    "custom_size": null
  }
}

Response samples

200
422
500

Content type

application/json

{"code": 201,
"data": {"identifier": "1285372591218",
"company": {"id": 2279,
"code": "DEV",
"name": "Development",
"dni": 106719926
},
"address": {"place_id": 378,
"full_address": "Avenida Vitacura 123",
"place": "Santiago",
"information": "H23",
"place_parents": {"parent1": {"id": 61,
"name": "Santiago",
"level_name": "Provincia"
},
"parent2": {"id": 7,
"name": "Metropolitana de Santiago",
"level_name": "Region"
}
},
"place_level_name": "Comuna",
"zip_code": null
},
"carrier": {"code": "BLX",
"name": "Bluexpress",
"country": "CL",
"is_integrated": 1,
"time_zome": "America/Santiago",
"config": {"time_limit": "10:29",
"time_limit_key": "default"
}
},
"range_time": "13:00 - 18:00",
"qty": 7,
"weight": 10,
"contact": {"name": "John Doe",
"phone": 999999999
},
"status": {"code": "created",
"name": "retiro creado",
"date": "2025-04-04 16:50:11"
},
"created_at": "2025-04-04 16:50:11",
"updated_at": "2025-04-04 16:50:11",
"deleted_at": null,
"uuid": "d3e8a7ae-5a2a-43b3-a77b-e8c0a3e1718a",
"marketplace": {"id": 10,
"code": "enviame",
"name": "Envíame"
},
"type": {"code": "normal",
"name": "retiro normal"
},
"size": "s",
"dimensions": "10cm x 15cm x 5cm",
"pickup_date": "2025-04-07 00:00:00",
"warehouse": {"id": 8710,
"code": "DEV",
"name": "DEV",
"contact": {"name": "Javier Smith",
"phone": 998874910,
"email": "cinthia.garrido@enviame.io"
}
},
"need_evaluation": false,
"carrier_pickup_number": 1285372591218,
"carrier_pickup_created": false,
"max_cancelation_date": null,
"id": "cRr8Kbj8zPAb4OsCyQxU"
}
}

List pickups as Seller

Lists all pickups created by a Company/Seller. Only works in production environment.

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

200
422
500

Content type

application/json

{"status": "success"
}

Returns

Create return

path Parameters

id_seller

required

integer

Seller ID

Request Body schema: application/json

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

Payload

Content type

application/json

Example

Home origin → Home destination

{"origin": {"place": "Valparaíso",
"full_address": "Av. Siempre Viva 123",
"information": "Casa blanca, 2 pisos",
"contact": {"name": "Alicia Pérez",
"phone": "+56911111111",
"email": "alicia.perez@example.com"
}
},
"destination": {"place": "Santiago",
"full_address": "Av. Providencia 456",
"information": "Depto 702",
"contact": {"name": "Roberto Díaz",
"phone": "+56922222222",
"email": "roberto.diaz@example.com"
}
},
"order": {"type": "return",
"imported_id": "RET-001234",
"n_packages": 1,
"packages": [{"id": 1,
"price": "4000",
"description": "Accesorio genérico",
"weight": "1",
"volume": "2"
}
]
},
"carrier": {"code": "CHX",
"service": "nextdayReturn",
"type": "",
"attribute": ""
}
}

Response samples

200
422
500

Content type

application/json

{"code": "Success",
"message": "creation success",
"data": {"id": 300100001,
"imported_id": "RET-001234",
"tracking_number": "712938900000",
"labels": ["https://storage.googleapis.com/carrier-labels/202508/300100001/label.pdf"
],
"current_status": {"name": "Listo para despacho",
"status_code": "CREATED",
"comment": "Creado en carrier CHX con OT 712938900000",
"created_at": "2025-08-25 22:00:00"
}
}
}

Get return tracking

path Parameters

imported_id

required

string

Return identifier (imported_id)

Responses

Response samples

200

Content type

application/json

{"code": "Success",
"message": "ok",
"data": {"imported_id": "RET-001234",
"tracking_number": "712938900000",
"history": [{"status_code": "CREATED",
"name": "Listo para despacho",
"comment": "Orden creada",
"created_at": "2025-08-25 22:00:00"
},
{"status_code": "IN_TRANSIT",
"name": "En tránsito",
"comment": "Salida a ruta",
"created_at": "2025-08-26 08:00:00"
},
{"status_code": "DELIVERED",
"name": "Entregado",
"comment": "Recibido en bodega DEV",
"created_at": "2025-08-27 11:30:00"
}
]
}
}

Create return from an existing delivery

path Parameters

id_seller required	integer Seller ID
delivery_id required	integer Original delivery ID

Request Body schema: application/json

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"order": {"imported_id": "string",
"n_packages": 0,
"packages": [{"id": 0,
"description": "string",
"price": "string",
"weight": "string",
"volume": "string"
}
]
},
"carrier": {"code": "string",
"service": "string"
}
}

Response samples

200

Content type

application/json

{"code": "Success",
"message": "creation success",
"data": {"id": 300107999,
"imported_id": "RET-002000",
"tracking_number": "712938999999",
"current_status": {"name": "Listo para despacho",
"status_code": "CREATED",
"comment": "Creado en carrier CHX con OT 712938999999",
"created_at": "2025-08-25 22:40:00"
}
}
}

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.

path Parameters

id_seller required	integer <int64> Company/Seller ID, generated by Enviame
id_Marketplace required	integer <int64> Marketplace ID, generated by Enviame

header Parameters

api-key required	string Marketplace Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Request Body schema: multipart/form-data

name	string Required / Warehouse name
code	string Required / Alphanumeric code of the warehouse
place	string Required / Commune (CL) - City/Municipality (CO) - District (PE) - Neighborhood (MX) - Municipality (AR) where the warehouse is located
full_address	string Required / 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

Payload

Content type

multipart/form-data

{
  "value": {
    "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

201
401

Content type

application/json

{"status": "success",
"data": {"identifier": 18035,
"marketplace_creator": 23314,
"marketplace_exclusive": false,
"is_active": true,
"name": "Bodega 2",
"code": "bod_prueba_akagi",
"contact_name": "Contacto Prueba",
"contact_phone": 987656789,
"contact_email": "bodega-prueba@enviame.io",
"address": {"place": "Cerrillos",
"place_id": 105,
"full_address": "Calle Bodega Akagi 2",
"information": "Oficina 7",
"zip_code": null,
"latitude": null,
"longitude": null
},
"created_at": "2025-03-21 18:49:26",
"updated_at": "2025-03-21 18:49:26",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/warehouses/18035"
}
]
},
"errors": [ ]
}

Edit Company/Seller Warehouse from Marketplace

Endpoint that allows modifying warehouse data of a Company/Seller associated with a Marketplace.

path Parameters

id_seller required	integer <int64> Company/Seller ID, generated by Enviame
marketplace_id required	integer <int64> Marketplace ID, generated by Enviame
warehouse_code required	string Alphanumeric code of the warehouse

header Parameters

api-key required	string Marketplace Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Request Body schema: application/json

name	string Warehouse name
place	string Required / Commune (CL) - City/Municipality (CO) - District (PE) - Neighborhood (MX) - Municipality (AR) where the warehouse is located
full_address	string Warehouse address, excluding commune

Responses

Request samples

Payload

Content type

application/json

{"name": "Bodega 2",
"place": "Cerrillos",
"full_address": "Avenida Siempreviva 24"
}

Response samples

200
401

Content type

application/json

{"status": "success",
"data": {"identifier": 18035,
"marketplace_creator": 23314,
"marketplace_exclusive": false,
"is_active": true,
"name": "Bodega 2",
"code": "bod_prueba_akagi",
"contact_name": "Contacto Prueba",
"contact_phone": 987656789,
"contact_email": "bodega-prueba@enviame.io",
"address": {"place": "Cerrillos",
"place_id": 105,
"full_address": "Calle Bodega Akagi 2",
"information": "Oficina 7",
"zip_code": null,
"latitude": null,
"longitude": null
},
"created_at": "2025-03-21 18:49:26",
"updated_at": "2025-03-21 18:49:26",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/warehouses/18035"
}
]
},
"errors": [ ]
}

Delete Company/Seller Warehouse from Marketplace

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

path Parameters

id_seller required	integer <int64> Company/Seller ID, generated by Enviame
marketplace_id required	integer <int64> Marketplace ID, generated by Enviame
warehouse_id required	integer <int64> Warehouse ID, generated by Enviame

header Parameters

api-key required	string Marketplace Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": {"identifier": 18035,
"marketplace_creator": 23314,
"marketplace_exclusive": false,
"is_active": true,
"name": "Bodega 2",
"code": "bod_prueba_akagi",
"contact_name": "Contacto Prueba",
"contact_phone": 987656789,
"contact_email": "bodega-prueba@enviame.io",
"address": {"place": "Cerrillos",
"place_id": 105,
"full_address": "Calle Bodega Akagi 2",
"information": "Oficina 7",
"zip_code": null,
"latitude": null,
"longitude": null
},
"created_at": "2025-03-21 18:49:26",
"updated_at": "2025-03-21 19:23:57",
"deleted_at": "2025-03-21 19:23:57",
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/warehouses/18035"
}
]
},
"errors": [ ]
}

List Sellers

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

path Parameters

marketplace_id

required

integer <int64>

Marketplace ID, generated by Enviame

header Parameters

api-key required	string Marketplace Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"identifier": 23315,
"name": "Team Rukawa",
"corporate_name": "Rukawa Team",
"dni": 111111111111,
"website": null,
"activated": 1,
"logo": null,
"code": "rukawa",
"api_key": "526507674963f91839ff24d52d97e2cc",
"country": "CL",
"rule": null,
"created_at": "2025-03-18 13:07:24",
"updated_at": "2025-03-18 16:07:25",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23315"
},
{"rel": "companies.employees",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23315/employees"
},
{"rel": "companies.warehouses",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23315/warehouses"
},
{"rel": "companies.carriers",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23315/carriers"
}
]
},
{"identifier": 23316,
"name": "Team Sakuragi",
"corporate_name": "Sakuragi",
"dni": 111111111111,
"website": null,
"activated": 1,
"logo": null,
"code": "sakuragi",
"api_key": "b07bcc089587489ed0c3018b2cb50d10",
"country": "CL",
"rule": null,
"created_at": "2025-03-18 13:08:57",
"updated_at": "2025-03-18 16:08:58",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23316"
},
{"rel": "companies.employees",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23316/employees"
},
{"rel": "companies.warehouses",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23316/warehouses"
},
{"rel": "companies.carriers",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23316/carriers"
}
]
},
{"identifier": 23317,
"name": "Akagi",
"corporate_name": "Akagi",
"dni": 111111111111,
"website": null,
"activated": 1,
"logo": null,
"code": "akagiii",
"api_key": "935a4d6a35fd2fc593f9705de644b66c",
"country": "CL",
"rule": null,
"created_at": "2025-03-18 13:39:21",
"updated_at": "2025-03-18 16:46:32",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23317"
},
{"rel": "companies.employees",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23317/employees"
},
{"rel": "companies.warehouses",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23317/warehouses"
},
{"rel": "companies.carriers",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23317/carriers"
}
]
}
],
"meta": {"pagination": {"total": 3,
"count": 3,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": { }
}
},
"errors": [ ]
}

Assign carrier to Company/Seller

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

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

api-key required	string Marketplace Api-Key, generated by Enviame
Accept required	string Default: application/json Not modified

Request Body schema: application/json

Assign a carrier to a Company/Seller

code	string Required / Carrier code

Responses

Request samples

Payload

Content type

application/json

{"code": "BLX"
}

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"name": "BLUEXPRESS",
"code": "BLX",
"country": "CL",
"configurations": [{"name": "BLUEXPRESS",
"code": "BLX",
"description": "Bluexpress [New]",
"default": false
}
]
}
],
"meta": {"pagination": {"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": { }
}
},
"errors": [ ]
}

Edit Seller as Marketplace

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

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

api-key required	string Marketplace Api-Key, generated by Enviame
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

Payload

Content type

multipart/form-data

{
  "value": {
    "name": "Team Akagi",
    "corporate_name": "Akagi Team",
    "code": "akagi",
    "dni": "11.111.111-1",
    "website": "www.akagiteam.cl"
  }
}

Response samples

200
401
500

Content type

application/json

{"status": "success",
"data": {"identifier": 23317,
"name": "Team Akagi",
"corporate_name": "Akagi Team",
"dni": "11.111.111-1",
"website": "www.akagiteam.cl",
"activated": 1,
"logo": null,
"code": "akagiii",
"country": "CL",
"rule": null,
"created_at": "2025-03-18 13:39:21",
"updated_at": "2025-03-18 16:43:25",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23317"
},
{"rel": "companies.employees",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23317/employees"
},
{"rel": "companies.warehouses",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23317/warehouses"
},
{"rel": "companies.carriers",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23317/carriers"
}
]
}
}

Create Seller as Marketplace

Endpoint that allows creating a Company/Seller in a Marketplace

path Parameters

marketplace_id_

required

integer <int64>

Marketplace ID, generated by Enviame

header Parameters

api-key required	string Marketplace Api-Key, generated by Enviame
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

Payload

Content type

application/json

{"name": "Team Mitsui",
"corporate_name": "Mitsui Team",
"code": "mitsui_team",
"dni": 111111111111,
"rule": 0,
"carrier_code": ["BLX, CHX, CCH, SKN"
]
}

Response samples

200
401

Content type

application/json

{"status": "success",
"data": {"identifier": 23321,
"name": "Team Mitsui",
"corporate_name": "Mitsui Team",
"dni": 111111111111,
"website": null,
"activated": 1,
"logo": null,
"code": "mitsui_team",
"country": "CL",
"rule": null,
"created_at": "2025-03-25 19:35:21",
"updated_at": "2025-03-25 19:35:21",
"deleted_at": null,
"links": [{"rel": "self",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23321"
},
{"rel": "companies.employees",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23321/employees"
},
{"rel": "companies.warehouses",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23321/warehouses"
},
{"rel": "companies.carriers",
"href": "https://dev-san-andres-dot-easypoint-latam.appspot.com/api/s1/v1/companies/23321/carriers"
}
]
}
}

Rates

Query rates

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

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

header Parameters

x-api-key

required

string

Client API key for authentication.

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

200

Content type

application/json

Example

Response for Chile (kg)

{"status": "success",
"data": [{"carrier": "BLX",
"name": "BLUEXPRESS",
"weight": "1.00",
"services": [{"name": "E-Commerce",
"code": "priority",
"service_types": ["nextday"
],
"transit_days_base_value": 1,
"transit_days": 1,
"cost_freight_included": false,
"cost_freight_information": { },
"group_by_carrier_service_type": null,
"price": 3838,
"price_formatted": "$3.838"
}
]
}
],
"meta": {"exec_seconds": 3.2198411490007857
}
}