Returns a list of all SelfServiceMembershipItem

GET /api/cp/self_service_membership/item

Session token Jwt token internal Login config

Query parameters

id string

Requires access right: SCOPE
deleted boolean

This property is used to mark an entity as deleted / archived | Requires access right: SCOPE | Default value: false
order integer

Requires access right: SCOPE
name string

Requires access right: SCOPE
unifiedCategory string

Requires access right: SCOPE
searchString string

text to search for in the list
orderFieldName string

name of the order field
orderFieldSort string

sorting mode

Values are DESC or ASC.
page integer

page of the list

Default value is 0.
pageSize integer

number of entries for each page

Minimum value is 1, maximum value is 200. Default value is 50.
withMaxPageNumber string

returns the number of pages available as a header if this is set
iw-build-id string

build id of the client
iw-package-id string

package id of the client

Responses

200 application/json

Returns a list of all SelfServiceMembershipItem
Hide response attributes Show response attributes object
- id integer
- products array[object]
  
  Hide products attributes Show products attributes object
  
  id integer
  
  name string Required
  
  description string Required
  
  fixed_price number(float)
  
  fixed_price_base_unit number(float)
  
  billing_type object
  
  Hide billing_type attribute Show billing_type attribute object
  
  deleted boolean
  
  recurrence object
  
  Hide recurrence attributes Show recurrence attributes object
  
  id integer
  
  name string
  
  once boolean
  
  allow_partial_on_eq_start_billing boolean
  
  date_string string
  
  tolerance number(float)
  
  deleted boolean
  
  rounding_steps integer
  
  month_factor integer
  
  deleted boolean
  
  sub_self_service_add boolean
  
  sub_self_service_add_fixed_price number(float)
  
  price_is_brutto boolean
  
  sku string
  
  barcode string
  
  is_preferred boolean
  
  is_default boolean
  
  is_discount boolean
  
  is_free boolean
  
  is_passive boolean
  
  is_global boolean
  
  ucats array[object]
  
  Hide ucats attributes Show ucats attributes object
  
  id integer
  
  category_type string
  
  name string
  
  deleted boolean
  
  image_url string
  
  order integer
- categories array[object]
  
  Hide categories attributes Show categories attributes object
  
  id integer
  
  name string
  
  deleted boolean
  
  unified_category object
  
  Hide unified_category attributes Show unified_category attributes object
  
  id integer
  
  category_type string
  
  name string
  
  deleted boolean
  
  image_url string
  
  image_url string
  
  order integer
- required_item object
- disable_for_flat_list boolean
- require_attachment boolean
- name string
- deleted boolean
- unified_category object
  
  Hide unified_category attributes Show unified_category attributes object
  
  id integer
  
  category_type string
  
  name string
  
  deleted boolean
  
  image_url string
- image_url string
- order integer

GET /api/cp/self_service_membership/item

curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/cp/self_service_membership/item' \
 --header "x-session-token: $API_KEY"

Response examples (200)

[
  {
    "id": 42,
    "products": [
      {
        "id": 42,
        "name": "string",
        "description": "string",
        "fixed_price": 42.0,
        "fixed_price_base_unit": 42.0,
        "billing_type": {
          "deleted": true
        },
        "recurrence": {
          "id": 42,
          "name": "string",
          "once": true,
          "allow_partial_on_eq_start_billing": true,
          "date_string": "string",
          "tolerance": 42.0,
          "deleted": true,
          "rounding_steps": 42,
          "month_factor": 42
        },
        "deleted": true,
        "sub_self_service_add": true,
        "sub_self_service_add_fixed_price": 42.0,
        "price_is_brutto": true,
        "sku": "string",
        "barcode": "string",
        "is_preferred": true,
        "is_default": true,
        "is_discount": true,
        "is_free": true,
        "is_passive": true,
        "is_global": true,
        "ucats": [
          {
            "id": 42,
            "category_type": "string",
            "name": "string",
            "deleted": true,
            "image_url": "string"
          }
        ],
        "order": 42
      }
    ],
    "categories": [
      {
        "id": 42,
        "name": "string",
        "deleted": true,
        "unified_category": {
          "id": 42,
          "category_type": "string",
          "name": "string",
          "deleted": true,
          "image_url": "string"
        },
        "image_url": "string",
        "order": 42
      }
    ],
    "required_item": {},
    "disable_for_flat_list": true,
    "require_attachment": true,
    "name": "string",
    "deleted": true,
    "unified_category": {
      "id": 42,
      "category_type": "string",
      "name": "string",
      "deleted": true,
      "image_url": "string"
    },
    "image_url": "string",
    "order": 42
  }
]