AfterShip (独立発行者) (プレビュー)

  • リファレンス

AfterShip は出荷追跡ソリューションです。 FedEx、DHL などの人気のあるサービスを含む、世界に広がる 900 以上もの運送業者と提携しています。このコネクタを使用すると、ユーザーは貨物を追跡し、貨物に関する通知を受け取ることができ、Dynamics 365 やサードパーティなどの他のサービスと統合して e コマースを強化し、内部のビジネス プロセスを合理化することができます。

このコネクタは、次の製品および地域で利用可能です。

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)
お問い合わせ先
件名 Taiki Yoshida
[URL] https://memo.tyoshida.me/power-platform/connectors/aftership-connector/
メール tayoshi@microsoft.com
Connector Metadata
発行者 Taiki Yoshida
Web サイト https://www.aftership.com
プライバシー ポリシー https://www.automizely.com/legal/privacy
カテゴリ コマース

接続の作成

コネクタは、次の認証タイプをサポートしています:
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ 説明 必須
API キー securestring AfterShip が発行したアプリ/サブスクリプション API キー True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

すべての宅配便を取得する

すべての宅配便の一覧を返します。
ユーザーがアクティブ化した宅配便を取得する

AfterShip アカウントでアクティブ化された宅配便 のリストを返す。
宅配便を検出する

追跡番号の形式に基づいて一致した宅配便のリストを返し、選択された宅配便 または宅配便のリスト。
最後のチェックポイントを取得する

単一の追跡の最後のチェックポイントの追跡情報を返します。
期限切れの追跡を再追跡する

期限切れの追跡を再追跡する。 追跡ごとに最大 3 回。
追跡を作成する

追跡を作成する。
追跡を削除する

追跡を削除する。
追跡を取得する

単一の追跡の追跡結果を取得します。
追跡を取得する

複数の追跡の追跡結果を取得します。
追跡を完了とマーク

追跡を完了とマーク。 追跡は、再追跡するまで自動更新されません。
追跡を更新する

追跡を更新する。
追跡情報の取得

追跡が変更されたときに通知するユーザーの連絡先情報を取得します。 顧客の受信者のみが返されます。 ストアに属するどの email、sms または webhook も返されません。
通知を削除する

通知受信者を追跡番号から削除します。
通知を追加する

通知受信者を追跡番号に追加します。

すべての宅配便を取得する

操作 ID:
GetAllCouriers

すべての宅配便の一覧を返します。

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
合計
 data.total integer

合計
宅配便
 data.couriers array of object

宅配便情報
置換フィールド
 data.couriers.slug string

宅配業者名
名前
 data.couriers.name string

名前
電話
 data.couriers.phone string

電話番号
other_name
 data.couriers.other_name string

代替の名前
web_url
 data.couriers.web_url string

Web サイトの URL
required_fields
 data.couriers.required_fields array of

必須フィールド
optional_fields
 data.couriers.optional_fields array of

オプション フィールド

ユーザーがアクティブ化した宅配便を取得する

操作 ID:
GetUserActivatedCouriers

AfterShip アカウントでアクティブ化された宅配便 のリストを返す。

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
合計
 data.total integer

合計
宅配便
 data.couriers array of object

宅配便情報
置換フィールド
 data.couriers.slug string

宅配業者名
名前
 data.couriers.name string

名前
電話
 data.couriers.phone string

電話番号
other_name
 data.couriers.other_name string

代替の名前
web_url
 data.couriers.web_url string

Web サイトの URL
required_fields
 data.couriers.required_fields array of string

必須フィールド
optional_fields
 data.couriers.optional_fields array of string

オプション フィールド
default_language
 data.couriers.default_language string

既定の言語
support_languages
 data.couriers.support_languages array of string

サポートされている言語
service_from_country_iso3
 data.couriers.service_from_country_iso3 array of string

ISO3 形式のサービスの国コード

宅配便を検出する

操作 ID:
DetectCourier

追跡番号の形式に基づいて一致した宅配便のリストを返し、選択された宅配便 または宅配便のリスト。

