콘텐츠로 건너뛰기
ShopentlyLearn
한국어

조회 — 주문

“주문”의 데이터를 조회합니다. 결과는 이 작업의 매개변수에 따라 달라집니다.

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: 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: 0.

discount_netMoneyData null필수

세전 금액 · 할인; 알 수 없음: null; 확인된 0: 0.

discount_taxMoneyData null필수

세액 · 할인; 알 수 없음: null; 확인된 0: 0.

discounts배열 <OrderDeliveryDiscountData > null필수

할인

grossMoneyData 필수

세금 포함 금액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

method_code문자열 null필수

배송 또는 결제 방법 코드입니다.

method_name문자열 null필수

배송 또는 결제 방법 이름입니다.

netMoneyData null필수

세전 금액 · 할인 후; 알 수 없음: null; 확인된 0: 0.

original_grossMoneyData 필수

세금 포함 금액 · 배송 · 할인 전; 알 수 없음: null; 확인된 0: 0.

original_netMoneyData null필수

세전 금액 · 배송 · 할인 전; 알 수 없음: null; 확인된 0: 0.

original_taxMoneyData null필수

세액 · 배송 · 할인 전; 알 수 없음: null; 확인된 0: 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문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

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: 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문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

ContextMeta

전체 모델: ContextMeta

locale문자열필수

이 요청에서 선택한 언어입니다.

market_code문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

PageMeta

전체 모델: PageMeta

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

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

오류 목록 · 자세히 보기