What is it for?

This endpoint lets you list all the shops in your account, returning a structure with information about each one.

Conditions

• Requires authentication.

Parameters

Fill in the fields in Query Params and/or Path Params as applicable.

Quick parameter guide

• name: Filter by shop name (Instructions: Type the name or part of it)
• shop_ids: Filter by specific IDs (Instructions: The IDs you already know. Separate with commas: 1,2,3)
• status: Filter by status (Instructions: Write: 0 (inactive), 1 (active) or 2 (pending))
• page: Which page to view (Instructions: Starts at 1)
• per_page: How many results per page (Instructions: An integer)
• order_by: Field to sort by (Instructions: Values: created_at, id)
• order_direction: Ascending or descending order (Instructions: Write: asc or desc)

Expected response

HTTP 200 → Paginated shop list. Copy the "id" of the shop you need.