パラメーター

名前 キー 必須 型 説明
tracking_number
 tracking_number string

追跡番号

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
合計
 data.total integer

合計
宅配便
 data.couriers array of object

宅配便情報
置換フィールド
 data.couriers.slug string

宅配業者名
名前
 data.couriers.name string

名前
電話
 data.couriers.phone string

電話番号
other_name
 data.couriers.other_name string

代替の名前
web_url
 data.couriers.web_url string

Web サイトの URL
required_fields
 data.couriers.required_fields array of string

必須フィールド
optional_fields
 data.couriers.optional_fields array of string

オプション フィールド
default_language
 data.couriers.default_language string

既定の言語
support_languages
 data.couriers.support_languages array of string

サポートされている言語
service_from_country_iso3
 data.couriers.service_from_country_iso3 array of string

ISO3 形式のサービスの国コード

最後のチェックポイントを取得する

操作 ID:
GetLastCheckpoint

単一の追跡の最後のチェックポイントの追跡情報を返します。

パラメーター

名前 キー 必須 型 説明
宅配便の置換フィールド
 slug True string

宅配便の置換フィールド
追跡番号
 tracking_number True string

追跡番号の入力

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
ID
 data.id string

ID
tracking_number
 data.tracking_number string

追跡番号
置換フィールド
 data.slug string

宅配業者名
タグ
 data.tag string

タグ
subtag
 data.subtag string

サブ タグ
subtag_message
 data.subtag_message string

Sub tag messages
置換フィールド
 data.checkpoint.slug string

宅配業者名
created_at
 data.checkpoint.created_at string

作成日時
checkpoint_time
 data.checkpoint.checkpoint_time string

チェックポイントに到達した時間
都市
 data.checkpoint.city string

都市
座標
 data.checkpoint.coordinates array of

座標
country_iso3
 data.checkpoint.country_iso3 string

ISO 3 形式の国コード
country_name
 data.checkpoint.country_name string

国名
メッセージ
 data.checkpoint.message string

メッセージ
都道府県
 data.checkpoint.state string

都道府県
タグ
 data.checkpoint.tag string

タグ
subtag
 data.checkpoint.subtag string

サブ タグ
subtag_message
 data.checkpoint.subtag_message string

Sub tag messages
郵便番号
 data.checkpoint.zip string

郵便番号
raw_tag
 data.checkpoint.raw_tag string

Raw タグ

期限切れの追跡を再追跡する

操作 ID:
RetrackAnExpiredTracking

期限切れの追跡を再追跡する。 追跡ごとに最大 3 回。

パラメーター

名前 キー 必須 型 説明
宅配便の置換フィールド
 slug True string

宅配便の置換フィールド
追跡番号
 tracking_number True string

追跡番号の入力

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
メッセージ
 meta.message string

メッセージ
タイプ
 meta.type string

タイプ
ID
 data.tracking.id string

ID
tracking_number
 data.tracking.tracking_number string

追跡番号
置換フィールド
 data.tracking.slug string

宅配業者名
tracking_account_number
 data.tracking.tracking_account_number string

tracking_account_number
tracking_origin_country
 data.tracking.tracking_origin_country string

tracking_origin_country
tracking_destination_country
 data.tracking.tracking_destination_country string

tracking_destination_country
tracking_key
 data.tracking.tracking_key string

tracking_key
tracking_postal_code
 data.tracking.tracking_postal_code string

tracking_postal_code
tracking_ship_date
 data.tracking.tracking_ship_date string

tracking_ship_date
tracking_state
 data.tracking.tracking_state string

tracking_state
アクティブ
 data.tracking.active boolean

アクティブまたは非アクティブな追跡

追跡を作成する

操作 ID:
CreateTracking

追跡を作成する。

パラメーター

名前 キー 必須 型 説明
置換フィールド
 slug string

宅配業者名
tracking_number
 tracking_number string

追跡番号
肩書き
 title string

肩書き
SMS
 smses array of

SMS
メール
 emails array of

