VibeFox Correios for WooCommerce — ヘルプ

要件

WordPress: 5.8 以降。

WooCommerce: 5.0 以降、インストールおよび有効化されていること。WooCommerce がないとプラグインを有効化できません。

PHP: 8.0 以降。

Correios 契約（リアルタイム料金のみ）: リアルタイム料金は Correios Web Services（CWS）の料金 API を使用し、posting card を持つ Correios 契約の認証情報が必要です。必要な情報は 3 つです: Meu Correios のユーザー（通常は契約の CNPJ または CPF）、API アクセスコード、posting card 番号。アクセスコードは Correios Web Services ポータル（cws.correios.com.br。ホモロゲーション用は cwshom.correios.com.br）で生成します。また、発送元の CEP も必要です。認証情報がない場合、プラグインは固定料金のみで動作します。

VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインでのみ使用できます。

インストール

1. WordPress で Plugins > Add New > Upload Plugin に進み、プラグインの ZIP ファイルを選択して Install Now をクリックします。FTP で vfd_correios フォルダを /wp-content/plugins/ にアップロードすることもできます。

2. Activate をクリックします。

3. 設定を開きます: WooCommerce > Settings > Shipping > VibeFox Correios。または、プラグインの一覧画面でプラグイン名の下にある Settings をクリックします。

4. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。

5. Correios API ユーザー、アクセスコード、posting card 番号、発送元 CEP、サービスを入力します。ストアの通貨が BRL でない場合は、BRL のレートを入力します。他の国と、フォールバック用の固定料金を入力してください（設定の項を参照）。

6. WooCommerce > Settings > Shipping > Shipping zones で、配送ゾーンに VibeFox Correios を追加するか、Ignore shipping zones をオンにして国を選択します。

設定

すべての設定は 1 つのページにあります: WooCommerce > Settings > Shipping > VibeFox Correios。設定はすべての配送ゾーンに適用されます。ゾーンに配送方法を追加すると、ゾーンの画面にはフィールドが 1 つだけ表示されます:

Title (zone): このゾーンで購入者に表示される名前。空欄にすると、全体の Method title が使われます。

設定ページには、リアルタイム料金や配送方法が機能しない場合に警告が表示されます。3 つの認証情報の一部しか入力されていない場合、発送元 CEP が未入力の場合、通貨が BRL でないストアで BRL のレートが未入力の場合、認証情報も固定料金もない場合です。設定を保存するたびに、キャッシュされた料金と API トークンが消去されます。数値は小数点またはカンマで入力できます。

一般

Enable/Disable: すべてのゾーンで配送方法をオンまたはオフにします。

Method title: カートとチェックアウトで表示される配送方法の名前。デフォルト: Correios。ゾーンごとに独自のタイトルで上書きできます。

Tax status: Taxable は配送料に WooCommerce の税金を加算します。None は加算しません。

Correios API（ブラジルのリアルタイム料金）

ブラジルの住所では、料金は Correios の料金 API から取得されます。API が料金を返さない場合（API の停止、CEP が対象外、荷物が大きすぎるなど）は、Country prices の固定料金が使われます。固定料金もない場合は、配送方法が非表示になります。

API user: Meu Correios ポータルのログイン情報。通常は契約の CNPJ または CPF です。

Access code: Correios Web Services ポータルで生成される API アクセスコード（código de acesso）。ポータルのパスワードではありません。

Posting card: 契約の posting card（cartão de postagem）番号。10 桁で、通常は 2 つの 0 で始まります（例: 0012345678）。短い番号は先頭に 0 を付けて 10 桁にします。番号は Correios の Correios Fácil ページで確認できます。

Homologation: ホモロゲーション用のアクセスコードを使い、Correios のホモロゲーション（テスト）環境を利用します。本番のストアでは無効にしてください。

Origin CEP: 荷物を発送する CEP（8 桁）。例: 01001-000。

Service: チェックアウトで料金を計算する Correios のサービス。小売コード: PAC（04510、デフォルト）、SEDEX（04014）、SEDEX 12（04782）、SEDEX 10（04790）、SEDEX Hoje（04804）。契約コード: PAC（03298）、SEDEX（03220）、SEDEX 12（03140）、SEDEX 10（03158）、SEDEX Hoje（03204）、Correios Mini Envios（04227）。契約コードには、そのサービスを含む契約の posting card が必要です。

