1b.app
Link skopiowany -
Używamy plików cookie w celu optymalizacji treści i wydajności witryny. Kontynuując wizytę wyrażasz zgodę na używanie plików cookies.
ru ua en de
RU UA EN DE
Rejestracja logowania
  1. OneBox
    2. ›
  2. OneBox Rest API
    3. ›
  3. API Zamówienia

API Zamówienia

Dlaczego klienci tego potrzebują? Z reguły jest to tylko kilka rzeczy – przenieś zamówienie, produkt, kategorie, marki do BOX. Stosuje się w tym celu kilka metod. Więcej szczegółów poniżej



Dodanie zamówienia, metoda: /api/orders/add/

Opcje

Przykład:

http://myboxurl/api/orders/add/?login=LOGIN&password=PASSWORD&clientnamefirst=Bazylia&clientnamelast=Iwanow&clientemail=vasyas33@test.ru&clientphone=+380639370442&clientcode=31333&clientaddress=Kijów&managername=Inna Leonowa&ordercode=1333&sum=320&comments=wpłacił zaliczkę&source=mój sklep&payed=1&productArray[0][id]=100500&productArray[0][name]=Test PRODUKT1&productArray[0][price]=102&productArray[0][count]=1&productArray[1][id]=123131&productArray[1][name]=Nowy%20test%20produkt2&productArray[1][price]=122&productArray[1][count]=2

Nie ma potrzeby tworzenia kontaktu przed złożeniem zamówienia, system BOX sam go utworzy, jeśli zajdzie taka potrzeba..
Dodanie projektu lub zadania za pomocą REST API jest podobne do dodania zamówienia. W tym celu obowiązkowym parametrem przy wysyłaniu zapytania jest parametr flowname, który służy do przekazania nazwy Procesu Biznesowego, w którym chcesz utworzyć projekt/zamówienie/zadanie. Jeśli podasz nazwę Procesu Biznesowego, koniecznie sprawdź, czy został on utworzony w Twoim OneBoxie. Jeśli nie określisz Procesu Biznesowego, wybrany zostanie domyślny Proces Biznesowy dla zamówień.


