Linha Datasul

Árvore de páginas


Objetivo
Esta API tem a finalidade de mostrar as informações de uma ordem de compra específica e das primeiras ordens de compra da paginação informada.
OBS: Caso a quantidade de ordens de compra não seja informada, a API define 20 ordens por paginação. E caso a paginação não seja informada, a API define 1 página por padrão.

Esta API recebe os parâmetros da requisição enviada pela ccp/api/v2/purchaseOrderLines fazendo as primeiras comunicações necessárias nos métodos e encaminhando o que foi solicitado por meio de parâmetros para a ccp/rules/purchaseOrderLinesV2 afim de realizar as devidas consultas utilizando as regras de negocio.

Funcionalidade 
A API fornece dois métodos que podem ser executados individualmente para apresentação das informações das ordens.

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

pi-get

RequisitoNenhum.

Sintaxe

RUN pi-get in handle (INPUT oInput,

                                    OUTPUT oOutput).

Descrição







Repassa o parâmetro do tipo de evento recebido pela API de comunicação para o script de negocio (ccp/rules/purchaseOrderLinesV2) chamando o método pi-get-v2.

  • ccp/api/v2/purchaseOrderLinesV2: API de comunicação para a requisição das ordens de compra.
  • ccp/rules/purchaseOrderLinesV2.p: Script com as regras de negocio que atribui aos campos os valores que irão ser retornados.
  • ccp/rules/purchaseOrderLinesV2.i: Interface que tem os campos que serão retornados.

Retornando os valores da ordem passada pelo pathParams.

Parâmetro

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para busca de ordens específicas.

pathParams:  Informar numero da ordem.

queryParams: Pode ser utilizado filtros complexos com campos específicos.

Exemplo

{
    "pathParams": [
       285863
    ]

}

oOutput

JsonObject

OUTPUT

Retorno da requisição trazendo as informações da ordem pesquisada 

Exemplo de retorno

{
  "orderType": 1,
  "orderNumber": 0,
  "businessUnit": "",
  "totalPriceInDefaultCurrency": 3500.0,
  "freightPriceInDefaultCurrency": 0.0,
  "itemCode": ".compras",
  "groupId": 0,
  "vendorId": 13,
  "investmentOrder": 221,
  "carrierShortName": "12345678901234567890123456789012345678901234567890666666666677777777778888888888",
  "requestNumber": 9998627,
  "itemDescription": "TUBO DE ALUMINIO 34 X 96,5 X 0,50MM COM RASGO REF 7337",
  "freightPrice": 0.0,
  "unitPrice": 700.0,
  "package": 0,
  "unitOfMeasure": "KG",
  "vendorUnitOfMeasure": "L",
  "contractNumber": 0,
  "deliveryDateTxt": "08/18/2020",
  "quotationDate": "2020-08-18",
  "firstDeliveryDate": "2020-08-18",
  "quantityBalance": 0.0,
  "paymentTermDescription": "QUITADO",
  "quotationValidityDays": 135,
  "incoterm": "",
  "carrierCode": 0,
  "expiredQuote": true,
  "statusCode": 3,
  "freightPaymentType": false,
  "totalPrice": 3500.0,
  "siteName": "B2B  Estabelecimento Automação APP",
  "expectation": false,
  "quotationValidityDate": "2020-12-31",
  "urgencyDescription": "Muito Alta",
  "urgency": 1,
  "vendorPrice": 700.0,
  "quotationProcessId": 0.0,
  "paymentTermId": 2,
  "siteCode": "1",
  "quantity": 5.0,
  "comments": "A narrativa xxxdesse item possui 100 posições, A narrativa desse item possui 100 posições, A narrativa desse item possui #pp\nNarrativa do Item...\n",
  "unitPriceInDefaultCurrency": 700.0,
  "orderTypeDescription": "Compra",
  "buyerName": "SUPER",
  "buyerCode": "super",
  "statusDescription": "Cotada",
  "orderLineNumber": 285863,
  "currencyCode": 0,
  "vendorShortName": "TREZE"
}

RowErrors

Temp-table

OUTPUT

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

Retorno

Retorna a busca dos dados da ordem escolhida ou os erros ocorridos durante a busca

