Dostupnosti

více o dostupnostech v Upgates e-shopech naleznete zde.

Seznam dostupností

GET

/api/v2/availabilities

Seznam dostupností je dostupný po jednotlivých stranách, výstup je omezený na 50 položek na stránku.

Seznam dostupností › query Parameters

ids

QueryParameterArrayInt

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

page

integer

stránka

Default: 1

type

AvailabilityType · enum

typ dostupnosti:

OnRequest - na dotaz
NotAvailable - není skladem
InStock - skladem
Custom - vlastní

Enum values:

OnRequest

NotAvailable

InStock

Custom

Default: InStock

Seznam dostupností › 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 dostupnostmi

Aktualizace dostupností

PUT

/api/v2/availabilities

Aktualizace dostupností › Request Body

object[] · required

pole objektů s dostupnostmi

Aktualizace dostupností › Responses

200

object[]

pole objektů s dostupnostmi

PUT/api/v2/availabilities

curl --request PUT \
  --url /api/v2/availabilities \
  --header 'Content-Type: application/json' \
  --data '
{
  "availabilities": [
    {
      "id": 0,
      "type": "OnRequest",
      "stock_from": 0,
      "dispatch_days": 0,
      "delivery_days": 0,
      "color": "color",
      "descriptions": [
        {
          "language": "cz",
          "name": "name",
          "note": "note"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "availabilities": [
    {
      "id": 0,
      "type": "OnRequest",
      "stock_from": 0,
      "dispatch_days": 0,
      "delivery_days": 0,
      "color": "color",
      "descriptions": [
        {
          "language": "cz",
          "name": "name",
          "note": "note"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "availabilities": [
    {
      "id": 0,
      "updated_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Vytvoření dostupností

POST

/api/v2/availabilities

Název descriptions musí být vždy ve všech jazycích, ty které chybí se vezmou z výchozího jazyka, pokud není tak z prvního co je na řadě.

Vytvoření dostupností › Request Body

object[] · required

pole objektů s dostupnostmi

Vytvoření dostupností › Responses

200

object[]

pole objektů s dostupnostmi

POST/api/v2/availabilities

curl --request POST \
  --url /api/v2/availabilities \
  --header 'Content-Type: application/json' \
  --data '
{
  "availabilities": [
    {
      "type": "InStock",
      "stock_from": 0,
      "dispatch_days": 0,
      "delivery_days": 0,
      "color": "color",
      "descriptions": [
        {
          "language": "cz",
          "name": "name",
          "note": "note"
        }
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "availabilities": [
    {
      "type": "InStock",
      "stock_from": 0,
      "dispatch_days": 0,
      "delivery_days": 0,
      "color": "color",
      "descriptions": [
        {
          "language": "cz",
          "name": "name",
          "note": "note"
        }
      ]
    }
  ]
}

json

Example Responses

{
  "availabilities": [
    {
      "id": 0,
      "inserted_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Detail dostupnosti

GET

/api/v2/availabilities/{id}

Detail dostupnosti › path Parameters

id

integer · required

ID dostupnosti

Detail dostupnosti › 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 dostupnostmi

Smazání dostupností

DELETE

/api/v2/availabilities/{id}

Smazání dostupností › path Parameters

id

integer · required

ID dostupnosti

Smazání dostupností › query Parameters

ids

QueryParameterArrayInt

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

Smazání dostupností › Responses

200

object[]

pole objektů s dostupnostmi

Články Dopravy

Seznam dostupností

GET

/api/v2/availabilities

Seznam dostupností je dostupný po jednotlivých stranách, výstup je omezený na 50 položek na stránku.

Seznam dostupností › query Parameters

ids

QueryParameterArrayInt

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

page

integer

stránka

Default: 1

type

AvailabilityType · enum

typ dostupnosti:

OnRequest - na dotaz
NotAvailable - není skladem
InStock - skladem
Custom - vlastní

Enum values:

OnRequest

NotAvailable

InStock

Custom

Default: InStock

Seznam dostupností › 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 dostupnostmi

Vytvoření dostupností

POST

/api/v2/availabilities

Název descriptions musí být vždy ve všech jazycích, ty které chybí se vezmou z výchozího jazyka, pokud není tak z prvního co je na řadě.

Vytvoření dostupností › Request Body

object[] · required

pole objektů s dostupnostmi

Vytvoření dostupností › Responses

200

object[]

pole objektů s dostupnostmi

Detail dostupnosti

GET

/api/v2/availabilities/{id}

Detail dostupnosti › path Parameters

id

integer · required

ID dostupnosti

Detail dostupnosti › 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 dostupnostmi

Smazání dostupností

DELETE

/api/v2/availabilities/{id}

Smazání dostupností › path Parameters

id

integer · required

ID dostupnosti

Smazání dostupností › query Parameters

ids

QueryParameterArrayInt

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

Smazání dostupností › Responses

200

object[]

pole objektů s dostupnostmi