Entrar

Listar pedidos (completo)

GET https://{organization}.myguper.com/api/order/data/full

A mesma listagem do GET /api/order/data - mesmos filtros, ordenacao e paginacao - mas cada linha vem com o payload completo do pedido, o mesmo que o GET /api/order/data/{idOrder} devolve: itens, pagamentos, campanhas, tags do cliente, historico, reward, loja e cliente.

Serve para ler uma pagina inteira em detalhe sem fazer uma requisicao por pedido.

GET /api/order/data/full?q[status][E]=paid&e=20

Teto de 50 linhas por pagina: cada linha carrega itens, pagamentos e historico, entao e=0 significaria o historico inteiro da organizacao em uma resposta. Acima de 50 - ou e=0 - a resposta vem com 50.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Send your user token in the x-guper-authorization header.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros de query

Name Type Description
q object Filters, as `q[column][operator]=value` - the same grammar and the same columns as `GET /api/order/data`.
p integer Page number, starting at 1.
e integer Entries per page. Maximum and default 50.

Respostas

{
    "list": [
        {
            "id": 1672118,
            "refId": "ord-2026-001",
            "interface": "mystore",
            "store": {
                "id": 124,
                "refId": "SP-01",
                "name": "mystore"
            },
            "cashier": "6977",
            "salesperson": "2367",
            "client": {
                "id": 6497,
                "name": "Tintim",
                "email": "tintim@tintim.com.br",
                "countryCallingCode": 55,
                "cellphone": "19966659986",
                "document": null
            },
            "clientValidation": null,
            "processStatus": "processed",
            "orderStatus": "completed",
            "paidValue": 25000,
            "customerTag": [
                12,
                34
            ],
            "campaigns": [
                {
                    "campaign": 656,
                    "value": 2500,
                    "type": "monetary"
                }
            ],
            "items": [
                {
                    "id": 138876,
                    "productId": null,
                    "productRefId": "9912",
                    "productName": "Tenis Casual Feminino",
                    "skuId": null,
                    "skuRefId": "9912-34",
                    "skuName": "Tenis Casual Feminino 34",
                    "categoryId": 659,
                    "brandId": 987,
                    "quantity": 1,
                    "quantityCanceled": 0,
                    "price": 25000,
                    "listPrice": 26200,
                    "redemption": 1200
                }
            ],
            "payments": [
                {
                    "id": 55321,
                    "value": 25000,
                    "type": "credit-card",
                    "paymentSystem": "my-payment",
                    "paymentSystemName": "My Payment",
                    "installments": 1,
                    "firstDigits": "4569",
                    "lastDigits": "1236"
                }
            ],
            "total_order": 25000,
            "total_item": 25000,
            "total_shipping": 0,
            "total_taxes": 0,
            "total_discounts": 1200,
            "histories": [
                {
                    "status": "order-create",
                    "reason": "Order Create",
                    "date": "2026-09-01T10:35:00-03:00"
                }
            ],
            "reward": {
                "tid": "4fa1a7fa876a80ec025184e7786fd51f",
                "rewardable": 23800,
                "redeemable": 0
            },
            "createdAt": "2026-09-01T10:35:06-03:00",
            "integratedAt": "2026-09-01T10:35:06-03:00",
            "indexedAt": "2026-09-01T10:36:02-03:00",
            "updatedAt": "2026-09-01T11:25:46-03:00"
        }
    ],
    "total": 348,
    "pagination": {
        "entries": 20,
        "order": {
            "createdAt": "desc"
        },
        "totalPages": 18,
        "currentPage": 1,
        "isInitial": true,
        "isEnd": false,
        "totalPrevPages": 0,
        "totalNextPages": 17
    }
}

Relacionados

Copied to clipboard