Dopravy

pro práci s dopravami lze využívat webhooky.
více o dopravách v Upgates e-shopech naleznete zde.

Seznam doprav

GET

/api/v2/shipments

Seznam doprav › query Parameters

ids

QueryParameterArrayInt

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

code

string

kód dopravy

codes

QueryParameterArrayInt

kódy dopravy oddělené středníkem ; nebo jako pole

type

ShipmentType · enum

typ dopravy:

ceskaPosta - Česká pošta
balikovna - Balíkovna
slovenskaPosta - Slovenská pošta
sps - SPS
ulozenka - Uloženka
zasilkovna - Zásilkovna
dpd - DPD
ppl - PPL
gls - GLS
wedo - WEDO
custom - Vlastní doprava
individual - Individuální

Enum values:

ceskaPosta

balikovna

slovenskaPosta

sps

zasilkovna

dpd

ppl

gls

page

integer

stránka

Default: 1

Seznam doprav › 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 dopravami

GET/api/v2/shipments

curl --request GET \
  --url /api/v2/shipments

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "shipments": [
    {
      "id": "id",
      "code": "code",
      "image_url": "https://www.example.com/path/to/resource",
      "type": "ceskaPosta",
      "active_yn": true,
      "affiliates": [
        "balikovna"
      ],
      "tracking_url": "https://www.example.com/path/to/resource",
      "internal_note": "internal_note",
      "descriptions": [
        {
          "language_id": "cz",
          "name": "name",
          "description": "description",
          "price": 0,
          "free_from": 0
        }
      ],
      "metas": [
        {
          "key": "key",
          "type": "checkbox",
          "value": "value"
        }
      ]
    }
  ]
}

json

application/json

Detail dopravy

GET

/api/v2/shipments/{id}

Detail dopravy › path Parameters

id

integer · required

ID dopravy

Detail dopravy › 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 dopravami

GET/api/v2/shipments/{id}

curl --request GET \
  --url /api/v2/shipments/:id

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "shipments": [
    {
      "id": "id",
      "code": "code",
      "image_url": "https://www.example.com/path/to/resource",
      "type": "ceskaPosta",
      "active_yn": true,
      "affiliates": [
        "balikovna"
      ],
      "tracking_url": "https://www.example.com/path/to/resource",
      "internal_note": "internal_note",
      "descriptions": [
        {
          "language_id": "cz",
          "name": "name",
          "description": "description",
          "price": 0,
          "free_from": 0
        }
      ],
      "metas": [
        {
          "key": "key",
          "type": "checkbox",
          "value": "value"
        }
      ]
    }
  ]
}

json

application/json

Seznam poboček dopravy

GET

/api/v2/shipments/{id}/affiliates

Seznam poboček jde získat k jakémukoliv typu dopravy. Pracuje vždy s pobočkami jedné konkrétní dopravy.

Seznam poboček dopravy › path Parameters

id

integer · required

ID dopravy

Seznam poboček dopravy › query Parameters

page

integer

stránka

Default: 1

Seznam poboček dopravy › 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ů pobočkami

Vytvoření pobočky dopravy

POST

/api/v2/shipments/{id}/affiliates

Pobočky lze vytvářet pouze u vlastního typu dopravy. Pokud se pokusíte vytvořit pobočky u dopravy jiného typu, API vrátí chybu 403.

Vytvoření pobočky dopravy › path Parameters

id

integer · required

ID dopravy

Vytvoření pobočky dopravy › Request Body

object[] · required

Vytvoření pobočky dopravy › Responses

200

object[]

POST/api/v2/shipments/{id}/affiliates

curl --request POST \
  --url /api/v2/shipments/:id/affiliates \
  --header 'Content-Type: application/json' \
  --data '
{
  "affiliates": [
    {
      "affiliate_id": "affiliate_id",
      "name": "name",
      "street": "street",
      "city": "city",
      "zip": "zip",
      "country": "cz",
      "note": "note"
    }
  ]
}
'

shell

Example Request Body

{
  "affiliates": [
    {
      "affiliate_id": "affiliate_id",
      "name": "name",
      "street": "street",
      "city": "city",
      "zip": "zip",
      "country": "cz",
      "note": "note"
    }
  ]
}