メール アドレス
order_id
 order_id string

Order ID
order_id_path
 order_id_path string

受注 ID パス
product_name
 product_name string

product_name
product_price
 product_price string

product_price
言語
 language string

言語
order_promised_delivery_date
 order_promised_delivery_date string

order_promised_delivery_date
delivery_type
 delivery_type string

delivery_type
pickup_location
 pickup_location string

pickup_location
pickup_note
 pickup_note string

pickup_note

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
ID
 data.tracking.id string

ID
created_at
 data.tracking.created_at string

作成日時
updated_at
 data.tracking.updated_at string

更新日時
last_updated_at
 data.tracking.last_updated_at string

最終更新日時
tracking_number
 data.tracking.tracking_number string

追跡番号
置換フィールド
 data.tracking.slug string

宅配業者名
アクティブ
 data.tracking.active boolean

アクティブまたは非アクティブな追跡
Android
 data.tracking.android array of

Android
custom_fields
 data.tracking.custom_fields string

カスタム フィールド
customer_name
 data.tracking.customer_name string

顧客名
delivery_time
 data.tracking.delivery_time integer

出荷日時
destination_country_iso3
 data.tracking.destination_country_iso3 string

ISO 3 形式の宛先国コード
courier_destination_country_iso3
 data.tracking.courier_destination_country_iso3 string

ISO 3 形式の宅配便国コード
メール
 data.tracking.emails array of

メール アドレス
expected_delivery
 data.tracking.expected_delivery string

配達予定日時
iOS
 data.tracking.ios array of

iOS
note
 data.tracking.note string

ノート
order_id
 data.tracking.order_id string

Order ID
order_id_path
 data.tracking.order_id_path string

受注 ID パス
origin_country_iso3
 data.tracking.origin_country_iso3 string

ISO 3 形式の元の国コード
shipment_package_count
 data.tracking.shipment_package_count integer

出荷のパッケージ数
shipment_pickup_date
 data.tracking.shipment_pickup_date string

集荷したパッケージの日時
shipment_delivery_date
 data.tracking.shipment_delivery_date string

パッケージが配送された日時
shipment_type
 data.tracking.shipment_type string

配送タイプ
shipment_weight
 data.tracking.shipment_weight integer

荷物の重量
shipment_weight_unit
 data.tracking.shipment_weight_unit string

荷物の重量の単位
signed_by
 data.tracking.signed_by string

署名者
SMS
 data.tracking.smses array of

SMS
ソース
 data.tracking.source string

ソース
タグ
 data.tracking.tag string

タグ
subtag
 data.tracking.subtag string

サブ タグ
subtag_message
 data.tracking.subtag_message string

Sub tag messages
役職
 data.tracking.title string

役職
tracked_count
 data.tracking.tracked_count integer

追跡回数
last_mile_tracking_supported
 data.tracking.last_mile_tracking_supported boolean

ラスト マイル追跡はサポートされています
言語
 data.tracking.language string

言語
unique_token
 data.tracking.unique_token string

一意のトークン
チェックポイント
 data.tracking.checkpoints array of

チェックポイント
subscribed_smses
 data.tracking.subscribed_smses array of

subscribed_smses
subscribed_emails
 data.tracking.subscribed_emails array of

subscribed_emails
return_to_sender
 data.tracking.return_to_sender boolean

return_to_sender
tracking_account_number
 data.tracking.tracking_account_number string

tracking_account_number
tracking_origin_country
 data.tracking.tracking_origin_country string

tracking_origin_country
tracking_destination_country
 data.tracking.tracking_destination_country string

tracking_destination_country
tracking_key
 data.tracking.tracking_key string

tracking_key
tracking_postal_code
 data.tracking.tracking_postal_code string

tracking_postal_code
tracking_ship_date
 data.tracking.tracking_ship_date string

tracking_ship_date
tracking_state
 data.tracking.tracking_state string

tracking_state
order_promised_delivery_date
 data.tracking.order_promised_delivery_date string

order_promised_delivery_date
delivery_type
 data.tracking.delivery_type string

