List products (admin)

GET

/admin/products

Authorization

headerx-api-key<token>

Organization-scoped API key with scope metadata.

Query Parameters

page?integer

Range0 < value <= 9007199254740991

perPage?integer

Range0 < value <= 200

search?string

sortField?string

sortDirection?string

Value in"asc""desc"

Response Body

Success

application/json

response

items*array<>

total*number

page*number

perPage*number

hasMore*boolean

Example Request

curl -X GET 'https://api-prood.vercel.app/v1/admin/products'

Example Request

curl -X GET 'https://api-prood.vercel.app/v1/admin/products'

Example ResponseSchema

{
  "items": [
    {
      "id": "string",
      "sku": "string",
      "name": {
        "property1": "string",
        "property2": "string"
      },
      "slug": "string",
      "description": {
        "property1": "string",
        "property2": "string"
      },
      "shortDescription": {
        "property1": "string",
        "property2": "string"
      },
      "price": {
        "amount": 0,
        "currency": "string",
        "formatted": "string",
        "originalAmount": 0,
        "discountPercent": 0
      },
      "primaryImage": {
        "url": "string",
        "alt": "string",
        "width": 0,
        "height": 0
      },
      "gallery": [
        {
          "url": "string",
          "alt": "string",
          "width": 0,
          "height": 0
        }
      ],
      "rating": {
        "average": 0,
        "count": 0
      },
      "variants": [
        {
          "id": "string",
          "sku": "string",
          "name": {
            "property1": "string",
            "property2": "string"
          },
          "price": {
            "amount": 0,
            "currency": "string",
            "formatted": "string",
            "originalAmount": 0,
            "discountPercent": 0
          },
          "inStock": true,
          "inventoryQuantity": 0
        }
      ],
      "attributes": [
        {
          "code": "string",
          "name": {
            "property1": "string",
            "property2": "string"
          },
          "value": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "quantityLimit": 0,
      "categories": [
        {
          "id": "string",
          "name": {
            "property1": "string",
            "property2": "string"
          },
          "slug": "string",
          "description": {
            "property1": "string",
            "property2": "string"
          },
          "image": {
            "url": "string",
            "alt": "string",
            "width": 0,
            "height": 0
          },
          "parentId": "string",
          "productCount": 0
        }
      ],
      "inStock": true,
      "vatIncluded": true,
      "vatRate": 0,
      "tags": [
        "string"
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "productType": "physical",
      "requiresShipping": true,
      "isDropshipped": true,
      "status": "string"
    }
  ],
  "total": 0,
  "page": 0,
  "perPage": 0,
  "hasMore": true
}

{  "items": [    {      "id": "string",      "sku": "string",      "name": {        "property1": "string",        "property2": "string"      },      "slug": "string",      "description": {        "property1": "string",        "property2": "string"      },      "shortDescription": {        "property1": "string",        "property2": "string"      },      "price": {        "amount": 0,        "currency": "string",        "formatted": "string",        "originalAmount": 0,        "discountPercent": 0      },      "primaryImage": {        "url": "string",        "alt": "string",        "width": 0,        "height": 0      },      "gallery": [        {          "url": "string",          "alt": "string",          "width": 0,          "height": 0        }      ],      "rating": {        "average": 0,        "count": 0      },      "variants": [        {          "id": "string",          "sku": "string",          "name": {            "property1": "string",            "property2": "string"          },          "price": {            "amount": 0,            "currency": "string",            "formatted": "string",            "originalAmount": 0,            "discountPercent": 0          },          "inStock": true,          "inventoryQuantity": 0        }      ],      "attributes": [        {          "code": "string",          "name": {            "property1": "string",            "property2": "string"          },          "value": {            "property1": "string",            "property2": "string"          }        }      ],      "quantityLimit": 0,      "categories": [        {          "id": "string",          "name": {            "property1": "string",            "property2": "string"          },          "slug": "string",          "description": {            "property1": "string",            "property2": "string"          },          "image": {            "url": "string",            "alt": "string",            "width": 0,            "height": 0          },          "parentId": "string",          "productCount": 0        }      ],      "inStock": true,      "vatIncluded": true,      "vatRate": 0,      "tags": [        "string"      ],      "createdAt": "string",      "updatedAt": "string",      "productType": "physical",      "requiresShipping": true,      "isDropshipped": true,      "status": "string"    }  ],  "total": 0,  "page": 0,  "perPage": 0,  "hasMore": true}

List products (admin)

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body