№ Pole Typ Opis Obowiązkowe lub nie Komentarz
1 login string Zaloguj się w systemie BOX Pole obowiązkowe.  
2 password string Hasło w formacie md5 Pole obowiązkowe. Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3 ordercode string id zamów ze swojego systemu Pole obowiązkowe. Jest to unikalny identyfikator zamówienia z Twojego systemu (z Twojego sklepu). Jeśli istnieje zamówienie o tym identyfikatorze, API zgłosi błąd
4 workflowname string Nazwa procesu biznesowego dla zamówień Pole nie wymagane. Podaj nazwę PPG, do którego chcesz dodać zlecenie. Jeśli określisz zasilacz, sprawdź, czy został on utworzony w Twoim BOX. Jeżeli tego nie określisz, wybrany zostanie domyślny BP dla zleceń.
5 statusname string status zamówienia Pole nie wymagane. Określ status z BP, do którego chcesz dodać zamówienie. Jeśli nie określisz statusu, domyślnym będzie status początkowy..
6 source string Zamów kanał Pole nie wymagane.  
7 cdate datetime Data zamówienia Pole nie wymagane. Data utworzenia zamówienia musi być w formacie (Ymd H:i:s) Przykład: 2015-12-15 23:11:00
8 name string Nazwa zamówienia Pole nie wymagane.  
9 clientcode string id klienta z zamówienia Pole nie wymagane. W tym polu możesz wpisać identyfikator użytkownika z zamówienia z Twojego systemu.
10 clientnamefirst string Nazwa klienta z zamówienia Pole nie wymagane.  
11 clientnamelast string Nazwisko Klienta z zamówienia Pole nie wymagane.  
12 clientnamemiddle string Drugie imię klienta z zamówienia Pole nie wymagane.  
13 clientphone integer Numer telefonu klienta z zamówienia Wymagany jest adres e-mail lub numer telefonu klienta Najlepiej w formacie 380XXXXXXXXXXXX
14 clientemail string Email klienta z zamówienia  
15 clientaddress string Adres klienta z zamówienia Pole nie wymagane.  
16 managercode string id kierownik z zamówienia Pole nie wymagane. W tym polu możesz wpisać identyfikator menadżera z zamówienia z Twojego systemu.
17 managername string Nazwisko menedżera z zamówienia Pole nie wymagane.  
18 managerphone integer Numer telefonu menadżera z zamówienia Pole nie wymagane. Najlepiej w formacie 380XXXXXXXXXXXX
19 manageremail string Email kierownik z zamówienia Pole nie wymagane.  
20 comments string Komentarz do zamówienia Pole nie wymagane. W tym polu możesz wpisać wszelkie potrzebne informacje dotyczące zamówienia.
21 deliveryid integer id sposób dostawy zamówienia Pole nie wymagane. Jeśli Twój system WebProduction BOX dodał metody dostawy, podaj identyfikator żądanej metody dostawy
22 deliverynote string Uwagi dotyczące realizacji zamówienia Pole nie wymagane.  
23 sum float cena zamówienia Pole nie wymagane.  
24 payed true / false Czy zamówienie zostało opłacone? Pole nie wymagane. Jeżeli zamówienie zostało opłacone to wpisz true w to pole i płatność za to zamówienie zostanie dodana do BOX w sekcji finansów oraz w samym zamówieniu.
25 productArray array (id, name, price, count) Zestawienie towarów z zamówienia Pole nie wymagane.
id - id towar z BOX, jeśli taki istnieje, system powiąże go z zamówieniem
code1c - id produkt z Twojego systemu, jeśli taki istnieje, system powiąże go z zamówieniem
articul - produkt z systemu, jeśli taki istnieje, system powiąże go z zamówieniem
name - Nazwa produktu
price - cena za sztukę za sztukę
count - ilość tego produktu w zamówieniu
currency - waluta towaru w zamówieniu (UAH, RUB, USD, EUR itp.)..)
discount_percent - Procent rabatu na produkt procesowy
supplierid - ID dostawca w systemie
suppliercode1c - Identyfikator dostawcy zewnętrznego w systemie
custom_{key} - Custom-pole. Zamiast {key} należy wprowadzić klucz dodatkowego pola z zamówienia produktu
26 workflowid integer ID Proces biznesowy Pole nie wymagane. Podaj identyfikator BP, do którego chcesz dodać zamówienie/zadanie/projekt. Jeśli określisz zasilacz, sprawdź, czy został on utworzony w Twoim OneBox.
27 statusid integer ID Status zamówienia Pole nie wymagane. Określ identyfikator statusu, do którego chcesz przenieść BP. Jeśli nie określisz statusu, domyślnym będzie status początkowy..
28 type string Typ zasilacza Pole nie wymagane. Jeśli nie określisz zasilacza, wskaż typ zasilacza, który chcesz dodać
29 utm_date string UTL etykieta utm_date Pole nie wymagane.  
30 utm_campaign string UTL etykieta utm_campaign Pole nie wymagane.  
31 utm_source string UTL etykieta utm_source Pole nie wymagane.  
32 utm_content string UTL etykieta utm_content Pole nie wymagane.  
33 utm_referrer string UTL etykieta utm_referrer Pole nie wymagane.  
34 utm_medium string UTL etykieta utm_medium Pole nie wymagane.  
35 utm_term string UTL etykieta utm_term Pole nie wymagane.  
36 custom_{key} string Custom-pole Zamiast {key} należy wpisać klucz dodatkowego pola z zamówienia Podczas przekazywania łącza do pliku dla dodatkowego pola z typem" Plik" - zostanie on załadowany do systemu, a identyfikator zostanie wpisany w dodatkowym polu
37 customuser_{key} string Custom-pole klienta Zamiast {key} należy wprowadzić dodatkowy klucz pola z karty kontaktu Podczas przekazywania łącza do pliku dla dodatkowego pola z typem" Plik" - zostanie on załadowany do systemu, a identyfikator zostanie wpisany w dodatkowym polu
38 dateto datetime Data planowania zamówienia (zadanie) Pole nie wymagane. Data planowania zamówienia musi być w formacie (Ymd H:i:s) Przykład: 2015-12-15 23:11:00
39 deliveryprice float koszt przesyłki Pole nie wymagane.  
40 discountid integer ID rabaty z systemu OneBox Pole nie wymagane.  
41 discountname string Nazwa rabatu z systemu OneBox Pole nie wymagane.  
42 discountsum float Kwota rabatu Pole nie wymagane.  
43 contractorid integer Osoba prawna zamówienia Pole nie wymagane.  
44 paymentid integer ID metoda płatności Pole nie wymagane. id metoda płatności z systemu OneBox
45 paymentname string Nazwa metody płatności Pole nie wymagane. Jeśli podasz ten parametr, system spróbuje znaleźć tę metodę płatności w OneBox i podnieść ją
46 country string Kraj Pole nie wymagane.  
47 region string Region (obszar) Pole nie wymagane.  
48 district string Obszar Pole nie wymagane.  
49 city string Nazwa miejscowości Pole nie wymagane.  
50 street string Ulica Pole nie wymagane.  
51 street_number string numer domu Pole nie wymagane.  
52 apartment string Apartament Pole nie wymagane.  
53 currencyrate_{key} string Kurs waluty dla zamówienia Zamiast {key} musisz wpisać nazwę waluty  
54 documenttemplateid int ID szablon dokumentu Pole nie wymagane. Po utworzeniu procesu zostanie podjęta próba wygenerowania dokumentu według podanego szablonu dokumentu.
55 documentpdf base64 encoded string Zawartość wygenerowanego dokumentu PDF w kodowaniu base64. Pole nie wymagane. Po wygenerowaniu dokumentu za pomocą documenttemplateid zawartość dokumentu PDF zostanie zdekodowana i dodana jako zeskanowana kopia do utworzonego dokumentu.
56 dataFromBody boolean Pobieraj dane nie z argumentów, ale z treści Pole nie wymagane. Jeżeli zostanie przekazane dataFromBody=1, to dane zostaną pobrane nie z argumentów, ale z treści żądania. Należy przekazać treść json, w której klucze muszą mieć parametry opisane powyżej. login i hasło powinny zostać wysłane jak zwykle
57 typesex string Typ klienta procesu Pole nie wymagane. Możesz przenieść nazwę lub klucz typu kontaktu z ustawień systemu" Typy kontaktów"
58 parentid integer id proces nadrzędny Pole nie wymagane. id proces, który należy wyznaczyć jako nadrzędny, bieżący proces stanie się jego podprocesem
59 company string Nazwa firmy klienta Pole nie wymagane. Jeśli nie zostanie znaleziona firma o tej samej nazwie, zostanie ona utworzona
60 files string|array Pliki opisu procesu Pole nie wymagane. Link lub tablica linków do plików, które należy pobrać i dodać do opisu procesu
61 restoreSource boolean Odzyskaj usunięte źródło Pole nie wymagane. Jeśli przesyłane źródło zostanie usunięte, zostanie ono przywrócone. Data utworzenia źródła zostanie zaktualizowana do aktualnej.

