# Orderful

O **Orderful** simplifica as transações de EDI (Intercâmbio Eletrônico de Dados). Ele permite a integração com a API do Orderful, possibilitando o envio, recebimento e gerenciamento eficiente de documentos EDI.

## **Parâmetros**

Dê uma olhada nos parâmetros de configuração do conector. Parâmetros suportados por [expressões Double Braces](https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/double-braces/overview) estão marcados com `(DB)`.

### **Aba General**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Account</strong></td><td>A conta usada pelo conector. Tipo suportado: <strong>Secret Key</strong>.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Fail On Error</strong></td><td>Se a opção for ativada, a execução do pipeline com erro será interrompida. Caso contrário, a execução do pipeline continua, mas o resultado mostrará um valor falso para a propriedade <code>"success"</code>.</td><td>False</td><td>Booleano</td></tr></tbody></table>

### **Aba Host**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Host</strong> <code>(DB)</code></td><td>A URL base da API do Orderful. Recomendamos o uso de HTTPS.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Path</strong></td><td>O endpoint específico do Orderful a ser acessado. Com base no caminho selecionado, opções adicionais podem estar disponíveis para a configuração de parâmetros de consulta ou outras definições necessárias. Para mais detalhes sobre cada endpoint, consulte a documentação da <a href="https://docs.orderful.com/reference/overview">API do Orderful</a>.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Method</strong></td><td>O método HTTP usado para a solicitação.</td><td>N/A</td><td>String</td></tr></tbody></table>

### **Aba Settings**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Connect Timeout (ms)</strong></td><td>Tempo máximo permitido para estabelecer uma conexão, em milissegundos.</td><td>30000</td><td>Integer</td></tr><tr><td><strong>Read Timeout (ms)</strong></td><td>Tempo máximo permitido para ler dados, em milissegundos.</td><td>30000</td><td>Integer</td></tr><tr><td><strong>Stop on Client Error</strong></td><td>Quando ativado, interrompe a execução do pipeline se ocorrer um erro HTTP 4xx.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Stop on Server Error</strong></td><td>Quando ativado, interrompe a execução do pipeline se ocorrer um erro HTTP 5xx.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Override Response Charset</strong></td><td>Quando ativado, substitui o charset retornado pelo endpoint especificado na propriedade <strong>Response Charset</strong>. Caso contrário, o charset do cabeçalho <strong>Content-Type</strong> é usado.</td><td>True</td><td>Booleano</td></tr><tr><td><strong>Response Charset</strong></td><td>Define o charset a ser utilizado quando <strong>Override Response Charset</strong> estiver ativado. Padrão: UTF-8.</td><td>UTF-8</td><td>String</td></tr><tr><td><strong>Advanced Settings</strong></td><td>Ativa opções de configuração adicionais.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Raw Mode</strong></td><td>Quando ativado, permite o envio ou recebimento de um payload não-JSON.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Save as Local File</strong></td><td>Quando ativado, salva a resposta como um arquivo no diretório local do pipeline.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Allow Insecure Endpoints</strong></td><td>Quando ativado, permite chamadas para endpoints HTTPS sem aplicar verificações de segurança.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Enable Retries</strong></td><td>Quando ativado, tenta repetir as solicitações em caso de erros do servidor.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Compress Body with GZIP</strong></td><td>Quando ativado, compacta o corpo da solicitação usando GZIP.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Force HTTP 1.1</strong></td><td>Quando ativado, força a solicitação a usar HTTP 1.1.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Disable Connection Pooling</strong></td><td>Quando ativado, impede que as conexões sejam reutilizadas. Recomendado para endpoints com problemas de reutilização de conexões.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Invalidate SSL Sessions on Every Call</strong></td><td>Quando ativado, invalida as sessões SSL para cada solicitação. Recomendado para endpoints com problemas de reutilização de sessões SSL. Esta configuração torna o conector de thread único, o que significa que todas as execuções serão executadas sequencialmente para o mesmo conector REST no pipeline.</td><td>False</td><td>Booleano</td></tr></tbody></table>

### **Aba Documentation**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Seção para documentar qualquer informação necessária sobre a configuração do conector e regras de negócio.</td><td>N/A</td><td>String</td></tr></tbody></table>

## **Exemplos de uso**

### **Buscar uma Transaction**

Retorna uma Transaction especificada.

#### **Configuração do conector**

