How to connect Yamato v2 to ShippyPro

Let's see how you can integrate Yamato v2 with ShippyPro in just a few steps and start shipping across Japan.

Summary:

Before you start
Connection steps
Supported services
Additional options
Troubleshooting & Errors
FAQs

1. Before you start

Yamato v2 is the new integration with Yamato, one of Japan's main domestic parcel carriers. It replaces the previous Yamato integration, with improved label generation and tracking.

Before connecting, please note:

Yamato v2 supports domestic shipments within Japan only (Japan → Japan). International shipments are not available.
You need an active business account with Yamato (B2 Cloud service).

Ask your Yamato sales contact for the following credentials:

Token (API token)
API User ID
Invoice Code
Classification Code
Freight Control Number

If you don't have these details, contact your Yamato account manager before proceeding.

2. Connection steps

Go to the Carriers page in your ShippyPro account.
Click on the Yamato v2 logo.
Fill in the connection fields:

Field	Required	Description
Token	Yes	The API token provided by Yamato
API User ID	Yes	Your Yamato API user identifier
Invoice Code	Yes	Your Yamato invoice (customer) code
Classification Code	Yes	The classification code linked to your invoice code
Freight Control Number	Yes	Your Yamato freight control number
Label Type	Yes	Choose between PDF A6 or PDF A5
Service Type	Yes	The default Yamato service to use (see section 3)
Permanent Labels	No	Defines whether labels are generated as permanent or hidden
Test Mode	No	Connects to the Yamato test environment

Click Connect to save the configuration.

Your Yamato v2 account is now connected and ready to ship!

3. Supported services

Service	Description
Shipment	Standard delivery, with shipping prepaid by the sender
Collect	Delivery with collection of the goods' value from the recipient (Cash On Delivery)
Kuroneko Yu-mail	Service for lightweight mail items such as catalogues and printed materials
Payment on delivery	Delivery where the shipping cost is paid by the recipient
Kuroneko Yuupacket / Nekoposu	Service for small, thin parcels delivered to the mailbox
TA-Q-BIN Compact	Service for small parcels using Yamato's dedicated compact box
Compact Collect	TA-Q-BIN Compact with Cash On Delivery

Yamato v2 also supports:

PDF labels in A6 or A5 format
Track & Trace, with the tracking link pointing to the ShippyPro tracking page
Cash On Delivery, with the amount automatically converted to JPY

The following are not supported: shipment deletion (Void), live rates, pickup booking, return labels, multi-parcel shipments, ZPL/EPL labels, insurance, international shipments.

4. Additional options

Test Mode

By enabling Test Mode, your shipments are created in the Yamato test environment.

⚠️ Important: labels created in Test Mode are not valid for real shipments. Remember to disable Test Mode before you start shipping.

Carrier options

Yamato v2 also supports the following optional parameters at shipment level:

Tax Amount: tax amount sent with the shipment
Point ID: delivery to a Yamato service center instead of the recipient's address
Shipment Date: overrides the shipment date (format YYYYMMDD)
Delivery Date: requested delivery date
Delivery Time Zone: requested delivery time slot code

Shipment data

The Carrier Notes field is sent to Yamato and printed on the label; the generic Notes field is not.
The Company name is not sent to Yamato, so make sure the recipient's name is complete.
If the Content Description is empty, "Merchandise" is used by default.
The Order ID is shown on the label as a second item reference.

5. Troubleshooting & Errors

Authentication error / Invalid credentials

Check that Token and API User ID have been copied correctly, with no extra spaces. If the error persists, ask Yamato to confirm that your API access is active.

Invalid invoice code / classification code / freight control number

These three values must match your Yamato contract. Verify them with your Yamato sales contact.

Destination not supported

Yamato v2 only supports shipments within Japan. Shipments to other countries cannot be created with this carrier.

Address errors

Make sure the address is complete and correctly split: State = prefecture, City = city/ward, Street = street and number. Missing or misplaced fields may cause the shipment to be rejected.

Label not generated / delayed

Yamato generates documents in several steps. If the label isn't ready in time, wait a few minutes and try again.

Internal Server Error / connection issues

This is usually a temporary issue on the carrier's side. Please retry later. If the problem persists, contact ShippyPro Support with the order details.

6. FAQs

Can I ship internationally with Yamato v2?

No, Yamato v2 only supports domestic shipments within Japan.

Where do I get my credentials?

All credentials (Token, API User ID, Invoice Code, Classification Code, Freight Control Number) are provided by Yamato. Contact your Yamato account manager.

Can I delete a shipment created with Yamato v2?

No, deleting shipments is not supported through ShippyPro. Contact Yamato directly if you need to cancel a shipment.

Is Cash On Delivery supported?

Yes. The COD amount is automatically converted to Japanese Yen (JPY). Use the Collect or Compact Collect service.

Which label formats are available?

PDF A6 and PDF A5. ZPL and EPL formats are not available.

How can I track my shipments?

Tracking is automatic. Once the shipment is created, you can follow it from ShippyPro and share the ShippyPro tracking page with your customers.

I was using the old Yamato integration. Do I need to reconnect?

Yes, Yamato v2 is a new integration. Connect it from the Carriers page using your Yamato credentials.