Publishes an outbound 832 price/sales catalog to a partner.

Wire-ready X12 832 interchange

POST /v1/edi/outbound/832/{partner_id}

cURL

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.edi.stateset.com/v1/edi/outbound/832/{partner_id}' \
  --header "Authorization: Bearer $EDI_API_TOKEN" \
  --header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
  --header 'Content-Type: application/json' \
  --data '{
  "catalog_number": "string",
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "items": [
    {
      "description": "Two-person tent, green — replacement for damaged pole set.",
      "ids": [
        {
          "qualifier": "string",
          "value": "49.00"
        }
      ],
      "pack_size": "string",
      "prices": [
        {
          "price": "49.00",
          "qualifier": "string"
        }
      ]
    }
  ],
  "purpose": "string"
}'

Path parameters

partner_id · string · required

Partner ID

Headers

Idempotency-Key · string,null

Stable unique request key (1–128 ASCII letters/digits or -_.:). Requires Postgres. Retries return the original EDI bytes; changed JSON payload returns 409.

Request body

Catalog832

catalog_number · string,null

BCT02 — catalog number / identifier.

description · string,null

BCT07 — catalog description, when present.

items · CatalogItem[] · required

Show CatalogItem

description · string,null

PID-05 — free-form item description.

ids · ProductId[]

LIN qualifier/value identifier pairs (UP UPC, VN vendor part, BP buyer part, …).

Show ProductId

qualifier · string · required

value · string · required

pack_size · string,null

PO4 pack size (PO4-01 inner pack quantity), when present.

prices · CatalogPrice[]

CTP pricing by price type code (CTP-02 qualifier → CTP-03 price).

Show CatalogPrice

price · string · required

CTP-03 unit price.

qualifier · string · required

CTP-02 price-qualifier code (e.g. RES resale, UCP unit cost, LIS list). Defaults to an empty qualifier when the segment omits it.

purpose · string,null

BCT01 — catalog purpose code (e.g. 00 original, 01 cancel, 05 replace).

Response

No response body. Wire-ready X12 832 interchange.

Status codes

Code	Meaning
200	Wire-ready X12 832 interchange
403	Not this credential’s partner
409	Idempotency-Key reused with a different payload
422	Invalid payload

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 POST \
  --url 'https://api.edi.stateset.com/v1/edi/outbound/832/{partner_id}' \
  --header "Authorization: Bearer $EDI_API_TOKEN" \
  --header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
  --header 'Content-Type: application/json' \
  --data '{
  "catalog_number": "string",
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "items": [
    {
      "description": "Two-person tent, green — replacement for damaged pole set.",
      "ids": [
        {
          "qualifier": "string",
          "value": "49.00"
        }
      ],
      "pack_size": "string",
      "prices": [
        {
          "price": "49.00",
          "qualifier": "string"
        }
      ]
    }
  ],
  "purpose": "string"
}'