Usuwanie zamówienia metoda: /api/orders/delete/

Opcje

Przykład:

http://myboxurl/api/orders/delete/?login=LOGIN&password=PASSWORD&orderid=660

№ Pole Typ Opis Obowiązkowe lub nie Komentarz
1 login string Zaloguj się w systemie BOX Pole obowiązkowe.  
2 password string Hasło w formacie md5 Pole obowiązkowe. Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3 orderid string Identyfikator zamówienia Pole obowiązkowe. W tym polu możesz podać identyfikator zamówienia, który został zwrócony przez nasze API podczas jego tworzenia. Lub przekaż tam zewnętrzny identyfikator zamówienia (pole ordercode podczas tworzenia zamówienia . System spróbuje odnaleźć zlecenie o takim zewnętrznym identyfikatorze i je usunąć.

Edycja zamówienia, metoda: /api/orders/update/

Opcje

Przykład:

http://myboxurl/api/orders/update/?login=LOGIN&password=PASSWORD&orderid=660&&name=Zmiana nazwy zamówienia&workflowname=Zamówienie&statusname=Dostarczony&payed=1

№ Pole Typ Opis Obowiązkowe lub nie Komentarz
1 login string Zaloguj się w systemie BOX Pole obowiązkowe.  
2 password string Hasło w formacie md5 Pole obowiązkowe. Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3 orderid string Identyfikator zamówienia Pole obowiązkowe. W tym polu możesz podać identyfikator zamówienia, który został zwrócony przez nasze API podczas jego tworzenia. Lub przekaż tam zewnętrzny identyfikator zamówienia (pole ordercode podczas tworzenia zamówienia). System spróbuje znaleźć zamówienie o tym zewnętrznym identyfikatorze.
4 name string Nazwa zamówienia Pole nie wymagane.  
5 comments string Komentarze do zamówienia Pole nie wymagane.  
6 sum float cena zamówienia Pole nie wymagane.  
7 deliverynote string Komentarze dotyczące dostawy Pole nie wymagane.  
8 workflowname string Proces zamówienia biznesowego Pole nie wymagane. Za pośrednictwem API możesz zmienić zamówienie BP na inne
9 statusname string Status zamówienia dla tego BP Pole nie wymagane. Ustaw inny status zamówienia
10 payed boolean Czy powinienem dokonać płatności za zamówienie? Pole nie wymagane. Czy zamówienie zostało opłacone?
11 productArray array Dodaj produkty do zamówienia Pole nie wymagane. Możesz dodać produkty do istniejącego zamówienia. W takim przypadku jego kwota zostanie automatycznie przeliczona
id - id towar z BOX, jeśli taki istnieje, system powiąże go z zamówieniem
code1c - id produkt z Twojego systemu, jeśli taki istnieje, system powiąże go z zamówieniem
articul - produkt z systemu, jeśli taki istnieje, system powiąże go z zamówieniem
name - Nazwa produktu
price - cena za sztukę za sztukę
count - ilość tego produktu w zamówieniu
currency - waluta towaru w zamówieniu (UAH, RUB, USD, EUR itp.)..)
storagecode1c - Zewnętrzny identyfikator magazynu, w którym BOX podejmie próbę rezerwacji towaru, jeśli nie jest on jeszcze zarezerwowany
storagefromcode1c - identyfikator magazynu zewnętrznego. Jeżeli przekażesz ten parametr, w magazynie Storagecode1c zostaną zarezerwowane tylko te towary, które aktualnie znajdują się w magazynie storefromcode1c
suplierid - ID dostawca w systemie
supliercode1c - Zewnętrzny identyfikator dostawcy
custom_{key} - Custom-pole. Zamiast {key} należy wprowadzić klucz dodatkowego pola z zamówienia produktu
12 workflowid integer Id Biznes związany z zamówieniem Pole nie wymagane. Za pośrednictwem API możesz zmienić zamówienie BP na inne
13 statusid integer Id status tego BP Pole nie wymagane. Ustaw inny status według identyfikatora
14 deleteproducts 0/1 Usuń produkty z zamówienia Pole nie wymagane. Jeśli 1 - usuwa wszystkie produkty w edytowanej kolejności
15 dataFromBody boolean Pobieraj dane nie z argumentów, ale z treści Pole nie wymagane. Jeżeli zostanie przekazane dataFromBody=1, to dane zostaną pobrane nie z argumentów, ale z treści żądania. Należy przekazać treść json, w której klucze muszą mieć parametry opisane powyżej. login i hasło powinny zostać wysłane jak zwykle
16 paymentid integer ID sposób płatności za proces Pole nie wymagane.  
17 customuser_[key] optional Dodatkowe pole klienta procesu Pole nie wymagane. Zamiast [key] konieczne jest podstawienie identyfikatora dodatkowego pola klienta
17 customorder_[key] optional Dodatkowe pole procesowe Pole nie wymagane. Zamiast [key] należy zastąpić identyfikator dodatkowego pola procesu
Podczas przekazywania łącza do pliku dla dodatkowego pola z typem" Plik" - zostanie on załadowany do systemu, a identyfikator zostanie wpisany w dodatkowym polu.
18 clientemail string Email klient procesu Pole nie wymagane. Zapisuje do procesu i jest dodawany do klienta procesu. Jeśli nie ma procesu klienta, służy on do znalezienia (i utworzenia) klienta.
19 clientphone string Przetwarzaj numer telefonu klienta Pole nie wymagane. Zapisuje do procesu i jest dodawany do klienta procesu. Jeśli nie ma procesu klienta, służy on do znalezienia (i utworzenia) klienta.
20 clientname string Nazwa klienta z zamówienia Pole nie wymagane. Służy do aktualizowania klienta procesu (i tworzenia go, jeśli nie istnieje)
21 clientnamelast string Nazwisko Klienta z zamówienia Pole nie wymagane. Służy do aktualizowania klienta procesu (i tworzenia go, jeśli nie istnieje)
22 clientnamemiddle string Drugie imię klienta z zamówienia Pole nie wymagane. Służy do aktualizowania klienta procesu (i tworzenia go, jeśli nie istnieje)
23 clienttypesex string Rodzaj (płeć) klienta z zamówienia Pole nie wymagane. Służy do aktualizowania klienta procesu (i tworzenia go, jeśli nie istnieje)
24 clientexternalid string Zewnętrzny identyfikator klienta z zamówienia Pole nie wymagane. Służy do aktualizowania klienta procesu (i tworzenia go, jeśli nie istnieje)
25 clientcode string Kod (EDRPOU/INN) klienta ze zlecenia Pole nie wymagane. Służy do aktualizowania klienta procesu (i tworzenia go, jeśli nie istnieje)
26 clientcompany string Firma klienta z zamówienia Pole nie wymagane. Służy do aktualizowania klienta procesu (i tworzenia go, jeśli nie istnieje)
27 searchclient boolean Wyszukaj klienta po danych kontaktowych, nawet jeśli jest on obecny w zamówieniu Pole nie wymagane.
28 country string Kraj Pole nie wymagane. Służy do aktualizacji adresu klienta procesu
29 region string Region (obszar) Pole nie wymagane. Służy do aktualizacji adresu klienta procesu
30 district string Obszar Pole nie wymagane. Służy do aktualizacji adresu klienta procesu
31 city string Nazwa miejscowości Pole nie wymagane. Służy do aktualizacji adresu klienta procesu
32 street string Ulica Pole nie wymagane. Służy do aktualizacji adresu klienta procesu
33 street_number string numer domu Pole nie wymagane. Służy do aktualizacji adresu klienta procesu
34 apartment string Apartament Pole nie wymagane. Służy do aktualizacji adresu klienta procesu
35 deliveryid integer id sposób dostawy zamówienia Pole nie wymagane. Jeśli Twój system WebProduction BOX dodał metody dostawy, podaj identyfikator żądanej metody dostawy
36 novaposhtadeliverynote string Nowy numer poczty TTN Pole nie wymagane.
37 novaposhtaredeliverynote string Nowy numer TTN doręczenia poczty zwrotnej Pole nie wymagane.
38 novaposhtaServiceType string Metoda dostawy Nova Posta Pole nie wymagane. Dostępne wartości:
WarehouseWarehouse - Cmagazyn skarbów WarehouseDoors - CDrzwi Skarbów DoorsWarehouse - Drzwi-Magazyn DoorsDoors - Drzwi-Drzwi
39 utm_XXX (gdzie zamiast XXX umieszczasz potrzebną etykietę, na przykład utm_source, utm_date) string UTM znaczniki procesów Pole nie wymagane.
40 files string|array Pliki opisu procesu Pole nie wymagane. Link lub tablica linków do plików, które należy pobrać i dodać do opisu procesu

