시작하기
home
둘러보기
home

채널 상품

채널 상품 기준으로 작성된 API 목록입니다.
목차

1. 채널 상품 목록 조회

GET /ac/api/external/channel-products

POD SHOP 에 등록한 상품 전체 조회

Query Parameter

Name
필수여부
Type
pageNo
int
* default : 0 * 1 page = 0
pageSize
int
* default : 10
productName
String
상품 이름 검색 키워드
category
int
sort
String (ENUM)
CREATED_DATE_DESC : 최근등록일순 PRODUCT_NAME_DESC : 상품명 내림차순 PRODUCT_NAME_ASC : 상품명 오름차순 * default : CREATED_DATE_DESC
요청 예시
curl -X 'GET' 'https://dev-api.pod.shop/ac/api/external/channel-products?pageNo=0&pageSize=10' -H 'accept: application/hal+json' -H 'Authorization: Basic eyJhbGciOiJIUzI1NiJ9.eyJhcHBsaWNhdGlvbiI6ImFjIiwic3ViVHlwZSI6Ik9hdXRoQ2xpZW50RGV0YWlscyIsImNoYW5uZWxJZCI6OSwiYXBpVHlwZSI6IkVYVEVSTkFMIiwic3ViIjoiYXJ0Y2xvdWQiLCJpYXQiOjE3MDcxODY0NzIsImV4cCI6MTcwNzI3Mjg3Mn0.-Lz9du8xTSB3m59psw4UA7xp5igFytlfVOSD3XS2CV0'
Shell
복사

Response

채널 상품 정보가 담긴 객체를 배열로 응답합니다.
Name
Type
channelProductId
Number
채널상품아이디
name
String
상품명
thumbnailImage
String
썸네일 이미지
응답 예시
[ { "channelProductId":279, "name":"버튼자석 상품", "thumbnailImage":"https://dev-webling-pod-portal-web.s3.ap-northeast-2.amazonaws.com/public/product/50/버튼자석-1703126982967.jpg" }, { "channelProductId":278, "name":"ABCDEFG 오버핏 티셔츠", "thumbnailImage":"https://dev-webling-pod-portal-web.s3.ap-northeast-2.amazonaws.com/public/product/7/오버핏 티셔츠-1702628428785.jpg" } ]
JSON
복사

2. 디자인 템플릿 조회

GET /ac/api/external/channel-products/{channelProductId}/design-templates

상품에 사용가능한 디자인 템플릿 조회

Path Parameter

Name
Type
channelProductId
Number
채널상품아이디

Query Parameter

Name
필수여부
Type
pageNo
int
* default : 0 * 1 page = 0
pageSize
int
* default : 10
name
String
디자인 템플릿 이름 검색 키워드
요청 예시
curl -X 'GET' 'https://dev-api.pod.shop/ac/api/external/channel-products/96/design-templates?pageNo=0&pageSize=10' -H 'accept: application/hal+json' -H 'Authorization: Basic eyJhbGciOiJIUzI1NiJ9.eyJhcHBsaWNhdGlvbiI6ImFjIiwic3ViVHlwZSI6Ik9hdXRoQ2xpZW50RGV0YWlscyIsImNoYW5uZWxJZCI6OSwiYXBpVHlwZSI6IkVYVEVSTkFMIiwic3ViIjoiYXJ0Y2xvdWQiLCJpYXQiOjE3MDcyODk2MzUsImV4cCI6MTcwNzM3NjAzNX0.Vwts5RFiTOLrjhc0iJNTjC8Heegp9WwUkHRCovvtrZM'
Shell
복사

Response

디자인 템플릿 정보가 담긴 객체를 배열로 응답합니다.
Name
Type
designTemplateId
Number
디자인 템플릿 ID
designTemplateName
String
디자인 템플릿 명
thumbnailImage
String
썸네일 이미지
createdBy
String
생성자
응답 예시
[ { "designTemplateId": 1821, "designTemplateName": "(오픈) 스냅스 착한 반팔 티셔츠 [조합테스트]", "thumbnailImageUrl": "https://dev-cdn.pod.shop/9/design/templates/2024/1/1821/1821_thumbnail", "createdBy": "channelmanager@channel.com" }, { "designTemplateId": 1009, "designTemplateName": "(오픈) 오프린트미 피그먼트 맨투맨(남여공용) [피그먼트 썸네일 테스트]", "thumbnailImageUrl": "https://dev-cdn.pod.shop/9/design/templates/2024/1/1009/1009_thumbnail", "createdBy": "channelmanager@channel.com" } ]
JSON
복사

