Version: current

Track Packages

About this guide

The lack of information is one of the main causes of making LATAM’s logistics inefficient for both merchants and customers. EBANX Track provides information by crossing payment data with logistics.

This guide gives you a quick overview of our package tracking API and the basics on how to use it.

EBANX Track

What you will need

Before starting your integration, please make sure that you have:

  1. An EBANX Sandbox account. That's not the case? Please sign up for an Sandbox Account here;

How it works

You have a few options with our API, depending on how much information you have about your package.

info

For a full description of this API, check our API Reference

  1. Sending a simple tracking number

    curl -X POST \
    https://sandbox.ebanxpay.com/ws/tracking \
    -H 'Content-Type: application/json' \
    -d '{
    "integration_key": "your_integration_key",
    "order_number": "ORDER123",
    "email": "customer@business.com",
    "tracking_code": ["LZ624515815CN"]
    }'
  2. Send the tracking number and more info about the items inside the package

    curl -X POST \
    https://sandbox.ebanxpay.com/ws/tracking \
    -H 'Content-Type: application/json' \
    -d '{
    "integration_key": "your_integration_key",
    "email": "customer@business.com",
    "order_number": "ORDER123",
    "tracking_code": [
    {
    "tracking_code": "RN1234567890BR",
    "items": [
    {
    "sku": "ITEM-SKU",
    "name": "Item name",
    "description": "A little bit more detailed item description",
    "unit_price": 13400,
    "quantity": 1,
    "type": "mobile-phone"
    }
    ]
    }
    ]
    }'
  3. Send the tracking number and complete information including address

    curl -X POST \
    https://sandbox.ebanxpay.com/ws/tracking \
    -H 'Content-Type: application/json' \
    -d '{
    "integration_key": "your_integration_key",
    "email": "customer@business.com",
    "order_number": "ORDER123",
    "tracking_code": [
    "LZ624515815CN",
    {
    "tracking_code": "RN1234567890BR",
    "items": [
    {
    "sku": "ITEM-SKU",
    "name": "Item name",
    "description": "A little bit more detailed item description",
    "unit_price": 13400,
    "quantity": 1,
    "type": "mobile-phone"
    }
    ]
    },
    {
    "tracking_code": "RN0987654321BR",
    "address": {
    "zipcode": "80123456",
    "address": "Sample Street",
    "street_number": "123",
    "street_complement": "Address Complement",
    "city": "Curitiba",
    "state": "Paraná",
    "country": "BR"
    }
    }
    ],
    "email": "customer@ebanx.com",
    "order_number": "ORDER-123",
    "payment_hash": "PAYMENT_HASH_STRING"
    }'

A successful request will return a JSON expression similar to the one below.

{
"status": "SUCCESS",
"result": [
{
"customer_email": "customer@ebanx.com",
"tracking_code": "LZ624515815CN",
"order_number": "ORDER-123",
"status": "CREATED"
},
{
"customer_email": "customer@ebanx.com",
"tracking_code": "RN1234567890BR",
"order_number": "ORDER-123",
"status": "CREATED"
},
{
"customer_email": "customer@ebanx.com",
"tracking_code": "RN0987654321BR",
"order_number": "ORDER-123",
"status": "CREATED"
}
]
}

Getting help

We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:

  • If you’re not our partner yet and would like to know more about our prices and conditions please fill ou this form and our comercial team will get in touch with you.
  • In case you’re already our partner please get in touch with our support team at integration@ebanx.com.
Last updated on by Fernando Pankiewicz Gomes