delivery_type
pickup_location
 data.tracking.pickup_location string

pickup_location
pickup_note
 data.tracking.pickup_note string

pickup_note
courier_tracking_link
 data.tracking.courier_tracking_link string

courier_tracking_link
courier_redirect_link
 data.tracking.courier_redirect_link string

courier_redirect_link
first_attempted_at
 data.tracking.first_attempted_at string

first_attempted_at

追跡を削除する

操作 ID:
DeleteATracking

追跡を削除する。

パラメーター

名前 キー 必須 型 説明
宅配便の置換フィールド
 slug True string

宅配便の置換フィールド
追跡番号
 tracking_number True string

追跡番号の入力

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
ID
 data.tracking.id string

ID
tracking_number
 data.tracking.tracking_number string

追跡番号
置換フィールド
 data.tracking.slug string

宅配業者名
tracking_account_number
 data.tracking.tracking_account_number string

tracking_account_number
tracking_origin_country
 data.tracking.tracking_origin_country string

tracking_origin_country
tracking_destination_country
 data.tracking.tracking_destination_country string

tracking_destination_country
tracking_key
 data.tracking.tracking_key string

tracking_key
tracking_postal_code
 data.tracking.tracking_postal_code string

tracking_postal_code
tracking_ship_date
 data.tracking.tracking_ship_date string

tracking_ship_date
tracking_state
 data.tracking.tracking_state string

tracking_state

追跡を取得する

操作 ID:
GetATracking

単一の追跡の追跡結果を取得します。

パラメーター

名前 キー 必須 型 説明
宅配便の置換フィールド
 slug True string

宅配便の置換フィールド
追跡番号
 tracking_number True string

追跡番号の入力

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
ID
 data.tracking.id string

ID
created_at
 data.tracking.created_at string

作成日時
updated_at
 data.tracking.updated_at string

更新日時
last_updated_at
 data.tracking.last_updated_at string

最終更新日時
tracking_number
 data.tracking.tracking_number string

追跡番号
置換フィールド
 data.tracking.slug string

宅配業者名
アクティブ
 data.tracking.active boolean

アクティブまたは非アクティブな追跡
Android
 data.tracking.android array of

Android
custom_fields
 data.tracking.custom_fields string

カスタム フィールド
customer_name
 data.tracking.customer_name string

顧客名
delivery_time
 data.tracking.delivery_time integer

出荷日時
destination_country_iso3
 data.tracking.destination_country_iso3 string

ISO 3 形式の宛先国コード
courier_destination_country_iso3
 data.tracking.courier_destination_country_iso3 string

ISO 3 形式の宅配便国コード
メール
 data.tracking.emails array of

メール アドレス
expected_delivery
 data.tracking.expected_delivery string

配達予定日時
iOS
 data.tracking.ios array of

iOS
note
 data.tracking.note string

ノート
order_id
 data.tracking.order_id string

Order ID
order_id_path
 data.tracking.order_id_path string

受注 ID パス
origin_country_iso3
 data.tracking.origin_country_iso3 string

ISO 3 形式の元の国コード
shipment_package_count
 data.tracking.shipment_package_count integer

出荷のパッケージ数
shipment_pickup_date
 data.tracking.shipment_pickup_date string

集荷したパッケージの日時
shipment_delivery_date
 data.tracking.shipment_delivery_date string

パッケージが配送された日時
shipment_type
 data.tracking.shipment_type string

配送タイプ
shipment_weight
 data.tracking.shipment_weight integer

荷物の重量
shipment_weight_unit
 data.tracking.shipment_weight_unit string

荷物の重量の単位
signed_by
 data.tracking.signed_by string

署名者
SMS
 data.tracking.smses array of

SMS
ソース
 data.tracking.source string

ソース
タグ
 data.tracking.tag string

タグ
subtag
 data.tracking.subtag string

サブ タグ
subtag_message
 data.tracking.subtag_message string

Sub tag messages
役職
 data.tracking.title string

役職
tracked_count
 data.tracking.tracked_count integer

