UserCoupon API

CREMA 서버에 등록된 쇼핑몰 회원의 쿠폰 정보를 확인하고, 등록/수정하는 방법을 제공합니다.

List user coupons

쇼핑몰 회원 쿠폰 목록을 가져옵니다.

with `user_id`

GET /v1/users/:user_id/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_id`	integer	✔	회원의 크리마 `id`
`limit`	integer	✖	한 페이지에 가져올 쿠폰 개수입니다. 최대 100개까지 가능합니다. 기본: `30`

with `user_code`

GET /v1/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_code`	string	✔	회원의 쇼핑몰 ID
`limit`	integer	✖	한 페이지에 가져올 쿠폰 개수입니다. 최대 100개까지 가능합니다. 기본: `30`

Response

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

[
  {
    "id": 1,
    "username": "thecrema3",
    "code": "eb46d86d28b7036e10f036e10fef99e21b6166d28b7036e100fef99e21b49230",
    "coupon_name": "블랙프라이데이 쿠폰",
    "issued_at": "2015-11-29T01:45:14.000+09:00",
    "expires_at": null,
    "used_at": null,
    "created_at": "2019-11-29T18:42:34.000+09:00",
    "updated_at": "2019-11-29T18:42:34.000+09:00"
  },
  {
    "id": 2,
    "username": "user2",
    "code": "6d28b7036e10eb46d86160f0d0fe70366e1e21b30649230e128b1bfef99e2f99",
    "issued_at": "2015-11-29T01:45:14.000+09:00",
    "expires_at": "2015-12-15T01:45:14.000+09:00",
    "used_at": null,
    "created_at": "2019-11-28T18:42:34.000+09:00",
    "updated_at": "2019-11-28T18:42:34.000+09:00"
  },
  {
    "id": 3,
    "username": "user3",
    "code": "86160f0d0fe70366e1e21b306d28b7036e10eb46d649230e128b1bfef99e2f99",
    "issued_at": "2015-11-29T01:45:14.000+09:00",
    "expires_at": "2015-12-15T01:45:14.000+09:00",
    "used_at": "2015-12-10T10:45:14.000+09:00",
    "created_at": "2019-11-28T18:42:34.000+09:00",
    "updated_at": "2019-11-28T18:42:34.000+09:00"
  }
]

Get a single user coupon

쿠폰 항목 하나의 상세 정보를 가져옵니다.

with `user_id` and `id`

GET /v1/users/:user_id/user_coupons/:id HTTP/1.1

이름	타입	필수	설명
`user_id`	integer	✔	회원의 크리마 `id`
`id`	integer	✔	쿠폰 항목의 `id`

with `user_code` and `id`

GET /v1/user_coupons/:id HTTP/1.1

이름	타입	필수	설명
`id`	integer	✔	가져올 쿠폰 항목 `id`
`user_code`	string	✔	회원의 쇼핑몰 ID

with `user_id` and `code`

GET /v1/users/:user_id/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_id`	integer	✔	회원의 크리마 `id`
`code`	string	✔	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID

with `user_code` and `code`

GET /v1/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_code`	string	✔	회원의 쇼핑몰 ID
`code`	string	✔	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID

Response

HTTP/1.1 200 OK

{
  "id": 2,
  "username": "user2",
  "code": "6d28b7036e10eb46d86160f0d0fe70366e1e21b30649230e128b1bfef99e2f99",
  "issued_at": "2015-11-29T01:45:14.000+09:00",
  "expires_at": "2015-12-15T01:45:14.000+09:00",
  "used_at": null,
  "created_at": "2019-11-28T18:42:34.000+09:00",
  "updated_at": "2019-11-28T18:42:34.000+09:00"
}

Create or Update a user coupon

새로운 쿠폰 항목을 생성하거나 기존 데이터를 수정합니다.

with `user_id`

POST /v1/users/:user_id/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_id`	integer	✔	회원의 크리마 `id`
`code`	string	✔	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID
`coupon_name`	string	✔	쿠폰 이름
`issued_at`	datetime(ISO 8601)	✔	쿠폰이 발행된 시간. 초단위까지만 유효
`expires_at`	datetime(ISO 8601)	✖	쿠폰이 만료되는 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 만료 시각이 존재하면 필수로 입력해야 합니다.
`used_at`	datetime(ISO 8601)	✖	쿠폰이 사용된 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 사용 시각이 존재하면 필수로 입력해야 합니다.

with `user_code`

POST /v1/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_code`	string	✔	회원의 쇼핑몰 ID
`code`	string	✔	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID
`coupon_name`	string	✔	쿠폰 이름
`issued_at`	datetime(ISO 8601)	✔	쿠폰이 발행된 시간. 초단위까지만 유효
`expires_at`	datetime(ISO 8601)	✖	쿠폰이 만료되는 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 만료 시각이 존재하면 필수로 입력해야 합니다.
`used_at`	datetime(ISO 8601)	✖	쿠폰이 사용된 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 사용 시각이 존재하면 필수로 입력해야 합니다.

Response

HTTP/1.1 201 Created
Location: https://api.cre.ma/v1/users/1/user_coupons

{
  "id": 2,
  "username": "user2",
  "code": "6d28b7036e10eb46d86160f0d0fe70366e1e21b30649230e128b1bfef99e2f99",
  "issued_at": "2015-11-29T01:45:14.000+09:00",
  "expires_at": "2015-12-15T01:45:14.000+09:00",
  "used_at": null,
  "created_at": "2019-11-28T18:42:34.000+09:00",
  "updated_at": "2019-11-28T18:42:34.000+09:00"
}

