SubBrand API

CREMA 서버에 등록된 하위 브랜드 정보를 확인하고, 등록/수정하는 방법을 제공합니다.

List sub_brands

하위 브랜드 목록을 가져옵니다.

GET /v1/sub_brands HTTP/1.1

Parameters

이름 타입 필수 설명
limit integer ✖ 한 페이지의 하위 브랜드 목록 길이. 범위: 1 ~ 100. 기본: 30
page integer ✖ 페이지 번호. 최대 페이지 수는 Link HTTP header의 rel="last"에 기재되어 있습니다. 기본: 1

Response

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

[
  {
    "id": 1,
    "code": "001",
    "name": "하위 브랜드 01",
    "created_at": "2018-10-24T11:59:56.000+09:00",
    "updated_at": "2018-10-24T11:59:56.000+09:00"
  },
  {
    "id": 1,
    "code": "002",
    "name": "하위 브랜드 02",
    "created_at": "2018-10-24T14:59:56.000+09:00",
    "updated_at": "2018-10-24T14:59:56.000+09:00"
  }
]

Get a single sub_brand

하위 브랜드 하나의 상세 정보를 가져옵니다.

with id

GET /v1/sub_brands/:id HTTP/1.1
이름 타입 필수 설명
id integer ✔ 하위 브랜드 id

with code

GET /v1/sub_brands HTTP/1.1
이름 타입 필수 설명
code string ✔ 하위 브랜드 코드

Response

HTTP/1.1 200 OK

{
  "id": 1,
  "code": "001",
  "name": "하위 브랜드 01",
  "created_at": "2018-10-24T11:59:56.000+09:00",
  "updated_at": "2018-10-24T11:59:56.000+09:00"
}

Create or Update a sub_brand

새로운 하위 브랜드를 생성하거나 기존 데이터를 수정합니다.

POST /v1/sub_brands HTTP/1.1

Parameters

이름 타입 필수 설명
code string ✔ 하위 브랜드 코드
name string ✔ 하위 브랜드명

Response

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

{
  "id": 1,
  "code": "001",
  "name": "하위 브랜드 01",
  "created_at": "2018-10-24T11:59:56.000+09:00",
  "updated_at": "2018-10-24T11:59:56.000+09:00"
}

Update a sub_brand

하위 브랜드를 수정합니다.

with id

PATCH /v1/sub_brands/:id HTTP/1.1
이름 타입 필수 설명
id string ✔ 하위 브랜드 id
code string ✖ 하위 브랜드 코드
name string ✖ 하위 브랜드명

with code

PATCH /v1/sub_brands HTTP/1.1
이름 타입 필수 설명
code string ✔ 하위 브랜드 코드
name string ✖ 하위 브랜드명

Response

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

Delete a sub_brand

하위 브랜드 하나를 삭제합니다.

with id

DELETE /v1/sub_brands/:id HTTP/1.1
이름 타입 필수 설명
id integer ✔ 하위 브랜드 id

with code

DELETE /v1/sub_brands HTTP/1.1
이름 타입 필수 설명
code string ✔ 하위 브랜드 코드

Response

HTTP/1.1 204 No Content

직접 사용해 보세요!

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

결과