Introduction

Generate labels, electronic trade documents and special services as well as tracking and manifesting.

Preferences

In order to create a Preference for Yamato in the Multi-carrier application please obtain the credentials below directly from the carrier.

How to Test

If you don't have your live credentials available during implementation phase, Zenkraft can provide test credentials. Click on the Use Test Account toggle and select the Test Account Country from the dropdown.

How to get Yamato API key

1. Log into the Yamato Business Members page.

2. Click on “Service in Use (ご利用中のサービス)” → “Shipping Label Printing System B2 Cloud (送り状発行システムB2クラウド)”

3. In the “Shipping Label Printing System B2 Cloud (送り状発行システムB2クラウド)” page, click on “Change System Settings (システム設定を変更する)” → “Link with external system (外部システムとの連携)”.

4. When the API access authentication key (APIアクセス認証キー) is displayed on the screen below, copy the contents.

5. Next, in the “Shipping Label Printing System B2 Cloud (送り状発行システムB2クラウド)” page, click on “Issue one by one (1件ずつ発行)”

6. Copy the last two digits of the “Bill to (請求先)” code in the basic information (基本情報). You see numbers from 01 ~ 99.

7. Use the API key (APIアクセス認証キー) and the Freight Number Bill to (請求先) to set up the preference.

Service Types

Service Types	Value	Description
Ta-Q-Bin Regular	regular	Ta-q-bin (Size 60 to 160 parcels) next-day delivery to most areas in Japan all year round.	Copy
Collect	collect	Ta-q-bin Collect (Size 60 to 160 parcels) - Send small parcels for a reasonable price. Like TA-Q-BIN, all services are available, with payment taken from recipient.	Copy
Direct Mail	direct_mail	Service for delivering catalogs, pamphlets, and other promotional material to mailboxes throughout Japan without a seal of receipt.	Copy
Time	time	Parcels accepted by the evening are delivered by 10:00am the following morning.	Copy
Freight On Delivery	freight_on_delivery	Freight delivery service provided by Yamato.	Copy
Nekopos	nekopos	This service for small parcels provides next-day delivery to a mailbox, to the same standards as TA-Q-BIN.	Copy
Ta-Q-Bin Compact	taqbin	Ta-q-bin Compact (Parcels smaller than Size 60) - Send small parcels for a reasonable price. Like TA-Q-BIN, all services are available.	Copy
TA-Q-BIN Collect	taqbin_collect	Ta-q-bin Compact Collect (Parcels smaller than Size 60) - Send small parcels for a reasonable price. Like TA-Q-BIN, all services are available, with payment taken from recipient.	Copy

Packaging Types

Packaging Types	Value
Your Packaging (あなたのパッケージ)	your_packaging	Copy

Product Details

Product details are required for both domestic and international shipments.

• DESCRIPTION (概要)
• HARMONIZED CODE (HSコード)
• VALUE (価格)
• QUANTITY (数量)
• MANUFACTURE COUNTRY (生産国コード)

Estimated Delivery Date

The earliest possible delivery date is typically the next day, but this depends heavily on the origin (ship-from) and destination (ship-to) postal codes.
Yamato does not provide a public API connection for this calculation as their transit schedules often change. However, they provide an official tool on their website for these calculations: Yamato Date and Time Search

Shipping

Please make sure both sender and recipient address details are in Japanese.

Standard, Express, Next Day

Standard and Express: for general packages that need to be shipped with a standard or express service you can use regular

Next Day: for next day shipments regular will work as well, provided the shipping distance allows for next-day delivery. If the customer needs guaranteed next-day delivery by a specific time (e.g., before 10:00 AM or 5:00 PM), Yamato offers a "Time Service," which corresponds to time in our API.

Click&Collect

While Yamato does offer a service where couriers deliver to convenience stores or specific lockers, this is a completely separate system restricted to major enterprise partners (like Amazon or Rakuten). Unfortunately, the public API does not support this feature, so orders must be shipped to a standard residential or business address.

Returns

Yamato is including the return label in the outbound shipment. This is because Yamato requires return labels to be printed on Yamato-specific paper. So generally Yamato clients create an outbound shipment with the return label included in the box. The customer then contacts Yamato directly to arrange the pickup.

Pickups

Yamato does not have an API integration to create pickups. These need to be done manually through their website.

Label Types

The available label formats can be usually grouped into two types: thermal and non-thermal labels.

Label Types	Value
PDF	PDF	Copy