1. Κέντρο βοηθείας
  2. API & 3rd party εφαρμογές
  3. Εντολές API

Εντολές API

Χρησιμοποιήστε το API εντολών για να ανακτήσετε πληροφορίες εντολών, να προσθέσετε νέες εντολές ή να ενημερώσετε υπάρχοντα δεδομένα εντολών.

  • Διαθέσιμα πεδία
  • Εξαγάγετε τη λίστα παραγγελιών
  • Εξαγωγή δεδομένων παραγγελίας
  • Προσθήκη παραγγελίας
  • Αλλαγή δεδομένων παραγγελίας
  • Επεξεργασία παραγγελίας
    • Αλλαγή κατάστασης παράδοσης (παραγγελία σε διαδικασία)
    • Αλλαγή κατάστασης παράδοσης (αποστολή παραγγελίας)
    • Αλλαγή κατάστασης παράδοσης (παραγγελία παραδόθηκε)
    • Αλλαγή κατάστασης παράδοσης (επιστροφή παραγγελίας)
    • Ακύρωση παραγγελίας
    • Εκδώστε το τιμολόγιο
  • Διαγραφή εντολής

Διαθέσιμα πεδία

Η παρακάτω λίστα δείχνει όλα τα διαθέσιμα πεδία για αυτό το API, τα οποία επιστρέφονται όταν εξαγάγετε μια μεμονωμένη λίστα ή πόρο, οι οποίοι μπορούν να τροποποιηθούν, οι οποίοι είναι υποχρεωτικοί κατά τη δημιουργία ενός νέου πόρου ή την ενημέρωση ενός υπάρχοντος πόρου.

Κωδικός Περιγραφής Υπόδειξη

Περιγραφή

Ναι/Όχι

Μεταβλητός

αναγνωριστικό

σειρά

Αριθμός Παραγγελίας

 

γονέα_id

int

Το γονικό αναγνωριστικό παραγγελίας για παραγγελίες που έχουν χωριστεί

 

return_source_id

int

Το αρχικό αναγνωριστικό παραγγελίας για παραγγελίες που έχουν επιστραφεί

 

rma_order

πίνακας

Λίστα παραγγελιών που επιστράφηκαν από την αρχική παραγγελία

 

 

rma_orders.id

int

Αναγνωριστικό παραγγελίας επιστροφής

 

 

rma_orders.type

σειρά

Τύπος επιστροφής

 

 

όνομα_καναλιού

σειρά

Το όνομα του καναλιού πωλήσεων από το οποίο ελήφθη η παραγγελία

 

channel_ref_id

σειρά

Εξωτερικό αναγνωριστικό εντολών

 

κατάσταση πληρωμής

σειρά

Status-ul de plata. Valori posibile: προσωρινό, αναμονή, πληρωμή, αποτυχία, ακύρωση, επιστροφή χρημάτων, απόρριψη

πληρωμή_κατάσταση_κείμενο

σειρά

Αναπαράσταση κειμένου της κατάστασης πληρωμής

 

Payment_substatus_id

int

Αναγνωριστικό υποσταθμού πληρωμής

πληρωμή_substatus_text

σειρά

Αναπαράσταση κειμένου του υποστατικού πληρωμής

 

Payment_method_code

σειρά

Κωδικός τρόπου πληρωμής. Πιθανές τιμές (ανάλογα με τις ενεργές μεθόδους): librapay, paypal, skrill, 2checkout, epayment, euplatesc, cash_delivery, wire, in_store, mobilpay, nestpay, plationlinepo5, brd_finance, sofort, tbi, paypal_plus, libracredit, ipay

Πληρωμή_μέθοδο_ όνομα

σειρά

Όνομα του τρόπου πληρωμής

 

Payment_transaction_id

σειρά

Αναγνωριστικό αναφοράς πληρωμής

 

Κατάσταση αποστολής

σειρά

Status-ul de livrare. Valori posibile: αναμονή, επιβεβαίωση, σε διαδικασία, αποστολή, παράδοση, επιστροφή, ακύρωση

shipping_status_text

σειρά

Αναπαράσταση κειμένου της κατάστασης παράδοσης

 

shipping_substatus_id

int

Αναγνωριστικό κατάστασης παράδοσης

text_substatus_text

σειρά

Αναπαράσταση κειμένου του υποστατικού παράδοσης

 

shipping_method_id

σειρά

Το εσωτερικό αναγνωριστικό της μεθόδου παράδοσης

shipping_method_name

σειρά

Όνομα της μεθόδου παράδοσης

 

shipping_delivery_info

πίνακας

Λεπτομέρειες παράδοσης

 

 

shipping_delivery_info.delivery_time

σειρά

Ωρα παράδοσης

 

 

shipping_delivery_info.pickup_address

πίνακας

Πληροφορίες διεύθυνσης παράδοσης

 

pickup_address.id

int

Αναγνωριστικό σημείου παραλαβής παραγγελίας (ντουλάπι, easybox, γραφείο)

 

pickup_address.name

σειρά

Όνομα διεύθυνσης παράδοσης

 

shipping_carrier_id

σειρά

Το αναγνωριστικό courier που χρησιμοποιήθηκε για την παράδοση

 

shipping_awb

σειρά

Κωδικός AWB από το σύστημα ταχυμεταφορών

ποσό αποστολής

φλοτέρ

Κόστος παράδοσης

αριθμός αποστολής_ταξ

φλοτέρ

Το ποσό του φόρου από το κόστος παράδοσης

 

συνολικό ποσό

φλοτέρ

Συνολική αξία παραγγελίας

 

νόμισμα

σειρά

Σχετικό νόμισμα (ISO 4217)

 

original_currency

σειρά

Νόμισμα στο οποίο υποβλήθηκε η παραγγελία, εάν η παραγγελία πραγματοποιήθηκε σε νόμισμα διαφορετικό από το προεπιλεγμένο νόμισμα (ISO 4217)

 

ισοτιμία νομίσματος

φλοτέρ

Συναλλαγματική ισοτιμία για το νόμισμα στο οποίο έγινε η παραγγελία

 

Κωδικός κουπονιού

σειρά

Χρησιμοποιήθηκε κωδικός κουπονιού

 

