본 포스트 시리즈는 Joom for Merchants API의 공식 레퍼런스를 번역한 문서입니다.
(출처: https://api-v3-docs.merchant.joom.com/)
Joom API v2 포스트 시리즈와는 별개의 시리즈 입니다. 읽으실때 혼동 없으시길 바랍니다.
Products 개요
이 섹션은 Product 관련 작업을 위한 모든 엔드 포인트를 다룹니다.
ID 및 SKU
Product SKU 및 Variation SKU는 판매자가 직접 생성한 Product 및 Variation에 대한 고유 식별자 입니다.
- 각 Product SKU는 모든 판매자의 Product SKU와 겹치면 안됩니다
- 각 Variation SKU는 모든 판매자의 Variation SKU와 겹치면 안됩니다
- Product SKU는 Variation SKU와 겹칠 수 있습니다.
예: Product에 Variation이 하나만 있는 경우 유사한 SKU를 제공할 수 있습니다.
Joom Product ID 및 Variation ID는 Joom에서 생성한 Product 및 Variation의 고유 식별자 입니다. (단지 정보용으로 표시됩니다.)
Product 및 Variation에 대한 모든 작업은 SKU만 사용하여 수행할 수 있습니다. 하지만 Joom ID를 선호 할 수도 있습니다.
참고: Joom Store ID도 중요합니다. 새 Product를 생성할 때 Joom Store ID를 지정해야합니다.
Product 상태
각 Product는 최신 변경사항(일종의 초안)을 반영하는 현재 버전과 승인 된(게시 된) 버전의 두가지 버전으로 존재합니다. 게시 된 버전만 고객에게 표시될 수 있습니다.
이 hasActiveVersion 필드는 Product에 현재 고객이 사용할 수있는 버전이 있는지 여부를 반영합니다. 이 state 필드는 현재 버전의 상태를 반영합니다.
| No. | 상태 | 의미 |
| 1 | active | 이 Product 버전은 승인되고 활성화되었습니다 (고객에게 제공됨.) |
| 2 | warning | 이 버전의 Product는 활성화되었지만 판매자의 주의가 필요할 수 있습니다. |
| 3 | pending | 이 Product 버전은 활성화되지 않았으며 Joom의 확인을 기다리고 있습니다. 판매자의 조치가 필요하지 않습니다. 이전 승인 버전이 활성화되었을 수 있습니다. |
| 4 | rejected | 이 Product 버전은 활성화 상태가 아닙니다. 판매자는 문제를 해결해야할 것으로 예상됩니다. 이전 승인 버전이 활성화되었을 수 있습니다. |
| 5 | disabledByJoom | 이 Product는 Joom에 의해 완전히 비활성화되었으며 고객이 이용할 수 없습니다. 이것은 Joom이 Product의 스토어를 비활성했을 때 발생합니다. |
| 6 | disabledByMerchant | 판매자가 Product를 완전히 비활성화 했으며 고객이 사용할 수 없습니다. 이는 판매자가 Product의 상점을 비활성화 한 경우에도 발생합니다 |
| 7 | locked | Product에 대한 모든 변경 사항은 잠금이 해제될 때까지 연기됩니다. 이는 Product가 프로모션에 참여할 때 발생합니다. 이전 승인버전이 활성화되었을 수 있습니다. |
| 9 | archived | Product가 제거됩니다. 일반적으로 제거된 Product는 판매자에게 표시되지 않지만 기술적인 지연으로 인해 API에 계속 나타날 수 있으므로 이 상태를 사용하는 것이 좋습니다. 이 상태의 제품은 존재하지 않는 것으로 무시 될 수 있습니다. |
엔드 포인트 개요
이 API 문서를 사용하는 기본 시나리오에서 판매자는 다음을 수행할 수 있습니다.
- Product의 생성 및 업데이트
- Joom ID 또는 판매자의 SKU로 특정 Product 검색
- 타임스탬프를 업테이트하여 Product 배치를 검색
- Product 제거 및 Variation 제거와 같은 고급 작업
- 일부 ERP는 Joom 색상 및 범주 목록을 사용자에게 제공하고 있으며 이러한 경우에도 엔드 포인트있습니다.
Joom 도움말 센터에서 Product 요구 사항 및 카테고리 Product 요구사항에 대해 자세히 알아보세요 .
Product 생성
POST /products/create
새 Product를 생성합니다.
필수가 아닌 필드는 생략할 수 있습니다
(null , "" 또는 false 와 같은 기본값을 보낼 필요가 없습니다.)
기존 Product에 새로운 Variation을 추가하기 위해선 Product 업데이트 엔드 포인트를 사용하세요
반환 값
- 새로 생성된 Product를 반환합니다.
Request Body Schema
Responses Schema
Variation을 가진 Product의 Schema입니다.
Product 업데이트
POST /products/update
기존 Product를 업데이트합니다. id 또는 sku 하나를 지정해야만 합니다.
이 엔드 포인트는 PATCH 엔드 포인트처럼 작동합니다.
- request body에 일부 필드를 보내지 않으면, 그 필드는 업데이트 되거나 제거되지 않습니다.
- 변경하지 않으려는 Variation은 생략할 수 있습니다.
- 새 SKU의 Variation은 새로 생성되고 Product에 추가됩니다. 기존 SKU의 Variation은 업데이트 됩니다.
- 변경하려는 필드만 보내고 변경하지 않으려는 필드는 생략할 수 있습니다. 예를 들어 Product의 이름만 변경하려는 경우 request body는 { "name" : "My New Name" } 처럼 작성하면 됩니다.
- 만약 어떤 필드에 명시적으로 null 값을 보낸다면, 그 필드는 기본값/비어있는값으로 설정될 것입니다. 몇몇 필드들은 기본값이 필요없는 경우가 있는데(예: currency), 이들에겐 null 값을 보내면 안됩니다.
반환 값
- 업데이트 된 Product를 반환합니다
Request GET 파라미터
Request Body Schema
Responses Schema
Product 단일 검색
GET /products
단일 Product를 검색합니다. id 또는 sku 하나를 지정해야만 합니다.
반환 값
- 요청한 Product를 반환합니다.
Request GET 파라미터
Responses Schema
Product 다중 검색
GET /Products/multi
쿼리에 충족하는 Product들을 검색합니다.
일반적으로 정기적인 검토가 필요한 Product들의 정보(예: 재고 소진 여부)를 검색하려면 이 엔드 포인트를 사용하십시오.
updatedFrom 파라미터를 사용하여 time window를 제한하세요.
반환 값
- 요청 된 Product 목록과 필요한 경우 페이징 옵션이 있는 paging 필드가 반환됩니다.
- Joom API의 Pagination에 대한 자세한 내용 Pagination 개요를 참조하십시오 .
(번역자 주석: Pagination에 관한 레퍼런스 번역 포스트도 업로드 예정입니다
추후 올라올 해당 포스트를 참조하셔도 됩니다.)
Request GET 파라미터
Responses Schema
Product 제거
POST /products/remove
Product를 제거합니다. id 또는 sku 하나를 지정해야만 합니다.
Product의 모든 Variation들 또한 함께 제거되므로 별도로 제거해야할 필요가 없습니다.
주의
- 제거된 Product는 복원할 수 없습니다.
- 더 이상 재고가 없는 Product만 제거하십시오. 일시적으로 비활성화시킨 Product들에 이 엔드포인트를 절대 사용하지 마세요.
Request GET 파라미터
Responses Schema
Product Variations 제거
POST /products/removeVariations
지정된 Product의 Variation들을 제거합니다. Product를 식별하는 쿼리 파라미터에 id 또는 sku 를 지정해야만 합니다.
한 번의 호출로 단일 Product의 몇몇 Variation들을 제거할 수 있습니다. 제거 할 각 Variation의 경우 request body에 id 또는 sku 를 명시해야합니다.
Product의 모든 Variation을 제거할 수는 없습니다. Product의 전체를 제거하려면 Product 제거 엔드포인트를 사요하세요
주의
- 제거된 Variation들은 복원할 수 없습니다.
- 더 이상 재고가 없는 Variaiton들만 제거하십시오. 일시적으로 비활성화시킨 Variations에는 이 엔드 포인트를 절대 사용하지 마세요.
반환 값
- 업데이트 된 Product를 반환합니다.
Request GET 파라미터
Request Body Schema
Responses Schema
Product Store 변경
POST /products/changeStore
Product의 store를 변경합니다. id 또는 sku 하나를 지정해야만 합니다.
특수조건
- Joom에 의해 비활성화 된 상점 간에 Product를 이동할 수 없습니다.
반환 값
- 업데이트된 Product를 반환합니다
Request GET 파라미터
Request Body Schema
모든 Product 색상 검색
GET /productColors
Joom 에서 허용하는 모든 Product 색상을 검색합니다.
반환 값
- Joom에서 허용하는 모든 Product 색상의 목록을 반환합니다.
Response Schema
모든 Product 카테고리 검색
GET /productCategories
모든 Joom Product 카테고리를 검색합니다.
반환 값
- 모든 Joom Product 카테고리 리스트를 반환합니다.
Response Schema
'SW > Joom API' 카테고리의 다른 글
| [Joom API v3] 1. Getting Started (0) | 2021.11.21 |
|---|---|
| [Joom API v2] 3. Product (0) | 2021.11.21 |
| [Joom API v2] 2. Joom OAuth (0) | 2021.11.21 |
| [Joom API v2] 1. Getting Started (0) | 2021.11.21 |