Reference Data

Reference data endpoints (countries, providers, etc.)

List countries

get

Retrieve a list of all available countries

Authorizations
AuthorizationstringRequired

Laravel Sanctum token authentication. Include the token in the Authorization header: Bearer {your-token}

Responses
chevron-right
200

List of countries

application/json
idintegerOptional

Country ID

Example: 1
namestringOptional

Country name

Example: Hungary
isostringOptional

ISO country code (lowercase)

Example: hu
currency_idintegerOptional

Currency ID

Example: 1
cod_payout_limitnumberOptional

Cash on delivery payout limit

Example: 50000
vatnumberOptional

VAT rate percentage

Example: 27
get
/v3/countries

List providers

get

Retrieve a list of all shipping providers

Authorizations
AuthorizationstringRequired

Laravel Sanctum token authentication. Include the token in the Authorization header: Bearer {your-token}

Responses
chevron-right
200

List of providers

application/json
idintegerOptional

Provider ID

Example: 1
namestringOptional

Provider name

Example: Magyar Posta Logisztika
slugstringOptional

Provider slug

Example: mpl
tracking_linkstringOptional

Tracking link template with %foreign_tracking_id% placeholder

Example: https://posta.hu/ugyfelszolgalat/nyomkovetes?ids=%foreign_tracking_id%
get
/v3/providers

Search provider places

get

Search for provider pickup/drop-off places

Authorizations
AuthorizationstringRequired

Laravel Sanctum token authentication. Include the token in the Authorization header: Bearer {your-token}

Query parameters
provider_service_ids[]integer[]Optional

Filter by provider service IDs

Example: [1,2,3]
country_idintegerOptional

Filter by country ID

Example: 1
searchstringOptional

Search term for place names or locations

Example: Budapest
pageinteger · min: 1Required

Page number for pagination

Default: 1
limitinteger · min: 1Required

Number of items per page

Default: 10
Responses
chevron-right
200

List of provider places

application/json
current_pageintegerOptionalExample: 1
first_page_urlstringOptionalExample: http://localhost:8000/api/v3/provider-places?page=1
fromintegerOptionalExample: 1
last_pageintegerOptionalExample: 1230
last_page_urlstringOptionalExample: http://localhost:8000/api/v3/provider-places?page=1230
next_page_urlstring · nullableOptionalExample: http://localhost:8000/api/v3/provider-places?page=2
pathstringOptionalExample: http://localhost:8000/api/v3/provider-places
per_pageintegerOptionalExample: 10
prev_page_urlstring · nullableOptional
tointegerOptionalExample: 10
totalintegerOptionalExample: 12292
get
/v3/provider-places

Last updated