Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Location Contacts

Create a new location contact

Link a customer contact to a location with specific contact types/roles.

Location contacts represent the relationship between a customer contact and a specific location, defining what role the contact has at that location.

post/location-contacts

Request body

locationIdstring uuid required

Location this contact is associated with (required)

customerContactIdstring uuid required

Customer contact to link to this location (required)

isPrimaryboolean required

Whether this is the primary contact for the location (required)

contactTypesLocationContactType[]

Roles/types for this location contact

keystring

Client-defined reference identifier

Example request

{
  "locationId": "770e8400-e29b-41d4-a716-446655440000",
  "customerContactId": "660e8400-e29b-41d4-a716-446655440000",
  "isPrimary": true,
  "contactTypes": [
    "LOCATION_MANAGER",
    "SHIPPING"
  ],
  "key": "ERP-LOC-CONTACT-001"
}

Response

Location contact created successfully

object'LOCATION_CONTACT'

Object type identifier

idstring uuid required

Unique location contact identifier

locationIdstring uuid required

Location this contact is associated with

customerContactIdstring uuid required

Customer contact linked to this location

isPrimaryboolean required

Whether this is the primary contact for the location

contactTypesLocationContactType[]

Roles/types for this location contact

keystring nullable

Client-defined reference identifier for this location contact

createdAtstring date-time required

Timestamp when location contact was created

updatedAtstring date-time required

Timestamp when location contact was last updated

deletedAtstring date-time nullable

Timestamp when location contact was soft-deleted (null if active)

Example response

