Fed Ex Docs

Technical Preview

Overview

Client-mode REST API connector for the FedEx Developer Portal APIs: OAuth 2.0 client credentials, tracking (tracking number, reference, TCN, multiple-piece shipments, proof of delivery documents, e-mail notifications), rates and transit times, address and postal code validation, service availability, location search, shipments and labels (purchase), cancel, return tags (purchase), pickups (purchase), Global Trade regulatory details, Advanced Integrated Visibility subscriptions (billed) and trade document upload; companion server connector for AIV tracking webhooks. This is one of the templates in the FedEx Developer Portal REST API app (fedex-developer-portal). Deploy it alongside the other connectors of that app when they depend on each other (for example a token connector plus an API connector).

Not yet verified against the live vendor API: No FedEx developer project (API key / secret key) or FedEx shipping account on the factory box (no FEDEX_* variables); only static, mock, negative-control and unauthenticated / fake-credential public probes ran.

Auth

OAuth 2.0 client credentials (credentials in the form body, client_secret_post): GetToken posts grant_type=client_credentials&client_id&client_secret (application/x-www-form-urlencoded) to /oauth/token; GetTokenChild uses client_pc_credentials or csp_credentials + child_Key + child_secret. Reply access_token, token_type bearer, expires_in 3600, scope; no refresh token. FedExApi / FedExDocs events: Authorization: Bearer <access_token> and x-customer-transaction-id; FedExApi also x-locale en_US. Every event sends User-Agent: Coreflux-Broker. Auth headers used by the template: Authorization: Bearer {value.json.access_token}.

Template parameters

Placeholder	Type	Description	Required
`RouteName`	string	Name of the Fed Ex Docs connector	no
`BaseUrl`	string	Fed Ex Docs base URL without trailing slash (e.g. https://documentapi.prod.fedex.com)	yes

BASE_ADDRESS default: https://documentapi.prod.fedex.com.

Events

Event	Method	Endpoint	Request topic	Response topic	Payload fields
`UploadTradeDocuments`	POST	`/documents/v1/etds/encodedmultiupload`	`fleet/fedex/trade-document/upload`	`fleet/fedex/trade-document/upload/response`	`access_token`, `body`, `trans_id`
`UploadDocumentImage`	POST	`/documents/v1/lhsimages/encodedupload`	`fleet/fedex/document-image/upload`	`fleet/fedex/document-image/upload/response`	`access_token`, `body`, `trans_id`

Deploy

Get the template card (JSON with template and metadata) from the broker, then deploy the connector:

mosquitto_pub -t '$SYS/Coreflux/Command' -m "-routeCode FED_EX_DOCS"

The deployable connector from the REST API app, with BASE_ADDRESS already filled in:

DEFINE ROUTE FedExDocs WITH TYPE REST_API
    ADD REST_API_CONFIG
        WITH BASE_ADDRESS "https://documentapi.prod.fedex.com"
        WITH ENABLE_CLIENT "true"
        WITH USE_SSL "true"
        WITH REQUEST_TIMEOUT '60'
        WITH DEFAULT_CONTENT_TYPE "application/json"
    ADD EVENT UploadTradeDocuments
        WITH SOURCE_TOPIC "fleet/fedex/trade-document/upload"
        WITH DESTINATION_TOPIC "fleet/fedex/trade-document/upload/response"
        WITH METHOD "POST"
        WITH ENDPOINT "/documents/v1/etds/encodedmultiupload"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "User-Agent" "Coreflux-Broker"
            ADD "Authorization" "Bearer {value.json.access_token}"
            ADD "x-customer-transaction-id" "{value.json.trans_id}"
            ADD "Content-Type" "application/json"
        WITH BODY "{value.json.body}"
    ADD EVENT UploadDocumentImage
        WITH SOURCE_TOPIC "fleet/fedex/document-image/upload"
        WITH DESTINATION_TOPIC "fleet/fedex/document-image/upload/response"
        WITH METHOD "POST"
        WITH ENDPOINT "/documents/v1/lhsimages/encodedupload"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "User-Agent" "Coreflux-Broker"
            ADD "Authorization" "Bearer {value.json.access_token}"
            ADD "x-customer-transaction-id" "{value.json.trans_id}"
            ADD "Content-Type" "application/json"
        WITH BODY "{value.json.body}"

Deploy it with -addRoute (do not include ADD METADATA).

Usage example

Call UploadTradeDocuments by publishing a JSON payload to its request topic, and read the reply on the response topic:

mosquitto_sub -t 'fleet/fedex/trade-document/upload/response' &
mosquitto_pub -t 'fleet/fedex/trade-document/upload' -m '{"access_token": "<access_token>", "body": {}, "trans_id": "<trans_id>"}'

Quick Start

Coreflux MQTT Broker

LoT Language

Coreflux HUB

VS Code - LoT Notebooks

Coreflux Portal

Using AI with Coreflux

Product Updates

Overview

Auth

Template parameters

Events

Deploy

Usage example

​Overview

​Auth

​Template parameters

​Events

​Deploy

​Usage example

​Related

Overview

Auth

Template parameters

Events

Deploy

Usage example

Related