The packaged back-end integration catalog (ERP/WMS/TMS/e-commerce/carrier),…

Back-end adapter catalog

GET /v1/adapters

cURL

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.edi.stateset.com/v1/adapters' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

[
  {
    "consumes_events": [
      "string"
    ],
    "display_name": "Ada Lovelace",
    "emits_documents": [
      "string"
    ],
    "kind": "erp",
    "name": "Two-Person Tent",
    "notes": "Two-person tent, green — replacement for damaged pole set.",
    "status": "ga",
    "vendor": "string"
  }
]

Query parameters

kind · string

System class filter

consumes · string

Canonical event type filter

Response

AdapterDescriptor[] — each element:

consumes_events · string[] · required

Inbound canonical VES event types this adapter writes into the back end.

display_name · string · required

emits_documents · string[] · required

Outbound X12 transaction sets this adapter originates from back-end state.

kind · AdapterKind · required

The class of system an adapter integrates. Allowed values: 'erp', 'wms', 'tms', 'ecommerce', 'carrier'.

name · string · required

Stable lookup key, e.g. netsuite.

notes · string · required

status · AdapterStatus · required

Delivery maturity of a packaged adapter. Allowed values: 'ga', 'beta', 'planned'.

vendor · string · required

Status codes

Code	Meaning
200	Back-end adapter catalog

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.

cURL

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.edi.stateset.com/v1/adapters' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

[
  {
    "consumes_events": [
      "string"
    ],
    "display_name": "Ada Lovelace",
    "emits_documents": [
      "string"
    ],
    "kind": "erp",
    "name": "Two-Person Tent",
    "notes": "Two-person tent, green — replacement for damaged pole set.",
    "status": "ga",
    "vendor": "string"
  }
]