Platby

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

Seznam plateb

GET

/api/v2/payments

Vrací seznam plateb po stránkách.

Seznam plateb › query Parameters

ids

QueryParameterArrayInt

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

code

string

kód platby

codes

QueryParameterArrayString

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

type

string

typ platby

page

integer

stránka

Default: 1

Seznam plateb › 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 platbami

GET/api/v2/payments

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

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "payments": [
    {
      "id": "id",
      "code": "code",
      "image_url": "https://www.example.com/path/to/resource",
      "type": "cash",
      "active_yn": true,
      "descriptions": [
        {
          "language_id": "cz",
          "name": "name",
          "description": "description",
          "price": 0,
          "price_type": "fixed",
          "free_from": 0
        }
      ],
      "metas": [
        {
          "key": "key",
          "type": "checkbox",
          "value": "value"
        }
      ]
    }
  ]
}

json

application/json

Detail platby

GET

/api/v2/payments/{id}

Detail platby › path Parameters

id

integer · required

ID platby

Detail platby › 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 platbami

GET/api/v2/payments/{id}

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

shell

Example Responses

{
  "current_page": 1,
  "current_page_items": 1,
  "number_of_items": 1,
  "number_of_pages": 1,
  "payments": [
    {
      "id": "id",
      "code": "code",
      "image_url": "https://www.example.com/path/to/resource",
      "type": "cash",
      "active_yn": true,
      "descriptions": [
        {
          "language_id": "cz",
          "name": "name",
          "description": "description",
          "price": 0,
          "price_type": "fixed",
          "free_from": 0
        }
      ],
      "metas": [
        {
          "key": "key",
          "type": "checkbox",
          "value": "value"
        }
      ]
    }
  ]
}

json

application/json

Parametry Produkty

Seznam plateb

GET

/api/v2/payments

Vrací seznam plateb po stránkách.

Seznam plateb › query Parameters

ids

QueryParameterArrayInt

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

code

string

kód platby

codes

QueryParameterArrayString

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

type

string

typ platby

page

integer

stránka

Default: 1

Seznam plateb › 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 platbami

Detail platby

GET

/api/v2/payments/{id}

Detail platby › path Parameters

id

integer · required

ID platby

Detail platby › 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 platbami