pi-query

RequisitoNenhum.

Sintaxe

RUN pi-query in handle (INPUT oInput,

                                        OUTPUT oOutput).

Descrição






Repassa o parâmetro do tipo de evento recebido pela API de comunicação para o script de negocio (ccp/rules/purchaseOrderLinesV2) chamando o método pi-query-v2.

  • ccp/api/v2/purchaseOrderLinesV2: API de comunicação para a requisição das ordens de compra.
  • ccp/rules/purchaseOrderLinesV2.p: Script com as regras de negocio que atribui aos campos os valores que irão ser retornados.
  • ccp/rules/purchaseOrderLinesV2.i: Interface que tem os campos que serão retornados.

Parâmetro

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para busca de ordens.

  • queryParams: 
    • page: Informar numero da paginação.
    • pageSize: Informar a quantidade de campos que serão retornados por cada paginação.
Exemplo

{

    "queryParams": {

    "page": 1,

         "pageSize": 20

  },
}

oOutput

JsonObject

OUTPUT

Retorno contendo as informações de todas as ordens de compra na paginação escolhida:

Exemplo de retorno
{
  "total": 20,
  "hasNext": true,
  "items":[
    {"orderType": 1, "orderNumber": 190876, "businessUnit": "01", "totalPriceInDefaultCurrency": 2881.2,…},
    {"orderType": 1, "orderNumber": 191204, "businessUnit": "99", "totalPriceInDefaultCurrency": 1.0,…},
    {"orderType": 1, "orderNumber": 190858, "businessUnit": "01", "totalPriceInDefaultCurrency": 176.0,…},
    {"orderType": 1, "orderNumber": 181265, "businessUnit": "", "totalPriceInDefaultCurrency": 534.24,…},
    {"orderType": 1, "orderNumber": 181264, "businessUnit": "01", "totalPriceInDefaultCurrency": 1252.4,…},
    {"orderType": 1, "orderNumber": 0, "businessUnit": "01", "totalPriceInDefaultCurrency": 0.0,…},
    {"orderType": 2, "orderNumber": 0, "businessUnit": "99", "totalPriceInDefaultCurrency": 0.0,…},
    {"orderType": 1, "orderNumber": 0, "businessUnit": "01", "totalPriceInDefaultCurrency": 623.12,…},
    {"orderType": 1, "orderNumber": 181221, "businessUnit": "01", "totalPriceInDefaultCurrency": 270.0,…},
    {"orderType": 1, "orderNumber": 1019, "businessUnit": "01", "totalPriceInDefaultCurrency": 300.0,…},
    {"orderType": 1, "orderNumber": 181266, "businessUnit": "01", "totalPriceInDefaultCurrency": 34.6236,…},
    {"orderType": 1, "orderNumber": 181267, "businessUnit": "01", "totalPriceInDefaultCurrency": 34.6236,…},
    {"orderType": 1, "orderNumber": 181268, "businessUnit": "01", "totalPriceInDefaultCurrency": 34.6236,…},
    {"orderType": 1, "orderNumber": 181272, "businessUnit": "01", "totalPriceInDefaultCurrency": 242.00022,…},
    {"orderType": 1, "orderNumber": 181273, "businessUnit": "01", "totalPriceInDefaultCurrency": 3520.0,…},
    {"orderType": 1, "orderNumber": 190858, "businessUnit": "01", "totalPriceInDefaultCurrency": 100.0,…},
    {"orderType": 1, "orderNumber": 190858, "businessUnit": "01", "totalPriceInDefaultCurrency": 7260.0,…},
    {"orderType": 1, "orderNumber": 181275, "businessUnit": "01", "totalPriceInDefaultCurrency": 6600.0,…},
    {"orderType": 1, "orderNumber": 181276, "businessUnit": "01", "totalPriceInDefaultCurrency": 6000.0,…},
    {"orderType": 1, "orderNumber": 181277, "businessUnit": "01", "totalPriceInDefaultCurrency": 6000.0,…}
  ]
}

RowErrors

Temp-table

OUTPUT

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

Retorno

Retorna uma busca das ordens seguindo a paginação escolhida ou os erros ocorridos durante a busca