배송

배송비 확인

post

Header parameters

AuthorizationstringOptionalExample: {{token}}

Body

Responses

200

Successful response

application/json

post

/v1/partner/rest-api/delivery-amount

POST /v1/partner/rest-api/delivery-amount HTTP/1.1
Host: biz-api.gossok.com
Content-Type: application/json
Accept: */*
Content-Length: 336

{
  "senderAddress": {
    "gu": "동작구",
    "dong": "노량진동",
    "landNumberAddress": "서울 동작구 노량진동 334",
    "roadNameAddress": "서울 동작구 노들로 674"
  },
  "receiverAddress": {
    "gu": "금천구",
    "dong": "가산동",
    "landNumberAddress": "서울 금천구 가산동 235-64",
    "roadNameAddress": "서울 금천구 두산로9가길 19-3"
  }
}

200

Successful response

No content

Warning: 배송 API는 주소에 한글이 존재하여 데이터 전송 시 UTF-8 설정 필요 합니다

단 건 배송

단 건 배송 생성

post

/v1/partner/rest-api/delivery/

Header parameters

AuthorizationBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwMUdWSzlINlhOMUgyOFpQOUM4UlZBMzlHNSIsInN1YiI6IjAxRzgyUzJLN1pUUzFLUU0zQk1BWldGNlJKIiwicm9sZSI6IlBBUlRORVJfVVNFUiIsImlhdCI6MTY3ODkwNjAwNiwiZXhwIjoxNjc4OTA2MzA2fQ.c__G_rZ7pHpAfLXAwMR63N_wFNzrtEhhjTa0ZdOptionalExample:

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwMUdWSzlINlhOMUgyOFpQOUM4UlZBMzlHNSIsInN1YiI6IjAxRzgyUzJLN1pUUzFLUU0zQk1BWldGNlJKIiwicm9sZSI6IlBBUlRORVJfVVNFUiIsImlhdCI6MTY3ODkwNjAwNiwiZXhwIjoxNjc4OTA2MzA2fQ.c__G_rZ7pHpAfLXAwMR63N_wFNzrtEhhjTa0Zd

Body

payloadjsonObjectOptionalExample:

{"isSender":true,"senderAddr":{"name":"강병곤","phone":"01098735198","postalCode":"08826","sigungu":"관악구","landNumberAddress":"서울 관악구 신림동 산 56-1","roadNameAddress":"서울 관악구 관악로 1","detailAddress":"32-1동"},"receiverAddr":{"name":"홍길동","phone":"01012345678","postalCode":"16011","sigungu":"의왕시","landNumberAddress":"경기도 의왕시 학의동 158-3","roadNameAddress":"경기도 의왕시 새터말길 42","detailAddress":"벨라리치 A동 502호"},"itemName":"서류","itemWeight":0,"numPackages":1,"packagingType":"종이 봉투","requestNote":"빠른 배송 부탁드립니다"}

imagefile · binaryOptional

배송 물품 사진 (file) [optional]

Responses

201

정상

application/json

400

입력 값에 문제가 발생한 경우

application/json

401

accesstoken 인증 실패

application/json

post

/v1/partner/rest-api/delivery/

POST /v1/partner/rest-api/delivery/ HTTP/1.1
Host: biz-api.gossok.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 664

{
  "payload": {
    "isSender": true,
    "senderAddr": {
      "name": "강병곤",
      "phone": "01098735198",
      "postalCode": "08826",
      "sigungu": "관악구",
      "landNumberAddress": "서울 관악구 신림동 산 56-1",
      "roadNameAddress": "서울 관악구 관악로 1",
      "detailAddress": "32-1동"
    },
    "receiverAddr": {
      "name": "홍길동",
      "phone": "01012345678",
      "postalCode": "16011",
      "sigungu": "의왕시",
      "landNumberAddress": "경기도 의왕시 학의동 158-3",
      "roadNameAddress": "경기도 의왕시 새터말길 42",
      "detailAddress": "벨라리치 A동 502호"
    },
    "itemName": "서류",
    "itemWeight": 0,
    "numPackages": 1,
    "packagingType": "종이 봉투",
    "requestNote": "빠른 배송 부탁드립니다"
  },
  "image": null
}

{
  "data": {
    "id": "01GVK5ECB3Y5CY5H6ME8A6WEK",
    "status": "WAITING"
  }
}

Notice: 단 건 배송 이미지 파일 최대 가능 크기(약 2MB(2097152 byte))

Warning: 배송 API 사용 시 로그인(토큰 발행) API 를 통해 발급 받은 accessToken을 header의 Authorization 값으로 설정이 필요합니다

다 건 배송

다 건 배송 생성

post

/v1/partner/rest-api/deliveries/

Header parameters

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwMUdWSzlINlhOMUgyOFpQOUM4UlZBMzlHNSIsInN1YiI6IjAxRzgyUzJLN1pUUzFLUU0zQk1BWldGNlJKIiwicm9sZSI6IlBBUlRORVJfVVNFUiIsImlhdCI6MTY3ODkwNjAwNiwiZXhwIjoxNjc4OTA2MzA2fQ.c__G_rZ7pHpAfLXAwMR63N_wFNzrtEhhjTa0Zd

Body

deliveriesjsonArrayOptionalExample:

[{"isSender":true,"senderAddr":{"name":"강병곤","phone":"01098735198","postalCode":"08826","sigungu":"관악구","landNumberAddress":"서울 관악구 신림동 산 56-1","roadNameAddress":"서울 관악구 관악로 1","detailAddress":"32-1동"},"receiverAddr":{"name":"홍길동","phone":"01012345678","postalCode":"16011","sigungu":"의왕시","landNumberAddress":"경기도 의왕시 학의동 158-3","roadNameAddress":"경기도 의왕시 새터말길 42","detailAddress":"벨라리치 A동 502호"},"itemName":"생선회","itemWeight":1,"numPackages":1,"packagingType":"스트리폼","requestNote":"빠른 배송 부탁드립니다"},{"isSender":true,"senderAddr":{"name":"강병곤","phone":"01098735198","postalCode":"08826","sigungu":"관악구","landNumberAddress":"서울 관악구 신림동 산 56-1","roadNameAddress":"서울 관악구 관악로 1","detailAddress":"32-1동"},"receiverAddr":{"name":"홍길동","phone":"01012345678","postalCode":"16011","sigungu":"의왕시","landNumberAddress":"경기도 의왕시 학의동 158-3","roadNameAddress":"경기도 의왕시 새터말길 42","detailAddress":"벨라리치 A동 502호"},"itemName":"생선회","itemWeight":1,"numPackages":1,"packagingType":"스트리폼","requestNote":"빠른 배송 부탁드립니다"}]

Responses

201

정상

application/json

400

입력 값에 문제가 발생한 경우

application/json

401

accesstoken 인증 실패

application/json

post

/v1/partner/rest-api/deliveries/

POST /v1/partner/rest-api/deliveries/ HTTP/1.1
Host: biz-api.gossok.com
Content-Type: application/json
Accept: */*
Content-Length: 1300

