fetchOffers

Navigation:  WebService Calls > Options for Growth >

fetchOffers

Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Abfrage grundlegender Angebotsdaten aus Speed4Trade CONNECT

Beispiel Request

Code

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:

„fetchOffers“

version

Attribut von request. Legt die Version der Anfrage fest.

1

string

Fester Wert:

„1.0.0“

offers_per_page

Anzahl der zurückgegebenen Angebote pro Seite. Falls keine Anzahl angegeben wird, werden alle durch die Filter selektierten Angebote auf der Seite 1 zurückgegeben.

0..1

integer


page

Nummer der Seite, welche zurückgeliefert werden soll. Falls keine Seite angegeben wird, wird automatisch die Seite 1 zurückgeliefert.

0..1

integer


filter

Legt Parameter fest nach denen die Ergebnismenge eingeschränkt wird. Mehrere Filter werden als ODER-Verknüpfung, Elemente innerhalb des Filters als UND-Verknüpfung behandelt.

1..N

Element


mandator_id

Schränkt die Ergebnismenge der Abfrage auf Angebote eines bestimmten Mandanten ein.

1

Element


filter_method

Attribut von mandator_id. Legt das Verhalten des Mandanten-Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von mandator_id. Legt den Filterwert des Mandanten-Filters fest.

1

integer


offer_id

Schränkt die Ergebnismenge der Abfrage auf das Angebot mit der angegebenen Id ein.

0..1

Element


filter_method

Attribut von offer_id. Legt das Verhalten des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von offer_id. Legt den Filterwert fest.

1

integer


external_offer_number

Schränkt die Ergebnismenge der Abfrage auf das Angebot mit der angegebenen externen Angebotsnummer ein.

0..1

Element


filter_method

Attribut von external_offer_number. Legt das Verhalten des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von external_offer_number. Legt den Filterwert fest.

1

string


subchannel_id

Schränkt die Ergebnismenge der Abfrage auf Angebote für den Subchannel mit der angegebenen Id ein.

0..1

Element


filter_method

Attribut von subchannel_id. Legt das Verhalten des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von subchannel_id. Legt den Filterwert fest.

1

integer


account_id

Schränkt die Ergebnismenge der Abfrage auf Angebote für den Account mit der angegebenen Id ein.

0..1

Element


filter_method

Attribut von account_id. Legt das Verhalten des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von account_id. Legt den Filterwert fest.

1

integer


item_id

Schränkt die Ergebnismenge der Abfrage auf Angebote des Artikels mit der angegebenen Id ein.

0..1

Element


filter_method

Attribut von item_id. Legt das Verhalten des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von item_id. Legt den Filterwert fest.

1

integer


internal_item_number

Schränkt die Ergebnismenge der Abfrage auf Angebote des Artikels mit der angegebenen externen Artikelnummer ein.

0..1

Element


filter_method

Attribut von internal_item_number. Legt das Verhalten des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von internal_item_number. Legt den Filterwert fest.

1

string


offer_start_date

Schränkt die Ergebnismenge der Abfrage nach dem Startdatum des Angebots ein.

0..1

Element


from_date

Attribut von offer_start_date. Selektiert alle Angebote deren Startdatum größer oder gleich des angegebenen Datums ist.

0..1

dateTime


to_date

Attribut von offer_start_date. Selektiert alle Angebote deren Startdatum kleiner oder gleich des angegebenen Datums ist.

0..1

dateTime


allow_null

Legt fest ob auch Angebote bei denen das Startdatum nicht definiert ist berücksichtigt werden.

0..1

boolean

Feste Werte:

true | false

offer_end_date

Schränkt die Ergebnismenge der Abfrage nach dem Ende-Datum des Angebots ein.

0..1

Element


from_date

Attribut von offer_end_date. Selektiert alle Angebote deren Ende-Datum größer oder gleich des angegebenen Datums ist.

0..1

dateTime


to_date

Attribut von offer_end_date. Selektiert alle Angebote deren Ende-Datum kleiner oder gleich des angegebenen Datums ist.

0..1

dateTime


allow_null

Legt fest ob auch Angebote bei denen das Ende-Datum nicht definiert ist berücksichtigt werden.

0..1

boolean

Feste Werte:

true | false

last_changed

Schränkt die Ergebnismenge der Abfrage nach dem Datum der letzten Änderung des Angebots ein.

0..1

Element


from_date

Attribut von last_changed. Selektiert alle Angebote deren letztes Änderungsdatum größer oder gleich des angegebenen Datums ist.

0..1

dateTime


to_date

Attribut von last_changed. Selektiert alle Angebote deren letztes Änderungsdatum kleiner oder gleich des angegebenen Datums ist.

0..1

dateTime


allow_null

Legt fest ob auch Angebote bei denen das Änderungsdatum nicht definiert ist berücksichtigt werden.

0..1

boolean

Feste Werte:

true | false

offer_type

Schränkt die Ergebnismenge der Abfrage auf einen bestimmten Angebotstyp ein.

0..1

Element


filter_method

Attribut von offer_type. Legt das Verhalten des Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von offer_type. Legt den Filterwert fest.

1

integer

Feste Werte

Beispiel Response

Code

Feldliste Response

Name

Beschreibung

Anz.

Typ

sonstiges

response

Root-Element der Antwort

1

Element


method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert:

„fetchOffers“

version

Attribut von response. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

report

Information über die ausgeführte Operation.

1

Element


total_number_of_pages

Gesamtanzahl an verfügbaren Seiten mit Angeboten.

1

integer


total_number_of_entries

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

1

integer


return_code

Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind.

1

integer

0 = OK.

< 0 = Fehler

