Listar todos os pedidos - Integração sistema de estabelecimentos

Exemplo endpoint de integração

/establishments/{establishment_id}/orders?fields=order&status=canceled&fields=status&fields=created_at&sort=-order

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

establishment_id

string

requerido

Parâmetros Query

status

array[string]

opcional

Status do pedido no momento da consulta

Valores permitidos:

newconfirmedcanceledcompletedscheduledlocalsentawaiting_payment

fields

array[string]

opcional

Campos do pedido que serão retornados

Valores permitidos:

orderstatuscreated_atdeadlinedelivery_typeuser.nameuser.phone

sort

enum<string>

opcional

Ordenação dos resultados, sendo -order a ordenação decrescente

Valores permitidos:

order-order

limit

number

opcional

Limite de documentos por página

Padrão:

page

number

opcional

Página da listagem dos documentos

Padrão:

start_at

string

opcional

Data de criação >= start_at

end_at

string

opcional

Data de criação < end_at

Parâmetros Header

client-type

enum<string>

requerido

Valores permitidos:

rest

api-version

enum<number>

requerido

Valor fixo:

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Success

application/json

Body

docs

array[object (Docs) {8}]

requerido

_id

string

requerido

order

number

requerido

user_id

string

requerido

establishment_id

string

requerido

status

string

requerido

created_at

string

requerido

establishment

object

requerido

user

object

requerido

paginate

object

requerido

count

number

requerido

limit

number

requerido

page

number

requerido

pages

number

requerido

Exemplo

{
    "docs": [
        {
            "_id": "string (mongo id)",
            "order": 5,
            "user_id": "string (mongo id)",
            "establishment_id": "string (mongo id)",
            "status": "string",
            "created_at": "string(data no formato iso string)",
            "establishment": {
                "_id": "string (mongo id)",
                "company": "string",
                "preferences": {
                    "title": "string"
                },
                "design": {
                    "icon": "string"
                },
                "app_name": "string"
            },
            "user": {
                "_id": "string (mongo id)",
                "name": "string",
                "email": "string",
                "phone": "string"
            }
        }
    ],
    "paginate": {
        "count": 5,
        "limit": 5,
        "page": 5,
        "pages": 5
    }
}