API Reference
Developer ConsoleAPI Status Page

List objects

get
https://api.wafeq.com/v2/items/

List the organization's items.

Query Params
extra_fields
array of strings

The extra fields to include in the response.

extra_fields
boolean

Filter items by active status.

boolean

Filter items by assembly status (items with a bill of materials).

boolean

Filter items by inventory tracking status.

string

The search term, based on fields:

  • name.ar - The name (arabic) of the item (contains, case-insensitive).
  • name.en - The name (english) of the item (contains, case-insensitive).
  • sku - The stock keeping unit (SKU) of the item (contains, case-insensitive).
integer

Number of results to return per page.

integer

The initial index from which to return the results.

ordering
array of strings

The custom ordering of the results. The default ordering is by created_ts descending.

  • created_ts - The timestamp (ISO 8601) in UTC when the item was created.
  • -created_ts - The timestamp (ISO 8601) in UTC when the item was created. (descending)
  • modified_ts - The timestamp (ISO 8601) in UTC when the item was last modified.
  • -modified_ts - The timestamp (ISO 8601) in UTC when the item was last modified. (descending)
  • name - The name of the item.
  • -name - The name of the item. (descending)
ordering
Allowed:
Response

Updated 20 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago

Did this page help you?