Otrzymanie jednego zamówienia i przyjęcie wszystkich zamówień, metoda: /api/orders/get/

Opcje
Opcje otrzymania jednego zamówienia:

Przykład:

http://myboxurl/api/orders/get/?login=LOGIN&password=PASSWORD&orderid=7927

№ Pole Typ Opis Obowiązkowe lub nie Komentarz
1 login string Zaloguj się w systemie BOX Pole obowiązkowe.  
2 password string Hasło w formacie md5 Pole obowiązkowe. Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3 supplierhash string Klucz dostawcy Pole nie wymagane. Dostępne w karcie klienta, która jest kontaktem dostawcy.
Dostępne z loginem systemowym i hasłem oraz poziomem dostępu" klient".
Umożliwia ograniczenie dostępu do procesów wyszukiwania zgodnie z powiązaniem dodatkowego pola procesu z kluczem dostawcy (patrz. Ustawienia" Walidacje i wyjątkowość") lub tylko w przypadku, gdy osobą kontaktową jest klient-dostawca.
4 orderid string Identyfikator zamówienia Pole obowiązkowe. Jeśli potrzebujesz konkretnego zamówienia, podajesz w tym polu albo identyfikator zamówienia, który został Ci zwrócony przez nasze API podczas jego tworzenia. Lub przekaż tam zewnętrzny identyfikator zamówienia (pole ordercode podczas tworzenia zamówienia). System spróbuje znaleźć zamówienie o tym zewnętrznym identyfikatorze.
Istnieje również możliwość otrzymania zamówienia za pomocą dodatkowych pól zamówienia. W tym celu należy przekazać dodatkowy identyfikator. pola (wyświetlane w ustawieniach) z prefiksem' customorder_' i podaj wartość, której szukasz, na przykład customorder_idKeydoppolya=wartość

