UnpaidOrder API

CREMA 서버에 등록된 미입금 무통장 주문 정보를 확인하고, 등록/수정하는 방법을 제공합니다.

  • Unpaid Order 데이터를 입력하기 전에 관련 Order, SubOrder 데이터를 먼저 입력해주세요.

List unpaid_orders

미입금 무통장 주문 목록을 가져옵니다.

GET /v1/unpaid_orders HTTP/1.1
이름 타입 필수 설명
limit integer ✖ 한 페이지에 가져올 미입금 무통장 주문의 개수입니다. 최대 100개까지 가능합니다. 기본: 50
page integer ✖ 페이지 번호입니다. 최대 페이지 수는 Link http header의 rel="last"에 기재되어 있습니다. 기본: 1

Response

HTTP/1.1 200 OK
Link: <https://api.cre.ma/v1/unpaid_orders>; rel="last", <https://api.cre.ma/v1/unpaid_orders&page=2>; rel="next"

[
  {
    "id": "11142",
    "order_id": "4421",
    "order_code": "order-391837",
    "bank_name": "국민은행",
    "bank_account_no": "123-1234-123",
    "recipient_name": "홍길동",
    "sender_name": "크리마",
    "unpaid_price_cents": "10000",
    "created_at": "2019-12-01T19:10:36.000+09:00",
    "updated_at": "2019-12-03T02:04:15.000+09:00"
  },
  {
    "id": "13213",
    "order_id": "1242",
    "order_code": "order-391432",
    "bank_name": "하나은행",
    "bank_account_no": "456-4567-456",
    "recipient_name": "홍길동",
    "sender_name": "크리마",
    "unpaid_price_cents": "500000",
    "created_at": "2019-12-01T19:10:36.000+09:00",
    "updated_at": "2019-12-03T02:04:15.000+09:00"
  }
]

Get a single unpaid_order

미입금 무통장 주문 한건의 상세 정보를 가져옵니다.

GET /v1/unpaid_orders HTTP/1.1
이름 타입 필수 설명
order_code string ✔ 주문 식별자

Response

HTTP/1.1 200 OK

{
  "id": "11142",
  "order_id": "4421",
  "order_code": "order-391837",
  "bank_name": "국민은행",
  "bank_account_no": "123-1234-123",
  "recipient_name": "홍길동",
  "sender_name": "크리마",
  "unpaid_price_cents": "10000",
  "created_at": "2019-12-01T19:10:36.000+09:00",
  "updated_at": "2019-12-03T02:04:15.000+09:00"
}

Create an unpaid_order

새로운 미입금 무통장 주문을 생성합니다.

POST /v1/unpaid_orders HTTP/1.1
이름 타입 필수 설명
order_code string ✔ 주문의 고유 식별자입니다. /v1/orders 에 사용하는 code와 같은 값입니다. 이미 /v1/orders API를 통해 생성된 주문의 code값을 사용해야 합니다.
bank_name string ✔ 입금 은행의 이름
bank_account_no string ✔ 입금 계좌 번호
recipient_name string ✔ 예금주, 혹은 입금 받는 사람의 이름
sender_name string ✔ 입금자명
unpaid_price_cents integer ✔ 미입금액

Response

HTTP/1.1 201 Created
Location: https://api.cre.ma/v1/unpaid_orders

{
  "id": "11142",
  "order_id": "4421",
  "order_code": "order-391837",
  "bank_name": "국민은행",
  "bank_account_no": "123-1234-123",
  "recipient_name": "홍길동",
  "sender_name": "크리마",
  "unpaid_price_cents": "10000",
  "created_at": "2019-12-01T19:10:36.000+09:00",
  "updated_at": "2019-12-03T02:04:15.000+09:00"
}

Update an unpaid_order

미입금 무통장 주문의 내용을 수정합니다.

PATCH /v1/unpaid_orders HTTP/1.1
이름 타입 필수 설명
order_code string ✔ 주문의 고유 식별자입니다. /v1/orders 에 사용하는 code와 같은 값입니다. 이미 /v1/orders API를 통해 생성된 주문의 code값을 사용해야 합니다.
bank_name string ✖ 입금 은행의 이름
bank_account_no string ✖ 입금 계좌 번호
recipient_name string ✖ 예금주, 혹은 입금 받는 사람의 이름
sender_name string ✖ 입금자명
unpaid_price_cents integer ✖ 미입금액

Response

HTTP/1.1 204 No Content
Location: https://api.cre.ma/v1/unpaid_orders

Delete a single unpaid_order

미입금 무통장 주문 한 개를 삭제합니다.

DELETE /v1/unpaid_orders HTTP/1.1
이름 타입 필수 설명
order_code string ✔ 주문의 고유 식별자입니다. /v1/orders 에 사용하는 code와 같은 값입니다. 이미 /v1/orders API를 통해 생성된 주문의 code값을 사용해야 합니다.

Response

HTTP/1.1 204 No Content

직접 사용해 보세요!

API Explorer를 사용하여 API 요청 및 응답을 확인해 보세요.

결과