Soubory

více o rádcích v Upgates e-shopech naleznete zde.

Seznam souborů

GET

/api/v2/files

Seznam souborů › query Parameters

ids

QueryParameterArrayInt

ID souborů oddělené středníkem ; nebo jako pole

type

string · enum

typ

Enum values:

image

file

video

category_id

integer

ID kategorie

deleted_yn

boolean

když true vrátí smazané soubory z koše

page

integer

stránka

Default: 1

Seznam souborů › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů se soubory

Nahrání souborů

POST

/api/v2/files

Nahrání více souborů najednou pomocí stažení z URL adresy obsažené v požadavku.

V JSONu lze poslat 3 objekty file. Timeout na stažení jednoho souboru je 20 vteřin, connection timeout je 3 vteřiny.

Nahrání souborů › Request Body

object[] · maxItems: 3 · required

pole objektů se soubory

Nahrání souborů › Responses

200

object[]

inserted_yn

boolean

informace o úspěšném vytvoření položky

object[]

chybové zprávy

POST/api/v2/files

curl --request POST \
  --url /api/v2/files \
  --header 'Content-Type: application/json' \
  --data '
{
  "files": [
    {
      "url": "https://www.example.com/path/to/resource",
      "category_id": 0,
      "titles": [
        {
          "language": "cz",
          "title": "title"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "files": [
    {
      "url": "https://www.example.com/path/to/resource",
      "category_id": 0,
      "titles": [
        {
          "language": "cz",
          "title": "title"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "files": [
    {
      "id": "id",
      "url": "https://www.example.com/path/to/resource",
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ],
  "inserted_yn": true,
  "messages": [
    {
      "object": "object",
      "property": "property",
      "message": "message",
      "level": "info"
    }
  ]
}

json

application/json

Nahrání souboru

POST

/api/v2/files/file

Nahrání jednoho souboru pomocí přímého poslání obsahu přes form-data

Nahrání souboru › Request Body

file

string · binary · required

obsah souboru

file_name

string

název souboru

category_id

integer

ID kategorie pro zařazení souboru

Nahrání souboru › Responses

200

object

inserted_yn

boolean

informace o úspěšném vytvoření položky

object[]

chybové zprávy

POST/api/v2/files/file

curl --request POST \
  --url /api/v2/files/file \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=<binary>' \
  --form file_name=file_name \
  --form category_id=0

shell

Example Request Body

{
  "file": "<binary>",
  "file_name": "file_name",
  "category_id": 0
}

json

Example Responses

{
  "file": {
    "id": "id",
    "name": "name",
    "mimetype": "mimetype",
    "size": "size",
    "type": "image",
    "url": "https://www.example.com/path/to/resource",
    "titles": [
      {
        "language": "cz",
        "title": "title"
      }
    ]
  },
  "inserted_yn": true,
  "messages": [
    {
      "object": "object",
      "property": "property",
      "message": "message",
      "level": "info"
    }
  ]
}

json

application/json

Soubor

GET

/api/v2/files/{id}

Soubor › path Parameters

id

integer · required

ID souboru

Soubor › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů se soubory

Smazání souboru

DELETE

/api/v2/files/{id}

Při smazání souboru nedojde k jeho fyzickému smazání, ale pouze k přesunutí do koše.

V API (metoda GET) má smazaný soubor příznak deleted_yn.

Smazání souboru › path Parameters

id

integer · required

ID souboru

Smazání souboru › query Parameters

ids

QueryParameterArrayInt

ID souborů oddělené středníkem ; nebo jako pole

Smazání souboru › Responses

200

object[]

seznam výsledků mazání

Seznam kategorií

GET

/api/v2/files/categories

Vrátí seznam kategorií souborů.

Pokud není parametr page definován, vrací vždy stranu 1.

Seznam kategorií › query Parameters

id

integer

ID kategorie

ids

QueryParameterArrayInt

ID kategorií oddělené středníkem ; nebo jako pole

page

integer

stránka

Default: 1

Seznam kategorií › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů s kategoriemi

Slevové kupóny Stavy objednávek

Seznam souborů

GET

/api/v2/files

Seznam souborů › query Parameters

ids

QueryParameterArrayInt

ID souborů oddělené středníkem ; nebo jako pole

type

string · enum

typ

Enum values:

image

file

video

category_id

integer

ID kategorie

deleted_yn

boolean

když true vrátí smazané soubory z koše

page

integer

stránka

Default: 1

Seznam souborů › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů se soubory

Nahrání souborů

POST

/api/v2/files

Nahrání více souborů najednou pomocí stažení z URL adresy obsažené v požadavku.

V JSONu lze poslat 3 objekty file. Timeout na stažení jednoho souboru je 20 vteřin, connection timeout je 3 vteřiny.

Nahrání souborů › Request Body

object[] · maxItems: 3 · required

pole objektů se soubory

Nahrání souborů › Responses

200

object[]

inserted_yn

boolean

informace o úspěšném vytvoření položky

object[]

chybové zprávy

Nahrání souboru

POST

/api/v2/files/file

Nahrání jednoho souboru pomocí přímého poslání obsahu přes form-data

Nahrání souboru › Request Body

file

string · binary · required

obsah souboru

file_name

string

název souboru

category_id

integer

ID kategorie pro zařazení souboru

Nahrání souboru › Responses

200

object

inserted_yn

boolean

informace o úspěšném vytvoření položky

object[]

chybové zprávy

Soubor

GET

/api/v2/files/{id}

Soubor › path Parameters

id

integer · required

ID souboru

Soubor › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů se soubory

Smazání souboru

DELETE

/api/v2/files/{id}

Při smazání souboru nedojde k jeho fyzickému smazání, ale pouze k přesunutí do koše.

V API (metoda GET) má smazaný soubor příznak deleted_yn.

Smazání souboru › path Parameters

id

integer · required

ID souboru

Smazání souboru › query Parameters

ids

QueryParameterArrayInt

ID souborů oddělené středníkem ; nebo jako pole

Smazání souboru › Responses

200

object[]

seznam výsledků mazání

Seznam kategorií

GET

/api/v2/files/categories

Vrátí seznam kategorií souborů.

Pokud není parametr page definován, vrací vždy stranu 1.

Seznam kategorií › query Parameters

id

integer

ID kategorie

ids

QueryParameterArrayInt

ID kategorií oddělené středníkem ; nebo jako pole

page

integer

stránka

Default: 1

Seznam kategorií › Responses

200

current_page

integer · min: 1

aktuální strana

current_page_items

integer

počet položek na aktuální straně

number_of_items

integer

celkový počet položek

number_of_pages

integer

celkový počet stran

object[]

pole objektů s kategoriemi