updateBranches

Navigation:  WebService Calls > Options for Growth >

updateBranches

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Anlegen und aktualisieren von Filialdaten.

Beispiel Request

Code

<request method="updateBranches" version="1.0.0">

   <branch significant_key="branch_id">

      <mandator_id>1</mandator_id>

      <branch_id>36907</branch_id>

      <branch_code>Branchcode</branch_code>

      <active>true</active>

      <company_name>Speed4Trade GmbH</company_name>

      <street>An den Gärten</street>

      <house_number>8</house_number>

      <postal_code>92665</postal_code>

      <city>Altenstadt</city>

      <country_code_iso>DE</country_code_iso>

      <salutation>

         <salutation_id>2</salutation_id>

      </salutation>

      <first_name>Vorname</first_name>

      <last_name>Nachname</last_name>

      <phone_number>0960294440</phone_number>

      <phone_number2>0960294440</phone_number2>

      <fax_number>096029444100</fax_number>

      <email_address>info@speed4trade.com</email_address>

      <bank_name>Bankname</bank_name>

      <bank_code>Bankcode</bank_code>

      <bank_account_number>Kontonummer</bank_account_number>

      <swift_code>Swift</swift_code>

      <iban_code>IBAN</iban_code>

      <order_time>2022-06-01T08:09:56.640+01:00</order_time>

      <tax_id_number>Steuernummer</tax_id_number>

      <warehouse_id>133</warehouse_id>

      <region>Region</region>

      <latitude>49.719</latitude>

      <longitude>12.155</longitude>

      <shop_url>https://www.speed4trade.com/</shop_url>

      <pickup_instructions>Abholbar ab 12:00 Uhr des Folgetages</pickup_instructions>

      <opening_hours>

         <opening_hour>

            <day_of_week>2</day_of_week>

            <open>07:00</open>

            <close>23:00</close>

         </opening_hour>

      </opening_hours>

      <special_opening_hours>

         <special_opening_hour>

            <day_of_week>0</day_of_week>

            <open>2022-04-20T06:00:00.000+02:00</open>

            <close>2022-04-20T09:15:00.000+02:00</close>

         </special_opening_hour>

      </special_opening_hours>

      <contacts>

         <branch_contact>

            <contact_id>36874</contact_id>

            <contact_salutation_id>2</contact_salutation_id>

            <contact_first_name>Vorname</contact_first_name>

            <contact_last_name>Nachname</contact_last_name>

            <contact_position>Jobtitel</contact_position>

            <phone_number>0960294440</phone_number>

            <mobile_phone_number>0960294440</mobile_phone_number>

            <fax_number>096029444100</fax_number>

            <contact_email>info@speed4trade.com</contact_email>

            <contact_picture_as_base64>base64Content</contact_picture_as_base64>

            <contact_picture_name>contact.png</contact_picture_name>

            <contact_sort>1</contact_sort>

         </branch_contact>

      </contacts>

   </branch>

</request>

Feldliste Request

Name

Beschreibung

Anz.

Typ

sonstiges

request

Root-Element der Anfrage

1

Element

method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert:

„updateBranches“

version

Attribut von request. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

branch

Wrapper-Element, das die Daten der Filalen beinhaltet.

1..N

Element

significant_key

Gibt an welches Feld zur Identifikation beim Update genutzt wird.

1

string

mandator_id

ID des Mandanten

1

integer

branch_id

ID der Filiale

0..1

integer

branch_code

Filialcode

0..1

string

active

Aktivflag

0..1

boolean

company_name

Firmenname

0..1

string

street

Straße

0..1

string

house_number

Hausnummer

0..1

string

postal_code

Postleitzahl

0..1

string

city

Ort

0..1

string

country_code_iso

ISO-Code der die Sprache darstellt

0..1

string

z.B. „de“

salutation

Wrapper-Element, das die Daten der Anrede enthält.

0..1

Element

salutation_id

ID der Anrede

1

integer

first_name

Vorname

0..1

string

last_name

Nachname

0..1

string

phone_number

