Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• pageNumber integer

  Page Number

  Default value is 1.

• sortingField string

  Field to sort by

• direction string

  Sorting direction

  Values are ASC or DESC. Default value is ASC.

• sizePerPage integer

  Size per page

  Default value is 60.

• contactId string(string)

  Contact identifier used to determine localization language

• id string

  Unique identifier of the article
  
  Multi-value supported. Example: value1;value2
  
  

• type string

  Type of the article

  Values are PRODUCT, SERVICE, or BUNDLE.

• articleId string

  Identifier of the article

• name string

  Article's primary name translation

• description string

  Article's detailed description translation

• categoryId string

  Unique identifier of the article's category
  
  Multi-value supported. Example: value1;value2
  
  

• categoryName string

  Name of the category

• measurement string

  Article's measurement type

  Values are UNIT, ML, DL, L, HL, G, KG, T, H, M, M_2, M_3, KM, or DAY.

• unitCost string

  Cost per unitSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• unitPrice string

  Article's unit priceSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• vatRateId integer(int64)

  VAT rate identifier

• archived boolean

  Is the status of the article archived?

• ean string

  Article's EAN code

• quantity number

  Quantity of the article. Applicable only when articleType = PRODUCT

• startDate string

  Start date for the article validitySupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• endDate string

  End date for the article validitySupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• weightKg number

  Weight of the article in Kg. Applicable only when articleType = PRODUCT

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • type string

    Values are PRODUCT, SERVICE, or BUNDLE.

  • articleId string
  • name object
    Hide name attributes Show name attributes object

    • en string
    • fr string
    • de string
    • it string
  • articleIdName object
    Hide articleIdName attributes Show articleIdName attributes object

    • en string
    • fr string
    • de string
    • it string
  • description object
    Hide description attributes Show description attributes object

    • en string
    • fr string
    • de string
    • it string
  • categoryId integer(int64)
  • categoryName string
  • measurement string

    Values are UNIT, ML, DL, L, HL, G, KG, T, H, M, M_2, M_3, KM, or DAY.

  • unitCost number
  • unitPrice number
  • vatRateId integer(int64)
  • archived boolean
  • ean string
  • creatorContactId integer(int64)
  • quantity number
  • startDate string(date-time)
  • endDate string(date-time)
  • weightKg number
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error