Consulta de CEP

GET /shipping/zipcode/consult/{countryCode}/{zipCode}

Consulta informações de endereço a partir de um CEP e país

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
countryCode	string	Sim	Código do país (3 caracteres, ex: BRA)
zipCode	string	Sim	CEP para consulta (ex: 01310-100)

Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": {
4    "zipCode": "01310-100",
5    "publicPlace": "Rua das flores 1234",
6    "complement": "lado ímpar",
7    "district": "Bela Vista",
8    "city": "São Paulo",
9    "stateCode": "BR-SP",
10    "latitude": -23.5614,
11    "longitude": -46.6559,
12    "countryName": "Brasil",
13    "countryCodeAlpha2": "BR",
14    "countryCodeAlpha3": "BRA",
15    "ddi": "55",
16    "currency": "BRL"
17  }
18}
{
  "status": true,
  "data": {
    "zipCode": "01310-100",
    "publicPlace": "Rua das flores 1234",
    "complement": "lado ímpar",
    "district": "Bela Vista",
    "city": "São Paulo",
    "stateCode": "BR-SP",
    "latitude": -23.5614,
    "longitude": -46.6559,
    "countryName": "Brasil",
    "countryCodeAlpha2": "BR",
    "countryCodeAlpha3": "BRA",
    "ddi": "55",
    "currency": "BRL"
  }
}

Cotação de Frete

GET /publics/products/quote

Calcula opções e valores de frete para uma lista de produtos com destino específico

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
tradePolicyId	integer	Não	ID da política comercial
targetZipCode	string	Sim	CEP de destino da entrega
targetCountryCode	string	Sim	Código do país de destino (3 caracteres)
items	array	Sim	Array de itens para cotação
items[].productId	integer	Sim	ID do produto
items[].quantity	integer	Sim	Quantidade do produto

Estrutura do Response

