Callbacks (webhooks)

Отримання списку підписок

Get subscription list

get

Get subscription list

Authorizations

Responses

200

Ok

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

HTTPcURLJavaScriptPython

GET /v1/merchant/callback/subscriptions HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "total": 1,
  "items": [
    {
      "id": "1eedc61a-0f1b-60e8-a3ca-c9551a06168a",
      "secret": "ba7638de38e3d25f42fc243eb1d9ad937c7b5a1d8088f8c8c76e9118bd4db3ab",
      "companyIds": [
        "e80594bf-9fea-4e3e-b86f-1099b270332d"
      ],
      "events": [
        "order.new"
      ],
      "callback": "https://example.com/loko_callback"
    }
  ]
}

Створення нової підписки

Create subscription

post

Create subscription

Authorizations

Body

companyIdsstring[]OptionalExample: e80594bf-9fea-4e3e-b86f-1099b270332d

callbackstringOptionalExample: https://example.com/loko_callback

Responses

201

Created

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

post

HTTPcURLJavaScriptPython

POST /v1/merchant/callback/subscriptions HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "companyIds": [
    "e80594bf-9fea-4e3e-b86f-1099b270332d"
  ],
  "callback": "https://example.com/loko_callback",
  "events": [
    "order.new"
  ]
}

{
  "id": "1eedc61a-0f1b-60e8-a3ca-c9551a06168a",
  "secret": "ba7638de38e3d25f42fc243eb1d9ad937c7b5a1d8088f8c8c76e9118bd4db3ab",
  "companyIds": [
    "e80594bf-9fea-4e3e-b86f-1099b270332d"
  ],
  "events": [
    "order.new"
  ],
  "callback": "https://example.com/loko_callback"
}

Оновлення підписки

Update subscription

put

Update subscription

Authorizations

Path parameters

idstring · uuidRequired

Internal identifier

Example: 569e7427-14ca-43f1-8d4b-ed3b7f1fd197

Body

companyIdsstring[]OptionalExample: e80594bf-9fea-4e3e-b86f-1099b270332d

callbackstringOptionalExample: https://example.com/loko_callback

Responses

200

Ok

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

put

HTTPcURLJavaScriptPython

PUT /v1/merchant/callback/subscriptions/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "companyIds": [
    "e80594bf-9fea-4e3e-b86f-1099b270332d"
  ],
  "callback": "https://example.com/loko_callback",
  "events": [
    "order.new"
  ]
}

{
  "id": "1eedc61a-0f1b-60e8-a3ca-c9551a06168a",
  "secret": "ba7638de38e3d25f42fc243eb1d9ad937c7b5a1d8088f8c8c76e9118bd4db3ab",
  "companyIds": [
    "e80594bf-9fea-4e3e-b86f-1099b270332d"
  ],
  "events": [
    "order.new"
  ],
  "callback": "https://example.com/loko_callback"
}

Видалення непотрібної підписки

Remove subscription

delete

Remove subscription

Authorizations

Path parameters

idstring · uuidRequired

Internal identifier

Example: 569e7427-14ca-43f1-8d4b-ed3b7f1fd197

Responses

204

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/merchant/callback/subscriptions/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Отримання списку подій, доступних для підписки

Event list to subscribe

get

Event list to subscribe

Authorizations

Responses

200

Successful operation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

get

HTTPcURLJavaScriptPython

GET /v1/merchant/callback/events HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "total": 4,
  "items": [
    {
      "name": "order.new",
      "description": "Fires when new order created"
    },
    {
      "name": "order.status.changed",
      "description": "Fires when order status is changed"
    },
    {
      "name": "order.item.changed",
      "description": "Fires when order item is changed"
    },
    {
      "name": "order.courier.assigned",
      "description": "Fires when courier is assigned to order"
    }
  ]
}