API προϊόντων
Χρησιμοποιήστε το API προϊόντος για εξαγωγή πληροφοριών προϊόντος, προσθήκη προϊόντων ή ενημέρωση δεδομένων για υπάρχοντα προϊόντα ή παραλλαγές.
- Διαθέσιμα πεδία
- Εξαγάγετε τη λίστα προϊόντων
- Εξαγωγή δεδομένων προϊόντος
- Προσθήκη προϊόντος
- Αλλαγή δεδομένων προϊόντος
- Διαγραφή προϊόντος
Διαθέσιμα πεδία
Η παρακάτω λίστα δείχνει όλα τα διαθέσιμα πεδία για αυτό το API, τα οποία επιστρέφονται όταν εξαγάγετε μια μεμονωμένη λίστα ή πόρο, οι οποίοι μπορούν να τροποποιηθούν, οι οποίοι είναι υποχρεωτικοί κατά τη δημιουργία ενός νέου πόρου ή την ενημέρωση ενός υπάρχοντος πόρου.
Κωδικός περιγραφής
Υπόδειξη
Περιγραφή
Lista
Μεταβλητός
ταυτότητα
int
Αναγνωριστικό προϊόντος
τύπος
σειρά
Τύπος προϊόντος (βασικό, πολλαπλών παραλλαγών, ψηφιακό, πακέτο)
sku
σειρά
Κωδικός SKU προϊόντος
ean
σειρά
Κωδικός EAN προϊόντος
ext_ref
σειρά
Το αναγνωριστικό αναφοράς στο σύστημα του προμηθευτή
όνομα
σειρά
Ονομασία προϊόντος
περιγραφή
σειρά
Περιγραφή προϊόντος
meta_description
σειρά
Μετα-περιγραφή προϊόντος
inventory_enabled
σειρά
Ενεργοποίηση της λειτουργίας αποθέματος προϊόντος (προεπιλογή απενεργοποιημένη)
στοκ
int
Ποσότητα σε απόθεμα
αποθήκες
πίνακας
Διανομή αποθεμάτων από αποθήκες
αποθήκες []. id
int
Αναγνωριστικό αποθήκης
αποθήκες []. όνομα
σειρά
Όνομα της αποθήκης
αποθήκες []
int
Ποσότητα σε απόθεμα
αποθήκες []
σειρά
Θέση στο ράφι
διαθεσιμότητα_id
int
Διαθεσιμότητα προμηθευτή
price_net
φλοτέρ
Καθαρή τιμή
τιμή_ ακαθάριστο
φλοτέρ
Περιλαμβάνεται τιμή με φόρους
old_price_net
φλοτέρ
Η παλιά μη μειωμένη τιμή του προϊόντος
old_price_gross
φλοτέρ
Μη μειωμένη τιμή παλιού προϊόντος (περιλαμβάνονται φόροι)
τον αριθμό φορολογικού μητρώου
int
ID-ul taxei
φορολογική αξία
φλοτέρ
Ποσοστό αξίας του φόρου
όνομα_ φόρου
σειρά
Όνομα του φόρου
τύπος αποστολής
σειρά
Ορισμός κόστους παράδοσης σε επίπεδο προϊόντος (προεπιλογή, δωρεάν, μονάδα, απενεργοποιημένη)
ποσότητα_πολλαπλασιαστής
int
Πολλαπλασιαστής ποσότητας (προεπιλεγμένη τιμή 1)
Τύπος μονάδας
σειρά
Μονάδα τύπου μέτρου
shipping_unit_cost
φλοτέρ
Μονάδα κόστους παράδοσης προϊόντος
βάρος
φλοτέρ
Βάρος προϊόντος
κατηγορία_id
int
Αναγνωριστικό κατηγορίας
όνομα κατηγορίας
σειρά
Ονομα κατηγορίας
κατηγορίες
πίνακας
Κατανομή προϊόντων σε πολλές κατηγορίες
κατηγορίες [] .id
int
Αναγνωριστικό κατηγορίας
κατηγορίες []. όνομα
σειρά
Ονομα κατηγορίας
κατασκευαστής_id
int
Αναγνωριστικό κατασκευαστή
όνομα κατασκευαστή
σειρά
Όνομα κατασκευαστή
ετικέτες
πίνακας
Ετικέτες προϊόντων
ετικέτες [] .id
int
Αναγνωριστικό ετικέτας
ετικέτες []. όνομα
σειρά
Όνομα ετικέτας
product_attributes
πίνακας
Περιγραφικά χαρακτηριστικά προϊόντος
product_attributes []. αναγνωριστικό
int
Αναγνωριστικό χαρακτηριστικού
product_attributes [] όνομα
σειρά
Όνομα χαρακτηριστικού
product_attributes [] επιλογές
πίνακας
Λίστα επιλεγμένων τιμών χαρακτηριστικών
product_attributes []. επιλογές []. id
int
Αναγνωριστικό τιμής χαρακτηριστικού
product_attributes []. επιλογές []. τιμή
σειρά
Το όνομα της τιμής χαρακτηριστικού
παραλλαγή_διακρίσεων
πίνακας
Χαρακτηριστικά προϊόντος που διαφοροποιούν τις παραλλαγές του
variant_attributes []. αναγνωριστικό
int
Αναγνωριστικό χαρακτηριστικού
variant_attributes [] όνομα
σειρά
Όνομα χαρακτηριστικού
Επιλογές
πίνακας
Λίστα επιλεγμένων τιμών χαρακτηριστικών
variant_attributes []. επιλογές []. id
int
Αναγνωριστικό τιμής χαρακτηριστικού
variant_attributes []. επιλογές []. τιμή
σειρά
Το όνομα της τιμής χαρακτηριστικού
παραλλαγές
πίνακας
Παραλλαγές προϊόντων (προϊόντα πολλαπλών μεταβλητών)
παραλλαγές []. id
int
Αναγνωριστικό παραλλαγής
παραλλαγές []. sku
σειρά
Παραλλαγή κωδικού SKU
variants[].ean
σειρά
Κωδικός EAN της παραλλαγής
παραλλαγές []. inventory_enabled
σειρά
Ενεργοποίηση της λειτουργίας αποθέματος παραλλαγής
παραλλαγές []
int
Παραλλαγή αποθεμάτων
παραλλαγές []. price_net
φλοτέρ
Καθαρή τιμή
παραλλαγές []. price_gross
φλοτέρ
Περιλαμβάνεται τιμή με φόρους
παραλλαγές []. variant_options []
πίνακας
Χαρακτηριστικά που καθορίζουν παραλλαγές προϊόντος
παραλλαγές []. variant_options []. id
int
Αναγνωριστικό χαρακτηριστικού
παραλλαγές []. variant_options []. όνομα
int
Όνομα χαρακτηριστικού
παραλλαγές []. variant_options []. τιμή
σειρά
Τιμή χαρακτηριστικού
παραλλαγές []
σειρά
Επιλογές ορατότητας ("ορατό", "διακοπείσα")
meta_fields
αντικείμενο
Πρόσθετα πεδία
meta_fields [].img[]
πίνακας
Πρόσθετο πεδίο εικόνας
meta_fields [] .img []. όνομα
int
Όνομα εικόνας
meta_fields [] .img [] .ext
σειρά
Επέκταση εικόνας
meta_fields [] .img []. πλάτος
int
Πλάτος εικόνας
meta_fields [] .img []. ύψος
int
Μήκος εικόνας
meta_fields [].img[] .path
σειρά
Η διαδρομή της εικόνας
meta_fields [].list[]
σειρά
Πρόσθετο πεδίο τύπου λίστας
meta_fields [].text[]
σειρά
Πρόσθετο πεδίο κειμένου
πεδία χρήστη
πίνακας
Λίστα προσαρμόσιμων πεδίων
url
σειρά
Διεύθυνση URL προϊόντος (ενεργό, ανενεργό)
εικόνες
πίνακας
Λίστα εικόνων
εικόνες []. id
int
Αναγνωριστικό εικόνας
εικόνες []. url
σειρά
URL εικόνας
εικόνες []. λεζάντα
int
Όνομα εικόνας
meta_links
πίνακας
Διευθύνσεις URL προϊόντων για ενεργές γλώσσες
meta_links[].lang
σειρά
Γλώσσα
meta_links[].url
σειρά
Διεύθυνση URL προϊόντος
Ημερομηνία Δημιουργίας
ημερομηνία
Ημερομηνία προσθήκης του προϊόντος (μορφή ISO 8601)
ημερομηνία_ τροποποιήθηκε
ημερομηνία
Ημερομηνία τελευταίας αλλαγής προϊόντος, δεν περιλαμβάνει ενημερώσεις τιμών και αποθεμάτων (μορφή ISO 8601)
date_last_updated
ημερομηνία
Ημερομηνία τελευταίας τροποποίησης, περιλαμβάνει ενημερώσεις τιμών και αποθεμάτων (μορφή ISO 8601)
κατάσταση
σειρά
Κατάσταση εγγραφής (ενεργή, ανενεργή)
είναι_επιλεγμένο
bool
Το προϊόν εμφανίζεται στην αρχική σελίδα
είναι καταχωρημένο στη λίστα
bool
Το προϊόν πληροί τις προϋποθέσεις που πρέπει να αναφέρονται στον ιστότοπο
είναι νέο
bool
Το προϊόν επισημαίνεται ως νέο ή προστέθηκε πρόσφατα
είναι_marked_new
bool
Το προϊόν επισημαίνεται ως νέο
σε απόθεμα
bool
Το προϊόν πληροί τους όρους που πρέπει να αγοραστούν
συνολικές πωλήσεις
int
Ο αριθμός παραγγελιών στις οποίες βρίσκεται το προϊόν
σύνολο_units_sold
int
Συνολικός αριθμός μονάδων που πωλήθηκαν
συνολικές προβολές
int
Συνολικός αριθμός εμφανίσεων προϊόντος
bundled_products
πίνακας
Τα προϊόντα που περιλαμβάνονται στη συσκευασία
ορατότητα
σειρά
Optiuni vizibilitate ("ορατό", "διακοπεί", "κρυφό")
ΥΠΟΔΕΙΞΗ
Τυχόν επιστρεφόμενα και χωρίς έγγραφα πεδία μπορούν να αγνοηθούν επειδή δεν είναι ακόμη διαθέσιμα.
Εξαγάγετε τη λίστα προϊόντων
Εμφανίζει τη φιλτραρισμένη λίστα εγγραφών.
Τύπος : Λίστα πόρων
ρήμα : GET
Διεύθυνση URL : /api/v2/products
Αποτελέσματα φίλτρου : Ναι
Επιλογή πεδίου : Ναι
Συμπερίληψη επιπλέον πεδίων : Ναι
Σελίδα : Ναι
Ο κωδικός http απόκρισης είναι 200
επιτυχής, η απόκριση θα έχει τη μορφή μιας λίστας πόρων που σχετίζονται με τα καθορισμένα φίλτρα.
Μόνο τα πεδία λίστας θα συμπεριληφθούν στο τυπικό αποτέλεσμα. Μπορείτε να συμπεριλάβετε επιπλέον πεδία που δεν περιλαμβάνονται από προεπιλογή χρησιμοποιώντας την παράμετρο include
και αναφέρετε ρητά μόνο τα πρόσθετα πεδία (διαχωρισμένα με κόμματα) που θέλετε να συμπεριληφθούν.
GET /api/v2/products?include=variants
Μπορείτε να φιλτράρετε τα πεδία που θέλετε να συμπεριληφθούν στο αποτέλεσμα για κάθε πόρο χρησιμοποιώντας την παράμετρο fields
και αναφέροντας ρητά μόνο τα πεδία (διαχωρισμένα με κόμματα) που θέλετε να συμπεριληφθούν (το πεδίο id
θα περιλαμβάνεται πάντα από προεπιλογή).
GET /api/v2/products?fields=id,name,url
Φιλτράρισμα αποτελεσμάτων
Είναι δυνατό να φιλτράρετε τα αποτελέσματα προσθέτοντας συγκεκριμένες παραμέτρους στη διεύθυνση URL.
Παράμετρος
Περιγραφή
Παράδειγμα
ταυτότητα
Αναγνωριστικό προϊόντος
id = 10001
αναγνωριστικά
Λίστα αναγνωριστικών προϊόντων διαχωρισμένων με κόμματα
ids = 10001,10002,10003
τύπος
Τύπος προϊόντος (βασικό, πολλαπλών παραλλαγών, ψηφιακό, πακέτο)
type = multi_variant
sku
Κωδικός SKU προϊόντος
sku = PN.1358
ean
Κωδικός EAN προϊόντος
ean=7501031311309
κατηγορία_id
Το αναγνωριστικό της κατηγορίας στην οποία ανήκει
κατηγορία_id = 101
κατηγορία_ids
Αναγνωριστικά κατηγορίας λίστας
Category_ids = 101,102,103
κατασκευαστής_id
Αναγνωριστικό κατασκευαστή
κατασκευαστής_id = 1001
κατασκευαστής_ids
Λίστα αναγνωριστικών κατασκευαστή
κατασκευαστής_ids = 1001.1002.1003
meta_fields
Πρόσθετα πεδία
meta_fields [field_key] = τιμή_ πεδίου
δημιουργήθηκε μετά
Ημερομηνία δημιουργίας των εγγραφών (μορφή ISO 8601)
create_after = 2019-01-01
δημιουργήθηκε πριν
Ημερομηνία έως την οποία δημιουργήθηκαν οι εγγραφές (μορφή ISO 8601)
δημιουργήθηκε_πριν = 2020-01-01
τροποποιήθηκε μετά
Ημερομηνία τελευταίας τροποποίησης των εγγραφών (μορφή ISO 8601)
τροποποιημένο_after = 2019-01-01
τροποποιήθηκε πριν
Ημερομηνία τροποποίησης των εγγραφών (μορφή ISO 8601)
τροποποιήθηκε_πριν = 2020-01-01
κατάσταση
Κατάσταση εγγραφής (ενεργή, ανενεργή)
κατάσταση = ενεργό
είναι_επιλεγμένο
Εγγραφές που εμφανίζονται στην αρχική σελίδα (0, 1)
is_featured = 1
είναι νέο
Νέες εγγραφές ή επισημαίνονται ως νέες (0, 1)
is_new = 1
tag_name
Όνομα ετικέτας
tag_name = τιμή
ετικέτες_ids
Λίστα ετικετών ταυτότητας διαχωρισμένα με κόμματα
tag_ids = 123,456
ext_ref
Η τιμή της εξωτερικής αναφοράς
ext_ref = τιμή
GET /api/v2/products?category_id=101&status=active
Ταξινόμηση αποτελεσμάτων
Είναι δυνατή η ταξινόμηση των αποτελεσμάτων προσθέτοντας συγκεκριμένες παραμέτρους στη διεύθυνση URL.
Παράμετρος
Περιγραφή
Παράδειγμα
όνομα
Αύξουσα όνομα προϊόντος
είδος = όνομα
όνομα.desc
Φθίνουσα ονομασία προϊόντος
είδος = όνομα.desc
Ημερομηνία Δημιουργίας
Ημερομηνία προσθήκης του ανερχόμενου προϊόντος
ταξινόμηση = ημερομηνία_δημιουργήθηκε
date_created.desc
Ημερομηνία προσθήκης του φθίνοντος προϊόντος
sort = date_created.desc
νεότερο
Τα νεότερα προϊόντα
είδος = νεότερο
ημερομηνία_ τροποποιήθηκε
Αύξουσα ημερομηνία ενημέρωσης προϊόντος
ταξινόμηση = ημερομηνία_ τροποποιημένη
date_modified.desc
Η ημερομηνία ενημέρωσης προϊόντος φθάνει
sort = date_modified.desc
τάξη
Τα πιο δημοφιλή προϊόντα
ταξινόμηση = κατάταξη
best_seller
Προϊόντα με τις καλύτερες πωλήσεις
είδος = best_seller
τιμή
Αύξηση της καθαρής τιμής των προϊόντων
είδος = τιμή
τιμή.desc
Καθαρή τιμή των προϊόντων φθίνουσα
είδος = τιμή.desc
GET /api/v2/products?sort=name
Σελιδοποίηση
Οι παράμετροι σελιδοποίησης μπορούν να προστεθούν στο αίτημα API για περιορισμό του αριθμού καταχωρήσεων ανά σελίδα και πρόσβαση σε όλες τις διαθέσιμες σελίδες.
Παράμετρος
Υπόδειξη
Προκαθορισμένο
αρχή
int
0
όριο
int
20
Το μέγιστο όριο εγγραφής ανά σελίδα δεν μπορεί να υπερβαίνει τα 100.
GET /api/v2/products?start=150&limit=50
Αίτημα μορφοποίησης
Παράδειγμα αιτήματος CURL που επιστρέφει όλες τις εγγραφές:
curl --request GET \
--url 'https://shop.demo.ro/api/v2/products' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}'
Εξαγωγή όλων των εγγραφών, εξαγωγή όλων των πεδίων
Παράδειγμα αιτήματος
GET /api/v2/products
Παράδειγμα απάντησης
{
"data": [
{
"id": 11,
"type": "basic",
"sku": null,
"name": "Cotton Twill Shirt for men",
"description": "<p>Rendered in feather-light cotton twill, this long-sleeved shirt from Ralph Lauren equips new season collections with comfortable breathability and an iconic profile.</p><p>Embroidered with the iconic Polo Pony logo on the chest, its slim point collar and button fastening combine to offer the label's signature preppy appeal.</p>",
"meta_description": null,
"inventory_enabled": "off",
"category_id": 6,
"category_name": "Shirts",
"manufacturer_id": 1000005,
"manufacturer_name": "Ralph Lauren",
"price_net": 127.72,
"price_gross": 127.72,
"tax_id": 1,
"tax_name": "VAT",
"tax_value": 0,
"url": "https://shop.demo.ro/shirts/cotton-twill-shirt-for-men",
"date_created": "2019-01-29T16:43:35+02:00",
"date_modified": "2020-03-01T20:55:51+02:00",
"status": "active",
"visibility": "visible",
"is_listed": true,
"in_stock": true,
"total_sales": 0,
"total_units_sold": 0,
"total_views": 0
},
{
"id": 12,
"type": "basic",
"sku": null,
"name": "Striped Shirt",
"description": "<p>A staple piece that cleverly merges statement with minimalist, this shirt from Polo Ralph Lauren is infused with nautical stripes that can be transformed from casual to formal depending on the occasion.</p><p>Embroidered with the signature Pony logo to the chest, the breezy cotton silhouette boasts a classic point collar and mother-of-pearl button fastenings to complement the cobalt tones.</p>",
"meta_description": null,
"inventory_enabled": "off",
"category_id": 6,
"category_name": "Shirts",
"manufacturer_id": 1000005,
"manufacturer_name": "Ralph Lauren",
"price_net": 126.04,
"price_gross": 126.04,
"tax_id": 1,
"tax_name": "VAT",
"tax_value": 0,
"url": "https://shop.demo.ro/shirts/striped-shirt",
"date_created": "2019-01-29T16:43:35+02:00",
"date_modified": "2020-03-01T20:55:51+02:00",
"status": "active",
"visibility": "visible",
"is_listed": true,
"in_stock": true,
"total_sales": 0,
"total_units_sold": 0,
"total_views": 0
},
{ ... }
],
"meta": {
"count": {
"total": 2000,
"current": 20,
"start": 0,
"limit": 20
},
"links": {
"prev": null,
"current": "/api/v2/products",
"next": "/api/v2/products?start=20"
}
}
}
Εξαγάγετε όλες τις εγγραφές, φιλτράρετε μόνο συγκεκριμένα πεδία
Παράδειγμα αιτήματος
GET /api/v2/products?fields=id,name,url
Παράδειγμα απάντησης
{
"data": [
{
"id": 11,
"name": "Cotton Twill Shirt for men",
"url": "https://shop.demo.ro/shirts/cotton-twill-shirt-for-men"
},
{
"id": 12,
"name": "Striped Shirt",
"url": "https://shop.demo.ro/shirts/striped-shirt"
},
{ ... }
],
"meta": {
"count": {
"total": 2000,
"current": 20,
"start": 0,
"limit": 20
},
"links": {
"prev": null,
"current": "/api/v2/products",
"next": "/api/v2/products?start=20"
}
}
}
Εξαγάγετε όλες τις εγγραφές, συμπεριλάβετε επιπλέον πεδία
Παράδειγμα αιτήματος
GET /api/v2/products?include=images
Παράδειγμα απάντησης
{
"data": [
{
"id": 11,
"type": "basic",
"sku": null,
"ean": null,
"name": "Cotton Twill Shirt for men",
"description": "<p>Rendered in feather-light cotton twill, this long-sleeved shirt from Ralph Lauren equips new season collections with comfortable breathability and an iconic profile.</p><p>Embroidered with the iconic Polo Pony logo on the chest, its slim point collar and button fastening combine to offer the label's signature preppy appeal.</p>",
"meta_description": null,
"inventory_enabled": "off",
"category_id": 6,
"category_name": "Camasi",
"manufacturer_id": 1000005,
"manufacturer_name": "Ralph Lauren",
"price_net": 127.72,
"price_gross": 151.99,
"tax_id": 1,
"tax_name": "TVA",
"tax_value": 19,
"url": "http://shop.demo.ro/shirts/cotton-twill-shirt-for-men",
"images": [
{
"id": 43,
"url": "https://s.cdnmpro.com/242394140/p/l/3/cotton-twill-shirt-for-men~43.jpg",
"caption": null
},
{
"id": 686,
"url": "https://s.cdnmpro.com/242394140/p/l/6/cotton-twill-shirt-for-men~686.jpg",
"caption": null
},
{
"id": 687,
"url": "https://s.cdnmpro.com/242394140/p/l/7/cotton-twill-shirt-for-men~687.jpg",
"caption": null
}
],
"date_created": "2019-01-29T16:43:35+02:00",
"date_modified": "2020-04-08T12:22:17+03:00",
"status": "active",
"visibility": "visible",
"is_listed": true,
"in_stock": true,
"total_sales": 1,
"total_units_sold": 1,
"total_views": 0
},
{
"id": 12,
"type": "basic",
"sku": null,
"ean": null,
"name": "Striped Shirt",
"description": "<p>A staple piece that cleverly merges statement with minimalist, this shirt from Polo Ralph Lauren is infused with nautical stripes that can be transformed from casual to formal depending on the occasion.</p><p>Embroidered with the signature Pony logo to the chest, the breezy cotton silhouette boasts a classic point collar and mother-of-pearl button fastenings to complement the cobalt tones.</p>",
"meta_description": null,
"inventory_enabled": "off",
"category_id": 6,
"category_name": "Camasi",
"manufacturer_id": 1000005,
"manufacturer_name": "Ralph Lauren",
"price_net": 126.04,
"price_gross": 149.99,
"tax_id": 1,
"tax_name": "TVA",
"tax_value": 19,
"url": "http://shop.demo.ro/shirts/striped-shirt",
"images": [
{
"id": 46,
"url": "https://s.cdnmpro.com/242394140/p/l/6/striped-shirt~46.jpg",
"caption": null
},
{
"id": 693,
"url": "https://s.cdnmpro.com/242394140/p/l/3/striped-shirt~693.jpg",
"caption": null
},
{
"id": 694,
"url": "https://s.cdnmpro.com/242394140/p/l/4/striped-shirt~694.jpg",
"caption": null
}
],
"date_created": "2019-01-29T16:43:35+02:00",
"date_modified": "2020-04-08T12:22:17+03:00",
"status": "active",
"visibility": "visible",
"is_listed": true,
"in_stock": true,
"total_sales": 5,
"total_units_sold": 5,
"total_views": 0
},
{ ... }
],
"meta": {
"count": {
"total": 2000,
"current": 20,
"start": 0,
"limit": 20
},
"links": {
"prev": null,
"current": "/api/v2/products?include=images",
"next": "/api/v2/products?include=images&start=20"
}
}
}
Φιλτράρετε εγγραφές βάσει λίστας αναγνωριστικών, φιλτράρετε μόνο συγκεκριμένα πεδία
Παράδειγμα αιτήματος
GET /api/v2/products?ids=101,102&fields=id,name
Παράδειγμα απάντησης
{
"data": [
{
"id": 101,
"name": "Cotton Twill Shirt for men"
},
{
"id": 102,
"name": "Striped Shirt"
},
{ ... }
],
"meta": {
"count": {
"total": 2,
"current": 2,
"start": 0,
"limit": 20
},
"links": {
"prev": null,
"current": "/api/v2/products?ids=101,102&fields=id,name",
"next": null
}
}
}
Εξαγωγή δεδομένων προϊόντος
Εμφανίζει τα δεδομένα μιας μεμονωμένης εγγραφής.
Τύπος : Ατομικός πόρος
ρήμα : GET
Διεύθυνση URL : /api/v2/products/{id}
Αποτελέσματα φίλτρου : Όχι
Επιλογή πεδίου : Ναι
Συμπερίληψη επιπλέον πεδίων : Όχι
Σελίδα : Όχι
Ο κωδικός απόκρισης http είναι 200
σε περίπτωση επιτυχίας, η απάντηση θα έχει τη μορφή ενός μεμονωμένου πόρου που σχετίζεται με το αναγνωριστικό που ζητήσατε.
Μπορείτε να φιλτράρετε τα πεδία που θέλετε να συμπεριληφθούν στο αποτέλεσμα για κάθε πόρο χρησιμοποιώντας την παράμετρο "πεδία" και να αναφέρετε ρητά μόνο τα πεδία (διαχωρισμένα με κόμματα) που θέλετε να συμπεριληφθούν (το πεδίο id θα συμπεριλαμβάνεται πάντα από προεπιλογή)
GET /api/v2/products/{id}?fields=id,name,category_id
Αίτημα μορφοποίησης
Παράδειγμα αιτήματος CURL που επιστρέφει μια μεμονωμένη εγγραφή:
curl --request GET \
--url 'https://shop.demo.ro/api/v2/products/30' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}'
Εξαγωγή όλων των πεδίων
Παράδειγμα αιτήματος
GET /api/v2/products/30
Παράδειγμα απάντησης
{
"id": 30,
"type": "basic",
"sku": null,
"name": "Low Neckline Dress",
"description": "<p>Boasting a deep neckline and gathering details, this dress from Roberto Cavalli is sure to make an impression. The sleeveless design can be worn during the day with tights and boots and elevated come evening with an embellished clutch bag and pointed heels.</p>",
"meta_description": null,
"inventory_enabled": "off",
"category_id": 9,
"category_name": "Dresses",
"manufacturer_id": 1000010,
"manufacturer_name": "Roberto Cavalli",
"price_net": 515.96,
"price_gross": 515.96,
"tax_id": 1,
"tax_name": "VAT",
"tax_value": 0,
"url": "https://shop.demo.ro/dresses/low-neckline-dress",
"meta_links": [
{
"lang": "en_US",
"url": "https://shop.demo.ro/dresses/low-neckline-dress"
}
],
"images": [
{
"id": 100,
"url": "https://cdn1.shopmania.biz/files/s15/936942325/p/l/0/100.jpg",
"caption": null
},
{
"id": 822,
"url": "https://cdn1.shopmania.biz/files/s15/936942325/p/l/2/822.jpg",
"caption": null
}
],
"product_attributes": [
{
"id": 5,
"name": "Colour",
"options": [
"id": 5,
"name": "Purple",
]
},
{
"id": 6,
"name": "Occasion",
"options": [
"id": 15,
"name": "Party",
]
}
],
"date_created": "2019-01-29T16:43:36+02:00",
"date_modified": "2020-03-01T20:55:51+02:00",
"status": "active",
"visibility": "visible",
"is_listed": true,
"in_stock": true,
"total_sales": 0,
"total_units_sold": 0,
"total_views": 0
}
Φιλτράρετε μόνο ορισμένα πεδία
Παράδειγμα αιτήματος
GET /api/v2/products/101?fields=id,name,url
Παράδειγμα απάντησης
{
"id": 101,
"name": "Low Neckline Dress",
"url": "https://shop.demo.ro/dresses/low-neckline-dress"
}
Προσθήκη προϊόντος
Σας επιτρέπει να προσθέσετε μια νέα εγγραφή.
Τύπος : Δυναμικού Δημιουργία
ρήμα : POST
Url :/api/v2/products
Ο κωδικός http απόκρισης είναι 200
επιτυχής, η απόκριση θα έχει τη μορφή ενός μεμονωμένου πόρου που θα αντιπροσωπεύει την εγγραφή που μόλις προστέθηκε.
Αίτημα μορφοποίησης
Παράδειγμα αιτήματος CURL που δημιουργεί ένα νέο βασικό προϊόν:
curl --request POST \
--url 'https://shop.demo.ro/api/v2/products' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}' \
--data-raw '{
"type": "basic",
"name": "Leather Cardholder Wallet",
"description": "A classic bi-fold wallet, perfect for everyday use",
"category_id": 22,
"price_gross": 89
}'
Παράδειγμα αιτήματος CURL που δημιουργεί ένα νέο προϊόν πολλαπλών μεταβλητών:
curl --request POST \
--url 'https://shop.demo.ro/api/v2/products' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}' \
--data-raw '{
"type": "multi_variant",
"name": "Leather biker jacket",
"description": "We\u0027ve fused traditional bomber jackets with classic elements from biker styles.",
"category_id": 10,
"manufacturer_id": 1000014,
"product_attributes": [
{
"name": "Material",
"options": [
{
"value": "Leather"
},
{
"value": "Faux leather"
}
]
},
{
"name": "Sleeve size",
"options": [
{
"value": "Small"
},
{
"value": "Medium"
},
{
"value": "Large"
}
]
}
],
"variant_attributes": [
{
"name": "Size",
"options": [
{
"value": "S"
},
{
"value": "M"
},
{
"value": "L"
}
]
}
],
"variants": [
{
"inventory_enabled": "off",
"price_gross": 457,
"variant_options": [
{
"name": "Size",
"value": "M"
}
]
}
],
"images": [
{
"caption": "Front side",
"default": true,
"base64": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAIBAQIBAQICAgICAgICAwUDAwMDAwYEBAMFBwYHBwcGBwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wBDAQICAgMDAwYDAwYMCAcIDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAAyADIDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD8q6KKK+PP9CAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD/2Q=="
}
]
}'
Προσθέστε βασικό προϊόν
Παράδειγμα αιτήματος
POST /api/v2/products
{
"type": "basic",
"name": "Leather Cardholder Wallet",
"description": "A classic bi-fold wallet, perfect for everyday use",
"category_id": 22,
"price_gross": 89,
"stock": 10
}
Παράδειγμα απάντησης
{
"id": 17838,
"type": "basic",
"sku": null,
"ean": null,
"ext_ref": null,
"name": "Leather Cardholder Wallet",
"description": "A classic bi-fold wallet, perfect for everyday use",
"meta_description": null,
"inventory_enabled": "off",
"category_id": 22,
"category_name": "Wallets",
"categories": [
{
"id": 22,
"name": "Wallets"
}
],
"manufacturer_id": 0,
"manufacturer_name": null,
"price_net": 80.91,
"price_gross": 89,
"tax_id": 3,
"tax_name": "taxa 10",
"tax_value": 10,
"quantity_multiplier": 1,
"unit_id": 0,
"shipping_unit_cost": 0,
"weight": null,
"url": "http://shop.demo.ro/leather-cardholder-wallet-17838",
"meta_links": [
{
"lang": "ro_RO",
"url": "http://shop.demo.ro/cumpara/leather-cardholder-wallet-17838"
},
{
"lang": "de_DE",
"url": "http://shop.demo.ro/de/cumpara/leather-cardholder-wallet-17838"
},
{
"lang": "en_GB",
"url": "http://shop.demo.ro/buy/leather-cardholder-wallet-17838"
},
{
"lang": "fr_FR",
"url": "http://shop.demo.ro/acheter/leather-cardholder-wallet-17838"
},
{
"lang": "it_IT",
"url": "http://shop.demo.ro/compra/leather-cardholder-wallet-17838"
},
{
"lang": "hu_HU",
"url": "http://shop.demo.ro/hu/cumpara/leather-cardholder-wallet-17838"
}
],
"images": [],
"date_created": "2020-04-30T13:30:51+03:00",
"date_modified": "2020-04-30T13:30:51+03:00",
"status": "active",
"visibility": "visible",
"is_listed": true,
"in_stock": true,
"total_sales": 0,
"total_units_sold": 0,
"total_views": 0
}
Προσθέστε προϊόν πολλαπλών παραλλαγών
Παράδειγμα αιτήματος
POST /api/v2/products
{
"type": "multi_variant",
"name": "Leather biker jacket",
"description": "We\u0027ve fused traditional bomber jackets with classic elements from biker styles.",
"category_id": 10,
"manufacturer_id": 1000014,
"product_attributes": [
{
"name": "Material",
"options": [
{
"value": "Leather"
},
{
"value": "Faux leather"
}
]
},
{
"name": "Sleeve size",
"options": [
{
"value": "Small"
},
{
"value": "Medium"
},
{
"value": "Large"
}
]
}
],
"variant_attributes": [
{
"name": "Size",
"options": [
{
"value": "S"
},
{
"value": "M"
},
{
"value": "L"
}
]
}
],
"variants": [
{
"inventory_enabled": "off",
"price_gross": 457,
"variant_options": [
{
"name": "Size",
"value": "M"
}
]
}
],
"images": [
{
"caption": "Front side",
"default": true,
"base64": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAIBAQIBAQICAgICAgICAwUDAwMDAwYEBAMFBwYHBwcGBwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wBDAQICAgMDAwYDAwYMCAcIDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAAyADIDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD8q6KKK+PP9CAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD/2Q=="
}
]
}
Παράδειγμα απάντησης
{
"id": 620,
"type": "multi_variant",
"sku": null,
"name": "Leather biker jacket",
"description": "We've fused traditional bomber jackets with classic elements from biker styles.",
"meta_description": null,
"inventory_enabled": "on",
"stock": 0,
"stock_value": 0,
"category_id": 10,
"category_name": "Coats & Jackets",
"manufacturer_id": 1000014,
"manufacturer_name": "Dolce & Gabbana",
"price_net": 457,
"price_gross": 457,
"tax_id": 0,
"tax_value": null,
"url": "https://shop.demo.ro/coats-jackets/leather-biker-jacket",
"meta_links": [
{
"lang": "en_US",
"url": "https://shop.demo.ro/coats-jackets/leather-biker-jacket"
}
],
"images": [
{
"id": 2051,
"url": "https://cdn1.shopmania.biz/files/s15/936942325/p/l/1/2051.jpg",
"caption": "Front side"
}
],
"product_attributes": [
{
"id": 8,
"name": "Material",
"options": [
{
"value": "Leather"
},
{
"value": "Faux leather"
}
]
},
{
"id": 9,
"name": "Sleeve size",
"options": [
{
"value": "Small"
},
{
"value": "Medium"
},
{
"value": "Large"
}
]
}
],
"variant_attributes": [
{
"id": 4,
"name": "Size",
"options": [
{
"value": "S"
},
{
"value": "M"
},
{
"value": "L"
}
]
}
],
"variants": [
{
"id": 10000001,
"sku": null,
"inventory_enabled": "off",
"price_net": 457,
"price_gross": 457,
"variant_options": [
{
"id": 4,
"name": "Size",
"value": "M"
}
],
"visibility": "visible"
}
],
"date_created": "2020-03-04T16:19:02+02:00",
"date_modified": "2020-03-04T16:19:03+02:00",
"status": "active",
"visibility": "visible",
"is_listed": true,
"in_stock": true,
"total_sales": 0,
"total_units_sold": 0,
"total_views": 0
}
Αλλαγή δεδομένων προϊόντος
Σας επιτρέπει να ενημερώσετε μια υπάρχουσα εγγραφή βάσει αναγνωριστικού.
Τύπος : Δυναμικού Ενημέρωση
ρήμα : PATCH
Url :/api/v2/products/{id}
Ο κωδικός http απόκρισης είναι 200
επιτυχής, η απόκριση θα έχει τη μορφή ενός μεμονωμένου πόρου που αντιπροσωπεύει την εγγραφή που μόλις ενημερώθηκε.
Αίτημα μορφοποίησης
Παράδειγμα αιτήματος CURL που ενημερώνει μια υπάρχουσα εγγραφή:
curl --request PATCH \
--url 'https://shop.demo.ro/api/v2/products/619' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}' \
--data-raw '{
"price_gross": 59,
"old_price_gross": 89,
"stock": 250
}'
Ενημέρωση δεδομένων προϊόντος
Παράδειγμα αιτήματος
PATCH /api/v2/products/17838
{
"price_gross": 59,
"old_price_gross": 89
}
Παράδειγμα απάντησης
{
"id": 17838,
"type": "basic",
"sku": null,
"ean": null,
"ext_ref": null,
"name": "Leather Cardholder Wallet",
"description": "A classic bi-fold wallet, perfect for everyday use",
"meta_description": null,
"inventory_enabled": "off",
"category_id": 22,
"category_name": "Wallets",
"categories": [
{
"id": 22,
"name": "Wallets"
}
],
"manufacturer_id": 0,
"manufacturer_name": null,
"price_net": 53.64,
"price_gross": 59,
"old_price_net": 80.91,
"old_price_gross": 89,
"tax_id": 3,
"tax_name": "taxa 10",
"tax_value": 10,
"quantity_multiplier": 1,
"unit_id": 0,
"shipping_unit_cost": 0,
"weight": null,
"url": "http://shop.demo.ro/leather-cardholder-wallet-17838",
"meta_links": [
{
"lang": "ro_RO",
"url": "http://shop.demo.ro/cumpara/leather-cardholder-wallet-17838"
},
{
"lang": "de_DE",
"url": "http://shop.demo.ro/de/cumpara/leather-cardholder-wallet-17838"
},
{
"lang": "en_GB",
"url": "http://shop.demo.ro/buy/leather-cardholder-wallet-17838"
},
{
"lang": "fr_FR",
"url": "http://shop.demo.ro/acheter/leather-cardholder-wallet-17838"
},
{
"lang": "it_IT",
"url": "http://shop.demo.ro/compra/leather-cardholder-wallet-17838"
},
{
"lang": "hu_HU",
"url": "http://shop.demo.ro/hu/cumpara/leather-cardholder-wallet-17838"
}
],
"images": [],
"product_attributes": [],
"variant_attributes": [],
"date_created": "2020-04-30T13:30:51+03:00",
"date_modified": "2020-04-30T13:30:51+03:00",
"status": "active",
"visibility": "visible",
"is_listed": true,
"in_stock": true,
"total_sales": 0,
"total_units_sold": 0,
"total_views": 0
}
Αλλαγή κατάστασης προϊόντος
Παράδειγμα αιτήματος
PATCH /api/v2/products/101
{
"status": "inactive"
}
Παράδειγμα απάντησης
{
"id": 17838,
"type": "basic",
"sku": null,
"ean": null,
"ext_ref": null,
"name": "Leather Cardholder Wallet",
"description": "A classic bi-fold wallet, perfect for everyday use",
"meta_description": null,
"inventory_enabled": "off",
"category_id": 22,
"category_name": "Wallets",
"categories": [
{
"id": 22,
"name": "Wallets"
}
],
"manufacturer_id": 0,
"manufacturer_name": null,
"price_net": 53.64,
"price_gross": 59,
"old_price_net": 80.91,
"old_price_gross": 89,
"tax_id": 3,
"tax_name": "taxa 10",
"tax_value": 10,
"quantity_multiplier": 1,
"unit_id": 0,
"shipping_unit_cost": 0,
"weight": null,
"url": "http://shop.demo.ro/cumpara/leather-cardholder-wallet-17838",
"meta_links": [
{
"lang": "ro_RO",
"url": "http://shop.demo.ro/cumpara/leather-cardholder-wallet-17838"
},
{
"lang": "de_DE",
"url": "http://shop.demo.ro/de/cumpara/leather-cardholder-wallet-17838"
},
{
"lang": "en_GB",
"url": "http://shop.demo.ro/buy/leather-cardholder-wallet-17838"
},
{
"lang": "fr_FR",
"url": "http://shop.demo.ro/acheter/leather-cardholder-wallet-17838"
},
{
"lang": "it_IT",
"url": "http://shop.demo.ro/compra/leather-cardholder-wallet-17838"
},
{
"lang": "hu_HU",
"url": "http://shop.demo.ro/hu/cumpara/leather-cardholder-wallet-17838"
}
],
"images": [],
"product_attributes": [],
"variant_attributes": [],
"date_created": "2020-04-30T13:30:51+03:00",
"date_modified": "2020-04-30T13:30:51+03:00",
"status": "inactive",
"visibility": "visible",
"is_listed": false,
"in_stock": true,
"total_sales": 0,
"total_units_sold": 0,
"total_views": 0
}
Αλλαγή παραλλαγών προϊόντος
Παράδειγμα αιτήματος
PATCH /api/v2/products/101
{
"variant_attributes": [
{
"name": "Color",
"options": [
{
"value": "White"
},
{
"value": "Blue"
}
]
}
],
"variants": [
{
"price_net": 457,
"price_gross": 457,
"variant_options": [
{
"name": "Color",
"value": "Blue"
}
]
}
]
}
Παράδειγμα απάντησης
{
"id": 630,
"type": "multi_variant",
"sku": null,
"ean": null,
"name": "Leather biker jacket",
"description": "We've fused traditional bomber jackets with classic elements from biker styles.",
"meta_description": null,
"inventory_enabled": "on",
"stock": 0,
"category_id": 10,
"category_name": "Jackets",
"categories": [
{
"id": 10,
"name": "Jackets"
}
],
"manufacturer_id": 1000014,
"manufacturer_name": "Dolce & Gabbana",
"price_net": 457,
"price_gross": 457,
"tax_id": 0,
"tax_value": null,
"url": "http://shop.demo.ro//cumpara/leather-biker-jacket-630",
"meta_links": [
{
"lang": "ro_RO",
"url": "http://shop.demo.ro//cumpara/leather-biker-jacket-630"
},
{
"lang": "en_GB",
"url": "http://shop.demo.ro//en/cumpara/leather-biker-jacket-630"
},
{
"lang": "es_ES",
"url": "http://shop.demo.ro//es/cumpara/leather-biker-jacket-630"
}
],
"images": [
{
"id": 2057,
"url": "https://s.cdnmpro.com/242394140/p/l/5/narn-quilted-funnel-neck-jacket~205.jpg",
"caption": "Front side"
}
],
"product_attributes": [
{
"id": 15,
"name": "Sleeve size",
"options": [
{
"id": 108,
"value": "Small"
},
{
"id": 109,
"value": "Medium"
},
{
"id": 110,
"value": "Large"
}
]
},
{
"id": 3,
"name": "Material",
"options": [
{
"id": 106,
"value": "Leather"
},
{
"id": 107,
"value": "Faux leather"
}
]
}
],
"variant_attributes": [
{
"id": 17
"name": "Color",
"options": [
{
"id": 114,
"value": "White"
},
{
"id": 115,
"value": "Blue"
}
]
}
],
"variants": [
{
"id": 10000112,
"sku": null,
"inventory_enabled": "off",
"price_net": 457,
"price_gross": 457,
"variant_options": [
{
"id": 17,
"name": "Color",
"value": "Blue"
}
]
}
],
"date_created": "2020-04-30T13:27:37+03:00",
"date_modified": "2020-04-30T14:10:42+03:00",
"status": "active",
"visibility": "visible",
"is_listed": true,
"in_stock": true,
"total_sales": 0,
"total_units_sold": 0,
"total_views": 0
}
Διαγραφή προϊόντος
Σας επιτρέπει να διαγράψετε μια υπάρχουσα εγγραφή βάσει αναγνωριστικού.
Τύπος : Διαγραφή πόρου
ρήμα : DELETE
Url :/api/v2/products/{id}
Ο κωδικός απόκρισης http είναι 200
επιτυχής.
Αίτημα μορφοποίησης
Παράδειγμα αιτήματος CURL διαγραφής υπάρχουσας εγγραφής:
curl --request DELETE \
--url 'https://shop.demo.ro/api/v2/products/619' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}'
Παράδειγμα απάντησης
{
"ok": true
}