Consultar

A consulta de pedidos é restrita ao acesso somente dos próprios pedidos ou dos pedidos das filiais do usuário autenticado, a fim de evitar o acesso não autorizado a informações de outros usuários.

Busca de detalhes de um pedido criado. Somente é possível buscar os próprios pedidos

GEThttps://integrations.mottu.io/delivery/orders/{mottuOrderId}

Authorization

SECURITY_API_TOKEN

Path parameters

mottuOrderId*number

Response

200400401404

Pedido encontrado com sucesso

Body

application/json

codestring

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

idnumber

Identificador do pedido

createdAtstring (date-time)

Data de criação do pedido

storeIdnumber

Identificador do lojista

situationnumber

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

totalDistancenumber

Distância total da entrega em kms

deliveryFeenumber

Taxa cobrada pelo lojista pela entrega

deliveriesarray 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)

deliveryManall of

Entregador associado ao pedido. A propriedade é opcional, somente irá retornar algo quando um entregador for associado ao pedido

events*array of OrderEventDto (object)

Coleção de eventos do pedido

origin*string

Origem de criação do pedido. A origem de criação de um pedido por esta integração é 'INTEGRATION'

Request

JavaScriptCurlPython

const response = await fetch('https://integrations.mottu.io/delivery/orders/{mottuOrderId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404

{
  "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:03:39.881Z",
  "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:03:39.881Z",
  "expectedPickup": "2024-09-18T08:03:39.881Z",
  "deliveryMan": {
    "phone": "text",
    "name": "text",
    "id": 0,
    "profileId": 0,
    "email": "text",
    "document": "text",
    "ddd": "text",
    "latitude": 0,
    "longitude": 0
  },
  "events": [
    {
      "id": 0,
      "createdAt": "2024-09-18T08:03:39.881Z",
      "description": "text",
      "latitude": 0,
      "longitude": 0,
      "deliveryMan": {
        "phone": "text",
        "name": "text"
      },
      "requestedBy": {
        "phone": "text",
        "name": "text"
      }
    }
  ],
  "origin": "text"
}