Skydropx
menu

Skydropx API

Welcome to the skydropx API! You can use our API to access skydropx API endpoints, which can get information about Shipments and Labels, also create Cancel Label Requests.

You can view code examples in the dark area to the right.

Skydropx CHANGELOG

13/04/2022

  • Added order relationship attribute in 'Get all shipments' endpoint response.
  • Added order relationship attribute in 'Get a specific shipment' endpoint response.
  • Added order parameter (optional) in 'Create a shipment' endpoint.

28/04/2022

  • Added effectiveness and ranking attributes in 'Get all shipments' endpoint response.
  • Added effectiveness and ranking attributes in 'Get a specific shipment' endpoint response.
  • Added carriers parameter (optional) in 'Create a shipment' endpoint.
  • Added carriers parameter (optional) in 'Get a quotation' endpoint.

Authentication

Skydropx uses API keys to allow access to the API. You need to contact our support team to get your API key. [email protected]

Skydropx expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Token token=YOUR_API_KEY
To authorize, use this code:
cURL
  • 1
  • 2
  • 3
  • 4
  • # With shell, you can just pass the correct header with each request. \
  • curl "https://api.skydropx.com/v1/shipments" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"

Developer Testing

We recommend to use our demo environment before run your code in production.

  1. Firstly, you need to register in demo environment create account.
  2. Contact our support team to get your API key.

The URL for demo environment is:

https://api-demo.skydropx.com/

Carriers

Get a list of carriers

Returns the available carriers from the user account

HTTP Request

GET https://api.skydropx.com/v1/carriers
cURL
  • 1
  • 2
  • 3
  • curl "https://api.skydropx.com/v1/carriers" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "data": [
    {
      "id": "785f39d0-11f7-4fcf-871e-5dad6795bbb7",
      "type": "carrier",
      "attributes": {
        "name": "Fedex"
      }
    },
    {
      "id": "746c7235-7452-4a82-8ab7-5f3c36fc4680",
      "type": "carrier",
      "attributes": {
        "name": "DHL"
      }
    }
  ]
}

Quotations

Get a Quotation

This endpoint receives zip codes and parcel measures. It returns a list that contains all Rates found.

HTTP Request

POST https://api.skydropx.com/v1/quotations

Parameters

  • zip_fromString

    Zip code of origin.

  • zip_toString

    Zip code of destination.

  • parcelObject

    Used to specify the measures and total Parcel weight.

  • weightInteger

    Weight of Parcel, must be in KG.

  • heightInteger

    Height of Parcel, must be in CM.

  • widthInteger

    Width of Parcel, must be in CM.

  • lengthInteger

    Length of Parcel, must be in CM.

  • carriersArray (optional)

    Quote with specific carriers

Description

The field amount_local is used to indicate the price of the service. Depending on the zip code, they may have extra charges.

Out of area means that zone is not covered for normal delivery and generates extra charges.

out_of_area_service is used to indicate if the service is out of the area for normal delivery and if it's true.

out_of_area_pricing have the pricing for this extra service.

total_pricing have the sum of amount_local and out_of_area_pricing.

days Estimated time of arrival.

insurable means that the shipment could be insured declaring a cost. Not implemented yet in this API version.

is_ocurre is used to indicate if the shipment is to a home address or to a branch office.

cURL
  • 1
  • 2
  • 3
  • 4
  • curl "https://api.skydropx.com/v1/quotations" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json" \
  • -d '{ "zip_from": "02900", "zip_to": "44100", "parcel": { "weight": "1", "height": "10", "width": "10", "length": "10" }, "carriers": [{ "name": "DHL" }, { "name": "Fedex" }] }'
response
[
  {
    "amount_local": 540,
    "currency_local": "MXN",
    "provider": "UPS",
    "service_level_name": "UPS Express",
    "service_level_code": "EXPRESS_SAVER",
    "days": 2,
    "insurable": false,
    "out_of_area_service": false,
    "out_of_area_pricing": 0,
    "total_pricing": 540,
    "is_occure": true
  },
  {
    "amount_local": 681,
    "currency_local": "MXN",
    "provider": "ESTAFETA",
    "service_level_name": "Servicio Express",
    "service_level_code": "ESTAFETA_NEXT_DAY",
    "days": 2,
    "insurable": true,
    "out_of_area_service": true,
    "out_of_area_pricing": 100,
    "total_pricing": 781,
    "is_occure": true
  }
]

Shipments

Get All Shipments

This endpoint retrieves all Shipments.

HTTP Request

GET https://api.skydropx.com/v1/shipments

Query Parameters

  • pageInteger, default is 1

    Number of page.

  • per_pageInteger, default is 20

    Quantity of records per page.

