Envíosperros V3

https://enviosperrosv3.docs.apiary.io/
Admin
Envíosperros V3 allows users to manage their shipments through an API integration for a personalized...
Tokens:112,811
Snippets:872
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Solicitar una recolección

Source: https://enviosperrosv3.docs.apiary.io/

Request a pickup for a previously created guide, provided the service allows it and availability/time rules are met. You can request up to three pickups per guide if the initial attempts fail. This endpoint returns all pickup requests for the given guide.

```APIDOC
## Solicitar una recolección

### Description
Request a pickup for a previously created guide, provided the service allows it and availability/time rules are met. You can request up to three pickups per guide if the initial attempts fail. This endpoint returns all pickup requests for the given guide.

### Method
POST

### Endpoint
/recolecciones

### Parameters
#### Request Body
- **guide_number** (string) - Required - The guide number for which to request a pickup.
- **pickup_date** (string) - Required - The desired date for the pickup (YYYY-MM-DD).
- **pickup_time** (string) - Required - The desired time window for the pickup (e.g., "09:00-12:00").
- **pickup_address** (object) - Required - The address where the pickup should occur (can be different from origin).
  - **street** (string) - Required.
  - **neighborhood** (string) - Required.
  - **city** (string) - Required.
  - **state** (string) - Required.
  - **postal_code** (string) - Required.
  - **references** (string) - Optional - Additional references for the pickup location.

### Response
#### Success Response (200)
- **pickup_requests** (array) - A list of all pickup requests for the guide.
  - **request_id** (string) - Unique identifier for the pickup request.
  - **guide_number** (string) - The associated guide number.
  - **status** (string) - The current status of the pickup request (e.g., "pending", "scheduled", "completed", "failed").
  - **reference** (string) - The pickup folio or reference number if successful.
  - **scheduled_time** (string) - The confirmed scheduled time for the pickup.

#### Response Example
```json
{
  "pickup_requests": [
    {
      "request_id": "PICKUP001",
      "guide_number": "GUIDE12345",
      "status": "scheduled",
      "reference": "REF45678",
      "scheduled_time": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

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

### Solicitar una recolección

Source: https://enviosperrosv3.docs.apiary.io/introduction/descuentos

Requests a pickup for a previously created guide if the service used for the guide allows for pickups and meets availability and time requirements. It is possible to request a pickup up to a maximum of three times per guide if the package could not be collected. This endpoint will return all pickup requests made for the given guide, including the one requested. If successful, it will return the pickup request folio ('reference'). Only for PaquetExpress and TresGuerras pickups is it necessary for the guide to have been generated through the corresponding 'Económica con Recolección' service, otherwise it cannot be scheduled.

```APIDOC
## POST /recolecciones

### Description
Requests a pickup for a specific shipping guide.

### Method
POST

### Endpoint
/recolecciones

### Request Body
- **guide_id** (string) - Required - The ID of the guide for which to request a pickup.
- **pickup_address** (object) - Required - The address where the pickup should occur.
  - **street** (string) - Required - Street name.
  - **number** (string) - Required - Street number.
  - **neighborhood** (string) - Required - Neighborhood or colony.
  - **postal_code** (string) - Required - Postal code.
  - **city** (string) - Required - City.
  - **state** (string) - Required - State.
  - **references** (string) - Optional - Additional references for the pickup location.
- **pickup_time** (object) - Optional - Desired pickup time window.
  - **start_time** (string) - Required if pickup_time is provided - Start time in HH:MM format.
  - **end_time** (string) - Required if pickup_time is provided - End time in HH:MM format.

### Response
#### Success Response (200)
- **request_id** (string) - The unique ID of the pickup request.
- **guide_id** (string) - The ID of the guide associated with the pickup request.
- **status** (string) - The status of the pickup request (e.g., 'scheduled', 'pending').
- **reference** (string) - The folio or reference number for the pickup request.

#### Response Example
```json
{
  "request_id": "pickup_req_456",
  "guide_id": "guide_xyz789",
  "status": "scheduled",
  "reference": "PICKUPREF001"
}
```
```

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

### Cancel Guides

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/descarga/descargar-guia

Allows cancellation of multiple guides and requests a refund to the account balance. Guides become unusable after cancellation. Cancellation is only possible within 3 days of creation.

```APIDOC
## Cancel Guides

### Description
Cancels one or more shipping guides and requests a refund to the account balance. Cancelled guides cannot be used. This operation is only available within 3 days of guide creation.

### Method
DELETE

### Endpoint
/guides

### Parameters
#### Query Parameters
- **guide_ids** (array of strings) - Required - A list of guide IDs to cancel.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of cancellation.
- **refunded_guides** (array of strings) - List of successfully refunded guide IDs.
- **failed_cancellations** (object) - Details of guides that could not be cancelled.
  - **guide_id** (string) - The ID of the guide that failed cancellation.
  - **reason** (string) - The reason for the cancellation failure.

#### Response Example
{
  "message": "Guides cancelled successfully.",
  "refunded_guides": ["GUIDE12345", "GUIDE67890"],
  "failed_cancellations": [
    {
      "guide_id": "GUIDE11111",
      "reason": "Guide is older than 3 days."
    }
  ]
}
```

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

### Cancelar guías

Source: https://enviosperrosv3.docs.apiary.io/#reference/endpoints/seguros

Allows cancellation of multiple guides and requests a refund to the user's balance. Cancelled guides become unusable. Cancellation is only possible within 3 calendar days of guide creation. If a guide is already cancelled, the current information will be returned.

```APIDOC
## Cancelar guías

### Description
Allows cancellation of multiple guides and requests a refund to the user's balance. Cancelled guides become unusable. Cancellation is only possible within 3 calendar days of guide creation. If a guide is already cancelled, the current information will be returned.

### Method
DELETE

### Endpoint
/guias

### Parameters
#### Request Body
- **guide_ids** (array) - Required - A list of guide IDs to cancel.

### Request Example
{
  "example": "{\"guide_ids\": [\"guide123\", \"guide456\"]}"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the guides have been cancelled.
- **refunded_amount** (number) - The total amount refunded to the balance.
```

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

### Cancelar guías

Source: https://enviosperrosv3.docs.apiary.io/introduction/create-api

Cancel multiple guides and request a refund to your account balance. Canceled guides become unusable. Refunds are processed automatically after a grace period. Cancellation is only possible within 3 days of guide creation.

```APIDOC
## Cancelar guías

### Description
Cancel multiple guides and request a refund to your account balance. Canceled guides become unusable. Refunds are processed automatically after a grace period. Cancellation is only possible within 3 days of guide creation.

### Method
DELETE

### Endpoint
/guias

### Parameters
#### Request Body
- **guide_ids** (array) - Required - A list of guide IDs to cancel.

### Request Example
```json
{
  "guide_ids": ["GUIDE12345", "GUIDE67890"]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the guides have been canceled.
- **refunded_guides** (array) - List of guides that were successfully refunded.

#### Response Example
```json
{
  "message": "Guides canceled successfully and refund initiated.",
  "refunded_guides": ["GUIDE12345", "GUIDE67890"]
}
```
```

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

### Cancelar guías

Source: https://enviosperrosv3.docs.apiary.io/reference/create-api

Cancel multiple guides and request a refund to your balance. Guides must be canceled within 3 days of creation.

```APIDOC
## DELETE /guias

### Description
Este recurso permite cancelar múltiples guías y solicitar un **reembolso a saldo**. Esto dejará las guías inutilizables y no serán aceptada por paqueterías en su ventanilla o al momento de recolectarlas. Después de un periodo de gracia, el reembolso se realizará de forma automática a tu cuenta en Envíosperros.
Para poder cancelar una guías, no deben haber transcurrido más de **3 días** naturales tras la creación de la guía.
Si una guía ya está cancelada, se devolverá la información actual.

### Method
DELETE

### Endpoint
/guias

### Parameters
#### Request Body
- **guide_numbers** (array) - Required - A list of guide numbers to cancel.
  - (string) - A guide number.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the guides have been canceled.
- **canceled_guides** (array) - A list of guide numbers that were successfully canceled.
  - (string) - A canceled guide number.
- **failed_cancellations** (array) - A list of guide numbers that could not be canceled, with reasons.
  - **guide_number** (string) - The guide number that failed cancellation.
  - **reason** (string) - The reason for the cancellation failure.

#### Response Example
```json
{
  "message": "Guides canceled successfully.",
  "canceled_guides": ["1234567890", "0987654321"],
  "failed_cancellations": [
    {
      "guide_number": "1122334455",
      "reason": "Guide is older than 3 days."
    }
  ]
}
```
```

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

### Listar bienes asegurables (Groovy)

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/seguros/listar-bienes-asegurables

Groovy script to retrieve insurable commodities. This example uses the HTTPBuilder library to send a GET request with the required headers, including the authorization token.

```groovy
import groovy.json.JsonOutput
import groovy.json.JsonSlurper
import groovyx.net.http.HTTPBuilder
import static groovyx.net.http.Method.GET

HTTPBuilder http = new HTTPBuilder('https://app.enviosperros.com')

http.each (
    request -> {
        request.uri.path = '/api/v3/insurance/commodities'
        request.headers.'Content-Type' = 'application/json'
        request.headers.'Accept' = 'application/json'
        request.headers.'Authorization' = 'Bearer {token}'
    }
)

http.request(GET, 'application/json') {
    resp, json -> 
        println "Status: ${resp.status}"
        println JsonOutput.prettyPrint(JsonOutput.toJson(json))
    
    response ->
        println "Failed: ${response.status} ${response.data}"
}

```

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

### Create a Guide

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/descarga/descargar-guia

This process involves selecting a carrier and service, validating all shipment details, and then generating the guide. The cost is deducted from the account balance.

```APIDOC
## Create a Guide

### Description
Creates a shipping guide by selecting a carrier, service, validating details, and deducting the cost from the account balance. Supports insurance with beneficiary details.

### Method
POST

### Endpoint
/guides

### Parameters
#### Request Body
- **carrier** (string) - Required - The selected carrier.
- **service** (string) - Required - The selected service (e.g., "Económica", "Express").
- **origin_details** (object) - Required - Details of the origin.
  - **name** (string) - Required
  - **phone** (string) - Required
  - **email** (string) - Required
  - **address** (object) - Required
    - **street** (string) - Required
    - **number** (string) - Required
    - **neighborhood** (string) - Required
    - **city** (string) - Required
    - **state** (string) - Required
    - **zip_code** (string) - Required
    - **country** (string) - Required
- **destination_details** (object) - Required - Details of the destination.
  - **name** (string) - Required
  - **phone** (string) - Required
  - **email** (string) - Required
  - **address** (object) - Required
    - **street** (string) - Required
    - **number** (string) - Required
    - **neighborhood** (string) - Required
    - **city** (string) - Required
    - **state** (string) - Required
    - **zip_code** (string) - Required
    - **country** (string) - Required
- **package_details** (object) - Required - Details of the package.
  - **weight** (number) - Required
  - **dimensions** (object) - Required
    - **length** (number) - Required
    - **width** (number) - Required
    - **height** (number) - Required
  - **insurance** (object) - Optional - Insurance details.
    - **required** (boolean) - Required
    - **beneficiary** (object) - Required if insurance.required is true.
      - **rfc** (string) - Required
      - **name** (string) - Optional
      - **address** (object) - Optional
        - **street** (string) - Required
        - **number** (string) - Required
        - **neighborhood** (string) - Required
        - **city** (string) - Required
        - **state** (string) - Required
        - **zip_code** (string) - Required
        - **country** (string) - Required

### Response
#### Success Response (201)
- **guide_id** (string) - Unique identifier for the created guide.
- **policy_number** (string) - Policy number if insurance was requested.
- **total_cost** (number) - The total cost of the shipment.

#### Response Example
{
  "guide_id": "GUIDE12345",
  "policy_number": "POL98765",
  "total_cost": 150.75
}
```

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

### Listar bienes asegurables (Objective-C)

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/seguros/listar-bienes-asegurables

Objective-C code for fetching insurable commodities. This example uses NSURLSession to perform a GET request, including the necessary headers for authentication and content type.

```objectivec
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        NSURL *url = [NSURL URLWithString:@"https://app.enviosperros.com/api/v3/insurance/commodities"];
        NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
        request.HTTPMethod = @"GET";
        
        NSString *token = @"{token}";
        [request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
        [request setValue:@"application/json" forHTTPHeaderField:@"Accept"];
        [request setValue:[NSString stringWithFormat:@"Bearer %@", token] forHTTPHeaderField:@"Authorization"];
        
        NSURLSession *session = [NSURLSession sharedSession];
        NSURLSessionDataTask *task = [session dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
            if (error) {
                NSLog(@"Error: %@\n", error.localizedDescription);
                return;
            }
            
            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
            if (httpResponse.statusCode >= 200 && httpResponse.statusCode < 300) {
                NSString *responseString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
                NSLog(@"%@\n", responseString);
            } else {
                NSLog(@"HTTP Error: %ld\n", (long)httpResponse.statusCode);
            }
        }];
        
        [task resume];
    }
    return 0;
}

```

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

### Listar bienes asegurables (Perl)

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/seguros/listar-bienes-asegurables

Perl script to fetch insurable commodities. This example uses the LWP::UserAgent module to send a GET request with the necessary headers, including the authorization token.

```perl
use strict;
use warnings;
use LWP::UserAgent;

my $url = 'https://app.enviosperros.com/api/v3/insurance/commodities';
my $token = '{token}';

my $ua = LWP::UserAgent->new;
$ua->agent("MyClient/1.0");

my $response = $ua->get($url, 
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => "Bearer $token"
);

if ($response->is_success) {
    print $response->decoded_content;
} else {
    die "Error: " . $response->status_line;
}

```

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

### Crear una guía

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/guias

Create a shipping guide. This process involves selecting a package and service, validating shipment details, deducting the cost from the account balance, and generating a unique guide reference.

```APIDOC
## Crear una guía

### Description
The complete process involves: Selection: A package and service (Economic, Express, or Economic with Pickup) previously obtained from the Quote endpoint is used. Validation: It is verified that all origin, destination, and package data are correct, including origin and destination neighborhood names. Payment: The shipping cost is automatically deducted from the account balance. For now, it is only possible to pay with balance, which is deducted from the account associated with the used Bearer token. Generation: The guide is created with the package and a unique reference, as well as the total and policy number (if insurance was requested) are returned.

To request insurance, it is necessary to include beneficiary data. For insurance generation, an RFC is necessary, either in the origin data (if the beneficiary is the sender), in the destination data (if the beneficiary is the recipient), or in the complete data of another beneficiary (in the `insurance.beneficiary` object).

### Method
POST

### Endpoint
/guias

### Parameters
#### Request Body
- **carrierId** (string) - Required - The ID of the selected carrier.
- **serviceId** (string) - Required - The ID of the selected service.
- **origin** (object) - Required - Origin address details.
  - **name** (string) - Required - Contact name.
  - **company** (string) - Optional - Company name.
  - **phone** (string) - Required - Contact phone number.
  - **email** (string) - Required - Contact email address.
  - **street** (string) - Required - Street name.
  - **number** (string) - Required - Street number.
  - **neighborhood** (string) - Required - Neighborhood name or key.
  - **city** (string) - Required - City name.
  - **state** (string) - Required - State name.
  - **postalCode** (string) - Required - Postal code.
  - **country** (string) - Required - Country name.
- **destination** (object) - Required - Destination address details (same structure as origin).
- **package** (object) - Required - Package details.
  - **weight** (object) - Required - Package weight.
    - **value** (number) - Required - Weight value.
    - **unit** (string) - Required - Weight unit (e.g., 'kg').
  - **dimensions** (object) - Required - Package dimensions.
    - **length** (number) - Required - Length value.
    - **width** (number) - Required - Width value.
    - **height** (number) - Required - Height value.
    - **unit** (string) - Required - Dimension unit (e.g., 'cm').
- **insurance** (object) - Optional - Insurance details.
  - **declareCustoms** (boolean) - Optional - Whether to declare customs value.
  - **customsValue** (object) - Optional - Customs value details.
    - **amount** (number) - Required if `declareCustoms` is true.
    - **currency** (string) - Required if `declareCustoms` is true.
  - **beneficiary** (object) - Optional - Insurance beneficiary details.
    - **rfc** (string) - Required if insurance is requested and beneficiary is not sender/receiver.
    - **name** (string) - Required.
    - **phone** (string) - Required.
    - **email** (string) - Required.
    - **street** (string) - Required.
    - **number** (string) - Required.
    - **neighborhood** (string) - Required.
    - **city** (string) - Required.
    - **state** (string) - Required.
    - **postalCode** (string) - Required.
    - **country** (string) - Required.

### Response
#### Success Response (200)
- **guideNumber** (string) - The generated guide number.
- **reference** (string) - A unique reference for the guide.
- **total** (object) - The total cost of the shipment.
  - **amount** (number) - The amount.
  - **currency** (string) - The currency.
- **policyNumber** (string) - The policy number if insurance was requested.

#### Response Example
{
  "guideNumber": "1234567890",
  "reference": "REF12345",
  "total": {
    "amount": 250.75,
    "currency": "MXN"
  },
  "policyNumber": "POL98765"
}
```

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

### Crear una guía

Source: https://enviosperrosv3.docs.apiary.io/introduction/limites

Create a shipping guide by selecting a carrier and service, validating addresses and package details, and deducting the cost from the user's account balance.

```APIDOC
## Crear una guía

### Description
This process involves selecting a carrier and service, validating all origin, destination, and package data, and then generating the guide. The cost is automatically deducted from the account balance. Payment is currently only possible via account balance.

### Method
POST

### Endpoint
/guias

### Parameters
#### Request Body
- **carrier_code** (string) - Required - The code of the selected carrier.
- **service_code** (string) - Required - The code of the selected service (e.g., "Económica", "Express", "Económica con Recolección").
- **origin** (object) - Required - Details of the origin address.
  - **name** (string) - Required - Contact person's name.
  - **phone** (string) - Required - Contact person's phone number.
  - **email** (string) - Required - Contact person's email address.
  - **street** (string) - Required - Street name and number.
  - **neighborhood** (string) - Required - Neighborhood name.
  - **city** (string) - Required - City name.
  - **state** (string) - Required - State name.
  - **postal_code** (string) - Required - Postal code.
  - **country** (string) - Required - Country code (e.g., "MX").
  - **rfc** (string) - Optional - RFC for insurance if sender is beneficiary.
- **destination** (object) - Required - Details of the destination address.
  - **name** (string) - Required - Contact person's name.
  - **phone** (string) - Required - Contact person's phone number.
  - **email** (string) - Required - Contact person's email address.
  - **street** (string) - Required - Street name and number.
  - **neighborhood** (string) - Required - Neighborhood name.
  - **city** (string) - Required - City name.
  - **state** (string) - Required - State name.
  - **postal_code** (string) - Required - Postal code.
  - **country** (string) - Required - Country code (e.g., "MX").
  - **rfc** (string) - Optional - RFC for insurance if recipient is beneficiary.
- **package** (object) - Required - Details of the package.
  - **weight** (object) - Required - Package weight.
    - **value** (number) - Required - Weight value.
    - **unit** (string) - Required - Weight unit (e.g., "kg", "lb").
  - **dimensions** (object) - Required - Package dimensions.
    - **length** (number) - Required - Length value.
    - **width** (number) - Required - Width value.
    - **height** (number) - Required - Height value.
    - **unit** (string) - Required - Dimension unit (e.g., "cm", "in").
- **insurance** (object) - Optional - Insurance details.
  - **amount** (number) - Required if insurance is requested - Insured amount.
  - **beneficiary** (object) - Optional - Details of the insurance beneficiary if not sender or recipient.
    - **name** (string) - Required - Beneficiary's name.
    - **rfc** (string) - Required - Beneficiary's RFC.

### Response
#### Success Response (200)
- **guide_number** (string) - The generated guide number.
- **tracking_number** (string) - The tracking number for the shipment.
- **policy_number** (string) - The policy number if insurance was requested.
- **total_price** (number) - The total cost of the shipment.
- **currency** (string) - The currency of the total price.

#### Response Example
```json
{
  "guide_number": "GUIDE123456789",
  "tracking_number": "TRACK987654321",
  "policy_number": "POL987654321",
  "total_price": 250.00,
  "currency": "MXN"
}
```
```

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

### Listar bienes asegurables (Ruby)

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/seguros/listar-bienes-asegurables

Ruby code to fetch insurable commodities. This example uses the Net::HTTP library to make a GET request, including the required authorization token in the headers.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://app.enviosperros.com/api/v3/insurance/commodities')

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.request_uri)
request['Content-Type'] = 'application/json'
request['Accept'] = 'application/json'
request['Authorization'] = 'Bearer {token}'

response = http.request(request)

puts response.body
```

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

### Crear una guía

Source: https://enviosperrosv3.docs.apiary.io/introduction/descuentos

Creates a shipping guide. The process involves selecting a carrier and service, validating addresses and package details, deducting the shipping cost from the account balance, and generating a unique guide reference.

```APIDOC
## POST /guias

### Description
Creates a shipping guide after selecting a carrier, service, and validating all details.

### Method
POST

### Endpoint
/guias

### Request Body
- **carrier_service_id** (string) - Required - The ID of the carrier service obtained from the Cotización endpoint.
- **origin** (object) - Required - Details of the origin address.
  - **postal_code** (string) - Required - Origin postal code.
  - **name** (string) - Required - Name of the locality.
  - **state** (string) - Required - State of the locality.
  - **city** (string) - Required - City of the locality.
  - **neighborhood_id** (string) - Required - ID of the origin neighborhood.
- **destination** (object) - Required - Details of the destination address.
  - **postal_code** (string) - Required - Destination postal code.
  - **name** (string) - Required - Name of the locality.
  - **state** (string) - Required - State of the locality.
  - **city** (string) - Required - City of the locality.
  - **neighborhood_id** (string) - Required - ID of the destination neighborhood.
- **package** (object) - Required - Details of the package.
  - **weight** (object) - Required - Package weight.
    - **value** (number) - Required - Weight value.
    - **unit** (string) - Required - Weight unit (e.g., 'kg', 'lb').
  - **dimensions** (object) - Required - Package dimensions.
    - **length** (number) - Required - Length value.
    - **width** (number) - Required - Width value.
    - **height** (number) - Required - Height value.
    - **unit** (string) - Required - Dimension unit (e.g., 'cm', 'in').
- **insurance** (object) - Optional - Insurance details.
  - **rfc** (string) - Required if insurance is requested and beneficiary is sender or receiver - RFC of the beneficiary.
  - **beneficiary** (object) - Required if insurance is requested and RFC is not in origin/destination - Beneficiary details.
    - **name** (string) - Required - Beneficiary name.
    - **rfc** (string) - Required - Beneficiary RFC.

### Response
#### Success Response (200)
- **guide_id** (string) - The unique ID of the generated guide.
- **reference** (string) - A unique reference number for the guide.
- **policy_number** (string) - The policy number if insurance was requested.
- **total_price** (number) - The total cost of the shipment.
- **currency** (string) - The currency of the total price.

#### Response Example
```json
{
  "guide_id": "guide_xyz789",
  "reference": "REF123456789",
  "policy_number": "POL987654321",
  "total_price": 250.00,
  "currency": "MXN"
}
```
```

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

### Listar bienes asegurables (PHP)

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/seguros/listar-bienes-asegurables

PHP code example for retrieving a list of insurable commodities. This snippet uses cURL to send a GET request with the necessary headers, including the authorization token.

```php
<?php

$url = 'https://app.enviosperros.com/api/v3/insurance/commodities';
$token = '{token}';

$headers = [
    'Content-Type: application/json',
    'Accept: application/json',
    'Authorization: Bearer ' . $token
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);

?>

```

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

### Listar bienes asegurables (Node.js)

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/seguros/listar-bienes-asegurables

This Node.js example shows how to make a GET request to retrieve insurable commodities. It utilizes the 'axios' library and includes necessary headers for authentication and content type.

```javascript
const axios = require('axios');

const url = 'https://app.enviosperros.com/api/v3/insurance/commodities';
const token = '{token}';

axios.get(url, {
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': `Bearer ${token}`
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error fetching commodities:', error);
});
```

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

### Crear una guía

Source: https://enviosperrosv3.docs.apiary.io/introduction/formato

Create a shipping guide by selecting a carrier and service, validating details, and deducting the cost from your account balance.

```APIDOC
## Crear una guía

### Description
This endpoint initiates the process of creating a shipping guide. The process involves:
1.  **Selection:** Choosing a carrier and service (e.g., 'Económica', 'Express', or 'Económica con Recolección') obtained from the 'Cotizar envío' endpoint.
2.  **Validation:** Verifying all origin, destination, and package details, including neighborhood names.
3.  **Payment:** The shipping cost is automatically deducted from the account balance associated with the provided Bearer token.
4.  **Generation:** Creating the guide with the selected carrier and returning a unique reference, the total cost, and a policy number if insurance was requested.

To request insurance, beneficiary details must be included. An RFC is required for insurance generation, either in the origin data (if the beneficiary is the sender), destination data (if the beneficiary is the recipient), or in the complete data of another beneficiary (within the `insurance.beneficiary` object).

### Method
POST

### Endpoint
/guias

### Parameters
#### Request Body
- **carrier_id** (string) - Required - The ID of the selected carrier.
- **service_id** (string) - Required - The ID of the selected service.
- **origin_details** (object) - Required - Details of the origin.
  - **name** (string) - Required - Sender's name.
  - **phone** (string) - Required - Sender's phone number.
  - **email** (string) - Required - Sender's email address.
  - **postal_code** (string) - Required - Sender's postal code.
  - **neighborhood_key** (string) - Required - Key of the sender's neighborhood.
  - **rfc** (string) - Optional - Sender's RFC (if beneficiary).
- **destination_details** (object) - Required - Details of the destination.
  - **name** (string) - Required - Recipient's name.
  - **phone** (string) - Required - Recipient's phone number.
  - **email** (string) - Required - Recipient's email address.
  - **postal_code** (string) - Required - Recipient's postal code.
  - **neighborhood_key** (string) - Required - Key of the recipient's neighborhood.
  - **rfc** (string) - Optional - Recipient's RFC (if beneficiary).
- **package_details** (object) - Required - Details about the package.
  - **weight** (number) - Required - The weight of the package in kilograms.
  - **dimensions** (object) - Required - The dimensions of the package.
    - **length** (number) - Required - The length of the package in centimeters.
    - **width** (number) - Required - The width of the package in centimeters.
    - **height** (number) - Required - The height of the package in centimeters.
- **insurance** (object) - Optional - Insurance details.
  - **requested** (boolean) - Required - Whether insurance is requested.
  - **beneficiary** (object) - Optional - Insurance beneficiary details if different from sender/receiver.
    - **name** (string) - Required - Beneficiary's name.
    - **rfc** (string) - Required - Beneficiary's RFC.

### Request Example
```json
{
  "carrier_id": "carrier_123",
  "service_id": "service_express",
  "origin_details": {
    "name": "Juan Perez",
    "phone": "5512345678",
    "email": "juan.perez@example.com",
    "postal_code": "06000",
    "neighborhood_key": "col_roma_norte",
    "rfc": "PEPJ800101ABC"
  },
  "destination_details": {
    "name": "Maria Garcia",
    "phone": "3398765432",
    "email": "maria.garcia@example.com",
    "postal_code": "44600",
    "neighborhood_key": "col_providencia"
  },
  "package_details": {
    "weight": 2,
    "dimensions": {
      "length": 25,
      "width": 15,
      "height": 10
    }
  },
  "insurance": {
    "requested": true,
    "beneficiary": {
      "name": "Ana Lopez",
      "rfc": "LOPA900202XYZ"
    }
  }
}
```

### Response
#### Success Response (200)
- **guide_reference** (string) - A unique reference for the generated guide.
- **total_cost** (number) - The total cost of the shipment.
- **policy_number** (string) - The policy number if insurance was requested.

#### Response Example
```json
{
  "guide_reference": "REF123456789",
  "total_cost": 250.00,
  "policy_number": "POL987654321"
}
```
```

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

### Listar bienes asegurables (Python)

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/seguros/listar-bienes-asegurables

Example of how to list insurable commodities using Python's requests library. This code sends a GET request with the required headers, including the authorization token.

```python
import requests

url = "https://app.enviosperros.com/api/v3/insurance/commodities"
headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer {token}'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

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

### Crear una guía

Source: https://enviosperrosv3.docs.apiary.io/reference/create-api

Create a shipping guide by selecting a carrier and service, validating details, and deducting the cost from your account balance.

```APIDOC
## POST /guias

### Description
El proceso completo implica:
  1. _Selección:_ Se utiliza una paquetería y un servicio (**Económica, Express o Económica con Recolección**) previamente obtenido del endpoint de Cotización.
  2. _Validación:_ Se verifica que todos los datos de origen, destino y paquete sean correctos, incluyendo nombres de colonias de origen y destino.
  3. _Pago:_ El costo del envío se deduce automáticamente del saldo de la cuenta. Por el momento sólo es posible pagar con saldo, el cual se deduce de la cuenta asociada al `Bearer token` usado.
  4. _Generación:_ Se crea la guía con la paquetería y se devuelve una referencia única, así como el total y el número de póliza (si se solicitó seguro).

Para solicitar seguro, es necesario incluir datos del beneficiario, Para la generación de seguros, es necesario incluir un RFC, ya sea en datos de origen (si el beneficiario es el remitente), en datos de destino (si el beneficiario es el destinatario) o en los datos completos de otro beneficiario (en el objeto `insurance.beneficiary`).

### Method
POST

### Endpoint
/guias

### Parameters
#### Request Body
- **carrier** (string) - Required - The selected shipping carrier.
- **service** (string) - Required - The selected shipping service (e.g., "Económica", "Express").
- **origin** (object) - Required - Details of the origin address.
  - **name** (string) - Required - Contact person's name.
  - **phone** (string) - Required - Contact person's phone number.
  - **email** (string) - Required - Contact person's email address.
  - **street** (string) - Required - Street name and number.
  - **colonia** (string) - Required - Colonia name.
  - **city** (string) - Required - City name.
  - **state** (string) - Required - State name.
  - **zip_code** (string) - Required - Postal code.
  - **rfc** (string) - Optional - RFC for insurance purposes.
- **destination** (object) - Required - Details of the destination address.
  - **name** (string) - Required - Contact person's name.
  - **phone** (string) - Required - Contact person's phone number.
  - **email** (string) - Required - Contact person's email address.
  - **street** (string) - Required - Street name and number.
  - **colonia** (string) - Required - Colonia name.
  - **city** (string) - Required - City name.
  - **state** (string) - Required - State name.
  - **zip_code** (string) - Required - Postal code.
  - **rfc** (string) - Optional - RFC for insurance purposes.
- **package** (object) - Required - Details of the package.
  - **weight** (number) - Required - Package weight.
  - **weight_unit** (string) - Required - Unit of weight (e.g., "kg").
  - **dimensions** (object) - Required - Package dimensions.
    - **length** (number) - Required.
    - **width** (number) - Required.
    - **height** (number) - Required.
    - **unit** (string) - Required - Unit of dimensions (e.g., "cm").
- **insurance** (object) - Optional - Insurance details.
  - **amount** (number) - Required if insurance is requested.
  - **beneficiary** (object) - Optional - Beneficiary details if different from sender/receiver.
    - **name** (string) - Required.
    - **rfc** (string) - Required.

### Request Example
```json
{
  "carrier": "PaquetExpress",
  "service": "Económica",
  "origin": {
    "name": "Juan Perez",
    "phone": "5512345678",
    "email": "juan.perez@example.com",
    "street": "Calle Falsa 123",
    "colonia": "Centro",
    "city": "Ciudad de México",
    "state": "Ciudad de México",
    "zip_code": "06000"
  },
  "destination": {
    "name": "Maria Garcia",
    "phone": "3398765432",
    "email": "maria.garcia@example.com",
    "street": "Avenida Siempre Viva 742",
    "colonia": "Providencia",
    "city": "Guadalajara",
    "state": "Jalisco",
    "zip_code": "44630"
  },
  "package": {
    "weight": 2,
    "weight_unit": "kg",
    "dimensions": {
      "length": 20,
      "width": 15,
      "height": 10,
      "unit": "cm"
    }
  },
  "insurance": {
    "amount": 1000
  }
}
```

### Response
#### Success Response (200)
- **guide_number** (string) - The generated guide number.
- **tracking_number** (string) - The tracking number for the shipment.
- **policy_number** (string) - The policy number if insurance was requested.
- **total_price** (number) - The total cost of the shipment.
- **currency** (string) - The currency of the total price.

#### Response Example
```json
{
  "guide_number": "1234567890",
  "tracking_number": "ABC123XYZ",
  "policy_number": "POL987654",
  "total_price": 250.00,
  "currency": "MXN"
}
```
```

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

### Listar bienes asegurables (Swift)

Source: https://enviosperrosv3.docs.apiary.io/reference/endpoints/seguros/listar-bienes-asegurables

Swift code for making a network request to list insurable commodities. This example uses URLSession to send a GET request with the required headers, including the authorization token.

```swift
import Foundation

let url = URL(string: "https://app.enviosperros.com/api/v3/insurance/commodities")!
var request = URLRequest(url: url)
request.httpMethod = "GET"

let token = "{token}"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let error = error {
        print("Error: \(error.localizedDescription)")
        return
    }
    
    if let httpResponse = response as? HTTPURLResponse {
        if (200...299).contains(httpResponse.statusCode) {
            if let data = data, let dataString = String(data: data, encoding: .utf8) {
                print(dataString)
            }
        } else {
            print("HTTP Error: \(httpResponse.statusCode)")
        }
    }
}

task.resume()
```
Tokens:
Raw