Easyship (独立発行者) (プレビュー)
Easyship は、手間のかからない世界中の配送オプションを Web サイトに追加し、倉庫、ERP、またはプラットフォームにエンドツーエンドの配送機能を追加するための強力なサービスを提供します。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Troy Taylor |
[URL] | https://www.hitachisolutions.com |
メール | ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
発行者 | Troy Taylor |
Web サイト | https://www.easyship.com/ |
プライバシー ポリシー | https://www.easyship.com/legal/privacy |
カテゴリー | ビジネス管理;コマース |
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
名前 | タイプ | 説明 | 必須 |
---|---|---|---|
API アクセス トークン (形式: Bearer APIAccessToken) | securestring | この API に対する API アクセス トークン (形式: Bearer APIAccessToken) | True |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
すべてのボックスを一覧表示 |
使用可能なすべての配送業者ボックスの一覧を取得します。 |
すべての出荷の一覧表示 |
すべての出荷のリストを取得します。 |
チェックポイントを取得 |
出荷チェックポイントの詳細を取得します。 |
ピックアップのリクエスト (V1) |
集荷が作成されると、集荷リクエストが宅配業者に直接行われ、宅配業者が参照番号を返します。 参照番号は、宅配業者の顧客サービスに連絡するときに使用できます。 ピックアップ スロットを選択する必要があります。今後のピックアップ スロットは、「利用可能なピックアップ スロットを取得する」アクションを使用して見つけることができます。 |
倉庫の状態を更新 |
出荷の倉庫の状態を更新します。 Easyship 統合倉庫の 1 つで履行された出荷でのみ使用できます。 |
出荷を作成 |
荷物に関する情報を作成および取得します。 |
出荷を削除 (V1) |
削除して、出荷削除の確認を受け取ります。 |
出荷を取得 |
出荷の詳細を取得します。 |
出荷を更新 |
出荷の詳細を更新します。 |
出荷ラベルを購入 (V1) |
配送ラベルに関する情報を購入して取得します。 |
利用可能なピックアップ スロットを取得 (V1) |
利用可能なピックアップ スロットは、特定の宅配業者、現地時間、および今後 7 日間で計算されます。 次に、「集荷のリクエスト」アクションを使用して集荷をリクエストできます。 |
品目カテゴリを取得 |
出荷カテゴリのリストと、カテゴリを使用するためのスラッグを取得します。 |
料金と税金を取得 |
将来の出荷の出荷見積もりのリストを取得します。 |
追跡ステータスを取得 |
出荷の追跡ステータスを取得します。 |
すべてのボックスを一覧表示
使用可能なすべての配送業者ボックスの一覧を取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ボックス
|
boxes | array of object | |
ID
|
boxes.id | string |
一意識別子。 |
宅配業者包括名
|
boxes.courier_umbrella_name | string |
宅配業者包括名。 |
名前
|
boxes.name | string |
名前。 |
置換フィールド
|
boxes.slug | string |
置換フィールド。 |
外側の長さ
|
boxes.outer_length | float |
外側の長さ。 |
外側の幅
|
boxes.outer_width | float |
外側の幅。 |
外側の高さ
|
boxes.outer_height | float |
外側の高さ。 |
重さ
|
boxes.weight | float |
重さ。 |
すべての出荷の一覧表示
すべての出荷のリストを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Easyship 出荷 ID
|
easyship_shipment_id | string |
Easyship 出荷の一意識別子。 |
|
プラットフォーム注文番号
|
platform_order_number | string |
プラットフォーム注文番号。 |
|
ぺージ
|
page | integer |
ページ。 |
|
ページ当たり
|
per_page | integer |
ページあたりの数。 |
|
作成開始時刻
|
created_at_from | string |
作成開始時刻。 |
|
作成終了時刻
|
created_at_to | string |
作成終了時刻。 |
|
確認開始時刻
|
confirmed_at_from | string |
確認開始時刻。 |
|
確認終了時刻
|
confirm_at_to | string |
確認終了時刻。 |
|
ラベル生成開始時刻
|
label_generated_at_from | string |
ラベル生成開始時刻。 |
|
ラベル生成終了時刻
|
label_generated_at_to | string |
ラベル生成終了時刻。 |
|
出荷先の都道府県
|
shipment_state | string |
出荷先の都道府県。 |
|
集荷先の都道府県
|
pickup_state | string |
集荷先の都道府県。 |
|
配送先の都道府県
|
delivery_state | string |
配送先の都道府県。 |
|
ラベルの状態
|
label_state | string |
ラベルの状態。 |
|
倉庫の状態
|
warehouse_state | string |
倉庫の状態。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
出荷
|
shipments | array of object | |
Easyship 出荷 ID
|
shipments.easyship_shipment_id | string |
Easyship 出荷の一意識別子。 |
作成日
|
shipments.created_at | string |
作成日時。 |
更新日
|
shipments.updated_at | string |
更新日。 |
ラベルの支払い日時
|
shipments.label_paid_at | string |
ラベルの支払い日時 |
ラベルの生成日時
|
shipments.label_generated_at | string |
生成日時。 |
注文作成日時
|
shipments.order_created_at | string |
注文作成日時。 |
住所
|
shipments.origin_address.line_1 | string |
住所。 |
住所行 2
|
shipments.origin_address.line_2 | string |
住所明細行 2。 |
都道府県
|
shipments.origin_address.state | string |
都道府県。 |
都市
|
shipments.origin_address.city | string |
市区町村。 |
郵便番号
|
shipments.origin_address.postal_code | string |
郵便番号。 |
国番号
|
shipments.origin_address.country_alpha2 | string |
国番号。 |
連絡先の名前
|
shipments.origin_address.contact_name | string |
取引先担当者の名。 |
会社名
|
shipments.origin_address.company_name | string |
会社名。 |
取引先担当者の電話番号
|
shipments.origin_address.contact_phone | string |
取引先担当者の電話番号です。 |
連絡先メール
|
shipments.origin_address.contact_email | string |
取引先担当者のメール アドレスです。 |
住所
|
shipments.sender_address.line_1 | string |
住所。 |
住所行 2
|
shipments.sender_address.line_2 | string |
住所明細行 2。 |
都道府県
|
shipments.sender_address.state | string |
都道府県。 |
都市
|
shipments.sender_address.city | string |
市区町村。 |
郵便番号
|
shipments.sender_address.postal_code | string |
郵便番号。 |
国番号
|
shipments.sender_address.country_alpha2 | string |
国番号。 |
連絡先の名前
|
shipments.sender_address.contact_name | string |
取引先担当者の名。 |
会社名
|
shipments.sender_address.company_name | string |
会社名。 |
取引先担当者の電話番号
|
shipments.sender_address.contact_phone | string |
取引先担当者の電話番号です。 |
連絡先メール
|
shipments.sender_address.contact_email | string |
取引先担当者のメール アドレスです。 |
住所
|
shipments.return_address.line_1 | string |
住所。 |
住所行 2
|
shipments.return_address.line_2 | string |
住所明細行 2。 |
都道府県
|
shipments.return_address.state | string |
都道府県。 |
都市
|
shipments.return_address.city | string |
市区町村。 |
郵便番号
|
shipments.return_address.postal_code | string |
郵便番号。 |
国番号
|
shipments.return_address.country_alpha2 | string |
国番号。 |
連絡先の名前
|
shipments.return_address.contact_name | string |
取引先担当者の名。 |
会社名
|
shipments.return_address.company_name | string |
会社名。 |
取引先担当者の電話番号
|
shipments.return_address.contact_phone | string |
取引先担当者の電話番号です。 |
連絡先メール
|
shipments.return_address.contact_email | string |
取引先担当者のメール アドレスです。 |
住所
|
shipments.destination_address.line_1 | string |
住所。 |
住所行 2
|
shipments.destination_address.line_2 | string |
住所明細行 2。 |
都道府県
|
shipments.destination_address.state | string |
都道府県。 |
都市
|
shipments.destination_address.city | string |
市区町村。 |
郵便番号
|
shipments.destination_address.postal_code | string |
郵便番号。 |
国番号
|
shipments.destination_address.country_alpha2 | string |
国番号。 |
連絡先の名前
|
shipments.destination_address.contact_name | string |
取引先担当者の名。 |
会社名
|
shipments.destination_address.company_name | string |
会社名。 |
取引先担当者の電話番号
|
shipments.destination_address.contact_phone | string |
取引先担当者の電話番号です。 |
連絡先メール
|
shipments.destination_address.contact_email | string |
取引先担当者のメール アドレスです。 |
プラットフォーム名
|
shipments.order_data.platform_name | string |
プラットフォーム名。 |
プラットフォーム注文番号
|
shipments.order_data.platform_order_number | string |
プラットフォーム注文番号。 |
注文タグ リスト
|
shipments.order_data.order_tag_list | array of string |
注文タグ リスト |
販売者のメモ
|
shipments.order_data.seller_notes | string |
販売者のメモ。 |
購入者のメモ
|
shipments.order_data.buyer_notes | string |
購入者のメモ。 |
住宅として設定
|
shipments.set_as_residential | boolean |
住宅として設定されているかどうか |
荷受人納税者 ID
|
shipments.consignee_tax_id | string |
荷受人納税者識別子。 |
EEI リファレンス
|
shipments.eei_reference | string |
EEI リファレンス。 |
インターコムズ
|
shipments.incoterms | string |
インターコムズ。 |
保険あり
|
shipments.insurance.is_insured | boolean |
保険がかけられているかどうか。 |
保険金額
|
shipments.insurance.insured_amount | integer |
保険金額。 |
保険通貨
|
shipments.insurance.insured_currency | string |
保険通貨。 |
小包
|
shipments.parcels | array of object | |
実際の重さ合計
|
shipments.parcels.total_actual_weight | float |
実際の重さ合計。 |
合計関税額
|
shipments.parcels.total_customs_value | float |
合計関税額。 |
合計寸法重量
|
shipments.parcels.total_dimensional_weight | float |
合計寸法重量。 |
合計容積重量
|
shipments.parcels.total_volumetric_weight | float |
合計容積重量。 |
ID
|
shipments.parcels.box.id | string |
一意識別子。 |
宅配業者包括名
|
shipments.parcels.box.courier_umbrella_name | string |
宅配業者包括名。 |
名前
|
shipments.parcels.box.name | string |
名前。 |
置換フィールド
|
shipments.parcels.box.slug | string |
置換フィールド。 |
外側の長さ
|
shipments.parcels.box.outer_length | float |
外側の長さ。 |
外側の幅
|
shipments.parcels.box.outer_width | float |
外側の幅。 |
外側の高さ
|
shipments.parcels.box.outer_height | float |
外側の高さ。 |
重さ
|
shipments.parcels.box.weight | integer |
重さ。 |
アイテム
|
shipments.parcels.items | array of object | |
説明
|
shipments.parcels.items.description | string |
説明。 |
カテゴリー
|
shipments.parcels.items.category | string |
カテゴリ。 |
SKU
|
shipments.parcels.items.sku | string |
SKU。 |
数量
|
shipments.parcels.items.quantity | integer |
数量です。 |
実重量
|
shipments.parcels.items.actual_weight | integer |
実重量。 |
寸法重量
|
shipments.parcels.items.dimensional_weight | integer |
寸法重量。 |
容積重量
|
shipments.parcels.items.volumetric_weight | integer |
容積重量。 |
元の通貨
|
shipments.parcels.items.origin_currency | string |
元の通貨。 |
元の関税額
|
shipments.parcels.items.origin_customs_value | integer |
元の関税額。 |
申告通貨
|
shipments.parcels.items.declared_currency | string |
申告通貨。 |
申告税関額
|
shipments.parcels.items.declared_customs_value | integer |
申告税関額。 |
長さ
|
shipments.parcels.items.dimensions.length | integer |
長さ。 |
幅
|
shipments.parcels.items.dimensions.width | integer |
幅。 |
高さ
|
shipments.parcels.items.dimensions.height | integer |
高さ。 |
合計関税額
|
shipments.total_customs_value | float |
合計関税額。 |
実際の重さ合計
|
shipments.total_actual_weight | float |
実際の重さ合計。 |
合計寸法重量
|
shipments.total_dimensional_weight | float |
合計寸法重量。 |
合計容積重量
|
shipments.total_volumetric_weight | float |
合計容積重量。 |
出荷先の都道府県
|
shipments.shipment_state | string |
出荷先の都道府県。 |
集荷先の都道府県
|
shipments.pickup_state | string |
集荷先の都道府県。 |
配送先の都道府県
|
shipments.delivery_state | string |
配送先の都道府県。 |
ラベルの状態
|
shipments.label_state | string |
ラベルの状態。 |
倉庫の状態
|
shipments.warehouse_state | string |
倉庫の状態。 |
追跡
|
shipments.trackings | array of object | |
追跡番号
|
shipments.trackings.tracking_number | string |
追跡番号。 |
ローカル追跡番号
|
shipments.trackings.local_tracking_number | string |
ローカル追跡番号。 |
代替追跡番号
|
shipments.trackings.alternate_tracking_number | string |
代替追跡番号。 |
区間番号
|
shipments.trackings.leg_number | integer |
区間番号。 |
ハンドラー
|
shipments.trackings.handler | string |
ハンドラー。 |
追跡状態
|
shipments.trackings.tracking_state | string |
追跡状態。 |
追跡ページ URL
|
shipments.tracking_page_url | string |
追跡ページの URL アドレス。 |
出荷ドキュメント
|
shipments.shipping_documents | array of |
出荷ドキュメント。 |
通貨
|
shipments.currency | string |
通貨。 |
ID
|
shipments.selected_courier.id | string |
一意識別子。 |
レート
|
shipments.rates | array of object | |
宅配業者 ID
|
shipments.rates.courier_id | string |
宅配業者の一意識別子。 |
宅配業者名
|
shipments.rates.courier_name | string |
宅配業者名。 |
最短配送時間
|
shipments.rates.min_delivery_time | integer |
最短配送時間。 |
最長配送時間
|
shipments.rates.max_delivery_time | integer |
最長配送時間。 |
金額に対する価値のランク
|
shipments.rates.value_for_money_rank | integer |
金額に対する価値のランク。 |
配送時間ランク
|
shipments.rates.delivery_time_rank | integer |
配送時間ランク。 |
発送料金
|
shipments.rates.shipment_charge | float |
発送料金。 |
燃料割増金
|
shipments.rates.fuel_surcharge | float |
燃料割増金。 |
遠隔地追加料金
|
shipments.rates.remote_area_surcharge | integer |
遠隔地追加料金。 |
特大追加料金
|
shipments.rates.oversized_surcharge | integer |
特大追加料金。 |
追加サービス追加料金
|
shipments.rates.additional_services_surcharge | integer |
追加サービス追加料金。 |
住宅全額
|
shipments.rates.residential_full_fee | integer |
住宅全額。 |
住宅割引料金
|
shipments.rates.residential_discounted_fee | integer |
住宅割引料金。 |
出荷合計料金
|
shipments.rates.shipment_charge_total | float |
出荷合計料金。 |
倉庫手数料
|
shipments.rates.warehouse_handling_fee | integer |
倉庫手数料。 |
保険料
|
shipments.rates.insurance_fee | integer |
保険料。 |
消費税
|
shipments.rates.sales_tax | integer |
消費税。 |
地方消費税
|
shipments.rates.provincial_sales_tax | integer |
地方消費税。 |
DDP 取り扱い手数料
|
shipments.rates.ddp_handling_fee | integer |
DDP 取り扱い手数料。 |
輸入税
|
shipments.rates.import_tax_charge | integer |
輸入税。 |
輸入関税
|
shipments.rates.import_duty_charge | integer |
輸入関税。 |
合計料金
|
shipments.rates.total_charge | float |
合計料金。 |
しきい値を超えている
|
shipments.rates.is_above_threshold | boolean |
しきい値を超えているかどうか。 |
インターコムズ
|
shipments.rates.incoterms | string |
インターコムズ。 |
予測輸入税
|
shipments.rates.estimated_import_tax | integer |
予測輸入税。 |
予測輸入関税
|
shipments.rates.estimated_import_duty | integer |
予測輸入関税。 |
使用可能な引き渡しオプション
|
shipments.rates.available_handover_options | string |
使用可能な引き渡しオプション。 |
追跡評価
|
shipments.rates.tracking_rating | integer |
追跡評価。 |
Easyship Rating
|
shipments.rates.easyship_rating | integer |
Easyship 評価。 |
宅配業者の備考
|
shipments.rates.courier_remarks | string |
宅配業者の備考。 |
支払い受取人
|
shipments.rates.payment_recipient | string |
支払い受取人。 |
コード
|
shipments.rates.discount.code | string |
コード。 |
金額
|
shipments.rates.discount.amount | integer |
金額。 |
有効期限
|
shipments.rates.discount.expires_at | string |
有効期限。 |
割合
|
shipments.rates.discount.percentage | string |
割合。 |
有効なインコタームズ
|
shipments.rates.effective_incoterms | string |
有効なインコタームズ。 |
チェックポイントを取得
出荷チェックポイントの詳細を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Easyship 出荷 ID
|
easyship_shipment_id | True | string |
Easyship 出荷の一意識別子。 |
プラットフォーム注文番号
|
platform_order_number | string |
プラットフォーム注文番号。 |
|
ぺージ
|
page | integer |
ページ。 |
|
ページ当たり
|
per_page | integer |
ページあたりの数。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
合計ページ
|
total_page | integer |
合計ページ。 |
現在のページ
|
current_page | integer |
現在のページ。 |
出荷
|
shipments | array of object | |
Easyship 出荷 ID
|
shipments.easyship_shipment_id | string |
Easyship 出荷の一意識別子。 |
プラットフォーム注文番号
|
shipments.platform_order_number | string |
プラットフォーム注文番号。 |
元
|
shipments.origin | string |
元。 |
宛先
|
shipments.destination | string |
目的地。 |
ステータス
|
shipments.status | string |
ステータス。 |
追跡番号
|
shipments.tracking_number | string |
追跡番号。 |
追跡ページ URL
|
shipments.tracking_page_url | string |
追跡ページの URL アドレス。 |
チェックポイント
|
shipments.checkpoints | array of object | |
受注番号
|
shipments.checkpoints.order_number | integer |
受注番号。 |
ハンドラー
|
shipments.checkpoints.handler | string |
ハンドラー。 |
メッセージ
|
shipments.checkpoints.message | string |
メッセージ。 |
場所
|
shipments.checkpoints.location | string |
場所。 |
都市
|
shipments.checkpoints.city | string |
市区町村。 |
国
|
shipments.checkpoints.country_name | string |
国。 |
国番号
|
shipments.checkpoints.country_iso3 | string |
国番号。 |
座標
|
shipments.checkpoints.coordinates | array of |
座標。 |
都道府県
|
shipments.checkpoints.state | string |
都道府県。 |
郵便番号
|
shipments.checkpoints.postal_code | string |
郵便番号。 |
チェックポイント時刻
|
shipments.checkpoints.checkpoint_time | string |
チェックポイント時刻。 |
プライマリ ステータス
|
shipments.checkpoints.primary_status | string |
プライマリ ステータス。 |
ピックアップのリクエスト (V1)
集荷が作成されると、集荷リクエストが宅配業者に直接行われ、宅配業者が参照番号を返します。 参照番号は、宅配業者の顧客サービスに連絡するときに使用できます。 ピックアップ スロットを選択する必要があります。今後のピックアップ スロットは、「利用可能なピックアップ スロットを取得する」アクションを使用して見つけることができます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
宅配業者 ID
|
courier_id | string |
宅配業者の識別子。 |
|
希望日
|
preferred_date | string |
希望日。 |
|
希望最大時間
|
preferred_max_time | string |
希望最大時間。 |
|
希望最小時間
|
preferred_min_time | string |
希望最小時間。 |
|
Easyship 出荷 ID
|
easyship_shipment_ids | array of string |
Easyship 出荷識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
宅配業者 ID
|
courier_id | string |
宅配業者の識別子。 |
宅配業者名
|
courier_name | string |
宅配業者名。 |
Easyship 出荷 ID
|
easyship_shipment_ids | array of string |
Easyship 出荷識別子。 |
Easyship 集荷 ID
|
pickup.easyship_pickup_id | string |
Easyship 集荷識別子。 |
希望最小時間
|
pickup.preferred_min_time | string |
希望最小時間。 |
希望最大時間
|
pickup.preferred_max_time | string |
希望最大時間。 |
ピックアップ照合番号
|
pickup.pickup_reference_number | string |
ピックアップ照合番号。 |
集荷手数料
|
pickup.pickup_fee | string |
集荷手数料。 |
プロバイダー名
|
pickup.provider_name | string |
プロバイダー名。 |
プロバイダー顧客サービスの電話
|
pickup.provider_customer_service_phone | string |
プロバイダー顧客サービスの電話番号。 |
出荷数
|
pickup.shipments_count | string |
出荷数。 |
実際の重さ合計
|
pickup.total_actual_weight | string |
実際の重さ合計。 |
集荷先の都道府県
|
pickup.pickup_state | string |
集荷先の都道府県。 |
住所
|
pickup.address.line_1 | string |
住所。 |
住所行 2
|
pickup.address.line_2 | string |
住所明細行 2。 |
住所行 3
|
pickup.address.line_3 | string |
住所明細行 3。 |
郵便番号
|
pickup.address.postal_code | string |
郵便番号。 |
都市
|
pickup.address.city | string |
市区町村。 |
都道府県
|
pickup.address.state | string |
都道府県。 |
国
|
pickup.address.country | string |
国。 |
連絡先メール
|
pickup.address.contact_email | string |
取引先担当者のメール アドレスです。 |
取引先担当者の電話番号
|
pickup.address.contact_phone | string |
取引先担当者の電話番号です。 |
会社名
|
pickup.address.company_name | string |
会社名。 |
連絡先の名前
|
pickup.address.contact_name | string |
取引先担当者の名。 |
倉庫の状態を更新
出荷の倉庫の状態を更新します。 Easyship 統合倉庫の 1 つで履行された出荷でのみ使用できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Easyship 出荷 ID
|
easyship_shipment_id | string |
Easyship 出荷の一意識別子。 |
|
倉庫の状態
|
warehouse_state | string |
倉庫の状態。 |
|
Message
|
message | string |
メッセージ。 |
|
シリアル番号
|
serial_number | string |
シリアル番号。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Message
|
message | array of object | |
Easyship 出荷 ID
|
message.easyship_shipment_id | string |
Easyship 出荷の一意識別子。 |
倉庫の状態が更新済み
|
message.warehouse_state_updated | string |
更新された倉庫の状態 |
出荷を作成
荷物に関する情報を作成および取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
住所
|
line_1 | string |
住所。 |
|
住所行 2
|
line_2 | string |
住所明細行 2。 |
|
都道府県
|
state | string |
都道府県。 |
|
都市
|
city | string |
市区町村。 |
|
郵便番号
|
postal_code | string |
郵便番号。 |
|
国番号
|
country_alpha2 | string |
国番号。 |
|
連絡先の名前
|
contact_name | string |
取引先担当者の名。 |
|
会社名
|
company_name | string |
会社名。 |
|
取引先担当者の電話番号
|
contact_phone | string |
取引先担当者の電話番号です。 |
|
連絡先メール
|
contact_email | string |
取引先担当者のメール アドレスです。 |
|
住所
|
line_1 | string |
住所。 |
|
住所行 2
|
line_2 | string |
住所明細行 2。 |
|
都道府県
|
state | string |
都道府県。 |
|
都市
|
city | string |
市区町村。 |
|
郵便番号
|
postal_code | string |
郵便番号。 |
|
国番号
|
country_alpha2 | string |
国番号。 |
|
連絡先の名前
|
contact_name | string |
取引先担当者の名。 |
|
会社名
|
company_name | string |
会社名。 |
|
取引先担当者の電話番号
|
contact_phone | string |
取引先担当者の電話番号です。 |
|
連絡先メール
|
contact_email | string |
取引先担当者のメール アドレスです。 |
|
住所
|
line_1 | string |
住所。 |
|
住所行 2
|
line_2 | string |
住所明細行 2。 |
|
都道府県
|
state | string |
都道府県。 |
|
都市
|
city | string |
市区町村。 |
|
郵便番号
|
postal_code | string |
郵便番号。 |
|
国番号
|
country_alpha2 | string |
国番号。 |
|
連絡先の名前
|
contact_name | string |
取引先担当者の名。 |
|
会社名
|
company_name | string |
会社名。 |
|
取引先担当者の電話番号
|
contact_phone | string |
取引先担当者の電話番号です。 |
|
連絡先メール
|
contact_email | string |
取引先担当者のメール アドレスです。 |
|
住所
|
line_1 | string |
住所。 |
|
住所行 2
|
line_2 | string |
住所明細行 2。 |
|
都道府県
|
state | string |
都道府県。 |
|
都市
|
city | string |
市区町村。 |
|
郵便番号
|
postal_code | string |
郵便番号。 |
|
国番号
|
country_alpha2 | string |
国番号。 |
|
連絡先の名前
|
contact_name | string |
取引先担当者の名。 |
|
会社名
|
company_name | string |
会社名。 |
|
取引先担当者の電話番号
|
contact_phone | string |
取引先担当者の電話番号です。 |
|
連絡先メール
|
contact_email | string |
取引先担当者のメール アドレスです。 |
|
住宅として設定
|
set_as_residential | boolean |
住宅として設定されているかどうか |
|
荷受人納税者 ID
|
consignee_tax_id | string |
荷受人納税者識別子。 |
|
EEI リファレンス
|
eei_reference | string |
EEI リファレンス。 |
|
インターコムズ
|
incoterms | string |
インターコムズ。 |
|
保険あり
|
is_insured | boolean |
保険がかけられているかどうか。 |
|
保険金額
|
insured_amount | integer |
保険金額。 |
|
保険通貨
|
insured_currency | string |
保険通貨。 |
|
プラットフォーム名
|
platform_name | string |
プラットフォーム名。 |
|
プラットフォーム注文番号
|
platform_order_number | string |
プラットフォーム注文番号。 |
|
注文タグ リスト
|
order_tag_list | array of string |
注文タグ リスト。 |
|
販売者のメモ
|
seller_notes | string |
販売者のメモ。 |
|
購入者のメモ
|
buyer_notes | string |
購入者のメモ。 |
|
選択された宅配業者 ID
|
selected_courier_id | string |
選択された宅配業者識別子。 |
|
宅配業者のフォールバックを許可する
|
allow_courier_fallback | boolean |
宅配業者のフォールバックを許可するかどうか。 |
|
配送ルールを適用
|
apply_shipping_rules | boolean |
配送ルールが適用されたかどうか。 |
|
重さ
|
weight | string |
重さ。 |
|
寸法
|
dimensions | string |
寸法。 |
|
形式
|
format | string |
形式。 |
|
ラベル
|
label | string |
ラベル。 |
|
商業請求書
|
commercial_invoice | string |
商業請求書。 |
|
梱包明細
|
packing_slip | string |
梱包明細。 |
|
ラベルを購入
|
buy_label | boolean |
ラベルを購入するかどうか。 |
|
ラベル購入の同期
|
buy_label_synchronous | boolean |
ラベルを同期で購入するかどうか。 |
|
実際の重さ合計
|
total_actual_weight | float |
実際の重さ合計。 |
|
置換フィールド
|
slug | string | ||
長さ
|
length | integer |
長さ。 |
|
幅
|
width | integer |
幅。 |
|
高さ
|
height | integer |
高さ。 |
|
説明
|
description | string |
説明。 |
|
カテゴリ
|
category | string |
カテゴリ。 |
|
SKU
|
sku | string |
SKU。 |
|
数量
|
quantity | integer |
数量。 |
|
長さ
|
length | string |
長さ。 |
|
幅
|
width | string |
幅。 |
|
高さ
|
height | string |
高さ。 |
|
実重量
|
actual_weight | integer |
実重量。 |
|
申告通貨
|
declared_currency | string |
申告通貨。 |
|
申告税関額
|
declared_customs_value | integer |
申告税関額。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Status
|
status | string |
状態。 |
エラー
|
errors | array of |
エラー。 |
Easyship 出荷 ID
|
shipment.easyship_shipment_id | string |
Easyship 出荷識別子。 |
作成日
|
shipment.created_at | string |
作成日時。 |
更新日
|
shipment.updated_at | string |
更新時刻。 |
ラベルの支払い日時
|
shipment.label_paid_at | string |
ラベルの支払い日時 |
ラベルの生成日時
|
shipment.label_generated_at | string |
ラベルの生成日時。 |
注文作成日時
|
shipment.order_created_at | string |
注文作成日時。 |
住所
|
shipment.origin_address.line_1 | string |
住所。 |
住所行 2
|
shipment.origin_address.line_2 | string |
住所明細行 2。 |
都道府県
|
shipment.origin_address.state | string |
都道府県。 |
都市
|
shipment.origin_address.city | string |
市区町村。 |
郵便番号
|
shipment.origin_address.postal_code | string |
郵便番号。 |
国番号
|
shipment.origin_address.country_alpha2 | string |
国番号。 |
連絡先の名前
|
shipment.origin_address.contact_name | string |
取引先担当者の名。 |
会社名
|
shipment.origin_address.company_name | string |
会社名。 |
取引先担当者の電話番号
|
shipment.origin_address.contact_phone | string |
取引先担当者の電話番号です。 |
連絡先メール
|
shipment.origin_address.contact_email | string |
取引先担当者のメール アドレスです。 |
住所
|
shipment.sender_address.line_1 | string |
住所。 |
住所行 2
|
shipment.sender_address.line_2 | string |
住所明細行 2。 |
都道府県
|
shipment.sender_address.state | string |
都道府県。 |
都市
|
shipment.sender_address.city | string |
市区町村。 |
郵便番号
|
shipment.sender_address.postal_code | string |
郵便番号。 |
国番号
|
shipment.sender_address.country_alpha2 | string |
国番号。 |
連絡先の名前
|
shipment.sender_address.contact_name | string |
取引先担当者の名。 |
会社名
|
shipment.sender_address.company_name | string |
会社名。 |
取引先担当者の電話番号
|
shipment.sender_address.contact_phone | string |
取引先担当者の電話番号です。 |
連絡先メール
|
shipment.sender_address.contact_email | string |
取引先担当者のメール アドレスです。 |
住所
|
shipment.return_address.line_1 | string |
住所。 |
住所行 2
|
shipment.return_address.line_2 | string |
住所明細行 2。 |
都道府県
|
shipment.return_address.state | string |
都道府県。 |
都市
|
shipment.return_address.city | string |
市区町村。 |
郵便番号
|
shipment.return_address.postal_code | string |
郵便番号。 |
国番号
|
shipment.return_address.country_alpha2 | string |
国番号。 |
連絡先の名前
|
shipment.return_address.contact_name | string |
取引先担当者の名。 |
会社名
|
shipment.return_address.company_name | string |
会社名。 |
取引先担当者の電話番号
|
shipment.return_address.contact_phone | string |
取引先担当者の電話番号です。 |
連絡先メール
|
shipment.return_address.contact_email | string |
取引先担当者のメール アドレスです。 |
住所
|
shipment.destination_address.line_1 | string |
住所。 |
住所行 2
|
shipment.destination_address.line_2 | string |
住所明細行 2。 |
都道府県
|
shipment.destination_address.state | string |
都道府県。 |
都市
|
shipment.destination_address.city | string |
市区町村。 |
郵便番号
|
shipment.destination_address.postal_code | string |
郵便番号。 |
国番号
|
shipment.destination_address.country_alpha2 | string |
国番号。 |
連絡先の名前
|
shipment.destination_address.contact_name | string |
取引先担当者の名。 |
会社名
|
shipment.destination_address.company_name | string |
会社名。 |
取引先担当者の電話番号
|
shipment.destination_address.contact_phone | string |
取引先担当者の電話番号です。 |
連絡先メール
|
shipment.destination_address.contact_email | string |
取引先担当者のメール アドレスです。 |
プラットフォーム名
|
shipment.order_data.platform_name | string |
プラットフォーム名。 |
プラットフォーム注文番号
|
shipment.order_data.platform_order_number | string |
プラットフォーム注文番号。 |
注文タグ リスト
|
shipment.order_data.order_tag_list | array of string |
注文タグ リスト。 |
販売者のメモ
|
shipment.order_data.seller_notes | string |
販売者のメモ。 |
購入者のメモ
|
shipment.order_data.buyer_notes | string |
購入者のメモ。 |
住宅として設定
|
shipment.set_as_residential | boolean |
住宅として設定されているかどうか |
荷受人納税者 ID
|
shipment.consignee_tax_id | string |
荷受人納税者識別子。 |
EEI リファレンス
|
shipment.eei_reference | string |
EEI リファレンス。 |
インターコムズ
|
shipment.incoterms | string |
インターコムズ。 |
保険あり
|
shipment.insurance.is_insured | boolean |
保険がかけられているかどうか。 |
保険金額
|
shipment.insurance.insured_amount | integer |
保険金額。 |
保険通貨
|
shipment.insurance.insured_currency | string |
保険通貨。 |
小包数
|
shipment.parcels_count | integer |
小包数。 |
小包
|
shipment.parcels | array of object | |
実際の重さ合計
|
shipment.parcels.total_actual_weight | float |
実際の重さ合計。 |
合計関税額
|
shipment.parcels.total_customs_value | float |
合計関税額。 |
合計寸法重量
|
shipment.parcels.total_dimensional_weight | float |
合計寸法重量。 |
合計容積重量
|
shipment.parcels.total_volumetric_weight | float |
合計容積重量。 |
ID
|
shipment.parcels.box.id | string |
一意識別子。 |
置換フィールド
|
shipment.parcels.box.slug | string |
置換フィールド。 |
長さ
|
shipment.parcels.box.length | integer |
長さ。 |
幅
|
shipment.parcels.box.width | integer |
幅。 |
高さ
|
shipment.parcels.box.height | integer |
高さ。 |
アイテム
|
shipment.parcels.items | array of object | |
説明
|
shipment.parcels.items.description | string |
説明。 |
カテゴリ
|
shipment.parcels.items.category | string |
カテゴリ。 |
SKU
|
shipment.parcels.items.sku | string |
SKU。 |
数量
|
shipment.parcels.items.quantity | integer |
数量です。 |
実重量
|
shipment.parcels.items.actual_weight | integer |
実重量。 |
寸法重量
|
shipment.parcels.items.dimensional_weight | integer |
寸法重量。 |
容積重量
|
shipment.parcels.items.volumetric_weight | integer |
容積重量。 |
元の通貨
|
shipment.parcels.items.origin_currency | string |
元の通貨。 |
元の関税額
|
shipment.parcels.items.origin_customs_value | integer |
元の関税額。 |
申告通貨
|
shipment.parcels.items.declared_currency | string |
申告通貨。 |
申告税関額
|
shipment.parcels.items.declared_customs_value | integer |
申告税関額。 |
長さ
|
shipment.parcels.items.dimensions.length | integer |
長さ。 |
幅
|
shipment.parcels.items.dimensions.width | integer |
幅。 |
高さ
|
shipment.parcels.items.dimensions.height | integer |
高さ。 |
合計関税額
|
shipment.total_customs_value | float |
合計関税額。 |
実際の重さ合計
|
shipment.total_actual_weight | float |
実際の重さ合計。 |
合計寸法重量
|
shipment.total_dimensional_weight | float |
合計寸法重量。 |
合計容積重量
|
shipment.total_volumetric_weight | float |
合計容積重量。 |
出荷先の都道府県
|
shipment.shipment_state | string |
出荷先の都道府県。 |
集荷先の都道府県
|
shipment.pickup_state | string |
集荷先の都道府県。 |
配送先の都道府県
|
shipment.delivery_state | string |
配送先の都道府県。 |
ラベルの状態
|
shipment.label_state | string |
ラベルの状態。 |
倉庫の状態
|
shipment.warehouse_state | string |
倉庫の状態。 |
追跡
|
shipment.trackings | array of object | |
追跡番号
|
shipment.trackings.tracking_number | string |
追跡番号。 |
ローカル追跡番号
|
shipment.trackings.local_tracking_number | string |
ローカル追跡番号。 |
代替追跡番号
|
shipment.trackings.alternate_tracking_number | string |
代替追跡番号。 |
区間番号
|
shipment.trackings.leg_number | integer |
区間番号。 |
ハンドラー
|
shipment.trackings.handler | string |
ハンドラー。 |
追跡状態
|
shipment.trackings.tracking_state | string |
追跡状態。 |
追跡ページ URL
|
shipment.tracking_page_url | string |
追跡ページ URL。 |
出荷ドキュメント
|
shipment.shipping_documents | array of object | |
カテゴリ
|
shipment.shipping_documents.category | string |
カテゴリ。 |
必須
|
shipment.shipping_documents.required | boolean |
必須かどうか。 |
ページ サイズ
|
shipment.shipping_documents.page_size | string |
ページ サイズ。 |
形式
|
shipment.shipping_documents.format | string |
形式。 |
Base64 でエンコードされた文字列
|
shipment.shipping_documents.base64_encoded_strings | array of string |
Base64 でエンコードされた文字列。 |
URL
|
shipment.shipping_documents.url | string |
URL アドレス。 |
通貨
|
shipment.currency | string |
通貨。 |
ID
|
shipment.selected_courier.id | string |
一意識別子。 |
レート
|
shipment.rates | array of object | |
宅配業者 ID
|
shipment.rates.courier_id | string |
宅配業者の識別子。 |
宅配業者名
|
shipment.rates.courier_name | string |
宅配業者名。 |
最短配送時間
|
shipment.rates.min_delivery_time | integer |
最短配送時間。 |
最長配送時間
|
shipment.rates.max_delivery_time | integer |
最長配送時間。 |
金額に対する価値のランク
|
shipment.rates.value_for_money_rank | integer |
金額に対する価値のランク。 |
配送時間ランク
|
shipment.rates.delivery_time_rank | integer |
配送時間ランク。 |
発送料金
|
shipment.rates.shipment_charge | float |
発送料金。 |
燃料割増金
|
shipment.rates.fuel_surcharge | float |
燃料割増金。 |
遠隔地追加料金
|
shipment.rates.remote_area_surcharge | integer |
遠隔地追加料金。 |
特大追加料金
|
shipment.rates.oversized_surcharge | integer |
特大追加料金。 |
追加サービス追加料金
|
shipment.rates.additional_services_surcharge | integer |
追加サービス追加料金。 |
住宅全額
|
shipment.rates.residential_full_fee | integer |
住宅全額。 |
住宅割引料金
|
shipment.rates.residential_discounted_fee | integer |
住宅割引料金。 |
出荷合計料金
|
shipment.rates.shipment_charge_total | float |
出荷合計料金。 |
倉庫手数料
|
shipment.rates.warehouse_handling_fee | integer |
倉庫手数料。 |
保険料
|
shipment.rates.insurance_fee | integer |
保険料。 |
消費税
|
shipment.rates.sales_tax | integer |
消費税。 |
地方消費税
|
shipment.rates.provincial_sales_tax | integer |
地方消費税。 |
DDP 取り扱い手数料
|
shipment.rates.ddp_handling_fee | integer |
DDP 取り扱い手数料。 |
輸入税
|
shipment.rates.import_tax_charge | integer |
輸入税の変更。 |
輸入関税
|
shipment.rates.import_duty_charge | integer |
輸入関税。 |
合計料金
|
shipment.rates.total_charge | float |
合計料金。 |
しきい値を超えている
|
shipment.rates.is_above_threshold | boolean |
しきい値を超えているかどうか。 |
インターコムズ
|
shipment.rates.incoterms | string |
インターコムズ。 |
予測輸入税
|
shipment.rates.estimated_import_tax | integer |
予測輸入税。 |
予測輸入関税
|
shipment.rates.estimated_import_duty | integer |
予測輸入関税。 |
使用可能な引き渡しオプション
|
shipment.rates.available_handover_options | string |
使用可能な引き渡しオプション。 |
追跡評価
|
shipment.rates.tracking_rating | integer |
追跡評価。 |
Easyship Rating
|
shipment.rates.easyship_rating | integer |
Easyship 評価。 |
宅配業者の備考
|
shipment.rates.courier_remarks | string |
宅配業者の備考。 |
支払い受取人
|
shipment.rates.payment_recipient | string |
支払い受取人。 |
コード
|
shipment.rates.discount.code | string |
コード。 |
金額
|
shipment.rates.discount.amount | integer |
金額。 |
有効期限
|
shipment.rates.discount.expires_at | string |
有効期限。 |
割合
|
shipment.rates.discount.percentage | string |
割合。 |
有効なインコタームズ
|
shipment.rates.effective_incoterms | string |
有効なインコタームズ。 |
出荷を削除 (V1)
削除して、出荷削除の確認を受け取ります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Easyship 出荷 ID
|
easyship_shipment_id | True | string |
Easyship 出荷識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Status
|
status | string |
状態。 |
出荷を取得
出荷の詳細を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Easyship 出荷 ID
|
easyship_shipment_id | True | string |
Easyship 出荷識別子。 |
Format
|
format | string |
形式。 |
|
Label
|
label | string |
ラベル。 |
|
商業請求書
|
commercial_invoice | string |
商業請求書。 |
|
梱包明細
|
packing_slip | string |
梱包明細。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
作成日
|
created_at | string |
作成日時。 |
更新日
|
updated_at | string |
更新日時。 |
Easyship 出荷 ID
|
easyship_shipment_id | string |
Easyship 出荷識別子。 |
目的地名
|
destination_name | string |
目的地名。 |
宛先住所
|
destination_address_line_1 | string |
宛先住所。 |
宛先住所行 2
|
destination_address_line_2 | string |
宛先住所行 2。 |
宛先市区町村
|
destination_city | string |
宛先市区町村。 |
宛先都道府県
|
destination_state | string |
宛先都道府県。 |
配送先郵便番号
|
destination_postal_code | string |
配送先郵便番号。 |
宛先電話番号
|
destination_phone_number | string |
宛先の電話番号。 |
宛先メール アドレス
|
destination_email_address | string |
宛先メール アドレス。 |
受注のメモ
|
order_notes | string |
受注のメモ。 |
注文作成日時
|
order_created_at | string |
注文作成日時。 |
プラットフォーム名
|
platform_name | string |
プラットフォーム名。 |
プラットフォーム注文番号
|
platform_order_number | string |
プラットフォーム注文番号。 |
合計関税額
|
total_customs_value | float |
合計関税額。 |
実際の重さ合計
|
total_actual_weight | float |
実際の重さ合計。 |
合計寸法重量
|
total_dimensional_weight | float |
合計寸法重量。 |
合計容積重量
|
total_volumetric_weight | float |
合計容積重量。 |
保険あり
|
is_insured | boolean |
保険がかけられているかどうか。 |
通貨
|
currency | string |
通貨。 |
倉庫の状態
|
warehouse_state | string |
倉庫の状態。 |
名前
|
origin_country.name | string |
名前。 |
国番号
|
origin_country.alpha2 | string |
国番号。 |
名前
|
destination_country.name | string |
名前。 |
国番号
|
destination_country.alpha2 | string |
国番号。 |
アイテム
|
items | array of object | |
ID
|
items.id | string |
一意識別子。 |
説明
|
items.title | string |
説明。 |
SKU
|
items.sku | string |
SKU。 |
幅
|
items.width | integer |
幅。 |
長さ
|
items.length | integer |
長さ。 |
高さ
|
items.height | integer |
高さ。 |
実重量
|
items.actual_weight | float |
実重量。 |
寸法重量
|
items.dimensional_weight | float |
寸法重量。 |
容積重量
|
items.volumetric_weight | float |
容積重量。 |
申告税関額
|
items.declared_customs_value | integer |
申告税関額。 |
申告通貨
|
items.declared_currency | string |
申告通貨。 |
元の関税額
|
items.origin_customs_value | float |
元の関税額。 |
元の通貨
|
items.origin_currency | string |
元の通貨。 |
カテゴリ
|
items.category | string |
カテゴリ。 |
名前
|
box.name | string |
名前。 |
長さ
|
box.length | integer |
長さ。 |
幅
|
box.width | integer |
幅。 |
高さ
|
box.height | integer |
高さ。 |
ID
|
selected_courier.id | string |
一意識別子。 |
名前
|
selected_courier.name | string |
名前。 |
最短配送時間
|
selected_courier.min_delivery_time | integer |
最短配送時間。 |
最長配送時間
|
selected_courier.max_delivery_time | integer |
最長配送時間。 |
発送料金
|
selected_courier.shipment_charge | float |
発送料金。 |
燃料割増金
|
selected_courier.fuel_surcharge | float |
燃料割増金。 |
遠隔地追加料金
|
selected_courier.remote_area_surcharge | integer |
遠隔地追加料金。 |
出荷合計料金
|
selected_courier.shipment_charge_total | float |
出荷合計料金。 |
倉庫手数料
|
selected_courier.warehouse_handling_fee | integer |
倉庫手数料。 |
保険料
|
selected_courier.insurance_fee | integer |
保険料。 |
輸入税
|
selected_courier.import_tax_charge | integer |
輸入税。 |
輸入関税
|
selected_courier.import_duty_charge | integer |
輸入関税。 |
DDP 取り扱い手数料
|
selected_courier.ddp_handling_fee | integer |
DDP 取り扱い手数料。 |
合計料金
|
selected_courier.total_charge | float |
合計料金。 |
しきい値を超えている
|
selected_courier.is_above_threshold | boolean |
しきい値を超えているかどうか。 |
有効なインコタームズ
|
selected_courier.effective_incoterms | string |
有効なインコタームズ。 |
予測輸入税
|
selected_courier.estimated_import_tax | integer |
予測輸入税。 |
予測輸入関税
|
selected_courier.estimated_import_duty | integer |
予測輸入関税。 |
宅配業者が集荷
|
selected_courier.courier_does_pickup | boolean |
宅配業者が集荷するかどうか。 |
宅配業者ドロップオフ URL
|
selected_courier.courier_dropoff_url | string |
宅配便ドロップオフ URL アドレス。 |
宅配業者の備考
|
selected_courier.courier_remarks | string |
宅配業者の備考。 |
支払い受取人
|
selected_courier.payment_recipient | string |
支払い受取人。 |
必須
|
shipping_documents.label.required | boolean |
必須かどうか。 |
ページ サイズ
|
shipping_documents.label.page_size | string |
ページ サイズ。 |
形式
|
shipping_documents.label.format | string |
形式。 |
Base64 でエンコードされた文字列
|
shipping_documents.label.base64_encoded_strings | array of string |
Base64 でエンコードされた文字列。 |
URL
|
shipping_documents.label.url | string |
URL アドレス。 |
メッセージ
|
shipping_documents.label.message | string |
メッセージ。 |
必須
|
shipping_documents.commercial_invoice.required | boolean |
必須かどうか。 |
ページ サイズ
|
shipping_documents.commercial_invoice.page_size | string |
ページ サイズ。 |
形式
|
shipping_documents.commercial_invoice.format | string |
形式。 |
Base64 でエンコードされた文字列
|
shipping_documents.commercial_invoice.base64_encoded_strings | array of |
Base64 でエンコードされた文字列。 |
URL
|
shipping_documents.commercial_invoice.url | string |
URL アドレス。 |
必須
|
shipping_documents.packing_slip.required | boolean |
必須かどうか。 |
ページ サイズ
|
shipping_documents.packing_slip.page_size | string |
ページ サイズ。 |
形式
|
shipping_documents.packing_slip.format | string |
形式。 |
Base64 でエンコードされた文字列
|
shipping_documents.packing_slip.base64_encoded_strings | array of string |
Base64 でエンコードされた文字列。 |
URL
|
shipping_documents.packing_slip.url | string |
URL アドレス。 |
必須
|
shipping_documents.battery_form.required | boolean |
必須かどうか。 |
ページ サイズ
|
shipping_documents.battery_form.page_size | string |
ページ サイズ。 |
形式
|
shipping_documents.battery_form.format | string |
形式。 |
Base64 でエンコードされた文字列
|
shipping_documents.battery_form.base64_encoded_strings | array of |
Base64 でエンコードされた文字列。 |
URL
|
shipping_documents.battery_form.url | string |
URL アドレス。 |
必須
|
shipping_documents.battery_caution_label.required | boolean |
必須かどうか。 |
ページ サイズ
|
shipping_documents.battery_caution_label.page_size | string |
ページ サイズ。 |
形式
|
shipping_documents.battery_caution_label.format | string |
形式。 |
Base64 でエンコードされた文字列
|
shipping_documents.battery_caution_label.base64_encoded_strings | array of |
Base64 でエンコードされた文字列。 |
URL
|
shipping_documents.battery_caution_label.url | string |
URL アドレス。 |
出荷を更新
出荷の詳細を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Easyship 出荷 ID
|
easyship_shipment_id | True | string |
Easyship 出荷識別子。 |
宛先国番号
|
destination_country_alpha2 | string |
宛先国番号。 |
|
宛先市区町村
|
destination_city | string |
宛先市区町村。 |
|
目的地名
|
destination_name | string |
目的地名。 |
|
宛先住所
|
destination_address_line_1 | string |
宛先住所。 |
|
宛先電話番号
|
destination_phone_number | string |
宛先の電話番号。 |
|
説明
|
description | string |
説明。 |
|
実重量
|
actual_weight | float |
実重量。 |
|
高さ
|
height | integer |
高さ。 |
|
幅
|
width | integer |
幅。 |
|
長さ
|
length | integer |
長さ。 |
|
カテゴリー
|
category | string |
カテゴリ。 |
|
申告通貨
|
declared_currency | string |
申告通貨。 |
|
申告税関額
|
declared_customs_value | integer |
申告税関額。 |
|
SKU
|
sku | string |
SKU。 |
|
プラットフォーム名
|
platform_name | string |
プラットフォーム名。 |
|
プラットフォーム注文番号
|
platform_order_number | string |
プラットフォーム注文番号。 |
|
納税者
|
taxes_duties_paid_by | string |
納税者。 |
|
保険あり
|
is_insured | boolean |
保険がかけられているかどうか。 |
|
選択された宅配業者 ID
|
selected_courier_id | string |
選択された宅配業者識別子。 |
|
配送先郵便番号
|
destination_postal_code | integer |
配送先郵便番号。 |
|
宛先都道府県
|
destination_state | string |
宛先都道府県。 |
|
宛先住所行 2
|
destination_address_line_2 | string |
宛先住所行 2。 |
|
宛先メール アドレス
|
destination_email_address | string |
宛先メール アドレス。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
作成日
|
shipment.created_at | string |
作成日時。 |
更新日
|
shipment.updated_at | string |
更新時刻。 |
Easyship 出荷 ID
|
shipment.easyship_shipment_id | string |
Easyship 出荷識別子。 |
目的地名
|
shipment.destination_name | string |
目的地名。 |
宛先住所
|
shipment.destination_address_line_1 | string |
宛先住所。 |
宛先住所行 2
|
shipment.destination_address_line_2 | string |
宛先住所行 2。 |
宛先市区町村
|
shipment.destination_city | string |
宛先市区町村。 |
宛先都道府県
|
shipment.destination_state | string |
宛先都道府県。 |
配送先郵便番号
|
shipment.destination_postal_code | string |
配送先郵便番号。 |
宛先電話番号
|
shipment.destination_phone_number | string |
宛先の電話番号。 |
宛先メール アドレス
|
shipment.destination_email_address | string |
宛先メール アドレス。 |
プラットフォーム名
|
shipment.platform_name | string |
プラットフォーム名。 |
プラットフォーム注文番号
|
shipment.platform_order_number | string |
プラットフォーム注文番号。 |
合計関税額
|
shipment.total_customs_value | float |
合計関税額。 |
実際の重さ合計
|
shipment.total_actual_weight | float |
実際の重さ合計。 |
合計寸法重量
|
shipment.total_dimensional_weight | float |
合計寸法重量。 |
合計容積重量
|
shipment.total_volumetric_weight | float |
合計容積重量。 |
保険あり
|
shipment.is_insured | boolean |
保険がかけられているかどうか。 |
通貨
|
shipment.currency | string |
通貨。 |
名前
|
shipment.origin_country.name | string |
名前。 |
国番号
|
shipment.origin_country.alpha2 | string |
国番号。 |
名前
|
shipment.destination_country.name | string |
名前。 |
国番号
|
shipment.destination_country.alpha2 | string |
国番号。 |
アイテム
|
shipment.items | array of object | |
ID
|
shipment.items.id | string |
一意識別子。 |
説明
|
shipment.items.description | string |
説明。 |
SKU
|
shipment.items.sku | string |
SKU。 |
幅
|
shipment.items.width | integer |
幅。 |
長さ
|
shipment.items.length | integer |
長さ。 |
高さ
|
shipment.items.height | integer |
高さ。 |
実重量
|
shipment.items.actual_weight | float |
実重量。 |
寸法重量
|
shipment.items.dimensional_weight | float |
寸法重量。 |
容積重量
|
shipment.items.volumetric_weight | float |
容積重量。 |
申告税関額
|
shipment.items.declared_customs_value | integer |
申告税関額。 |
申告通貨
|
shipment.items.declared_currency | string |
申告通貨。 |
元の関税額
|
shipment.items.origin_customs_value | float |
元の関税額。 |
元の通貨
|
shipment.items.origin_currency | string |
元の通貨。 |
カテゴリ
|
shipment.items.category | string |
カテゴリ。 |
名前
|
shipment.box.name | string |
名前。 |
長さ
|
shipment.box.length | integer |
長さ。 |
幅
|
shipment.box.width | integer |
幅。 |
高さ
|
shipment.box.height | integer |
高さ。 |
ID
|
shipment.selected_courier.id | string |
一意識別子。 |
名前
|
shipment.selected_courier.name | string |
名前。 |
最短配送時間
|
shipment.selected_courier.min_delivery_time | integer |
最短配送時間。 |
最長配送時間
|
shipment.selected_courier.max_delivery_time | integer |
最長配送時間。 |
発送料金
|
shipment.selected_courier.shipment_charge | float |
発送料金。 |
燃料割増金
|
shipment.selected_courier.fuel_surcharge | float |
燃料割増金。 |
遠隔地追加料金
|
shipment.selected_courier.remote_area_surcharge | integer |
遠隔地追加料金。 |
出荷合計料金
|
shipment.selected_courier.shipment_charge_total | float |
出荷合計料金。 |
倉庫手数料
|
shipment.selected_courier.warehouse_handling_fee | integer |
倉庫手数料。 |
保険料
|
shipment.selected_courier.insurance_fee | integer |
保険料。 |
輸入税
|
shipment.selected_courier.import_tax_charge | integer |
輸入税。 |
輸入関税
|
shipment.selected_courier.import_duty_charge | integer |
輸入関税。 |
DDP 取り扱い手数料
|
shipment.selected_courier.ddp_handling_fee | integer |
DDP 取り扱い手数料。 |
合計料金
|
shipment.selected_courier.total_charge | float |
合計料金。 |
しきい値を超えている
|
shipment.selected_courier.is_above_threshold | boolean |
しきい値を超えているかどうか。 |
有効なインコタームズ
|
shipment.selected_courier.effective_incoterms | string |
有効なインコタームズ。 |
予測輸入税
|
shipment.selected_courier.estimated_import_tax | integer |
予測輸入税。 |
予測輸入関税
|
shipment.selected_courier.estimated_import_duty | integer |
予測輸入関税。 |
宅配業者が集荷
|
shipment.selected_courier.courier_does_pickup | boolean |
宅配業者が集荷するかどうか。 |
宅配業者ドロップオフ URL
|
shipment.selected_courier.courier_dropoff_url | string |
宅配便ドロップオフ URL アドレス。 |
宅配業者の備考
|
shipment.selected_courier.courier_remarks | string |
宅配業者の備考。 |
支払い受取人
|
shipment.selected_courier.payment_recipient | string |
支払い受取人。 |
レート
|
shipment.rates | array of object | |
宅配業者 ID
|
shipment.rates.courier_id | string |
宅配業者の識別子。 |
宅配業者名
|
shipment.rates.courier_name | string |
宅配業者名。 |
最短配送時間
|
shipment.rates.min_delivery_time | integer |
最短配送時間。 |
最長配送時間
|
shipment.rates.max_delivery_time | integer |
最長配送時間。 |
金額に対する価値のランク
|
shipment.rates.value_for_money_rank | integer |
金額に対する価値のランク。 |
配送時間ランク
|
shipment.rates.delivery_time_rank | integer |
配送時間ランク。 |
発送料金
|
shipment.rates.shipment_charge | float |
発送料金。 |
燃料割増金
|
shipment.rates.fuel_surcharge | float |
燃料割増金。 |
遠隔地追加料金
|
shipment.rates.remote_area_surcharge | integer |
遠隔地追加料金。 |
出荷合計料金
|
shipment.rates.shipment_charge_total | float |
出荷合計料金。 |
倉庫手数料
|
shipment.rates.warehouse_handling_fee | integer |
倉庫手数料。 |
保険料
|
shipment.rates.insurance_fee | integer |
保険料。 |
DDP 取り扱い手数料
|
shipment.rates.ddp_handling_fee | integer |
DDP 取り扱い手数料。 |
輸入税
|
shipment.rates.import_tax_charge | integer |
輸入税の変更。 |
輸入関税
|
shipment.rates.import_duty_charge | integer |
輸入関税。 |
合計料金
|
shipment.rates.total_charge | float |
合計料金。 |
しきい値を超えている
|
shipment.rates.is_above_threshold | boolean |
しきい値を超えているかどうか。 |
有効なインコタームズ
|
shipment.rates.effective_incoterms | string |
有効なインコタームズ。 |
予測輸入税
|
shipment.rates.estimated_import_tax | integer |
予測輸入税。 |
予測輸入関税
|
shipment.rates.estimated_import_duty | integer |
予測輸入関税。 |
宅配業者が集荷
|
shipment.rates.courier_does_pickup | boolean |
宅配業者が集荷するかどうか。 |
宅配業者ドロップオフ URL
|
shipment.rates.courier_dropoff_url | string |
宅配便ドロップオフ URL アドレス。 |
追跡評価
|
shipment.rates.tracking_rating | integer |
追跡評価。 |
Easyship Rating
|
shipment.rates.easyship_rating | float |
Easyship 評価。 |
宅配業者の備考
|
shipment.rates.courier_remarks | string |
宅配業者の備考。 |
支払い受取人
|
shipment.rates.payment_recipient | string |
支払い受取人。 |
出荷ラベルを購入 (V1)
配送ラベルに関する情報を購入して取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Easyship 出荷 ID
|
easyship_shipment_id | string |
Easyship 出荷の一意識別子。 |
|
宅配業者 ID
|
courier_id | string |
宅配業者の一意識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
メッセージ
|
message | string |
メッセージ。 |
エラー
|
errors | array of |
エラー。 |
合計コスト
|
total_cost | integer |
合計コスト。 |
利用可能残高
|
available_balance | integer |
利用可能な残高。 |
ラベル
|
labels | array of object | |
Easyship 出荷 ID
|
labels.easyship_shipment_id | string |
Easyship 出荷の一意識別子。 |
ラベルの状態
|
labels.label_state | string |
ラベルの状態。 |
ラベル URL
|
labels.label_url | string |
ラベルの URL アドレス。 |
ステータス
|
labels.status | string |
ステータス。 |
追跡番号
|
labels.tracking_number | string |
追跡番号。 |
追跡ページ URL
|
labels.tracking_page_url | string |
追跡ページの URL アドレス。 |
利用可能なピックアップ スロットを取得 (V1)
利用可能なピックアップ スロットは、特定の宅配業者、現地時間、および今後 7 日間で計算されます。 次に、「集荷のリクエスト」アクションを使用して集荷をリクエストできます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
宅配業者 ID
|
courier_id | True | string |
宅配業者の識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
宅配業者 ID
|
courier_id | string |
宅配業者の識別子。 |
宅配業者名
|
courier_name | string |
宅配業者名。 |
メッセージ
|
message | string |
メッセージ。 |
プロバイダー名
|
pickup.provider_name | string |
プロバイダー名。 |
プロバイダー顧客サービスの電話
|
pickup.provider_customer_service_phone | string |
プロバイダー顧客サービスの電話番号。 |
品目カテゴリを取得
出荷カテゴリのリストと、カテゴリを使用するためのスラッグを取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
カテゴリー
|
categories | array of object | |
名前
|
categories.name | string |
名前。 |
置換フィールド
|
categories.slug | string |
置換フィールド。 |
料金と税金を取得
将来の出荷の出荷見積もりのリストを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
住所
|
line_1 | string |
住所。 |
|
住所行 2
|
line_2 | string |
住所明細行 2。 |
|
都道府県
|
state | string |
都道府県。 |
|
都市
|
city | string |
市区町村。 |
|
郵便番号
|
postal_code | string |
郵便番号。 |
|
国番号
|
country_alpha2 | string |
国番号。 |
|
住所
|
line_1 | string |
住所。 |
|
住所行 2
|
line_2 | string |
住所明細行 2。 |
|
都道府県
|
state | string |
都道府県。 |
|
都市
|
city | string |
市区町村。 |
|
郵便番号
|
postal_code | string |
郵便番号。 |
|
国番号
|
country_alpha2 | string |
国番号。 |
|
インターコムズ
|
incoterms | string |
インターコムズ。 |
|
保険あり
|
is_insured | boolean |
保険がかけられているかどうか。 |
|
保険金額
|
insured_amount | integer |
保険金額。 |
|
保険通貨
|
insured_currency | string |
保険通貨。 |
|
配送ルールを適用
|
apply_shipping_rules | boolean |
配送ルールが適用されたかどうか。 |
|
重さ
|
weight | string |
重さ。 |
|
寸法
|
dimensions | string |
寸法。 |
|
出力通貨
|
output_currency | string |
出力通貨。 |
|
実際の重さ合計
|
total_actual_weight | float |
実際の重さ合計。 |
|
置換フィールド
|
slug | string |
参照置換フィールド。 |
|
長さ
|
length | integer |
長さ。 |
|
幅
|
width | integer |
幅。 |
|
高さ
|
height | integer |
高さ。 |
|
説明
|
description | string |
説明。 |
|
カテゴリ
|
category | string |
カテゴリ。 |
|
SKU
|
sku | string |
SKU。 |
|
数量
|
quantity | integer |
数量。 |
|
長さ
|
length | string |
長さ。 |
|
幅
|
width | string |
幅。 |
|
高さ
|
height | string |
高さ。 |
|
実重量
|
actual_weight | integer |
実重量。 |
|
申告通貨
|
declared_currency | string |
申告通貨。 |
|
申告税関額
|
declared_customs_value | integer |
申告税関額。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
レート
|
rates | array of object | |
宅配業者 ID
|
rates.courier_id | string |
宅配業者の一意識別子。 |
宅配業者名
|
rates.courier_name | string |
宅配業者名。 |
最短配送時間
|
rates.min_delivery_time | integer |
最短配送時間。 |
最長配送時間
|
rates.max_delivery_time | integer |
最長配送時間。 |
金額に対する価値のランク
|
rates.value_for_money_rank | integer |
金額に対する価値のランク。 |
配送時間ランク
|
rates.delivery_time_rank | integer |
配送時間ランク。 |
発送料金
|
rates.shipment_charge | float |
発送料金。 |
燃料割増金
|
rates.fuel_surcharge | float |
燃料割増金。 |
遠隔地追加料金
|
rates.remote_area_surcharge | integer |
遠隔地追加料金。 |
出荷合計料金
|
rates.shipment_charge_total | float |
出荷合計料金。 |
倉庫手数料
|
rates.warehouse_handling_fee | integer |
倉庫手数料。 |
保険料
|
rates.insurance_fee | integer |
保険料。 |
DDP 取り扱い手数料
|
rates.ddp_handling_fee | integer |
インコタームズが DDP の場合は DDP 手数料。 |
輸入税
|
rates.import_tax_charge | integer |
輸入税。 |
輸入関税
|
rates.import_duty_charge | integer |
輸入関税。 |
合計料金
|
rates.total_charge | float |
合計料金。 |
しきい値を超えている
|
rates.is_above_threshold | boolean |
しきい値を超えているかどうか。 |
有効なインコタームズ
|
rates.effective_incoterms | string |
有効なインコタームズ。 |
予測輸入税
|
rates.estimated_import_tax | integer |
予測輸入税。 |
予測輸入関税
|
rates.estimated_import_duty | integer |
予測輸入関税。 |
宅配業者が集荷
|
rates.courier_does_pickup | boolean |
宅配業者が集荷するかどうか。 |
宅配業者ドロップオフ URL
|
rates.courier_dropoff_url | string |
宅配便ドロップオフ URL アドレス。 |
追跡評価
|
rates.tracking_rating | integer |
追跡評価。 |
支払い受取人
|
rates.payment_recipient | string |
支払い受取人。 |
宅配業者の備考
|
rates.courier_remarks | string |
宅配業者の備考。 |
通貨
|
rates.currency | string |
通貨。 |
名前
|
rates.box.name | string |
名前。 |
長さ
|
rates.box.length | integer |
長さ。 |
幅
|
rates.box.width | integer |
幅。 |
高さ
|
rates.box.height | integer |
高さ。 |
最小ピックアップ料金
|
rates.minimum_pickup_fee | integer |
最小ピックアップ料金。 |
説明
|
rates.title | string |
説明。 |
説明全体
|
rates.full_description | string |
説明全体。 |
追跡ステータスを取得
出荷の追跡ステータスを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Easyship 出荷 ID
|
easyship_shipment_id | True | string |
Easyship 出荷識別子。 |
プラットフォーム注文番号
|
platform_order_number | string |
プラットフォーム注文番号。 |
|
ぺージ
|
page | integer |
ページ。 |
|
ページ当たり
|
per_page | integer |
ページあたりの数。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
合計ページ
|
total_page | integer |
合計ページ。 |
現在のページ
|
current_page | integer |
現在のページ。 |
出荷
|
shipments | array of object | |
Easyship 出荷 ID
|
shipments.easyship_shipment_id | string |
Easyship 出荷の一意識別子。 |
プラットフォーム注文番号
|
shipments.platform_order_number | string |
プラットフォーム注文番号。 |
元
|
shipments.origin | string |
元。 |
宛先
|
shipments.destination | string |
目的地。 |
ステータス
|
shipments.status | string |
ステータス。 |
追跡番号
|
shipments.tracking_number | string |
追跡番号。 |
追跡ページ URL
|
shipments.tracking_page_url | string |
追跡ページの URL アドレス。 |