SelSup Developers

Public API · API Referencja

Kwit

Punkty końcowe do otrzymania, w tym dokładne trasy, parametry, organy żądania oraz rozszerzalne schematy odpowiedzi.

4 punkty końcowe/api/receiptStabilnyOpis czytelny maszynowo ↗
{ }

Strona ta jest wspierana przez edytowalny samodzielny kontrakt.

/api/receipt

Gotowe do użytkowania przepływy robocze

Gotowe do użytkowania przepływy robocze

Model danych

Struktura danych

Modele są wymienione tutaj raz i mogą być również rozszerzane bezpośrednio z punktów końcowych, które je wykorzystują.

Receipt14 pola
idinteger · int64

Id.

read-only
clientIdinteger · int64

Id klientów.

read-only
orderIdinteger · int64

Identyfikacja zamówienia.

read-only
organizationIdinteger · int64

Id organizacyjny.

read-only
externalReceiptIdstring

Wynik odbioru.

fiscalNumberstring

Numer fiskalny.

cashRegisterServicestring

Usługa rejestru gotówki.

fnsUrlstring

- Url.

statusstring

Status.

receiptTypestring

Typ kwitu.

totalAmountnumber · double

Źródło:

createdDatestring · date-time

Tworzony Termin.

read-only
completedDatestring · date-time

Termin zakończony.

errorMessagestring

Wiadomość błędu.

Umowa o błędzie

W jaki sposób można zwrócić błędy w aplikacji

Kod error jest identyczny w każdym miejscu, podczas gdy wiadomość skierowana do użytkownika jest tłumaczona przez serwer.

error

Stabilny kod czytelny maszynowo do logiki integracyjnej.

localMessage

Przesłanie gotowe do wyświetlania w języku użytkownika tokenu API.

params

Wartości interpołowane przez serwer w szablonie lokalizowanej wiadomości.

localMessage wykorzystuje pole lang użytkownika, który posiada token API. Język dokumentacji i nagłówek Accept-Language nie zmieniają go; rosyjski jest używany, gdy użytkujący nie ma konfigurowanego języka.

RULokalizacja użytkownika jest ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
PLPolski (pl)
{
  "error": "error_brand_already_exists",
  "localMessage": "Marka Base już istnieje",
  "params": {
    "name": "Base"
  }
}

Punkty końcowe

Punkty końcowe

GET

Otrzymuj kwity po zamówieniu

/api/receipt/order/{orderId}
Token z dostępem do odczytu

Uzyskaj kwoty za zamówienie za pomocą GET /api/receipt/order/{orderId}.

Parametry ścieżki

PoleTypWymaganeOpis
orderId integer · int64 Tak Identyfikacja zamówienia.
curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Struktura pozycji zestawu Receipt[]
PoleTypWymaganeOpis
id integer · int64 Nie Id.
clientId integer · int64 Nie Id klientów.
orderId integer · int64 Nie Identyfikacja zamówienia.
organizationId integer · int64 Nie Id organizacyjny.
externalReceiptId string Nie Wynik odbioru.
fiscalNumber string Nie Numer fiskalny.
cashRegisterService stringNONE, EVOTOR, ATOL Nie Usługa rejestru gotówki.
fnsUrl string Nie - Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Nie Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Nie Typ kwitu.
totalAmount number · double Nie Źródło:
createdDate string · date-time Nie Tworzony Termin.
completedDate string · date-time Nie Termin zakończony.
errorMessage string Nie Wiadomość błędu.
[
  "string"
]
Władze3

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

POST

Utwórz kwitancję do zamówienia

/api/receipt/order/{orderId}
Token z dostępem do pisania

Utworz Kwitę do zamówienia za pomocą POST /api/receipt/order/{orderId}.

Parametry ścieżki

PoleTypWymaganeOpis
orderId integer · int64 Tak Identyfikacja zamówienia.

Parametry zapytania

PoleTypWymaganeOpis
typeWartość domyślna: INCOME stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Nie Type.
curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu Receipt
PoleTypWymaganeOpis
id integer · int64 Nie Id.
clientId integer · int64 Nie Id klientów.
orderId integer · int64 Nie Identyfikacja zamówienia.
organizationId integer · int64 Nie Id organizacyjny.
externalReceiptId string Nie Wynik odbioru.
fiscalNumber string Nie Numer fiskalny.
cashRegisterService stringNONE, EVOTOR, ATOL Nie Usługa rejestru gotówki.
fnsUrl string Nie - Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Nie Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Nie Typ kwitu.
totalAmount number · double Nie Źródło:
createdDate string · date-time Nie Tworzony Termin.
completedDate string · date-time Nie Termin zakończony.
errorMessage string Nie Wiadomość błędu.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Władze3

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

GET

Otrzymaj kwitament

/api/receipt/{receiptId}
Token z dostępem do odczytu

Uzyskaj Kwitę za pomocą GET /api/receipt/{receiptId}.

Parametry ścieżki

PoleTypWymaganeOpis
receiptId integer · int64 Tak Idekcja odbioru.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu Receipt
PoleTypWymaganeOpis
id integer · int64 Nie Id.
clientId integer · int64 Nie Id klientów.
orderId integer · int64 Nie Identyfikacja zamówienia.
organizationId integer · int64 Nie Id organizacyjny.
externalReceiptId string Nie Wynik odbioru.
fiscalNumber string Nie Numer fiskalny.
cashRegisterService stringNONE, EVOTOR, ATOL Nie Usługa rejestru gotówki.
fnsUrl string Nie - Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Nie Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Nie Typ kwitu.
totalAmount number · double Nie Źródło:
createdDate string · date-time Nie Tworzony Termin.
completedDate string · date-time Nie Termin zakończony.
errorMessage string Nie Wiadomość błędu.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Władze3

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

GET

Aktualizacja stanu otrzymania

/api/receipt/{receiptId}/update
Token z dostępem do odczytu

Aktualizacja stanu otrzymania przy użyciu GET /api/receipt/{receiptId}/update.

Parametry ścieżki

PoleTypWymaganeOpis
receiptId integer · int64 Tak Idekcja odbioru.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu Receipt
PoleTypWymaganeOpis
id integer · int64 Nie Id.
clientId integer · int64 Nie Id klientów.
orderId integer · int64 Nie Identyfikacja zamówienia.
organizationId integer · int64 Nie Id organizacyjny.
externalReceiptId string Nie Wynik odbioru.
fiscalNumber string Nie Numer fiskalny.
cashRegisterService stringNONE, EVOTOR, ATOL Nie Usługa rejestru gotówki.
fnsUrl string Nie - Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Nie Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Nie Typ kwitu.
totalAmount number · double Nie Źródło:
createdDate string · date-time Nie Tworzony Termin.
completedDate string · date-time Nie Termin zakończony.
errorMessage string Nie Wiadomość błędu.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Władze3

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

Authorization

Token do wniosków o badania

Token pozostaje w lokalnym magazynie przeglądarki i jest wysyłany tylko w nagłówku Authorization z wniosków na api.selsup.ru.

Wypróbuj

Prawdziwe parametry żądania

Odpowiedź API

Wyślij wniosek o zapoznanie się z odpowiedzią SelSup.