Facility Management

Create or update a facility

Create or update a single facility, keyed on the externalId you send. An externalId not yet seen for your brokerage creates a facility; one already stored updates it.

This is a whole-record replace, not a partial update. Any field omitted from the body is cleared on an existing facility rather than left as it was. Send the complete record on every call. Posting a facility without notes, for example, erases notes already stored against it.

post/v2/facilities

Request

Base URL
https://api.prod.goaugment.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/goaugment/apis/augment-api/docs/v2/facilities/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

externalIdstring required

Your identifier for the facility. Used as the upsert key.

namestring required

emailstring email nullable

phonestring nullable

Normalized to E.164.

phoneExtensionstring nullable

notesstring nullable

Example request

{
  "externalId": "EXP-00142",
  "name": "Houston Distribution Center",
  "address": {
    "street1": "1200 W Loop S",
    "street2": "Suite 400",
    "city": "Houston",
    "stateOrProvince": "TX",
    "postalCode": "77027",
    "country": "US"
  },
  "email": "dock@example.com",
  "phone": "+17135550100",
  "phoneExtension": "204"
}

Response

Facility created or updated

facilityIdstring

Augment's identifier for the facility.

externalIdstring nullable

namestring

emailstring nullable