Telefonnummer

0..1

string

phone_number2

zusätzliche Telefonnummer

0..1

string

fax_number

Faxnummer

0..1

string

email_address

Emailadresse

0..1

string

bank_name

Name der Bank

0..1

string

bank_code

BLZ-Nummer

0..1

string

bank_account_number

Kontonummer

0..1

string

swift_code

SWIFT- bzw. BIC-Code

0..1

string

iban_code

IBAN

0..1

string

order_time

Bestellzeitpunkt

0..1

dateTime

tax_id_number

Umsatzsteuer-ID

0..1

string

warehouse_id

ID des Lagers

0..1

integer

warehouse_code

Lagercode

0..1

string

region

Region

0..1

string

latitude

Geographische Breitenangabe

0..1

decimal

longitude

Geographische Längenangabe

0..1

decimal

shop_url

Shop-URL

0..1

string

pickup_instructions

Abholhinweise

0..1

string

opening_hours

Wrapper, der die einzelnen Öffnungszeiten-Elemente beinhaltet.

0..1

Element

opening_hour

Wrapper-Element, das die Daten der Öffnungszeiten beinhaltet

1..N

Element

day_of_week

Wochentag

1

integer

open

Geöffnet ab

1

string

close

Geschlossen ab

1

string

special_opening_hours

Wrapper, der die einzelnen besonderen Öffnungszeiten-Elemente beinhaltet.

0..1

Element

special_opening_hour

Wrapper-Element, das die Daten der besonderen Öffnungszeiten beinhaltet

1..N

Element

day_of_week

Wochentag

1

integer

open

Geöffnet ab

1

string

close

Geschlossen ab

1

string

contacts

Wrapper-Element, das die Daten des Ansprechpartner  darstellt.

0..1

Element

branch_contact

Wrapper-Element, das die Daten eines Ansprechpartners bündelt

1

Element

contact_id

ID des Ansprechpartners

0..1

integer

contact_salutation_id

ID der Anrede

0..1

integer

contact_first_name

Vorname des Ansprechpartners

1

string

contact_last_name

Nachname des Ansprechpartners

1

string

contact_position

Position des Ansprechpartners

0..1

string

phone_number

Telefonnummer

0..1

string

mobile_phone_number

Mobilnummer

0..1

string

fax_number

Faxnummer

0..1

string

contact_email

Mailadresse des Anpsrechpartners

1

string

contact_picture_as_base64

BASE64 codiertes Bild des Ansprechpartners

0..1

string

contact_picture_name

Name des Bildes des Ansprechpartners

0..1

string

contact_sort

Sortierung

0..1

integer

Beispiel Response

Code

<response method="updateBranches" version="1.0.0">

   <report action="update" return_code="0">

       <branch>

           <branch_id>36907</branch_id>

           <mandator_id>1</mandator_id>

           <branch_code>Branchcode</branch_code>

       </branch>

   </report>

</response>

Feldliste Response

Name

Beschreibung

Anz.

Typ

sonstiges

response

Root-Element der Anfrage

1

Element

methode

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert:

„updateBranches“

version

Attribut von response. Legt die Version der Anfrage fest.

1

string

Fester Wert:

„1.0.0“

report

Information über die ausgeführte Operation.

Element

reference_id

Attribut von report

0..1

string

action

Attribut von report

0..1

string

Fester Wert:

„delete | insert | update“

return_code

Attribut von report

1

integer

error_description

Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert

0..1

string

total_number_of_pages

Gesamtanzahl an verfügbaren Seiten mit Filialdaten.

0..1

integer

total_number_of_entries

Gesamtanzahl an verfügbaren Filialdaten für den im Request angegebenen Filter.

0..1

integer

branch

Wrapper-Element, das die Daten der Filalen beinhaltet.

0..1

Element

branch_id

ID der Filiale

1

integer

mandator_id

ID des Mandanten

1

integer

branch_code

Filialcode

1

string

 

Änderungsübersicht

Version

Änderungsbeschreibung

3.4.35.1

Initiale Erstellung