OneBox
OneBox Rest API
API Aufträge

API Aufträge

Warum brauchen Kunden es? In der Regel sind dies nur wenige Dinge - Bestellung, Produkt, Kategorien, Marken an BOX übertragen. Dazu werden mehrere Methoden verwendet. Weitere Details unten

Auftrag hinzufügen Methode: /api/orders/add/

Optionen

Beispiel:

http://myboxurl/api/orders/add/?login=LOGIN&password=PASSWORD&clientnamefirst=Wassilij&clientnamelast=Iwanow&clientemail=vasyas33@test.ru&clientphone=+380639370442&clientcode=31333&clientaddress=Kiew&managername=Inna Leonova&ordercode=1333&sum=320&comments=eine Vorauszahlung geleistet&source=mein Geschäft&payed=1&productArray[0][id]=100500&productArray[0][name]=Prüfung PRODUKT1&productArray[0][price]=102&productArray[0][count]=1&productArray[1][id]=123131&productArray[1][name]=Neues%20test%20Produkt2&productArray[1][price]=122&productArray[1][count]=2

Bevor Sie eine Bestellung erstellen, müssen Sie keinen Kontakt erstellen, das BOX-System erstellt ihn bei Bedarf selbst.
Das Hinzufügen eines Projekts oder einer Aufgabe mithilfe der REST-API ähnelt dem Hinzufügen einer Bestellung. Dazu ist ein obligatorischer Parameter bei der Übermittlung einer Anfrage der Parameter workflowname, mit dem der Name des Geschäftsprozesses übermittelt wird, in dem Sie ein Projekt/Auftrag/Aufgabe anlegen möchten. Wenn Sie den Namen des Geschäftsprozesses angeben, stellen Sie sicher, dass er in Ihrer OneBox erstellt wurde. Wenn Sie den Geschäftsprozess nicht angeben, wird der Standard-Geschäftsprozess für Bestellungen ausgewählt..

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	ordercode	string	id Bestellung aus Ihrem System	Pflichtfeld.	Dies ist eine eindeutige Bestell-ID aus Ihrem System (aus Ihrem Geschäft).. Wenn eine Bestellung mit dieser ID vorhanden ist, generiert die API einen Fehler
4	workflowname	string	Geschäftsprozessname für Bestellungen	Nicht erforderliches Feld.	Geben Sie den Namen des GP an, dem Sie den Auftrag hinzufügen möchten. Wenn Sie einen GP angeben, überprüfen Sie, ob dieser in Ihrer BOX erstellt werden muss. Wenn nicht angegeben, wird der Standard-BP für Bestellungen ausgewählt.
5	statusname	string	Bestellstatus	Nicht erforderliches Feld.	Geben Sie den Status des GP an, dem Sie die Bestellung hinzufügen möchten. Wenn Sie keinen Status angeben, wird standardmäßig der Startstatus verwendet..
6	source	string	Bestellkanal	Nicht erforderliches Feld.
7	cdate	datetime	Bestelldatum	Nicht erforderliches Feld.	Erstellungsdatum der Bestellung, muss im Format (Ymd H:i:s) vorliegen. Beispiel: 2015-12-15 23:11:00
8	name	string	Auftragsname	Nicht erforderliches Feld.
9	clientcode	string	id Kunde aus der Bestellung	Nicht erforderliches Feld.	In dieses Feld können Sie die Benutzer-ID aus der Bestellung aus Ihrem System schreiben.
10	clientnamefirst	string	Name des Kunden aus der Bestellung	Nicht erforderliches Feld.
11	clientnamelast	string	Nachname des Kunden aus der Bestellung	Nicht erforderliches Feld.
12	clientnamemiddle	string	Zweiter Vorname des Kunden aus der Bestellung	Nicht erforderliches Feld.
13	clientphone	integer	Telefonnummer des Kunden aus der Bestellung	Oder E-Mail oder Telefon des Kunden ist erforderlich	Vorzugsweise im Format 380XXXXXXXXX
14	clientemail	string	Email Kunde aus der Bestellung	Oder E-Mail oder Telefon des Kunden ist erforderlich
15	clientaddress	string	Kundenadresse aus der Bestellung	Nicht erforderliches Feld.
16	managercode	string	id Auftragsverwalter	Nicht erforderliches Feld.	In dieses Feld können Sie die ID des Managers aus der Bestellung aus Ihrem System schreiben.
17	managername	string	Name des Managers aus der Bestellung	Nicht erforderliches Feld.
18	managerphone	integer	Telefonnummer des Managers aus der Bestellung	Nicht erforderliches Feld.	Vorzugsweise im Format 380XXXXXXXXX
19	manageremail	string	Email Auftragsverwalter	Nicht erforderliches Feld.
20	comments	string	Kommentar zur Bestellung	Nicht erforderliches Feld.	In dieses Feld können Sie alle Informationen schreiben, die Sie über die Bestellung benötigen.
21	deliveryid	integer	id Versandart bestellen	Nicht erforderliches Feld.	Wenn Ihr WebProduction BOX-System Liefermethoden hinzugefügt hat, geben Sie die ID der gewünschten Liefermethode an
22	deliverynote	string	Lieferkommentar	Nicht erforderliches Feld.
23	sum	float	Bestellpreis	Nicht erforderliches Feld.
24	payed	true / false	Wurde die Bestellung bezahlt?	Nicht erforderliches Feld.	Wenn die Bestellung bezahlt ist, geben Sie in diesem Feld wahr ein und die Zahlung für diese Bestellung wird der BOX im Finanzbereich und in der Bestellung selbst hinzugefügt.
25	productArray	array (id, name, price, count)	Array von Produkten aus der Bestellung	Nicht erforderliches Feld.	id - id Waren aus der BOX, falls vorhanden, wird das System sie mit der Bestellung verbinden code1c - id Waren aus Ihrem System, falls vorhanden, wird das System sie der Bestellung zuordnen articul - Warenartikel aus dem System, sofern vorhanden, verknüpft das System diese mit der Bestellung name - Artikelname price - Artikelpreis pro Einheit count - die Menge dieses Artikels in der Bestellung currency - Währung der Ware in der Bestellung (UAH, RUB, USD, EUR usw...) discount_percent - Produktrabatt in Prozent verarbeiten supplierid - ID Anbieter im System suppliercode1c - Externe Lieferanten-ID im System custom_{key} - Custom-e-Feld. Anstatt {key} Sie müssen den Schlüssel des zusätzlichen Feldes aus dem Bestellprodukt ersetzen
26	workflowid	integer	ID Geschäftsprozess	Nicht erforderliches Feld.	Geben Sie die ID des GP an, dem Sie einen Auftrag/eine Aufgabe/ein Projekt hinzufügen möchten. Wenn Sie einen GP angeben, überprüfen Sie, ob er in Ihrer OneBox erstellt werden muss.
27	statusid	integer	ID Bestellstatus	Nicht erforderliches Feld.	Geben Sie die ID des Status an, in den Sie den GP überführen möchten. Wenn Sie keinen Status angeben, wird standardmäßig der Startstatus verwendet..
28	type	string	Netzteiltyp	Nicht erforderliches Feld.	Wenn Sie keinen BP angeben, geben Sie den Typ des hinzuzufügenden BP an
29	utm_date	string	UTL utm_date-Label	Nicht erforderliches Feld.
30	utm_campaign	string	UTL utm_campaign-Label	Nicht erforderliches Feld.
31	utm_source	string	UTL utm_source-Label	Nicht erforderliches Feld.
32	utm_content	string	UTL utm_content-Label	Nicht erforderliches Feld.
33	utm_referrer	string	UTL utm_referrer-Label	Nicht erforderliches Feld.
34	utm_medium	string	UTL utm_medium-Label	Nicht erforderliches Feld.
35	utm_term	string	UTL utm_term-Label	Nicht erforderliches Feld.
36	custom_{key}	string	Custom-e-Feld	Anstatt {key} Sie müssen den Schlüssel des zusätzlichen Feldes aus der Bestellung ersetzen	Beim Übergeben eines Links zu einer Datei für ein Zusatzfeld vom Typ" Datei" - es wird in das System geladen und die ID wird in ein zusätzliches Feld geschrieben
37	customuser_{key}	string	Custom-Das Kundenfeld	Anstatt {key} Sie müssen den Schlüssel des zusätzlichen Feldes aus der Kontaktkarte ersetzen	Beim Übergeben eines Links zu einer Datei für ein Zusatzfeld vom Typ" Datei" - es wird in das System geladen und die ID wird in ein zusätzliches Feld geschrieben
38	dateto	datetime	Planungsdatum des Auftrags (Aufgabe).	Nicht erforderliches Feld.	Auftragsplanungsdatum, muss im Format (Ymd H:i:s) vorliegen. Beispiel: 2015-12-15 23:11:00
39	deliveryprice	float	Lieferpreis	Nicht erforderliches Feld.
40	discountid	integer	ID Rabatte aus dem OneBox-System	Nicht erforderliches Feld.
41	discountname	string	Rabattname aus dem OneBox-System	Nicht erforderliches Feld.
42	discountsum	float	Rabattbetrag	Nicht erforderliches Feld.
43	contractorid	integer	Juristische Person der Bestellung	Nicht erforderliches Feld.
44	paymentid	integer	ID Zahlungsmethode	Nicht erforderliches Feld.	id Zahlungsmethode aus dem OneBox-System
45	paymentname	string	Name der Zahlungsmethode	Nicht erforderliches Feld.	Wenn Sie diesen Parameter angeben, versucht das System, diese Zahlungsmethode in OneBox zu finden und zu erheben
46	country	string	Land	Nicht erforderliches Feld.
47	region	string	Region (Gebiet)	Nicht erforderliches Feld.
48	district	string	Bereich	Nicht erforderliches Feld.
49	city	string	Ortsname	Nicht erforderliches Feld.
50	street	string	Die Straße	Nicht erforderliches Feld.
51	street_number	string	Hausnummer	Nicht erforderliches Feld.
52	apartment	string	Wohnung	Nicht erforderliches Feld.
53	currencyrate_{key}	string	Währungskurs für die Bestellung	Anstatt {key} Sie müssen den Namen der Währung ersetzen
54	documenttemplateid	int	ID Dokumentvorlage	Nicht erforderliches Feld.	Nachdem der Prozess erstellt wurde, wird versucht, ein Dokument gemäß der angegebenen Dokumentvorlage zu generieren.
55	documentpdf	base64 encoded string	Der Inhalt des generierten PDF-Dokuments in base64-Codierung.	Nicht erforderliches Feld.	Nach dem Generieren eines Dokuments durch documenttemplateid wird der Inhalt des PDF-Dokuments dekodiert und als gescannte Kopie dem erstellten Dokument hinzugefügt.
56	dataFromBody	boolean	Nehmen Sie Daten nicht aus Argumenten, sondern aus dem Körper	Nicht erforderliches Feld.	Wenn dataFromBody=1 übergeben wird, werden die Daten nicht aus den Argumenten, sondern aus dem Request-Body genommen. Json muss an den Body übergeben werden, in dem die Schlüssel die oben beschriebenen Parameter sein müssen. login und Passwort sollten wie gewohnt gesendet werden
57	typesex	string	Mandantentyp verarbeiten	Nicht erforderliches Feld.	Sie können den Namen oder Schlüssel des Kontakttyps aus den Systemeinstellungen übernehmen" Kontaktarten"
58	parentid	integer	id übergeordneter Prozess	Nicht erforderliches Feld.	id Prozess, der übergeordnet werden soll, wird der aktuelle Prozess zu seinem Unterprozess
59	company	string	Firmenname des Kunden	Nicht erforderliches Feld.	Wenn kein Unternehmen mit diesem Namen gefunden wird, wird es erstellt
60	files	string\|array	Dateien für die Beschreibung des Prozesses	Nicht erforderliches Feld.	Link oder Array von Links zu Dateien, die hochgeladen und der Prozessbeschreibung hinzugefügt werden sollen
61	restoreSource	boolean	Remote-Quelle wiederherstellen	Nicht erforderliches Feld.	Wenn die übertragene Quelle gelöscht wird, wird sie wiederhergestellt. Das Erstellungsdatum der Quelle wird auf das aktuelle aktualisiert.