cURL
  • 1
  • 2
  • 3
  • curl "https://api.skydropx.com/v1/shipments" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "data": [
    {
      "id": "902675",
      "type": "shipments",
      "attributes": {
        "status": "WAITING",
        "created_at": "2018-12-18T15:00:21.892-06:00",
        "updated_at": "2018-12-18T15:00:21.892-06:00"
      },
      "relationships": {
        "parcel": {
          "data": {
            "id": "773773",
            "type": "parcels"
          }
        },
        "rates": {
          "data": [
            {
              "id": "7146458",
              "type": "rates"
            },
            {
              "id": "7146457",
              "type": "rates"
            },
            {
              "id": "7146456",
              "type": "rates"
            },
            {
              "id": "7146455",
              "type": "rates"
            },
            {
              "id": "7146454",
              "type": "rates"
            }
          ]
        },
        "address_to": {
          "data": {
            "id": "2901622",
            "type": "addresses"
          }
        },
        "address_from": {
          "data": {
            "id": "2901621",
            "type": "addresses"
          }
        },
        "label": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "773773",
      "type": "parcels",
      "attributes": {
        "length": "10.0",
        "height": "10.0",
        "width": "10.0",
        "weight": "3.0",
        "mass_unit": "KG",
        "distance_unit": "CM"
      }
    },
    {
      "id": "7146458",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.418-06:00",
        "updated_at": "2018-12-18T15:00:22.418-06:00",
        "amount_local": "119.0",
        "currency_local": "MXN",
        "provider": "CARSSA",
        "service_level_name": "Nacional",
        "service_level_code": "NACIONAL",
        "service_level_terms": null,
        "days": 5,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": false,
        "out_of_area_pricing": "0.0",
        "total_pricing": "119.0",
        "is_occure": true
      }
    },
    {
      "id": "7146457",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.389-06:00",
        "updated_at": "2018-12-18T15:00:22.389-06:00",
        "amount_local": "204.0",
        "currency_local": "MXN",
        "provider": "DHL",
        "service_level_name": "DHL Express",
        "service_level_code": "EXPRESS",
        "service_level_terms": null,
        "days": 2,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "349.0",
        "is_occure": true
      }
    },
    {
      "id": "7146456",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.380-06:00",
        "updated_at": "2018-12-18T15:00:22.380-06:00",
        "amount_local": "180.0",
        "currency_local": "MXN",
        "provider": "DHL",
        "service_level_name": "DHL Terrestre",
        "service_level_code": "STANDARD",
        "service_level_terms": null,
        "days": 5,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "325.0",
        "is_occure": true
      }
    },
    {
      "id": "7146455",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.150-06:00",
        "updated_at": "2018-12-18T15:00:22.150-06:00",
        "amount_local": "205.0",
        "currency_local": "MXN",
        "provider": "FEDEX",
        "service_level_name": "Standard Overnight",
        "service_level_code": "STANDARD_OVERNIGHT",
        "service_level_terms": null,
        "days": 2,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "350.0",
        "is_occure": true
      }
    },
    {
      "id": "7146454",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.141-06:00",
        "updated_at": "2018-12-18T15:00:22.141-06:00",
        "amount_local": "149.0",
        "currency_local": "MXN",
        "provider": "FEDEX",
        "service_level_name": "Fedex Express Saver",
        "service_level_code": "FEDEX_EXPRESS_SAVER",
        "service_level_terms": null,
        "days": 5,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "294.0",
        "is_occure": true
      }
    },
    {
      "id": "2901622",
      "type": "addresses",
      "attributes": {
        "name": "Jorge Fernández",
        "company": "-",
        "address1": "Av. Lázaro Cárdenas #234",
        "address2": "Americana",
        "city": "Guadalajara",
        "province": "Jalisco",
        "zip": "23312",
        "country": "MX",
        "phone": "5555555555",
        "email": "[email protected]",
        "created_at": "2018-12-18T15:00:21.887-06:00",
        "updated_at": "2018-12-18T15:00:21.887-06:00"
      }
    },
    {
      "id": "2901621",
      "type": "addresses",
      "attributes": {
        "name": "Jose Fernando",
        "company": "skydropx",
        "address1": "Av. Principal #234",
        "address2": "Centro",
        "city": "Guadalajara",
        "province": "Jalisco",
        "zip": "02900",
        "country": "MX",
        "phone": "5555555555",
        "email": "[email protected]",
        "created_at": "2018-12-18T15:00:21.874-06:00",
        "updated_at": "2018-12-18T15:00:21.874-06:00"
      }
    }
  ],
  "links": {
    "self": "https://api.skydropx.com/v1/shipments?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "https://api.skydropx.com/v1/shipments?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": null,
    "last": "https://api.skydropx.com/v1/shipments?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

Get a Specific Shipment

This endpoint retrieves a specific Shipment.

HTTP Request

GET https://api.skydropx.com/v1/shipments/ID

URL Parameters

  • IDInteger

    The ID of the Shipment to retrieve.

cURL
  • 1
  • 2
  • 3
  • curl "GET https://api.skydropx.com/v1/shipments/<ID>" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "data": {
    "id": "902675",
    "type": "shipments",
    "attributes": {
      "status": "WAITING",
      "created_at": "2018-12-18T15:00:21.892-06:00",
      "updated_at": "2018-12-18T15:00:21.892-06:00"
    },
    "relationships": {
      "parcel": {
        "data": {
          "id": "773773",
          "type": "parcels"
        }
      },
      "rates": {
        "data": [
          {
            "id": "7146458",
            "type": "rates"
          },
          {
            "id": "7146457",
            "type": "rates"
          },
          {
            "id": "7146456",
            "type": "rates"
          },
          {
            "id": "7146455",
            "type": "rates"
          },
          {
            "id": "7146454",
            "type": "rates"
          }
        ]
      },
      "address_to": {
        "data": {
          "id": "2901622",
          "type": "addresses"
        }
      },
      "address_from": {
        "data": {
          "id": "2901621",
          "type": "addresses"
        }
      },
      "label": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "773773",
      "type": "parcels",
      "attributes": {
        "length": "10.0",
        "height": "10.0",
        "width": "10.0",
        "weight": "3.0",
        "mass_unit": "KG",
        "distance_unit": "CM"
      }
    },
    {
      "id": "7146458",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.418-06:00",
        "updated_at": "2018-12-18T15:00:22.418-06:00",
        "amount_local": "119.0",
        "currency_local": "MXN",
        "provider": "CARSSA",
        "service_level_name": "Nacional",
        "service_level_code": "NACIONAL",
        "service_level_terms": null,
        "days": 5,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": false,
        "out_of_area_pricing": "0.0",
        "total_pricing": "119.0",
        "is_occure": true
      }
    },
    {
      "id": "7146457",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.389-06:00",
        "updated_at": "2018-12-18T15:00:22.389-06:00",
        "amount_local": "204.0",
        "currency_local": "MXN",
        "provider": "DHL",
        "service_level_name": "DHL Express",
        "service_level_code": "EXPRESS",
        "service_level_terms": null,
        "days": 2,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "349.0",
        "is_occure": true
      }
    },
    {
      "id": "7146456",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.380-06:00",
        "updated_at": "2018-12-18T15:00:22.380-06:00",
        "amount_local": "180.0",
        "currency_local": "MXN",
        "provider": "DHL",
        "service_level_name": "DHL Terrestre",
        "service_level_code": "STANDARD",
        "service_level_terms": null,
        "days": 5,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "325.0",
        "is_occure": true
      }
    },
    {
      "id": "7146455",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.150-06:00",
        "updated_at": "2018-12-18T15:00:22.150-06:00",
        "amount_local": "205.0",
        "currency_local": "MXN",
        "provider": "FEDEX",
        "service_level_name": "Standard Overnight",
        "service_level_code": "STANDARD_OVERNIGHT",
        "service_level_terms": null,
        "days": 2,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "350.0",
        "is_occure": true
      }
    },
    {
      "id": "7146454",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.141-06:00",
        "updated_at": "2018-12-18T15:00:22.141-06:00",
        "amount_local": "149.0",
        "currency_local": "MXN",
        "provider": "FEDEX",
        "service_level_name": "Fedex Express Saver",
        "service_level_code": "FEDEX_EXPRESS_SAVER",
        "service_level_terms": null,
        "days": 5,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "294.0",
        "is_occure": true
      }
    },
    {
      "id": "2901622",
      "type": "addresses",
      "attributes": {
        "name": "Jorge Fernández",
        "company": "-",
        "address1": "Av. Lázaro Cárdenas #234",
        "address2": "Americana",
        "city": "Guadalajara",
        "province": "Jalisco",
        "zip": "23312",
        "country": "MX",
        "phone": "5555555555",
        "email": "[email protected]",
        "created_at": "2018-12-18T15:00:21.887-06:00",
        "updated_at": "2018-12-18T15:00:21.887-06:00"
      }
    },
    {
      "id": "2901621",
      "type": "addresses",
      "attributes": {
        "name": "Jose Fernando",
        "company": "skydropx",
        "address1": "Av. Principal #234",
        "address2": "Centro",
        "city": "Guadalajara",
        "province": "Jalisco",
        "zip": "02900",
        "country": "MX",
        "phone": "5555555555",
        "email": "[email protected]",
        "created_at": "2018-12-18T15:00:21.874-06:00",
        "updated_at": "2018-12-18T15:00:21.874-06:00"
      }
    }
  ]
}

