Open a new location

Set up a new place of business — where it is, what it’s called, and how it operates.

Manage · a play in 3 steps.

The steps

1. Record the street address — the place itself. — createPhysicalFacilityLocation
2. Put your building at that address. — createPhysicalFacility
3. Open the operation inside it — the store or warehouse you’ll run. — createLogicalFacility

The calls

Every operation this use case runs, in the order it first appears, with the request and the response its reference page shows.

createPhysicalFacilityLocation

createPhysicalFacilityLocation — mutation · Create a new facility address — where a physical facility sits at your organization.

Example request

mutation ExampleCreatePhysicalFacilityLocation($input: NewPhysicalFacilityLocationInput!) {
  createPhysicalFacilityLocation(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    code
    taxJurisdictionId
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "address": {
      "line1": "100 Queen Street West",
      "line2": "<line2>",
      "city": "Toronto",
      "countryCode": "CA"
    }
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createPhysicalFacilityLocation": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PL-EXMP-0000-000F",
      "type": "PhysicalFacilityLocation",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "code": "BJ-001",
      "taxJurisdictionId": "01900000-0000-7000-8000-3a64e3820000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

createPhysicalFacility

createPhysicalFacility — mutation · Create a new physical facility — an actual building (a store, a warehouse) at your organization.

Example request

mutation ExampleCreatePhysicalFacility($input: NewPhysicalFacilityInput!) {
  createPhysicalFacility(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    physicalFacilityLocationId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "organizationId": "01900000-0000-7000-8000-44b781470000",
    "physicalFacilityLocationId": "01900000-0000-7000-8000-4ff696030000"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createPhysicalFacility": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PF-EXMP-0000-000F",
      "type": "PhysicalFacility",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "physicalFacilityLocationId": "01900000-0000-7000-8000-4ff696030000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

createLogicalFacility

createLogicalFacility — mutation · Create a new logical facility — a sellable/working unit inside a building (the shop floor, the back room) at your organization.

Example request

mutation ExampleCreateLogicalFacility($input: NewLogicalFacilityInput!) {
  createLogicalFacility(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    classification
    geographicDivisionId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "physicalFacilityId": "01900000-0000-7000-8000-6ecd4f980000",
    "classification": "<classification>"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createLogicalFacility": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "LF-EXMP-0000-000F",
      "type": "LogicalFacility",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "classification": "<classification>",
      "geographicDivisionId": "01900000-0000-7000-8000-478b5d0c0000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}