List locations

GET 
/v1/entities/:entity_id/locations

The Location object represents a sales tax location. Locations are identified by a unique ID. Authentication

Request

Path Parameters

entity_id stringrequired

entity_id

Responses

200

A dictionary with a data property that contains an array of objects. Each entry in the array is a separate location object. If no more locations are available, the resulting array will be empty.

application/json

Schema

Schema

object stringrequired

Default value: list

total_records integerrequired
data object[]
Array [
id stringrequired
Unique identifier for the Location object.
entity_id stringrequired
Unique identifier for the Entity object.
name stringrequired
Name of Location.
address1 stringrequired
Address line 1.
address2 stringnullablerequired
Address line 2.
city stringrequired
City.
state stringrequired
State.
postal_code stringrequired
Postal code.
phone_number stringrequired
Phone number.
email stringrequired
Email address.
headquarters booleanrequired
Indicates if this is the headquarters location.
end_of_day stringrequired
Time of day that the business closes.
timezone stringrequired
Timezone.
updated_at date-timerequired
closeout_offset integerrequired
Defaults to 0, minutes after midnight in the timezone of this address the location considers its end of day ie. closes at 2am, so through 2am is included in prior day
]

Example (from schema)

{
  "object": "list",
  "total_records": 1,
  "data": [
    {
      "id": "nGBr7Vr7mNqW",
      "entity_id": "9zOe70LNPwlN",
      "name": "JT Bottle Shop",
      "address1": "61707 29 Palms Hwy",
      "address2": "string",
      "city": "Joshua Tree",
      "state": "CA",
      "postal_code": 92252,
      "phone_number": "+1917xxxxx00",
      "email": "[email protected]",
      "headquarters": true,
      "end_of_day": "00:00",
      "timezone": "Pacific Time (US & Canada)",
      "updated_at": "2023-05-23T07:57:26.851Z",
      "closeout_offset": 0
    }
  ]
}

401

HTTP Basic: Access denied.

404

Returns an error if a invalid entity identifier was provided.

application/json

Schema

Schema

error object
message stringrequired
type stringrequired
status stringrequired

Example (from schema)

{
  "error": {
    "message": "Couldn't find Organization",
    "type": "invalid_request_error",
    "status": "ok"
  }
}

Loading...