Runs a retailer sandbox scenario for a **test** partner: synthesizes the…

Per-step processing results: document ids, statuses, and generated acknowledgments

POST /v1/sandbox/{partner_id}/scenarios/{scenario}

cURL

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.edi.stateset.com/v1/sandbox/{partner_id}/scenarios/{scenario}' \
  --header "Authorization: Bearer $EDI_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "lines": [
    {
      "description": "Two-person tent, green — replacement for damaged pole set.",
      "quantity": "2",
      "sku": "SKU-TENT-2P-GRN",
      "sku_qualifier": "string",
      "unit_price": "49.00",
      "uom": "string"
    }
  ],
  "new_quantity": "string",
  "po_number": "ORD-10042"
}'

Path parameters

partner_id · string · required

Test partner ID

scenario · string · required

po | po_change | po_cancel | bad_po

Request body

SandboxRequest,null

lines · SandboxLine[]

PO lines (default: one line of 12 units).

Show SandboxLine

description · string,null

quantity · string · required

sku · string · required

sku_qualifier · string,null

PO1 identifier qualifier for sku (default VN).

unit_price · string,null

uom · string,null

Unit of measure (default: the partner guide’s first allowed PO103, else EA).

new_quantity · string,null

po_change: the new quantity for line 1 (default: half the ordered quantity, at least 1).

po_number · string,null

PO number for the synthetic 850 (default SBX-<random>). Ignored by bad_po, which omits it on purpose.

Response

No response body. Per-step processing results: document ids, statuses, and generated acknowledgments.

Status codes

Code	Meaning
200	Per-step processing results: document ids, statuses, and generated acknowledgments
403	Not this credential’s partner
404	Unknown partner
409	Partner is not a test (usage T) partner
422	Unknown scenario or invalid body

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/sandbox/{partner_id}/scenarios/{scenario}' \
  --header "Authorization: Bearer $EDI_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "lines": [
    {
      "description": "Two-person tent, green — replacement for damaged pole set.",
      "quantity": "2",
      "sku": "SKU-TENT-2P-GRN",
      "sku_qualifier": "string",
      "unit_price": "49.00",
      "uom": "string"
    }
  ],
  "new_quantity": "string",
  "po_number": "ORD-10042"
}'