1. 주문 등록
POST /ac/api/external/orders
주문을 등록합니다
Body Parameter
Name | 필수여부 | Type | |
orders | Y | Array | 주문 객체(order) 배열 |
•
order
Name | 필수여부 | Type | |
orderCode | Y | String | 주문번호(고객사 스토어)
* 주문에 대해 유니크한 고객사 스토어 키값 |
storeCustomerId | Y | String | 주문자
* 고객사 주문자 유니크 키값 |
orderEntries | Y | Array | 주문 상품(프로젝트) 배열
* 주문 프로젝트(entry) |
shippingAddress | Y | Object | 배송지 정보
* 주소 객체(address) |
◦
entry
Name | 필수여부 | Type | |
projectId | Y | Number | 상품 번호
* channelProductId / designTemplateId / channelOptionVariantId 를 이용해 획득한 상품 고유 ID |
quantity | Y | Number | 주문수량 |
productSellPrice | Y | Array | 판매금액 |
◦
address
Name | 필수여부 | Type | |
recipient | Y | String | 받는사람 |
postcode | Y | String | 우편번호 |
address | Y | String | 주소 1 |
addressDetail | Y | String | 주소 2 |
phoneNumber | Y | String | 수신자 전화번호 |
nationCode | Y | String | * default : KR |
•
요청예시
curl --location 'https://dev-api.pod.shop/ac/api/external/orders' --header 'Authorization: [인증코드]' --header 'Content-Type: application/json' --data '{
"orders": [
{
"orderCode": "20240226000000001",
"storeCustomerId": "jun",
"shippingAddress": {
"address": "서울 영등포구 여의대로 24",
"addressDetail": "21층",
"nationCode": "KR",
"phoneNumber": "010-1234-1234",
"postcode": "12345",
"recipient": "요"
},
"orderEntries": [
{
"projectId": "10302",
"quantity": 3,
"productSellPrice": 8800
},
{
"projectId": "10303",
"quantity": 2,
"productSellPrice": 36300
}
]
}
,{
"orderCode": "20240226000000002",
"storeCustomerId": "jun",
"shippingAddress": {
"address": "서울 영등포구 여의대로 24",
"addressDetail": "21층",
"nationCode": "KR",
"phoneNumber": "010-1234-1234",
"postcode": "12345",
"recipient": "요"
},
"orderEntries": [
{
"projectId": "10302",
"quantity": 3,
"productSellPrice": 8800
},
{
"projectId": "10303",
"quantity": 2,
"productSellPrice": 36300
}
]
}
]
}'
Shell
복사
Response
•
주문 정보가 담긴 객체를 배열로 응답합니다.
Name | Type | |
orderId | Number | 주문번호 |
channelName | String | 주문 채널명 |
orderCode | String | 주문번호(고객사 스토어) |
storeCustomerId | String | 주문자
* 고객사 주문자 유니크 키값 |
orderStatus | Enum
(String) | IN_PRODUCTION : 주문 처리중
WAITING_FOR_SHIPPING : 포장 완료
SHIPPED : 발송완료
IN_DELIVERY : 배송중
DELIVERY_COMPLETED : 배송완료 |
estimatedShippingDate | String | 발송예정일
* YYYY-MM-DD |
totalPaymentAmount | Number | 주문 총액 |
orderEntries | Array
(Object) | 주문 상품(프로젝트) 배열
* 주문 프로젝트(entry) |
shippingAddress | Object | 배송지 정보
* 주소 객체(address) |
•
entry
Name | Type | |
orderEntryId | Number | 주문상세번호 |
projectId | Number | 상품 번호
* channelProductId / designTemplateId / channelOptionVariantId 를 이용해 획득한 상품 고유 ID |
quantity | Number | 주문수량 |
productSellPrice | Array | 판매금액 |
status | Enum
(String) | IN_PRODUCTION제작중
DELIVERY_COMPLETED배송완료
IN_DELIVERY배송중 |
thumbnailImageUrl | String | 썸네일 이미지 URL |
productName | String | 상품명 |
designTemplateName | String | 디자인 템플릿 명 |
optionValueString | String | 선택 옵션 정보 |
•
address
Name | Type | |
recipient | String | 받는사람 |
postcode | String | 우편번호 |
address | String | 주소 1 |
addressDetail | String | 주소 2 |
phoneNumber | String | 수신자 전화번호 |
nationCode | String | * default : KR |
•
응답 예시
[
{
"orderId": 476,
"channelName": "JunTestChannel-자사몰",
"orderCode": "20240226000000003",
"storeCustomerId": "jun",
"orderStatus": "RECEIVED",
"orderEntries": [
{
"projectId": 10302,
"quantity": 3,
"status": "IN_PRODUCTION",
"productSellPrice": 8800,
"thumbnailImageUrl": "https://dev-cdn.pod.shop/60/projects/2024/2/10304/10304_thumbnail_20240223081714532_blob",
"productName": "버튼거울 58, 75 무유광",
"designTemplateName": "58 75 사이즈",
"optionValueString": "NORMAL/원형/75X75/무광"
},
{
"projectId": 10303,
"quantity": 2,
"status": "IN_PRODUCTION",
"productSellPrice": 36300,
"thumbnailImageUrl": "https://dev-cdn.pod.shop/60/projects/2024/2/10305/10305_thumbnail_20240223081731933_blob",
"productName": "아메30수 반팔여 - S-M-L - 앞-뒤-목뒤 - AllColor",
"designTemplateName": "아메반팔여 MSL 앞뒤목",
"optionValueString": "앞면-뒷면-목뒤/디지털Plus/블랙/M"
}
],
"estimatedShippingDate": "2024-02-29",
"shippingAddress": {
"recipient": "요",
"postcode": "12345",
"address": "서울 영등포구 여의대로 24",
"addressDetail": "21층",
"nationCode": "KR",
"phoneNumber": "010-1234-1234"
},
"totalPaymentAmount": 99000
},
{
"orderId": 477,
"channelName": "JunTestChannel-자사몰",
"orderCode": "20240226000000004",
"storeCustomerId": "jun",
"orderStatus": "RECEIVED",
"orderEntries": [
{
"projectId": 10302,
"quantity": 3,
"status": "IN_PRODUCTION",
"productSellPrice": 8800,
"thumbnailImageUrl": "https://dev-cdn.pod.shop/60/projects/2024/2/10304/10304_thumbnail_20240223081714532_blob",
"productName": "버튼거울 58, 75 무유광",
"designTemplateName": "58 75 사이즈",
"optionValueString": "NORMAL/원형/75X75/무광"
},
{
"projectId": 10303,
"quantity": 2,
"status": "IN_PRODUCTION",
"productSellPrice": 36300,
"thumbnailImageUrl": "https://dev-cdn.pod.shop/60/projects/2024/2/10305/10305_thumbnail_20240223081731933_blob",
"productName": "아메30수 반팔여 - S-M-L - 앞-뒤-목뒤 - AllColor",
"designTemplateName": "아메반팔여 MSL 앞뒤목",
"optionValueString": "앞면-뒷면-목뒤/디지털Plus/블랙/M"
}
],
"estimatedShippingDate": "2024-02-29",
"shippingAddress": {
"recipient": "요",
"postcode": "12345",
"address": "서울 영등포구 여의대로 24",
"addressDetail": "21층",
"nationCode": "KR",
"phoneNumber": "010-1234-1234"
},
"totalPaymentAmount": 99000
}
]
JSON
복사
2. 주문 단건 조회
GET /ac/api/external/orders/{orderCode}
고객사 스토어 주문번호를 이용해 주문 정보를 조회 합니다.
Path Parameter
Name | Type | |
orderCode | String | 주문번호(고객사 스토어)
* 주문에 대해 유니크한 고객사 스토어 키값
|
•
요청예시
curl --location --request GET 'https://dev-api.pod.shop/ac/api/external/orders/20240226000000004' --header 'Authorization: Basic dnJkanZjcWpsa2psafoOjBKbExSMFZ1sdsTEV0MU5VaEpEY1FsdafzNzhSR0EzYjQwTjFR'
--header 'Content-Type: application/json'
Shell
복사
Response
•
주문 정보가 담긴 객체를 응답합니다.
Name | Type | |
orderId | Number | 주문번호 |
channelName | String | 주문 채널명 |
orderCode | String | 주문번호(고객사 스토어) |
storeCustomerId | String | 주문자
* 고객사 주문자 유니크 키값 |
orderStatus | Enum
(String) | IN_PRODUCTION : 주문 처리중
WAITING_FOR_SHIPPING : 포장 완료
SHIPPED : 발송완료
IN_DELIVERY : 배송중
DELIVERY_COMPLETED : 배송완료 |
estimatedShippingDate | String | 발송예정일
* YYYY-MM-DD |
totalPaymentAmount | Number | 주문 총액 |
orderEntries | Array
(Object) | 주문 상품(프로젝트) 배열
* 주문 프로젝트(entry) |
shippingAddress | Object | 배송지 정보
* 주소 객체(address) |
isDeliveryDelay | Boolean | true: 지연, false : 징상 |
•
entry
Name | Type | |
projectId | Number | 상품 번호
* channelProductId / designTemplateId / channelOptionVariantId 를 이용해 획득한 상품 고유 ID |
quantity | Number | 주문수량 |
productSellPrice | Array | 판매금액 |
status | Enum
(String) | IN_PRODUCTION제작중
SHIPPED 발송완료
DELIVERY_COMPLETED배송완료
IN_DELIVERY배송중 |
thumbnailImageUrl | String | 썸네일 이미지 URL |
productName | String | 상품명 |
designTemplateName | String | 디자인 템플릿 명 |
optionValueString | String | 선택 옵션 정보 |
consignments | Array
(Object) | 배송 정보
* 배송정보(consignment) |
•
address
Name | Type | |
recipient | String | 받는사람 |
postcode | String | 우편번호 |
address | String | 주소 1 |
addressDetail | String | 주소 2 |
phoneNumber | String | 수신자 전화번호 |
nationCode | String | * default : KR |
•
consignment
Name | Type | |
shippingDate | DateTime | 발송일자 |
carrier | String | 배송사 |
shippingInvoice | String | 송장번호 |
•
응답 예시
{
"orderId": 476,
"channelName": "JunTestChannel-자사몰",
"orderCode": "20240226000000003",
"storeCustomerId": "jun",
"orderStatus": "RECEIVED",
"orderEntries": [
{
"projectId": 10302,
"quantity": 3,
"status": "IN_PRODUCTION",
"productSellPrice": 8800,
"thumbnailImageUrl": "https://dev-cdn.pod.shop/60/projects/2024/2/10304/10304_thumbnail_20240223081714532_blob",
"productName": "버튼거울 58, 75 무유광",
"designTemplateName": "58 75 사이즈",
"optionValueString": "NORMAL/원형/75X75/무광"
},
{
"projectId": 10303,
"quantity": 2,
"status": "SHIPPED",
"productSellPrice": 36300,
"thumbnailImageUrl": "https://dev-cdn.pod.shop/60/projects/2024/2/10305/10305_thumbnail_20240223081731933_blob",
"productName": "아메30수 반팔여 - S-M-L - 앞-뒤-목뒤 - AllColor",
"designTemplateName": "아메반팔여 MSL 앞뒤목",
"optionValueString": "앞면-뒷면-목뒤/디지털Plus/블랙/M",
"consignments": [
{
"shippingDate": "2024-03-13T11:22:20",
"carrier": "CJ",
"shippingInvoice": "123412341234"
}
],
}
],
"estimatedShippingDate": "2024-02-29",
"shippingAddress": {
"recipient": "요",
"postcode": "12345",
"address": "서울 영등포구 여의대로 24",
"addressDetail": "21층",
"nationCode": "KR",
"phoneNumber": "010-1234-1234"
},
"totalPaymentAmount": 99000
"isDeliveryDelay": false
}
JSON
복사
3. 배송지 변경
PUT /ac/api/external/orders/{orderCode}/shipping-address
고객사 스토어 주문번호를 이용해 배송지를 변경 합니다.
배송지 변경이 불가능 할 경우 오류를 응답합니다.
Path Parameter
Name | Type | |
orderCode | String | 주문번호(고객사 스토어)
* 주문에 대해 유니크한 고객사 스토어 키값
|
Body Parameter
Name | 필수여부 | Type | |
recipient | Y | String | 받는사람 |
postcode | Y | String | 우편번호 |
address | Y | String | 주소 1 |
addressDetail | Y | String | 주소 2 |
phoneNumber | Y | String | 수신자 전화번호 |
nationCode | Y | String | * default : KR |
•
요청예시
curl --location --request PUT 'https://dev-api.pod.shop/ac/api/external/orders/FffAbQpLor/shipping-address' \
--header 'Authorization: Basic [인증코드]' \
--header 'Basic;' \
--header 'Content-Type: application/json' \
--data '{
"address": "경기 성남시 분당구 ",
"addressDetail": "4층",
"nationCode": "KR",
"phoneNumber": "01012341234",
"postcode": "13494",
"recipient": "수신자s"
}'
Shell
복사
Response
•
주문 정보가 담긴 객체를 응답합니다.
Name | Type | |
orderId | Number | 주문번호 |
channelName | String | 주문 채널명 |
orderCode | String | 주문번호(고객사 스토어) |
storeCustomerId | String | 주문자
* 고객사 주문자 유니크 키값 |
orderStatus | Enum
(String) | IN_PRODUCTION : 주문 처리중
WAITING_FOR_SHIPPING : 포장 완료
SHIPPED : 발송완료
IN_DELIVERY : 배송중
DELIVERY_COMPLETED : 배송완료 |
estimatedShippingDate | String | 발송예정일
* YYYY-MM-DD |
totalPaymentAmount | Number | 주문 총액 |
orderEntries | Array
(Object) | 주문 상품(프로젝트) 배열
* 주문 프로젝트(entry) |
shippingAddress | Object | 배송지 정보
* 주소 객체(address) |
•
entry
Name | Type | |
projectId | Number | 상품 번호
* channelProductId / designTemplateId / channelOptionVariantId 를 이용해 획득한 상품 고유 ID |
quantity | Number | 주문수량 |
productSellPrice | Array | 판매금액 |
status | Enum
(String) | IN_PRODUCTION제작중
SHIPPED 발송완료
DELIVERY_COMPLETED배송완료
IN_DELIVERY배송중 |
thumbnailImageUrl | String | 썸네일 이미지 URL |
productName | String | 상품명 |
designTemplateName | String | 디자인 템플릿 명 |
optionValueString | String | 선택 옵션 정보 |
consignments | Array
(Object) | 배송 정보
* 배송정보(consignment) |
•
address
Name | Type | |
recipient | String | 받는사람 |
postcode | String | 우편번호 |
address | String | 주소 1 |
addressDetail | String | 주소 2 |
phoneNumber | String | 수신자 전화번호 |
nationCode | String | * default : KR |
•
consignment
Name | Type | |
shippingDate | DateTime | 발송일자 |
carrier | String | 배송사 |
shippingInvoice | String | 송장번호 |
Error Response 예시
{
"errorKey": "Api Exceptions",
"params": {
"message": "Unable to change recipient."
},
"title": "Business rule violation",
"status": 400
}
SQL
복사
•
응답 예시
{
"orderId": 476,
"channelName": "JunTestChannel-자사몰",
"orderCode": "20240226000000003",
"storeCustomerId": "jun",
"orderStatus": "RECEIVED",
"orderEntries": [
{
"projectId": 10302,
"quantity": 3,
"status": "IN_PRODUCTION",
"productSellPrice": 8800,
"thumbnailImageUrl": "https://dev-cdn.pod.shop/60/projects/2024/2/10304/10304_thumbnail_20240223081714532_blob",
"productName": "버튼거울 58, 75 무유광",
"designTemplateName": "58 75 사이즈",
"optionValueString": "NORMAL/원형/75X75/무광"
},
{
"projectId": 10303,
"quantity": 2,
"status": "SHIPPED",
"productSellPrice": 36300,
"thumbnailImageUrl": "https://dev-cdn.pod.shop/60/projects/2024/2/10305/10305_thumbnail_20240223081731933_blob",
"productName": "아메30수 반팔여 - S-M-L - 앞-뒤-목뒤 - AllColor",
"designTemplateName": "아메반팔여 MSL 앞뒤목",
"optionValueString": "앞면-뒷면-목뒤/디지털Plus/블랙/M",
"consignments": [
{
"shippingDate": "2024-03-13T11:22:20",
"carrier": "CJ",
"shippingInvoice": "123412341234"
}
],
}
],
"estimatedShippingDate": "2024-02-29",
"shippingAddress": {
"recipient": "요",
"postcode": "12345",
"address": "서울 영등포구 여의대로 24",
"addressDetail": "21층",
"nationCode": "KR",
"phoneNumber": "010-1234-1234"
},
"totalPaymentAmount": 99000
}
JSON
복사
