배송

굿웨어몰 배송 처리를 위한 다양한 API를 제공하고 있습니다.

POST/v1/delivery/order/waybill

1. 주문 운송장 등록

운송장을 등록해 출고 처리를 합니다.

운송장 정보는 최대 20개까지 등록 가능합니다.

필수 파라미터

Name: waybillInfos
Children: 운송장 정보 Array
Type: array of object
Description

Name
ordNo
Children
주문 번호
Type
string
Description

Name: waybillDetail
Children: 운송장 상세 정보 Array
Type: array of object
Description

Name
ordGodTurn
Children
주문 순번
Type
int
Description
Enum
dlvComCd
Children
택배사 코드
Type
enum
Description
Name
waybilNo
Children
운송장 번호
Type
string
Description

응답 모델

프로퍼티명	설명	타입	상위객체
code	응답 코드	Number	N/A
message	응답 메시지	String	N/A
success/failed	운송장 등록 성공/실패	Object	N/A
ordNo	주문 번호	String	success/failed
ordGodTurn	주문 순번	Number	success/failed
waybilNo	운송장 번호	String	success/failed

Request

POST

/v1/delivery/order/waybill

curl -X POST "https://store-api.goodwearmall.com/v1/delivery/order/waybill" \
    -H "Authorization: ${API_AUTH_INFO}" \
    -H "Content-Type: application/json" \
    -d '{
        "waybillInfos": [
            {
                "ordNo": "OD1234567890",
                "waybillDetail": [
                    {
                        "ordGodTurn": 1,
                        "dlvComCd": "TEST",
                        "waybilNo": "12345"
                    },
                    {
                        "ordGodTurn": 2,
                        "dlvComCd": "TEST",
                        "waybilNo": "67890"
                    }
                ]
            }
        ]
    }'

Response

{
    "code": 0,
    "message": "[n / n]주문의 송장이 갱신되었습니다. [송장처리 미대상 : n 주문]",
    "success": [
        {
            "ordNo": "OD1234567890",
            "ordGodTurns": 1
        },
        {
            "ordNo": "OD1234567890",
            "ordGodTurns": 3
        },
        {
            "ordNo": "OD0987654321",
            "ordGodTurns": 5
        },
        {
            "ordNo": "OD0987654321",
            "ordGodTurns": 7
        }
    ],
    "failed": []
}

POST/v1/delivery/claim/waybill

2. 회수 운송장 등록

회수 운송장을 등록합니다.

운송장 정보는 최대 20개까지 등록 가능합니다.

필수 파라미터

Name: waybillInfos
Children: 운송장 정보 Array
Type: array of object
Description

Name
ordNo
Children
주문 번호
Type
string
Description

Name: waybillDetail
Children: 운송장 상세 정보 Array
Type: array of object
Description

Name
ordGodTurn
Children
주문 순번
Type
int
Description
Enum
dlvComCd
Children
택배사 코드
Type
enum
Description
Name
waybilNo
Children
운송장 번호
Type
string
Description

응답 모델

프로퍼티명	설명	타입	상위객체
code	응답 코드	Number	N/A
message	응답 메시지	String	N/A
success/failed	운송장 등록 성공/실패	Object	N/A
ordNo	주문 번호	String	success/failed
ordGodTurn	주문 순번	Number	success/failed
waybilNo	운송장 번호	String	success/failed

Request

POST

/v1/delivery/claim/waybill

curl -X POST "https://store-api.goodwearmall.com/v1/delivery/claim/waybill" \
    -H "Authorization: ${API_AUTH_INFO}" \
    -H "Content-Type: application/json" \
    -d '{
        "waybillInfos": [
            {
                "ordNo": "OD1234567890",
                "waybillDetail": [
                    {
                        "ordGodTurn": 1,
                        "dlvComCd": "TEST",
                        "waybilNo": "12345"
                    },
                    {
                        "ordGodTurn": 2,
                        "dlvComCd": "TEST",
                        "waybilNo": "67890"
                    }
                ]
            }
        ]
    }'

Response

{
    "code": 0,
    "message": "[n / n]주문의 회수송장이 갱신되었습니다. [회수송장처리 미대상 : n 주문]",
    "success": [
        {
            "ordNo": "OD1234567890",
            "ordGodTurns": 1
        },
        {
            "ordNo": "OD1234567890",
            "ordGodTurns": 3
        },
        {
            "ordNo": "OD0987654321",
            "ordGodTurns": 5
        },
        {
            "ordNo": "OD0987654321",
            "ordGodTurns": 7
        }
    ],
    "failed": []
}