Logo
2RS's Public API Documentation

Pedidos

Number of APIs: 6


1. Pesquisar Pedidos

GET {{proto}}://{{domain}}/api/pedido/?order=created DESC&limit=20&lastid&data&lastupdate_gte&created_gte&status=4

Segue abaixo os filtros disponíveis para a pesquisa de pedidos:

  • lastid: Filtra os pedidos realizados após o ID informado.

  • data: Filtra os pedidos pela data de realização.

  • lastupdate: Filtra os pedidos pela data da última atualização.

  • created: Filtra os pedidos pela data de criação do registro.

    Os parâmetros data, lastupdate e created funcionam com os modificadores gte (maior ou igual) e lte (menor ou igual). Ex: &lastupdate_gte=2019-08-22 é igual a lastupdate >= 2019-08-22.

  • pago: Filtra os pedidos pagos pago=S ou não pagos pago=N.

  • status: Filtra os pedidos pelo status. Segue abaixo a tabela de situações:

    StatusDescrição
    1Aberto
    2Confirmado
    3Cancelado
    4Pendente
    5Postado
    6Finalizado
    7Carrinho
  • order: Ordena os resultados pela coluna informada. Aceita as seguintes opções: id, data, created, lastupdate, valor e o modificador ASC/DESC em seguida. Padrão id DESC.



2. Pesquisar Pedidos (Importar Últimos)

GET {{proto}}://{{domain}}/api/pedido?page=1&created_gte=2023-06-01

Segue abaixo os filtros disponíveis para a pesquisa de pedidos:

  • lastid: Filtra os pedidos realizados após o ID informado.

  • data: Filtra os pedidos pela data de realização.

  • lastupdate: Filtra os pedidos pela data da última atualização.

  • created: Filtra os pedidos pela data de criação do registro.

    Os parâmetros data, lastupdate e created funcionam com os modificadores gte (maior ou igual) e lte (menor ou igual). Ex: &lastupdate_gte=2019-08-22 é igual a lastupdate >= 2019-08-22.

  • pago: Filtra os pedidos pagos pago=S ou não pagos pago=N.

  • status: Filtra os pedidos pelo status. Segue abaixo a tabela de situações:

    StatusDescrição
    1Aberto
    2Confirmado
    3Cancelado
    4Pendente
    5Postado
    6Finalizado
    7Carrinho
  • order: Ordena os resultados pela coluna informada. Aceita as seguintes opções: id, data, created, lastupdate, valor e o modificador ASC/DESC em seguida. Padrão id DESC.



3. Detalhe de um pedido

GET {{proto}}://{{domain}}/api/pedido/2153



4. Editar um pedido

PUT {{proto}}://{{domain}}/api/pedido/130520222011

Campos disponíveis para editar: status, pago, pagtostatus, entregarastreiocodigo, entregarastreiolink, observacao, revisadoloja.



5. Remover um pedido

DELETE {{proto}}://{{domain}}/api/pedido/4716



6. Tabela de Status

GET {{proto}}://{{domain}}/api/pedido/status



ENDPOINTS