Zwróć wartości pól
orderid - id Zamówienie
ordercode - identyfikator zamówienia zewnętrznego,
ordername - Nazwa zamówienia,
clientId - id klient w systemie BOX,
clientcode - zewnętrzny identyfikator klienta w systemie BOX,
clientname - Nazwa klienta,
clientemail - email klient,
clientphone - telefon klienta,
clientaddress - adres klienta,
managerid - id kierownik zamówień,
managername - Nazwa kierownik zamówień,
managerrole - Rola kierownik zamówień,
cdate - Data zamówienia,
dateto - data planowania zamówienia,
deliveriID - id Sposób dostawy,
deliverinote - uwagi dotyczące dostawy,
deliveriprice - koszt przesyłki,
sum - cena zamówienia,
sumbase - podstawowa kwota zamówienia,
currency - waluta zamówienia,
statusname - status zamówienia,
workflowname - zamów nazwę BP,
contractorid - id zamówienie osoby prawnej,
contractorname - nazwa osoby prawnej zamówienia,
weight - całkowita waga zamówienia,
gabarite - całkowita wielkość zamówienia,
products - z jakich składa się asortyment produktów z zamówienia:
  • id - ID produktu
  • name - Nazwa produktu
  • count - Ilość produktu
  • price - Cena produktu
  • discountsum - kwota rabatu
  • discountpercent - procent zniżki
  • pricewithdiscount - obniżona cena produktu
  • storageId - identyfikator magazynu produktów
  • storageExternalId - zewnętrzny identyfikator magazynu produktów
  • productsource - rodzaj produktu (zwraca produkt lub usługę)
  • pricewithvat - Cena z VAT
  • pricewithoutvat - Cena bez VAT
  • productpricewithvat - Koszt zawiera podatek VAT
  • productpricewithoutvat - koszt bez VAT
  • producttaxvalue - FAKTURA VAT (%)
  • supplierid - ID dostawca w systemie
  • suppliercode1c - Identyfikator dostawcy zewnętrznego w systemie
  • suppliername - Nazwa dostawcy w systemie
  • customfields - dodatkowe pola produktowe zamówienia, na które składają się:
    • key - klucz_dodatkowego_pola
    • name - nazwa dodatkowego pola
    • value - dodatkowa wartość pola