Κωδικός πελάτη

int

Κωδικός πελάτη

email_ πελάτη

int

Η διεύθυνση email του πελάτη

customer_ip_address

σειρά

Η διεύθυνση IP από την οποία τοποθετήθηκε η εντολή

 

customer_ip_country

σειρά

Η χώρα που αντιστοιχεί στην IP από την οποία έγινε η παραγγελία

 

συσκευή_ πελάτη

σειρά

Τύπος συσκευής που χρησιμοποιείται κατά την παραγγελία (επιτραπέζιος υπολογιστής, κινητό)

πελάτης_γλώσσα

σειρά

Επιλογή γλώσσας κατά την υποβολή της παραγγελίας

σημείωση_ πελάτη

σειρά

Σχόλια πελατών

ειδοποίηση_ πελάτη

σειρά

Αναφορές του διαχειριστή στον πελάτη

Ημερομηνία Δημιουργίας

ημερομηνία

Ημερομηνία προσθήκης της παραγγελίας (μορφή ISO 8601)

 

ημερομηνία_ τροποποιήθηκε

ημερομηνία

Ημερομηνία τελευταίας τροποποίησης (μορφή ISO 8601)

 

Ημερομηνία Αποστολής

ημερομηνία

Ημερομηνία παράδοσης της παραγγελίας (μορφή ISO 8601)

 

date_delivered

ημερομηνία

Ημερομηνία παραλαβής της παραγγελίας από τον πελάτη (μορφή ISO 8601)

 

δημιουργήθηκε από

σειρά

Ο τύπος χρήστη που δημιούργησε την παραγγελία (λογαριασμός, χρήστης)

meta_fields

αντικείμενο

Πρόσθετα πεδία

εσωτερικές σημειώσεις

πίνακας

Λίστα εσωτερικών σημειώσεων

internal_notes []. αναγνωριστικό

int

Αναγνωριστικό σημείωσης

 

εσωτερικές σημειώσεις []. κείμενο

int

Το κείμενο της σημείωσης

ετικέτες

πίνακας

Παραγγελία ετικετών

ετικέτες []. id

int

Αναγνωριστικό ετικέτας

 

ετικέτες [] όνομα

int

Όνομα ετικέτας

τύπος τιμολόγησης

σειρά

Τύπος λογαριασμού, φυσικό ή νομικό πρόσωπο (άτομο, εταιρεία)

όνομα χρέωσης

σειρά

Ονομα πελάτη

billing_identity_number

σειρά

Προσωπικός αριθμητικός κωδικός (σε περίπτωση μεμονωμένων πελατών)

billing_company_name

σειρά

Επωνυμία εταιρείας (σε περίπτωση νομικών προσώπων)

billing_company_number

σειρά

Αριθμός εγγραφής (σε περίπτωση πελατών νομικών προσώπων)

billing_company_vat

σειρά

Δημοσιονομικός κώδικας (σε περίπτωση νομικών προσώπων πελατών)

billing_company_bank_name

σειρά

Όνομα τράπεζας (στην περίπτωση εταιρικών πελατών)

billing_company_bank_account

σειρά

Τραπεζικός λογαριασμός (σε περίπτωση νομικών προσώπων πελατών)

billing_country_code

σειρά

Κωδικός χώρας δεδομένων χρέωσης (ISO 3166-1 alpha-2)

billing_country_name

σειρά

Όνομα χώρας για δεδομένα χρέωσης

χρέωση_αρχείου

σειρά

Νομός ή πολιτεία που σχετίζεται με δεδομένα χρέωσης

χρέωση_ πόλης

σειρά

Πόλη δεδομένων χρέωσης

διεύθυνση χρέωσης

σειρά

Διεύθυνση δεδομένων χρέωσης

billing_postal_code

σειρά

Ταχυδρομικός κώδικας για πληροφορίες χρέωσης

billing_phone

σειρά

Αριθμός τηλεφώνου για πληροφορίες χρέωσης

όνομα_ αποστολής

σειρά

Το άτομο που έχει οριστεί να λάβει την παραγγελία

αποστολής_country_code

σειρά

Κωδικός χώρας για δεδομένα παράδοσης (ISO 3166-1 alpha-2)

όνομα_ αποστολής

σειρά

Όνομα χώρας για τις ημερομηνίες παράδοσης

ναυτιλιακός σταθμός

σειρά

Δεδομένα κομητείας ή κατάστασης παράδοσης

ναυτιλιακή πόλη

σειρά

Πόλη ημερομηνιών παράδοσης

διεύθυνση αποστολής

σειρά

Διεύθυνση δεδομένων παράδοσης

shipping_postal_code

σειρά

Ταχυδρομικός κώδικας για τις ημερομηνίες παράδοσης

Shipping_phone

σειρά

Αριθμός τηλεφώνου αριθμού παράδοσης

αντικείμενα γραμμής

πίνακας

Λίστα παραγγελιών προϊόντων

 

ΥΠΟΔΕΙΞΗ
Τυχόν επιστρεφόμενα και χωρίς έγγραφα πεδία μπορούν να αγνοηθούν επειδή δεν είναι ακόμη διαθέσιμα.

Εξαγάγετε τη λίστα παραγγελιών

Εμφανίζει τη φιλτραρισμένη λίστα εγγραφών.

Τύπος : Λίστα πόρων
ρήμα : GET
Διεύθυνση URL : /api/v2/orders
Αποτελέσματα φίλτρου : Ναι
Επιλογή πεδίου : Ναι
Συμπερίληψη επιπλέον πεδίων : Ναι
Σελίδα : Ναι

Ο κωδικός http απόκρισης είναι 200επιτυχής, η απόκριση θα έχει τη μορφή μιας λίστας πόρων που σχετίζονται με τα καθορισμένα φίλτρα.

Μόνο τα πεδία λίστας θα συμπεριληφθούν στο τυπικό αποτέλεσμα. Μπορείτε να συμπεριλάβετε επιπλέον πεδία που δεν περιλαμβάνονται από προεπιλογή χρησιμοποιώντας την παράμετρο includeκαι αναφέρετε ρητά μόνο τα πρόσθετα πεδία (διαχωρισμένα με κόμματα) που θέλετε να συμπεριληφθούν.

