# Criação de entregas

Com este endpoint, você poderá criar até um máximo de 100 entregas por request e 100 requests por minuto.

## Criação de entregas

> Crie até 100 entregas dentro da Shippify

```json
{"openapi":"3.0.0","info":{"title":"API Shippify","version":"1.0.0"},"servers":[{"url":"https://api.shippify.co","description":"Servidor de desenvolvimento"}],"security":[{"Basic_Auth":[]}],"components":{"securitySchemes":{"Basic_Auth":{"type":"http","scheme":"basic"}},"schemas":{"createDelivery":{"successfulResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"payload":{"type":"array","items":{"type":"object","description":"Informações da entrega criada","properties":{"index":{"description":"Posição da entrega no array de solicitação","type":"integer","minimum":0},"id":{"type":"string","description":"Identificador da entrega Shippify"},"price":{"description":"Preço da entrega","type":"number","minimum":0},"currencyCode":{"type":"string","description":"Moeda do preço da entrega"},"distance":{"description":"Distância entre pontos de coleta e entrega","type":"number","minimum":0},"cityId":{"description":"Identificador da cidade de coleta","type":"integer","minimum":1},"destinationCityId":{"description":"Identificador da cidade de entrega","type":"integer","minimum":1},"insurance":{"description":"Seguro da entrega","type":"number","minimum":0},"statusDelivery":{"type":"string","description":"Status atual da entrega"},"vehicleCapacity":{"description":"Capacidade da entrega","type":"integer","minimum":1,"maximum":5},"deliveryDate":{"type":"string","description":"Data estimada de entrega","format":"date-time"},"trackLink":{"type":"string","description":"Link de rastreamento"},"referenceId":{"type":"string","description":"Identificador externo da entrega, pode ser o número do pedido"}}}}}},"request":{"type":"object","required":["deliveries"],"properties":{"companyId":{"description":"Identificador da empresa onde a entrega será criada","type":"integer","minimum":1},"type":{"description":"Tipo de entrega","type":"string","enum":["flex","express","slot"],"default":"slot"},"deliveries":{"type":"array","items":{"$ref":"#/components/schemas/createDelivery/delivery"}}}},"delivery":{"type":"object","required":["pickup","dropoff","packages"],"properties":{"pickup":{"description":"Informações de coleta","$ref":"#/components/schemas/delivery/place"},"dropoff":{"description":"Informações de entrega","$ref":"#/components/schemas/delivery/place"},"packages":{"description":"Informações do pacote.","type":"array","items":{"$ref":"#/components/schemas/delivery/package"}},"referenceId":{"description":"Identificador externo da entrega, pode ser o número do pedido","type":"string","maxLength":40},"tags":{"description":"Nomes das etiquetas digitais","type":"array","items":{"description":"Nome da etiqueta digital","type":"string","maxLength":50}},"extraData":{"description":"Dados extras da entrega","type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"Nome da informação extra"},"value":{"type":"string","description":"Valor da informação extra"}}}},"cod":{"description":"Pagamento na entrega","type":"number","minimum":0}}}},"Unauthenticated":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"delivery":{"place":{"type":"object","required":["contact","location"],"properties":{"contact":{"$ref":"#/components/schemas/delivery/contact"},"location":{"$ref":"#/components/schemas/delivery/location"}}},"contact":{"description":"Informações de contato da pessoa responsável por entregar os pacotes no armazém de coleta.","type":"object","required":["name","email"],"properties":{"name":{"description":"Nome da pessoa responsável.","type":"string"},"email":{"description":"Email da pessoa responsável.","type":"string","format":"email"},"phonenumber":{"description":"Número de telefone da pessoa responsável.","type":"string"}}},"location":{"description":"Informações do endereço do local de coleta dos pacotes de entrega.","type":"object","required":["address"],"properties":{"address":{"description":"Endereço de entrega.","type":"string"},"instructions":{"description":"Informações extras sobre o endereço.","type":"string"},"lat":{"description":"Latitude do ponto de coleta.","type":"string"},"lng":{"description":"Longitude do ponto de coleta.","type":"string"}}},"package":{"type":"object","required":["name","qty","size"],"properties":{"id":{"type":"string","description":"Identificador do pacote"},"name":{"type":"string","description":"Nome do pacote"},"qty":{"description":"Número de pacotes no pedido (não o número de produtos dentro do pacote).","type":"integer","minimum":0},"weight":{"description":"Peso unitário * quantidade em Kg","type":"number","minimum":0},"size":{"description":"Package size","type":"string","enum":["xs","s","m","l","xl"]},"price":{"description":"Preço unitário * quantidade na moeda da empresa","type":"number","minimum":0}}}}}},"paths":{"/v1/deliveries":{"post":{"tags":["Entregas"],"summary":"Criação de entregas","description":"Crie até 100 entregas dentro da Shippify","responses":{"200":{"description":"Operação bem-sucedida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createDelivery/successfulResponse"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthenticated"}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createDelivery/request"}}}}}}}}
```

