API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

coordinate_locations

Retrieves the collection of coordinate_locations resources.

Retrieves the collection of coordinate_locations resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[address]
boolean
exists[suite]
boolean
exists[road]
boolean
exists[city]
boolean
exists[state]
boolean
exists[postalCode]
boolean
exists[timeZone]
boolean
exists[note]
boolean
exists[taxCustoms]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[address]
string
Default: "asc"
Enum: "asc" "desc"
order[suite]
string
Default: "asc"
Enum: "asc" "desc"
order[road]
string
Default: "asc"
Enum: "asc" "desc"
order[city]
string
Default: "asc"
Enum: "asc" "desc"
order[state]
string
Default: "asc"
Enum: "asc" "desc"
order[country]
string
Default: "asc"
Enum: "asc" "desc"
order[postalCode]
string
Default: "asc"
Enum: "asc" "desc"
order[timeZone]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[note]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
address_end_with
string
address_partial
string
address_start_with
string
address
string
address[]
Array of strings
city_end_with
string
city_partial
string
city_start_with
string
city
string
city[]
Array of strings
coordinates
string
coordinates[]
Array of strings
country_end_with
string
country_partial
string
country_start_with
string
country
string
country[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
note_end_with
string
note_partial
string
note_start_with
string
note
string
note[]
Array of strings
postalCode_end_with
string
postalCode_partial
string
postalCode_start_with
string
postalCode
string
postalCode[]
Array of strings
road_end_with
string
road_partial
string
road_start_with
string
road
string
road[]
Array of strings
shipment
string
shipment[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
state_end_with
string
state_partial
string
state_start_with
string
state
string
state[]
Array of strings
suite_end_with
string
suite_partial
string
suite_start_with
string
suite
string
suite[]
Array of strings
task
string
task[]
Array of strings
timeZone_end_with
string
timeZone_partial
string
timeZone_start_with
string
timeZone
string
timeZone[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}