> ## Documentation Index
> Fetch the complete documentation index at: https://make.edicus.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 주문 가능 여부 확인

> 프로젝트가 주문 가능한 상태인지 알려줍니다. 사용자가 뒤로가기나 브라우저 강제 종료로 저장하지 못한 경우를 걸러내기 위한 것입니다.

서버는 문서 리비전이 0이 아닌지(`doc_rev !== 0`)로 판단합니다. 리비전이 기록되지 않은 프로젝트는 `doc_rev`가 `null`이고 `can_order`는 `true`입니다.

`can_order`가 `false`여도 오류가 아니라 200입니다. `edicus-uid`가 필요 없습니다.



## OpenAPI

````yaml /api-reference/openapi.json get /v2/projects/{project_id}/order/can_order
openapi: 3.1.0
info:
  title: Edicus Server API
  version: 1.1.5
  description: >-
    Edicus 편집기 연동에 필요한 서버 API입니다. 토큰 발급, 프로젝트 조회, 주문 처리, 폰트와 상품 정보, 템플릿 등록을
    다룹니다.


    ## 반드시 서버에서만 호출합니다


    모든 엔드포인트는 `edicus-api-key` 헤더를 요구합니다. 이 키는 고객사 서버에만 두고 브라우저 코드나 공개 저장소에 넣지
    않습니다. 브라우저에는 이 API로 발급받은 토큰만 내려보냅니다.


    ## 오류 응답


    `api.edicus.io`는 실패를 4xx와 5xx 상태 코드로 알리고, body는 언제나 `{"error": {"code",
    "message", "details", "request_id"}}` 모양입니다. `error.code`로 분기합니다. 같은
    `request_id`가 응답 헤더 `x-request-id`에도 실립니다.


    `resource-dot-edicusbase.appspot.com`은 방식이 다릅니다. 파라미터 누락은 `400`, 인증 실패는
    `401`, 그 밖의 모든 실패는 `500`이고, body에 `error` 객체가 없습니다.


    ## 응답 형식


    응답의 `content-type`은 `application/json`입니다.
  contact:
    name: 모션원
    url: https://edicus.io
servers:
  - url: https://api.edicus.io
    description: Server API 호스트
security:
  - edicusApiKey: []
tags:
  - name: Auth
    description: 토큰 발급
  - name: Projects
    description: 프로젝트 조회, 삭제, 복제
  - name: Orders
    description: 잠정 주문, 확정 주문, 취소
  - name: Fonts
    description: 폰트 그룹과 폰트 목록
  - name: Products
    description: 상품과 상품 카테고리 정보
  - name: Templates
    description: 리소스 토큰과 템플릿 패키지 등록
  - name: Resources
    description: 리소스 검색과 사용자 이미지
paths:
  /v2/projects/{project_id}/order/can_order:
    get:
      tags:
        - Orders
      summary: 주문 가능 여부 확인
      description: >-
        프로젝트가 주문 가능한 상태인지 알려줍니다. 사용자가 뒤로가기나 브라우저 강제 종료로 저장하지 못한 경우를 걸러내기 위한
        것입니다.


        서버는 문서 리비전이 0이 아닌지(`doc_rev !== 0`)로 판단합니다. 리비전이 기록되지 않은 프로젝트는
        `doc_rev`가 `null`이고 `can_order`는 `true`입니다.


        `can_order`가 `false`여도 오류가 아니라 200입니다. `edicus-uid`가 필요 없습니다.
      operationId: canOrder
      parameters:
        - name: project_id
          in: path
          required: true
          description: 프로젝트 id
          schema:
            type: string
            minLength: 1
          example: '-LiBngTbCFYNjcOVcxcY'
      responses:
        '200':
          description: 주문 가능 여부입니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CanOrderResult'
              example:
                can_order: true
                doc_rev: 3
                status: editing
        '401':
          description: >-
            인증 실패입니다. `error.code`는 `no_credentials`(자격 증명 헤더가 없음) 또는
            `invalid_api_key`(API 키가 틀림)입니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              examples:
                invalid_api_key:
                  summary: invalid_api_key
                  value:
                    error:
                      code: invalid_api_key
                      message: edicus-api-key 값을 확인하세요
                      request_id: 4bf92f3577b34da6a3ce929d0e0e4736
                no_credentials:
                  summary: no_credentials
                  value:
                    error:
                      code: no_credentials
                      message: edicus-api-key 또는 edicus-id-token이 필요합니다
                      request_id: 4bf92f3577b34da6a3ce929d0e0e4736
        '404':
          description: 프로젝트가 없습니다. `error.code`는 `project_not_found`입니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              example:
                error:
                  code: project_not_found
                  message: 프로젝트가 없습니다
                  request_id: 4bf92f3577b34da6a3ce929d0e0e4736
components:
  schemas:
    CanOrderResult:
      type: object
      properties:
        can_order:
          type: boolean
          description: '`false`면 저장된 적이 없는 프로젝트라 주문할 수 없습니다'
        doc_rev:
          type:
            - number
            - 'null'
          description: 문서 리비전. 0이면 저장된 적이 없습니다. 기록되지 않았으면 `null`입니다
        status:
          type:
            - string
            - 'null'
          description: 프로젝트 상태(`ProjectStatus`와 같은 값)입니다. 소유자나 상태를 찾지 못하면 `null`입니다
      required:
        - can_order
        - doc_rev
        - status
    ErrorBody:
      type: object
      description: '`api.edicus.io`의 모든 4xx와 5xx 응답 body입니다. 클라이언트는 `error.code`로 분기합니다.'
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: snake_case 오류 코드. 이 값으로 분기합니다
              example: project_not_found
            message:
              type: string
              description: 사람이 읽는 설명입니다. 파싱하지 않습니다
            details:
              type: object
              additionalProperties: true
              description: 선택. 검증 실패면 `issues`에 어긋난 항목 목록이, 상태 충돌이면 현재 상태가 들어 있습니다
            request_id:
              type: string
              description: 요청 id입니다. 응답 헤더 `x-request-id`와 같은 값이고, 문의할 때 함께 알려 줍니다
          required:
            - code
            - message
            - request_id
      required:
        - error
      example:
        error:
          code: project_not_found
          message: 프로젝트가 없습니다
          request_id: 4bf92f3577b34da6a3ce929d0e0e4736
  securitySchemes:
    edicusApiKey:
      type: apiKey
      in: header
      name: edicus-api-key
      description: 모션원에서 발급받는 API 키입니다. 외부에 유출되지 않도록 각별히 주의합니다.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.