Get category by ID

Get a category by id. A soft-deleted item is returned with deleted: true.

GET/categories/{categoryId}

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Path parameters

categoryIdstringrequired

Responses

200

Category details

dataCategoryrequired

Show properties

idstringrequired

namestring

externalIdstring

Optional external identifier

indexinteger

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

deletedboolean

hideStorestring[]

allowStorestring[]

createdatestring<date-time>

403

Missing, unknown or inactive API key, or a Read key on a write operation.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

404

No item with this id.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Parameters

categoryIdpath*

Request

curl -X GET 'https://dashboard.scango.ch/api/v1/categories/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://dashboard.scango.ch/api/v1/categories/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://dashboard.scango.ch/api/v1/categories/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/categories/string',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
  ],
]);

$response = curl_exec($curl);

Response

{
  "data": {
    "id": "cat_01",
    "name": "Beverages",
    "index": 1,
    "showOnScreen": true,
    "imageUrl": ""
  }
}

{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}

{
  "statusCode": 0,
  "message": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "path": "string"
}