Create Location - Automate.ax

square.createLocation creates a location.

Example

automations/square-create-location.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Create Square Location", () => {
  onDashboardRun({ title: "Create Square Location" })

  square.createLocation({
    location: {
      name: "Midtown",
      address: {
        addressLine1: "1234 Peachtree St. NE",
        locality: "Atlanta",
        administrativeDistrictLevel1: "GA",
        postalCode: "30309",
      },
      description: "Midtown Atlanta store",
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires MERCHANT_PROFILE_WRITE.

Field	Type	Required	Default	Description
`location`	`Square.Location`	No	—	The initial values of the location being created. The `name` field is required and must be unique within a seller account. All other fields are optional, but any information you care about for the location should be included. The remaining fields are automatically added based on the data from the main location.

Use the official CreateLocation reference for provider field semantics and limits.

Output

Returns the official Square.CreateLocationResponse response as a codec-safe object. Square integer money amounts remain bigint values.