GET /api/account/locations

get/api/account/locations

Beispielanfrage

GET https://api.jupiter-erp.com/api/account/locations

Code

curl -X GET 'https://api.jupiter-erp.com/api/account/locations' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json'

Parameter

Name	In	Pflicht	Beschreibung
search	query	nein	Supports SQL-like syntax: - `test`: begins with `test` - `test`: ends with `test` - `test`: contains `test` - `test`: exact match.
active	query	nein	Filter by active status
order_by	query	nein	Sort by a specific field
#/components/parameters/OrderDirParameter
#/components/parameters/PerPageParameter
#/components/parameters/PageParameter

Antworten

200OK

Feld

Typ

Beschreibung

data*

object[]

array

Elemente

Feld	Typ	Beschreibung
active*	boolean	—
address_line_1	string	First line of the address (Street and House number)
address_line_2	string	Second line of the address
city	string	City of the address.
code	string	—
country_code	string	ISO country code of the address.
created_at	string (date-time)	Creation timestamp in ISO 8601 format.
description	string	HTML
email	string (email)	—
id*	integer	—
internal_note	string	HTML
name*	string	—
phone	string	Phone number in E.164 format.
state	string	State or region of the address.
updated_at	string (date-time)	Last update timestamp in ISO 8601 format.
website	string (https://test.com)	—
zip	string	ZIP or postal code.

meta*

object

Feld	Typ	Beschreibung
current_page*	integer	The current page number.
items_from*	integer	The starting item number on the current page.
items_to*	integer	The ending item number on the current page.
last_page*	integer	The last page number.
per_page*	integer	The number of items per page.
total*	integer	The total number of items.

Beispiel Response

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "code": "string",
      "description": "string",
      "address_line_1": "string",
      "address_line_2": "string",
      "active": true
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "items_from": 1,
    "items_to": 1
  }
}

Locations

Fragen zur Integration?