Löschen einer Bestellung Methode: /api/orders/delete/

Optionen

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	orderid	string	Auftragsnummer	Pflichtfeld.	In diesem Feld können Sie entweder die Bestell-ID übergeben, die Ihnen unsere API bei der Erstellung zurückgegeben hat. Oder übergeben Sie dort eine externe Auftragskennung (das Feld ordercode beim Erstellen einer Bestellung . Das System wird versuchen, eine Bestellung mit dieser externen ID zu finden und zu löschen.

Auftragsbearbeitung, Methode: /api/orders/update/

Optionen

Beispiel:

http://myboxurl/api/orders/update/?login=LOGIN&password=PASSWORD&orderid=660&&name=Auftragsname ändern&workflowname=Befehl&statusname=Geliefert&payed=1

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	orderid	string	Auftragsnummer	Pflichtfeld.	In diesem Feld können Sie entweder die Bestell-ID übergeben, die Ihnen unsere API bei der Erstellung zurückgegeben hat. Oder übergeben Sie dort eine externe Auftragskennung (das Feld ordercode beim Erstellen einer Bestellung). Das System wird versuchen, eine Bestellung mit dieser externen ID zu finden.
4	name	string	Auftragsname	Nicht erforderliches Feld.
5	comments	string	Kommentar zur Bestellung	Nicht erforderliches Feld.
6	sum	float	Bestellpreis	Nicht erforderliches Feld.
7	deliverynote	string	Kommentare zum Versand	Nicht erforderliches Feld.
8	workflowname	string	Geschäftsprozess bestellen	Nicht erforderliches Feld.	Sie können den BP einer Bestellung über die API in eine andere ändern
9	statusname	string	Auftragsstatus für diesen GP	Nicht erforderliches Feld.	Legen Sie einen anderen Bestellstatus fest
10	payed	boolean	Ob die Bestellung bezahlt werden soll	Nicht erforderliches Feld.	Wurde die Bestellung bezahlt?
11	productArray	array	Artikel zur Bestellung hinzufügen	Nicht erforderliches Feld.	Sie können Produkte zu einer bestehenden Bestellung hinzufügen. In diesem Fall wird der Betrag automatisch neu berechnet id - id Waren aus der BOX, falls vorhanden, wird das System sie mit der Bestellung verbinden code1c - id Waren aus Ihrem System, falls vorhanden, wird das System sie der Bestellung zuordnen articul - Warenartikel aus dem System, sofern vorhanden, verknüpft das System diese mit der Bestellung name - Artikelname price - Artikelpreis pro Einheit count - die Menge dieses Artikels in der Bestellung currency - Währung der Ware in der Bestellung (UAH, RUB, USD, EUR usw...) storagecode1c - Externe ID des Lagers, in dem BOX versucht, den Artikel zu reservieren, falls er noch nicht reserviert ist storagefromcode1c - Lager externe ID. Übergeben Sie diesen Parameter, dann werden nur die Waren, die sich aktuell im Lager von Lager Code1c befinden, im Lager Lager Code1c reserviert suplierid - ID Anbieter im System supliercode1c - Externe ID des Anbieters custom_{key} - Custom-e-Feld. Anstatt {key} Sie müssen den Schlüssel des zusätzlichen Feldes aus dem Bestellprodukt ersetzen
12	workflowid	integer	Id Auftragsabwicklung Geschäft	Nicht erforderliches Feld.	Sie können den BP einer Bestellung über die API in eine andere ändern
13	statusid	integer	Id Status für diesen GP	Nicht erforderliches Feld.	Legen Sie einen anderen Status nach ID fest
14	deleteproducts	0/1	Artikel aus der Bestellung entfernen	Nicht erforderliches Feld.	Wenn 1 - löscht alle Produkte in der bearbeiteten Bestellung
15	dataFromBody	boolean	Nehmen Sie Daten nicht aus Argumenten, sondern aus dem Körper	Nicht erforderliches Feld.	Wenn dataFromBody=1 übergeben wird, werden die Daten nicht aus den Argumenten, sondern aus dem Request-Body genommen. Json muss an den Body übergeben werden, in dem die Schlüssel die oben beschriebenen Parameter sein müssen. login und Passwort sollten wie gewohnt gesendet werden
16	paymentid	integer	ID Zahlungsmethode verarbeiten	Nicht erforderliches Feld.
17	customuser_[key]	optional	Zusätzliches Prozessmandantenfeld	Nicht erforderliches Feld.	Anstatt [key] Es ist notwendig, die Kennung des zusätzlichen Feldes des Kunden zu ersetzen
17	customorder_[key]	optional	Zusätzliches Prozessfeld	Nicht erforderliches Feld.	Anstatt [key] Es ist notwendig, den Bezeichner des zusätzlichen Feldes des Prozesses zu ersetzen Beim Übergeben eines Links zu einer Datei für ein Zusatzfeld vom Typ" Datei" - es wird in das System geladen und die ID wird in ein zusätzliches Feld geschrieben.
18	clientemail	string	Email Client verarbeiten	Nicht erforderliches Feld.	Wird in den Prozess geschrieben und dem Prozess-Client hinzugefügt. Wenn kein Client vorhanden ist, wird der Prozess verwendet, um einen Client zu finden (und zu erstellen)..
19	clientphone	string	Kundentelefon verarbeiten	Nicht erforderliches Feld.	Wird in den Prozess geschrieben und dem Prozess-Client hinzugefügt. Wenn kein Client vorhanden ist, wird der Prozess verwendet, um einen Client zu finden (und zu erstellen)..
20	clientname	string	Name des Kunden aus der Bestellung	Nicht erforderliches Feld.	Wird verwendet, um den Prozessclient zu aktualisieren (und ihn zu erstellen, falls er nicht vorhanden ist)
21	clientnamelast	string	Nachname des Kunden aus der Bestellung	Nicht erforderliches Feld.	Wird verwendet, um den Prozessclient zu aktualisieren (und ihn zu erstellen, falls er nicht vorhanden ist)
22	clientnamemiddle	string	Zweiter Vorname des Kunden aus der Bestellung	Nicht erforderliches Feld.	Wird verwendet, um den Prozessclient zu aktualisieren (und ihn zu erstellen, falls er nicht vorhanden ist)
23	clienttypesex	string	Typ (Geschlecht) des Kunden aus der Bestellung	Nicht erforderliches Feld.	Wird verwendet, um den Prozessclient zu aktualisieren (und ihn zu erstellen, falls er nicht vorhanden ist)
24	clientexternalid	string	Externe ID des Kunden aus der Bestellung	Nicht erforderliches Feld.	Wird verwendet, um den Prozessclient zu aktualisieren (und ihn zu erstellen, falls er nicht vorhanden ist)
25	clientcode	string	Code (EDRPOU/TIN) des Kunden aus der Bestellung	Nicht erforderliches Feld.	Wird verwendet, um den Prozessclient zu aktualisieren (und ihn zu erstellen, falls er nicht vorhanden ist)
26	clientcompany	string	Firma des Kunden aus der Bestellung	Nicht erforderliches Feld.	Wird verwendet, um den Prozessclient zu aktualisieren (und ihn zu erstellen, falls er nicht vorhanden ist)
27	searchclient	boolean	Suchen Sie anhand der Kontaktdaten nach einem Kunden, auch wenn die Bestellung einen Kunden enthält	Nicht erforderliches Feld.
28	country	string	Land	Nicht erforderliches Feld.	Wird verwendet, um die Client-Adresse eines Prozesses zu aktualisieren
29	region	string	Region (Gebiet)	Nicht erforderliches Feld.	Wird verwendet, um die Client-Adresse eines Prozesses zu aktualisieren
30	district	string	Bereich	Nicht erforderliches Feld.	Wird verwendet, um die Client-Adresse eines Prozesses zu aktualisieren
31	city	string	Ortsname	Nicht erforderliches Feld.	Wird verwendet, um die Client-Adresse eines Prozesses zu aktualisieren
32	street	string	Die Straße	Nicht erforderliches Feld.	Wird verwendet, um die Client-Adresse eines Prozesses zu aktualisieren
33	street_number	string	Hausnummer	Nicht erforderliches Feld.	Wird verwendet, um die Client-Adresse eines Prozesses zu aktualisieren
34	apartment	string	Wohnung	Nicht erforderliches Feld.	Wird verwendet, um die Client-Adresse eines Prozesses zu aktualisieren
35	deliveryid	integer	id Versandart bestellen	Nicht erforderliches Feld.	Wenn Ihr WebProduction BOX-System Liefermethoden hinzugefügt hat, geben Sie die ID der gewünschten Liefermethode an
36	novaposhtadeliverynote	string	TTN-Nummer der neuen E-Mail	Nicht erforderliches Feld.
37	novaposhtaredeliverynote	string	TTN-Nummer der Rücklieferung neuer Post	Nicht erforderliches Feld.
38	novaposhtaServiceType	string	Versandart Nova Poshta	Nicht erforderliches Feld.	Verfügbare Werte: WarehouseWarehouse - CSchatzlager WarehouseDoors - CSchatztüren DoorsWarehouse - Türen-Lager DoorsDoors - Türen-Türen
39	utm_XXX (wobei Sie anstelle von XXX das benötigte Label ersetzen, zum Beispiel utm_source, utm_date)	string	UTM Etiketten verarbeiten	Nicht erforderliches Feld.
40	files	string\|array	Dateien für die Beschreibung des Prozesses	Nicht erforderliches Feld.	Link oder Array von Links zu Dateien, die hochgeladen und der Prozessbeschreibung hinzugefügt werden sollen

Empfangen einer Bestellung und Empfangen aller Bestellungen, Methode: /api/orders/get/

Optionen

Optionen für den Erhalt einer einzelnen Bestellung:

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	supplierhash	string	Verkäuferschlüssel	Nicht erforderliches Feld.	Verfügbar in der Kundenkarte, die der Kontakt des Lieferanten ist. Verfügbar mit Login und Passwort aus der System- und Zugriffsebene" Klient". Ermöglicht es Ihnen, den Zugriff auf empfangende Prozesse gemäß der Zuordnung eines zusätzlichen Prozessfelds zu einem Lieferantenschlüssel einzuschränken (siehe. Einstellungen" Kontrollen und Einzigartigkeit") oder nur wenn der angegebene Kontakt ein Lieferant-Kunde ist.
4	orderid	string	Auftragsnummer	Pflichtfeld.	Wenn Sie eine bestimmte Bestellung benötigen, übergeben Sie in diesem Feld entweder die Bestell-ID, die Ihnen unsere API bei der Erstellung zurückgegeben hat. Oder übergeben Sie dort eine externe Auftragskennung (das Feld ordercode beim Erstellen einer Bestellung). Das System wird versuchen, eine Bestellung mit dieser externen ID zu finden. Außerdem besteht die Möglichkeit, einen Auftrag für zusätzliche Felder des Auftrags zu erhalten. Dazu müssen Sie die ID übergeben. Felder (in den Einstellungen angezeigt) mit einem Präfix' customorder_' und geben Sie den gewünschten Wert an, zum Beispiel customorder_idKeydoppolya=value Feldwerte zurückgeben orderid - id Reihenfolge ordercode - externe Auftrags-ID, ordername - Auftragsname, clientId - id Client im BOX-System, clientcode - externe ID des Clients im BOX-System, clientname - Kundenname, clientemail - email Klient, clientphone - Kundentelefon, clientaddress - Kundenadresse, managerid - id Auftragsverwalter, managername - Name Auftragsverwalter, managerrole - Rolle Auftragsverwalter, cdate - Bestelldatum, dateto - Auftragsplanungsdatum, deliveriID - id Versandart, deliverinote - Kommentare zum Versand, deliveriprice - Lieferpreis, sum - Bestellpreis, sumbase - Basisbestellmenge, currency - Bestellwährung, statusname - Bestellstatus, workflowname - BP-Name bestellen, contractorid - id juristische Person der Bestellung, contractorname - Name der juristischen Person der Bestellung, weight - Gesamtauftragsgewicht, gabarite - Gesamtbestellmenge, products - Reihe von Produkten aus der Bestellung, besteht aus: id - Produkt ID name - Der Name des Produkts count - Produktmenge price - Produktpreis discountsum - Rabattbetrag discountpercent - Prozent Rabatt pricewithdiscount - reduzierter Produktpreis storageId - Produktlager-ID storageExternalId - externe Lager-ID des Produkts productsource - Produkttyp (Retourenprodukt oder -dienstleistung) pricewithvat - Preis mit MwSt pricewithoutvat - Preis ohne MwSt productpricewithvat - Preis mit MwSt productpricewithoutvat - Kosten ohne Mehrwertsteuer producttaxvalue - Mehrwertsteuer (%) supplierid - ID Anbieter im System suppliercode1c - Externe Lieferanten-ID im System suppliername - Anbietername im System customfields - zusätzliche Auftragsproduktfelder, die bestehen aus: key - Additional_field_key name - zusätzlicher Feldname value - zusätzlicher Feldwert customfields - ein Array von zusätzlichen Feldern in der Reihenfolge, die bestehen aus: key - Additional_field_key name - zusätzlicher Feldname value - zusätzlicher Feldwert
5	sumoutbonuse	bool	Anzahl der in Bearbeitung abgeschriebenen Boni	Nicht erforderliches Feld.
6	suminbonuse	bool	Die Anzahl der dabei aufgelaufenen Boni	Nicht erforderliches Feld.
7	getcomments	bool	Kommentare zu einem Prozess erhalten	Nicht erforderliches Feld.	Gibt ein Array mit allen Kommentaren zum Prozess zurück Jedes Element des Arrays enthält id - id Kommentar, cdate - Datum, an dem der Kommentar erstellt wurde, type - Kommentartyp, content - Kommentartext, showtoclient - ob der Kommentar dem Client angezeigt wird, userid - id der Kontakt, der den Kommentar hinterlassen hat, usercode - externe Kontakt-ID, username - Kontaktname, useremail - email Kontakt, userphone - Kontakt-Telefon,
8	unescapedunicode	bool	Codieren Sie keine Unicode-Zeichen	Nicht erforderliches Feld.	Wenn der Wert 1 dieses Parameters im resultierenden JSON übergeben wird, werden Unicode-Zeichen nicht codiert, z. B. Kyrillisch" а" wird versendet als" а", nicht wie" \u0430"
9	getnovaposhtastatus	bool	Status empfangen ttn Neue Mail	Nicht erforderliches Feld.	Wenn der Wert 1 dieses Parameters übergeben wird, enthält die Liste der Felder zusätzlich den Status von ttn und den Status der Antwort ttn von New mail

Optionen zum Empfangen aller Bestellungen:

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	supplierhash	string	Verkäuferschlüssel	Nicht erforderliches Feld.	Verfügbar in der Kundenkarte, die der Kontakt des Lieferanten ist. Verfügbar mit Login und Passwort aus der System- und Zugriffsebene" Klient". Ermöglicht es Ihnen, den Zugriff auf empfangende Prozesse gemäß der Zuordnung eines zusätzlichen Prozessfelds zu einem Lieferantenschlüssel einzuschränken (siehe. Einstellungen" Kontrollen und Einzigartigkeit") oder nur wenn der angegebene Kontakt ein Lieferant-Kunde ist.
4	workflowname	string	Geschäftsprozessname für Bestellungen	Nicht erforderliches Feld.	Geben Sie den Namen des Geschäftsprozesses an, nach dem Sie Aufträge/Aufgaben/Projekte filtern möchten
5	workflowid	string	ID Geschäftsprozess	Nicht erforderliches Feld.	Geben Sie die ID des Geschäftsprozesses an, nach dem Sie Aufträge/Aufgaben/Projekte filtern möchten. Wenn Sie einen GP angeben, überprüfen Sie, ob er in Ihrer OneBox erstellt werden muss.
6	type	string	Netzteiltyp	Nicht erforderliches Feld.	Geben Sie den Geschäftsprozesstyp an, um Aufträge/Aufgaben/Projekte mit einem bestimmten Typ herauszufiltern
7	statusname	string	Bestellstatus	Nicht erforderliches Feld.	Geben Sie den Namen des GP-Status an, nach dem Sie Aufträge/Aufgaben/Projekte filtern möchten.
8	statusid	string	ID Bestellstatus	Nicht erforderliches Feld.	Geben Sie die GP-Status-ID an, nach der Sie Aufträge/Aufgaben/Projekte filtern möchten.
9	cdate	date	Erstellungsdatum der Bestellung	Nicht erforderliches Feld.	Geben Sie das Erstellungsdatum an und die endgültige Auswahl umfasst nur die Bestellungen, deren Erstellungsdatum größer oder gleich dem angegebenen ist
10	udate	date	Datum und Uhrzeit der letzten Aktualisierung der Bestellung	Nicht erforderliches Feld.	Geben Sie das Datum der letzten Aktualisierung an und die endgültige Auswahl umfasst nur die Bestellungen, bei denen das Datum der letzten Änderung größer oder gleich dem angegebenen ist
11	clientId	string	ID Client im BOX-System	Nicht erforderliches Feld.	Geben Sie die Client-ID an, nach der Sie Prozesse filtern möchten.
12	clientcode	string	externe ID des Clients im BOX-System	Nicht erforderliches Feld.	Geben Sie die externe ID des Clients an, nach dem Sie Prozesse filtern möchten.
13	sumoutbonuse	bool	Anzahl der in Bearbeitung abgeschriebenen Boni	Nicht erforderliches Feld.
14	suminbonuse	bool	Die Anzahl der dabei aufgelaufenen Boni	Nicht erforderliches Feld.
15	typesex	string	Client-Kontakttyp verarbeiten	Nicht erforderliches Feld.	Um Prozesse nach Kontakttyp des Prozesskunden zu filtern, müssen Sie den Kontakttypschlüssel übergeben (z. B. Unternehmen).
16	customorder_[Schlüssel]	optional	Prozesse nach zusätzlichen Prozessfeldern filtern	Nicht erforderliches Feld.	Für zusätzliche Felder vom Typ "Integer", "Float", "Datum und Uhrzeit", "Datum", "Zeit" verfügbares Filtern nach dem Bereich der Werte FROM und TO durch Übergabe der Parameter customorder_[key]_from und customorder_[key]_to
17	customuser_[Schlüssel]	optional	Prozessfilterung nach zusätzlichen Prozessmandantenfeldern	Nicht erforderliches Feld.	Für zusätzliche Felder vom Typ "Integer", "Float", "Datum und Uhrzeit", "Datum", "Zeit" verfügbares Filtern nach dem Bereich der Werte FROM und TO durch Übergabe der Parameter customuser_[key]_from und customuser_[key]_to
18	part	integer	Teil der Bestellungen	Pflichtfeld.	API gibt bis zu 1000 Bestellungen im 1. Teil aus, um die nächsten 1000 Bestellungen zu erhalten, passieren 2 dort (es stellt sich heraus, Teil 2) und so weiter. Feldwerte zurückgeben orderid - id Reihenfolge ordernumber - Bestellnummer ordercode - externe Auftrags-ID, ordername - Auftragsname, clientId - id Client im BOX-System, clientcode - externe ID des Clients im BOX-System, clientname - Kundenname, clientemail - email Klient, clientphone - Kundentelefon, clientaddress - Kundenadresse, managerid - id Auftragsverwalter, managername - Name Auftragsverwalter, managerrole - Rolle Auftragsverwalter, cdate - Bestelldatum, deliveriID - id Versandart, deliverinote - Kommentare zum Versand, deliveriprice - Lieferpreis, sum - Bestellpreis, sumbase - Basisbestellmenge, currency - Bestellwährung, statusname - Bestellstatus, workflowname - BP-Name bestellen, contractorid - id juristische Person der Bestellung, contractorname - Name der juristischen Person der Bestellung, products - Reihe von Produkten aus der Bestellung, besteht aus: id - Produkt ID name - Der Name des Produkts count - Produktmenge price - Produktpreis storageId - Produktlager-ID storageExternalId - externe Lager-ID des Produkts productsource - Produkttyp (Retourenprodukt oder -dienstleistung) pricewithvat - Preis mit MwSt pricewithoutvat - Preis ohne MwSt productpricewithvat - Preis mit MwSt productpricewithoutvat - Kosten ohne Mehrwertsteuer producttaxvalue - Mehrwertsteuer (%) supplierid - ID Anbieter im System suppliercode1c - Externe Lieferanten-ID im System suppliername - Anbietername im System customfields - zusätzliche Auftragsproduktfelder, die bestehen aus: key - Additional_field_key name - zusätzlicher Feldname value - zusätzlicher Feldwert customfields - ein Array von zusätzlichen Feldern in der Reihenfolge, die bestehen aus: key - Additional_field_key name - zusätzlicher Feldname value - zusätzlicher Feldwert Es ist auch möglich, Prozesse nach zurückgegebenen Feldern sowie nach Feldern von Prozessclients zu filtern. Es ist notwendig, einen Parameter zu übergeben, der dem Namen der zurückgegebenen Variablen entspricht, und einen Wert zum Filtern nach dem Variablenfeld. Beispielsweise werden bei der Übergabe des Parameters contactCountry=Ukraine Prozesse herausgefiltert, bei denen Kunden das Land in der Adresse angegeben haben" Ukraine". Oder wenn Sie den Parameter contractid=1 übergeben, werden Prozesse herausgefiltert, die eine juristische Person mit id=1 haben
19	getcomments	bool	Kommentare zu einem Prozess erhalten	Nicht erforderliches Feld.	Gibt ein Array mit allen Kommentaren zum Prozess zurück Jedes Element des Arrays enthält id - id Kommentar, cdate - Datum, an dem der Kommentar erstellt wurde, type - Kommentartyp, content - Kommentartext, showtoclient - ob der Kommentar dem Client angezeigt wird, userid - id der Kontakt, der den Kommentar hinterlassen hat, usercode - externe Kontakt-ID, username - Kontaktname, useremail - email Kontakt, userphone - Kontakt-Telefon,
20	unescapedunicode	bool	Codieren Sie keine Unicode-Zeichen	Nicht erforderliches Feld.	Wenn der Wert 1 dieses Parameters im resultierenden JSON übergeben wird, werden Unicode-Zeichen nicht codiert, z. B. Kyrillisch" а" wird versendet als" а", nicht wie" \u0430"
21	getnovaposhtastatus	bool	Status empfangen ttn Neue Mail	Nicht erforderliches Feld.	Wenn der Wert 1 dieses Parameters übergeben wird, enthält die Liste der Felder zusätzlich den Status von ttn und den Status der Antwort ttn von New mail

Kommentare zum Prozess erhalten, Methode: /api/order/comments/get/

Optionen

Optionen für den Erhalt einer einzelnen Bestellung:

Beispiel:

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

Als Antwort wird JSON mit einem Array von Daten zum Kommentar und dem Autor des Kommentars zurückgegeben.

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	id	string	Prozess ID	Pflichtfeld.	ID Prozess in OneBox. Es wird verwendet, um zu versuchen, den Prozess zu finden.
3	code	string	Externe Prozess-ID	Nicht erforderliches Feld.	Externe Prozess-ID in OneBox. Es wird verwendet, um zu versuchen, den Prozess zu finden.
3	type	array	Ein Array von Kommentartypen	Nicht erforderliches Feld.	Verfügbare Typen: comment - Kommentar: commentresult - Ergebnis: change - Rückgeld: email - Buchstabe call - Anruf notify - Benachrichtigung

Mögliche Antworten auf die Anfrage

Mehr

№	Status	Nachricht	Nachrichtenbeschreibung
1	ok	orderid	Gibt die ID der hinzugefügten Bestellung zurück
2	fail	login_empty	Fehlende Anmeldung
3	fail	password_empty	Fehlendes Passwort
4	fail	clientnamefirst_empty	Fehlender Kundenname
5	fail	Bad user level!	Niedriges Benutzerlevel zum Ausführen dieser Aktion (benötigt Level 2 und höher)
6	fail	Login or password not correct!	Login oder Passwort falsch eingegeben
7	fail	orderId_empty	Bestell-ID fehlt
8	fail	Order is already!	Auftrag ist bereits vorhanden
9	fail	Not workflow status by name	Es gibt keinen BP-Status mit diesem Namen
10	fail	Not workflow by name	Kein Geschäftsprozess mit diesem Namen
11	fail	Please create Finance Account	Erstellen Sie ein Finanzkonto
12	fail	Order with this Code does not found!	Bestellung mit diesem Code wurde nicht gefunden
13	fail	clientphone_and_clientemail_empty	Telefon und E-Mail des Kunden fehlen

Es können auch Fehler auftreten:

502 Bad Gateway - Wenn dieser Fehler auftritt, müssen Sie:
1. Überprüfen Sie, ob Sie Zugang zum Internet haben (gehen Sie zu einer anderen Website).
2. Wenn es keine Probleme mit dem Zugriff gibt — Sie können Cookies löschen.
Wenn das oben genannte nicht geholfen hat — Serverseitiges Problem. Wenden Sie sich an den Systemadministrator der Site.

503 (Service Temporarily Unavailable) - Dieser Fehler kann durch zu viele auftreten Anfragen an den Server. Wenn Sie einen solchen Fehler sehen, sollten Sie ein paar Minuten warten und es erneut versuchen.

504 Gateway Timeout - cDer Punkt ist höchstwahrscheinlich die erhöhte Auslastung der Site, bei der Apache dies nicht tut verwaltet, HTTP-Antworten zu geben, und neue Anforderungen werden in die Warteschlange gestellt. Um das Problem zu lösen, können Sie hinzufügen Serverressourcen, insbesondere RAM, und die Anzahl der httpd-Prozesse erhöhen (Apache).
Ein weiterer möglicher Grund für den 504-Fehler ist, dass das ausführbare Skript nicht in das zugewiesene Limit passt Zeit. Dies passiert, wenn die Anfrage zu schwer ist. Versuchen Sie, Ihre Anfrage in mehrere weitere aufzuteilen klein.

Fehler 505 HTTP-Version wird nicht unterstützt bedeutet, dass die Website nicht ist unterstützt die Version des HTTP-Protokolls, die der Browser verwendet, um eine Webseite anzufordern

API Aufträge

Optionen für den Erhalt einer einzelnen Bestellung:

Optionen zum Empfangen aller Bestellungen:

Optionen für den Erhalt einer einzelnen Bestellung:

Vielen Dank für Ihre Wahl.