追跡回数
last_mile_tracking_supported
 data.tracking.last_mile_tracking_supported string

ラスト マイル追跡はサポートされています
言語
 data.tracking.language string

言語
unique_token
 data.tracking.unique_token string

一意のトークン
チェックポイント
 data.tracking.checkpoints array of object

チェックポイント
置換フィールド
 data.tracking.checkpoints.slug string

宅配業者名
都市
 data.tracking.checkpoints.city string

都市
created_at
 data.tracking.checkpoints.created_at string

作成日時
場所
 data.tracking.checkpoints.location string

場所
country_name
 data.tracking.checkpoints.country_name string

国名
メッセージ
 data.tracking.checkpoints.message string

メッセージ
country_iso3
 data.tracking.checkpoints.country_iso3 string

ISO 3 形式の国コード
タグ
 data.tracking.checkpoints.tag string

タグ
subtag
 data.tracking.checkpoints.subtag string

サブ タグ
subtag_message
 data.tracking.checkpoints.subtag_message string

Sub tag messages
checkpoint_time
 data.tracking.checkpoints.checkpoint_time string

チェックポイントに到達した時間
座標
 data.tracking.checkpoints.coordinates array of

座標
都道府県
 data.tracking.checkpoints.state string

都道府県
郵便番号
 data.tracking.checkpoints.zip string

郵便番号
raw_tag
 data.tracking.checkpoints.raw_tag string

Raw タグ
subscribed_smses
 data.tracking.subscribed_smses array of

subscribed_smses
subscribed_emails
 data.tracking.subscribed_emails array of

subscribed_emails
return_to_sender
 data.tracking.return_to_sender boolean

return_to_sender
tracking_account_number
 data.tracking.tracking_account_number string

tracking_account_number
tracking_origin_country
 data.tracking.tracking_origin_country string

tracking_origin_country
tracking_destination_country
 data.tracking.tracking_destination_country string

tracking_destination_country
tracking_key
 data.tracking.tracking_key string

tracking_key
tracking_postal_code
 data.tracking.tracking_postal_code string

tracking_postal_code
tracking_ship_date
 data.tracking.tracking_ship_date string

tracking_ship_date
tracking_state
 data.tracking.tracking_state string

tracking_state
order_promised_delivery_date
 data.tracking.order_promised_delivery_date string

order_promised_delivery_date
delivery_type
 data.tracking.delivery_type string

delivery_type
pickup_location
 data.tracking.pickup_location string

pickup_location
pickup_note
 data.tracking.pickup_note string

pickup_note
courier_tracking_link
 data.tracking.courier_tracking_link string

courier_tracking_link
courier_redirect_link
 data.tracking.courier_redirect_link string

courier_redirect_link
first_attempted_at
 data.tracking.first_attempted_at string

first_attempted_at

追跡を取得する

操作 ID:
GetTrackings

複数の追跡の追跡結果を取得します。

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
ページ
 data.page integer

ページ
制限
 data.limit integer

制限
件数
 data.count integer

件数
キーワード
 data.keyword string

キーワード
置換フィールド
 data.slug string

宅配業者名
元
 data.origin array of

元
宛先
 data.destination array of

宛先
タグ
 data.tag string

タグ
フィールド
 data.fields string

フィールド
created_at_min
 data.created_at_min string

created_at_min
created_at_max
 data.created_at_max string

created_at_max
last_updated_at
 data.last_updated_at string

最終更新日時
return_to_sender
 data.return_to_sender array of

return_to_sender
courier_destination_country_iso3
 data.courier_destination_country_iso3 array of

ISO 3 形式の宅配便国コード
追跡
 data.trackings array of object

追跡
ID
 data.trackings.id string

ID
created_at
 data.trackings.created_at string

作成日時
updated_at
 data.trackings.updated_at string

更新日時
last_updated_at
 data.trackings.last_updated_at string

最終更新日時
tracking_number
 data.trackings.tracking_number string

追跡番号
置換フィールド
 data.trackings.slug string

