📦배송

물류 배송 PAGE

배송 요금 확인 API

post

출, 도착지를 통해 예상 배송 요금을 확인하는 API

Authorizations

jwt token

HTTPRequired

Body

application/json

배송비 확인 API Request DTO

countinteger · int32 · min: 1Required

수량(숫자만 가능('개' 등 단위는 제외))

Default: 1

weightinteger · int32 · min: 1 · max: 4Required

총 무게(1:0kg-5kg, 2:5kg-10kg, 3:10kg-15kg, 4:15kg-20kg, 5:20kg-25kg, 6:25kg-30kg, 7:30kg 이상)

Default: 1

reservationDateTimestring · min: 14 · max: 14 · nullableOptional

예약 배송 날짜(yyyyMMddHHmmss)

Default: 20230702173020

Responses

200

OK

*/*

배송비 확인 API Response DTO

successbooleanOptional

API 성공 여부

Default: true

messagestringOptional

전달 메세지

Default: API가 정상 처리되었습니다

errorCodeinteger · int32Optional

에러 코드

Default: 0

post

/v2/rest/estimated-cost

HTTPcURLJavaScriptPython

POST /v2/rest/estimated-cost HTTP/1.1
Host: in-api.gossok.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 499

{
  "count": 1,
  "weight": 1,
  "reservationDateTime": "20230702173020",
  "departureDeliveryAddress": {
    "roadNameMainAddr": "서울특별시 관악구 호암로 22길 32",
    "landNumberMainAddr": "서울특별시 관악구 신림동 1555-3",
    "longitude": 126.5705968581795,
    "latitude": 33.45066447440359
  },
  "arrivalDeliveryAddress": {
    "roadNameMainAddr": "서울특별시 관악구 호암로 22길 32",
    "landNumberMainAddr": "서울특별시 관악구 신림동 1555-3",
    "longitude": 126.5705968581795,
    "latitude": 33.45066447440359
  }
}

200

OK

{
  "success": true,
  "message": "API가 정상 처리되었습니다",
  "errorCode": 0,
  "data": {
    "totalAmount": 50000,
    "firstAmount": 10000,
    "secondAmount": 20000,
    "thirdAmount": 10000,
    "extraAmount": 10000,
    "deliveryExtraCosts": [
      {
        "reason": "무게 추가",
        "amount": 1000
      }
    ]
  }
}

배송 등록(단건) API

post

단건 배송 등록을 위한 API

Authorizations

jwt token

HTTPRequired

Body

application/json

배송 등록(단건) API Request DTO

countinteger · int32 · min: 1Required

수량(숫자만 가능('개' 등 단위는 제외))

Default: 1

weightinteger · int32 · min: 1 · max: 4Required

총 무게(1:0kg-5kg, 2:5kg-10kg, 3:10kg-15kg, 4:15kg-20kg, 5:20kg-25kg, 6:25kg-30kg, 7:30kg 이상)

Default: 1

itemstring · max: 200Required

물품 (최대 200자)

Default: 사과

itemCategoryinteger · int32Required

물품 카테고리(1:농/수/축산물, 2:가공식품/음료, 3:화훼류, 4:의류/패션잡화, 5:의료/약류, 6:서류, 7:기타)

Default: 1

senderFlaginteger · int32 · min: 1 · max: 2Required

고객 물품 발신/수신 여부(1:발신, 2:수신)

Default: 1

reservationDateTimestring · min: 14 · max: 14 · nullableOptional

예약 배송 날짜(yyyyMMddHHmmss)

Default: 20230702173020

itemAmountnumber · nullableOptional

물품 가액

Default: 1000

packageTypestring · max: 20 · nullableOptional

포장 정보 (최대 20자)

Default: 박스

requestMsgstring · max: 255 · nullableOptional

요청 사항 (최대 255자)

Default: 깨지는 물건 입니다. 취급 시 주의 요망 합니다

Responses

200

OK

*/*

배송 등록(단건) API Response DTO

successbooleanOptional

API 성공 여부

Default: true

messagestringOptional

전달 메세지

Default: API가 정상 처리 되었습니다

errorCodeinteger · int32Optional

에러 코드

Default: 0

post

/v2/rest/delivery

HTTPcURLJavaScriptPython

