Skip to main content

Parties API

Manage exporter, importer, and notify party profiles.

Create Party​

POST /api/v1/parties

Request Body​

{
  "name": "Acme Corp",
  "address": "123 Export St",
  "city": "Los Angeles",
  "state": "CA",
  "postal_code": "90001",
  "country": "US",
  "tax_ids": {
    "ein": "12-3456789"
  },
  "contact_email": "export@acme.com",
  "contact_phone": "+1-555-0100"
}

Response​

{
  "id": "party_a1b2c3d4",
  "name": "Acme Corp",
  "country": "US",
  "created_at": "2026-03-31T10:00:00Z"
}

List Parties​

GET /api/v1/parties

Query Parameters​

ParameterTypeDescription
searchstringSearch by name
countrystringFilter by country code

Get Party​

GET /api/v1/parties/:id

Update Party​

PATCH /api/v1/parties/:id

Delete Party​

DELETE /api/v1/parties/:id