GET /api/v2/orders?include=line_items

Μπορείτε να φιλτράρετε τα πεδία που θέλετε να συμπεριληφθούν στο αποτέλεσμα για κάθε πόρο χρησιμοποιώντας την παράμετρο fieldsκαι αναφέροντας ρητά μόνο τα πεδία (διαχωρισμένα με κόμματα) που θέλετε να συμπεριληφθούν (το πεδίο idθα περιλαμβάνεται πάντα από προεπιλογή).

GET /api/v2/orders?fields=id,payment_status,shipping_status,total_amount

Φιλτράρισμα αποτελεσμάτων

Είναι δυνατό να φιλτράρετε τα αποτελέσματα προσθέτοντας συγκεκριμένες παραμέτρους στη διεύθυνση URL.

Παράμετρος

Περιγραφή

Παράδειγμα

ταυτότητα

Αριθμός Παραγγελίας

id = 101

αναγνωριστικά

Λίστα αναγνωριστικών εντολών διαχωρισμένων με κόμματα

ids = 12345001,12345002,12345003

κατάσταση πληρωμής

Κατάσταση πληρωμής

Payment_status = αναμονή

Payment_substatus_id

Αναγνωριστικό υποσταθμού πληρωμής

Payment_substatus_id = 11

Payment_method_code

Κωδικός τρόπου πληρωμής

Payment_method_code = cash_delivery

Payment_transaction_id

Αναγνωριστικό αναφοράς πληρωμής

Payment_transaction_id = VADE0B248932

Κατάσταση αποστολής

Κατάσταση παράδοσης

shipping_status = αναμονή

shipping_substatus_id

Αναγνωριστικό κατάστασης παράδοσης

shipping_substatus_id = 21

shipping_method_id

Αναγνωριστικό μεθόδου παράδοσης

shipping_method_id = 101

shipping_awb

Κωδικός AWB από το σύστημα ταχυμεταφορών

shipping_awb = 12312345675

Κωδικός πελάτη

Κωδικός πελάτη

customer_id = 12345

email_ πελάτη

Η διεύθυνση email του πελάτη

customer_email=john.smith@example.com

δημιουργήθηκε μετά

Ημερομηνία δημιουργίας των εγγραφών (μορφή ISO 8601)

create_after = 2019-01-01

δημιουργήθηκε πριν

Ημερομηνία έως την οποία δημιουργήθηκαν οι εγγραφές (μορφή ISO 8601)

δημιουργήθηκε_πριν = 2020-01-01

tag_name

Όνομα ετικέτας

tag_name = τιμή

ετικέτες_ids

Λίστα ετικετών ταυτότητας διαχωρισμένα με κόμματα

tag_ids = 123,456

GET /api/v2/orders?ids=12345001,12345002,12345003

Ταξινόμηση αποτελεσμάτων

Είναι δυνατή η ταξινόμηση των αποτελεσμάτων προσθέτοντας συγκεκριμένες παραμέτρους στη διεύθυνση URL.

Παράμετρος

Περιγραφή

Παράδειγμα

Ημερομηνία Δημιουργίας

Ημερομηνία προσθήκης της αύξουσας σειράς

ταξινόμηση = ημερομηνία_δημιουργήθηκε

date_created.desc

Ημερομηνία προσθήκης της φθίνουσας σειράς

sort = date_created.desc

GET /api/v2/orders?sort=date_created

Σελιδοποίηση

Οι παράμετροι σελιδοποίησης μπορούν να προστεθούν στο αίτημα API για περιορισμό του αριθμού καταχωρήσεων ανά σελίδα και πρόσβαση σε όλες τις διαθέσιμες σελίδες.

Παράμετρος

Υπόδειξη

Προκαθορισμένο

αρχή

int

0

όριο

int

100

Το μέγιστο όριο εγγραφής ανά σελίδα δεν μπορεί να υπερβαίνει τα 100.

GET /api/v2/orders?start=100&limit=100

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL που εξάγει όλες τις εγγραφές:

curl --request GET \
--url 'https://shop.demo.ro/api/v2/orders' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}'

Φιλτράρετε τις εγγραφές με βάση την κατάσταση παράδοσης, εξαγάγετε όλα τα πεδία

Παράδειγμα αιτήματος

GET /api/v2/orders?shipping_status=awaiting

Παράδειγμα απάντησης

{
  "data": [  
    {
        "id": 11089919,
        "payment_status": "awaiting",
        "payment_status_text": "Plata in asteptare",
        "payment_method_code": "cash_delivery",
        "payment_method_name": "Plata in sistem ramburs",
        "shipping_status": "awaiting",
        "shipping_status_text": "Comanda in asteptare",
        "shipping_method_id": 3,
        "shipping_method_name": "Speedy",
        "shipping_amount": 15,
        "shipping_tax_amount": 2.39,
        "total_amount": 30.23,
        "currency": "RON",
        "customer_id": 14,
        "customer_email": "john.smith@yahoo.com",
        "customer_ip_address": "166.176.119.218",
        "customer_ip_country": "RO",
        "customer_device": "desktop",
        "customer_lang": "ro_RO",
        "customer_note": null,
        "customer_notification": null,
        "date_created": "2019-12-05T16:11:23+02:00",
        "date_modified": "2019-12-05T16:11:23+02:00",
        "created_by": "customer",
        "meta_fields": null,
        "tags": null,
        "billing_type": "individual",
        "billing_name": "John Smith",
        "billing_company_name": null,
        "billing_company_number": null,
        "billing_company_vat": null,
        "billing_company_bank_name": null,
        "billing_company_bank_account": null,
        "billing_country_code": "RO",
        "billing_country_name": "România",
        "billing_state": "Bucuresti",
        "billing_city": "Bucuresti",
        "billing_address": "str Rose Hill, nr. 45",
        "billing_postal_code": "100167",
        "billing_phone": "0722356158",
        "shipping_name": "John Smith",
        "shipping_country_code": "RO",
        "shipping_country_name": "România",
        "shipping_state": "Bucuresti",
        "shipping_city": "Bucuresti",
        "shipping_address": "str Rose Hill, nr. 45",
        "shipping_postal_code": "100167",
        "shipping_phone": "0722356158",
        "invoice": null,
        "info_url": "https://shop.demo.ro/comanda/info/33a818fcb3a13aa5b70e3a9e1475bfc0/11089919",
        "proforma_url": "https://shop.demo.ro/comanda/proforma/33a818fcb3a13aa5b70e3a9e1475bfc0/11089919"
    }  
  ],
  "meta": {
    "count": {
      "total": 1,
      "current": 1,
      "start": 0,
      "limit": 100
    },
    "links": {
      "prev": null,
      "current": "/api/v2/orders?shipping_status=awaiting",
      "next": null
    }
  }
}

