Skip to main content
API docs by Redocly

Enviame API (3.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

Intro

Hello world, this is the new Enviame API v3 definition.

Authentication

Before using this API version, you have to request an initial setup of your company's account to our support team. You'll be provided with a cURL example to an Auth0 application that we will have created for you (we're sorry for this unsophisticated way, we are working on a better setup). The Auth0 app provides valid access tokens to call our API methods.

Pickups

Export pickups

Export pickups to a excel file

Request Body schema: application/json
pickup_date_from
string <date>

Pickup date from

pickup_date_to
string <date>

Pickup date to

pickup_date
string <date>

Pickup date. If this parameter is set, the pickup_date_from and pickup_date_to parameters will be ignored

updated_at_from
string <date>

Updated at from

updated_at_to
string <date>

Updated at to

shipper_id
integer <int64>

Shipper ID

organization_id
integer <int64>

Organization ID

carrier_code
string

Carrier Code

carrier_pickup_number
string

The carrier's pickup number. This is the number that the carrier uses to identify the pickup

status_code
Array of strings
Items Enum: "scheduled" "done" "failed" "canceled"

Status of the pickup

type
string
Value: "return"

Type of pickup

Responses

Request samples

Content type
application/json
{
  • "pickup_date_from": "2019-08-24",
  • "pickup_date_to": "2019-08-24",
  • "pickup_date": "2019-08-24",
  • "updated_at_from": "2019-08-24",
  • "updated_at_to": "2019-08-24",
  • "shipper_id": 0,
  • "organization_id": 0,
  • "carrier_code": "string",
  • "carrier_pickup_number": "string",
  • "status_code": [
    ],
  • "type": "return"
}

Response samples

Content type
application/json
{}

PUDOs

List PUDOs by place

Retrieves a list of PUDOs, based on the provided place.

query Parameters
type
required
string
Enum: "store" "courier"
Example: type=store

The type of PUDOs that you want to retrieve.

place_name
required
string

Specifies the name of the smallest geographic administrative unit for the specified country. For Chile, this refers to the name of the commune; for Colombia, it corresponds to the municipality; for Peru, it refers to the name of the district. In the case of Mexico, this parameter accepts the name of any administrative division such as neighborhood, city, municipality, or state.

parent_place_name
string

required: only for Colombia and Peru.

Specifies the name of the parent administrative division of the given place for the specified country. For Chile and Peru, this refers to the name of the province; for Colombia, it corresponds to the department. In the case of Mexico, this parameter is ignored and is not necessary.

place_level_name
string
Enum: "state" "municipality" "city" "neighborhood"
Example: place_level_name=city

required: for Mexico only.

Name of the geographical subdivision corresponding to the sent place.

zip_code
string

applies: for Mexico only.

The zip code of the neighborhood. If this field is provided, it is assumed that the place corresponds to a neighborhood.

page
integer

The page number from which you want your page search results to be displayed.

limit
integer

Default 20 per page.

Number of results per page.

Responses

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "message": "PUDOs obtained successfully",
  • "paging": {
    },
  • "data": [
    ]
}

Tickets

Get all tickets

Retrieve a list of tickets.

query Parameters
delivery_id
integer <int64>

ID of the delivery

current_type
string

current type of the ticket

current_status
string

current status of the ticket

page
integer <int64>

page number to retrieve

limit
integer <int64>

number of tickets per page to retrieve

delivery_status
string

filter ticket by current delivery status

ticket_mode
string
Enum: "delivery" "return"

filter by tickets mode (delivery or return)

order_by
string
Enum: "CREATED_AT_ASC" "CREATED_AT_DESC" "LAST_MESSAGE_ASC" "LAST_MESSAGE_DESC" "WAITING_DAYS_ASC" "WAITING_DAYS_DESC"

order by a specific field. The available fields are: CREATED_AT_ASC, CREATED_AT_DESC, LAST_MESSAGE_ASC, LAST_MESSAGE_DESC, WAITING_DAYS_ASC, WAITING_DAYS_DESC

created_at_from
string

filter tickets created from a date in UTC timezone

created_at_to
string

filter tickets created to a date in UTC timezone

country
string
Enum: "CL" "PE" "CO" "MX"

filter tickets where the carrier is from the specified country

carrier
string

filter tickets by carrier code

shipper
string

filter tickets by shipper code

shipper_id
string

filter tickets by shipper id

current_status_date_from
string

filter tickets where the date of their current status is equal to or greater than a specified date in utc

current_status_date_to
string

filter tickets where the date of their current status is equal to or less than a specified date in utc

current_type_date_from
string

filter tickets where the date of their current subject is equal to or less than a specified date in utc

current_type_date_to
string

filter tickets where the date of their current subject is equal to or less than a specified date in utc

current_stage_date_from
string

filter tickets where the date of their current stage is equal to or less than a specified date in utc

current_stage_date_to
string

filter tickets where the date of their current stage is equal to or less than a specified date in utc

last_message_from
string

filter tickets where the date of their last message is equal to or less than a specified date in utc

last_message_to
string

filter tickets where the date of their last message is equal to or less than a specified date in utc

current_stage
string
Enum: "ISSUE" "COMPLAINT" "COMPENSATION" "CLOSED" "DISAGREEMENT"

filter tickets by current stage

fulfillment
boolean

filter tickets by fulfillment type

organization
string

filter tickets by organization code

organization_id
integer <int64>

filter tickets by organization id

read_client
boolean

filter tickets where the last message has been read or not by the client

read_agent
boolean

filter tickets where the last message has been read or not by the agent

Responses

Response samples

Content type
application/json
{
  • "status": "fail",
  • "message": "string",
  • "errors": [
    ]
}

Get ticket details by delivery id

Retrieve a ticket by delivery id.

path Parameters
delivery_id
required
integer <int64>

ID of the delivery

Responses

Response samples

Content type
application/json
{
  • "status": "fail",
  • "message": "string",
  • "errors": [
    ]
}

Create a message for a ticket

Create a message for a ticket.

path Parameters
delivery_id
required
integer <int64>

ID of the delivery

Request Body schema: application/json
message
string

The message to be sent.

timezone
string

The timezone of the message.

object
object

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "timezone": "string",
  • "type": {
    },
  • "extra_fields": {
    }
}

Response samples

Content type
application/json
{
  • "status": "fail",
  • "message": "string",
  • "errors": [
    ]
}