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.

• id string

  Stock movement ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• date string

  Movement date filterSupports 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.
  
  

• articleRealId string

  Article real ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• articleId string

  Article code filter

• movementDirection string

  Movement direction filter

  Values are IN or OUT.

• quantity string

  Quantity filterSupports 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.
  
  

• type string

  Movement type filter

  Values are MANUAL or SHIPMENT.

• cost string

  Unit cost filterSupports 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.
  
  

• currencyCode string

  Currency code filter

• quantityLeft string

  Remaining quantity filterSupports 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.
  
  

• ownerId string

  Owner entity ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• ownerType string

  Owner entity type filter

• measurement string

  Unit of measurement filter

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

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • date string(date-time)
  • articleRealId integer(int64)
  • articleId object
    Hide articleId attributes Show articleId attributes object

    • en string
    • fr string
    • de string
    • it string
  • movementDirection string

    Values are IN or OUT.

  • quantity number
  • type string

    Values are MANUAL or SHIPMENT.

  • cost number
  • currencyCode string
  • quantityLeft number
  • organizationId integer(int64)
  • ownerId integer(int64)
  • ownerType string

    Values are PURCHASE_INVOICE, SALES_INVOICE, or ORDER.

  • measurement string

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

  • entityCreatorContactId integer(int64)
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error