SelSup Developers

Public API · API Referencja

Ustawienia

Punkty końcowe dla ustawień, w tym dokładne trasy, parametry, organy żądania i rozszerzalne schematy odpowiedzi.

Punkty końcowe: 3/api/propertyStabilnyOpis czytelny maszynowo ↗
{ }

Strona ta jest wspierana przez edytowalny samodzielny kontrakt.

/api/property

Gotowe do użytkowania przepływy robocze

Gotowe do użytkowania przepływy robocze

01

Zacznij używać ustawień

Użyj dedykowanego tokena API i najpierw sprawdź operacje odczytu z danymi testowymi.

  1. Trzymaj token z serwera i wysłać go w nagłówku Authorization.
  2. Sprawdź wymagane parametry i poszerz schemat żądania lub odpowiedzi.
  3. Zrób z statusem HTTP i stabilnym pole error w przypadku błędów aplikacyjnych.

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ą.

Property6 pola
organizationIdinteger · int64

Id organizacyjny.

clientIdinteger · int64

Id klientów.

read-only
componentstring

Komponent.

namestring

- Nazwa.

valuestring

Wartość.

valueNamestring

Nazwa wartości.

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

PUT

Zatrzymaj własność

/api/property/
Token z dostępem do pisania

Wstawić własność za pomocą PUT /api/property/.

Organ wnioskujący

application/json
Połączenia obiektuProperty
PoleTypWymaganeOpis
organizationId integer · int64 Nie Id organizacyjny.
clientId integer · int64 Nie Id klientów.
component string Nie Komponent.
name string Nie - Nazwa.
value string Nie Wartość.
valueName string Nie Nazwa wartości.
curl --request PUT 'https://api.selsup.ru/api/property/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}'

Odpowiedź udana

200

Odpowiedź nie ma ciała.

Władze7

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.

400error_cant_extract_tariffs
Nie można pobrać taryf. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_cant_extract_tariffs; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_invalid_currency_source
Podane źródło kursu waluty nie jest obsługiwane

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_invalid_currency_source; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_invalid_stock_distribution_rules
Nieprawidłowe reguły podziału zapasów: sprawdź udziały od 0 do 1 i progi zapasów.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_invalid_stock_distribution_rules; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

GET

- Wchodź.

/api/property/{organizationId}/{component}
Token z dostępem do odczytu

Użyj GET /api/property/{organizationId}/{component}.

Parametry ścieżki

PoleTypWymaganeOpis
organizationId integer · int64 Tak Id organizacyjny.
component string Tak Komponent.
curl --request GET 'https://api.selsup.ru/api/property/1001/string' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
"string"
Władze32

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.

400error_base_creating
Twój panel jest w trakcie tworzenia, poczekaj kilka minut do pełnego utworzenia panelu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_base_creating; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_cant_extract_tariffs
Nie można pobrać taryf. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_cant_extract_tariffs; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_cant_receive_stocks
nie udało się pobrać stanów magazynowych

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_cant_receive_stocks; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_client_branding_failed
Nie udało się wczytać lub zapisać ustawień marki.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_client_branding_failed; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_fbs_marking_code_unsupported
Kod oznaczania FBS nie jest obsługiwany

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_fbs_marking_code_unsupported; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_fulfillment_client_access_denied
Fulfillment client access denied

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_fulfillment_client_access_denied; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_fulfillment_client_contract_required
Zaakceptuj umowę, aby uzyskać dostęp do operacji.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_fulfillment_client_contract_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_fulfillment_request_invalid
Wniosek o wypełnienie nieważny

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_fulfillment_request_invalid; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_header_logo_upload_failed
Could not upload the logo. Please try again.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_header_logo_upload_failed; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_income_not_found
Nie znaleziono zamówienia dostawcy nr {id}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_income_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_integration_cell_mapping_invalid
Nieważne wykreswanie komórek integracyjnych

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_integration_cell_mapping_invalid; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_price_for_order_product
Nie określono ceny dla produktu: {name}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_price_for_order_product; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_quantity_for_order_product
Nie podano ilości produktu: {name}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_quantity_for_order_product; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_order_not_found
Nie znaleziono zamówienia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_order_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_organization_create_failed
Wystąpił problem podczas tworzenia organizacji. Proszę skontaktować się z pomocą techniczną

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_organization_create_failed; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_organization_exists
Organizacja została już utworzona

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_organization_exists; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_organization_not_found
Nie znaleziono organizacji

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_organization_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_ozon_fbo_workflow_not_found
Nie znaleziono procesu Ozon FBO {id}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_ozon_fbo_workflow_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_reload
Sesja autoryzacji wygasła, odśwież stronę przeglądarki. Jeśli odświeżenie nie pomaga, spróbuj usunąć pliki cookie dla witryny

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_reload; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_settlement_invalid
Nieważne rozliczenie

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_settlement_invalid; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_subscription_expired
Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_supply_not_found
Nie znaleziono dostawy: {name}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_supply_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_token_expired_or_revoked
Token API został odwołany lub wprowadzony nieprawidłowo. Sprawdź, czy klucz API ma pełną funkcjonalność. Wygeneruj nowy klucz i zastąp w SELSUP, ponieważ klucze mają okres ważności.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_token_expired_or_revoked; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_transport_waybill_invalid
Sprawdź dane listu przewozowego.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_transport_waybill_invalid; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_transport_waybill_source
List przewozowy jest niedostępny dla tej wysyłki lub dostawy.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_transport_waybill_source; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_user_does_not_have_this_organization
Użytkownik nie ma dostępu do tej organizacji

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_user_does_not_have_this_organization; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_warehouse_not_found
Nie znaleziono magazynu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_warehouse_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_warehouse_setup_unavailable
Nie dostępne urządzenia magazynowe

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_warehouse_setup_unavailable; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