## Casos de uso

<details>

<summary>Criando entregas com referenceID</summary>

Esse é o payload mais básico que você pode usar na API, mas é provável que a tarefa seja criada com o estado "pendente de revisão" se o endereço não puder ser geolocalizado

<pre class="language-json"><code class="lang-json"><strong>{
</strong>    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "phonenumber": "09999999999",
                    "email": "example@test.com",
                    "name": "Carlos Perez"
                },
                "location": {
                    "address": "Av. Francisco de Orellana 8, Guayaquil 090502, Ecuador",
                    "instructions": "Apartamento 203"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Juan Perez",
                    "email": "example@hotmail.com"
                },
                "location": {
                    "address": "Malecón 2000, Simon Bolivar Palacios, Guayaquil 090313, Ecuador",
                    "instructions": "Local 890"
                }
            },
            "packages": [
                {
                    "name": "Caja de colores",
                    "qty": 1,
                    "size": 1
                }
            ],
            "referenceId": "FACT-000123"
        }
    ]
}
</code></pre>

</details>

<details>

<summary>Criando uma entrega com endereço e com latitude e longitude</summary>

Com esse payload, você poderá criar entregas com pontos de coleta e entrega precisos, garantindo que a tarefa sempre seja criada com o estado "processando".

```json
{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "name": "Juan Perez",
                    "phonenumber": "09999999999"
                },
                "location": {
                    "address": "Av. Echeñique 8861, 7860169 La Reina, Región Metropolitana, Chile",
                    "lat": "-33.44299381045172",
                    "lng": "-70.53898694556675"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "example@shippify.cl",
                    "phonenumber": "099999999999"
                },
                "location": {
                    "address": "Los Castaños 11989, 8010277 Santiago, El Bosque, Región Metropolitana, Chile",
                    "lat": "-33.56751",
                    "lng": "-70.67549"
                }
            },
            "packages": [
                {
                    "name": "149123156552",
                    "size": "XS",
                    "qty": "1"
                }
            ]
        }
    ]
}
```

</details>

<details>

<summary>Criando entregas com endereço por componentes</summary>

Com esse payload, você poderá criar entregas com um ponto de coleta ou entrega um pouco mais preciso e com menos probabilidades de ser criado como "pendente de revisão". Consiste em separar o endereço por país, cidade, rua e código postal.

