Orderful

Saiba mais sobre o conector Orderful e como usá-lo na Digibee Integration Platform.

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 estão marcados com (DB).

Aba General

Parâmetro	Descrição	Valor padrão	Tipo de dado
Account	A conta usada pelo conector. Tipo suportado: Secret Key.	N/A	Account
Fail On Error	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 "success".	False	Booleano

Aba Host

Parâmetro	Descrição	Valor padrão	Tipo de dado
Host (DB)	A URL base da API do Orderful. Recomendamos o uso de HTTPS.	N/A	String
Path	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 API do Orderful.	N/A	String
Method	O método HTTP usado para a solicitação.	N/A	String

Aba Settings

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

Aba Documentation

Parâmetro	Descrição	Valor padrão	Tipo de dado
Documentation	Seção para documentar qualquer informação necessária sobre a configuração do conector e regras de negócio.	N/A	String

Exemplos de uso

Buscar uma Transaction

Retorna uma Transaction especificada.

Configuração do conector

• Host: https://api.orderful.com

• Path: /v3/transactions/{transactionId}

• Method: GET

• Path {transactionId}: 451158757

Saída

{
  "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

• Path: /v3/relationships

• Method: GET

• Query {limit}: 2

Saída

{
  "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"
  }
}