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.

Body·

required
application/json
  • externalId
    Type: string
    max length:  
    255
    required

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

  • name
    Type: string
    max length:  
    255
    required
  • address
    Type:

    Address as posted. An omitted country resolves to US.

    Properties: 6
  • email
    Type: stringFormat: emailnullable
  • notes
    Type: stringnullable
  • phone
    Type: stringnullable

    Normalized to E.164.

  • phoneExtension
    Type: string
    max length:  
    30    nullable

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v2/facilities
curl https://api.prod.goaugment.com/v2/facilities \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "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",
  "notes": ""
}'

{
  "facilityId": "string",
  "externalId": "string",
  "name": "string",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "stateOrProvince": "string",
    "postalCode": "string",
    "country": "string"
  },
  "email": "string",
  "phone": "string",
  "phoneExtension": "string",
  "notes": "string"
}

Facility created or updated

Previous
Facility Management
Next
Bulk create or update facilities