Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome físico:

ccp/v1/purchaseOrder.p

Objetivo

Realiza a validação e geração de pedidos em lotes e consulta informações de pedido.


Funcionamento

A API fornece uma série de métodos que podem ser executados individualmente para geração e consulta de pedido.


A sintaxe para a chamada da API, que deve ser de forma persistente:

run ccp/rules/purchaseOrderRules.p persistent set h-handle.


A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.


Métodos Negócio

Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

pi-get-v1

Requisito

Nenhum.

Descrição

Repassa o número do pedido para a busca de um registro.

  • ccp/api/v1/purchaseOrder: API de comunicação para processamento dos dados.

Retorna um registro de pedido de compra.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetro para a busca do pedido de compra: 

  • número do pedido
Exemplo
{
    "pathParams": [
        "123543"
    ]
}

oOutput

JsonObject

OUTPUT

Retorno contendo informações do pedido de compra.

Exemplo
{
    "natureTxt": "Compra",
    "siteCode": "1",
    "nature": 1,
    "documentNumber": "53113791000122",
    "purchaseOrder": 994033,
    "shortName": "COTROLEDb",
    "supplyContract": false,
    "orderDate": "2023-02-01",
    "situation": 2,
    "vendorCode": 1
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processamento de busca dos dados.

Retorno

Retorna um registro de pedido de compra ou erros gerados durante o processamento.