Create a Shipment

This endpoint creates a Shipment.

HTTP Request

POST https://api.skydropx.com/v1/shipments

Description

The field contents under address_to object is used to indicate the description of package contents.

cURL
  • 1
  • 2
  • 3
  • 4
  • curl "https://api.skydropx.com/v1/shipments" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json" \
  • -d '{ "address_from": {"province": "Ciudad de México", "city": "Azcapotzalco", "name": "Jose Fernando", "zip": "02900", "country": "MX", "address1": "Av. Principal #234", "company": "skydropx", "address2": "Centro", "phone": "5555555555", "email": "[email protected]"}, "parcels": [{ "weight": 3, "distance_unit": "CM", "mass_unit": "KG", "height": 10, "width": 10, "length": 10 }], "address_to": { "province": "Jalisco", "city": "Guadalajara", "name": "Jorge Fernández", "zip": "44100", "country": "MX",  "address1": " Av. Lázaro Cárdenas #234", "company": "-", "address2": "Americana", "phone": "5555555555", "email": "[email protected]", "reference": "Frente a tienda de abarro", "contents": "" }, "consignment_note_class_code": "53131600", "consignment_note_packaging_code": "1H1", "carriers": [{ "name": "DHL" }, { "name": "Fedex" }] }'
response
{
  "data": {
    "id": "902675",
    "type": "shipments",
    "attributes": {
      "status": "WAITING",
      "created_at": "2018-12-18T15:00:21.892-06:00",
      "updated_at": "2018-12-18T15:00:21.892-06:00"
    },
    "relationships": {
      "parcel": {
        "data": {
          "id": "773773",
          "type": "parcels"
        }
      },
      "rates": {
        "data": [
          {
            "id": "7146454",
            "type": "rates"
          },
          {
            "id": "7146455",
            "type": "rates"
          },
          {
            "id": "7146456",
            "type": "rates"
          },
          {
            "id": "7146457",
            "type": "rates"
          },
          {
            "id": "7146458",
            "type": "rates"
          }
        ]
      },
      "address_to": {
        "data": {
          "id": "2901622",
          "type": "addresses"
        }
      },
      "address_from": {
        "data": {
          "id": "2901621",
          "type": "addresses"
        }
      },
      "label": {
        "data": null
      },
      "consignment_note_class": {
        "data": {
          "id": 641,
          "name": "Papel de imprenta y papel de escribir",
          "code": "14111500",
          "subcategory_id": 50,
          "created_at": "2021-12-02T07:10:55.072-06:00",
          "updated_at": "2021-12-02T07:10:55.072-06:00"
        }
      },
      "consignment_note_packaging": {
        "data": {
          "id": 27,
          "code": "Z01",
          "name": "No aplica",
          "created_at": "2022-02-03T12:28:03.388-06:00",
          "updated_at": "2022-02-03T12:28:03.388-06:00"
        }
      }
    }
  },
  "included": [
    {
      "id": "773773",
      "type": "parcels",
      "attributes": {
        "length": "10.0",
        "height": "10.0",
        "width": "10.0",
        "weight": "3.0",
        "mass_unit": "KG",
        "distance_unit": "CM"
      }
    },
    {
      "id": "7146454",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.141-06:00",
        "updated_at": "2018-12-18T15:00:22.141-06:00",
        "amount_local": "149.0",
        "currency_local": "MXN",
        "provider": "FEDEX",
        "service_level_name": "Fedex Express Saver",
        "service_level_code": "FEDEX_EXPRESS_SAVER",
        "service_level_terms": null,
        "days": 5,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "294.0",
        "is_occure": true
      }
    },
    {
      "id": "7146455",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.150-06:00",
        "updated_at": "2018-12-18T15:00:22.150-06:00",
        "amount_local": "205.0",
        "currency_local": "MXN",
        "provider": "FEDEX",
        "service_level_name": "Standard Overnight",
        "service_level_code": "STANDARD_OVERNIGHT",
        "service_level_terms": null,
        "days": 2,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "350.0",
        "is_occure": true
      }
    },
    {
      "id": "7146456",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.380-06:00",
        "updated_at": "2018-12-18T15:00:22.380-06:00",
        "amount_local": "180.0",
        "currency_local": "MXN",
        "provider": "DHL",
        "service_level_name": "DHL Terrestre",
        "service_level_code": "STANDARD",
        "service_level_terms": null,
        "days": 5,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "325.0",
        "is_occure": true
      }
    },
    {
      "id": "7146457",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.389-06:00",
        "updated_at": "2018-12-18T15:00:22.389-06:00",
        "amount_local": "204.0",
        "currency_local": "MXN",
        "provider": "DHL",
        "service_level_name": "DHL Express",
        "service_level_code": "EXPRESS",
        "service_level_terms": null,
        "days": 2,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": true,
        "out_of_area_pricing": "145.00",
        "total_pricing": "349.0",
        "is_occure": true
      }
    },
    {
      "id": "7146458",
      "type": "rates",
      "attributes": {
        "created_at": "2018-12-18T15:00:22.418-06:00",
        "updated_at": "2018-12-18T15:00:22.418-06:00",
        "amount_local": "119.0",
        "currency_local": "MXN",
        "provider": "CARSSA",
        "service_level_name": "Nacional",
        "service_level_code": "NACIONAL",
        "service_level_terms": null,
        "days": 5,
        "duration_terms": null,
        "zone": null,
        "arrives_by": null,
        "out_of_area": false,
        "out_of_area_pricing": "0.0",
        "total_pricing": "119.0",
        "is_occure": true
      }
    },
    {
      "id": "2901622",
      "type": "addresses",
      "attributes": {
        "name": "Jorge Fernández",
        "company": "-",
        "address1": "Av. Lázaro Cárdenas #234",
        "address2": "Americana",
        "city": "Guadalajara",
        "province": "Jalisco",
        "zip": "23312",
        "country": "MX",
        "phone": "5555555555",
        "email": "[email protected]",
        "created_at": "2018-12-18T15:00:21.887-06:00",
        "updated_at": "2018-12-18T15:00:21.887-06:00"
      }
    },
    {
      "id": "2901621",
      "type": "addresses",
      "attributes": {
        "name": "Jose Fernando",
        "company": "skydropx",
        "address1": "Av. Principal #234",
        "address2": "Centro",
        "city": "Guadalajara",
        "province": "Jalisco",
        "zip": "02900",
        "country": "MX",
        "phone": "5555555555",
        "email": "[email protected]",
        "created_at": "2018-12-18T15:00:21.874-06:00",
        "updated_at": "2018-12-18T15:00:21.874-06:00"
      }
    }
  ]
}