POST /v2/rest/delivery HTTP/1.1
Host: in-api.gossok.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 856

{
  "count": 1,
  "weight": 1,
  "item": "사과",
  "itemCategory": 1,
  "senderFlag": 1,
  "reservationDateTime": "20230702173020",
  "itemAmount": 1000,
  "packageType": "박스",
  "requestMsg": "깨지는 물건 입니다. 취급 시 주의 요망 합니다",
  "departureDeliveryAddress": {
    "name": "거래처-동양물산",
    "phoneNum": "01012345678",
    "numAddr": "08812",
    "roadNameMainAddr": "서울특별시 관악구 호암로 22길 32",
    "landNumberMainAddr": "서울특별시 관악구 신림동 1555-3",
    "subAddr": "301 호",
    "longitude": 126.5705968581795,
    "latitude": 33.45066447440359
  },
  "arrivalDeliveryAddress": {
    "name": "거래처-동양물산",
    "phoneNum": "01012345678",
    "numAddr": "08812",
    "roadNameMainAddr": "서울특별시 관악구 호암로 22길 32",
    "landNumberMainAddr": "서울특별시 관악구 신림동 1555-3",
    "subAddr": "301 호",
    "longitude": 126.5705968581795,
    "latitude": 33.45066447440359
  }
}

200

OK

{
  "success": true,
  "message": "API가 정상 처리 되었습니다",
  "errorCode": 0,
  "data": {
    "item": "사과",
    "deliveryNo": "231110100010",
    "deliveryStatus": 1
  }
}

배송 등록(다건) API

post

다건 배송 등록을 위한 API

Authorizations

jwt token

HTTPRequired

Bodyobject[]

application/json

배송 등록(단건) API Request DTO

countinteger · int32 · min: 1Required

수량(숫자만 가능('개' 등 단위는 제외))

Default: 1

weightinteger · int32 · min: 1 · max: 4Required

총 무게(1:0kg-5kg, 2:5kg-10kg, 3:10kg-15kg, 4:15kg-20kg, 5:20kg-25kg, 6:25kg-30kg, 7:30kg 이상)

Default: 1

itemstring · max: 200Required

물품 (최대 200자)

Default: 사과

itemCategoryinteger · int32Required

물품 카테고리(1:농/수/축산물, 2:가공식품/음료, 3:화훼류, 4:의류/패션잡화, 5:의료/약류, 6:서류, 7:기타)

Default: 1

senderFlaginteger · int32 · min: 1 · max: 2Required

고객 물품 발신/수신 여부(1:발신, 2:수신)

Default: 1

reservationDateTimestring · min: 14 · max: 14 · nullableOptional

예약 배송 날짜(yyyyMMddHHmmss)

Default: 20230702173020

itemAmountnumber · nullableOptional

물품 가액

Default: 1000

packageTypestring · max: 20 · nullableOptional

포장 정보 (최대 20자)

Default: 박스

requestMsgstring · max: 255 · nullableOptional

요청 사항 (최대 255자)

Default: 깨지는 물건 입니다. 취급 시 주의 요망 합니다

Responses

200

OK

*/*

배송 등록(다건) API Response DTO

successbooleanOptional

API 성공 여부

Default: true

messagestringOptional

전달 메세지

Default: API가 정상 처리 되었습니다

errorCodeinteger · int32Optional

에러 코드

Default: 0

post

/v2/rest/deliveries

HTTPcURLJavaScriptPython

POST /v2/rest/deliveries HTTP/1.1
Host: in-api.gossok.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 858

[
  {
    "count": 1,
    "weight": 1,
    "item": "사과",
    "itemCategory": 1,
    "senderFlag": 1,
    "reservationDateTime": "20230702173020",
    "itemAmount": 1000,
    "packageType": "박스",
    "requestMsg": "깨지는 물건 입니다. 취급 시 주의 요망 합니다",
    "departureDeliveryAddress": {
      "name": "거래처-동양물산",
      "phoneNum": "01012345678",
      "numAddr": "08812",
      "roadNameMainAddr": "서울특별시 관악구 호암로 22길 32",
      "landNumberMainAddr": "서울특별시 관악구 신림동 1555-3",
      "subAddr": "301 호",
      "longitude": 126.5705968581795,
      "latitude": 33.45066447440359
    },
    "arrivalDeliveryAddress": {
      "name": "거래처-동양물산",
      "phoneNum": "01012345678",
      "numAddr": "08812",
      "roadNameMainAddr": "서울특별시 관악구 호암로 22길 32",
      "landNumberMainAddr": "서울특별시 관악구 신림동 1555-3",
      "subAddr": "301 호",
      "longitude": 126.5705968581795,
      "latitude": 33.45066447440359
    }
  }
]

200

OK

{
  "success": true,
  "message": "API가 정상 처리 되었습니다",
  "errorCode": 0,
  "datas": [
    {
      "item": "사과",
      "deliveryNo": "231110100010",
      "deliveryStatus": 1
    }
  ]
}

배송 상세 조회 API

get

배송 상세 조회를 위한 API

Authorizations

jwt token

HTTPRequired

Query parameters

deliveryNostringRequired

조회 배송 접수 번호(배송 등록 API 통해 전달 받은 배송 접수 번호(deliveryNo))

Default: 241127100040

Responses

200

OK

*/*

