Criar

Ao realizar a criação do pedido, a Mottu irá retornar uma resposta informando se a criação foi bem-sucedida ou não. Em caso de sucesso, a resposta conterá o número do pedido criado. Em caso de erro, a Mottu retornará uma mensagem de erro informando o motivo do problema ou uma notificação no web lojista.

Para evitar problemas na criação de pedido e seguir o padrão esperado, recomenda-se a leitura dos itens Regras de negócio e Entrega segura.

Criação de pedido. Caso ocorrá algum erro ao criar o pedido, o lojista será notificado através do web lojista

POSThttps://integrations.mottu.io/delivery/orders

Authorization

SECURITY_API_TOKEN

Body

application/json

code*string

Código customizado do pedido

Example: "17842a"

preparationTimenumber

Tempo de preparo do pedido em minutos, por exemplo, 40 minutos de preparo da refeição, nesse caso o pedido alocará um entregador após 40 minutos da criação do pedido. A propriedade é opcional

previewDeliveryTimeboolean

Define se devolvemos o tempo de entrega. Caso seja "false", retornaremos os campos vazios

fullCodestring

Código customizado completo do pedido. A propriedade é opcional

Example: "17842a-77-426a"

sortByBestRouteboolean

Caso seja marcada como "true", as entregas serão ordenadas pela melhor rota. Caso contrário, os pedidos serão entregues na ordem enviada. A propriedade é opcional - tendo como "false" o valor padrão

pickupAddressall of

Endereço de coleta do pedido. A propriedade é opcional e, quando não informado, será utilizado o endereço do usuário cadastrado na Mottu como endereço de coleta

deliveries*array of CreateDeliveryDto (object)

Coleção de entregas que serão realizadas

storeall of

Lojista para criação do pedido. A propriedade é opcional

Response

201400401409

Pedido criado com sucesso

Body

application/json

code*string

Código customizado do pedido

Example: "17842a"

preparationTimenumber

Tempo de preparo do pedido em minutos, por exemplo, 40 minutos de preparo da refeição, nesse caso o pedido alocará um entregador após 40 minutos da criação do pedido. A propriedade é opcional

fullCodestring

Código customizado completo do pedido. A propriedade é opcional

Example: "17842a-77-426a"

pickupAddressall of

Endereço de coleta do pedido. A propriedade é opcional e, quando não informado, será utilizado o endereço do usuário cadastrado na Mottu como endereço de coleta

id*number

Identificador do pedido

createdAt*string (date-time)

Data de criação do pedido

storeId*number

Identificador do lojista

situation*number

Situação atual do pedido pelo evento tipo id

returnCodestring

Código de retorno de pedido. A propriedade é opcional

pickupCodestring

Código de coleta do pedido. A propriedade é opcional

totalDistance*number

Distância total da entrega em kms

deliveryFee*number

Taxa cobrada pelo lojista pela entrega

deliveries*array of DeliveryDto (object)

Coleção de entregas

expectedDeliverystring (date-time)

Expectativa de entrega do(s) pedido(s)

expectedPickupstring (date-time)

Expectativa de coleta do(s) pedido(s)

Request

JavaScriptCurlPython

const response = await fetch('https://integrations.mottu.io/delivery/orders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "code": "17842a",
      "deliveries": [
        {
          "code": "17842a",
          "name": "text",
          "phone": "text",
          "address": {
            "street": "text",
            "number": "text",
            "neighborhood": "text",
            "city": "SP",
            "state": "SP",
            "zipCode": "text"
          },
          "onlinePayment": false
        }
      ]
    }),
});
const data = await response.json();

Response

201400401409

{
  "code": "17842a",
  "preparationTime": 0,
  "fullCode": "17842a-77-426a",
  "pickupAddress": {
    "street": "text",
    "number": "text",
    "complement": "text",
    "neighborhood": "text",
    "city": "SP",
    "state": "SP",
    "zipCode": "text"
  },
  "id": 0,
  "createdAt": "2024-09-18T08:00:41.695Z",
  "storeId": 0,
  "situation": 0,
  "returnCode": "text",
  "pickupCode": "text",
  "totalDistance": 0,
  "deliveryFee": 0,
  "deliveries": [
    {
      "code": "17842a",
      "fullCode": "17842a-77-426a",
      "name": "text",
      "phone": "text",
      "observation": "text",
      "onlinePayment": false,
      "productValue": 13.45,
      "id": 0,
      "situation": 0,
      "orderRoute": 0,
      "address": {
        "street": "text",
        "number": "text",
        "complement": "text",
        "neighborhood": "text",
        "city": "SP",
        "state": "SP",
        "zipCode": "text"
      },
      "distance": 0,
      "deliveryCode": "text"
    }
  ],
  "expectedDelivery": "2024-09-18T08:00:41.695Z",
  "expectedPickup": "2024-09-18T08:00:41.695Z"
}