error_description

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

0..1

string


offer

Wrapper-Element, das die Daten des Angebots darstellt.

0..N

Element


mandator_id

ID des Mandanten

1

integer


subchannel_id

ID des Subchannels

1

integer

Siehe Wertetabelle.

account_id

ID des Accounts

1

integer


offer_id

ID des Angebots

1

integer


external_offer_id

Externe Angebots-ID. Angebotsnummer (eBay) oder ASIN (Amazon).

0..1

string


item_id

ID des Artikels

0..1

integer


offer_parent_id

ID des übergeordneten Variantenangebots.

0..1

integer


listed_quantity

Einstellmenge

1

integer


top_up_quantity

Die Menge, ab der wieder aufgefüllt wird.

1

integer


quantity_sold

Verkaufte Menge

1

integer


current_quantity

Aktuelle Angebotsmenge

1

integer


last_changed

Letzte Änderung

0..1

dateTime


offer_start_date

Startzeitpunkt des Angebotes

0..1

dateTime


offer_end_date

Endzeitpunkt des Angebotes

0..1

dateTime


offer_type

Angebotstyp

1

integer

Feste Werte

offer_subtype

Angebotssubtyp

1

integer

Feste Werte

changed_flag

Eine Bitmaske die angibt, welche Bereiche des Angebots sich geändert haben. Die Bedeutung der einzelnen Bits ist je nach Verkaufskanal unterschiedlich und wird nur intern verwertet.

1

integer


upload_error

Wrapper-Element, das die Daten des Upload-Fehlers zusammenfasst.

0..1

Element


description

Die Fehlermeldung des Verkaufkanals

1

string


date

Das Datum, wann der Fehler aufgetreten ist.

1

dateTime


Wertetabelle(n)

Die aufgeführten Werte gelten für das Feld offer_type.

Wert

Beschreibung

1

Vorbereitetes Angebot

2

Laufendes Angebot

8

Beendetes Angebot

Die aufgeführten Werte gelten für das Feld offer_subtype.

Wert

Beschreibung

10

Vorbereitet

15

Freigegeben

20

Laufend

40

Beendet Mindestbestand

45

Beendet Sicherheitsbestand

50

Beendet Marktplatz

60

Beendet Abverkauft

65

Beendet Teilverkauft

66

Beendet Nichtverkauft

80

Beendet durch Benutzer

90

Beendet Wiedereinstellen

95

Beendet Wiedereinstellen fehlgeschlagen

Value Table - for Field sub_channel_id

sub_channel_id

sub_channel_identifier

channel_identifier

1001

Speed4Trade COMMERCE

Onlineshops

1100

modified Shop

Onlineshops

1400

Gambio

Onlineshops

1500

Shopgate

Onlineshops

1600

MagentoCommerce

Onlineshops

1700

OXID

Onlineshops

1900

Shopware

Onlineshops

2100

eBay.de

eBay

2200

eBay.co.uk

eBay

2250

eBay.ie

eBay

2300

eBay.com

eBay

2310

eBay Motors

eBay

2350

eBay.ca

eBay

2400

eBay.fr

eBay

2500

eBay.it

eBay

2600

eBay.at

eBay

2650

eBay.ch

eBay

2700

eBay.es

eBay

2750

eBay.com.au

eBay

2800

eBay.nl

eBay

2850

eBay.be

eBay

2900

eBay.pl

eBay

3100

amazon.de

Amazon

3200

amazon.co.uk

Amazon

3300

amazon.fr

Amazon

3350

amazon.nl

Amazon

3400

amazon.com

Amazon

3500

amazon.it

Amazon

3550

amazon.ae

Amazon

3600

amazon.es

Amazon

3700

amazon.ca

Amazon

3750

amazon.com.au

Amazon

3800

amazon.com.mx

Amazon

3820

amazon.eg

Amazon

3830

amazon.sa

Amazon

3840

amazon.tr

Amazon

3850

amazon.se

Amazon

3860

amazon.pl

Amazon

4100

Telefonverkauf

manual sales / telesales

5100

Allyouneed.de (Deprecated)

Allyouneed (Deprecated)

6100

Yatego

Yatego

7100

Rakuten.de (Deprecated)

Rakuten (Deprecated)

9100

DAPARTO.de

DAPARTO

10100

otto.de

OTTO

10200

otto.at

OTTO

10300

otto.ch

OTTO

10400

otto.nl

OTTO

10500

otto.ru

OTTO

11100

Locafox.de (Deprecated)

Locafox (Deprecated)

12100

WEBSALE (Deprecated)

WEBSALE (Deprecated)

13100

Kaufland.de

Kaufland.de

14001-14999

individual channel name (see notes below)

Multi-Channel-Plugin (MCP)

15100

OTTO Market DE

OTTO Market

 

Note for value table and field : sub_channel_id:

The sub channels for the Multi-Channel-Plugin (MCP) can be configured via the Speed4Trade CONNECT UI. This doesn't allow for a standardized definition across all customer systems. The required subchannel_ids can be retrieved by using the call fetchSubChannels which could be executed after the initial configuration of a new subchannel using a tool like SoapUI. Setup of this tool is described in the Partnerportal.

 

Änderungsübersicht

Version

Änderungsbeschreibung

3.2.9.75

Redaktionelle Überarbeitung

3.2.9.100

Ergänzung um upload_error

3.2.11.46

Ergänzung der Elemente <offers_per_page> und <page> zur Ermöglichung eines Paging-Verfahrens bei der Abfrage von Angeboten.

3.3.50.1

Ergänzung um das Feld offer_subtype.

4.8.2

Wertetabelle für Subchannels eingefügt.