Navigation Properties - VIA eBay

Werbung
REST-Api - Products
Pr
od
uc
ts
Tho
mas
Hoff
man
n
2015
/06/2
6
12:0
1
Inhaltsverzeichnis
Beschreibung ...................................................................................................................................................................................................................................
Properties ..........................................................................................................................................................................................................................................
Page 1 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
Navigation Properties ....................................................................................................................................................................................................................
ProductImages ..............................................................................................................................................................................................................................
ProductSpecifics ..........................................................................................................................................................................................................................
ProductVariations .........................................................................................................................................................................................................................
ChildProducts ................................................................................................................................................................................................................................
ParentProducts .............................................................................................................................................................................................................................
Listings ............................................................................................................................................................................................................................................
ListingItems ....................................................................................................................................................................................................................................
CarParts ..........................................................................................................................................................................................................................................
DiscountOffers ..............................................................................................................................................................................................................................
OptionalProductAttributes .........................................................................................................................................................................................................
•
•
InhaltBeschreibung
Properties
• Navigation PropertiesProductImages
• ProductSpecifics
• ProductVariations
• ChildProducts
• ParentProducts
• Listings
• ListingItems
• CarParts
• DiscountOffers
• OptionalProductAttributes
Bevor die Produkte vom Fremdsystem in unserer System übertragen werden, sollten Sie sicherstellen, dass Sie
vorher die Kataloge/Kategorien aus dem Fremdsystem bei uns angelegt haben.
Somit wird gewährleistet, dass der Nutzer im Frontend unseres Systems eine Abbildung seiner
Kataloge/Kategorien aus dem Fremdsystem vorfindet und komfortabler in unserem System navigieren kann.
Beschreibung
Das EntitySet Products enthält die minimalen Produktdaten.
Jeder Eintrag eines Produktes wird über das Property Id identifiziert.
Mit dieser Id können die aktuellen Daten des Produktes in unserem System angefragt und Änderungen der
Daten durchgeführt werden.
Diese Id bildet die Assoziation zu anderen EntitySets
Properties
Alle Datums-/Zeitangaben werden in UTC ausgegeben.
Prop Wertt Anga Erläu
erty yp
be
terun
g
Id
Int64 Dami
t wird
ein
Entity
in
diese
m
Entity
Set
identi
fiziert
.
Page 2 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
Forei Strin Optio Mit
gnId g
nal diese
m
Wert
kann
das
Prod
ukt
im
Frem
dsyst
em
identi
fiziert
werd
en.
Hier
gibt
man
z.B.
einen
einde
utige
n
Wert
für
ein
Prod
ukt
aus
dem
Frem
dsyst
em
an.
Creat Date ionD Time
ate
Title
Enth
ält
das
Anlag
edatu
m
Wird
vom
Syste
m
auto
matis
ch
geset
zt
und
kann
nicht
verän
dert
werd
en.
Strin Pflic Enth
g
ht
ält
die
Bezei
chnu
ng
des
Prod
uktes
Für
eBay
darf
Page 3 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
der
Nam
e
nicht
länge
r als
80
Zeich
en
sein.
Desc Strin Kon Enth
riptio g
dition ält
n
al
die
Besc
hreib
ung
des
Prod
uktes
Bei
HTM
L
oder
XML
reser
vierte
n
Zeich
en
sollte
die
Besc
hreib
ung
mittel
s
CDA
TA
über
mittel
t
werd
en.
Wen
n
eine
der
Eigen
schaf
ten
Ean,
Upc
oder
Isbn
einen
Wert
enthä
lt, ist
die
Anga
be
optio
nal.
Es
wird
dann
versu
cht
mit
diese
n
Page 4 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
Wert
en
die
eBay
Katal
ogdat
en zu
nutze
n.
Enth
ält
keine
der
Eigen
schaf
ten
Ean,
Upc
oder
Isbn
einen
Wert,
ist
diese
Anga
be
Pflich
t.
Price Deci Opti Enth
mal onal ält
den
Preis
des
Prod
uktes
Diese
r
Preis
wird
als
Fest-/
Sofor
tkauf
enpre
is für
das
eBay
-Ang
ebot
genut
zt.
Das
Dezi
maltr
ennz
eiche
n
muss
ein
Punkt
(.)
sein.
Beisp
iel:
19.99
Stoc Int32 Pflich Enth
kAm
t
ält
ount
den
Besta
nd
Page 5 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
des
Prod
uktes
Diese
r
Besta
nd
wird
als
Meng
e für
das
eBay
-Ang
ebot
genut
zt.
Wird
der
Besta
nd
späte
r
reduz
iert,
so
wird
die
Meng
e des
eBay
-Ang
ebots
reduz
iert
bzw.
bei
nicht
ausre
ichen
dem
Besta
nd
wird
das
eBay
-Ang
ebot
auto
matis
ch
been
det.
Wird
der
Besta
nd
erhöh
t, so
wird
der
aktue
ller
Besta
nd
als
Meng
e zu
eBay
gese
ndet.
Page 6 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
Ean
Strin Optio Ean
g
nal des
Prod
uktes
Mit
diese
m
Wert
wird
versu
cht
die
eBay
Katal
ogdat
en zu
nutze
n.
Sollte
keine
Anga
be
vorha
nden
sein,
sollte
n
Wert
e in
den
Eigen
schaf
ten
Upc
oder
Isbn
vorha
nden
sein.
Ab
dem
29.06
.2015
ist
die
Anga
be
einer
GTIN
auf
der
eBay
Plattf
orm
verpfl
ichte
nd.
Upc
Strin Optio Upc
g
nal des
Prod
uktes
Mit
diese
m
Wert
wird
versu
cht
die
eBay
Katal
Page 7 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
ogdat
en zu
nutze
n.
Sollte
keine
Anga
be
vorha
nden
sein,
sollte
n
Wert
e in
den
Eigen
schaf
ten
Ean
oder
Isbn
vorha
nden
sein.
Ab
dem
29.06
.2015
ist
die
Anga
be
einer
GTIN
auf
der
eBay
Plattf
orm
verpfl
ichte
nd.
Isbn
Strin Optio Isbn
g
nal des
Prod
uktes
Mit
diese
m
Wert
wird
versu
cht
die
eBay
Katal
ogdat
en zu
nutze
n.
Sollte
keine
Anga
be
vorha
nden
sein,
sollte
n
Wert
Page 8 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
e in
den
Eigen
schaf
ten
Ean
oder
Upc
vorha
nden
sein.
Ab
dem
29.06
.2015
ist
die
Anga
be
einer
GTIN
auf
der
eBay
Plattf
orm
verpfl
ichte
nd.
Prod Int16 Pflich Gibt
uctT
t
den
ype
Type
n des
Prod
uktes
an
•
0
=
•
E
i
n
z
e
l
p
r
o
d
u
k
t
N
u
r
e
i
n
E
i
n
z
e
l
p
r
o
d
Page 9 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
u
k
t
k
a
n
n
P
r
o
d
u
k
t
s
p
e
z
i
f
i
k
a
t
i
o
n
e
n
(
A
t
t
r
i
b
u
t
e
)
•
h
a
b
e
n
1
=
•
V
a
r
i
a
t
i
o
n
s
s
e
t
E
i
n
V
a
r
Page 10 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
i
a
t
i
o
n
s
s
e
t
i
s
t
e
i
n
e
Z
u
s
a
m
m
e
n
f
a
s
s
u
n
g
v
o
n
E
i
n
z
e
l
p
r
o
d
u
k
t
e
n
m
i
t
S
p
e
z
i
f
i
k
a
t
i
o
n
Page 11 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
•
e
n
2
=
•
P
r
o
d
u
k
t
s
e
t
E
i
n
P
r
o
d
u
k
t
s
e
t
i
s
t
e
i
n
e
Z
u
s
a
m
m
e
n
f
a
s
s
u
n
g
v
o
n
E
i
n
z
e
l
p
r
o
d
u
k
t
Page 12 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
e
n
o
h
n
e
S
p
e
z
i
f
i
k
a
t
i
o
n
e
n
Modi Date ficati Time
onDa
te
Enth
ält
das
Ände
rungs
datu
m
Bei
Ände
runge
n
vom
Nutz
er
sowie
bei
Ände
runge
n
seite
ns
eBay
wird
das
Datu
m
auto
matis
ch
aktua
lisiert
Matc Int16 hing
Statu
s
Intern
er
Identi
fikato
r
VatP Float Optio Enth
erce
nal ält
nt
die
Mehr
werts
teuer
des
Prod
uktes
Page 13 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
IsWo Boole wDe an
al
Intern
er
Identi
fikato
r
Unit Float Opti Enth
Quan
onal ält
tity
den
Inhalt
des
Prod
uktes
(z.B.
1,5 |
0,7)
Die
Anga
be
dient
zur
Darst
ellun
g des
Grun
dabg
abepr
eises
UnitT Strin Optio Enth
ype g
nal ält
die
Maße
inheit
des
Prod
uktes
(z.B.
L,
100m
l,
Kilogr
amm)
Die
Anga
be
dient
zur
Darst
ellun
g des
Grun
dabg
abepr
eises
Disa Boole Optio Gibt
bleA an
nal an,
utom
ob
atch
der
intern
e
Matc
hingp
rozes
s für
die
eBay
Kate
gorie
vorsc
hläge
durch
gefüh
Page 14 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
rt
werd
en
soll.
Diese
s
Flag
wird
benöt
igt,
wenn
die
Servi
ceOp
eratio
n
SetE
bayC
atego
ry
aufge
rufen
wird.
Dami
t wird
gewä
hrleis
tet,
dass
der
intern
e
Matc
hingP
rozes
s
übers
prung
en
wird
unhd
stattd
esse
n die
Ebay
Kate
gorie
n aus
der
Servi
ceOp
eratio
n
SetE
bayC
atego
ry
übern
omm
en
werd
en
solle
n.
Shor Strin Optio Enth
tDes g
nal ält
cripti
die
on
Kurz
besc
hreib
ung
des
Page 15 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
Prod
uktes
Cond Strin Optio Enth
itionI g
nal ält
d
den
Zusta
nd
des
Prod
uktes
Unter
stütz
e
Wert
e:
“gebr
aucht
”
oder
“neu”
Best Deci Optio
Offer mal nal
Auto
Acce
ptPri
ce
Enth
ält
den
Preis,
ab
dem
Preis
vorsc
hläge
auto
matis
ch
ange
nom
men
werd
en
solle
n
Anga
be
muss
klein
er
dem
Verk
aufsp
reis
sein
Best Deci Optio
Offer mal nal
Mini
mum
Price
Enth
ält
den
Preis,
ab
dem
Preis
vorsc
hläge
auto
matis
ch
abgel
ehnt
werd
en
solle
n
Anga
be
Page 16 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
muss
klein
er
dem
Best
Offer
Auto
Acce
ptPric
e
sein
Mpn Strin Optio Enth
g
nal ält
die
Herst
ellern
umm
er
des
Prod
uktes
.
Ab
dem
29.06
.2015
ist
die
Anga
be
einer
Mpn
auf
der
eBay
Plattf
orm
verpfl
ichte
nd.
Bran Strin Optio Enth
d
g
nal ält
die
Mark
e der
Prod
uktes
Ab
dem
29.06
.2015
ist
die
Anga
be
einer
Bran
d auf
der
eBay
Plattf
orm
verpfl
ichte
nd.
Page 17 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
Navigation Properties
Mittels der Navigation Properties können assoziierte EntitySets zum EntitySet ListingItems abgerufen werden.
Die unten aufgeführten Beispiele beziehen sich auf das Entity mit der Id 1.
ProductImages
Abrufen von Produktbildern
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/ProductImages
ProductSpecifics
Abrufen von Produktspezifikationen
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/ProductSpecifics
ProductVariations
Abrufen der Produktvariationen
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/ProductVariations
ChildProducts
Abrufen von untergeordneten Produkten (zugeordnete Standardprodukte eines Produkt-/Variationsset)
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/ChildProducts
ParentProducts
Abrufen von übergeordneten Produkten
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/ParentProducts
Listings
Abrufen von plattformspezifischen Daten
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/Listings
ListingItems
Abrufen von eingestellten/verkauften Mengen
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/ListingItems
CarParts
Abrufen von zugehörigen CarParts
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/CarParts
Page 18 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
REST-Api - Products
DiscountOffers
Abrufen von zugehörigen DiscountOffer
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/DiscountOffers
OptionalProductAttributes
Abrufen von zugehörigen OptionalProductAttributes
GET
https://sandboxapi.via.de/publicapi/v1/api.svc/Products(1L)/OptionalProductAttributes
Page 19 - zuletzt bearbeitet von Thomas Hoffmann am 2015/06/26 12:01
Herunterladen