Skip to main content

Fetch location detail

GET 
/v1/entities/:entity_id/locations/:id

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

Request​

Path Parameters

    entity_id stringrequired

    Unique identifier for the Entity object.

    id stringrequired

    Unique identifier for the Location object.

Responses​

Returns a location if a valid identifier was provided, and returns an error otherwise.

Schema
    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

Loading...