Φιλτράρετε εγγραφές βάσει λίστας αναγνωριστικών, φιλτράρετε μόνο συγκεκριμένα πεδία

Παράδειγμα αιτήματος

GET /api/v2/orders?ids=12345001,12345002,12345003&fields=id,payment_status,payment_method_code,total_amount

Παράδειγμα απάντησης

{
  "data": [
    {
      "id": 12345001,
      "payment_status": "awaiting",
      "payment_method_code": "cash_delivery",
      "total_amount": 999.95
    },
    {
      "id": 12345002,
      "payment_status": "paid",
      "payment_method_code": "paypal",
      "total_amount": 199.99
    },
    {
      "id": 12345003,
      "payment_status": "cancelled",
      "payment_method_code": "cash_delivery",
      "total_amount": 599.97
    }
  ],
  "meta": {
    "count": {
      "total": 3,
      "current": 3,
      "start": 0,
      "limit": 100
    },
    "links": {
      "prev": null,
      "current": "/api/v2/orders?ids=12345001,12345002,12345003&fields=id,payment_status,payment_method_code,total_amount",
      "next": null
    }
  }
}

Φίλτρα εγγραφών με βάση την κατάσταση παράδοσης, περιλαμβάνει επιπλέον πεδία

Παράδειγμα αιτήματος

GET /api/v2/orders?shipping_status=awaiting&include=line_items

Παράδειγμα απάντησης

{
  "data": [
         {
            "id": 64098294,
            "payment_status": "awaiting",
            "payment_status_text": "Plata in asteptare",
            "payment_method_code": "cash_delivery",
            "payment_method_name": "Plata in sistem ramburs",
            "shipping_status": "awaiting",
            "shipping_status_text": "Comanda in asteptare",
            "shipping_method_id": 3,
            "shipping_method_name": "Speedy",
            "shipping_amount": 161.16,
            "shipping_tax_amount": 25.73,
            "total_amount": 526.55,
            "currency": "RON",
            "customer_id": 19,
            "customer_email": "john.smith@yahoo.com",
            "customer_ip_address": "143.20.218.217",
            "customer_ip_country": "ro",
            "customer_device": "desktop",
            "customer_lang": "ro_RO",
            "customer_note": null,
            "customer_notification": null,
            "date_created": "2020-03-26T15:47:08+02:00",
            "date_modified": "2020-03-26T15:47:08+02:00",
            "created_by": "customer",
            "meta_fields": null,
            "tags": null,
            "billing_type": "individual",
            "billing_name": "John Smith",
            "billing_company_name": null,
            "billing_company_number": null,
            "billing_company_vat": null,
            "billing_company_bank_name": null,
            "billing_company_bank_account": null,
            "billing_country_code": "RO",
            "billing_country_name": "România",
            "billing_state": "Bucuresti",
            "billing_city": "Bucuresti",
            "billing_address": "str Rose Hill, nr. 45",
            "billing_postal_code": "1221421",
            "billing_phone": "0722654983",
            "shipping_name": "John Smith",
            "shipping_country_code": "RO",
            "shipping_country_name": "România",
            "shipping_state": "Bucuresti",
            "shipping_city": "Bucuresti",
            "shipping_address": "str Rose Hill, nr. 45",
            "shipping_postal_code": "1221421",
            "shipping_phone": "0722654983",
            "line_items": [
                {
                    "item_type": "product",
                    "product_id": 1958,
                    "variant_name": "Culoare: alb",
                    "variant_options": [
                        {
                            "id": 1,
                            "name": "Culoare",
                            "value": "alb"
                        },
                    ],
                    "product_sku": "3484",
                    "product_ean": "7562461441110",
                    "product_name": "Massive Menelaus 37511/48/10",
                    "product_url": "https://shop.demo.ro/cumpara?id=1958",
                    "product_image_url": "https://shop.demo.ro/files/s11/204992628/p/l/7/massive-menelaus-37511-48-10-lustra~1057.jpg",
                    "product_tax_name": "TVA",
                    "product_tax_percent": 19,
                    "category_id": 2,
                    "category_name": "Lustre",
                    "manufacturer_id": 0,
                    "quantity": 1,
                    "unit_price_net": 307.05,
                    "unit_tax_amount": 58.34,
                    "unit_price_gross": 365.39,
                    "line_subtotal_net": 307.05,
                    "line_tax_amount": 58.34,
                    "line_subtotal_gross": 365.39,
                }
            ],
            "invoice": null,
            "info_url": "https://shop.demo.ro/comanda/info/6c1d81789f477768caad874aafc24936/64098294",
            "proforma_url": "https://shop.demo.ro/comanda/proforma/6c1d81789f477768caad874aafc24936/64098294"
        }
  ],
  "meta": {
    "count": {
      "total": 1,
      "current": 1,
      "start": 0,
      "limit": 100
    },
    "links": {
      "prev": null,
      "current": "/api/v2/orders?shipping_status=awaiting&include=line_items",
      "next": null
    }
  }
}

Εξαγωγή δεδομένων παραγγελίας

Εμφανίζει τα δεδομένα μιας μεμονωμένης εγγραφής.

Τύπος : Ατομικός πόρος
ρήμα : GET
Διεύθυνση URL : /api/v2/orders/{id}
Αποτελέσματα φίλτρου : Όχι
Επιλογή πεδίου : Ναι
Συμπερίληψη επιπλέον πεδίων : Όχι
Σελίδα : Όχι