3. 채널 상품 카테고리

GET /ac/api/external/channel-products/categories

상품 조회 API이용시에 카테고리별(categoryId) 조회시 이용

Path Parameter

Name
필수여부
Type
inUseOnly
Boolean
사용중인 카테고리만 응답시 true
요청 예시
curl -X 'GET' 'https://dev-api.pod.shop/ac/api/external/channel-products/categories' -H 'accept: application/hal+json' -H 'Authorization: Basic YXJ0Y2xvdSDFWQ6SlFVTzJqTUlwQVYsdwM3JyOUh3MfdD1BCbXJHclF3QXRoUUo='
Shell
복사

Response

카테고리 정보가 담긴 객체를 배열로 응답합니다.
Name
Type
id
Number
카테고리ID
categoryName
String
카테고리명
path
String
카테고리 Path * 카테고리의 계층 구조에 따른 Path * 참고 “달력” 카테고리 ID = 2 “우드블럭 달력” 카테고리ID = 6 ⇒ “달력” path = “2” “우드블럭 달력” = “2.6”
응답 예시

4. 채널 상품 안내

GET /ac/api/external/channel-products/{channelProductId}

상품의 안내, 고시, 이미지 정보 제공

Path Parameter

Name
Type
channelProductId
Number
채널상품아이디
요청 예시
curl -X 'GET' 'https://dev-api.pod.shop/ac/api/external/channel-products/791' -H 'accept: application/hal+json' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhcHBsaWNhdGlvbiI6ImFjIiwic3ViVHlwZSI6Ik9hddfXRoQ2xpZW50RGV0YWlscyIsImNsoYW5uZdsWxJZCI6NDIsImFwaVR5cGUiOiJFWFQiLCJleHRUeXBlIjoiQ0xJRU5UIiwic3ViIjoiYW54YmRrd3ZveGN1IiwiaWF0IjoxNzE4MjQwOTYxLCJleHAiOjE3MTgyNDgxNjF9.ndf1xYd_3Iw1BLiJlNuHkqvzrhfYhUKWvV6uYTUEURA-o'
Shell
복사

Response

