Get product results with multiple products.
Page number
Number of products per page
Array of product ID
Array of product slug
Search term (fuzzy search in title)
Filter by published status
This value equals to store.id of Store Resource. You can obtain this id by making a GET /stores call to get existing stores or a POST /stores to create a new store.
The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...
Error code in integer format. For detailed information, please refer to the Request Error introduction page.
Response type string for the reference. For detailed information, please refer to the Request Error introduction page.
Human-readable response message. For detailed information, please refer to the Request Error introduction page.
Error detail object. Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.Show all...
The Product model represents an individual item of your store. It includes essential attributes such as product title, price, variants, SKU, and so on. This model is crucial for cataloging and managing the store's inventory effectively.
The Pagination holds the information for the pagination when the response contains multiple objects.
{ "meta": { "code": 20000, "type": "OK", "message": "The request was successfully processed by AfterShip." }, "data": { "products": [ { "id": "product_id_1", "title": "Example Product 1", "slug": "example-product-1", "published": true }, { "id": "product_id_2", "title": "Example Product 2", "slug": "example-product-2", "published": false } ], "pagination": { "page": 1, "limit": 10, "has_next_page": true } } }