customfields - tablica dodatkowych pól w kolejności, na które składają się:
  • key - klucz_dodatkowego_pola
  • name - nazwa dodatkowego pola
  • value - dodatkowa wartość pola
5 sumoutbonuse bool Liczba bonusów odpisanych w toku Pole nie wymagane.  
6 suminbonuse bool Liczba naliczonych bonusów w toku Pole nie wymagane.  
7 getcomments bool Otrzymuj komentarze na temat procesu Pole nie wymagane. Zwraca tablicę ze wszystkimi komentarzami dla procesu

Każdy element tablicy będzie zawierał
id - id uwagi,
cdate - data utworzenia komentarza,
type - typ komentarza,
content - tekst komentarza,
showtoclient - czy komentarz jest pokazywany klientowi?,
userid - id kontakt, który zostawił komentarz,
usercode - zewnętrzny identyfikator kontaktu,
username - Nazwa Kontaktu,
useremail - email kontakt,
userphone - Telefoniczny numer kontaktowy,
8 unescapedunicode bool Nie koduj znaków Unicode Pole nie wymagane. Podczas przekazywania wartości 1 tego parametru w wynikowym formacie JSON znaki Unicode nie będą kodowane, na przykład cyrylica" а" zostanie przesłany jako" а", nie jak" \u0430"
9 getnovaposhtastatus bool Otrzymuj statusy usługi Nowa poczta Pole nie wymagane. Po przekazaniu wartości 1 tego parametru na liście pól pojawi się dodatkowo status TTN oraz status zwrotnego TTN Nowej Poczty


Opcje otrzymywania wszystkich zamówień:

Przykład:

http://myboxurl/api/orders/get/?login=LOGIN&password=PASSWORD&part=1
http://myboxurl/api/orders/get/?login=LOGIN&password=PASSWORD&part=2

№ Pole Typ Opis Obowiązkowe lub nie Komentarz
1 login string Zaloguj się w systemie BOX Pole obowiązkowe.  
2 password string Hasło w formacie md5 Pole obowiązkowe. Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3 supplierhash string Klucz dostawcy Pole nie wymagane. Dostępne w karcie klienta, która jest kontaktem dostawcy.
Dostępne z loginem systemowym i hasłem oraz poziomem dostępu" klient".
Umożliwia ograniczenie dostępu do procesów wyszukiwania zgodnie z powiązaniem dodatkowego pola procesu z kluczem dostawcy (patrz. Ustawienia" Walidacje i wyjątkowość") lub tylko w przypadku, gdy osobą kontaktową jest klient-dostawca.
4 workflowname string Nazwa procesu biznesowego dla zamówień Pole nie wymagane. Podaj nazwę Procesu biznesowego, według którego chcesz filtrować zamówienia/zadania/projekty
5 workflowid string ID Proces biznesowy Pole nie wymagane. Podaj identyfikator procesu biznesowego, według którego chcesz filtrować zamówienia/zadania/projekty. Jeśli określisz zasilacz, sprawdź, czy został on utworzony w Twoim OneBox.
6 type string Typ zasilacza Pole nie wymagane. Określ Typ procesu biznesowego, aby filtrować zamówienia/zadania/projekty o danym typie
7 statusname string status zamówienia Pole nie wymagane. Podaj nazwę statusu BP, według którego chcesz filtrować zamówienia/zadania/projekty.
8 statusid string ID Status zamówienia Pole nie wymagane. Podaj identyfikator statusu BP, według którego chcesz filtrować zamówienia/zadania/projekty.
9 cdate date Data utworzenia zamówienia Pole nie wymagane. Podaj datę utworzenia, a ostateczna selekcja obejmie tylko te zamówienia, których data utworzenia jest większa lub równa podanej
10 udate date Data i godzina ostatniej aktualizacji zamówienia Pole nie wymagane. Podaj datę ostatniej aktualizacji, a ostateczny wybór obejmie tylko te zamówienia, w których data ostatniej zmiany jest większa lub równa podanej
11 clientId string ID klient w systemie BOX Pole nie wymagane. Określ identyfikator klienta, według którego chcesz filtrować procesy.
12 clientcode string zewnętrzny identyfikator klienta w systemie BOX Pole nie wymagane. Określ zewnętrzny identyfikator klienta, według którego chcesz filtrować procesy.
13 sumoutbonuse bool Liczba bonusów odpisanych w toku Pole nie wymagane.  
14 suminbonuse bool Liczba naliczonych bonusów w toku Pole nie wymagane.  
15 typesex string Typ kontaktu z klientem procesowym Pole nie wymagane. Aby filtrować procesy według typu kontaktu z klientem w procesie, należy przekazać klucz typu kontaktu (np. firma)
16 customorder_[klucz] optional Filtrowanie procesów według dodatkowych pól procesów Pole nie wymagane. Dla dodatkowych pól o typach „Liczba całkowita”, „Liczba zmiennoprzecinkowa”, „Data i godzina”, „Data”, „Czas” dostępne jest filtrowanie po zakresie wartości OD i TO poprzez przekazanie parametrów niestandardowezamówienie_[ klucz]_od i niestandardowe zamówienie_[klucz ]_to
17 customuser_[klucz] optional Filtrowanie procesów według dodatkowych pól klienta procesu Pole nie wymagane. Dla dodatkowych pól o typach „Liczba całkowita”, „Liczba zmiennoprzecinkowa”, „Data i godzina”, „Data”, „Czas” dostępne jest filtrowanie po zakresie wartości OD i TO poprzez przekazanie parametrówcustomuser_[ klucz]_od i niestandardowyużytkownik_[klucz]_to
18 part integer Niektóre zamówienia Pole obowiązkowe. API wydaje do 1000 zamówień w pierwszej części, aby otrzymać kolejne 1000 zamówień, przenieś tam 2 (otrzymujesz część 2) i tak dalej.