1{
2  "quoteGroups": [
3    {
4      "quoteId": "group-1-storage-1",
5      "error": null,
6      "tradePolicyId": 1,
7      "productStorageId": 1,
8      "distance": 15.5,
9      "originZipCode": "04567890",
10      "targetZipCode": "01310100",
11      "totalPrice": 2399.80,
12      "quantityItems": 2,
13      "totalCubicVolume": 8000,
14      "totalWeight": 1.2,
15      "service": false,
16      "cargoTypeCombination": [1, 2],
17      "additionalTimeGroup": 2,
18      "storage": {
19        "id": 1,
20        "name": "Armazém Central SP",
21        "zipCode": "04567-890"
22      },
23      "items": [
24        {
25          "productId": 1234,
26          "upsellId": null,
27          "productPairOfferId": null,
28          "name": "Smartphone TechBrand"
29          "sku":"ABC123",
30          "service": false,
31          "saleWithoutStock": false,
32          "quantity": 2,
33          "productPriceRuleId": 0,
34          "productPriceRuleName": "Original",
35          "value": 1299.90,
36          "code": null,
37          "product": {
38            "id": 1234,
39            "brandId": 1234,
40            "brandName": "TopPhone,
41            "mainCategoryId": 1,
42            "mainCategoryName": "smartphone",
43            "type": "product",
44            "name": "Smartphone XYZ Pro 128GB",
45            "sku": "SMPH001",
46            "url": "/smartphone-xyz-pro-128gb",
47            "comparisonPrice":2199.99,
48            "stock":20,
49            "medias":[
50              {
51                "id": 123,
52                "type": "image",
53                "title": "",
54                "alternativeText": null,
55                "file": "\/upload\/media\/produto-media.webp",
56                "originalFile": "\/upload\/media\/produto-media.png",
57                "size": null,
58                "originalSize": null,
59                "width": null,
60                "height": null,
61                "url": null
62              }
63            ],
64            "combination":[1, 2, 3],
65            "currentAttributes":[
66              {
67                "id":123,
68                "name":"cor",
69                "value":{
70                  "id":123,
71                  "label":"azul-escuro",
72                  "image":null,
73                  "originalImage":null,
74                  "color":"#00008B",
75                  "order":1
76                }
77              }
78            ],
79            "active": true
80          },
81					"productStorages": [
82            {
83              "productStorageId": 1234, 
84              "stock": 20,
85              "zipCode": "04567890",
86              "latitude": "-12983571225721985",
87              "longitude": "-12904872198572198",
88            }
89          ],
90          "volume": {
91            "height": 15.7,
92            "width": 7.8,
93            "length": 0.8,
94            "weight": 0.195
95          },
96          "category": {
97            "id": 123,
98            "name": "tecnologia/smartphones"
99          }
100          "cargoTypeId": 1,
101          "additionalTime": 1,
102          "cubicVolumeItem": 0.0196,
103          "totalCubicVolume": 0.0196,
104          "error": null
105        }
106      ],
107      "shippingOptions": [
108        {
109          "shippingTableId": 8,
110          "integrationCode": "",
111          "externalShippingCode": "",
112          "carrierId": 0,
113          "carrierName": "",
114          "label": "Retirar na loja",
115          "value": 0,
116          "beginShippingTime": 1,
117          "endShippingTime": 1,
118          "trackingUrl": null,
119          "row": {
120            "id": 1,
121            "initialZipcode": "10000000",
122            "finalZipcode": "99999999",
123            "initialWeight": 0,
124            "finalWeight": 10,
125            "initialPrice": 0,
126            "finalPrice": 100000,
127            "beginShippingTime": 1,
128            "endShippingTime": 1,
129            "shippingValue": 0,
130            "variables": []
131          },
132          "pickups": [
133            {
134              "id": 1,
135              "type": "inner",
136              "selected": false,
137              "name": "Retirada na loja TechBrand",
138              "address": "TechBrand street",
139              "number": "1234",
140              "district": "TechBrand",
141              "city": "São Paulo",
142              "countryCode": "BRA",
143              "stateCode": "BR-SP",
144              "zipCode": "12345-123",
145              "complement": "",
146              "latitude": "-22109580918509215",
147              "longitude": "-1023598021985029185",
148              "openingHours": "9 horas am"
149            }
150          ],
151          "error": null
152        }
153      ],
154      "additionalTimeGroup":0,
155      "storage": {
156        "id": 1234,
157        "code": "1",
158        "corporateName": "TechBrand",
159        "email": "suporte@techbrand.com.br",
160        "phone": "+55123451234",
161        "tradeName": "Armazém Principal",
162        "stateCode": "BR-SP",
163        "countryCode": "BRA",
164        "document": "12345678910",
165        "zipCode": "12345678",
166        "city": "Birigui",
167        "address": "Rua das flores 123",
168        "district": "Jardim das flores 1234",
169        "number": "1234",
170        "complement": "Ao lado da praça",
171        "latitude": "-12034598159523",
172        "longitude": "-12351298578213",
173        "active": true,
174        "observation": null,
175        "tradePolicyExceptions": [1, 2, 3]
176      }
177    }
178  ],
179  "errorItems": []
180}
{
  "quoteGroups": [
    {
      "quoteId": "group-1-storage-1",
      "error": null,
      "tradePolicyId": 1,
      "productStorageId": 1,
      "distance": 15.5,
      "originZipCode": "04567890",
      "targetZipCode": "01310100",
      "totalPrice": 2399.80,
      "quantityItems": 2,
      "totalCubicVolume": 8000,
      "totalWeight": 1.2,
      "service": false,
      "cargoTypeCombination": [1, 2],
      "additionalTimeGroup": 2,
      "storage": {
        "id": 1,
        "name": "Armazém Central SP",
        "zipCode": "04567-890"
      },
      "items": [
        {
          "productId": 1234,
          "upsellId": null,
          "productPairOfferId": null,
          "name": "Smartphone TechBrand"
          "sku":"ABC123",
          "service": false,
          "saleWithoutStock": false,
          "quantity": 2,
          "productPriceRuleId": 0,
          "productPriceRuleName": "Original",
          "value": 1299.90,
          "code": null,
          "product": {
            "id": 1234,
            "brandId": 1234,
            "brandName": "TopPhone,
            "mainCategoryId": 1,
            "mainCategoryName": "smartphone",
            "type": "product",
            "name": "Smartphone XYZ Pro 128GB",
            "sku": "SMPH001",
            "url": "/smartphone-xyz-pro-128gb",
            "comparisonPrice":2199.99,
            "stock":20,
            "medias":[
              {
                "id": 123,
                "type": "image",
                "title": "",
                "alternativeText": null,
                "file": "\/upload\/media\/produto-media.webp",
                "originalFile": "\/upload\/media\/produto-media.png",
                "size": null,
                "originalSize": null,
                "width": null,
                "height": null,
                "url": null
              }
            ],
            "combination":[1, 2, 3],
            "currentAttributes":[
              {
                "id":123,
                "name":"cor",
                "value":{
                  "id":123,
                  "label":"azul-escuro",
                  "image":null,
                  "originalImage":null,
                  "color":"#00008B",
                  "order":1
                }
              }
            ],
            "active": true
          },
					"productStorages": [
            {
              "productStorageId": 1234, 
              "stock": 20,
              "zipCode": "04567890",
              "latitude": "-12983571225721985",
              "longitude": "-12904872198572198",
            }
          ],
          "volume": {
            "height": 15.7,
            "width": 7.8,
            "length": 0.8,
            "weight": 0.195
          },
          "category": {
            "id": 123,
            "name": "tecnologia/smartphones"
          }
          "cargoTypeId": 1,
          "additionalTime": 1,
          "cubicVolumeItem": 0.0196,
          "totalCubicVolume": 0.0196,
          "error": null
        }
      ],
      "shippingOptions": [
        {
          "shippingTableId": 8,
          "integrationCode": "",
          "externalShippingCode": "",
          "carrierId": 0,
          "carrierName": "",
          "label": "Retirar na loja",
          "value": 0,
          "beginShippingTime": 1,
          "endShippingTime": 1,
          "trackingUrl": null,
          "row": {
            "id": 1,
            "initialZipcode": "10000000",
            "finalZipcode": "99999999",
            "initialWeight": 0,
            "finalWeight": 10,
            "initialPrice": 0,
            "finalPrice": 100000,
            "beginShippingTime": 1,
            "endShippingTime": 1,
            "shippingValue": 0,
            "variables": []
          },
          "pickups": [
            {
              "id": 1,
              "type": "inner",
              "selected": false,
              "name": "Retirada na loja TechBrand",
              "address": "TechBrand street",
              "number": "1234",
              "district": "TechBrand",
              "city": "São Paulo",
              "countryCode": "BRA",
              "stateCode": "BR-SP",
              "zipCode": "12345-123",
              "complement": "",
              "latitude": "-22109580918509215",
              "longitude": "-1023598021985029185",
              "openingHours": "9 horas am"
            }
          ],
          "error": null
        }
      ],
      "additionalTimeGroup":0,
      "storage": {
        "id": 1234,
        "code": "1",
        "corporateName": "TechBrand",
        "email": "suporte@techbrand.com.br",
        "phone": "+55123451234",
        "tradeName": "Armazém Principal",
        "stateCode": "BR-SP",
        "countryCode": "BRA",
        "document": "12345678910",
        "zipCode": "12345678",
        "city": "Birigui",
        "address": "Rua das flores 123",
        "district": "Jardim das flores 1234",
        "number": "1234",
        "complement": "Ao lado da praça",
        "latitude": "-12034598159523",
        "longitude": "-12351298578213",
        "active": true,
        "observation": null,
        "tradePolicyExceptions": [1, 2, 3]
      }
    }
  ],
  "errorItems": []
}

Prologue

Getting Started

Architecture Concepts

The Basics

Digging Deeper

Security

Database

Eloquent ORM

Testing

Packages