상품정보가 담긴 객체가 응답합니다
Name
Type
channelProductId
Number
채널상품아이디
channelProductName
String
채널상품명
channelProductNames
Map
채널상품명(다국어객체)
primaryImage
String
대표이미지 URL
frontImage
String
앞면이미지 URL
backImage
String
뒷면이미지 URL
additionalImages
Array
추가이미지정보 객체(additionalImages)
descriptions
Map
안내(다국어객체) * base64로 인코딩된 HTML코드
notice
Map
고시(다국어객체) * base64로 인코딩된 HTML코드
Multilingualism
Key
Value Type
KO
String
한국어 value
EN
String
영어 value
JA
String
일어 value
additionalImage
Name
Type
image
String
이미지 URL
name
Stirng
이미지 명
localizedNames
Map
이미지명 (다국어객체)
응답 예시
{ "channelProductId": 791, "channelProductName": "위블링", "channelProductNames": { "EN": "Webling", "JA": "Webling", "KO": "위블링" }, "productSaleStatus": "IN_SALE", "descriptions": { "JA": "PGh0bWw+CiA8aGVhZD48L2hlYWQ+CiA8Ym9keT48L2JvZHk+CjwvaHRtbD4=", "EN": "PGh0bWw+CiA8aGVhZD48L2hlYWQ+CiA8Ym9keT48L2JvZHk+CjwvaHRtbD4=", "KO": "PGh0bWw+CiA8aGVhZD48L2hlYWQ+CiA8Ym9keT4KICA8cD7qsIDrgpjri6Trnbzrp4jrsJTsgqw8L3A+CiAgPHA+QVNEYWRBRDwvcD4KIDwvYm9keT4KPC9odG1sPg==" }, "primaryImage": "https://dev-webling-pod-portal-web.s3.ap-northeast-2.amazonaws.com/public/product/62/pod_hoodie_mtm_10-1713247997242.jpg", "frontImage": "https://prd-webling-pod-portal-web.s3.ap-northeast-2.amazonaws.com/public/product/62/데일리후드1-1702969528262.jpg", "backImage": "https://prd-webling-pod-portal-web.s3.ap-northeast-2.amazonaws.com/public/product/62/데일리후드_2-1702969535489.jpg", "additionalImages": [ { "id": 275, "image": "https://dev-webling-pod-portal-web.s3.ap-northeast-2.amazonaws.com/public/product/62/api doc cover-1718241918872.png", "localizedNames": { "JA": "imageTest", "EN": "imageTest", "KO": "추가이미지 테스트" }, "name": "추가이미지 테스트" } ], "notice": { "JA": "PGh0bWw+CiA8aGVhZD48L2hlYWQ+CiA8Ym9keT4KICA8cD48YnI+PC9wPgogPC9ib2R5Pgo8L2h0bWw+", "EN": "PGh0bWw+CiA8aGVhZD48L2hlYWQ+CiA8Ym9keT4KICA8cD5hPC9wPgogPC9ib2R5Pgo8L2h0bWw+", "KO": "PGh0bWw+CiA8aGVhZD48L2hlYWQ+CiA8Ym9keT4KICA8cD7soJztkogg7IaM7J6s66m0IDYwJSDtj7Trpqzsl5DsiqTthLAgNDAl7IOJ7IOB67iU656ZLOyVhOydtOuztOumrCzrhKTsnbTruYQs6re466CI7J20LOyYpO2KuOuwgOy5mOyImFMg7LSd7J6lIDY4Y23slrTquajrhIjruYQgNTljbSDqsIDsirTri6jrqbQoMeyduOy5mCDslYTrnpgpIDU3Y20gLCDrsJHri6gg64uo66m0IDogNDNjbSAsIOyGjOunpOq4sOyepSA6IDU4Y208L3A+CiAgPHA+TSDstJ3snqUgNzBjbSAsIOyWtOq5qOuEiOu5hCA2MWNtIOqwgOyKtOuLqOuptCgx7J247LmYIOyVhOuemCkgNTljbSAsIOuwkeuLqCDri6jrqbQgOiA0NWNtICwg7IaM66ek6riw7J6lIDogNTljbTwvcD4KICA8cD5MIOy0neyepSA3MmNtICwg7Ja06rmo64SI67mEIDYzY20g6rCA7Iq064uo66m0KDHsnbjsuZgg7JWE656YKSA2MWNtICwg67CR64uoIOuLqOuptCA6IDQ3Y20gLCDshozrp6TquLDsnqUgOiA2MGNtPC9wPgogIDxwPlhMIOy0neyepSA3NGNtICwg7Ja06rmo64SI67mEIDY1Y20g6rCA7Iq064uo66m0KDHsnbjsuZgg7JWE656YKSA2M2NtICwg67CR64uoIOuLqOuptCA6IDQ5Y20gLCDshozrp6TquLDsnqUgOiA2MWNtPC9wPgogIDxwPjJYTCDstJ3snqUgNzVjbSAsIOyWtOq5qOuEiOu5hCA2N2NtIOqwgOyKtOuLqOuptCgx7J247LmYIOyVhOuemCkgNjVjbSAsIOuwkeuLqCDri6jrqbQgOiA1MWNtICwg7IaM66ek6riw7J6lIDogNjEuNWNtJm5ic3A7PC9wPgogIDxwPuygnOyhsOyekCwg7IiY7J6F7ZKI7J2YIOqyveyasCDsiJjsnoXsnpDrpbwg7ZWo6ruYIO2RnOq4sCjso7wp7JyE67iU66eB7KCc7KGw6rWt67Kg7Yq464Ko7IS47YOB67Cp67KVIOuwjyDst6jquInsi5wg7KO87J2Y7IKs7ZWtW+yEuO2DgSDrsKnrspVdPC9wPgogIDxwPi0g65Kk7KeR7Ja07IScIOywrOusvOyXkCDri6jrj4XshLjtg4HtlZjshLjsmpQuPC9wPgogIDxwPi0g7YOI7IiY6rCAIO2VhOyalO2VoCDqsr3smrAg7IaQ7Jy866GcIOyVve2VmOqyjCDsp5zshLjsmpQuIOqwle2VmOqyjCDruYTti4DqsbDrgpgg7KWQ7Ja07Kec7KeAIOuniOyEuOyalC48L3A+CiAgPHA+LSDri6Trprzsp4jsnYQg6riI7KeA7ZWp64uI64ukLiDtlYTsmpTsi5wg7LKc7J2EIOuMgOqzoCDslb3tlZjqsowg64uk66a87KeIIO2VmOyEuOyalC48L3A+CiAgPHA+LSDsl7zshowg7ZGc67Cx7KCcIOuYkOuKlCDsgrDshowg7ZGc67Cx7KCcIOyCrOyaqeydhCDquIjsp4Dtlanri4jri6QuPC9wPgogIDxwPi0g6rG07KGw6riwIOyCrOyaqeydhCDquIjsp4DtlZjrqbAsIOyemCDtjrTshJwg6re464qY7JeQIOqxtOyhsO2VtCDso7zshLjsmpQuPC9wPgogIDxwPi0g65Oc65287J20IO2BtOumrOuLneydhCDquIjsp4Dtlanri4jri6QuPC9wPgogIDxwPjxicj48L3A+CiAgPHA+W+y3qOq4ieyLnCDso7zsnZgg7IKs7ZWtXTwvcD4KICA8cD4tIOygnO2SiOydmCDsg4nsg4Eg67CPIOyCrOydtOymiOuKlCDsoJzsnpEg7Iuc6riwL+yDneyCsCDsi5zspozsl5Ag65Sw6528IOyVveqwhOydmCDssKjsnbTqsIAg7J6I7J2EIOyImCDsnojsirXri4jri6QuJm5ic3A7PC9wPgogIDxwPi0g7ZSE66aw7YyFIOuwqeyLnSDrsI8g7JuQ64uo7JeQIOuUsOudvCDstpzroKXrrLzsnZgg7IOJ7IOB7J20IOyhsOq4iCDri6TrpbTqsowg7ZGc7ZiE65CgIOyImCDsnojsnLzrqbAsIOuqqOuLiO2EsCDtmZTrqbQo6riw6riwKeyXkCDrlLDrnbwg7IOJ7IOB7J20IOuLpOultOqyjCDrs7Tsnbwg7IiYIOyeiOyKteuLiOuLpC4mbmJzcDs8L3A+CiAgPHA+LSDrjIDrtoDrtoQg7IiY7J6R7JeF7Jy866GcIOydtOujqOyWtOyngOuKlCDsnbjsh4Qg67Cp7IudIO2KueyEseyDgSDsnbjsh4Qg7JyE7LmY7JmAIO2BrOq4sOyXkCDslb3qsITsnZgg7Jik7LCo6rCAIOuwnOyDne2VoCDsiJgg7J6I7Jy866mwLCDsnbTroZwg7J247ZWcIOq1kO2ZmC/tmZjrtojsnYAg67aI6rCA7ZWp64uI64ukLjwvcD4KICA8cD4tIOupnOuegOyngCDsm5Dri6jsnZgg7Yq57ISx7IOBIOybkOuLqCDsgqzsmqkg67aA7JyE7JmAIOyjvOusuCDsi5zsoJDsl5Ag65Sw6528IOuqqOyWkeydtCDri6Trpbwg7IiYIOyeiOyKteuLiOuLpC4gKOq3uOugiOydtCDsu6zrn6wg7KO866y4IOyLnCDtlbTri7kpPC9wPgogIDxwPuygnOyhsOyXsOyblCZuYnNwO+2SiOyniOuztOymneq4sOykgCDrs7gg7KCc7ZKI7J2AIE9IIFBSSU5ULiBNRSBRdWFsaXR5IEFzc3VyYW5jZeydmCDsl4TqsqntlZwg7ZKI7KeI6rKA7IKs66W8IO2GteqzvO2VmOyYgOqzoCDrnbzsnbTshKDsiqTrpbwg67O07Kad7ZWp64uI64ukLjwvcD4KICA8cD7rs7gg7KCc7ZKI7J2YIO2SiOyniOyXkCDsnbTsg4HsnbQg7J6I7Jy87IukIOqyveyasCDsiJjroLnsnbzroZzrtoDthLAgN+ydvCDsnbTrgrTsl5AgMTAwJSDsnqzsoJzsnpEg65iQ64qUIO2ZmOu2iCDqsIDriqXtlanri4jri6QuQS9TIOyxheyehOyekOyZgCDsoITtmZTrsojtmLgmbmJzcDsxNTc3LTQ3MDM8L3A+CiAgPHA+Jm5ic3A7PC9wPgogPC9ib2R5Pgo8L2h0bWw+" } }
JSON
복사