Zwróć wartości pól
orderid - id Zamówienie
ordernumber - Numer zamówienia
ordercode - identyfikator zamówienia zewnętrznego,
ordername - Nazwa zamówienia,
clientId - id klient w systemie BOX,
clientcode - zewnętrzny identyfikator klienta w systemie BOX,
clientname - Nazwa klienta,
clientemail - email klient,
clientphone - telefon klienta,
clientaddress - adres klienta,
managerid - id kierownik zamówień,
managername - Nazwa kierownik zamówień,
managerrole - Rola kierownik zamówień,
cdate - Data zamówienia,
deliveriID - id Sposób dostawy,
deliverinote - uwagi dotyczące dostawy,
deliveriprice - koszt przesyłki,
sum - cena zamówienia,
sumbase - podstawowa kwota zamówienia,
currency - waluta zamówienia,
statusname - status zamówienia,
workflowname - zamów nazwę BP,
contractorid - id zamówienie osoby prawnej,
contractorname - nazwa osoby prawnej zamówienia,
products - z jakich składa się asortyment produktów z zamówienia:
  • id - ID produktu
  • name - Nazwa produktu
  • count - Ilość produktu
  • price - Cena produktu
  • storageId - identyfikator magazynu produktów
  • storageExternalId - zewnętrzny identyfikator magazynu produktów
  • productsource - rodzaj produktu (zwraca produkt lub usługę)
  • pricewithvat - Cena z VAT
  • pricewithoutvat - Cena bez VAT
  • productpricewithvat - Koszt zawiera podatek VAT
  • productpricewithoutvat - koszt bez VAT
  • producttaxvalue - FAKTURA VAT (%)
  • supplierid - ID dostawca w systemie
  • suppliercode1c - Identyfikator dostawcy zewnętrznego w systemie
  • suppliername - Nazwa dostawcy w systemie
  • customfields - dodatkowe pola produktowe zamówienia, na które składają się:
    • key - klucz_dodatkowego_pola
    • name - nazwa dodatkowego pola
    • value - dodatkowa wartość pola
customfields - tablica dodatkowych pól w kolejności, na które składają się:
  • key - klucz_dodatkowego_pola
  • name - nazwa dodatkowego pola
  • value - dodatkowa wartość pola


Dostępne jest także filtrowanie procesów według zwróconych pól, a także pól klientów procesów.
Konieczne jest przekazanie parametru równego nazwie zwracanej zmiennej i wartości do filtrowania według pola zmiennej.
Przykładowo po przekazaniu parametru contactCountry=Ukraina zostaną odfiltrowane procesy, których klienci mają w adresie podany kraj" Ukraina".
Lub po przekazaniu parametru Contractorid=1 filtrowane będą procesy, które mają podmiot prawny o podanym identyfikatorze=1
19 getcomments bool Otrzymuj komentarze na temat procesu Pole nie wymagane. Zwraca tablicę ze wszystkimi komentarzami dla procesu

