GoGoVan API Specification - KR

거리 및 운임 확인

요청:

curl -X GET \
  -H 'GoGoVan-API-Key: a2c29f56-be11-4822-9f6f-8b62338ac782' \
  -H 'GoGoVan-User-Language: en-US' \
  -F 'order[name]=홍길동' \
  -F 'order[phone_number]=01012345678' \
  -F 'order[pickup_time]=2016-02-18T11:20:00I' \
  -F 'order[service_type]=transport' \
  -F 'order[vehicle]=motorcycle' \
  -F 'order[extra_requirements][is_raining]=true' \
  -F 'order[extra_requirements][express_service]=true' \
  -F 'order[extra_requirements][remark]=받는 분 : 김실장(010-1234-5678), 먼저 연락주세요' \
  -F 'order[locations]=[[37.4921936,127.02867949999995,"서울특별시 서초구 서초동 1337-1"],
[37.2288589,127.17216080000003,"서울특별시 강남구 역삼동 720-9"],[37.4921936,127.02867949999995,"서울특별시 서초구 서초동 1337-1"]]' \
  'https://stag-kr.gogovan.tech/api/v0/orders/price.json'

GoGoVan-User-Language는 en-US, zh-TW, zh-CN 중 택일하여 사용 가능

응답:

{
	"breakdown":{
		"fee":{
			"title":"기본 요금 합계",
			"value":67520
		},

		"extra_charge_for_raining":{
		"title":"비가 오는 경우",
		"value":3000
		},

		"extra_charge_for_express":{
		"title":"급행 추가 요금",
		"value":67520
		},
		
		"multi_point_concession":{
		"title":"경유지 할인",
		"value":-20256
		},

		"rounded_down_discount":{
		"title":"백원 단위 절사",
		"value":-784
		}
	},

	"distance_in_kms":"77.04",
	"vehicle":"motorcycle",
	"base":67520
}

최종 금액은 base + extra_charges - multi_point_concession - rounded_down_discount

주문 요청

요청:

curl -X POST \
  -H 'GoGoVan-API-Key: a2c29f56-be11-4822-9f6f-8b62338ac782' \
  -H 'GoGoVan-User-Language: en-US' \
  -F 'order[name]=홍길동' \
  -F 'order[phone_number]=01012345678' \
  -F 'order[pickup_time]=2016-02-18T11:20:00I' \
  -F 'order[service_type]=transport' \
  -F 'order[vehicle]=motorcycle' \
  -F 'order[extra_requirements][is_raining]=true' \
  -F 'order[extra_requirements][express_service]=true' \
  -F 'order[extra_requirements][remark]=받는 분 : 김실장(010-1234-5678), 먼저 연락주세요' \
  -F 'order[locations]=[[37.4921936,127.02867949999995,"서울특별시 서초구 서초동 1337-1"],
[37.2288589,127.17216080000003,"서울특별시 강남구 역삼동 720-9"],[37.4921936,127.02867949999995,"서울특별시 서초구 서초동 1337-1"]]' \
  'https://stag-kr.gogovan.tech/api/v0/orders.json'

응답:

{ "id": 2727 }

주문 취소

curl -v -X POST \
  -H 'GoGoVan-API-Key: a2c29f56-be11-4822-9f6f-8b62338ac782' \
  -H 'GoGoVan-User-Language: en-US' \
  'https://stag-kr.gogovan.tech/api/v0/orders/2727/cancel.json'

응답:

성공 시, Body가 없는 HTTP 200 OK

주문 상태 확인

요청:

curl -v -X GET \
  -H 'GoGoVan-API-Key: a2c29f56-be11-4822-9f6f-8b62338ac782' \
  -H 'GoGoVan-User-Language: en-US' \
  'https://stag-kr.gogovan.tech/api/v0/orders/2727.json'

응답:

기사 미 배정

{
	"id":2727,
	"status":"pending",
	"name":"홍길동",
	"phone_number":"01012345678",
	"price":69000.0
}

기사 배정

{
        "id":2727,
        "status":"active",
        "name":"홍길동",
        "phone_number":"01012345678",
        "price":69000.0,
    
        "driver":{
            "id":185,
            "phone_number":"01087654321",
            "name":"기사님",
            "license_plate":"30주1234"
            }
}

상태 값

pending - 주문 요청 완료, 기사 검생 중
active - 해당 주문 요청에 대한 기사 배정 완료
completed - 기사에 의한 주문 배송 완료
canelled - 기사에 의한 주문 취소

필수 항목

  GoGoVan-API-Key
  GoGoVan-User-Language
  order[name]
  order[phone_number]
  order[pickup_time]
  order[service_type]
  order[vehicle]
  order[extra_requirements][remark]
  order[locations]
  API URL

사용 가능한 파라미터

  <차량 종류>
  order[vehicle]]=motorcycle / damas / labo / ton1 ton1_2_and_ton1_4 <오토바이 / 다마스 / 라보 / 1톤 트럭 / 1.2&1.4톤 트럭>
    
  <서비스 종류>
  order[service_type]=transport / delivery <퀵 서비스 / 용달>
  
  <퀵 서비스 추가 요구 사항>
  order[extra_requirements][is_raining]=true <비가 오는 경우>
  order[extra_requirements][is_snowing]=true <눈이 오는 경우>
  order[extra_requirements][express_service]=true <급송>
  
  <용달 추가 요구 사항>
  order[extra_requirements][need_carry]=true <운반 요청>

API 목록

  거리 및 운임 = https://stag-kr.gogovan.tech/api/v0/orders/price.json
  주문 요청 = https://stag-kr.gogovan.tech/api/v0/orders.json
  주문 취소 = https://stag-kr.gogovan.tech/api/v0/orders/{order_id}/cancel.json
  주문 상태 확인 = https://stag-kr.gogovan.tech/api/v0/orders/{order_id}.json