StateSet API Docs

curl --request GET \
  --url 'https://edi.stateset.com/v1/connectors' \
  --header 'Authorization: Bearer YOUR_API_KEY'

[
  {
    "category": "string",
    "delimiters": {
      "component": ">",
      "element": "*",
      "repetition": "string",
      "segment": "~"
    },
    "display_name": "string",
    "inbound_sets": [
      "string"
    ],
    "name": "string",
    "notes": "string",
    "outbound_sets": [
      "string"
    ],
    "partner_isa_qualifier": "string",
    "validation": {
      "accepted_inbound": [],
      "conditional_rules": [],
      "count_checks": {},
      "element_constraints": [],
      "required_qualified": {},
      "required_references": {},
      "required_segments": {},
      "segment_cardinality": {}
    },
    "version": "string"
  }
]

GET

connectors

curl --request GET \
  --url 'https://edi.stateset.com/v1/connectors' \
  --header 'Authorization: Bearer YOUR_API_KEY'

[
  {
    "category": "string",
    "delimiters": {
      "component": ">",
      "element": "*",
      "repetition": "string",
      "segment": "~"
    },
    "display_name": "string",
    "inbound_sets": [
      "string"
    ],
    "name": "string",
    "notes": "string",
    "outbound_sets": [
      "string"
    ],
    "partner_isa_qualifier": "string",
    "validation": {
      "accepted_inbound": [],
      "conditional_rules": [],
      "count_checks": {},
      "element_constraints": [],
      "required_qualified": {},
      "required_references": {},
      "required_segments": {},
      "segment_cardinality": {}
    },
    "version": "string"
  }
]

Query parameters

string

Retail vertical, e.g. beauty

Response

Connector[] — each element:

string

Retail vertical, e.g. beauty, department, club, off-price. Lets callers narrow the catalog (a beauty vendor wants the beauty channels).

Delimiters

Show Delimiters

string

required

string

required

string

required

string

required

string[]

required

Transaction sets the retailer sends us (we parse and acknowledge).

string

required

Stable lookup key, e.g. walmart.

string

required

string[]

required

Transaction sets we send the retailer.

string

required

The retailer’s typical ISA interchange ID qualifier (01 DUNS, 08 UCC/EAN, 12 phone, ZZ mutually defined). Override per relationship.

PartnerValidation

required

Show PartnerValidation

string[]

If non-empty, inbound transaction sets not in this list are rejected (e.g. ['850', '860'] for a partner that only sends orders).

ConditionalRule[]

If-then rules, e.g. ‘when BEG02 is SA, a DTM segment is required’.

Show ConditionalRule

string[]

Trigger values. Empty means ‘when the element is present (non-empty)’.

object

string

Then this segment must be present somewhere in the transaction.

integer

required

string

required

Trigger: segment tag + 1-based element position.

object

Count-balancing rules per inbound transaction set — CTT01 must equal the number of PO1 segments and friends. Checked only when the counter segment is present (pair with required_segments to mandate it).

ElementConstraint[]

Element-level constraints applied to matching segments anywhere in an inbound document — e.g. pin PO1-03 (unit of measure) to an allowed set.

Show ElementConstraint

string[]

If non-empty, the element must be one of these values.

integer

required

1-based element position, e.g. 3 for the PO1 unit of measure.

object

integer

Maximum length (in characters) when the element is present.

integer

Minimum length (in characters) when the element is present.

boolean

If true, the element must be present (non-empty).

string

required

Segment tag, e.g. PO1.

object

Qualified-segment requirements per inbound transaction set — the guide staple required_references can’t reach beyond REF: ‘a DTM*002 (delivery date) must be present’, ‘an N1 loop with N101=ST’. The '*' key applies to every set.

object

REF qualifiers that must be present per inbound transaction set, e.g. {'850': ['DP']} to require a department-number reference on every PO.

object

Segment tags that must be present per inbound transaction set, e.g. {'850': ['DTM', 'REF']} to require a date and reference on every PO. The '*' key applies to every inbound set.

object

Occurrence bounds per inbound transaction set, e.g. {'850': [{'segment': 'BEG', 'min': 1, 'max': 1}]} for ‘exactly one BEG’ or a guide’s ‘max 200 PO1 lines’. The '*' key applies to every set; a set-specific rule for the same segment takes precedence.

string

required

GS08 version/release, e.g. 004010.

Status codes

Code	Meaning
`200`	Available retailer connectors
`403`	Admin credential required

curl --request GET \
  --url 'https://edi.stateset.com/v1/connectors' \
  --header 'Authorization: Bearer YOUR_API_KEY'

[
  {
    "category": "string",
    "delimiters": {
      "component": ">",
      "element": "*",
      "repetition": "string",
      "segment": "~"
    },
    "display_name": "string",
    "inbound_sets": [
      "string"
    ],
    "name": "string",
    "notes": "string",
    "outbound_sets": [
      "string"
    ],
    "partner_isa_qualifier": "string",
    "validation": {
      "accepted_inbound": [],
      "conditional_rules": [],
      "count_checks": {},
      "element_constraints": [],
      "required_qualified": {},
      "required_references": {},
      "required_segments": {},
      "segment_cardinality": {}
    },
    "version": "string"
  }
]

Overview

Partners

Inbound

Outbound

Operations

System

Lists the built-in retailer connectors, optionally filtered by vertical.

Query parameters

Response

Status codes

​Query parameters

​Response

​Status codes

Query parameters

Response

Status codes