StateSet API Docs

curl --request POST \
  --url 'https://edi.stateset.com/v1/commercial-invoice/{partner_id}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "buyer": {
    "address_lines": [
      "string"
    ],
    "city": "string",
    "country": "string",
    "name": "string",
    "postal_code": "string",
    "state": "string",
    "tax_id": "string"
  },
  "currency": "string",
  "freight": "string",
  "incoterms": "string",
  "incoterms_place": "string",
  "insurance": "string",
  "invoice_date": "string",
  "invoice_number": "string",
  "lines": [
    {
      "country_of_origin": "string",
      "description": "string",
      "hs_code": "string",
      "net_weight_kg": "string",
      "quantity": "string",
      "sku": "string",
      "unit_price": "string",
      "uom": "string"
    }
  ],
  "po_number": "string",
  "reason_for_export": "string",
  "seller": {
    "address_lines": [
      "string"
    ],
    "city": "string",
    "country": "string",
    "name": "string",
    "postal_code": "string",
    "state": "string",
    "tax_id": "string"
  },
  "ship_to": {
    "address_lines": [
      "string"
    ],
    "city": "string",
    "country": "string",
    "name": "string",
    "postal_code": "string",
    "state": "string",
    "tax_id": "string"
  }
}'

POST

commercial-invoice

{partner_id}

curl --request POST \
  --url 'https://edi.stateset.com/v1/commercial-invoice/{partner_id}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "buyer": {
    "address_lines": [
      "string"
    ],
    "city": "string",
    "country": "string",
    "name": "string",
    "postal_code": "string",
    "state": "string",
    "tax_id": "string"
  },
  "currency": "string",
  "freight": "string",
  "incoterms": "string",
  "incoterms_place": "string",
  "insurance": "string",
  "invoice_date": "string",
  "invoice_number": "string",
  "lines": [
    {
      "country_of_origin": "string",
      "description": "string",
      "hs_code": "string",
      "net_weight_kg": "string",
      "quantity": "string",
      "sku": "string",
      "unit_price": "string",
      "uom": "string"
    }
  ],
  "po_number": "string",
  "reason_for_export": "string",
  "seller": {
    "address_lines": [
      "string"
    ],
    "city": "string",
    "country": "string",
    "name": "string",
    "postal_code": "string",
    "state": "string",
    "tax_id": "string"
  },
  "ship_to": {
    "address_lines": [
      "string"
    ],
    "city": "string",
    "country": "string",
    "name": "string",
    "postal_code": "string",
    "state": "string",
    "tax_id": "string"
  }
}'

commercial-invoice payload. Emits a signed edi.commercial_invoice.generated VES event. The response flags whether every line carries the HS code and country of origin a compliant declaration needs.

Path parameters

string

required

Partner ID

Request body

CommercialInvoice

CustomsParty

required

string

ISO currency code the values are expressed in.

string

Freight charge added to the customs value (when DDP/CIF style terms).

string

Incoterms 2020 three-letter rule, e.g. DAP, DDP, EXW.

string

Named place for the incoterm, e.g. Rotterdam.

string

Insurance charge added to the customs value.

string

required

string

required

CustomsLine[]

required

string

Why the goods are being exported (sale, sample, return, gift) — a CN22/23 and many national customs forms require it.

CustomsParty

required

object

Response

No response body — commercial invoice (structured + html).

Status codes

Code	Meaning
`200`	Commercial invoice (structured + HTML)
`403`	Not this credential’s partner
`422`	Invalid payload

curl --request POST \
  --url 'https://edi.stateset.com/v1/commercial-invoice/{partner_id}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "buyer": {
    "address_lines": [
      "string"
    ],
    "city": "string",
    "country": "string",
    "name": "string",
    "postal_code": "string",
    "state": "string",
    "tax_id": "string"
  },
  "currency": "string",
  "freight": "string",
  "incoterms": "string",
  "incoterms_place": "string",
  "insurance": "string",
  "invoice_date": "string",
  "invoice_number": "string",
  "lines": [
    {
      "country_of_origin": "string",
      "description": "string",
      "hs_code": "string",
      "net_weight_kg": "string",
      "quantity": "string",
      "sku": "string",
      "unit_price": "string",
      "uom": "string"
    }
  ],
  "po_number": "string",
  "reason_for_export": "string",
  "seller": {
    "address_lines": [
      "string"
    ],
    "city": "string",
    "country": "string",
    "name": "string",
    "postal_code": "string",
    "state": "string",
    "tax_id": "string"
  },
  "ship_to": {
    "address_lines": [
      "string"
    ],
    "city": "string",
    "country": "string",
    "name": "string",
    "postal_code": "string",
    "state": "string",
    "tax_id": "string"
  }
}'

Overview

Partners

Inbound

Outbound

Operations

System

Generates a commercial invoice / customs document from a canonical

Path parameters

Request body

Response

Status codes

​Path parameters

​Request body

​Response

​Status codes

Path parameters

Request body

Response

Status codes