Other service code: 任意。リストにない、契約内の 5 桁のサービスコード（例: 03085）。入力すると Service の代わりに使用されます。

Package format: Correios に送信する荷物の種類。

Default product weight (kg): 重量が設定されていない商品ごとに Correios へ送信される重量。Default: 0.3。商品の重量とサイズはストアの単位から変換され、カートは 1 つの荷物として計算されます。

BRL → store currency rate: フィールド名にはストアの通貨が表示されます。Correios の料金は BRL 建てです。ストアの通貨が BRL でない場合は、1 BRL がストアの通貨でいくらに相当するかを入力します（例: 0.17）。入力しないと、リアルタイム料金は使用されません。ストアの通貨が BRL の場合は空欄にします。

固定料金（ブラジル以外の国、API の認証情報がない場合、および API が料金を返さない場合のフォールバックに使用）

Country prices: 国の表です。ストアの通貨で、Base（基本料金）と、カートの重量ごとの料金を設定します: XS は 1 kg まで、S は 1～2 kg、M は 2～3 kg、L は 3～5 kg、XL は 5 kg 超。サイズの料金が空欄またはゼロの場合は Base の料金を使用します。Add country をクリックして行を追加し、× をクリックして行を削除します。* Default (all other countries) の行は、独自の行がないすべての国の料金を設定します。行がない国（* の行もない場合）には固定料金が適用されません。基本料金を 0 にすると、その国は送料無料になります。

Fixed price per: Order は料金を 1 回だけ請求します。Item (price × quantity) は、カート内の商品数を掛けて請求します。これは固定料金にのみ適用されます。リアルタイム料金は常に荷物全体で計算されます。

条件

Min cart weight (kg): カートの重量がこの値より小さい場合、配送方法を非表示にします。0 は制限なしを意味します。

Max cart weight (kg): カートの重量がこの値より大きい場合、配送方法を非表示にします。デフォルト: 30。0 は制限なしを意味します。Correios の PAC と SEDEX の荷物は最大 30 kg まで可能です。

Minimum order amount: カートの小計がこの金額に達した場合のみ配送方法を表示します。空欄にすると常に表示されます。

Excluded shipping classes: カート内のいずれかの商品が、これらの WooCommerce 配送クラスに該当する場合、配送方法を非表示にします。

Free shipping: 下記の金額以上で送料無料にします。

Free shipping from: 送料が無料になるカートの小計。この場合、API へのリクエストは行われません。

配送ゾーンを使わない場合の利用可能性

Ignore shipping zones: どのゾーンに一致するかに関係なく、下記の国に対して配送方法を提供します。

Countries: このモードでの配送先の国。空欄にすると、ストアが配送するすべての国が対象になります。このフィールドは Ignore shipping zones がオンの場合にのみ使われます。

詳細設定

Debug log: 料金の計算を WooCommerce > Status > Logs に記録します（ソース: vfd-correios）。API のエラーは、このオプションがオフでも常に記録されます。API ユーザー、アクセスコード、posting card、トークン、購入者の CEP は記録されません。

Remove data on uninstall: オンにすると、プラグインを削除したときに、その設定、ゾーンの配送方法、キャッシュされた料金が削除されます。プラグインを無効化しても、何も削除されません。

チェックアウト時の動作

購入者が配送先の住所を入力すると、WooCommerce はプラグインに料金を問い合わせます。プラグインはまず条件を確認します: カートの重量、最低注文金額、除外する配送クラス。送料無料が適用される場合、購入者は無料の料金を受け取り、Correios へのリクエストは送信されません。

認証情報が設定されたブラジルの住所の場合、プラグインは最初に posting card の API トークンを取得します。トークンには契約番号と地域営業所の番号も含まれるため、料金はお客様の契約の料金になります。次に、発送元と配送先の CEP、グラム単位の荷物の重量、cm 単位の荷物のサイズを基に、選択したサービスの料金をリクエストします。料金のリクエストは、配送先の CEP が 8 桁の場合にのみ行われます。すべての商品にサイズがある場合は、それらから荷物のサイズを推定します。そうでない場合は、Correios の最小サイズを送信します。30 kg を超える荷物は API に送信されません。BRL の料金はお客様のレートで換算されます。サービスは Correios service として、注文の配送行に保存され、注文の管理画面に表示されます。