Ο κωδικός απόκρισης http είναι 200σε περίπτωση επιτυχίας, η απάντηση θα έχει τη μορφή ενός μεμονωμένου πόρου που σχετίζεται με το αναγνωριστικό που ζητήσατε.

Μπορείτε να φιλτράρετε τα πεδία που θέλετε να συμπεριληφθούν στο αποτέλεσμα για κάθε πόρο χρησιμοποιώντας την παράμετρο fieldsκαι αναφέροντας ρητά μόνο τα πεδία (διαχωρισμένα με κόμματα) που θέλετε να συμπεριληφθούν (το πεδίο id θα συμπεριλαμβάνεται πάντα από προεπιλογή).

GET /api/v2/orders/{id}?fields=id,total_amount,line_items

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL που επιστρέφει μια μεμονωμένη εγγραφή:

curl --request GET \
--url 'https://shop.demo.ro/api/v2/orders/12345001' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}'

Εξαγωγή όλων των πεδίων

Παράδειγμα αιτήματος

GET /api/v2/orders/{id}

Παράδειγμα απάντησης

{
  "id": 12345001,
  "parent_id": 39787708,
  "payment_status": "awaiting",
  "payment_status_text": "Plata in asteptare",
  "payment_method_code": "cash_delivery",
  "payment_method_name": "Plata in sistem ramburs",
  "shipping_status": "awaiting",
  "shipping_status_text": "Comanda in asteptare",
  "shipping_method_id": 0,
  "shipping_method_name": null,
  "shipping_amount": null,
  "shipping_tax_amount": null,
  "total_amount": 453.05,
  "currency": "RON",
  "customer_id": 2,
  "customer_email": "dfdfddddf@exemple.com",
  "customer_ip_address": "",
  "customer_ip_country": "",
  "customer_device": "manual",
  "customer_lang": "ro_RO",
  "customer_note": null,
  "customer_notification": null,
  "date_created": "2020-03-25T07:42:28+02:00",
  "date_modified": "2020-03-25T07:42:28+02:00",
  "created_by": "account",
  "meta_fields": null,
  "tags": null,
  "billing_type": "individual",
  "billing_name": "John Smith",
  "billing_company_name": null,
  "billing_company_number": null,
  "billing_company_vat": null,
  "billing_company_bank_name": null,
  "billing_company_bank_account": null,
  "billing_country_code": "RO",
  "billing_country_name": "România",
  "billing_state": "Bacau",
  "billing_city": "bacau",
  "billing_address": "",
  "billing_postal_code": "",
  "billing_phone": "",
  "shipping_name": "John Smith",
  "shipping_country_code": "RO",
  "shipping_country_name": "România",
  "shipping_state": "Bacau",
  "shipping_city": "bacau",
  "shipping_address": "",
  "shipping_postal_code": "",
  "shipping_phone": "",
  "line_items": [
    {
      "item_type": "product",
      "product_id": 259,
      "product_sku": null,
      "product_ean": null,
      "product_name": "Giuseppe Zanotti Women's Swarovski Sandal",
      "product_url": "https://shop.demo.ro/cumpara?id=259",
      "product_image_url": "https://s.cdnmpro.com/272414248/p/l/7/giuseppe-zanotti-women-s-swarovski-sandal~27.jpg",
      "product_tax_name": "TVA",
      "product_tax_percent": 19,
      "category_id": 18,
      "category_name": "Sandale",
      "manufacturer_id": 1000050,
      "manufacturer_name": "Giuseppe-Zanotti",
      "quantity": 1,
      "unit_price_net": 184.03,
      "unit_tax_amount": 34.96,
      "unit_price_gross": 218.99,
      "line_subtotal_net": 184.03,
      "line_tax_amount": 34.96,
      "line_subtotal_gross": 218.99
    },
    {
      "item_type": "product",
      "product_id": 260,
      "product_sku": null,
      "product_ean": null,
      "product_name": "Women's Nunaked Dress Sandal",
      "product_url": "https://shop.demo.ro/cumpara?id=260",
      "product_image_url": "https://s.cdnmpro.com/272414248/p/l/9/women-s-nunaked-dress-sandal~29.jpg",
      "product_tax_name": "TVA",
      "product_tax_percent": 19,
      "category_id": 18,
      "category_name": "Sandale",
      "manufacturer_id": 1000061,
      "manufacturer_name": "Joop",
      "quantity": 2,
      "unit_price_net": 98.34,
      "unit_tax_amount": 18.69,
      "unit_price_gross": 117.03,
      "line_subtotal_net": 196.68,
      "line_tax_amount": 37.38,
      "line_subtotal_gross": 234.06
    }
  ],
  "invoice": {
    "prefix": "SERIE",
    "number": "0000010",
    "app": "billing",
    "cancelled": false,
    "url": "https://shop.demo.ro/comanda/invoice/2e8b8a4802eb3b5d1c8f381b2c20a0ea/52527708"
  },
  "info_url": "https://shop.demo.ro/comanda/info/557d2803bc4caee040329d1de5d2754f/12345001",
  "proforma_url": "https://shop.demo.ro/comanda/proforma/557d2803bc4caee040329d1de5d2754f/12345001"
}

Φιλτράρετε μόνο ορισμένα πεδία

Παράδειγμα αιτήματος

GET /api/v2/orders/{id}?fields=id,payment_status,shipping_status,total_amount

Παράδειγμα απάντησης

{
  "data": [
    {
      "id": 12345001,
      "payment_status": "awaiting",
      "shipping_status": "awaiting",
      "total_amount": 453.05
    },
    {
      "id": 39787708,
      "payment_status": "cancelled",
      "shipping_status": "cancelled",
      "total_amount": 1712.05
    },
    {
      "id": 46706210,
      "payment_status": "failed",
      "shipping_status": "awaiting",
      "total_amount": 1799
    },
    {
      "id": 53824910,
      "payment_status": "awaiting",
      "shipping_status": "shipped",
      "total_amount": 467.99
    },
    {
      "id": 67716435,
      "payment_status": "paid",
      "shipping_status": "in_process",
      "total_amount": 1719
    },
    {
      "id": 73000828,
      "payment_status": "awaiting",
      "shipping_status": "awaiting",
      "total_amount": 1900
    },
    {
      "id": 93950143,
      "payment_status": "paid",
      "shipping_status": "delivered",
      "total_amount": 503.99
    }
  ],
  "meta": {
    "count": {
      "total": 7,
      "current": 7,
      "start": 0,
      "limit": 20
    },
    "links": {
    "prev": null,
    "current": "/api/v2/orders?fields=id,payment_status,shipping_status,total_amount",
    "next": null
    }
  }
}

