The Location object
Attributes
- idstring
Unique identifier for the object.
- addressobject
The full address of the location.
- display_
namestring The display name of the location.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
More attributes
- objectstring
- configuration_
overridesnullable string - livemodeboolean
{
"id": "tml_FBakXQG8bQk4Mm",
"object": "terminal.location",
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Main Street",
"line2": "",
"postal_code": "94111",
"state": "CA"
},
"display_name": "My First Store",
"livemode": false,
"metadata": {}
}
Create a Location
Creates a new Location
object. For further details, including which address fields are required in each country, see the Manage locations guide.
Parameters
- addressobjectRequired
The full address of the location.
- display_
namestringRequired A name for the location.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
More parameters
- configuration_
overridesstring
Returns
Returns a Location
object if creation succeeds.
{
"id": "tml_FBakXQG8bQk4Mm",
"object": "terminal.location",
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Main Street",
"line2": "",
"postal_code": "94111",
"state": "CA"
},
"display_name": "My First Store",
"livemode": false,
"metadata": {}
}
Update a Location
Updates a Location
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- addressobject
The full address of the location.
- display_
namestring A name for the location.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
More parameters
- configuration_
overridesstring
Returns
Returns an updated Location
object if a valid identifier was provided.
{
"id": "tml_FBakXQG8bQk4Mm",
"object": "terminal.location",
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Main Street",
"line2": "",
"postal_code": "94111",
"state": "CA"
},
"display_name": "Update Store Name",
"livemode": false,
"metadata": {}
}
Retrieve a Location
Retrieves a Location
object.
Parameters
No parameters.
Returns
Returns a Location
object if a valid identifier was provided.
{
"id": "tml_FBakXQG8bQk4Mm",
"object": "terminal.location",
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Main Street",
"line2": "",
"postal_code": "94111",
"state": "CA"
},
"display_name": "My First Store",
"livemode": false,
"metadata": {}
}
List all Locations
Returns a list of Location
objects.
Parameters
No parameters.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
locations, starting after location starting_after
. Each entry in the array is a separate Terminal location
object. If no more locations are available, the resulting array will be empty.
{
"object": "list",
"url": "/v1/terminal/locations",
"has_more": false,
"data": [
{
"id": "tml_FBakXQG8bQk4Mm",
"object": "terminal.location",
"address": {
"city": "San Francisco",
"country": "US",
"line1": "1234 Main Street",
"line2": "",
"postal_code": "94111",
"state": "CA"
},
"display_name": "My First Store",
"livemode": false,
"metadata": {}
}
{...}
{...}
],
}