料金は荷物ごとに 1 時間キャッシュされます。失敗したリクエストは 10 分間キャッシュされるため、API の停止のたびにチェックアウトの更新が遅くなることはありません。トークンは期限切れの少し前までキャッシュされ、自動的に更新されます。Correios がトークンを拒否した場合は、新しいトークンを取得し、料金のリクエストを 1 回だけ再試行します。API のタイムアウトは 12 秒です。

API が料金を返さない場合は固定料金が使われます。固定料金がない場合は、配送方法が非表示になります。購入者に API のエラーの詳細が表示されることはありません。エラーは WooCommerce のログに記録されます。

この配送方法は、クラシックチェックアウトと、カートおよびチェックアウトのブロックで動作します。WooCommerce High-Performance Order Storage（HPOS）に対応しています。

プラグインが計算するのは料金のみです。Correios の国際料金（Exporta Fácil、Packet）、配達日数の見積もり、送り状、事前登録、通関申告、追跡は利用できません。購入者は Correios の営業所やロッカーを選択できません。追加サービス（申告価額、手渡し、受取通知）は追加されません。ストアごとに 1 つの Correios サービスのみが表示され、通貨レートは自動的に更新されません。

ライセンスキー

プラグインは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロックは WooCommerce > Settings > Shipping > VibeFox Correios の上部にあります。キーを License key に貼り付け、Activate をクリックします。ブロックには、ライセンスの有効期限日やお客様のドメインなどのステータスが表示されます。Check now でステータスを再確認、Change key で別のキーを入力、Remove key でこのサイトからキーを削除します。Manage licenses and domains in your account のリンクから、vibefox.net のアカウントを開けます。

1 つのキーは 1 つのドメインでのみ使用できます。サイトからキーを削除しても、ドメインの枠は解放されません。枠は vibefox.net のアカウントで解放してください。

有効なキーがない場合、Correios はチェックアウトで購入者に表示されません。ログインしているストアの管理者には表示されますが、(unlicensed — visible to admins only) と表示されるため、キーを購入する前にプラグインの設定とテストができます。プラグインのページと WooCommerce のページには、リマインダーが表示されます。既存の注文には影響しません。

ライセンスの期限が切れても、プラグインは動作を続けますが、アップデートとサポートには更新が必要です。ステータスはバックグラウンドで自動的に再確認されます。

トラブルシューティング

チェックアウトに Correios が表示されない: ライセンスが有効であること、Enable/Disable がオンであること、配送方法が購入者の国のゾーンに追加されていること（または Ignore shipping zones がオンで、その国が許可されていること）を確認してください。重量の制限、Minimum order amount、Excluded shipping classes も確認してください。リアルタイム料金がない場合は、その国または * の固定料金が必要です。

Correios の料金ではなく固定料金が表示される: WooCommerce > Status > Logs を開き、ソースで vfd-correios を選択します。Correios のエラーがここに記録されています: アクセスコードの誤り、契約にないサービス、CEP が対象外、30 kg を超える荷物、サイズの制限超過など。発送元 CEP が設定されていること、およびストアの通貨が BRL でない場合は BRL のレートが設定されていることも確認してください。すべての計算を確認するには Debug log をオンにします。

トークンのリクエストが失敗する: API ユーザー、アクセスコード、posting card、環境を確認してください。ホモロゲーション用のアクセスコードは Homologation がオンの場合のみ、本番用のコードはオフの場合のみ機能します。

変更後に料金が古いままになる: 設定ページを保存してください。キャッシュされた料金と API トークンが消去されます。

ライセンスブロックにエラーが表示される: ブロック内のメッセージに従ってください。たとえば、キーが別のドメインで既に使われている場合は、vibefox.net のアカウントで枠を解放し、Check now をクリックします。サイトの住所が変わった場合は、Check now をクリックして、新しいドメインでキーを有効化します。ライセンスサーバーに接続できない場合、プラグインは最後に確認されたステータスで動作を続けます。

アンインストール

プラグインを無効化しても、すべてのデータは保持されます。削除するには、無効化してから Plugins ページで削除します。このプラグインのライセンスキーとライセンスのステータスは、常に削除されます。設定、ゾーンの配送方法、キャッシュされた料金は、Remove data on uninstall がオンだった場合にのみ削除されます。それ以外の場合は、後で再インストールするために残ります。注文が変更されることはありません。

Correios は、その所有者の商標です。本プラグインは Correios と提携しておらず、Correios による推奨も受けていません。