Każdy element tablicy będzie zawierał
id - id uwagi,
cdate - data utworzenia komentarza,
type - typ komentarza,
content - tekst komentarza,
showtoclient - czy komentarz jest pokazywany klientowi?,
userid - id kontakt, który zostawił komentarz,
usercode - zewnętrzny identyfikator kontaktu,
username - Nazwa Kontaktu,
useremail - email kontakt,
userphone - Telefoniczny numer kontaktowy,
20 unescapedunicode bool Nie koduj znaków Unicode Pole nie wymagane. Podczas przekazywania wartości 1 tego parametru w wynikowym formacie JSON znaki Unicode nie będą kodowane, na przykład cyrylica" а" zostanie przesłany jako" а", nie jak" \u0430"
21 getnovaposhtastatus bool Otrzymuj statusy usługi Nowa poczta Pole nie wymagane. Po przekazaniu wartości 1 tego parametru na liście pól pojawi się dodatkowo status TTN oraz status zwrotnego TTN Nowej Poczty

Otrzymuj uwagi dotyczące procesu, metoda: /api/order/comments/get/

Opcje
Opcje otrzymania jednego zamówienia:

Przykład:

http://myboxurl/api/order/comments/get/?login=LOGIN&password=PASSWORD&id=7927

Odpowiedź będzie miała postać JSON z tablicą danych dotyczących komentarza i autora komentarza.


№ Pole Typ Opis Obowiązkowe lub nie Komentarz
1 login string Zaloguj się w systemie BOX Pole obowiązkowe.  
2 password string Hasło w formacie md5 Pole obowiązkowe. Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3 id string Identyfikator procesu Pole obowiązkowe. ID proces w OneBox. Zostanie użyty do znalezienia procesu.
3 code string Identyfikator procesu zewnętrznego Pole nie wymagane. Identyfikator procesu zewnętrznego w OneBox. Zostanie użyty do znalezienia procesu.
3 type array Tablica typów komentarzy Pole nie wymagane. Dostępne typy:
comment - Komentarz:
commentresult - wynik:
change - zmiana:
email - list
call - dzwonić
notify - powiadomienie

Możliwe odpowiedzi na zapytanie

Więcej szczegółów
№ Status Wiadomość Opis wiadomości
1 ok orderid Zwraca identyfikator dodanego zamówienia
2 fail login_empty Brak logowania
3 fail password_empty Brak hasła
4 fail clientnamefirst_empty Brak nazwiska klienta
5 fail Bad user level! Niski poziom użytkownika, aby wykonać tę akcję (wymagany poziom 2 lub wyższy)
6 fail Login or password not correct! Login lub hasło wpisane niepoprawnie
7 fail orderId_empty Brak identyfikatora zamówienia
8 fail Order is already! Zamówienie już istnieje
9 fail Not workflow status by name Nie ma statusu BP o tej nazwie
10 fail Not workflow by name Nie ma procesu biznesowego o tej nazwie
11 fail Please create Finance Account Utwórz konto finansowe
12 fail Order with this Code does not found! Nie znaleziono zamówienia z tym kodem
13 fail clientphone_and_clientemail_empty Brak telefonu klienta i adresu e-mail

Mogą również wystąpić błędy:

502 Bad Gateway - Jeśli wystąpi ten błąd, musisz to zrobić:
1. Sprawdź, czy jest dostęp do Internetu (przejdź do dowolnej innej witryny).
2. Jeśli nie ma problemów z dostępem — możesz usunąć pliki cookie.
Jeśli powyższe nie pomogło — problem po stronie serwera. Powinieneś skontaktować się z administratorem systemu lokacji.

503 (Service Temporarily Unavailable) - Ten błąd może wystąpić w wyniku zbyt dużej liczby żądania do serwera. Jeśli widzisz ten błąd, odczekaj kilka minut i spróbuj ponownie.

504 Gateway Timeout - cNajprawdopodobniej jest to spowodowane zwiększonym obciążeniem witryny, pod którym Apache nie jest w stanie zarządza wysyłaniem odpowiedzi HTTP, a nowe żądania ustawiają się w kolejce. Aby rozwiązać problem, możesz dodać zasobów serwera, w szczególności pamięci RAM, oraz zwiększenia liczby procesów httpd (Apache).
Inną możliwą przyczyną błędu 504 jest to, że wykonywany skrypt nie mieści się w wyznaczonym limicie. czas. Dzieje się tak, gdy żądanie jest zbyt ciężkie. Spróbuj podzielić żądanie na kilka kolejnych maluchy.

Błąd 505 Wersja HTTP nie jest obsługiwana oznacza, że ​​strona internetowa nie jest obsługuje wersję protokołu HTTP używaną przez przeglądarkę do żądania strony internetowej
System operacyjny dla biznesu
Email Messenger Forum Facebook Instagram Twitter YouTube Telegram LinkedIn
Copyright © OneBox 2024