âŦī¸Request and Response
Request to the API endpoint
Retrieves a list of orders that meet the specified criteria
GET
https://api.alephcrm.com/v2/products
Query Parameters
Parameters details
API_KEY
The API_KEY that was provided.
accountId
The Alephee account ID of the orders you are trying to get.
SKU
Filters products which SKU equals the provided one
Brand
Filters products which brand equals the provided one
ownCode
Filters products which own code equals the provided one
priceListId
Filters productâs prices collection, returning only those that the price list ID matches the provides one. If you manage only 1 price list, leave this parameter empty.
dateUpdatedFrom
Filter products which have been updated after the provided date. (Format yyyy-mm-dd HH:mm with HH in 24 hours-format) Will only return modified products on-or-after the given date.
types
Filter products which have based on a list of product types. The filter value must be a comma separated list of integer numeric values. Available values are: 1 = Normal product 2 = Kit product type 5 = Variation child product type 6 = Variation master product type Eg: 1,5,6 gets only products of normal, and variation types, without including the kit product type.
catalogStatus
Filter the products that are in the list of status provided. Available status values are: 0 = Assigned, 1 = Approved (assigned and approved), 2 = Observed (assigned but observed),2 = Observed (assigned but observed), 3 = Observed and fixed, 4 = Observed and rejected, 5 = Deleted This parameter can receive a list of status separated by a comma. For example: 1, 2, 4.
sort
Indicates the field to be sorted by (ascending only). Available fields: ID
offset
Used for paging. Moves the inferior limit of the records to the provided one. For example, offset=50 gets the rows skipping the first 50 records
limit
Used for paging. Defines the number of records to be returned. For example, limit=10 gets only 10 records
Paging example:
offset=50, limit=10, will skip the first 50 records and return the next 10 ones (from record 51 to 61)
Last updated