```json
{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "name": "Juan Perez",
                    "phonenumber": "0999999999"
                },
                "location": {
                    "address": "R. Dona Claudina, 401 - Méier, Rio de Janeiro - RJ, 20725-060, Brasil",
                    "lat": -22.906846699999996,
                    "lng": -43.28275978125001
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "example@shippify.cl",
                    "phonenumber": "09999999999"
                },
                "location": {
                    "address": {
                        "zipcode": "60348450",
                        "neighborhood": "VILA VELHA",
                        "streetName": "RUA 24,656",
                        "state": "CE",
                        "country": "Brazil",
                        "city": "FORTALEZA"
                    },
                    "instructions": "CONJ DOS BANCARIOS - REF.ENDERECO: PROX A UPA"
                }
            },
            "packages": [
                {
                    "name": "149123156552",
                    "size": "XS",
                    "qty": "1"
                }
            ]
        }
    ]
}
```

</details>

<details>

<summary>Criando entrega com um galpão já configurado</summary>

Com esse payload, você poderá criar entregas com um ponto de coleta salvo anteriormente na seção de [galpões/depósito](https://dash.shippify.co/places).

```json
{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "name": "Juan Perez",
                    "phonenumber": "09999999999"
                },
                "location": {
                    "warehouse": 9
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "example@shippify.cl",
                    "phonenumber": "09999999999"
                },
                "location": {
                    "address": {
                        "zipcode": "60348450",
                        "neighborhood": "VILA VELHA",
                        "streetName": "RUA 24,656",
                        "state": "CE",
                        "country": "Brasil",
                        "city": "FORTALEZA"
                    },
                    "instructions": "CONJ DOS BANCARIOS - REF.ENDERECO: PROX A UPA"
                }
            },
            "packages": [
                {
                    "name": "149123156552",
                    "size": "XS",
                    "qty": "1"
                }
            ]
        }
    ]
}
```

</details>

<details>

<summary>Criando entregas com tags e extradata</summary>

Com essas etiquetas digitais, você pode adicionar características adicionais à tarefa para depois poder filtrá-las, por exemplo: frágil.&#x20;

Com os dados extras, você pode vincular informações adicionais à entrega.

```json
{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "phonenumber": "09999999999",
                    "email": "example@test.com",
                    "name": "Juan Perez"
                },
                "location": {
                    "address": "Av. Francisco de Orellana 8, Guayaquil 090502, Ecuador",
                    "instructions": "Apartamento 203"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "example@hotmail.com"
                },
                "location": {
                    "address": "Malecón 2000, Simon Bolivar Palacios, Guayaquil 090313, Ecuador",
                    "instructions": "Local 890"
                }
            },
            "packages": [
                {
                    "name": "Caixa de lapís",
                    "qty": 1,
                    "size": 1
                }
            ],
            "tags" : [ 
                "fragil"
            ],
             "extraData": [
                {
                    "name": "GUIA DE REMISION",
                    "value": "0001-000344-2233",
                    "searchable": true
                }
            ],
            "referenceId": "FACT-000123"
        }
    ]
}
```

</details>

<details>

<summary>Criando entrega para uma empresa filha</summary>

Com esse payload, você pode criar entregas para uma empresa filha com a autorização da empresa matriz.

<pre class="language-json"><code class="lang-json">{
    <a data-footnote-ref href="#user-content-fn-1">"companyId":2,</a>
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "phonenumber": "09999999999",
                    "email": "example@test.com",
                    "name": "Juan Perez"
                },
                "location": {
                    "address": "Av. Francisco de Orellana 8, Guayaquil 090502, Ecuador",
                    "instructions": "Apartamento 203"
                }
            },
            "dropoff": {
                "contact": {
                    "name": "Carlos Perez",
                    "email": "example@hotmail.com"
                },
                "location": {
                    "address": "Malecón 2000, Simon Bolivar Palacios, Guayaquil 090313, Ecuador",
                    "instructions": "Local 890"
                }
            },
            "packages": [
                {
                    "name": "Caixa de lapís",
                    "qty": 1,
                    "size": 1
                }
            ],
            "referenceId": "FACT-000123"
        }
    ]
}
</code></pre>

</details>

[^1]: Identificador de la compañía hija


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shippify.co/developers/pt/shippify-api/entregas/criacao-de-entregas.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