GET

Lista

/api/property/list/{component}
Token z dostępem do odczytu

Lista używająca GET /api/property/list/{component}.

Parametry ścieżki

PoleTypWymaganeOpis
component string Tak Komponent.

Parametry zapytania

PoleTypWymaganeOpis
organizationId integer · int64 Nie Id organizacyjny.
curl --request GET 'https://api.selsup.ru/api/property/list/string' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Struktura pozycji zestawu Property[]
PoleTypWymaganeOpis
organizationId integer · int64 Nie Id organizacyjny.
clientId integer · int64 Nie Id klientów.
component string Nie Komponent.
name string Nie - Nazwa.
value string Nie Wartość.
valueName string Nie Nazwa wartości.
[
  "string"
]
Władze34

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.

400error_bad_request
Nieprawidłowy format żądania

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_bad_request; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_base_creating
Twój panel jest w trakcie tworzenia, poczekaj kilka minut do pełnego utworzenia panelu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_base_creating; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_cabinet_access_denied
Brak dostępu do tego obszaru roboczego.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_cabinet_access_denied; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_cant_extract_tariffs
Nie można pobrać taryf. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_cant_extract_tariffs; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_container_log_read_failed
Odczyt zapisu kontenera nie powiedziany

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_container_log_read_failed; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_container_log_request_invalid
Wniosek o zapisy zapisu kontenera nieważny

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_container_log_request_invalid; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_empty_first_name
Nie podano Imienia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_first_name; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_empty_last_name
Nie podano nazwiska

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_last_name; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_empty_organization_form
nie podano formy organizacji

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_organization_form; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_empty_organization_inn
Nie podano INN organizacji

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_organization_inn; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_empty_organization_name
Nie podano nazwy organizacji

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_organization_name; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_empty_position_name
Nie podano nazwy stanowiska

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_empty_position_name; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_fulfillment_client_access_denied
Fulfillment client access denied

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_fulfillment_client_access_denied; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_fulfillment_client_contract_required
Zaakceptuj umowę, aby uzyskać dostęp do operacji.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_fulfillment_client_contract_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_fulfillment_document_error
Nie można wygenerować dokumentu. Sprawdź parametry i zawartość operacji.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_fulfillment_document_error; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_fulfillment_request_invalid
Wniosek o wypełnienie nieważny

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_fulfillment_request_invalid; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_income_not_found
Nie znaleziono zamówienia dostawcy nr {id}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_income_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_max_page
Numer strony nie może być większy niż 100 000

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_max_page; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_price_for_order_product
Nie określono ceny dla produktu: {name}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_price_for_order_product; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_quantity_for_order_product
Nie podano ilości produktu: {name}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_quantity_for_order_product; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_order_not_found
Nie znaleziono zamówienia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_order_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_organization_create_failed
Wystąpił problem podczas tworzenia organizacji. Proszę skontaktować się z pomocą techniczną

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_organization_create_failed; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_organization_exists
Organizacja została już utworzona

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_organization_exists; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_position_exists
Stanowisko o takiej nazwie już istnieje

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_position_exists; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_reload
Sesja autoryzacji wygasła, odśwież stronę przeglądarki. Jeśli odświeżenie nie pomaga, spróbuj usunąć pliki cookie dla witryny

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_reload; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_subscription_expired
Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_warehouse_not_found
Nie znaleziono magazynu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_warehouse_not_found; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_wrong_crm_token
nieprawidłowy token CRM

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_wrong_crm_token; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_wrong_inn
Niepoprawnie podano NIP organizacji, długość 10 lub 12 cyfr

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_wrong_inn; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_wrong_version
Nieprawidłowo podano wersję

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_wrong_version; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

Authorization

Token do wniosków o badania

Uzyskaj token

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.