⬆️Request and Response

Request to the API endpoint

Retrieves a list of orders that meet the specified criteria

GET https://api.alephcrm.com/v2/productlistings/search

Query Parameters

Name	Type	Description
API_KEY*	String	(default=none)
accountId *	Integer	(default=none)
status*	Integer
includeChilds	boolean	(default=false)
marketplaceId	Integer
brand	String	(default=none)
sku	String	(default=none)
externalID	String	(default=none)
sort	String	(default=ID)
offset	Integer	(default=0)
limit	Integer	(default=100)

200: OK Array of productlistings

{
   "Total": integer,
   "Paging": {
       "Limit": integer,
       "Offset": integer,
       "Total": integer,
   },
   "SortBy": {
       "Id": string,
       "Name": string
   },
   "AvailableSorts": [{
       "Id": string,
       "Name": string
   }],
   "Results":[ ProductListingType ]
}

206: Partial Content Array of productlistings

{
   "Total": integer,
   "Paging": {
       "Limit": integer,
       "Offset": integer,
       "Total": integer,
   },
   "SortBy": {
       "Id": string,
       "Name": string
   },
   "AvailableSorts": [{
       "Id": string,
       "Name": string
   }],
   "Results":[ ProductListingType ]
}

400: Bad Request {"Status": integer, "Message": string}

401: Unauthorized {"Status": integer, "Message": string}

403: Forbidden {"Status": integer, "Message": string}

404: Not Found {"Status": integer, "Message": string}

500: Internal Server Error string

412: Precondition Failed {"Status": integer, "Message": string}

416: Range Not Satisfiable {"Status": integer, "Message": string}

429: Too Many Requests {"Status": integer, "Message": string}

Parameters details

API_KEY

The API_KEY that was provided.

accountId

The Alephee account ID of the orders you are trying to get.

status

Filters product listings which match the provided status. Available statuses are available on this section.

marketplaceId

Filters product listings which origin marketplace matches the provided one. See marketplaces ID section and the GET marketplaces endpoint for the coding reference.

includeChilds

If true, this endpoint will return all the “child” product listings belonging to the standard product listing. The child product listings are those that Alephee automatically generates based on compatibilities (vehicles) or proxy-type product listings.

brand

Filters product listings where the product brand equals the provided one.

sku

Filters product listings where the product SKU equals the provided one.

externalID

Filters product listings where the external ID (the product listing ID) equals the provided one. Examples: MLA929686204 or MLC119938382.

sort

Indicates the field to be sorted by (ascending only). Available fields: ID, dateCreated

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)