Ship&CoのAPIを使って、ヤマト運輸の代引きとクール宅急便の送り状のPDFファイルを生成する

この記事では、Ship&CoのAPIを使って、ヤマト運輸のヤマト運輸の代引きとクール宅急便の送り状のPDFファイルを生成する方法を紹介します。

1. shipment APIを呼び出す準備をする

こちらの記事、および、こちらのPOSTMANコレクションを参考にして、https://app.shipandco.com/api/v1/shipmentsにPOSTするリクエストJSONを作成します。

{
    "to_address": {
        "full_name": "TEST TARO",
        "company": "",
        "email": "",
        "phone": "11111111111",
        "country": "JP",
        "zip": "6048072",
        "province": "京都府",
        "city": "",
        "address1": "京都市中京区",
        "address2": "八百屋町117"
    },
   "from_address": {
        "full_name": "TEST",
        "company": "",
        "email": "",
        "phone": "11111111111",
        "country": "JP",
        "zip": "5670001",
        "province": "大阪府",
        "city": "",
        "address1": "茨木市安威",
        "address2": ""
    },
    "products": [
        {
          "name": "PRODUCT NAME",
          "price": 0,
          "quantity": 1
        }
    ],
    "setup": {
        "carrier": "yamato",
        "service": "yamato_regular",
        "ref_number": "SOME REF TO DISPLAY ON LABEL",
        "pack_amount": 1,
        "care": {
           "fragile": true,
           "side_up": true,
           "valuable_goods": true
        },
        "test": true
    }
}

2. 代引きの指定をする

APIドキュメントの「出荷情報の作成」からリンクされている共通定義の記述をもとに、setupのservice をyamato_collectに変更し、cash_on_deliveryの項目を追加します。

"setup": {
  ...
  "service": "yamato_collect",
  ...
  "cash_on_delivery": {
    "amount": 1100,
    "tax": 100
  },
  ...
}

3. クールオプションの指定をする

上記と同じドキュメントの記述をもとに、setupにcool_optionsを追加します。今回は、冷凍のfrozenを指定します。

"setup": {
  ...
  "cool_options": "frozen",
  ...
}

4. 出荷日と配送日を指定をする

上記と同じドキュメントの記述をもとに、setupにshipment_dateとdateを追加すると、それぞれ出荷日（受付日）と配送日（お届け予定日）を指定できます。省略すると、出荷日はAPIを呼び出した日として処理され、配送日は空欄での反映 (＝原則、運送会社がお届けできる最短での取り扱い) となります。

"setup": {
  ...
  "shipment_date": "2020-07-27",        
  "date": "2020-07-29",    
  ...
}

5. APIを実行する

上記で作成したリクエストをもとに、APIを実行します。成功すると、下記のようなPDFがレスポンスにURLとして返されます。代引きと冷凍の記載がPDFにあることがわかります。