{
  "object": "LOCATION_CONTACT",
  "id": "880e8400-e29b-41d4-a716-446655440000",
  "locationId": "770e8400-e29b-41d4-a716-446655440000",
  "location": {
    "object": "LOCATION",
    "id": "770e8400-e29b-41d4-a716-446655440000",
    "customerId": "550e8400-e29b-41d4-a716-446655440000",
    "customer": {
      "object": "CUSTOMER",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Acme Manufacturing Corp",
      "friendlyId": "A123456",
      "website": "https://acme-manufacturing.com",
      "phoneNumber": "+1-555-123-4567",
      "naics": "336411",
      "ein": "12-3456789",
      "duns": "123456789",
      "leadSource": "Referral",
      "dbaName": "Acme Corp DBA",
      "externalId": "EXT-12345",
      "creditLimit": 50000,
      "creditUsageWarning": 40000,
      "freeCreditReq": 5000,
      "defaultMargin": 0.15,
      "minMargin": 0.1,
      "maxMargin": 0.25,
      "defaultInternalNotes": "Contact via email only",
      "defaultCarrierNotes": "Call pickup contact before arrival",
      "defaultExternalNotes": "Please call 1 hour before delivery",
      "group": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345"
      },
      "paymentTerm": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-PAYTERM-NET30",
        "name": "Net 30",
        "description": "Payment due 30 days from invoice date",
        "days": 30,
        "quickPayFee": 0.05,
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "notes": "Prefers email communication",
      "closedBy": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone": "+1-555-123-4567",
        "phoneExt": "123",
        "status": "ACTIVE",
        "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "corporateAddress": {
        "line1": "123 Main St",
        "line2": "Suite 400",
        "city": "Chicago",
        "country": "USA",
        "market": "CHI",
        "latitude": "41.8781",
        "longitude": "-87.6298",
        "isSmartyValidated": true,
        "obeysDst": true
      },
      "billingAddress": {
        "line1": "123 Main St",
        "line2": "Suite 400",
        "city": "Chicago",
        "country": "USA",
        "market": "CHI",
        "latitude": "41.8781",
        "longitude": "-87.6298",
        "isSmartyValidated": true,
        "obeysDst": true
      },
      "key": "ERP-CUSTOMER-12345",
      "contacts": [
        {
          "object": "CUSTOMER_CONTACT",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "key": "ERP-CONTACT-JOHN-001",
          "name": "John Smith",
          "contactInfo": {
            "name": "John Smith",
            "email": "john.smith@example.com",
            "phoneNumber": "+1-555-0100",
            "title": "Operations Manager"
          },
          "phoneExtension": "1234",
          "isPrimary": true,
          "contactTypes": [
            "BILLING",
            "ACCOUNT_MANAGER"
          ],
          "notifications": [
            "SHIPMENT_PICKED_UP",
            "SHIPMENT_DELIVERED"
          ],
          "invitedUser": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-USER-12345",
            "email": "john.doe@example.com",
            "name": "John Doe",
            "phone": "+1-555-123-4567",
            "phoneExt": "123",
            "status": "ACTIVE",
            "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "createdAt": "2025-01-15T10:00:00Z",
            "updatedAt": "2025-01-15T14:30:00Z"
          },
          "deletedBy": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-USER-12345",
            "email": "john.doe@example.com",
            "name": "John Doe",
            "phone": "+1-555-123-4567",
            "phoneExt": "123",
            "status": "ACTIVE",
            "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "createdAt": "2025-01-15T10:00:00Z",
            "updatedAt": "2025-01-15T14:30:00Z"
          },
          "createdAt": "2025-01-15T10:00:00Z"
        }
      ],
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z",
      "deletedBy": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345",
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phone": "+1-555-123-4567",
        "phoneExt": "123",
        "status": "ACTIVE",
        "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      }
    },
    "name": "ABC Warehouse - Dallas",
    "key": "ERP-LOC-DALLAS-01",
    "isAppointmentRequired": true,
    "notes": "Call 24 hours ahead for appointment",
    "internalNotes": "Use dock door 5 for expedited shipments",
    "contacts": [
      {
        "object": "LOCATION_CONTACT",
        "id": "880e8400-e29b-41d4-a716-446655440000",
        "customerContactId": "660e8400-e29b-41d4-a716-446655440000",
        "customerContact": {
          "object": "CUSTOMER_CONTACT",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "customer": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-CUSTOMER-ACME",
            "name": "Acme Manufacturing Corp",
            "friendlyId": "A123456",
            "status": "ACTIVE",
            "phoneNumber": "+1-555-123-4567",
            "website": "https://acme-manufacturing.com",
            "createdAt": "2025-01-15T10:00:00Z",
            "updatedAt": "2025-01-15T14:30:00Z"
          },
          "name": "John Smith",
          "contactInfo": {
            "name": "John Smith",
            "email": "john.smith@example.com",
            "phoneNumber": "+1-555-0100",
            "title": "Operations Manager"
          },
          "phoneExtension": "1234",
          "isPrimary": true,
          "contactTypes": [
            "BILLING",
            "ACCOUNT_MANAGER"
          ],
          "notifications": [
            "SHIPMENT_PICKED_UP",
            "SHIPMENT_DELIVERED"
          ],
          "invitedUser": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-USER-12345",
            "email": "john.doe@example.com",
            "name": "John Doe",
            "phone": "+1-555-123-4567",
            "phoneExt": "123",
            "status": "ACTIVE",
            "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "createdAt": "2025-01-15T10:00:00Z",
            "updatedAt": "2025-01-15T14:30:00Z"
          },
          "deletedBy": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "key": "ERP-USER-12345",
            "email": "john.doe@example.com",
            "name": "John Doe",
            "phone": "+1-555-123-4567",
            "phoneExt": "123",
            "status": "ACTIVE",
            "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "createdAt": "2025-01-15T10:00:00Z",
            "updatedAt": "2025-01-15T14:30:00Z"
          },
          "key": "ERP-CONTACT-JOHN-001",
          "createdAt": "2025-01-15T10:00:00Z"
        },
        "isPrimary": true,
        "contactTypes": [
          "LOCATION_MANAGER",
          "SHIPPING"
        ],
        "key": "ERP-LOC-CONTACT-001",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      }
    ],
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "customerContactId": "660e8400-e29b-41d4-a716-446655440000",
  "customerContact": {
    "object": "CUSTOMER_CONTACT",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "customer": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "ERP-CUSTOMER-ACME",
      "name": "Acme Manufacturing Corp",
      "friendlyId": "A123456",
      "status": "ACTIVE",
      "phoneNumber": "+1-555-123-4567",
      "website": "https://acme-manufacturing.com",
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z"
    },
    "name": "John Smith",
    "contactInfo": {
      "name": "John Smith",
      "email": "john.smith@example.com",
      "phoneNumber": "+1-555-0100",
      "title": "Operations Manager"
    },
    "phoneExtension": "1234",
    "isPrimary": true,
    "contactTypes": [
      "BILLING",
      "ACCOUNT_MANAGER"
    ],
    "notifications": [
      "SHIPMENT_PICKED_UP",
      "SHIPMENT_DELIVERED"
    ],
    "invitedUser": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "ERP-USER-12345",
      "email": "john.doe@example.com",
      "name": "John Doe",
      "phone": "+1-555-123-4567",
      "phoneExt": "123",
      "status": "ACTIVE",
      "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z"
    },
    "deletedBy": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "ERP-USER-12345",
      "email": "john.doe@example.com",
      "name": "John Doe",
      "phone": "+1-555-123-4567",
      "phoneExt": "123",
      "status": "ACTIVE",
      "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z"
    },
    "key": "ERP-CONTACT-JOHN-001",
    "createdAt": "2025-01-15T10:00:00Z"
  },
  "isPrimary": true,
  "contactTypes": [
    "LOCATION_MANAGER",
    "SHIPPING"
  ],
  "key": "ERP-LOC-CONTACT-001",
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z"
}