Labels

Get all labels

This endpoint retrieves all Labels.

HTTP Request

GET https://api.skydropx.com/v1/labels

Query Parameters

  • pageInteger, default is 1

    Number of page.

  • per_pageInteger, default is 20

    Quantity of records per page.

cURL
  • 1
  • 2
  • 3
  • curl "https://api.skydropx.com/v1/labels" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "data": [
    {
      "id": "39",
      "type": "labels",
      "attributes": {
        "created_at": "2018-07-26T00:18:56.665-05:00",
        "updated_at": "2018-07-26T00:18:56.665-05:00",
        "status": null,
        "tracking_number": "XXXXXXXXXX",
        "tracking_status": null,
        "label_url": "label-url.pdf",
        "tracking_url_provider": "http://www.estafeta.com/Rastreo/XXXXXXXXXX",
        "rate_id": 3087
      }
    },
    {
      "id": "40",
      "type": "labels",
      "attributes": {
        "created_at": "2018-07-26T00:18:57.326-05:00",
        "updated_at": "2018-07-26T00:18:57.326-05:00",
        "status": null,
        "tracking_number": "XXXXXXXXXX",
        "tracking_status": null,
        "label_url": "label-url.pdf",
        "tracking_url_provider": "http://www.estafeta.com/Rastreo/XXXXXXXXXX",
        "rate_id": 3089
      }
    }
  ],
  "links": {
    "self": "https://api.skydropx.com/v1/labels?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "first": "https://api.skydropx.com/v1/labels?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "prev": null,
    "next": "https://api.skydropx.com/v1/labels?page%5Bnumber%5D=2&page%5Bsize%5D=20",
    "last": "https://api.skydropx.com/v1/labels?page%5Bnumber%5D=13&page%5Bsize%5D=20"
  }
}