宅配業者名
アクティブ
 data.trackings.active boolean

アクティブまたは非アクティブな追跡
Android
 data.trackings.android array of

Android
custom_fields
 data.trackings.custom_fields string

カスタム フィールド
customer_name
 data.trackings.customer_name string

顧客名
delivery_time
 data.trackings.delivery_time integer

出荷日時
destination_country_iso3
 data.trackings.destination_country_iso3 string

ISO 3 形式の宛先国コード
courier_destination_country_iso3
 data.trackings.courier_destination_country_iso3 string

ISO 3 形式の宅配便国コード
メール
 data.trackings.emails array of string

メール アドレス
expected_delivery
 data.trackings.expected_delivery string

配達予定日時
iOS
 data.trackings.ios array of

iOS
note
 data.trackings.note string

ノート
order_id
 data.trackings.order_id string

Order ID
order_id_path
 data.trackings.order_id_path string

受注 ID パス
origin_country_iso3
 data.trackings.origin_country_iso3 string

ISO 3 形式の元の国コード
shipment_package_count
 data.trackings.shipment_package_count integer

出荷のパッケージ数
shipment_pickup_date
 data.trackings.shipment_pickup_date string

集荷したパッケージの日時
shipment_delivery_date
 data.trackings.shipment_delivery_date string

パッケージが配送された日時
shipment_type
 data.trackings.shipment_type string

配送タイプ
shipment_weight
 data.trackings.shipment_weight string

荷物の重量
shipment_weight_unit
 data.trackings.shipment_weight_unit string

荷物の重量の単位
signed_by
 data.trackings.signed_by string

署名者
SMS
 data.trackings.smses array of string

SMS
ソース
 data.trackings.source string

ソース
タグ
 data.trackings.tag string

タグ
subtag
 data.trackings.subtag string

サブ タグ
subtag_message
 data.trackings.subtag_message string

Sub tag messages
役職
 data.trackings.title string

役職
tracked_count
 data.trackings.tracked_count integer

追跡回数
last_mile_tracking_supported
 data.trackings.last_mile_tracking_supported string

ラスト マイル追跡はサポートされています
言語
 data.trackings.language string

言語
unique_token
 data.trackings.unique_token string

一意のトークン
チェックポイント
 data.trackings.checkpoints array of object

チェックポイント
置換フィールド
 data.trackings.checkpoints.slug string

宅配業者名
都市
 data.trackings.checkpoints.city string

都市
created_at
 data.trackings.checkpoints.created_at string

作成日時
場所
 data.trackings.checkpoints.location string

場所
country_name
 data.trackings.checkpoints.country_name string

国名
メッセージ
 data.trackings.checkpoints.message string

メッセージ
country_iso3
 data.trackings.checkpoints.country_iso3 string

ISO 3 形式の国コード
タグ
 data.trackings.checkpoints.tag string

タグ
subtag
 data.trackings.checkpoints.subtag string

サブ タグ
subtag_message
 data.trackings.checkpoints.subtag_message string

Sub tag messages
checkpoint_time
 data.trackings.checkpoints.checkpoint_time string

チェックポイントに到達した時間
座標
 data.trackings.checkpoints.coordinates array of

座標
都道府県
 data.trackings.checkpoints.state string

都道府県
郵便番号
 data.trackings.checkpoints.zip string

郵便番号
raw_tag
 data.trackings.checkpoints.raw_tag string

Raw タグ
subscribed_smses
 data.trackings.subscribed_smses array of string

subscribed_smses
subscribed_emails
 data.trackings.subscribed_emails array of string

subscribed_emails
return_to_sender
 data.trackings.return_to_sender boolean

return_to_sender
tracking_account_number
 data.trackings.tracking_account_number string

tracking_account_number
tracking_origin_country
 data.trackings.tracking_origin_country string

tracking_origin_country
tracking_destination_country
 data.trackings.tracking_destination_country string

tracking_destination_country
tracking_key
 data.trackings.tracking_key string

tracking_key
tracking_postal_code
 data.trackings.tracking_postal_code string

