GET /api/account/products

get/api/account/products

Example request

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

Code

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

Parameters

Name	In	Required	Description
name	query	no	Supports SQL-like syntax: - `test`: begins with `test` - `test`: ends with `test` - `test`: contains `test` - `test`: exact match.
sku	query	no	Supports SQL-like syntax: - `test`: begins with `test` - `test`: ends with `test` - `test`: contains `test` - `test`: exact match.
type	query	no	—
price_net_from	query	no	—
price_net_to	query	no	—
order_by	query	no	Sort by a specific field
#/components/parameters/OrderDirParameter
#/components/parameters/PerPageParameter
#/components/parameters/PageParameter

Responses

200OK

ModelListProducts200Response

Field

Type

Description

data*

object[]

array

Elements

Field	Type	Description
created_at	string (date-time)	Creation timestamp in ISO 8601 format.
description	string	—
has_stock	boolean	—
id*	integer	—
internal_note	string	—
name*	string	—
price_net	integer	—
purchase_price_net	integer	—
sku	string	—
tax_rate	number	—
type	string	string physical virtual service
unit_code	string	UN/CEFACT unit of measure code (Recommendation 20/21). Null allowed for optional positions. Code meanings: - C62: unit (piece) - HUR: hour - DAY: day - KGM: kilogram - GRM: gram - LTR: litre - CMT: centimetre - MTR: metre - MTK: square metre - MTQ: cubic metre - KMT: kilometre - TNE: tonne (metric) - PAC: package - PR: pair - BOX: box - RO: roll - SET: set - PCE: page - MIN: minute - SEC: second - MLT: millilitre - MMT: millimetre - P1: percent - ZZ: lump sum (generic / no unit) string C62 HUR DAY KGM GRM LTR CMT MTR MTK MTQ KMT TNE PAC PR BOX RO SET PCE MIN SEC MLT MMT P1 ZZ
updated_at	string (date-time)	Last update timestamp in ISO 8601 format.

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,
      "sku": "string",
      "name": "string",
      "description": "string",
      "type": "physical",
      "unit_code": "C62"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "items_from": 1,
    "items_to": 1
  }
}

Products

Questions about integration?