{
  "deliveries": [
    {
      "isSender": true,
      "senderAddr": {
        "name": "강병곤",
        "phone": "01098735198",
        "postalCode": "08826",
        "sigungu": "관악구",
        "landNumberAddress": "서울 관악구 신림동 산 56-1",
        "roadNameAddress": "서울 관악구 관악로 1",
        "detailAddress": "32-1동"
      },
      "receiverAddr": {
        "name": "홍길동",
        "phone": "01012345678",
        "postalCode": "16011",
        "sigungu": "의왕시",
        "landNumberAddress": "경기도 의왕시 학의동 158-3",
        "roadNameAddress": "경기도 의왕시 새터말길 42",
        "detailAddress": "벨라리치 A동 502호"
      },
      "itemName": "생선회",
      "itemWeight": 1,
      "numPackages": 1,
      "packagingType": "스트리폼",
      "requestNote": "빠른 배송 부탁드립니다"
    },
    {
      "isSender": true,
      "senderAddr": {
        "name": "강병곤",
        "phone": "01098735198",
        "postalCode": "08826",
        "sigungu": "관악구",
        "landNumberAddress": "서울 관악구 신림동 산 56-1",
        "roadNameAddress": "서울 관악구 관악로 1",
        "detailAddress": "32-1동"
      },
      "receiverAddr": {
        "name": "홍길동",
        "phone": "01012345678",
        "postalCode": "16011",
        "sigungu": "의왕시",
        "landNumberAddress": "경기도 의왕시 학의동 158-3",
        "roadNameAddress": "경기도 의왕시 새터말길 42",
        "detailAddress": "벨라리치 A동 502호"
      },
      "itemName": "생선회",
      "itemWeight": 1,
      "numPackages": 1,
      "packagingType": "스트리폼",
      "requestNote": "빠른 배송 부탁드립니다"
    }
  ]
}

{
  "data": [
    {
      "id": "01GVK3MF3RGKXJPVRWZG944HGP",
      "status": "WAITING"
    },
    {
      "id": "01GVK3MF59T00JE0FCY3DY15K3",
      "status": "WAITING"
    }
  ]
}

Warning: 현재 다 건 배송은 배송 이미지 등록을 지원하지 않습니다

Previous인증

Last updated 1 year ago