이 게시물은 넷 통신 판매 등에서 빠뜨릴 수 없는 배송 업무를 클라우드형 출하 관리 시스템 Ship&Co의 API를 사용하여 프로그래밍하고 효율화하는 방법에 대해 설명합니다.

API의 사양은 API 문서 로서 공개되고 있습니다. 자세한 정보를 원하시는 분은 이쪽을 참조해 주십시오.

실제 API 호출의 샘플도 Postman 컬렉션 로서 공개되고 있습니다. 즉시 시도하고 싶은 분은 여기를 참조하십시오.

Ship&Co의 API로 할 수 있는 일과 그 이점

Ship&Co의 API에서 할 수 있는 일은 송장 인쇄, 요금 계산, 추적 정보 취득, 운송 회사, 창고 및 주소 등 관련 정보 관리 등입니다. 또 독특한 기능으로서, 서브 유저라고 하는 개념으로, 그러한 데이터를 유저마다 구분해 관리할 수 있습니다.

송장의 인쇄 등은 각 운용사가 API로서 제공하고 있는 일도 있습니다만, 그러한 처리 방법이나 포맷은 마을입니다. Ship&Co의 API의 큰 특징은, 운송회사나, 국내·해외의 발송으로 다른 인터페이스를 같은 사양의 API로 일원 관리할 수 있는 것이며, 배송 업자를 추가하거나 변경해도 프로그래밍의 내용을 크게 변경한다 필요가 없습니다. 이제 Ship&Co API를 사용하는 방법을 살펴 보겠습니다. 0단계: Ship&Co 계정 등록 Ship&Co의 API를 이용하려면 여기 에서 계정을 등록해야 합니다. 이미 계정을 가지고 계신 분은 필요하지 않습니다.

1단계: 액세스 토큰 획득

여기에 설명된 대로 Ship&Co 대시보드에서 액세스 토큰을 가져옵니다. 획득한 액세스 토큰을 주어진 HTTP 헤더에 쓰면 Ship&Co의 API를 호출할 수 있습니다.

2단계: 송장 인쇄 API 호출

여기 에 기재되어 있도록(듯이), 상기에서 취득한 액세스 토큰을 사용해 송장 인쇄의 API를 호출합니다. 실제 송장 인쇄에는 각 운송 회사와의 계약이 필요하지만, Ship&Co에는 테스트 모드가 있어, "test": true 의 파라미터를 부여하는 것만으로 실제로 청구되지 않는 더미의 송장을 인쇄할 수 있습니다 인쇄를 지원하는 운송 회사만 가능). 사가와익스프레스와 야마토 운수는 운송회사의 등록도 불필요합니다(그 외의 테스트 인쇄에는 Ship&Co의 대시보드 또는 API로 운송회사의 등록이 필요).

실제 요청은 다음과 같습니다.


API의 응답에는 다음과 같은 PDF가 URL로 포함되므로 이를 송장으로 인쇄합니다.



기본적인 이용 방법은 이상입니다. 운송회사, 국내·해외의 차이를 불문하고 이 스텝으로 송장을 인쇄할 수 있습니다.

(옵션: 요금 계산)

여기에 설명된 대로 송장 인쇄 API와 거의 동일한 매개변수를 갖는 요금 계산 API를 사용하여 각 운송 회사의 서비스별 배송비를 계산할 수 있습니다. 예를 들면 다음과 같이 같은 주소에 같은 것을 일본 우편으로 해외 발송을 했을 경우의 각 서비스의 배송료가 API의 응답으로서 돌려주어집니다.


이러한 서비스 중 가장 요금이 싼 것을 송장 인쇄의 API로 지정하는 코드를 쓰면, 항상 최저의 배송료로 송장을 인쇄할 수 있는 프로그램이 완성됩니다.

Ship&Co의 API에는 다른 많은 TIPS가 있지만 다른 게시물에서 자세히 파악하고 싶습니다.