SAsamsara
Beta APIs

[beta] Create a vendor location

Creates a maintenance vendor location linked to a live Place in this organization. First create or reuse an Address through the public Addresses API and set addressId to its returned data.id (the Place ID). The Place owns the location's name, address, and notes. Use addressId as {id} in GET /addresses/{id} to retrieve data.name, data.formattedAddress, and data.notes, and PATCH /addresses/{id} to update name, formattedAddress, and notes. These calls require Read Addresses and Write Addresses permissions, respectively. Mutation responses expose the same Address/Place ID as placeId.id; location lists return it as addressId. This endpoint does not create Places. Legacy vendor-stored notes are separate and are not exposed or copied to the Place. parentVendorId is optional.

<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write Work Orders under the Work Orders category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

post/fleet/maintenance/vendor-locations

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

includeExternalIdsboolean

Include externalIds in the response. Defaults to false.

Request body

addressIdstring required

Linked place identifier for the vendor address.

emailAddressesstring[]

Email addresses for the vendor.

isMobileboolean

Whether this vendor provides mobile service. When unset, the profile or system default applies.

isPreferredboolean

Whether this vendor location is preferred. When unset, the profile or system default applies.

parentVendorIdstring

Parent vendor UUID. Null removes membership while preserving explicit overrides.

payeeIdstring

Free-text AP/ERP payee identifier for the vendor. Not a reference to a Samsara entity.

phoneNumbersstring[]

Phone numbers for the vendor.

servicesProvidedstring

Description of services provided by the vendor.

status'active' | 'inactive' | 'unknown'

Own lifecycle status. Defaults to active. Unknown is read-only. Valid values: active, inactive, unknown

vendorIdstring

User-defined identifier for the vendor.

Example request

{
  "addressId": "281474976710656",
  "assetAttributeSelections": [
    {
      "attributeId": "12345",
      "values": [
        {
          "id": "12345"
        }
      ]
    }
  ],
  "contacts": [
    {
      "email": "12345",
      "name": "12345",
      "phoneNumber": "12345"
    }
  ],
  "defaultLaborRatePerHour": {
    "amount": "12345",
    "currency": "12345"
  },
  "emailAddresses": [
    "12345",
    "12345",
    "12345"
  ],
  "externalIds": [
    {
      "key": "12345",
      "value": "12345"
    }
  ],
  "isMobile": true,
  "isPreferred": true,
  "parentVendorId": "12345",
  "payeeId": "12345",
  "phoneNumbers": [
    "12345",
    "12345"
  ],
  "servicesProvided": "12345",
  "status": "active",
  "vendorId": "12345"
}

Response

OK response.

Example response

{
  "data": {
    "assetAttributeSelections": [
      {
        "attributeId": "12345",
        "values": [
          {
            "id": "12345"
          }
        ]
      }
    ],
    "contacts": [
      {
        "email": "12345",
        "name": "12345",
        "phoneNumber": "12345"
      }
    ],
    "defaultLaborRatePerHour": {
      "amount": "12345",
      "currency": "12345"
    },
    "emailAddresses": [
      "12345",
      "12345",
      "12345"
    ],
    "externalId": "12345",
    "externalIds": [
      {
        "key": "12345",
        "value": "12345"
      }
    ],
    "id": "12345",
    "isMobile": true,
    "isPreferred": true,
    "parentVendorId": "12345",
    "payeeId": "12345",
    "phoneNumbers": [
      "12345",
      "12345",
      "12345"
    ],
    "placeId": {
      "id": "281474976710656"
    },
    "servicesProvided": "12345",
    "status": "active",
    "vendorId": "12345"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.