GET /api/account/warehouses

get/api/account/warehouses

Example request

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

Code

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

Parameters

Name	In	Required	Description
search	query	no	Supports SQL-like syntax: - `test`: begins with `test` - `test`: ends with `test` - `test`: contains `test` - `test`: exact match.
location_id	query	no	Filter by location ID
active	query	no	Filter by active status
order_by	query	no	Sort by a specific field
#/components/parameters/OrderDirParameter
#/components/parameters/PerPageParameter
#/components/parameters/PageParameter

Responses

200OK

ModelListWarehouses200Response

Field

Type

Description

data*

object[]

array

Elements

Field

Type

Description

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

string (email)

—

id*

integer

—

internal_note

string

HTML

location

object

Field	Type	Description
id	integer	—
name	string	—

location_id

integer

—

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.

zip

string

ZIP or postal code.

meta*

object

Field	Type	Description
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.

Example response

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

Warehouses

Questions about integration?