notice / descriptions 의 경우 Base64로 디코딩 후 이용 바랍니다

응답 데이터
PGh0bWw+CiA8aGVhZD48L2hlYWQ+CiA8Ym9keT4KICA8cD7qsIDrgpjri6Trnbzrp4jrsJTsgqw8L3A+CiAgPHA+QVNEYWRBRDwvcD4KIDwvYm9keT4KPC9odG1sPg==
Shell
복사
Base64 디코딩
<html> <head></head> <body> <p>가나다라마바사</p> <p>ASDadAD</p> </body> </html>
Shell
복사
터미널 예시
[터미널 디코드 예시] > echo 'PGh0bWw+CiA8aGVhZD48L2hlYWQ+CiA8Ym9keT4KICA8cD7qsIDrgpjri6Trnbzrp4jrsJTsgqw8L3A+CiAgPHA+QVNEYWRBRDwvcD4KIDwvYm9keT4KPC9odG1sPg' | base64 -d
Shell
복사

5. 판매 가능한 채널 상품 목록 조회

GET /ac/api/external/channel-products/saleable

POD SHOP 에 등록하고 디자인 템플릿과 연동된 판매 가능한 채널 상품 전체 조회

Query Parameter

Name
필수여부
Type
pageNo
int
* default : 0 * 1 page = 0
pageSize
int
* default : 10
productName
String
상품 이름 검색 키워드
category
int
카테고리 ID 3. 채널 상품 카테고리 참고
sort
String (ENUM)
CREATED_DATE_DESC : 최근등록일순 PRODUCT_NAME_DESC : 상품명 내림차순 PRODUCT_NAME_ASC : 상품명 오름차순 * default : CREATED_DATE_DESC
요청 예시
curl -X 'GET' 'https://dev-api.pod.shop/ac/api/external/channel-products?pageNo=0&pageSize=10' -H 'accept: application/hal+json' -H 'Authorization: Basic eyJhbGciOiJIUzI1NiJ9.eyJhcHBsaWNhdGlvbiI6ImFjIiwic3ViVHlwZSI6Ik9hdXRoQ2xpZW50RGV0YWlscyIsImNoYW5uZWxJZCI6OSwiYXBpVHlwZSI6IkVYVEVSTkFMIiwic3ViIjoiYXJ0Y2xvdWQiLCJpYXQiOjE3MDcxODY0NzIsImV4cCI6MTcwNzI3Mjg3Mn0.-Lz9du8xTSB3m59psw4UA7xp5igFytlfVOSD3XS2CV0'
Shell
복사

Response

채널 상품 정보가 담긴 객체를 배열로 응답합니다.
Name
Type
channelProductId
Number
채널상품아이디
name
String
상품명
thumbnailImage
String
썸네일 이미지
응답 예시
[ { "channelProductId":279, "name":"버튼자석 상품", "thumbnailImage":"https://dev-webling-pod-portal-web.s3.ap-northeast-2.amazonaws.com/public/product/50/버튼자석-1703126982967.jpg" }, { "channelProductId":278, "name":"ABCDEFG 오버핏 티셔츠", "thumbnailImage":"https://dev-webling-pod-portal-web.s3.ap-northeast-2.amazonaws.com/public/product/7/오버핏 티셔츠-1702628428785.jpg" } ]
JSON
복사