Treci la conținut
ShopentlyLearn
Română

Obține — Comenzi

Citiți datele din „Comenzi”. Rezultatul depinde de parametrii acestei operațiuni.

GET/api/v1/orders/{order_id}

Autentificare
Bearer
Disponibil începând cu
BASIC
Permisiuni necesare
orders.order:read

Exemple de cod

Exemplu de cerere

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))

Exemplu de răspuns 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"
  }
}

Cum funcționează

  • Colecția oferă rezumate de comenzi și filtre pentru număr, stare, starea plății și data creării.
  • Lista și detaliile comenzilor includ delivery.dates. Datele YYYY-MM-DD sunt planificate și nu confirmă expedierea. Datele curente au prioritate; comenzile vechi folosesc estimarea salvată. Valorile șterse sau necunoscute sunt null. Detaliile includ și toate pozițiile și imaginile produselor.
  • Obțineți identificatorii valizi ai stărilor din /api/v1/order-statuses.
  • Starea comenzii și starea plății folosesc endpointuri PATCH și permisiuni separate.
  • Schimbarea stării de plată înregistrate nu debitează un card și nu execută o rambursare printr-un furnizor de plăți.

Scrieri sigure

Permisiuni și planuri

Comandă · Totaluri

Sumele și cotele provin din comanda salvată, inclusiv corecturile pozițiilor. Datele istorice lipsă sunt null și nu sunt înlocuite cu taxele actuale din catalog. Sumele rămân șiruri zecimale.

Lista returnează rezumate. Obține GET /api/v1/orders/{order_id} pentru fiecare rezultat pentru a exporta detaliile financiare complete. Reîncercările GET sunt limitate și respectă Retry-After. Exportul după data creării nu sincronizează corecturile ulterioare.

  • tax_country_code · Țară fiscală · Datele salvate ale comenzii · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · O unitate · Înainte de reduceri; lines[].original_total_* · Înainte de reduceri; lines[].total_* · După reduceri.
  • lines[].discount_* · Reduceri; manual_discount · Reducere manuală; percentage "10" = 10%.
  • delivery.net / tax / gross · După reduceri; delivery.original_* · Înainte de reduceri; delivery.discount_* · Reduceri.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Necunoscut: null; zero cunoscut: 0.
  • totals · Totaluri; tax_breakdown.groups · Grupuri fiscale; Taxă nealocată = order.tax − Σ groups.tax; ±.

payment.amount este totalul comenzii. Starea plății nu determină sumele plătite, rambursate sau restante.

Parametri

Parametrii căii

order_idȘir de caractereObligatoriu

Identificatorul comenzii asociate.

Restricții
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exemplu: "example"

Această operație nu acceptă un corp JSON.

Răspunsuri

Răspuns 200

Model complet: ApiResponse_OrderDetailData_

dataOrderDetailData Obligatoriu

Datele unui răspuns reușit.

Câmpuri · data

Model complet: OrderDetailData

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"
customerCustomerData Obligatoriu

Datele clientului înregistrate pentru această resursă.

Câmpuri · customer

Model complet: CustomerData

emailȘir de caractereObligatoriu

Adresa de e-mail.

first_nameȘir de caractere nullObligatoriu

Prenumele.

last_nameȘir de caractere nullObligatoriu

Numele de familie.

phoneȘir de caractere nullObligatoriu

Numărul de telefon.

deliveryShippingDetailData Obligatoriu

Metoda de livrare și informațiile asociate.

Câmpuri · delivery

Model complet: ShippingDetailData

amountMoneyData Obligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

datesDeliveryDatesData Obligatoriu

Date de expediere și livrare

discount_grossMoneyData Obligatoriu

Sumă brută · Reduceri; Necunoscut: null; zero cunoscut: 0.

discount_netMoneyData nullObligatoriu

Sumă netă · Reduceri; Necunoscut: null; zero cunoscut: 0.

discount_taxMoneyData nullObligatoriu

Valoarea taxei · Reduceri; Necunoscut: null; zero cunoscut: 0.

discountsTablou <OrderDeliveryDiscountData > nullObligatoriu