Get a Specific Label

This endpoint retrieves a specific Label.

HTTP Request

GET https://api.skydropx.com/v1/labels/ID

URL Parameters

  • ID

    The ID of the Label to retrieve.

cURL
  • 1
  • 2
  • 3
  • curl "GET https://api.skydropx.com/v1/labels/<ID>" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "data": {
    "id": "2",
    "type": "labels",
    "attributes": {
      "created_at": "2018-07-18T16:05:05.370-05:00",
      "updated_at": "2018-07-18T16:05:05.370-05:00",
      "status": null,
      "tracking_number": "XXXXXXXXXX",
      "tracking_status": null,
      "label_url": "label-url.pdf",
      "tracking_url_provider": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=XXXXXXXXXX",
      "rate_id": 3
    }
  }
}

Create a label

This endpoint creates a Label.

HTTP Request

POST https://api.skydropx.com/v1/labels
cURL
  • 1
  • 2
  • 3
  • 4
  • curl "https://api.skydropx.com/v1/labels" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json" \
  • -d '{ "rate_id": 10834, "label_format": "pdf" }'
response
{
  "data": {
    "id": "414",
    "type": "labels",
    "attributes": {
      "created_at": "2018-09-04T16:32:49.190-05:00",
      "updated_at": "2018-09-04T16:32:49.190-05:00",
      "status": null,
      "tracking_number": "XXXXXXXXXX",
      "tracking_status": null,
      "label_url": "label-url.pdf",
      "tracking_url_provider": "https://www.grupocarssa.com/new/XXXXXXXXXX",
      "rate_id": 11931
    }
  }
}

Cancel Label Request

Create a Cancel Label Request

This endpoint creates a Cancel Label Request.

HTTP Request

POST https://api.skydropx.com/v1/cancel_label_requests
Example of create a Cancel Label Request:
cURL
  • 1
  • 2
  • 3
  • 4
  • curl "https://api.skydropx.com/v1/cancel_label_requests" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json" \
  • -d '{ "tracking_number": XXXXXXXXXX, "reason": "Datos de dirección erróneos." }'
response
{
  "data": {
    "id": "18",
    "type": "cancel_requests",
    "attributes": {
      "status": "reviewing",
      "reason": "Datos de dirección erróneos.",
      "created_at": "2018-09-05T09:24:35.453-05:00",
      "updated_at": "2018-09-05T09:24:35.453-05:00"
    }
  }
}

Get All Cancel Label Request

This endpoint retrieves all Cancel Label Requests.

HTTP Request

GET https://api.skydropx.com/v1/cancel_label_requests

Query Parameters

  • statusString

    Status status="reviewing|rejected|approved".

  • dateString

    Date date="2020-11-13".

cURL
  • 1
  • 2
  • 3
  • curl "https://api.skydropx.com/v1/cancel_request?status=reviewing|rejected" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "data": {
    "cancel_requests_pending": 2,
    "cancel_requests": [
      {
        "id": 21,
        "status": "rejected",
        "reason": "Paquetería o servicio erróneo.",
        "messages": "no valido",
        "shipment_id": 235,
        "created_at": "2020-11-13T12:38:34.412-06:00",
        "updated_at": "2020-11-13T17:10:12.673-06:00",
        "user_id": 1,
        "headquarter_id": 1
      },
      {
        "id": 20,
        "status": "reviewing",
        "reason": "Datos de dirección erróneos.",
        "messages": null,
        "shipment_id": 236,
        "created_at": "2020-11-13T12:38:28.113-06:00",
        "updated_at": "2020-11-13T12:38:28.113-06:00",
        "user_id": 1,
        "headquarter_id": 1
      }
    ]
  }
}

Bulk Labels

This endpoint sends by email the specified labels in a single pdf file.

HTTP Request

GET https://api.skydropx.com/v1/bulk_labels

URL Parameters

  • emailsString

    Recipient emails separated by commas

  • label_idsString

    Labels identifiers separated by commas

cURL
  • 1
  • 2
  • 3

Consignment Note Categories

Index of categories of products established by SAT and demanded for the consignment note

HTTP Request

GET https://api.skydropx.com/v1/consignment_notes/categories
cURL
  • 1
  • 2
  • 3
  • curl "https://api.skydropx.com/v1/consignment_notes/categories" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "data": [
    {
      "id": "1",
      "type": "category",
      "attributes": {
        "name": "Material Vivo Vegetal y Animal, Accesorios y Suministros"
      }
    },
    {
      "id": "2",
      "type": "category",
      "attributes": {
        "name": "Material Químico incluyendo Bioquímicos y Materiales de Gas"
      }
    },
    {
      "id": "3",
      "type": "category",
      "attributes": {
        "name": "Material Mineral, Textil y Vegetal y Animal No Comestible"
      }
    },
    {
      "id": "4",
      "type": "category",
      "attributes": {
        "name": "Materiales de Resina, Colofonia, Caucho, Espuma, Película y Elastómericos"
      }
    },
    {
      "id": "5",
      "type": "category",
      "attributes": {
        "name": "Materiales y Productos de Papel"
      }
    }
  ]
}

