Ανάκτηση — Παραγγελίες

Διαβάστε δεδομένα από «Παραγγελίες». Το αποτέλεσμα εξαρτάται από τις παραμέτρους της ενέργειας.

GET`/api/v1/orders/{order_id}`

Έλεγχος ταυτότητας: Bearer
Διαθέσιμο από: BASIC
Απαιτούμενα δικαιώματα: orders.order:read

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

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/orders/example

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/orders/example');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/orders/example', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

Παράδειγμα απόκρισης 200

JSON

{
  "data": {
    "created_at": "2026-10-19T10:00:00Z",
    "customer": {
      "email": "customer@example.invalid",
      "first_name": "Example",
      "last_name": "Example",
      "phone": null
    },
    "delivery": {
      "amount": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "dates": {
        "dispatch_timezone": "Europe/Warsaw",
        "estimated_delivery_from": "2026-10-20",
        "estimated_delivery_to": "2026-10-21",
        "planned_dispatch_on": "2026-10-19"
      },
      "discount_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discounts": [
        {
          "amount": {
            "amount": "24.60",
            "currency": "PLN",
            "minor_units": 2
          },
          "campaign_id": "saved-coupon",
          "code": "SAVE",
          "kind": "coupon",
          "name": "Saved coupon",
          "sequence": 1,
          "version": 3
        }
      ],
      "gross": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "method_code": "shipping-old",
      "method_name": "Historic carrier",
      "net": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "pickup_point": null,
      "recipient_mode": "full_address",
      "tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_category_id": "standard",
      "tax_category_name": "VAT 23%",
      "tax_rate": "0.23"
    },
    "discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "discounts": [
      {
        "amount": {
          "amount": "12.30",
          "currency": "PLN",
          "minor_units": 2
        },
        "campaign_id": "saved-coupon",
        "code": "SAVE",
        "kind": "coupon",
        "name": "Saved coupon",
        "sequence": 1,
        "shipping_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "version": 3
      }
    ],
    "id": "order-0000",
    "invoice": null,
    "invoice_requested": false,
    "lifecycle_state": "placed",
    "lines": [
      {
        "discount_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [
          {
            "amount": {
              "amount": "12.30",
              "currency": "PLN",
              "minor_units": 2
            },
            "campaign_id": "saved-coupon",
            "code": "SAVE",
            "kind": "coupon",
            "name": "Saved coupon",
            "sequence": 1,
            "shipping_amount": null,
            "version": 3
          }
        ],
        "identifiers": {},
        "image": null,
        "line_id": "saved-line-a",
        "manual_discount": {
          "amount": {
            "amount": "12.30",
            "currency": "PLN",
            "minor_units": 2
          },
          "kind": "fixed",
          "value": "12.30"
        },
        "name": "Saved A",
        "original_total": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "200.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "46.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 1,
        "product_id": "product-api",
        "quantity": 2,
        "sku": "A",
        "tax": {
          "amount": "20.70",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax_category_id": "standard",
        "tax_category_name": "VAT 23%",
        "tax_rate": "0.23",
        "total": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "180.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "41.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "23.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      },
      {
        "discount_amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [],
        "identifiers": {},
        "image": null,
        "line_id": "b548a171-c331-505f-98f8-db3a06070998",
        "manual_discount": null,
        "name": "Saved B",
        "original_total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 2,
        "product_id": "deleted-product",
        "quantity": 1,
        "sku": "B",
        "tax": null,
        "tax_category_id": "reduced",
        "tax_category_name": "VAT 8%",
        "tax_rate": "0.08",
        "total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      }
    ],
    "locale": "pl",
    "market_id": "market-pl",
    "number": "0001",
    "payment": {
      "amount": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "environment": "live",
      "method_code": "payment-old",
      "method_name": "Historic method",
      "paid_at": null,
      "status": "unpaid",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 0
    },
    "pickup_point": null,
    "prices_include_tax": true,
    "shipping_address": null,
    "shipping_discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "status": {
      "id": "status-0",
      "name": "Status 0",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 1
    },
    "subtotal": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax": {
      "amount": "49.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax_breakdown": {
      "groups": [
        {
          "gross": {
            "amount": "221.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "180.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "41.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        },
        {
          "gross": {
            "amount": "108.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "100.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "8.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.08"
        },
        {
          "gross": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "shipping",
          "tax": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        }
      ],
      "unallocated_tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      }
    },
    "tax_country_code": "PL",
    "total": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "totals": {
      "before_discounts": {
        "gross": {
          "amount": "378.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "320.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "58.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "discounts": {
        "gross": {
          "amount": "49.20",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "40.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "9.20",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "order": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "product_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products_before_discounts": {
        "gross": {
          "amount": "354.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "300.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "54.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping": {
        "gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_before_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      }
    }
  },
  "meta": {
    "request_id": "example-request"
  }
}

Αρχές

Η συλλογή παρέχει συνόψεις παραγγελιών και φίλτρα για αριθμό, κατάσταση, κατάσταση πληρωμής και χρόνο δημιουργίας.
Η λίστα και οι λεπτομέρειες παραγγελιών περιλαμβάνουν delivery.dates. Οι ημερομηνίες YYYY-MM-DD είναι προγραμματισμένες και δεν επιβεβαιώνουν αποστολή. Οι τρέχουσες ημερομηνίες υπερισχύουν· οι παλιές παραγγελίες χρησιμοποιούν την αποθηκευμένη εκτίμηση. Διαγραμμένες ή άγνωστες τιμές είναι null. Οι λεπτομέρειες περιλαμβάνουν επίσης όλες τις γραμμές και εικόνες προϊόντων.

Λάβετε έγκυρα αναγνωριστικά κατάστασης από το /api/v1/order-statuses.
Η κατάσταση παραγγελίας και η κατάσταση πληρωμής χρησιμοποιούν ξεχωριστά σημεία πρόσβασης PATCH και δικαιώματα.
Η αλλαγή της καταγεγραμμένης κατάστασης πληρωμής δεν χρεώνει κάρτα ούτε εκτελεί επιστροφή μέσω παρόχου πληρωμών.

Ασφαλείς εγγραφές

Δικαιώματα και προγράμματα

Παραγγελία · Σύνολα

Τα ποσά και οι συντελεστές προέρχονται από την αποθηκευμένη παραγγελία, μαζί με τις διορθώσεις γραμμών. Τα άγνωστα ιστορικά στοιχεία είναι null και δεν αντικαθίστανται από τρέχοντες συντελεστές καταλόγου. Τα ποσά παραμένουν δεκαδικές συμβολοσειρές.

Η λίστα επιστρέφει συνόψεις. Ανακτήστε GET /api/v1/orders/{order_id} για κάθε αποτέλεσμα για πλήρη οικονομικά στοιχεία. Οι επαναλήψεις GET είναι περιορισμένες και τηρούν το Retry-After. Η εξαγωγή βάσει ημερομηνίας δημιουργίας δεν συγχρονίζει μεταγενέστερες διορθώσεις.

tax_country_code · Φορολογική χώρα · Αποθηκευμένα στοιχεία παραγγελίας · ISO 3166-1 alpha-2; null.
lines[].unit_* · Μία μονάδα · Πριν τις εκπτώσεις; lines[].original_total_* · Πριν τις εκπτώσεις; lines[].total_* · Μετά τις εκπτώσεις.
lines[].discount_* · Εκπτώσεις; manual_discount · Χειροκίνητη έκπτωση; percentage "10" = 10%.
delivery.net / tax / gross · Μετά τις εκπτώσεις; delivery.original_* · Πριν τις εκπτώσεις; delivery.discount_* · Εκπτώσεις.
tax_rate: "0.23" = 23%; "0" ≠ null. Άγνωστο: null· γνωστό μηδέν: 0.
totals · Σύνολα; tax_breakdown.groups · Φορολογικές ομάδες; Μη κατανεμημένος φόρος = order.tax − Σ groups.tax; ±.

Το payment.amount είναι το σύνολο παραγγελίας. Η κατάσταση πληρωμής δεν καθορίζει πληρωμένα, επιστραφέντα ή οφειλόμενα ποσά.

Παράμετροι

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

order_idΣυμβολοσειράΥποχρεωτικό

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

Περιορισμοί

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Παράδειγμα: "example"

Αυτή η λειτουργία δεν δέχεται περιεχόμενο JSON.

Αποκρίσεις

Απόκριση 200

Πλήρες μοντέλο: ApiResponse_OrderDetailData_

dataOrderDetailData Υποχρεωτικό

Δεδομένα επιτυχούς απόκρισης.

Πεδία · data

Πλήρες μοντέλο: OrderDetailData

created_atΣυμβολοσειράΥποχρεωτικό

Χρόνος δημιουργίας.

format: "date-time"

customerCustomerData Υποχρεωτικό

Στοιχεία πελάτη που έχουν καταγραφεί για αυτόν τον πόρο.

Πεδία · customer

Πλήρες μοντέλο: CustomerData

emailΣυμβολοσειράΥποχρεωτικό: Διεύθυνση ηλεκτρονικού ταχυδρομείου.
first_nameΣυμβολοσειρά nullΥποχρεωτικό: Όνομα.
last_nameΣυμβολοσειρά nullΥποχρεωτικό: Επώνυμο.
phoneΣυμβολοσειρά nullΥποχρεωτικό: Αριθμός τηλεφώνου.

deliveryShippingDetailData Υποχρεωτικό

Μέθοδος παράδοσης και σχετικές πληροφορίες.

Πεδία · delivery

Πλήρες μοντέλο: ShippingDetailData

amountMoneyData Υποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

datesDeliveryDatesData Υποχρεωτικό

Ημερομηνίες αποστολής και παράδοσης

discount_grossMoneyData Υποχρεωτικό

Μικτό ποσό · Εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.

discount_netMoneyData nullΥποχρεωτικό

Καθαρό ποσό · Εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.

discount_taxMoneyData nullΥποχρεωτικό

Ποσό φόρου · Εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.

discountsΠίνακας <OrderDeliveryDiscountData > nullΥποχρεωτικό

Εκπτώσεις

grossMoneyData Υποχρεωτικό

Μικτό ποσό · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.

method_codeΣυμβολοσειρά nullΥποχρεωτικό

Κωδικός μεθόδου παράδοσης ή πληρωμής.

method_nameΣυμβολοσειρά nullΥποχρεωτικό

Όνομα μεθόδου παράδοσης ή πληρωμής.

netMoneyData nullΥποχρεωτικό

Καθαρό ποσό · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.

original_grossMoneyData Υποχρεωτικό

Μικτό ποσό · Αποστολή · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.

original_netMoneyData nullΥποχρεωτικό

Καθαρό ποσό · Αποστολή · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.

original_taxMoneyData nullΥποχρεωτικό

Ποσό φόρου · Αποστολή · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.

pickup_pointDeliveryPickupPointData nullΥποχρεωτικό

Σημείο παραλαβής

recipient_modeΣυμβολοσειράΥποχρεωτικό

Μορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.

Περιορισμοί

enum: ["full_address", "pickup_contact"]

taxMoneyData nullΥποχρεωτικό

Πληροφορίες φόρου.

tax_category_idΣυμβολοσειρά nullΥποχρεωτικό

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

tax_category_nameΣυμβολοσειρά nullΥποχρεωτικό

Αποθηκευμένο όνομα φορολογικής κατηγορίας; null.

tax_rateΣυμβολοσειρά nullΥποχρεωτικό

tax_rate · Αποθηκευμένα στοιχεία παραγγελίας: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Υποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

Πεδία · discount_amount

Πλήρες μοντέλο: MoneyData

amountΣυμβολοσειράΥποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

currencyΣυμβολοσειράΥποχρεωτικό

Κωδικός νομίσματος του ποσού.

Περιορισμοί

pattern: "^[A-Z]{3}$"

minor_unitsΑκέραιοςΥποχρεωτικό

Πλήθος δεκαδικών ψηφίων του νομίσματος.

minimum: 0maximum: 4

discountsΠίνακας <OrderDiscountData > Υποχρεωτικό

Εκπτώσεις

Πεδία · discounts

OrderDiscountData

Πλήρες μοντέλο: OrderDiscountData

idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται.

invoiceInvoiceData nullΥποχρεωτικό

Στοιχεία τιμολογίου.

Πεδία · invoice

InvoiceData

Πλήρες μοντέλο: InvoiceData

null

invoice_requestedΛογική τιμήΥποχρεωτικό

Δείχνει αν ζητήθηκε τιμολόγιο.

lifecycle_stateOrderLifecycleState Υποχρεωτικό

Κατάσταση στον επιχειρησιακό κύκλο ζωής.

linesΠίνακας <OrderLineData > Υποχρεωτικό

Στιγμιότυπα γραμμών παραγγελίας.

Πεδία · lines

OrderLineData

Πλήρες μοντέλο: OrderLineData

localeΣυμβολοσειράΥποχρεωτικό

Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

market_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.

numberΣυμβολοσειράΥποχρεωτικό

Αριθμός παραγγελίας ή αιτήματος που εμφανίζεται στον χρήστη.

paymentPaymentData Υποχρεωτικό

Στοιχεία πληρωμής που έχουν καταγραφεί για την παραγγελία.

Πεδία · payment

Πλήρες μοντέλο: PaymentData

amountMoneyData Υποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

environmentΣυμβολοσειράΥποχρεωτικό

Πληροφορίες περιβάλλοντος που συνοδεύουν την εγγραφή.

Περιορισμοί

enum: ["live", "sandbox"]

method_codeΣυμβολοσειρά nullΥποχρεωτικό

Κωδικός μεθόδου παράδοσης ή πληρωμής.

method_nameΣυμβολοσειρά nullΥποχρεωτικό

Όνομα μεθόδου παράδοσης ή πληρωμής.

paid_atΣυμβολοσειρά nullΥποχρεωτικό

Ημερομηνία και ώρα επισήμανσης της πληρωμής ως εξοφλημένης.

Συμβολοσειρά:format: "date-time"

statusOrderPaymentStatus Υποχρεωτικό

Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.

updated_atΣυμβολοσειράΥποχρεωτικό

Χρόνος τελευταίας ενημέρωσης.

format: "date-time"

versionΑκέραιοςΥποχρεωτικό

Έκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.

pickup_pointPickupPointData nullΥποχρεωτικό

Σημείο παραλαβής

Πεδία · pickup_point

PickupPointData

Πλήρες μοντέλο: PickupPointData

null

prices_include_taxΛογική τιμήΥποχρεωτικό

Δείχνει αν οι τιμές περιλαμβάνουν φόρο.

shipping_addressAddressData nullΥποχρεωτικό

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

Πεδία · shipping_address

AddressData

Πλήρες μοντέλο: AddressData

null

shipping_discount_amountMoneyData Υποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

Πεδία · shipping_discount_amount

Πλήρες μοντέλο: MoneyData

amountΣυμβολοσειράΥποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

currencyΣυμβολοσειράΥποχρεωτικό

Κωδικός νομίσματος του ποσού.

Περιορισμοί

pattern: "^[A-Z]{3}$"

minor_unitsΑκέραιοςΥποχρεωτικό

Πλήθος δεκαδικών ψηφίων του νομίσματος.

minimum: 0maximum: 4

statusOrderStatusData Υποχρεωτικό

Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.

Πεδία · status

Πλήρες μοντέλο: OrderStatusData

idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται.
nameΣυμβολοσειράΥποχρεωτικό: Όνομα πόρου στο σχετικό πλαίσιο.
updated_atΣυμβολοσειράΥποχρεωτικό: Χρόνος τελευταίας ενημέρωσης.
format: "date-time"
versionΑκέραιοςΥποχρεωτικό: Έκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.

subtotalMoneyData Υποχρεωτικό

Ποσό πριν από τα πρόσθετα στοιχεία που εμφανίζονται στην απόκριση.

Πεδία · subtotal

Πλήρες μοντέλο: MoneyData

amountΣυμβολοσειράΥποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

currencyΣυμβολοσειράΥποχρεωτικό

Κωδικός νομίσματος του ποσού.

Περιορισμοί

pattern: "^[A-Z]{3}$"

minor_unitsΑκέραιοςΥποχρεωτικό

Πλήθος δεκαδικών ψηφίων του νομίσματος.

minimum: 0maximum: 4

taxMoneyData Υποχρεωτικό

Πληροφορίες φόρου.

Πεδία · tax

Πλήρες μοντέλο: MoneyData

amountΣυμβολοσειράΥποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

currencyΣυμβολοσειράΥποχρεωτικό

Κωδικός νομίσματος του ποσού.

Περιορισμοί

pattern: "^[A-Z]{3}$"

minor_unitsΑκέραιοςΥποχρεωτικό

Πλήθος δεκαδικών ψηφίων του νομίσματος.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Υποχρεωτικό

Φορολογικές ομάδες · source + tax_rate; unallocated_tax.

Πεδία · tax_breakdown

Πλήρες μοντέλο: OrderTaxBreakdownData

groupsΠίνακας <OrderTaxGroupData > Υποχρεωτικό: Φορολογικές ομάδες · source + tax_rate; Άγνωστο: null· γνωστό μηδέν: 0.
unallocated_taxMoneyData Υποχρεωτικό: Μη κατανεμημένος φόρος = order.tax − Σ groups.tax; ±.

tax_country_codeΣυμβολοσειρά nullΥποχρεωτικό

Φορολογική χώρα · Αποθηκευμένα στοιχεία παραγγελίας · ISO 3166-1 alpha-2; null.

totalMoneyData Υποχρεωτικό

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

Πεδία · total

Πλήρες μοντέλο: MoneyData

amountΣυμβολοσειράΥποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

currencyΣυμβολοσειράΥποχρεωτικό

Κωδικός νομίσματος του ποσού.

Περιορισμοί

pattern: "^[A-Z]{3}$"

minor_unitsΑκέραιοςΥποχρεωτικό

Πλήθος δεκαδικών ψηφίων του νομίσματος.

minimum: 0maximum: 4

totalsOrderTotalsData Υποχρεωτικό

Σύνολα · net / tax / gross; Πριν τις εκπτώσεις / Μετά τις εκπτώσεις.

Πεδία · totals

Πλήρες μοντέλο: OrderTotalsData

before_discountsOrderAmountBreakdownData Υποχρεωτικό: Παραγγελία · Πριν τις εκπτώσεις · net / tax / gross.
discountsOrderAmountBreakdownData Υποχρεωτικό: Εκπτώσεις
orderOrderAmountBreakdownData Υποχρεωτικό: Παραγγελία · Μετά τις εκπτώσεις · net / tax / gross.
product_discountsOrderAmountBreakdownData Υποχρεωτικό: Προϊόντα · Εκπτώσεις · net / tax / gross.
productsOrderAmountBreakdownData Υποχρεωτικό: Προϊόντα · Μετά τις εκπτώσεις · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Υποχρεωτικό: Προϊόντα · Πριν τις εκπτώσεις · net / tax / gross.
shippingOrderAmountBreakdownData Υποχρεωτικό: Αποστολή · Μετά τις εκπτώσεις · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Υποχρεωτικό: Αποστολή · Πριν τις εκπτώσεις · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Υποχρεωτικό: Αποστολή · Εκπτώσεις · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

Μεταδεδομένα απόκρισης.

Πεδία · meta

ContextPageMeta

Πλήρες μοντέλο: ContextPageMeta

localeΣυμβολοσειράΥποχρεωτικό: Γλώσσα που επιλέχθηκε για αυτό το αίτημα.
market_codeΣυμβολοσειράΥποχρεωτικό: Κωδικός αγοράς που επιστρέφει το endpoint πλαισίου.
market_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.
paginationPagination Υποχρεωτικό: Μεταδεδομένα σελιδοποίησης με cursor.
request_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength: 1maxLength: 100

ContextMeta

Πλήρες μοντέλο: ContextMeta

localeΣυμβολοσειράΥποχρεωτικό: Γλώσσα που επιλέχθηκε για αυτό το αίτημα.
market_codeΣυμβολοσειράΥποχρεωτικό: Κωδικός αγοράς που επιστρέφει το endpoint πλαισίου.
market_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.
request_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength: 1maxLength: 100

PageMeta

Πλήρες μοντέλο: PageMeta

paginationPagination Υποχρεωτικό: Μεταδεδομένα σελιδοποίησης με cursor.
request_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength: 1maxLength: 100

RequestMeta

Πλήρες μοντέλο: RequestMeta

request_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.
minLength: 1maxLength: 100

Παράδειγμα απόκρισης

Κατάσταση HTTP

200: Επιτυχής απόκριση Σχήμα
400: Μη έγκυρο αίτημα
401: Απαιτείται ταυτοποίηση
403: Δεν επιτρέπεται η πρόσβαση
404: Ο πόρος δεν βρέθηκε
409: Διένεξη έκδοσης
422: Αποτυχία επικύρωσης
429: Υπέρβαση ορίου αιτημάτων

Άλλες καταστάσεις HTTP (7)

405: Η μέθοδος δεν επιτρέπεται
413: Πολύ μεγάλο αίτημα
415: Μη υποστηριζόμενος τύπος
500: Σφάλμα διακομιστή
502: Σφάλμα πύλης API
503: Μη διαθέσιμη υπηρεσία
504: Υπέρβαση χρόνου αναμονής

Κατάλογος σφαλμάτων: ErrorResponse

Κεφαλίδες

401

WWW-AuthenticateΣυμβολοσειράΠροαιρετικό: Σχήμα ελέγχου ταυτότητας που απαιτεί ο διακομιστής.

405

AllowΣυμβολοσειράΠροαιρετικό: Μέθοδοι HTTP που υποστηρίζει αυτός ο πόρος.

429, 503

Retry-AfterΑκέραιοςΠροαιρετικό: Ελάχιστος χρόνος αναμονής πριν από νέα προσπάθεια, σε δευτερόλεπτα.

minimum: 0

Κατάλογος σφαλμάτων · Μάθετε περισσότερα

GET/api/v1/orders/{order_id}

Παραδείγματα κώδικα

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

cURL

PHP

Python

Παράδειγμα απόκρισης 200

Αρχές

Παραγγελία · Σύνολα

Παράμετροι

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

Αποκρίσεις

Απόκριση 200

Κατάσταση HTTP

GET`/api/v1/orders/{order_id}`