Reduceri

grossMoneyData Obligatoriu

Sumă brută · După reduceri; Necunoscut: null; zero cunoscut: 0.

method_codeȘir de caractere nullObligatoriu

Codul metodei de livrare sau de plată.

method_nameȘir de caractere nullObligatoriu

Numele metodei de livrare sau de plată.

netMoneyData nullObligatoriu

Sumă netă · După reduceri; Necunoscut: null; zero cunoscut: 0.

original_grossMoneyData Obligatoriu

Sumă brută · Livrare · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

original_netMoneyData nullObligatoriu

Sumă netă · Livrare · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

original_taxMoneyData nullObligatoriu

Valoarea taxei · Livrare · Înainte de reduceri; Necunoscut: null; zero cunoscut: 0.

pickup_pointDeliveryPickupPointData nullObligatoriu

Punct de ridicare

recipient_modeȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții
enum
["full_address", "pickup_contact"]
taxMoneyData nullObligatoriu

Informații despre taxe.

tax_category_idȘir de caractere nullObligatoriu

Identificatorul categoriei fiscale.

tax_category_nameȘir de caractere nullObligatoriu

Numele salvat al categoriei fiscale; null.

tax_rateȘir de caractere nullObligatoriu

tax_rate · Datele salvate ale comenzii: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Câmpuri · discount_amount

Model complet: MoneyData

amountȘir de caractereObligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

currencyȘir de caractereObligatoriu

Codul monedei în care este exprimată suma.

Restricții
pattern
"^[A-Z]{3}$"
minor_unitsNumăr întregObligatoriu

Numărul de zecimale folosite de monedă.

minimum: 0maximum: 4
discountsTablou <OrderDiscountData > Obligatoriu

Reduceri

Câmpuri · discounts

OrderDiscountData

Model complet: OrderDiscountData

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

invoiceInvoiceData nullObligatoriu

Informații despre factură.

Câmpuri · invoice

InvoiceData

Model complet: InvoiceData

null

invoice_requestedValoare booleanăObligatoriu

Indică dacă a fost solicitată o factură.

lifecycle_stateOrderLifecycleState Obligatoriu

Starea din ciclul de viață comercial.

linesTablou <OrderLineData > Obligatoriu

Datele pozițiilor comenzii păstrate la înregistrarea acesteia.

Câmpuri · lines

OrderLineData

Model complet: OrderLineData

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

numberȘir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

paymentPaymentData Obligatoriu

Detaliile de plată înregistrate pentru comandă.

Câmpuri · payment

Model complet: PaymentData

amountMoneyData Obligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

environmentȘir de caractereObligatoriu

Informații despre mediu asociate înregistrării.

Restricții
enum
["live", "sandbox"]
method_codeȘir de caractere nullObligatoriu

Codul metodei de livrare sau de plată.

method_nameȘir de caractere nullObligatoriu

Numele metodei de livrare sau de plată.

paid_atȘir de caractere nullObligatoriu

Data și ora la care plata a fost marcată ca efectuată.

Șir de caractere:format: "date-time"
statusOrderPaymentStatus Obligatoriu

Starea acceptată de această operație specifică.

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

pickup_pointPickupPointData nullObligatoriu

Punct de ridicare

Câmpuri · pickup_point

PickupPointData

Model complet: PickupPointData

null

prices_include_taxValoare booleanăObligatoriu

Indică dacă prețurile afișate includ taxele.

shipping_addressAddressData nullObligatoriu

Adresa de livrare.

Câmpuri · shipping_address

AddressData

Model complet: AddressData

null

shipping_discount_amountMoneyData Obligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Câmpuri · shipping_discount_amount

Model complet: MoneyData

amountȘir de caractereObligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

currencyȘir de caractereObligatoriu

Codul monedei în care este exprimată suma.

Restricții
pattern
"^[A-Z]{3}$"
minor_unitsNumăr întregObligatoriu

Numărul de zecimale folosite de monedă.

minimum: 0maximum: 4
statusOrderStatusData Obligatoriu

Starea acceptată de această operație specifică.

Câmpuri · status

