> ## 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.

# 주문 취소

> 주문을 취소합니다. **잠정 주문(`ordering`) 상태에서만 가능합니다.** 성공하면 프로젝트가 `editing`으로 돌아가고 사용자가 다시 편집할 수 있습니다.

응답의 `order_id`는 정수입니다.

<Warning>VDP를 포함한 주문을 취소하면 `vdp_dataset`은 삭제되고 복구되지 않습니다.</Warning>



## OpenAPI

````yaml /api-reference/openapi.json post /v2/orders/{order_id}/cancel
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/orders/{order_id}/cancel:
    post:
      tags:
        - Orders
      summary: 주문 취소
      description: >-
        주문을 취소합니다. **잠정 주문(`ordering`) 상태에서만 가능합니다.** 성공하면 프로젝트가 `editing`으로
        돌아가고 사용자가 다시 편집할 수 있습니다.


        응답의 `order_id`는 정수입니다.


        <Warning>VDP를 포함한 주문을 취소하면 `vdp_dataset`은 삭제되고 복구되지 않습니다.</Warning>
      operationId: cancelOrder
      parameters:
        - name: order_id
          in: path
          required: true
          description: 주문 id. 잠정 주문 응답으로 받은 정수입니다. 양의 정수가 아니면 `400 invalid_request`입니다.
          schema:
            type: integer
            exclusiveMinimum: 0
          example: 100023
        - name: edicus-uid
          in: header
          required: true
          description: >-
            고객사가 사용자에게 부여한 고유 id입니다. 1~70자이고 `a-z`, `A-Z`, `0-9`, `_`, `!`, `@`,
            `-`, `+`, `=`만 쓸 수 있습니다. 없거나 규칙을 어기면 `400 invalid_request`입니다.
          schema:
            type: string
            minLength: 1
            maxLength: 70
            pattern: ^[a-zA-Z0-9_!@\-+=]+$
          example: kr46KCD8vWOnOGo8CBO7c6ctSge2
      responses:
        '200':
          description: 취소했습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelOrderResult'
              example:
                order_id: 100023
                status: canceled
        '400':
          description: >-
            `order_id`가 양의 정수가 아니거나 `edicus-uid`가 형식 규칙을 어겼습니다. `error.code`는
            `invalid_request`입니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              example:
                error:
                  code: invalid_request
                  message: 요청 형식이 맞지 않습니다
                  details:
                    issues:
                      - origin: string
                        code: invalid_format
                        format: regex
                        pattern: ^[a-zA-Z0-9_!@\-+=]+$
                        path:
                          - edicus-uid
                        message: 'allowed: a-z A-Z 0-9 _ ! @ - + ='
                  request_id: 4bf92f3577b34da6a3ce929d0e0e4736
        '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
        '403':
          description: '`edicus-uid` 사용자의 주문이 아닙니다. `error.code`는 `order_not_owned`입니다.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              example:
                error:
                  code: order_not_owned
                  message: 이 사용자의 주문이 아닙니다
                  request_id: 4bf92f3577b34da6a3ce929d0e0e4736
        '404':
          description: >-
            주문이나 프로젝트가 없습니다. `error.code`는 `order_not_found` 또는
            `project_not_found`입니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              examples:
                order_not_found:
                  summary: order_not_found
                  value:
                    error:
                      code: order_not_found
                      message: 주문이 없습니다
                      request_id: 4bf92f3577b34da6a3ce929d0e0e4736
                project_not_found:
                  summary: project_not_found
                  value:
                    error:
                      code: project_not_found
                      message: 프로젝트가 없습니다
                      request_id: 4bf92f3577b34da6a3ce929d0e0e4736
        '409':
          description: >-
            취소할 수 없는 상태입니다. `error.code`는 다음 중 하나입니다.


            - `project_not_ordering`: 프로젝트가 잠정 주문(`ordering`) 상태가 아닙니다. 확정된 주문은
            취소할 수 없습니다

            - `order_id_mismatch`: 프로젝트에 기록된 주문 id와 다릅니다
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              examples:
                project_not_ordering:
                  summary: project_not_ordering
                  value:
                    error:
                      code: project_not_ordering
                      message: 취소는 status가 ordering일 때만 가능합니다
                      request_id: 4bf92f3577b34da6a3ce929d0e0e4736
                order_id_mismatch:
                  summary: order_id_mismatch
                  value:
                    error:
                      code: order_id_mismatch
                      message: 프로젝트에 기록된 주문 번호와 다릅니다
                      request_id: 4bf92f3577b34da6a3ce929d0e0e4736
components:
  schemas:
    CancelOrderResult:
      type: object
      properties:
        order_id:
          type: integer
          description: 취소한 주문 id. 정수입니다
        status:
          type: string
          enum:
            - canceled
          description: 주문의 처리 결과입니다. 프로젝트 상태는 `editing`으로 돌아갑니다
      required:
        - order_id
        - 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.