Orderful

Discover more about the Orderful connector and how to use it on the Digibee Integration Platform.

Orderful streamlines EDI (Electronic Data Interchange) transactions. It enables integration with Orderful’s API, allowing you to send, receive, and manage EDI documents efficiently.

Parameters

Take a look at the configuration parameters for the connector. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter	Description	Default value	Data type
Account	The account used by the connector. Supported type: Secret Key.	N/A	Account
Fail On Error	If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	False	Boolean

Host tab

Parameter	Description	Default value	Data type
Host (DB)	The base URL of the Orderful API. We recommend using HTTPS.	N/A	String
Path	The specific Orderful endpoint to be accessed. Based on the selected path, additional options may be available for configuring query parameters or other required settings. For details on each endpoint, refer to the Orderful API documentation.	N/A	String
Method	The HTTP method used for the request.	N/A	String

Settings tab

Parameter	Description	Default value	Data type
Connect Timeout (ms)	Maximum time allowed for establishing a connection, in milliseconds.	30000	Integer
Read Timeout (ms)	Maximum time allowed for reading data, in milliseconds.	30000	Integer
Stop on Client Error	When enabled, stops the pipeline execution if a 4xx HTTP error occurs.	False	Boolean
Stop on Server Error	When enabled, stops the pipeline execution if a 5xx HTTP error occurs.	False	Boolean
Override Response Charset	When enabled, replaces the charset returned by the endpoint with the one specified in the Response Charset property. Otherwise, the charset from the Content-Type header is used.	True	Boolean
Response Charset	Defines the charset to be used when Override Response Charset is enabled.	UTF-8	String
Advanced Settings	Enables additional configuration options.	False	Boolean
Raw Mode	When enabled, allows sending or receiving a non-JSON payload.	False	Boolean
Save as Local File	When enabled, saves the response as a file in the local pipeline directory.	False	Boolean
Allow Insecure Endpoints	When enabled, permits calls to HTTPS endpoints without enforcing security checks.	False	Boolean
Enable Retries	When enabled, retries requests in case of server errors.	False	Boolean
Compress Body with GZIP	When enabled, compresses the request body using GZIP.	False	Boolean
Force HTTP 1.1	When enabled, forces the request to use HTTP 1.1.	False	Boolean
Disable Connection Pooling	When enabled, prevents connections from being reused. Recommended for endpoints with connection reuse issues.	False	Boolean
Invalidate SSL Sessions on Every Call	When enabled, invalidates SSL sessions for each request. Recommended for endpoints with SSL session reuse issues. This setting makes the connector single-threaded, meaning all executions will run sequentially for the same REST connector in the pipeline.	False	Boolean

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Section for documenting any necessary information about the connector configuration and business rules.	N/A	String

Usage examples

Get a Transaction

Returns the specified Transaction.

Connector’s configuration

• Host: https://api.orderful.com
• Path: /v3/transactions/{transactionId}

• Method: GET

• Path {transactionId}: 451158757

Output

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

List Relationships

Retrieves a paginated list of the Relationships for the current Organization.

Connector’s configuration

• Host: https://api.orderful.com
• Path: /v3/relationships

• Method: GET

• Query {limit}: 2

Output

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