Προσθήκη παραγγελίας

Σας επιτρέπει να προσθέσετε μια νέα εγγραφή.

Τύπος : Δυναμικού Δημιουργία
ρήμα : POST
Url :/api/v2/orders

Ο κωδικός http απόκρισης είναι 200επιτυχής, η απόκριση θα έχει τη μορφή ενός μεμονωμένου πόρου που θα αντιπροσωπεύει την εγγραφή που μόλις προστέθηκε.

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL που δημιουργεί μια νέα εντολή:

curl --request POST \
--url 'https://shop.demo.ro/api/v2/orders' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}' \
--data-raw '{
    "payment_status": "awaiting",
    "payment_method_code": "cash_delivery",
    "shipping_status": "awaiting",
    "shipping_method_id": 0,
    "shipping_amount": null,
    "customer_id": 17,
    "customer_email": "sdsdsdsdsdsdsd@example.com",
    "billing_type": "individual",
    "billing_name": "John Smith",
    "billing_country_code": "RO",
    "billing_country_name": "România",
    "shipping_name": "John Smith",
    "shipping_country_code": "RO",
    "shipping_country_name": "Romania",
    "shipping_state": "Bucuresti",
    "shipping_city": "Bucuresti",
    "line_items": [
        {
            "item_type": "product",
            "product_id": 5087,
            "variant_id": 10004461,
            "variant_name": "Size: 39",
            "variant_options": [
                {
                    "id": 27884,
                    "name": "Size",
                    "value": "39"
                }
            ],
            "family_sku": "V01 nude pu",
            "product_sku": "V01 nude pu 39",
            "product_ean": null,
            "product_name": "Shoes Inko Nude 2",
            "product_url": "https://shop.demo.ro/cumpara?id=5087",
            "product_image_url": "https://shm-cdn.v1.ro/199135886/p/l/7/pantofi-inko-nude-2~4987.jpg",
            "product_tax_name": "TVA",
            "product_tax_percent": 19,
            "category_id": 6,
            "category_name": "Shoes",
            "manufacturer_id": 0,
            "quantity": 1,
            "unit_price_net": 91.6,
            "unit_tax_amount": 17.4,
            "unit_price_gross": 109,
            "line_subtotal_net": 91.6,
            "line_tax_amount": 17.4,
            "line_subtotal_gross": 109,
            "meta_fields": {
                "prod_id_ref": "7777060"
            }
        },
        {
            "item_type": "product",
            "product_id": 5088,
            "variant_id": 10002901,
            "variant_name": "Size: 35",
            "variant_options": [
                {
                    "id": 27884,
                    "name": "Size",
                    "value": "35"
                }
            ],
            "family_sku": "JA-1388-C BEIGE 2",
            "product_sku": "JA-1388-C BEIGE 2 35",
            "product_ean": null,
            "product_name": "Shoes Gabel Beige 2",
            "product_url": "https://shop.demo.ro/cumpara?id=5088",
            "product_image_url": "https://shm-cdn.v1.ro/199135886/p/l/8/pantofi-gabel-bej-2~4988.jpg",
            "product_tax_name": "TVA",
            "product_tax_percent": 19,
            "category_id": 6,
            "category_name": "Shoes",
            "manufacturer_id": 0,
            "quantity": 1,
            "unit_price_net": 57.98,
            "unit_tax_amount": 11.02,
            "unit_price_gross": 69,
            "line_subtotal_net": 57.98,
            "line_tax_amount": 11.02,
            "line_subtotal_gross": 69,
            "meta_fields": {
                "prod_id_ref": "7777061"
            }
        }
    ]
}'

Προσθήκη παραγγελίας

Παράδειγμα αιτήματος

POST /api/v2/orders

{
    "payment_status": "awaiting",
    "payment_method_code": "cash_delivery",
    "shipping_status": "awaiting",
    "shipping_method_id": 0,
    "shipping_amount": null,
    "customer_id": 17,
    "customer_email": "sdsdsdsdsdsdsd@example.com",
    "billing_type": "individual",
    "billing_name": "John Smith",
    "billing_country_code": "RO",
    "billing_country_name": "România",
    "shipping_name": "John Smith",
    "shipping_country_code": "RO",
    "shipping_country_name": "Romania",
    "shipping_state": "Bucuresti",
    "shipping_city": "Bucuresti",
    "line_items": [
        {
            "item_type": "product",
            "product_id": 5087,
            "variant_id": 10004461,
            "variant_name": "Size: 39",
            "variant_options": [
                {
                    "id": 27884,
                    "name": "Size",
                    "value": "39"
                }
            ],
            "family_sku": "V01 nude pu",
            "product_sku": "V01 nude pu 39",
            "product_ean": null,
            "product_name": "Shoes Inko Nude 2",
            "product_url": "https://shop.demo.ro/cumpara?id=5087",
            "product_image_url": "https://shm-cdn.v1.ro/199135886/p/l/7/pantofi-inko-nude-2~4987.jpg",
            "product_tax_name": "TVA",
            "product_tax_percent": 19,
            "category_id": 6,
            "category_name": "Shoes",
            "manufacturer_id": 0,
            "quantity": 1,
            "unit_price_net": 91.6,
            "unit_tax_amount": 17.4,
            "unit_price_gross": 109,
            "line_subtotal_net": 91.6,
            "line_tax_amount": 17.4,
            "line_subtotal_gross": 109,
            "meta_fields": {
                "prod_id_ref": "7777060"
            }
        },
        {
            "item_type": "product",
            "product_id": 5088,
            "variant_id": 10002901,
            "variant_name": "Size: 35",
            "variant_options": [
                {
                    "id": 27884,
                    "name": "Size",
                    "value": "35"
                }
            ],
            "family_sku": "JA-1388-C BEIGE 2",
            "product_sku": "JA-1388-C BEIGE 2 35",
            "product_ean": null,
            "product_name": "Shoes Gabel Beige 2",
            "product_url": "https://shop.demo.ro/cumpara?id=5088",
            "product_image_url": "https://shm-cdn.v1.ro/199135886/p/l/8/pantofi-gabel-bej-2~4988.jpg",
            "product_tax_name": "TVA",
            "product_tax_percent": 19,
            "category_id": 6,
            "category_name": "Shoes",
            "manufacturer_id": 0,
            "quantity": 1,
            "unit_price_net": 57.98,
            "unit_tax_amount": 11.02,
            "unit_price_gross": 69,
            "line_subtotal_net": 57.98,
            "line_tax_amount": 11.02,
            "line_subtotal_gross": 69,
            "meta_fields": {
                "prod_id_ref": "7777061"
            }
        }
    ]
}

