[1.23.0] Searching and sorting dispatch points

Warning!

The resource is available only in the following countries: PL

On this page

1 Dropoff points list

Dropoff points list

You can search for dropoff points by entering one or more of the following parameters
GET /v1/organizations/:organization_id/dispatch_points

Search parameters:

Parameter	Type	Action	Example

Parameter	Type	Action	Example
`id`	Integer Array	Finds dropoff points with the given id. Finds dropoff points with the given ids.	`?id=12` `?id=12,17`
`name`	String	Finds dropoff points whose names contain the specified string.	`?name=mag`
`email`	String Array	Finds dropoff points whose e-mail addresses are identical to the specified string. Finds dropoff points with the indicated e-mail addresses.	`?email=storage1@company.com` `?email=storage1@company.com,storage2@company.com`
`phone`	String Array	Finds dropoff points with a phone number identical to the specified string. Finds dropoff points with the indicated phone numbers.	`?phone=123123123` `?phone=123123123,1231231234`
`address`	String	Finds dropoff points where the address (street) begins with the specified string.	`?address=Zaw`
`post_code`	String	Finds dropoff points where the postcode begins with the specified string.	`?post_code=30-442`
`country_code`	String	Finds dropoff points where the country code is identical to the specified string.	`?country_code=PL`
`city`	String	Finds dropoff points where the city is identical to the specified sequence.	`?city=Cracow`

Results sorting

Search results can be sorted by passing the sort_by parameter, which can take the following values:

Value	Action	Example

Value	Action	Example
`id`	Sorts dropoff points by identifier.	`?sort_by=id`
`name`	Sorts dropoff points by name.	`?sort_by=name`
`email`	Sorts dropoff points by e-mail address.	`?sort_by=email`
`phone`	Sorts dropoff points by phone number.	`?sort_by=phone`
`address`	Sorts dropoff points by the first line of the address.	`?sort_by=address`
`post_code`	Sorts dropoff points by post code.	`?sort_by=post_code`
`country_code`	Sorts dropoff points by country code.	`?sort_by=country_code`

Sorting can be done in two ways by using the sort_order parameter. By default, the results are sorted in descending order (desc) by the dropoff point creation date (created_at).

Value	Action	Example

Value	Action	Example
`asc`	Sorts dropoff points in ascending order.	`?sort_order=asc&sort_by=id`
`desc`	Sorts dropoff points in descending order.	`?sort_order=desc&sort_by=id`