tracking_postal_code
tracking_ship_date
 data.trackings.tracking_ship_date string

tracking_ship_date
tracking_state
 data.trackings.tracking_state string

tracking_state
order_promised_delivery_date
 data.trackings.order_promised_delivery_date string

order_promised_delivery_date
delivery_type
 data.trackings.delivery_type string

delivery_type
pickup_location
 data.trackings.pickup_location string

pickup_location
pickup_note
 data.trackings.pickup_note string

pickup_note
courier_tracking_link
 data.trackings.courier_tracking_link string

courier_tracking_link
courier_redirect_link
 data.trackings.courier_redirect_link string

courier_redirect_link
first_attempted_at
 data.trackings.first_attempted_at string

first_attempted_at

追跡を完了とマーク

操作 ID:
MarkTrackingAsCompleted

追跡を完了とマーク。 追跡は、再追跡するまで自動更新されません。

パラメーター

名前 キー 必須 型 説明
宅配便の置換フィールド
 slug True string

宅配便の置換フィールド
追跡番号
 tracking_number True string

追跡番号の入力
理由
 reason string

理由

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
メッセージ
 meta.message string

メッセージ
タイプ
 meta.type string

タイプ

追跡を更新する

操作 ID:
UpdateATracking

追跡を更新する。

パラメーター

名前 キー 必須 型 説明
宅配便の置換フィールド
 slug True string

宅配便の置換フィールド
追跡番号
 tracking_number True string

追跡番号の入力
役職
 title string

役職
メモ
 note string

メモ

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
ID
 data.tracking.id string

ID
created_at
 data.tracking.created_at string

作成日時
updated_at
 data.tracking.updated_at string

更新日時
last_updated_at
 data.tracking.last_updated_at string

最終更新日時
tracking_number
 data.tracking.tracking_number string

追跡番号
置換フィールド
 data.tracking.slug string

宅配業者名
アクティブ
 data.tracking.active boolean

アクティブまたは非アクティブな追跡
Android
 data.tracking.android array of

Android
custom_fields
 data.tracking.custom_fields string

カスタム フィールド
customer_name
 data.tracking.customer_name string

顧客名
delivery_time
 data.tracking.delivery_time integer

出荷日時
destination_country_iso3
 data.tracking.destination_country_iso3 string

ISO 3 形式の宛先国コード
courier_destination_country_iso3
 data.tracking.courier_destination_country_iso3 string

ISO 3 形式の宅配便国コード
メール
 data.tracking.emails array of

メール アドレス
expected_delivery
 data.tracking.expected_delivery string

配達予定日時
iOS
 data.tracking.ios array of

iOS
note
 data.tracking.note string

ノート
order_id
 data.tracking.order_id string

Order ID
order_id_path
 data.tracking.order_id_path string

受注 ID パス
origin_country_iso3
 data.tracking.origin_country_iso3 string

ISO 3 形式の元の国コード
shipment_package_count
 data.tracking.shipment_package_count integer

出荷のパッケージ数
shipment_pickup_date
 data.tracking.shipment_pickup_date string

集荷したパッケージの日時
shipment_delivery_date
 data.tracking.shipment_delivery_date string

パッケージが配送された日時
shipment_type
 data.tracking.shipment_type string

配送タイプ
shipment_weight
 data.tracking.shipment_weight integer

荷物の重量
shipment_weight_unit
 data.tracking.shipment_weight_unit string

荷物の重量の単位
signed_by
 data.tracking.signed_by string

署名者
SMS
 data.tracking.smses array of

SMS
ソース
 data.tracking.source string

ソース
タグ
 data.tracking.tag string

タグ
subtag
 data.tracking.subtag string

サブ タグ
subtag_message
 data.tracking.subtag_message string

Sub tag messages
役職
 data.tracking.title string

役職
tracked_count
 data.tracking.tracked_count integer

追跡回数
last_mile_tracking_supported
 data.tracking.last_mile_tracking_supported string

ラスト マイル追跡はサポートされています
言語
 data.tracking.language string

