Ordens de serviço por período
Ordens de serviço abertas no período, com itens, receita, cliente e valores. Sem o parâmetro status, retorna somente as O.S. ativas.
Authorization
userToken Chave de acesso que aparece no cadastro do usuário, no ssOtica. Envie como
Authorization: Bearer {chave}.
In: header
Query Parameters
CNPJ (ou CPF) da loja, com ou sem máscara. Informe cnpj ou empresa.
Código da Licença da loja (chave de contrato). Informe cnpj ou empresa.
Data inicial, no formato AAAA-MM-DD. O intervalo até fim_periodo pode ter no máximo 180 dias (ex.: 2025-07-01 a 2025-12-28 é aceito; 2025-07-01 a 2025-12-31, com 183 dias, é recusado).
Data final, no formato AAAA-MM-DD. O dia informado é considerado por completo. Deve estar a no máximo 180 dias de inicio_periodo.
Lista de status separada por vírgula. Sem o parâmetro, retorna só O.S. ativas
(exclui PERDA/CANCELADO). Use TODAS para todos os status. Valores aceitos:
ABERTO, CANCELADO, FECHADO, PERDA, VENDIDO, VELADO, ENTREGUE. Valor
inválido retorna 400 com error: PARAMETRO_INVALIDO.
Número da página, a partir de 1 (padrão 1). As páginas devem ser consultadas até o valor de totalPages informado na resposta.
Itens por página, de 1 a 100. A paginação é ativada ao informar page e/ou perPage; sem esses parâmetros, a resposta traz a lista completa. Quando apenas page é informado, são retornados 10 itens por página. O nome deve ser escrito exatamente como perPage; outras grafias, como per_page, são desconsideradas sem aviso.
Se presente, a resposta é retornada como JSONP.
Response Body
application/json
application/json
text/html
curl -X GET "https://example.com/integracoes/ordens-servico/periodo?inicio_periodo=2026-06-01&fim_periodo=2026-06-30"{ "currentPage": 1, "totalPages": 1, "totalItems": 1, "perPage": 100, "data": [ { "id": 72, "numero": 17, "codigo_os_externo": null, "tipo_os": "Otica", "etapa_atual": "", "status": "ABERTO", "data": "2022-06-19", "previsao_entrega": "2022-06-20", "data_entrega": "", "valor_bruto": "259.00", "acrescimo": 0, "desconto": 0, "valor_liquido": 259, "tipo_armacao": "Zilo/Acetato", "material_lente": "Policarbonato", "formato_armacao": null, "aro": "20", "ponte": "30", "maior_diagonal": "35", "altura_vertical": "20", "descricao_material_lente": null, "descricao_lente": "descricao lente", "descricao_coloracao": "coloracao lente", "tipo_lente": "PRONTA", "distancia_pupilar": "23.00", "altura_centro_otico": { "altura_od_longe": "10", "altura_od_perto": "12", "altura_oe_longe": "11", "altura_oe_perto": "13" }, "possui_receita": 1, "possui_armacao": 0, "segue_armacao": 1, "local_montagem": "LABORATORIO", "gaveta_caixa": "123456", "receita": { "id": 98, "esferico_oe_longe": 2, "esferico_oe_perto": 4, "cilindrico_oe_longe": 2, "cilindrico_oe_perto": 2, "prisma_oe_longe": null, "prisma_oe_perto": null, "base_oe_longe": null, "base_oe_perto": null, "eixo_oe_longe": 120, "eixo_oe_perto": 120, "altura_oe_longe": 14, "altura_oe_perto": null, "dnp_oe_longe": 26, "dnp_oe_perto": null, "distancia_pupila_oe": null, "percentual_visao_oe": null, "desconto_oe": null, "ceratometria_oe_longe": null, "esferico_od_longe": 1, "esferico_od_perto": 3, "cilindrico_od_longe": 1, "cilindrico_od_perto": 1, "prisma_od_longe": null, "prisma_od_perto": null, "base_od_longe": null, "base_od_perto": null, "eixo_od_longe": 80, "eixo_od_perto": 80, "altura_od_longe": 15, "altura_od_perto": null, "dnp_od_longe": 23, "dnp_od_perto": null, "distancia_pupila_od": null, "percentual_visao_od": null, "desconto_od": null, "ceratometria_od_longe": null, "adicao": 2, "validade": "2023-06-19 00:00:00", "observacao": null, "curva_base": null, "olho_dominante": null, "ceratometria_od_horizontal": null, "ceratometria_od_horizontal_eixo": null, "ceratometria_od_vertical": null, "ceratometria_od_vertical_eixo": null, "ceratometria_oe_horizontal": null, "ceratometria_oe_horizontal_eixo": null, "ceratometria_oe_vertical": null, "ceratometria_oe_vertical_eixo": null, "indicacao": null, "dnp_oe": null, "dnp_od": null, "altura_oe": null, "altura_od": null, "diametro_lente_oe": null, "diametro_lente_od": null, "angulo_pantoscopico": null, "medido_pupilometro": null, "layout_novo": 0, "medicao_id": null, "dados_cliente_anonimizado": null, "campos_preenchidos_ia": null, "optometrista": "" }, "observacao": "", "ocorrencias": null, "responsavel_tecnico": "", "funcionario": { "id": 28432, "nome": "Juliana Santos", "cpf": "", "rg": "", "telefone_fixo": "", "telefone_movel": "", "endereco": { "logradouro": "", "bairro": "", "cep": "", "cidade": "", "uf": "" }, "funcao": "Vendedor", "observacao": "Observação de exemplo" }, "itens": [ { "id": 83, "produto": { "id": 2605953, "referencia": "7059-50-1742", "descricao": "**arm.pof.200-7059-50-1742-J Pierre", "grupo": "Armações", "grife": "Jean Pierre", "unidade": "UN", "código_gtin": null }, "quantidade": "1.0000", "desconto": 0, "acrescimo": 0, "valor_unitario_liquido": 259, "valor_total_liquido": 259, "custo": 68.02 } ], "formas_pagamento": [], "cliente": { "id": 2800261, "nome": "Pedro Almeida", "apelido": "Cliente Exemplo", "nascimento": "1977-11-08", "cpf_cnpj": "123.456.789-09", "rg_ie": "", "nome_pai": "José da Silva", "nome_mae": "Maria Aparecida da Silva", "profissao": null, "observacao": "", "ativo": true, "contribuinte_icms": false, "suframa": null, "ie": null, "im": null, "tipo": "PF", "cadastrado_em": "2021-09-07 06:40:18", "sexo": "M", "renda_familiar": "0.00", "codigo": null, "convenio": "", "escolaridade": null, "referencia": null, "endereco": { "logradouro": "Rua das Flores", "numero": "100", "complemento": "", "bairro": "Centro", "cep": "01001-000", "cidade": "Uberlândia", "uf": "MG", "pais": "Brasil" }, "telefones": [ { "numero": "(11) 9.9999-0000", "identificacao": "" } ], "emails": [], "origem": "" }, "cliente_otica": null, "origensCliente": [ "Abordagem Frente de Loja" ], "id_venda_vinculada": "", "laboratorio": "", "adiantamento": 0, "valor_a_receber": 259, "valor_credito_troca": 0, "valor_liquido_menos_troca": 259 } ]}{ "error": "DATA_INVALIDA", "error_info": "O campo \"inicio_periodo\" contém uma data inválida. Utilize o formato AAAA-MM-DD (ex.: 2026-06-30)."}"Unauthorized."