Consignment Note Subcategories

Index of subcategories of products established by SAT and demanded for the consignment note filter by Category

HTTP Request

GET https://api.skydropx.com/v1/consignment_notes/categories/CATEGORY_ID/subcategories
cURL
  • 1
  • 2
  • 3
  • curl "https://api.skydropx.com/v1/consignment_notes/categories/<CATEGORY_ID>/subcategories" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "data": [
    {
      "id": "49",
      "type": "subcategory",
      "attributes": {
        "name": "Materiales de papel"
      }
    },
    {
      "id": "50",
      "type": "subcategory",
      "attributes": {
        "name": "Productos de papel"
      }
    },
    {
      "id": "51",
      "type": "subcategory",
      "attributes": {
        "name": "Papel para uso industrial"
      }
    }
  ]
}

Consignment Note Classes

Index of classes of products established by SAT and demanded for the consignment note filter by Subcategory. The code attribute is needed to create a shipment.

HTTP Request

GET https://api.skydropx.com/v1/consignment_notes/subcategories/SUBCATEGORY_ID/classes
cURL
  • 1
  • 2
  • 3
  • curl "https://api.skydropx.com/v1/consignment_notes/subcategories/<SUBCATEGORY_ID>/classes" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "data": [
    {
      "id": "641",
      "type": "class",
      "attributes": {
        "name": "Papel de imprenta y papel de escribir",
        "code": "14111500"
      }
    },
    {
      "id": "642",
      "type": "class",
      "attributes": {
        "name": "Papel fantasía",
        "code": "14111600"
      }
    },
    {
      "id": "643",
      "type": "class",
      "attributes": {
        "name": "Productos de papel para uso personal",
        "code": "14111700"
      }
    },
    {
      "id": "644",
      "type": "class",
      "attributes": {
        "name": "Papeles de uso comercial",
        "code": "14111800"
      }
    }
  ]
}

Consignment Note Packagings

Index of packagings established by SAT and demanded for the consignment note. The code attribute is needed to create a shipment.

HTTP Request

GET https://api.skydropx.com/v1/consignment_notes/packagings
cURL
  • 1
  • 2
  • 3
  • curl "https://api.skydropx.com/v1/consignment_notes/packagings" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"
response
[
  {
    "id": "1",
    "type": "packagings",
    "attributes": {
      "name": "Bidones (Tambores) de Plástico de tapa no desmontable",
      "code": "1H1"
    }
  },
  {
    "id": "2",
    "type": "packagings",
    "attributes": {
      "name": "Bidones (Tambores) de Plástico de tapa desmontable",
      "code": "1H2"
    }
  },
  {
    "id": "3",
    "type": "packagings",
    "attributes": {
      "name": "Cajas de Aluminio",
      "code": "4B"
    }
  }
]

Errors

The skydropx API uses the following error codes:

  • 400Bad Request

    Your request is invalid.

  • 401Unauthorized

    Your API key is wrong.

  • 404Not Found

    The specified resource could not be found.

  • 500Internal Server Error

    We had a problem with our server. Try again later.

Radar API

Welcome to the radar API! You can use our API to access radar API endpoints, which can get information about Shipments, also tracking shipments. You can view code examples in the dark area to the right.

Radar CHANGELOG

06/04/2022

  • Added reference_number parameter (optional) in 'Get all shipments' endpoint.
  • Added reference_number attribute in 'Get all shipments' endpoint response.
  • Added reference_number attribute in 'Get a specific shipment' endpoint response.
  • Added reference_number parameter (optional) in 'Create a shipment' endpoint.

Radar Authentication

Radar uses API keys to allow access to the API. You need to contact our support team to get your API key. [email protected]

Skydropx expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Token token=YOUR_RADAR_API_KEY
To authorize, use this code:
cURL
  • 1
  • 2
  • 3
  • 4
  • # With shell, you can just pass the correct header with each request. \
  • curl "https://radar-api.skydropx.com/v1/shipments" \
  • -H "Authorization: Token token=YOUR_API_KEY" \
  • -H "Content-Type: application/json"

Radar Shipments

Radar Get all shipments

This endpoint retrieves all Shipments.

HTTP Request

GET https://radar-api.skydropx.com/v1/shipments

Query Parameters

  • pageInteger, default is 1

    Number of page.

  • per_pageInteger, default is 25

    Quantity of records per page.

  • statusString

    CREATED The shipment is created, but have not yet been picked up by carrier.

    PICKED_UP The shipment is out for delivery.

    IN_TRANSIT The shipment is out for delivery.

    LAST_MILE The shipment is out for delivery.

    DELIVERED The shipment was delivered successfully.

    EXCEPTION The shipment has any exception, it is likely presents some inconveniences such as returned or not delivered.

  • orderString, default is descending

    ascending Order shipments by created_at.