Παράδειγμα απάντησης

{
    "id": 69291306,
    "payment_status": "awaiting",
    "payment_status_text": "Plata in asteptare",
    "payment_method_code": "cash_delivery",
    "payment_method_name": "Plata in sistem ramburs",
    "shipping_status": "awaiting",
    "shipping_status_text": "Comanda in asteptare",
    "shipping_method_id": 0,
    "shipping_method_name": null,
    "shipping_amount": null,
    "shipping_tax_amount": null,
    "total_amount": 178,
    "currency": "RON",
    "customer_id": 17,
    "customer_email": "sdsdsdsdsdsdsd@example.com",
    "customer_ip_address": "",
    "customer_ip_country": "",
    "customer_device": "desktop",
    "customer_lang": null,
    "customer_note": null,
    "customer_notification": null,
    "date_created": "2020-05-05T10:04:54+03:00",
    "date_modified": "2020-05-05T10:04:54+03:00",
    "created_by": "customer",
    "meta_fields": null,
    "tags": null,
    "billing_type": "individual",
    "billing_name": "John Smith",
    "billing_company_name": null,
    "billing_company_number": null,
    "billing_company_vat": null,
    "billing_company_bank_name": null,
    "billing_company_bank_account": null,
    "billing_country_code": "RO",
    "billing_country_name": "România",
    "billing_state": "Bucuresti",
    "billing_city": "Bucuresti",
    "billing_address": "",
    "billing_postal_code": "1000",
    "billing_phone": "",
    "shipping_name": "John Smith",
    "shipping_country_code": "RO",
    "shipping_country_name": "România",
    "shipping_state": "Bucuresti",
    "shipping_city": "Bucuresti",
    "shipping_address": null,
    "shipping_postal_code": null,
    "shipping_phone": null,
    "line_items": [
        {
            "product_id": 5087,
            "variant_id": 10004461,
            "family_sku": "V01 nude pu",
            "product_sku": "V01 nude pu 39",
            "product_ean": null,
            "product_name": "Shoes Inko Nude 2",
            "product_url": "https://shop.demo.ro/cumpara?id=5087",
            "product_image_url": "https://shm-cdn.v1.ro/199135886/p/l/7/pantofi-inko-nude-2~4987.jpg",
            "product_tax_name": "TVA",
            "product_tax_percent": 19,
            "category_id": 6,
            "category_name": "Shoes",
            "manufacturer_id": 0,
            "quantity": 1,
            "unit_price_net": 91.6,
            "unit_tax_amount": 17.4,
            "unit_price_gross": 109,
            "line_subtotal_net": 91.6,
            "line_tax_amount": 17.4,
            "line_subtotal_gross": 109,
            "meta_fields": {
                "prod_id_ref": "7777060"
            }
        },
        {
            "product_id": 5088,
            "variant_id": 10002901,
            "family_sku": "JA-1388-C BEIGE 2",
            "product_sku": "JA-1388-C BEIGE 2 35",
            "product_ean": null,
            "product_name": "Shoes Gabel Beige 2",
            "product_url": "https://shop.demo.ro/cumpara?id=5088",
            "product_image_url": "https://shm-cdn.v1.ro/199135886/p/l/8/pantofi-gabel-bej-2~4988.jpg",
            "product_tax_name": "TVA",
            "product_tax_percent": 19,
            "category_id": 6,
            "category_name": "Shoes",
            "manufacturer_id": 0,
            "quantity": 1,
            "unit_price_net": 57.98,
            "unit_tax_amount": 11.02,
            "unit_price_gross": 69,
            "line_subtotal_net": 57.98,
            "line_tax_amount": 11.02,
            "line_subtotal_gross": 69,
            "meta_fields": {
                "prod_id_ref": "7777061"
            }
        }
    ],
    "invoice": null,
    "info_url": "https://shop.demo.ro/comanda/info/f3b941970c87ce44033586413c2dec92/69291306",
    "proforma_url": "https://shop.demo.ro/comanda/proforma/f3b941970c87ce44033586413c2dec92/69291306"
}

Αλλαγή δεδομένων παραγγελίας

Σας επιτρέπει να ενημερώσετε μια υπάρχουσα εγγραφή βάσει αναγνωριστικού.

Τύπος : Δυναμικού Ενημέρωση
ρήμα : PATCH
Url :/api/v2/orders/{id}

Ο κωδικός http απόκρισης είναι 200επιτυχής, η απόκριση θα έχει τη μορφή ενός μεμονωμένου πόρου που αντιπροσωπεύει την εγγραφή που μόλις ενημερώθηκε.

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL που ενημερώνει μια υπάρχουσα εγγραφή:

curl --request PATCH \
--url 'https://shop.demo.ro/api/v2/orders/12345001' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}' \
--data-raw '{
  "shipping_method_id": 101,
  "shipping_amount": 15
}'

Ενημέρωση δεδομένων παραγγελίας

Παράδειγμα αιτήματος

PATCH /api/v2/orders/{id}

{
  "shipping_method_id": 101,
  "shipping_amount": 15,
  "tags": [
    {
      "name": "Feedback excelent"
    }
  ]
}

Παράδειγμα απάντησης