Model complet: OrderStatusData

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

subtotalMoneyData Obligatoriu

Suma înainte de componentele suplimentare prezentate în răspuns.

Câmpuri · subtotal

Model complet: MoneyData

amountȘir de caractereObligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

currencyȘir de caractereObligatoriu

Codul monedei în care este exprimată suma.

Restricții
pattern
"^[A-Z]{3}$"
minor_unitsNumăr întregObligatoriu

Numărul de zecimale folosite de monedă.

minimum: 0maximum: 4
taxMoneyData Obligatoriu

Informații despre taxe.

Câmpuri · tax

Model complet: MoneyData

amountȘir de caractereObligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

currencyȘir de caractereObligatoriu

Codul monedei în care este exprimată suma.

Restricții
pattern
"^[A-Z]{3}$"
minor_unitsNumăr întregObligatoriu

Numărul de zecimale folosite de monedă.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Obligatoriu

Grupuri fiscale · source + tax_rate; unallocated_tax.

Câmpuri · tax_breakdown

Model complet: OrderTaxBreakdownData

groupsTablou <OrderTaxGroupData > Obligatoriu

Grupuri fiscale · source + tax_rate; Necunoscut: null; zero cunoscut: 0.

unallocated_taxMoneyData Obligatoriu

Taxă nealocată = order.tax − Σ groups.tax; ±.

tax_country_codeȘir de caractere nullObligatoriu

Țară fiscală · Datele salvate ale comenzii · ISO 3166-1 alpha-2; null.

totalMoneyData Obligatoriu

Suma totală.

Câmpuri · total

Model complet: MoneyData

amountȘir de caractereObligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

currencyȘir de caractereObligatoriu

Codul monedei în care este exprimată suma.

Restricții
pattern
"^[A-Z]{3}$"
minor_unitsNumăr întregObligatoriu

Numărul de zecimale folosite de monedă.

minimum: 0maximum: 4
totalsOrderTotalsData Obligatoriu

Totaluri · net / tax / gross; Înainte de reduceri / După reduceri.

Câmpuri · totals

Model complet: OrderTotalsData

before_discountsOrderAmountBreakdownData Obligatoriu

Comandă · Înainte de reduceri · net / tax / gross.

discountsOrderAmountBreakdownData Obligatoriu

Reduceri

orderOrderAmountBreakdownData Obligatoriu

Comandă · După reduceri · net / tax / gross.

product_discountsOrderAmountBreakdownData Obligatoriu

Produse · Reduceri · net / tax / gross.

productsOrderAmountBreakdownData Obligatoriu

Produse · După reduceri · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Obligatoriu

Produse · Înainte de reduceri · net / tax / gross.

shippingOrderAmountBreakdownData Obligatoriu

Livrare · După reduceri · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Obligatoriu

Livrare · Înainte de reduceri · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Obligatoriu

Livrare · Reduceri · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriu

Metadatele răspunsului.

Câmpuri · meta

ContextPageMeta

Model complet: ContextPageMeta

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

ContextMeta

Model complet: ContextMeta

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

PageMeta

Model complet: PageMeta

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

RequestMeta

Model complet: RequestMeta

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100
Exemplu de răspuns

Stare HTTP

200
Răspuns reușit Schemă
400
Cerere nevalidă
401
Autentificare necesară
403
Acces refuzat
404
Resursa nu a fost găsită
409
Conflict de versiune
422
Validare eșuată
429
Limită de cereri depășită
Alte stări HTTP (7)
405
Metodă nepermisă
413
Cerere prea mare
415
Format neacceptat
500
Eroare de server
502
Eroare de gateway API
503
Serviciu indisponibil
504
Timp de așteptare depășit

Catalog de erori: ErrorResponse

Antete

401

WWW-AuthenticateȘir de caractereOpțional

Schema de autentificare cerută de server.

405

AllowȘir de caractereOpțional

Metodele HTTP acceptate de această resursă.

429, 503

Retry-AfterNumăr întregOpțional

Întârzierea minimă înainte de reîncercare, în secunde.

minimum: 0

Catalog de erori · Află mai multe