cURL
  • 1
  • 2
  • 3
  • curl "https://radar-api.skydropx.com/v1/shipments" \
  • -H "Authorization: Token token=YOUR_RADAR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "shipments": [
    {
      "id": "GXZahxtx2Pyu3Zs111111BBr",
      "type": "Shipment",
      "tracking_number": "1234",
      "processed": true,
      "status": "IN_TRANSIT",
      "carrier": "FEDEX",
      "carrier_service": "FEDEX_EXPRESS_SERVICE",
      "tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234",
      "addresses": {
        "address_from": {
          "name": "SKYDROPX",
          "street1": "Padre Raymundo Jardon 925",
          "street2": "Centro",
          "zipcode": "64000",
          "city": "Monterrey",
          "province": "NL",
          "country": "MX",
          "phone": "+525555555555",
          "email": "[email protected]"
        },
        "address_to": {
          "name": "SKYDROPX",
          "street1": "Padre Raymundo Jardon 925",
          "street2": "Centro",
          "zipcode": "64000",
          "city": "Monterrey",
          "province": "NL",
          "country": "MX",
          "phone": "+525555555555",
          "email": "[email protected]"
        }
      },
      "created_at": "2020-03-11T16:49:23-06:00"
    },
    {
      "id": "GXZahxtx2Pyu3Zs111111BBr",
      "type": "Shipment",
      "tracking_number": "4321",
      "processed": true,
      "status": "IN_TRANSIT",
      "carrier": "FEDEX",
      "carrier_service": "FEDEX_EXPRESS_SERVICE",
      "tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=4321",
      "addresses": {
        "address_from": {
          "name": "SKYDROPX",
          "street1": "Padre Raymundo Jardon 925",
          "street2": "Centro",
          "zipcode": "64000",
          "city": "Monterrey",
          "province": "NL",
          "country": "MX",
          "phone": "+525555555555",
          "email": "[email protected]"
        },
        "address_to": {
          "name": "SKYDROPX",
          "street1": "Padre Raymundo Jardon 925",
          "street2": "Centro",
          "zipcode": "64000",
          "city": "Monterrey",
          "province": "NL",
          "country": "MX",
          "phone": "+525555555555",
          "email": "[email protected]"
        }
      },
      "created_at": "2020-03-11T16:49:23-06:00"
    }
  ],
  "meta": {
    "current_page": "1",
    "next_page": null,
    "prev_page": null,
    "total_count": "2",
    "total_pages": "1"
  }
}

Radar Get a specific Shipment

This endpoint retrieves a specific Shipment.

HTTP Request

GET https://radar-api.skydropx.com/v1/shipments/ID

URL Parameters

  • ID

    The ID of the Shipment to retrieve.

cURL
  • 1
  • 2
  • 3
  • curl "https://radar-api.skydropx.com/v1/shipments/<ID>" \
  • -H "Authorization: Token token=YOUR_RADAR_API_KEY" \
  • -H "Content-Type: application/json"
response
{
  "shipment": {
    "id": "GXZahxtx2Pyu3Zs111111BBr",
    "type": "Shipment",
    "tracking_number": "1234",
    "processed": true,
    "status": "IN_TRANSIT",
    "carrier": "FEDEX",
    "carrier_service": "FEDEX_EXPRESS_SERVICE",
    "tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234",
    "addresses": {
      "address_from": {
        "name": "SKYDROPX",
        "street1": "Padre Raymundo Jardon 925",
        "street2": "Centro",
        "zipcode": "64000",
        "city": "Monterrey",
        "province": "NL",
        "country": "MX",
        "phone": "+525555555555",
        "email": "[email protected]"
      },
      "address_to": {
        "name": "SKYDROPX",
        "street1": "Padre Raymundo Jardon 925",
        "street2": "Centro",
        "zipcode": "64000",
        "city": "Monterrey",
        "province": "NL",
        "country": "MX",
        "phone": "+525555555555",
        "email": "[email protected]"
      }
    },
    "created_at": "2020-03-11T16:49:23-06:00"
  }
}

Radar Create a Shipment

This endpoint records a shipment to be tracked on the Radar.

HTTP Request

POST https://radar-api.skydropx.com/v1/shipments

Parameters

  • carrierrequired

    Shipping carrier.

  • tracking_numberrequired

    Shipping tracking number.

  • carrier_service

    Shipping carrier service.

  • address_to[name]required

    Name of who will receive the shipment.

  • address_to[phone]required

    Mobile phone of who will receive the shipment.

  • address_to[email]required

    Email of who will receive the shipment.

  • address_to[street1]

    Delivery address.

  • address_to[street2]

    Delivery address.

  • address_to[zip_code]

    Delivery zip code.

  • address_to[city]

    Delivery city.

  • address_to[province]

    State of delivery.

  • address_to[county]

    Country of delivery.

  • address_from[street1]

    Shipping address.

  • address_from[street2]

    Shipping address.

  • address_from[zip_code]

    Shipping zip code.

  • address_from[city]

    Shipping city.

  • address_from[province]

    State of shipping.

  • address_from[county]

    Country of shipping.

cURL
  • 1
  • 2
  • 3
  • 4
  • curl "https://radar-api.skydropx.com/v1/shipments/<ID>" \
  • -H "Authorization: Token token=YOUR_RADAR_API_KEY" \
  • -H "Content-Type: application/json" \
  • -d '{ "shipment": { "carrier": "FEDEX", "tracking_number": "123456789", "carrier_service": "FEDEX_EXPRESS_SAVER", "address_to": { "name": "SKYDROPX", "street1": "Padre Raymundo Jardon 925", "street2": "Centro", "zipcode": "64000", "city": "Monterrey", "province": "Nuevo Leon", "country": "Mexico", "phone": "+525544383888", "email": "[email protected]" }, "address_from": { "province": "Jalisco", "city": "Guadalajara", "zip": "44100", "country": "MX", "street1": " Av. Lázaro Cárdenas #234", "street2": "Americana" }}}'