json

Example Responses

{
  "affiliates": [
    {
      "created_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ]
}

json

application/json

Smazání pobočky dopravy

DELETE

/api/v2/shipments/{id}/affiliates

Pobočky lze smazat pouze u vlastního typu dopravy. Pokud se pokusíte smazat pobočky u dopravy jiného typu, API vrátí chybu 403.

Smazání pobočky dopravy › path Parameters

id

integer · required

ID dopravy

Smazání pobočky dopravy › query Parameters

affiliate_ids

QueryParameterArrayInt

ID poboček oddělené středníkem ; nebo jako pole

delete_all_yn

boolean

pokud je TRUE, smaže všechny pobočky dopravy

Smazání pobočky dopravy › Responses

200

object[]

Seznam skupin dopravy

GET

/api/v2/shipments/groups

Více o skupinách doprav v Upgates e-shopech naleznete zde: https://www.upgates.cz/a/zvlastni-zasilky#skupiny-doprav

Seznam skupin dopravy › query Parameters

page

integer

stránka

Default: 1

Seznam skupin dopravy › 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ů pobočkami

Dostupnosti Faktury

Seznam doprav

GET

/api/v2/shipments

Seznam doprav › query Parameters

ids

QueryParameterArrayInt

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

code

string

kód dopravy

codes

QueryParameterArrayInt

kódy dopravy oddělené středníkem ; nebo jako pole

type

ShipmentType · enum

typ dopravy:

ceskaPosta - Česká pošta
balikovna - Balíkovna
slovenskaPosta - Slovenská pošta
sps - SPS
ulozenka - Uloženka
zasilkovna - Zásilkovna
dpd - DPD
ppl - PPL
gls - GLS
wedo - WEDO
custom - Vlastní doprava
individual - Individuální

Enum values:

ceskaPosta

balikovna

slovenskaPosta

sps

zasilkovna

dpd

ppl

gls

page

integer

stránka

Default: 1

Seznam doprav › 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 dopravami

Detail dopravy

GET

/api/v2/shipments/{id}

Detail dopravy › path Parameters

id

integer · required

ID dopravy

Detail dopravy › 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 dopravami

Seznam poboček dopravy

GET

/api/v2/shipments/{id}/affiliates

Seznam poboček jde získat k jakémukoliv typu dopravy. Pracuje vždy s pobočkami jedné konkrétní dopravy.

Seznam poboček dopravy › path Parameters

id

integer · required

ID dopravy

Seznam poboček dopravy › query Parameters

page

integer

stránka

Default: 1

Seznam poboček dopravy › 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ů pobočkami

Vytvoření pobočky dopravy

POST

/api/v2/shipments/{id}/affiliates

Pobočky lze vytvářet pouze u vlastního typu dopravy. Pokud se pokusíte vytvořit pobočky u dopravy jiného typu, API vrátí chybu 403.

Vytvoření pobočky dopravy › path Parameters

id

integer · required

ID dopravy

Vytvoření pobočky dopravy › Request Body

object[] · required

Vytvoření pobočky dopravy › Responses

200

object[]

Smazání pobočky dopravy

DELETE

/api/v2/shipments/{id}/affiliates

Pobočky lze smazat pouze u vlastního typu dopravy. Pokud se pokusíte smazat pobočky u dopravy jiného typu, API vrátí chybu 403.

Smazání pobočky dopravy › path Parameters

id

integer · required

ID dopravy

Smazání pobočky dopravy › query Parameters

affiliate_ids

QueryParameterArrayInt

ID poboček oddělené středníkem ; nebo jako pole

delete_all_yn

boolean

pokud je TRUE, smaže všechny pobočky dopravy

Smazání pobočky dopravy › Responses

200

object[]

Seznam skupin dopravy

GET

/api/v2/shipments/groups

Více o skupinách doprav v Upgates e-shopech naleznete zde: https://www.upgates.cz/a/zvlastni-zasilky#skupiny-doprav

Seznam skupin dopravy › query Parameters

page

integer

stránka

Default: 1

Seznam skupin dopravy › 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ů pobočkami