{
  "id": 12345001,
  "parent_id": 61001305,
  "payment_status": "cancelled",
  "payment_status_text": "Plata anulata",
  "payment_method_code": "cash_delivery",
  "payment_method_name": "Plata in sistem ramburs",
  "shipping_status": "cancelled",
  "shipping_status_text": "Comanda anulata",
  "shipping_method_id": 101,
  "shipping_method_name": null,
  "shipping_amount": 15,
  "shipping_tax_amount": 0,
  "total_amount": 13394.85,
  "currency": "RON",
  "customer_id": 3,
  "customer_email": "234242424242@example.net",
  "customer_ip_address": "95.77.99.177",
  "customer_ip_country": "RO",
  "customer_device": "desktop",
  "customer_lang": "ro_RO",
  "customer_note": null,
  "customer_notification": "",
  "date_created": "2020-01-13T13:34:15+02:00",
  "date_modified": "2020-05-02T10:50:12+03:00",
  "created_by": "customer",
  "meta_fields": null,
  "tags": [
    {
      "id": 1,
      "name": "Feedback excelent"
    }
  ],
  "billing_type": "individual",
  "billing_name": "John Smith",
  "billing_company_name": null,
  "billing_company_number": null,
  "billing_company_vat": null,
  "billing_company_bank_name": null,
  "billing_company_bank_account": null,
  "billing_country_code": "RO",
  "billing_country_name": "România",
  "billing_state": "Bucuresti",
  "billing_city": "Bucuresti",
  "billing_address": "str Rose Hill, nr. 45",
  "billing_postal_code": "",
  "billing_phone": "0212112121",
  "shipping_name": "John Smith",
  "shipping_country_code": "RO",
  "shipping_country_name": "România",
  "shipping_state": "Bucuresti",
  "shipping_city": "Bucuresti",
  "shipping_address": "str Rose Hill, nr. 45",
  "shipping_postal_code": "",
  "shipping_phone": "0212112121",
  "line_items": [
    {
      "item_type": "product",
      "product_id": 53,
      "product_sku": null,
      "product_ean": null,
      "product_name": "Floral Laser Suede Dress",
      "product_url": "https://shop.demo.ro/cumpara?id=53",
      "product_image_url": "https://shm-cdn.v1.ro/283342624/p/l/9/floral-laser-suede-dress~169.jpg",
      "product_tax_name": "TVA",
      "product_tax_percent": 19,
      "category_id": 9,
      "category_name": "Rochii",
      "manufacturer_id": 1000017,
      "manufacturer_name": "Michael Kors",
      "quantity": 15,
      "unit_price_net": 891.99,
      "unit_tax_amount": 0,
      "unit_price_gross": 891.99,
      "line_subtotal_net": 13379.85,
      "line_tax_amount": 0,
      "line_subtotal_gross": 13379.85
    }
  ],
  "invoice": {
    "prefix": "SERIE",
    "number": "0000010",
    "app": "billing",
    "cancelled": false,
    "url": "https://shop.demo.ro/comanda/invoice/2e8b8a4802eb3b5d1c8f381b2c20a0ea/52527708"
  },
  "info_url": "https://shop.demo.ro/comanda/info/6962541174d3099d2dc6b0cd902d3601/12345001",
  "proforma_url": "https://shop.demo.ro/comanda/proforma/6962541174d3099d2dc6b0cd902d3601/12345001"
}

Επεξεργασία παραγγελίας

Επιτρέπει την επεξεργασία μιας υπάρχουσας εγγραφής βάσει ταυτότητας.

Τύπος : Δυναμικού Ενημέρωση
ρήμα : PATCH
Url :/api/v2/orders/{id}/{request_handler}

Ο κωδικός απόκρισης http είναι 200επιτυχής.

Αλλαγή κατάστασης παράδοσης (παραγγελία σε διαδικασία)

Παράδειγμα αιτήματος

PATCH /api/v2/orders/{id}/in_process

Παράδειγμα απάντησης

{
  "ok": true
}

Αλλαγή κατάστασης παράδοσης (αποστολή παραγγελίας)

Παράδειγμα αιτήματος

PATCH /api/v2/orders/{id}/shipped

Παράδειγμα απάντησης

{
  "ok": true
}

Αλλαγή κατάστασης παράδοσης (παραγγελία παραδόθηκε)

Παράδειγμα αιτήματος

PATCH /api/v2/orders/{id}/delivered

Παράδειγμα απάντησης

{
  "ok": true
}

Αλλαγή κατάστασης παράδοσης (επιστροφή παραγγελίας)

Παράδειγμα αιτήματος

PATCH /api/v2/orders/{id}/returned

Παράδειγμα απάντησης

{
  "ok": true
}

Ακύρωση παραγγελίας

Παράδειγμα αιτήματος

PATCH /api/v2/orders/{id}/cancelled

Παράδειγμα απάντησης

{
  "ok": true
}

Εκδώστε το τιμολόγιο

Παράδειγμα αιτήματος

PATCH /api/v2/orders/{id}/create_invoice

Παράδειγμα απάντησης

{
  "ok": true
}

Διαγραφή εντολής

Σας επιτρέπει να διαγράψετε μια υπάρχουσα εγγραφή βάσει αναγνωριστικού.

Τύπος : Διαγραφή πόρου
ρήμα : DELETE
Url :/api/v2/orders/{id}

Ο κωδικός απόκρισης http είναι 200σε περίπτωση επιτυχίας, η απάντηση θα λάβει τη μορφή ενός μεμονωμένου πόρου που θα αντιπροσωπεύει την εγγραφή που μόλις διαγράφηκε.

Αίτημα μορφοποίησης

Παράδειγμα αιτήματος CURL διαγραφής υπάρχουσας εγγραφής:

curl --request DELETE \
--url 'https://shop.demo.ro/api/v2/orders/12345001' \
--header 'Accept: application/json' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic {base64-encoded-credentials}'

Διαγράψτε την παραγγελία μαζί με όλα τα δεδομένα που σχετίζονται με αυτήν

Παράδειγμα αιτήματος

DELETE /api/v2/orders/{id}

Παράδειγμα απάντησης

{
  "ok": true
}
Τελευταία τροποποίηση: 30 Jun 2021
Ήταν χρήσιμη αυτή η σελίδα;
Χρειάζεστε ακόμα βοήθεια;