response
{
  "shipment": {
    "id": "GXZahxtx2Pyu3Zs111111BBr",
    "type": "Shipment",
    "tracking_number": "1234",
    "processed": true,
    "status": "IN_TRANSIT",
    "carrier": "FEDEX",
    "carrier_service": "FEDEX_EXPRESS_SERVICE",
    "tracking_url": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=1234",
    "addresses": {
      "address_from": {
        "name": "SKYDROPX",
        "street1": "Padre Raymundo Jardon 925",
        "street2": "Centro",
        "zipcode": "64000",
        "city": "Monterrey",
        "province": "NL",
        "country": "MX",
        "phone": "+525555555555",
        "email": "[email protected]"
      },
      "address_to": {
        "name": "SKYDROPX",
        "street1": "Padre Raymundo Jardon 925",
        "street2": "Centro",
        "zipcode": "64000",
        "city": "Monterrey",
        "province": "NL",
        "country": "MX",
        "phone": "+525555555555",
        "email": "[email protected]"
      }
    },
    "created_at": "2020-03-11T16:49:23-06:00"
  }
}

Radar Tracking Shipments

Sending correct shipments keys

This endpoint returns an tracking shipments.

HTTP Request

POST https://radar-api.skydropx.com/v1/tracking
cURL
  • 1
  • 2
  • 3
  • 4
  • curl "POST https://radar-api.skydropx.com/v1/tracking" \
  • -H "Authorization: Token token=YOUR_RADAR_API_KEY" \
  • -H "Content-Type: application/json" \
  • -d '{ "tracking_numbers": [{ "carrier": "DHL", "tracking_number": "11111111" }, { "carrier": "FEDEX", "tracking_number": "987654321" }]}'
response
{
  "data": {
    "type": "tracking",
    "trackings": [
      {
        "id": "GXZahxtx2Puu3ZsAAAAAABBr",
        "type": "Shipment",
        "tracking_number": "11111111",
        "processed": true,
        "status": "IN_TRANSIT",
        "events": [
          {
            "status": "PICKED_UP",
            "date": "2020-02-20T17:54:39-06:00",
            "description": "Package received after cutoff",
            "location": "Monterrey, NL"
          }
        ],
        "carrier": "DHL",
        "carrier_service": "EXPRESS_SERVICE",
        "created_at": "2020-03-11T16:49:23-06:00"
      },
      {
        "id": "GXZahxtx2Pyu3Zs111111BBr",
        "type": "Shipment",
        "tracking_number": "987654321",
        "processed": true,
        "status": "IN_TRANSIT",
        "events": [
          {
            "status": "PICKED_UP",
            "date": "2020-02-20T17:54:39-06:00",
            "description": "Package received after FedEx cutoff",
            "location": "Monterrey, NL"
          },
          {
            "status": "PICKED_UP",
            "date": "2020-03-09T17:55:00-06:00",
            "description": "EXPRESS",
            "location": "Mexico, DF"
          }
        ],
        "carrier": "FEDEX",
        "carrier_service": "FEDEX_EXPRESS_SERVICE",
        "created_at": "2020-03-11T16:49:23-06:00"
      }
    ]
  }
}

Sending wrong shipment keys

This endpoint returns an tracking shipments.

HTTP Request

POST https://radar-api.skydropx.com/v1/tracking
cURL
  • 1
  • 2
  • 3
  • 4
  • curl "POST https://radar-api.skydropx.com/v1/tracking" \
  • -H "Authorization: Token token=YOUR_RADAR_API_KEY" \
  • -H "Content-Type: application/json" \
  • -d '{ "tracking_numbers": [{ "carrier": "DHL", "tracking_number": "11111111" }, { "carrier": "FEDEX", "tracking_number": "987654321" }]}'
response
{
  "data": {
    "type": "tracking",
    "trackings": [
      {
        "carrier": "DHL",
        "tracking_number": null,
        "error": "Required key is missing"
      },
      {
        "id": "GXZahxtx2Pyu3Zs111111BBr",
        "type": "Shipment",
        "tracking_number": "987654321",
        "processed": true,
        "status": "IN_TRANSIT",
        "events": [
          {
            "status": "PICKED_UP",
            "date": "2020-02-20T17:54:39-06:00",
            "description": "Package received after FedEx cutoff",
            "location": "Monterrey, NL"
          }
        ],
        "carrier": "FEDEX",
        "carrier_service": "FEDEX_EXPRESS_SERVICE",
        "created_at": "2020-03-11T16:49:23-06:00"
      }
    ]
  }
}

Tracking errors

Exceeding tracking limit

You can track up to 10 shipments per request and multiples carriers in the same request. If tracking numbers limit is execeed, the response will be:

{ "error": "Tracking numbers limit exceeded" }

Sending wrong request

If the request body is not as expected by Radar Tracking API, the response will be:

{ "error": "Request error" }

Radar Webhook

Shipment status change notifications webhook

You need to implement an HTTP POST endpoint that receives a JSON body and responds an HTTP STATUS 200 (OK) or 201 (CREATED).

Request

This is a JSON body example:

{ "type": "shipment", "action": "SHIPMENT_UPDATED", "timestamp": "2022-03-25T16:00:00Z", "data": { "id": "s5QaVWkPNheS6rW4bW9d2gfV", "carrier": "REDPACK", "status": "DELIVERED", "tracking_number": "070634535" } }

Attributes

The timestamp attribute is in UTC with ISO 8601 format.

The id attribute (data) is the same that can be used in https://docs.skydropx.com/#radar-get-a-specific-shipment endpoint.

The possible values for the status attribute (data) are: CREATED PICKED_UP IN_TRANSIT LAST_MILE DELIVERY_ATTEMPT DELIVERED CANCELED EXCEPTION PENDING.