Português

English

Português

English

Appearance

On this page

Guia de Início Rápido ​

Bem-vindo à API da TriStar Express! Esta página irá guiá-lo pelos passos essenciais para começar a integrar e testar nossa plataforma. Siga os passos abaixo para configurar rapidamente seu ambiente de testes (necessário antes do uso efetivo no ambiente de produção), criar remessas e anexar documentos.

1. Criar uma Conta de Teste ​

Para acessar a API, você precisa primeiro criar uma conta de teste. Use o endpoint abaixo para se registrar e receber seu token de autenticação:

http
POST /v1/create-account HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: x-www-form-urlencoded
Accept: application/json

name=John Doe&email=john.doe%40example.com&password=123456

A resposta incluirá seu bearer_token. Guarde este token com segurança, pois ele é necessário para autenticar todas as requisições à API. E não se esqueça de sempre usar a palavra ‘Bearer’ antes do token.

json
{
    "id": 1,
    "bearer_token": "1|mRxEle6EDfp4mtS4LwSMvPZt8OdAMBxEMY3CTtMm"
}

Para mais detalhes, veja Criando Conta de Teste.

2. Criar uma Remessa ​

Com seu token, você pode agora criar uma remessa. Envie uma requisição POST para o endpoint /v1/shipments com os dados obrigatórios da remessa. Certifique-se de incluir seu token no cabeçalho Authorization:

http
POST /v1/shipments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer 1|mRxEle6EDfp4mtS4LwSMvPZt8OdAMBxEMY3CTtMm

{
    "integration_code": "1",
    "order_number": "1",
    "from_person_type": 1,
    "from_name": "Sender name",
    "from_document_type": 1,
    "from_document": "123456789",
    "from_country_code": "US",
    "from_postcode": "33013",
    "from_state_code": "FL",
    "from_address_1": "Av. Test",
    "from_address_number": "123",
    "from_city": "Miami",
    "from_email": "sender@example.com",
    "from_phone": "+1234567890",
    "to_person_type": 1,
    "to_name": "Jane Doe",
    "to_document_type": 1,
    "to_document": "07173967970",
    "to_address_1": "Avenida Presidente Kennedy",
    "to_address_number": "759",
    "to_city": "São Paulo",
    "to_country_code": "BR",
    "to_state_code": "SP",
    "to_postcode": "13334170",
    "to_email": "janedoe@example.com",
    "to_phone": "+5511999999999",
    "package_width": 12,
    "package_height": 14,
    "package_length": 13,
    "package_weight": 1.100,
    "package_freight": 0.01,
    "total": 100,
    "total_freight": 10,
    "total_tax": 5,
    "with_insurance": false,
    "items": [
        {
            "shipment_item_type": 10,
            "description": "PROTECTION FILM",
            "quantity": 1,
            "unit_price": 10
        }
    ]
}

A resposta retornará os detalhes da remessa, incluindo o id e o tracking_code. Esses identificadores são usados para operações futuras, como anexar documentos.

json
{
    "data": {
        "id": 1234,
        "order_number": "1",
        "integration_code": "1",
        "tracking_code": "TR000001234BR",
        "tracking_code_label": null,
        "to_usd_rate": null,
        "to_brl_rate": null,
        "created_by_id": 1,
        "updated_by_id": null,
        "created_at": "2025-06-23T15:38:40.000000Z",
        "updated_at": "2025-06-23T15:38:40.000000Z",
        "shipment_status": 1,
        "shipment_status_text": "Draft"
    }
}

Para mais detalhes, veja Criar Remessa. Se tiver dúvidas quanto ao preenchimento dos tipos de pessoas, documentos e/ou produtos, veja Tipos.

Observação: para os tipos de documento 30 (medicamento) e 40 (CBD), é obrigatório o preenchimento dos dados quanto à Anvisa, para os demais tipos, você pode deixar como ‘null’.

3. Anexar Documentos à Remessa ​

Você pode anexar documentos à sua remessa usando URLs públicas (JSON) ou enviando arquivos binários (multipart/form-data). O método deve ser o POST, o endpoint é o /v1/shipments/{identification}/attachments, e identificador pode ser o ID da remessa ou o tracking_code.

Anexar usando URLs (JSON) ​

http
POST /v1/shipments/{shipment_id}/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer 1|mRxEle6EDfp4mtS4LwSMvPZt8OdAMBxEMY3CTtMm

{
    "attachments": [
        {
            "url": "https://example.com/documents/invoice.pdf",
            "document_code": "DOCUMENT"
        }
    ]
}

Anexar usando Arquivos Binários (multipart/form-data) ​

Precisa criar duas chaves, uma que terá como valor o nome do documento e será do tipo Text, e a outra o arquivo em PDF, e deverá ser do tipo File.

http
POST /v1/shipments/{shipment_id}/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: multipart/form-data
Accept: application/json
Authorization: Bearer 1|mRxEle6EDfp4mtS4LwSMvPZt8OdAMBxEMY3CTtMm

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[0][file]"; filename="invoice.pdf"
Content-Type: application/pdf

(binary data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[0][document_code]"

DOCUMENT
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Para mais detalhes, veja Anexar Documentos à Remessa.

4. Remessas de Teste para Homologação ​

Para concluir o processo de homologação, você deve criar as seguintes remessas de teste:

  1. Remessa com 2 itens:

    • Item 1: USD 100,00
    • Item 2: USD 112,29

  2. Remessa com 3 itens de quantidades diferentes:

    • Item 1: 2 unidades de USD 100,00 cada
    • Item 2: 3 unidades de USD 110,10 cada
    • Item 3: 5 unidades de USD 120,20 cada

Após criar essas remessas, entre em contato com nosso time de TI pelo e-mail support@tristarexpress.com para confirmar sua integração e homologação.