SmartWay™ API Docs

Required Header

x-smartway-api-key: YOUR_API_KEY
Content-Type: application/json

Business Partners

Business Partner records are staged before processing. During processing, SmartWay resolves the partner, creates role assignments, and creates customer relationships.

• Matches existing Business Partners.
• Creates new Business Partners when necessary.
• Creates Partner Role Assignments.
• Creates Customer Relationships.
• Prevents duplicate relationships.
• Maintains complete processing history and audit records.

Endpoint

POST /api/external/v1/import/business-partners

Required Fields

• partnerName
• taxID
• taxTypeID
• website
• relationshipDirection — Source or Target
• relationshipTypeID
• relationshipStatusID
• partnerRoleIDs

Relationship Direction

Use Source when the imported Business Partner is the source of the relationship. Use Target when the imported Business Partner is the target of the relationship.

Sample Request

{
  "sourceSystem": "TestERP",
  "externalBatchID": "BP-REL-001",
  "records": [
    {
      "externalPartnerID": "VEND-1001",
      "partnerName": "ABC Industrial Supply",
      "addressLine1": "123 Main St",
      "city": "Laredo",
      "stateProvince": "TX",
      "postalCode": "78040",
      "country": "USA",
      "taxID": "123456789",
      "taxTypeID": 1,
      "website": "abcindustrial.com",
      "accountNum": "ABC-1001",
      "scopeDescription": "Primary warehouse supplier",
      "relationshipDirection": "Target",
      "relationshipTypeID": 7,
      "relationshipStatusID": 1,
      "relationshipStartDate": "2026-06-29T00:00:00",
      "relationshipEndDate": null,
      "cxInternalTrackingID": "ERP-VEND-1001",
      "isCriticalRelationship": true,
      "isOnSiteAccessGranted": false,
      "isLimitedDataAccessGranted": true,
      "isSensitiveDataAccessGranted": false,
      "isSubjectToCerts": true,
      "isSubjectToRegulatedControl": true,
      "isPermitControls": false,
      "isEscalated": false,
      "escalatedAt": null,
      "isIndirect": false,
      "isCustomer": false,
      "isSubjectToContractRenewal": false,
      "lastContractRenewalAt": null,
      "partnerRoleIDs": [2, 5, 7]
    }
  ]
}

Business Partner Contacts

Business Partner Contacts are staged after Business Partners. These records must include externalPartnerID so SmartWay can link the contact to the resolved Business Partner.

• Resolves the associated Business Partner.
• Matches existing contacts.
• Creates new contacts when required.
• Associates contacts with one or more Partner Roles.
• Creates Customer Contact Relationships.
• Prevents duplicate contact assignments.

Endpoint

POST /api/external/v1/import/business-partner-contacts

Required Fields

• externalPartnerID
• partnerContactTypeID
• At least one of: firstName, lastName, or emailPrimary

Optional Fields

• externalContactID
• parentExternalContactID
• title
• emailOther
• phoneMobile
• phoneOffice
• phoneOther
• phoneOtherDesc
• isPrimary
• acceptedAt

Sample Request

    {
    "sourceSystem": "TestERP",
    "externalBatchID": "BP-CON-001",
    "records": [
    {
    "externalPartnerID": "VEND-1001",
    "externalContactID": "CONT-2001",
    "partnerContactTypeID": 1,
    "title": "Export Manager",
    "emailPrimary": "maria.garcia@vendor.com",
    "phoneOffice": "956-555-4000",
    "firstName": "Maria",
    "lastName": "Garcia",
    "isPrimary": true,
    "acceptedAt": "2026-06-29T00:00:00"
    }
    ]
    }

Business Partner Processing

Business Partner Flow

Business Partner API
        │
        ▼
SWPartnerImportStage
        │
        ▼
Partner Validation
        │
        ▼
Partner Resolution
        │
        ▼
SWPartners
        │
        ▼
Partner Role Assignments
        │
        ▼
Customer Relationships

Business Partner Contact Flow

Business Partner Contact API
        │
        ▼
SWPartnerContactImportStage
        │
        ▼
Partner Resolution
        │
        ▼
SWPartnerContacts
        │
        ▼
CXPartnerContacts

Business Partner and Business Partner Contact imports are asynchronous. Records are staged first and then processed by SmartWay to perform validation, duplicate detection, partner resolution, and relationship creation.

Direct Import Services

Direct import endpoints insert records after API key validation and basic payload checks. These records are customer-owned.

Standard Success Responses

Direct Import Response

{
  "status": "Completed",
  "recordsImported": 1,
  "insertedIds": [1001],
  "sourceSystem": "TestERP",
  "externalBatchId": "TEST-001",
  "message": "Records imported successfully."
}

Staged Import Response

{
  "status": "Staged",
  "recordsStaged": 1,
  "stagedIds": [101],
  "sourceSystem": "TestERP",
  "externalBatchId": "BP-001",
  "message": "Records staged for SmartWay validation and relationship processing."
}

Error Responses