言語
unique_token
 data.tracking.unique_token string

一意のトークン
チェックポイント
 data.tracking.checkpoints array of object

チェックポイント
置換フィールド
 data.tracking.checkpoints.slug string

宅配業者名
都市
 data.tracking.checkpoints.city string

都市
created_at
 data.tracking.checkpoints.created_at string

作成日時
場所
 data.tracking.checkpoints.location string

場所
country_name
 data.tracking.checkpoints.country_name string

国名
メッセージ
 data.tracking.checkpoints.message string

メッセージ
country_iso3
 data.tracking.checkpoints.country_iso3 string

ISO 3 形式の国コード
タグ
 data.tracking.checkpoints.tag string

タグ
subtag
 data.tracking.checkpoints.subtag string

サブ タグ
subtag_message
 data.tracking.checkpoints.subtag_message string

Sub tag messages
checkpoint_time
 data.tracking.checkpoints.checkpoint_time string

チェックポイントに到達した時間
座標
 data.tracking.checkpoints.coordinates array of

座標
都道府県
 data.tracking.checkpoints.state string

都道府県
郵便番号
 data.tracking.checkpoints.zip string

郵便番号
raw_tag
 data.tracking.checkpoints.raw_tag string

Raw タグ
subscribed_smses
 data.tracking.subscribed_smses array of

subscribed_smses
subscribed_emails
 data.tracking.subscribed_emails array of

subscribed_emails
return_to_sender
 data.tracking.return_to_sender boolean

return_to_sender
tracking_account_number
 data.tracking.tracking_account_number string

tracking_account_number
tracking_origin_country
 data.tracking.tracking_origin_country string

tracking_origin_country
tracking_destination_country
 data.tracking.tracking_destination_country string

tracking_destination_country
tracking_key
 data.tracking.tracking_key string

tracking_key
tracking_postal_code
 data.tracking.tracking_postal_code string

tracking_postal_code
tracking_ship_date
 data.tracking.tracking_ship_date string

tracking_ship_date
tracking_state
 data.tracking.tracking_state string

tracking_state
order_promised_delivery_date
 data.tracking.order_promised_delivery_date string

order_promised_delivery_date
delivery_type
 data.tracking.delivery_type string

delivery_type
pickup_location
 data.tracking.pickup_location string

pickup_location
pickup_note
 data.tracking.pickup_note string

pickup_note
courier_tracking_link
 data.tracking.courier_tracking_link string

courier_tracking_link
courier_redirect_link
 data.tracking.courier_redirect_link string

courier_redirect_link
first_attempted_at
 data.tracking.first_attempted_at string

first_attempted_at

追跡情報の取得

操作 ID:
GetTrackingNotification

追跡が変更されたときに通知するユーザーの連絡先情報を取得します。 顧客の受信者のみが返されます。 ストアに属するどの email、sms または webhook も返されません。

パラメーター

名前 キー 必須 型 説明
宅配便の置換フィールド
 slug True string

宅配便の置換フィールド
追跡番号
 tracking_number True string

追跡番号の入力

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
メール
 data.notification.emails array of

メール アドレス
SMS
 data.notification.smses array of string

SMS

通知を削除する

操作 ID:
RemoveANotification

通知受信者を追跡番号から削除します。

パラメーター

名前 キー 必須 型 説明
宅配便の置換フィールド
 slug True string

宅配便の置換フィールド
追跡番号
 tracking_number True string

追跡番号の入力

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
メール
 data.notification.emails array of

メール アドレス
SMS
 data.notification.smses array of string

SMS

通知を追加する

操作 ID:
AddANotification

通知受信者を追跡番号に追加します。

パラメーター

名前 キー 必須 型 説明
宅配便の置換フィールド
 slug True string

宅配便の置換フィールド
追跡番号
 tracking_number True string

追跡番号の入力

戻り値

名前 パス 型 説明
コード
 meta.code integer

コード
メール
 data.notification.emails array of

メール アドレス
SMS
 data.notification.smses array of string

SMS