Criar remessa
Para criar remessas você deve utilizar o método POST na rota /v1/shipments e enviar os paramêtros documentos a baixo no corpo da requisição.
Endpoint: /v1/shipments
Metodo: POST
http
POST /v1/shipments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
Authorization: {{ token }}
{ json }
Paramêtros do JSON
| Property | Required | Type | Description |
|---|---|---|---|
| integration_code | N | String | Seu código interno |
| from_person_type | Y | Integer | Tipo de pessoa do remetente: 1 para Pessoa Física (PF), 2 para Pessoa Jurídica (PJ) |
| from_name | Y | String | Nome completo do remetente ou nome fantasia da empresa remetente |
| from_document_type | N | Integer | Tipo de documento do remetente: 1 para CPF/CNPJ, 2 para Passaporte |
| from_document | N | String | Documento do remetente |
| from_trading_name | N | String | Nome fantasia da empresa remetente, obrigatório se o tipo de pessoa do remetente for 2 |
| from_br_ie | N | String | Inscrição Estadual da empresa remetente, obrigatória somente se a empresa possuir |
| from_address_1 | Y | String | Endereço do remetente - linha 1 |
| from_address_2 | N | String | Endereço do remetente - linha 2 |
| from_address_number | Y | String | Número do endereço do remetente |
| from_address_complement | N | String | Complemento do endereço do remetente |
| from_city | Y | String | Cidade do remetente |
| from_country_code | Y | String | Código do país do remetente (US ou USA), (BR ou BRA), (PT ou PRT), conforme ISO 3166 |
| from_state_code | Y | String | Código do estado (UF) do remetente |
| from_postcode | Y | String | CEP do remetente, somente números quando possível |
| from_email | Y | String | E-mail de contato do remetente |
| from_phone | Y | String | Telefone de contato do remetente |
| to_person_type | Y | Integer | Tipo de pessoa do destinatário: 1 para Pessoa Física (PF), 2 para Pessoa Jurídica (PJ) |
| to_name | Y | String | Nome completo do destinatário ou da empresa |
| to_document_type | Y | Integer | Tipo de documento do destinatário: 1 para CPF/CNPJ (TAX_ID), 2 para Passaporte (PASSPORT) |
| to_document | Y | String | CPF/CNPJ ou Passaporte do destinatário |
| to_responsible | N | String | Responsável Legal ou representante da empresa |
| to_trading_name | N | String | Nome fantasia da empresa destinatária, obrigatório se o tipo de pessoa do destinatário for 2 |
| to_br_ie | N | String | Inscrição Estadual da empresa destinatária, obrigatória somente se a empresa possuir |
| to_address_1 | Y | String | Endereço do destinatário - linha 1 |
| to_address_2 | N | Integer | Endereço do destinatário - linha 2 |
| to_address_number | Y | String | Número do endereço do destinatário |
| to_address_complement | N | String | Complemento do endereço do destinatário |
| to_city | Y | String | Cidade do destinatário |
| to_country_code | Y | Integer | Código do país do destinatário (US ou USA), (BR ou BRA), (PT ou PRT), conforme ISO 3166 |
| to_state_code | Y | String | Código do estado (UF) do destinatário |
| to_postcode | Y | String | CEP do destinatário, somente números quando possível |
| to_email | Y | String | E-mail de contato do destinatário |
| to_phone | Y | String | Destination contact phone |
| supervisory_organ | N | Integer | Consulte a Lista de Órgãos Anuentes |
| currency_id | N | Integer | ID da moeda, o padrão é USD (1) |
| width | Y | Integer | Largura do pacote em centímetros |
| height | Y | Integer | Altura do pacote em centímetros |
| length | Y | Integer | Comprimento do pacote em centímetros |
| weight | Y | Decimal (6.3) | Peso do pacote em quilogramas (utilize ponto "." como separador decimal) |
| freight | Y | Decimal(12.2) | Valor total do frete pago (utilize ponto "." como separador decimal) |
| total_insurance | Y | Decimal (6.3) | Valor total do seguro pago (utilize ponto "." como separador decimal) |
| prc_ii | N | Decimal (6.3) | Valor total do Imposto de Importação (II) pago no PRC (utilize ponto "." como separador decimal) |
| prc_icms | N | Decimal (6.3) | Valor total do ICMS pago no PRC (utilize ponto "." como separador decimal) |
| payment_cc | N | String | Últimos 4 dígitos do cartão de crédito |
| payment_cc_brand | N | String | Bandeira do cartão de crédito (Visa, Mastercard, etc.) |
| payment_cc_type | N | String | C para Crédito, D para Débito |
| anvisa_import_authorization_number | N | String | Número da autorização de importação da ANVISA (MEDICINE, CBD) |
| anvisa_product_commercial_name | N | String | Nome comercial do produto autorizado pela ANVISA (MEDICINE, CBD) |
| total | Y | Decimal(12.2) | Valor total declarado (utilize ponto "." como separador decimal) |
| discount | N | Decimal(12.2) | Valor total do desconto aplicado sobre o valor total (utilize ponto "." como separador decimal) |
| items | Y | Complex | Consulte os Tipos de Item da Remessa |
Shipment Item
| Property | Required | Type | Description |
|---|---|---|---|
| shipment_item_type | Y | Integer | 10 para Produtos, 20 para Livros, 30 para Medicamentos, 40 para CBD, 90 para Outros Imunes |
| sku | N | String | SKU do produto |
| hscode | N | String | Obrigatório para Medicamentos, CBD e THC |
| description | Y | String | Descrição do produto |
| quantity | Y | String | Quantidade |
| unit_price | Y | String | Preço unitário do produto |
| expiration_date | N | String | Data de validade |
| lot | N | String | Número do lote (para fulfillment) |
| immune_code | N | String | Obrigatório para shipment_item_type 90 (Outros Imunes). Obtenha a lista de códigos com a equipe da TriStar |
| currency_id | N | String | ID da moeda, o padrão é USD (1) |
Supervisory Organ
| Id | Description |
|---|---|
| 3 | Receita Federal do Brasil |
| 1 | Anvisa |
| 6 | Anvisa e Receita Federal do Brasil |
| 2 | Vigiagro / MAPA |
| 4 | Vigiagro / MAPA e Anvisa |
| 5 | Vigiagro / MAPA e Receita Federal do Brasil |
| 7 | Vigiagro / MAPA, Anvisa e Receita Federal do Brasil |
| 8 | Ibama |
| 9 | Ibama e Anvisa |
| 10 | Ibama e Vigiagro / MAPA |
| 11 | Ibama e Receita Federal do Brasil |
| 12 | Ibama, Vigiagro / MAPA e Anvisa |
| 13 | Ibama, Vigiagro / MAPA e Receita Federal do Brasil |
| 14 | Ibama, Anvisa e Receita Federal do Brasil |
| 15 | Ibama, Vigiagro / MAPA, Anvisa e Receita Federal do Brasil |
TIP
- Códigos de países seguem o padrão ISO 3166-1 alpha-2 and alpha-3 Wiki.
NCM - Mercosur Common Nomenclature.
- Tipos de documentos podem ser encontrados em Documents types
- Veja as referências para os códigos, CURRENCY_ID, PERSON_TYPE, SHIPMENT_ITEM_TYPE nesta página
Exemplo completo:
http
POST /v1/shipments/1/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
Authorization: {{ token }}
{
"integration_code": "1",
"order_number": "1",
"from_person_type" : 1,
"from_name": "Nome do Remetente",
"from_document_type": 1,
"from_country_code" : "US",
"from_postcode" : "33013",
"from_state_code" : "FL",
"from_address_1" : "Av. Test",
"from_address_2" : "",
"from_city" : "Miami",
"to_person_type": 1,
"to_name": "Jane Doe",
"to_document_type": 1,
"to_document": "07173967970",
"to_company_name": null,
"to_trading_name": null,
"to_br_ie": null,
"to_address_1": "Avenida Presidente Kennedy",
"to_address_2": "",
"to_address_number": "759",
"to_city": "São Paulo",
"to_country_code": "BR",
"to_state_code": "SP",
"to_postcode": "13334170",
"to_email": "janedoe@tristarexpress.com",
"to_phone": "+5511999999999",
"package_width": 12,
"package_height": 14,
"package_length": 13,
"package_weight": 1.100,
"freight": 0.01,
"insurance": 10,
"total": 100,
"anvisa_import_authorization_number":null,
"anvisa_product_commercial_name":null,
"with_insurance":false,
"items": [
{
"shipment_item_type": 40,
"hscode": "85177099",
"description": "PELICULA DE PROTECAO",
"quantity": 1,
"unit_price": 10,
"expiration_date":"2021-01-01",
"lot":"123456",
"immune_code": null,
"total": 10,
"is_book": false,
"currency_id": 1
}
]
}
TIP
- Tipos de documentos aceitos podem ser encotrados em Tipos de Documentos
Anexar documentos a uma remessa
http
POST /v1/shipments/{identitication}/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
{ json }
Exemplo completo enviando json com Urls:
http
POST /v1/shipments/1/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: application/json
Accept: application/json
{
"attachments" : [
{
"url" : "https://tristarexpress.com/wp-content/uploads/2022/07/AF_logotipo_tristar_EXPRESS_NEGATIVO.png",
"document_code" : "DOCUMENT"
},
{
"url" : "https://tristarexpress.com/wp-content/uploads/2022/07/AF_logotipo_tristar_EXPRESS_NEGATIVO.png",
"file_name" : "CPF.png",
"document_code" : "DOCUMENT"
}
]
}
Exemplo completo enviando arquivos binarios:
http
POST /v1/shipments/1/attachments HTTP/1.1
Host: sandbox.tristarexpress.com
Content-Type: multipart/form-data
Accept: application/json
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[0][file]"; filename="Arquivo.png"
Content-Type: <Content-Type header here>
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[0][document_code]"
DOCUMENT
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[1][document_code]"
DOCUMENT
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="attachments[1][file]"; filename="Arquvio2.png"
Content-Type: <Content-Type header here>
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW--