Pāriet uz saturu
ShopentlyLearn
Latviešu

Iegūt — Pasūtījumi

Nolasiet datus no “Pasūtījumi”. Rezultāts ir atkarīgs no šīs darbības parametriem.

GET/api/v1/orders/{order_id}

Autentifikācija
Bearer
Pieejams no
BASIC
Nepieciešamās atļaujas
orders.order:read

Koda piemēri

Pieprasījuma piemērs

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

Atbildes piemērs 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"
  }
}

Kā tas darbojas

  • Kolekcija piedāvā pasūtījumu kopsavilkumus un numura, statusa, maksājuma statusa un izveides laika filtrus.
  • Pasūtījumu saraksts un informācija ietver delivery.dates. Datumi YYYY-MM-DD ir plānoti un neapstiprina nosūtīšanu. Pašreizējiem datumiem ir prioritāte; vecāki pasūtījumi izmanto saglabāto prognozi. Dzēstas vai nezināmas vērtības ir null. Informācija ietver arī visas pasūtījuma pozīcijas un produktu attēlus.
  • Derīgos statusu identifikatorus iegūstiet no /api/v1/order-statuses.
  • Pasūtījuma un maksājuma statusam ir atsevišķi PATCH galapunkti un atļaujas.
  • Reģistrētā maksājuma statusa maiņa neveic kartes maksājumu vai atmaksu ar maksājumu pakalpojuma sniedzēja starpniecību.

Droša rakstīšana

Atļaujas un plāni

Pasūtījums · Kopsummas

Summas un likmes nāk no saglabātā pasūtījuma, ieskaitot pozīciju labojumus. Trūkstošie vēsturiskie dati ir null un netiek aizstāti ar pašreizējām kataloga likmēm. Summas paliek decimālās virknes.

Saraksts atgriež kopsavilkumus. Katram rezultātam iegūstiet GET /api/v1/orders/{order_id}, lai eksportētu pilnus finanšu datus. GET atkārtojumi ir ierobežoti un ievēro Retry-After. Eksports pēc izveides datuma nesinhronizē vēlākus labojumus.

  • tax_country_code · Nodokļu valsts · Saglabātie pasūtījuma dati · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Viena vienība · Pirms atlaidēm; lines[].original_total_* · Pirms atlaidēm; lines[].total_* · Pēc atlaidēm.
  • lines[].discount_* · Atlaides; manual_discount · Manuāla atlaide; percentage "10" = 10%.
  • delivery.net / tax / gross · Pēc atlaidēm; delivery.original_* · Pirms atlaidēm; delivery.discount_* · Atlaides.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Nezināms: null; zināma nulle: 0.
  • totals · Kopsummas; tax_breakdown.groups · Nodokļu grupas; Nepiešķirtais nodoklis = order.tax − Σ groups.tax; ±.

payment.amount ir pasūtījuma kopsumma. Maksājuma statuss nenosaka samaksātās, atmaksātās vai nesamaksātās summas.

Parametri

Ceļa parametri

order_idVirkneObligāts

Saistītā pasūtījuma identifikators.

Ierobežojumi
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Piemērs: "example"

Šī darbība nepieņem JSON saturu.

Atbildes

Atbilde 200

Pilns modelis: ApiResponse_OrderDetailData_

dataOrderDetailData Obligāts

Veiksmīgas atbildes dati.

Lauki · data

Pilns modelis: OrderDetailData

created_atVirkneObligāts

Izveides laiks.

format: "date-time"
customerCustomerData Obligāts

Šim resursam saglabātā klienta informācija.

Lauki · customer

Pilns modelis: CustomerData

emailVirkneObligāts

E-pasta adrese.

first_nameVirkne nullObligāts

Vārds.

last_nameVirkne nullObligāts

Uzvārds.

phoneVirkne nullObligāts

Tālruņa numurs.

deliveryShippingDetailData Obligāts

Piegādes metode un saistītā informācija.

Lauki · delivery

Pilns modelis: ShippingDetailData

amountMoneyData Obligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

datesDeliveryDatesData Obligāts

Nosūtīšanas un piegādes datumi

discount_grossMoneyData Obligāts

Bruto summa · Atlaides; Nezināms: null; zināma nulle: 0.

discount_netMoneyData nullObligāts

Neto summa · Atlaides; Nezināms: null; zināma nulle: 0.

discount_taxMoneyData nullObligāts

Nodokļa summa · Atlaides; Nezināms: null; zināma nulle: 0.

discountsMasīvs <OrderDeliveryDiscountData > nullObligāts

Atlaides

grossMoneyData Obligāts

Bruto summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

method_codeVirkne nullObligāts

Piegādes vai maksājuma metodes kods.

method_nameVirkne nullObligāts

Piegādes vai maksājuma metodes nosaukums.

netMoneyData nullObligāts

Neto summa · Pēc atlaidēm; Nezināms: null; zināma nulle: 0.

original_grossMoneyData Obligāts

Bruto summa · Piegāde · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

original_netMoneyData nullObligāts

Neto summa · Piegāde · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

original_taxMoneyData nullObligāts

Nodokļa summa · Piegāde · Pirms atlaidēm; Nezināms: null; zināma nulle: 0.

pickup_pointDeliveryPickupPointData nullObligāts

Saņemšanas punkts

recipient_modeVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi
enum
["full_address", "pickup_contact"]
taxMoneyData nullObligāts

Nodokļu informācija.

tax_category_idVirkne nullObligāts

Nodokļu kategorijas identifikators.

tax_category_nameVirkne nullObligāts

Saglabātais nodokļu kategorijas nosaukums; null.

tax_rateVirkne nullObligāts

tax_rate · Saglabātie pasūtījuma dati: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Lauki · discount_amount

Pilns modelis: MoneyData

amountVirkneObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi
pattern
"^[A-Z]{3}$"
minor_unitsVesels skaitlisObligāts

Valūtas izmantoto ciparu skaits aiz komata.

minimum: 0maximum: 4
discountsMasīvs <OrderDiscountData > Obligāts

Atlaides

Lauki · discounts

OrderDiscountData

Pilns modelis: OrderDiscountData

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā.

invoiceInvoiceData nullObligāts

Rēķina informācija.

Lauki · invoice

InvoiceData

Pilns modelis: InvoiceData

null

invoice_requestedLoģiska vērtībaObligāts

Vai pieprasīts rēķins.

lifecycle_stateOrderLifecycleState Obligāts

Biznesa dzīves cikla stāvoklis.

linesMasīvs <OrderLineData > Obligāts

Pasūtījuma rindu momentuzņēmumi.

Lauki · lines

OrderLineData

Pilns modelis: OrderLineData

localeVirkneObligāts

Šim pieprasījumam izvēlētā valoda.

market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

paymentPaymentData Obligāts

Pasūtījumā reģistrētās maksājuma detaļas.

Lauki · payment

Pilns modelis: PaymentData

amountMoneyData Obligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

environmentVirkneObligāts

Ierakstam pievienotā vides informācija.

Ierobežojumi
enum
["live", "sandbox"]
method_codeVirkne nullObligāts

Piegādes vai maksājuma metodes kods.

method_nameVirkne nullObligāts

Piegādes vai maksājuma metodes nosaukums.

paid_atVirkne nullObligāts

Datums un laiks, kad maksājums atzīmēts kā samaksāts.

Virkne:format: "date-time"
statusOrderPaymentStatus Obligāts

Šai konkrētajai darbībai pieņemamais statuss.

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

pickup_pointPickupPointData nullObligāts

Saņemšanas punkts

Lauki · pickup_point

PickupPointData

Pilns modelis: PickupPointData

null

prices_include_taxLoģiska vērtībaObligāts

Vai norādītās cenas ietver nodokli.

shipping_addressAddressData nullObligāts

Piegādes adrese.

Lauki · shipping_address

AddressData

Pilns modelis: AddressData

null

shipping_discount_amountMoneyData Obligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Lauki · shipping_discount_amount

Pilns modelis: MoneyData

amountVirkneObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi
pattern
"^[A-Z]{3}$"
minor_unitsVesels skaitlisObligāts

Valūtas izmantoto ciparu skaits aiz komata.

minimum: 0maximum: 4
statusOrderStatusData Obligāts

Šai konkrētajai darbībai pieņemamais statuss.

Lauki · status

Pilns modelis: OrderStatusData

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā.

nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

subtotalMoneyData Obligāts

Summa pirms atbildē parādītajiem papildu komponentiem.

Lauki · subtotal

Pilns modelis: MoneyData

amountVirkneObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi
pattern
"^[A-Z]{3}$"
minor_unitsVesels skaitlisObligāts

Valūtas izmantoto ciparu skaits aiz komata.

minimum: 0maximum: 4
taxMoneyData Obligāts

Nodokļu informācija.

Lauki · tax

Pilns modelis: MoneyData

amountVirkneObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi
pattern
"^[A-Z]{3}$"
minor_unitsVesels skaitlisObligāts

Valūtas izmantoto ciparu skaits aiz komata.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Obligāts

Nodokļu grupas · source + tax_rate; unallocated_tax.

Lauki · tax_breakdown

Pilns modelis: OrderTaxBreakdownData

groupsMasīvs <OrderTaxGroupData > Obligāts

Nodokļu grupas · source + tax_rate; Nezināms: null; zināma nulle: 0.

unallocated_taxMoneyData Obligāts

Nepiešķirtais nodoklis = order.tax − Σ groups.tax; ±.

tax_country_codeVirkne nullObligāts

Nodokļu valsts · Saglabātie pasūtījuma dati · ISO 3166-1 alpha-2; null.

totalMoneyData Obligāts

Kopējā summa.

Lauki · total

Pilns modelis: MoneyData

amountVirkneObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi
pattern
"^[A-Z]{3}$"
minor_unitsVesels skaitlisObligāts

Valūtas izmantoto ciparu skaits aiz komata.

minimum: 0maximum: 4
totalsOrderTotalsData Obligāts

Kopsummas · net / tax / gross; Pirms atlaidēm / Pēc atlaidēm.

Lauki · totals

Pilns modelis: OrderTotalsData

before_discountsOrderAmountBreakdownData Obligāts

Pasūtījums · Pirms atlaidēm · net / tax / gross.

discountsOrderAmountBreakdownData Obligāts

Atlaides

orderOrderAmountBreakdownData Obligāts

Pasūtījums · Pēc atlaidēm · net / tax / gross.

product_discountsOrderAmountBreakdownData Obligāts

Produkti · Atlaides · net / tax / gross.

productsOrderAmountBreakdownData Obligāts

Produkti · Pēc atlaidēm · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Obligāts

Produkti · Pirms atlaidēm · net / tax / gross.

shippingOrderAmountBreakdownData Obligāts

Piegāde · Pēc atlaidēm · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Obligāts

Piegāde · Pirms atlaidēm · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Obligāts

Piegāde · Atlaides · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligāts

Atbildes metadati.

Lauki · meta

ContextPageMeta

Pilns modelis: ContextPageMeta

localeVirkneObligāts

Šim pieprasījumam izvēlētā valoda.

market_codeVirkneObligāts

Konteksta galapunkta atgrieztais tirgus kods.

market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

paginationPagination Obligāts

Kursora lapošanas metadati.

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100

ContextMeta

Pilns modelis: ContextMeta

localeVirkneObligāts

Šim pieprasījumam izvēlētā valoda.

market_codeVirkneObligāts

Konteksta galapunkta atgrieztais tirgus kods.

market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100

PageMeta

Pilns modelis: PageMeta

paginationPagination Obligāts

Kursora lapošanas metadati.

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100

RequestMeta

Pilns modelis: RequestMeta

request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100
Atbildes piemērs

HTTP statuss

200
Veiksmīga atbilde Shēma
400
Nederīgs pieprasījums
401
Nepieciešama autentifikācija
403
Piekļuve liegta
404
Resurss nav atrasts
409
Versiju konflikts
422
Validācijas kļūda
429
Pārsniegts pieprasījumu limits
Citi HTTP statusi (7)
405
Metode nav atļauta
413
Pieprasījums ir pārāk liels
415
Neatbalstīts formāts
500
Servera kļūda
502
API vārtejas kļūda
503
Pakalpojums nav pieejams
504
Noildze

Kļūdu katalogs: ErrorResponse

Galvenes

401

WWW-AuthenticateVirkneNeobligāts

Servera pieprasītā autentifikācijas shēma.

405

AllowVirkneNeobligāts

Šī resursa atbalstītās HTTP metodes.

429, 503

Retry-AfterVesels skaitlisNeobligāts

Minimālā aizkave pirms atkārtošanas sekundēs.

minimum: 0

Kļūdu katalogs · Uzzināt vairāk