* **Host:** [`https://api.orderful.com`](https://api.orderful.com)
* **Path:** `/v3/transactions/{transactionId}`
* **Method:** `GET`
* **Path {transactionId}:** `451158757`

#### **Saída**

```json
{
  "status": 200,
  "statusMessage": "",
  "body": {
    "id": "451158757",
    "href": "https://api.orderful.com/v3/transactions/451158757",
    "version": "v3",
    "sender": {
      "isaId": "ODFLDIGIBEE",
      "isaIdQualifier": "ZZ",
      "testIsaId": "ODFLDIGIBEET",
      "testIsaIdQualifier": "ZZ",
      "name": "Digibee Demo "
    },
    "receiver": {
      "isaId": "008965063",
      "isaIdQualifier": "01",
      "testIsaId": "TST1WALGREECFDC",
      "testIsaIdQualifier": "ZZ",
      "name": "Walgreens DC (Domestic Distribution Centers, Import, Direct to store, Corporate)"
    },
    "type": {
      "name": "810_INVOICE"
    },
    "stream": "TEST",
    "businessNumber": "1017538",
    "referenceIdentifiers": [
      {
        "value": "120",
        "type": "GROUP",
        "owner": "RECEIVER"
      },
      {
        "value": "000000120",
        "type": "INTERCHANGE",
        "owner": "RECEIVER"
      },
      {
        "value": "0001",
        "type": "TRANSACTION",
        "owner": "RECEIVER"
      }
    ],
    "message": {
      "href": "https://api.orderful.com/v3/transactions/451158757/message"
    },
    "validationStatus": "VALID",
    "deliveryStatus": "DELIVERED",
    "acknowledgmentStatus": "ACCEPTED",
    "createdAt": "2024-11-18T15:43:43.594Z",
    "lastUpdatedAt": "2025-03-06T19:52:07.458Z",
    "acknowledgment": {
      "href": "https://api.orderful.com/v3/transactions/451158757/acknowledgment"
    }
  },
  "headers": {
    "access-control-allow-credentials": "true",
    "content-type": "application/json; charset=utf-8",
    "date": "Fri, 07 Mar 2025 12:40:55 GMT",
    "etag": "W/\"40e-txsYlxSZ++96fjXHVRmW/6ddjWI\"",
    "strict-transport-security": "max-age=60",
    "vary": "Origin, Accept-Encoding",
    "x-correlation-id": "21b8157e-7303-4394-bd97-3f99b9ae111c",
    "x-powered-by": "Express",
    "x-ratelimit-limit": "500",
    "x-ratelimit-remaining": "498",
    "x-ratelimit-reset": "3"
  }
}
```

### **Listar Relationships**

Retorna uma lista paginada dos Relationships da Organização atual.

#### **Configuração do conector**

* **Host:** [`https://api.orderful.com`](https://api.orderful.com)
* **Path:** `/v3/relationships`
* **Method:** `GET`
* **Query {limit}:** `2`

#### **Saída**

```json
{
  "status": 200,
  "statusMessage": "",
  "body": {
    "data": [
      {
        "id": 56092,
        "createdAt": "2023-12-12T19:42:23.948Z",
        "updatedAt": "2024-07-12T00:49:22.138Z",
        "sender": {
          "ediAccountId": 20205,
          "liveIsaId": "ODFLRETAILLEAD",
          "testIsaId": "ODFLRETAILLEADT",
          "organizationName": "Retail Leader",
          "ediAccountName": "Retail Leader",
          "organizationId": 21584
        },
        "receiver": {
          "ediAccountId": 9016,
          "liveIsaId": "ODFLDIGIBEE",
          "testIsaId": "ODFLDIGIBEET",
          "organizationName": "Digibee Demo ",
          "ediAccountName": "Digibee Demo ",
          "organizationId": 10262
        },
        "transactionType": {
          "name": "860_PURCHASE_ORDER_CHANGE_REQUEST_BUYER_INITIATED"
        },
        "status": "SETUP",
        "autoSend": "ENABLED"
      },
      {
        "id": 56089,
        "createdAt": "2023-12-12T19:42:23.948Z",
        "updatedAt": "2024-07-12T00:49:22.138Z",
        "sender": {
          "ediAccountId": 9016,
          "liveIsaId": "ODFLDIGIBEE",
          "testIsaId": "ODFLDIGIBEET",
          "organizationName": "Digibee Demo ",
          "ediAccountName": "Digibee Demo ",
          "organizationId": 10262
        },
        "receiver": {
          "ediAccountId": 20205,
          "liveIsaId": "ODFLRETAILLEAD",
          "testIsaId": "ODFLRETAILLEADT",
          "organizationName": "Retail Leader",
          "ediAccountName": "Retail Leader",
          "organizationId": 21584
        },
        "transactionType": {
          "name": "846_INVENTORY_INQUIRY_ADVICE"
        },
        "status": "TEST",
        "autoSend": "ENABLED"
      }
    ],
    "metadata": {
      "pagination": {
        "links": {
          "next": "https://api.orderful.com/v3/relationships?limit=2&nextCursor=NTYwODk%3D",
          "prev": null
        }
      }
    }
  },
  "headers": {
    "access-control-allow-credentials": "true",
    "content-type": "application/json; charset=utf-8",
    "date": "Fri, 07 Mar 2025 12:38:14 GMT",
    "etag": "W/\"4e5-FUmZsYb18ZcR71xBY25ReIZvEik\"",
    "strict-transport-security": "max-age=60",
    "vary": "Origin, Accept-Encoding",
    "x-correlation-id": "a9e3e851-5f57-42f7-823a-f942b95b4ee6",
    "x-powered-by": "Express",
    "x-ratelimit-limit": "500",
    "x-ratelimit-remaining": "499",
    "x-ratelimit-reset": "60"
  }
}
```