Update a user coupon

쿠폰 항목의 정보를 수정합니다.

with `user_id` and `id`

PATCH /v1/users/:user_id/user_coupons/:id HTTP/1.1

이름	타입	필수	설명
`id`	integer	✔	쿠폰 항목의 `id`
`user_id`	integer	✔	회원의 크리마 `id`
`code`	string	✖	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID
`coupon_name`	string	✖	쿠폰 이름
`issued_at`	datetime(ISO 8601)	✖	쿠폰이 발행된 시간. 초단위까지만 유효
`expires_at`	datetime(ISO 8601)	✖	쿠폰이 만료되는 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 만료 시각이 존재하면 필수로 입력해야 합니다.
`used_at`	datetime(ISO 8601)	✖	쿠폰이 사용된 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 사용 시각이 존재하면 필수로 입력해야 합니다.

with `user_code` and `id`

PATCH /v1/user_coupons/:id HTTP/1.1

이름	타입	필수	설명
`id`	integer	✔	쿠폰 항목의 `id`
`user_code`	string	✔	회원의 쇼핑몰 ID
`code`	string	✖	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID
`coupon_name`	string	✖	쿠폰 이름
`issued_at`	datetime(ISO 8601)	✖	쿠폰이 발행된 시간. 초단위까지만 유효
`expires_at`	datetime(ISO 8601)	✖	쿠폰이 만료되는 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 만료 시각이 존재하면 필수로 입력해야 합니다.
`used_at`	datetime(ISO 8601)	✖	쿠폰이 사용된 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 사용 시각이 존재하면 필수로 입력해야 합니다.

with `user_id` and `code`

PATCH /v1/users/:user_id/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_id`	integer	✔	회원의 크리마 `id`
`code`	string	✔	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID
`coupon_name`	string	✖	쿠폰 이름
`issued_at`	datetime(ISO 8601)	✖	쿠폰이 발행된 시간. 초단위까지만 유효
`expires_at`	datetime(ISO 8601)	✖	쿠폰이 만료되는 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 만료 시각이 존재하면 필수로 입력해야 합니다.
`used_at`	datetime(ISO 8601)	✖	쿠폰이 사용된 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 사용 시각이 존재하면 필수로 입력해야 합니다.

with `user_code` and `code`

PATCH /v1/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_code`	string	✔	회원의 쇼핑몰 ID
`code`	string	✔	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID
`coupon_name`	string	✖	쿠폰 이름
`issued_at`	datetime(ISO 8601)	✖	쿠폰이 발행된 시간. 초단위까지만 유효
`expires_at`	datetime(ISO 8601)	✖	쿠폰이 만료되는 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 만료 시각이 존재하면 필수로 입력해야 합니다.
`used_at`	datetime(ISO 8601)	✖	쿠폰이 사용된 시간. 초단위까지만 유효 타겟 서비스를 이용하는 경우, 사용 시각이 존재하면 필수로 입력해야 합니다.

Response

HTTP/1.1 204 No Content
Location: https://api.cre.ma/v1/users/:user_id/user_coupons/:id

Delete a single user coupon

쿠폰 항목 하나를 삭제합니다.

with `user_id` and `id`

DELETE /v1/users/:user_id/user_coupons/:id HTTP/1.1

이름	타입	필수	설명
`user_id`	integer	✔	회원의 크리마 `id`
`id`	integer	✔	쿠폰 항목의 `id`

with `user_code` and `id`

DELETE /v1/user_coupons/:id HTTP/1.1

이름	타입	필수	설명
`id`	integer	✔	쿠폰 항목의 `id`
`user_code`	string	✔	회원의 쇼핑몰 ID

with `user_id` and `code`

DELETE /v1/users/:user_id/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_id`	integer	✔	회원의 크리마 `id`
`code`	string	✔	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID

with `user_code` and `code`

DELETE /v1/user_coupons HTTP/1.1

이름	타입	필수	설명
`user_code`	string	✔	회원의 쇼핑몰 ID
`code`	string	✔	쇼핑몰에서 회원에게 발급한 쿠폰의 고유 ID

Response

HTTP/1.1 204 No Content

직접 사용해 보세요!

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

회원쿠폰 목록
회원쿠폰 정보
회원쿠폰 생성
회원쿠폰 업데이트
회원쿠폰 삭제

UserCoupon API

List user coupons

with user_id

with user_code

Response

Get a single user coupon

with user_id and id

with user_code and id

with user_id and code

with user_code and code

Response

Create or Update a user coupon

with user_id

with user_code

Response

Update a user coupon

with user_id and id

with user_code and id

with user_id and code

with user_code and code

Response

Delete a single user coupon

with user_id and id

with user_code and id

with user_id and code

with user_code and code

Response

직접 사용해 보세요!

결과

with `user_id`

with `user_code`

with `user_id` and `id`

with `user_code` and `id`

with `user_id` and `code`

with `user_code` and `code`

with `user_id`

with `user_code`

with `user_id` and `id`

with `user_code` and `id`

with `user_id` and `code`

with `user_code` and `code`

with `user_id` and `id`

with `user_code` and `id`

with `user_id` and `code`

with `user_code` and `code`