배송 상세조회 API Response DTO

successbooleanOptional

API 성공 여부

Default: true

messagestringOptional

전달 메세지

Default: API가 정상 처리 되었습니다

errorCodeinteger · int32Optional

에러 코드

Default: 0

get

/v2/rest/delivery

HTTPcURLJavaScriptPython

GET /v2/rest/delivery?deliveryNo=241127100040 HTTP/1.1
Host: in-api.gossok.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "success": true,
  "message": "API가 정상 처리 되었습니다",
  "errorCode": 0,
  "data": {
    "pickUpFlag": 1,
    "reservationFlag": 2,
    "reservationDateTime": 20230702173020,
    "deliveryNo": 123456789012,
    "deliveryStatus": 1,
    "paymentStatus": 1,
    "totalAmount": 10000,
    "packageType": "박스",
    "count": 1,
    "weight": 1,
    "item": "사과",
    "itemAmount": 1000,
    "itemCategory": 1,
    "itemImageOriginalName": "test.png",
    "itemImageS3Url": "https://prod-gossok-contents.s3.ap-northeast-2.amazonaws.com/d934bd03-3518-41a0-8675-c54585555d50test.png",
    "senderFlag": 1,
    "requestMsg": "깨지기 쉬운 물건 입니다. 취급 시 주의 바랍니다.",
    "csUserName": "김고쏙",
    "createdTime": "2023-05-31 13:00:00",
    "departureDeliveryAddress": {
      "name": "김고쏙",
      "phoneNum": 1012345678,
      "numAddr": 8812,
      "roadNameMainAddr": "서울특별시 관악구 호암로 22길 32",
      "subAddr": "301 호",
      "longitude": 126.5705968581795,
      "latitude": 33.45066447440359
    },
    "arrivalDeliveryAddress": {
      "name": "김고쏙",
      "phoneNum": 1012345678,
      "numAddr": 8812,
      "roadNameMainAddr": "서울특별시 관악구 호암로 22길 32",
      "subAddr": "301 호",
      "longitude": 126.5705968581795,
      "latitude": 33.45066447440359
    },
    "deliveryPayment": {
      "payerFlag": 1,
      "payMethod": 1,
      "payerName": "김고쏙"
    }
  }
}

배송 취소 API

delete

단건 배송 취소를 위한 API

Authorizations

jwt token

HTTPRequired

Body

application/json

배송 취소 API Request DTO

deliveryNostringRequired

배송 등록 시 결과 값으로 전달 받은 배송 접수 번호

Default: 1

Responses

200

OK

*/*

배송 취소 API Response DTO

successbooleanOptional

API 성공 여부

Default: true

messagestringOptional

전달 메세지

Default: API가 정상 처리 되었습니다

errorCodeinteger · int32Optional

에러 코드

Default: 0

dataobjectOptional

전달 데이터

delete

/v2/rest/delivery

HTTPcURLJavaScriptPython

DELETE /v2/rest/delivery HTTP/1.1
Host: in-api.gossok.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "deliveryNo": "1"
}

200

OK

{
  "success": true,
  "message": "API가 정상 처리 되었습니다",
  "errorCode": 0,
  "data": {}
}