Przejdź do głównej zawartości

Przykład integracji z FedEx

W tym samouczku pokażemy, jak zintegrować FedEx

1. Przygotowanie wstępne​

1.1. Utwórz konto w FedEx

Utwórz konto na portalu dewelopera

1.2. Utwórz projekty i uzyskaj tokeny

Utwórz 2 projekty w sekcji moje projekty i zapisz client id oraz client secret

Pierwszy projekt do zarządzania dostawami

Drugi projekt do śledzenia dostaw

1.3. Utwórz statusy dla dostawy

W zakładce statusy magazynu zamówień utwórz statusy:

  • order_delivery
  • order_delivery_started
  • ready_for_pickup

1.4. Utwórz zdarzenie do śledzenia statusów

W module Zdarzenia utwórz zdarzenie do śledzenia zmiany statusu zamówienia order_delivery.

IMG2

1.5. Utwórz kolekcję dla dostawy

W module Kolekcje integracyjne utwórz kolekcję dla dostawy z atrybutami:

  • name (string)
  • address (string)
  • phone_number (string)
  • city (string)
  • state_code (string)
  • postal_code (string)
  • country_code (string)
  • tracking_number (string)
  • transaction_id (string)
  • ship_datestamp (string)
  • delivery_datestamp (string)

IMG2

1.6. Utwórz testowe zamówienie

Utwórz zamówienie i wpis w kolekcji dla tego zamówienia.

IMG2

IMG2

2. Tworzenie przesyłki​

2.1. Śledzenie zdarzenia dostawy

  • Przeciągnij węzeł zdarzenia na obszar roboczy.
  • Wprowadź nazwę węzła
  • Zmień wartość w polu "Set" na "orderEvent".
  • Zdarzenie zostanie zapisane w obiekcie "msg.orderEvent" i będzie można je wykorzystać w innych węzłach.
  • Wybierz z listy utworzone zdarzenie "order delivery" i naciśnij "submit"

IMG2

2.2. Uzyskanie tokena

  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".
  • Zastąp YOUR_CLIENT_ID i YOUR_CLIENT_SECRET swoimi

IMG2

msg.payload = {
    'grant_type': 'client_credentials',
    'client_id': 'YOUR_CLIENT_ID',
    'client_secret': 'YOUR_CLIENT_SECRET'
}
msg.headers = {
    'Content-Type': 'application/x-www-form-urlencoded'
}

return msg;

Szczegóły dotyczące parametrów można znaleźć w dokumentacji FedEx

  • Przeciągnij węzeł żądanie http na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz w polu Metoda opcję "POST".
  • Wybierz w polu Dane opcję "Wyślij jako treść żądania".
  • Wklej w polu Link link https://apis-sandbox.fedex.com/oauth/token.
  • Wybierz w polu Zwróć opcję "Obiekt JSON".

IMG2

  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".

IMG2

msg.access_token = msg.payload.access_token;

return msg;

2.3. Tworzenie przesyłki

  • Przeciągnij węzeł api na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz metodę "Znajdź wiersze kolekcji" i wklej kod z opisu poniżej w polu "Dane".

IMG2

{
  "collectionIdentifier": "delivery",
  "entityId": "{{orderEvent.order.id}}",
  "entityType": "orders",
  "langCode": "en_US",
  "limit": 1,
  "offset": 0
}
  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".

IMG2

// uzyskujemy wcześniej zapisany token
const token = msg.access_token;

// ustawiamy nagłówki
msg.headers = {
    'Content-Type': 'application/json',
    'authorization': `Bearer ${token}`
};

// uzyskujemy kolekcje z poprzedniego kroku
const collection = msg.payload.items[0];
// przekształcamy tablicę w obiekt
const formData = collection.formData.reduce((acc, item) => {
  acc[item.marker] = item.value;
  return acc;
}, {});
// ustawiamy parametry odbiorcy z formularza
const recipient = {
  "address": {
    "streetLines": [
      formData.address
    ],
    "city": formData.city,
    "stateOrProvinceCode": formData.state_code,
    "postalCode": formData.postal_code,
    "countryCode": formData.country_code
  },
  "contact": {
    "personName": formData.name,
    "phoneNumber": formData.phone_number
  }
}
// ustawiamy dane kolekcji w msg, aby użyć w przyszłości
msg.collection = collection;
// ustawiamy parametry żądania dla fedex
msg.payload = {
  "labelResponseOptions": "URL_ONLY",
  "accountNumber": {
    "value": "510087020"
  },
  "requestedShipment": {
    "shipper": {
      "contact": {
        "personName": "IMIĘ NADAWCY",
        "phoneNumber": "9018328595"
      },
      "address": {
        "streetLines": [
          "ADRES NADAWCY 1"
        ],
        "city": "MEMPHIS",
        "stateOrProvinceCode": "TN",
        "postalCode": "38116",
        "countryCode": "US"
      }
    },
    "recipients": [
      recipient
    ],
    "serviceType": "STANDARD_OVERNIGHT",
    "packagingType": "TWÓJ_PAKIET",
    "pickupType": "DROPOFF_AT_FEDEX_LOCATION",
    "shippingChargesPayment": {
      "paymentType": "NADAWCA",
      "payor": {
        "responsibleParty": {
          "accountNumber": {
            "value": "510087020",
            "key": ""
          }
        },
        "address": {
          "streetLines": [
            "ADRES NADAWCY 1"
          ],
          "city": "MEMPHIS",
          "stateOrProvinceCode": "TN",
          "postalCode": "38116",
          "countryCode": "US"
        }
      }
    },
    "labelSpecification": {},
    "requestedPackageLineItems": [
      {
        "customerReferences": [
          {
            "customerReferenceType": "CUSTOMER_REFERENCE",
            "value": `Collection${collection.id}`
          }
        ],
        "weight": {
          "units": "LB",
          "value": "20"
        }
      }
    ]
  }
};

return msg;

Szczegóły dotyczące parametrów można znaleźć w dokumentacji FedEx

  • Przeciągnij węzeł żądanie http na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz w polu Metoda opcję "POST".
  • Wybierz w polu Dane opcję "Wyślij jako treść żądania".
  • Wklej w polu Link link https://apis-sandbox.fedex.com/ship/v1/shipments.
  • Wybierz w polu Zwróć opcję "Obiekt JSON".

IMG2

  • Przeciągnij węzeł debug na obszar roboczy i połącz z węzłem z poprzedniego kroku.

IMG2

  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".

IMG2

// uzyskujemy dane przesyłki
const shipment = msg.payload.output.transactionShipments[0];
// uzyskujemy dane kolekcji, zapisane wcześniej
const collection = msg.collection;

// zapisujemy w atrybutach formularza dane z przesyłki
const newFormData = [
  ...collection.formData
    .filter(item => !['transaction_id', 'ship_datestamp', 'delivery_datestamp', 'tracking_number'].includes(item.marker)),
  {
    marker: 'transaction_id',
    value: msg.payload.transactionId,
    type: 'string'
  },
  {
    marker: 'ship_datestamp',
    value: shipment.shipDatestamp,
    type: 'string'
  },
  {
    marker: 'delivery_datestamp',
    value: shipment.pieceResponses[0].deliveryDatestamp,
    type: 'string'
  },
  {
    marker: 'tracking_number',
    value: shipment.masterTrackingNumber,
    type: 'string'
  }
]

// ustawiamy parametry do aktualizacji kolekcji
msg.payload = {
  id: collection.id,
  collectionIdentifier: 'delivery',
  formData: {
    en_US: newFormData
  },
  formIdentifier: 'delivery_form',
  entityId: collection.entityId,
  entityType: collection.entityType,
  langCode: 'en_US',
}

// zapisujemy dane kolekcji, aby użyć dalej
msg.collection = msg.payload;

return msg;
  • Przeciągnij węzeł api na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz metodę "Aktualizuj wiersz kolekcji".

IMG2

2.4. Aktualizacja statusu zamówienia

  • Przeciągnij węzeł api na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz metodę "Aktualizuj status zamówienia" i wklej kod z opisu poniżej w polu "Dane".

IMG2

{
  "orderId": "{{collection.entityId}}",
  "storageId": "test_order_storage",
  "statusIdentifier": "order_delivery_started"
}
  • Przeciągnij węzeł debug na obszar roboczy i połącz z węzłem z poprzedniego kroku.

IMG2

3. Śledzenie statusu przesyłki​

3.1. Uzyskanie zamówień do śledzenia

  • Przeciągnij węzeł interwał na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wprowadź interwał w minutach.

IMG2

  • Przeciągnij węzeł api na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz metodę "Znajdź zamówienia według statusu" i wklej kod z opisu poniżej w polu "Dane".

IMG2

{
  "storageId": "test_order_storage",
  "statusIdentifier": "order_delivery_started"
}
  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".

IMG2

msg.payload = msg.payload.items;

return msg;
  • Przeciągnij węzeł podziel na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wprowadź długość.

IMG2

  • Przeciągnij węzeł api na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz metodę "Znajdź wiersz kolekcji" i wklej kod z opisu poniżej w polu "Dane".

IMG2

{
  "collectionIdentifier": "delivery",
  "entityId": "{{payload.id}}",
  "entityType": "orders",
  "langCode": "en_US",
  "limit": 1,
  "offset": 0
}
  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".

IMG2

msg.payload = msg.payload.items[0]

return msg;
  • Przeciągnij węzeł przełącz na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Dodaj regułę do sprawdzenia. Wybierz warunek "nie pusty".

IMG2

  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".

IMG2

msg.trackingNumber = msg.payload
  .formData
  .find(item => item.marker === 'tracking_number')
  .value;

msg.collection = msg.payload;

return msg;

3.2. Uzyskanie tokena

  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".
  • Zastąp YOUR_CLIENT_ID i YOUR_CLIENT_SECRET swoimi

IMG2

msg.payload = {
    'grant_type': 'client_credentials',
    'client_id': 'YOUR_CLIENT_ID',
    'client_secret': 'YOUR_CLIENT_SECRET'
}
msg.headers = {
    'Content-Type': 'application/x-www-form-urlencoded'
}

return msg;

Szczegóły dotyczące parametrów można znaleźć w dokumentacji FedEx

  • Przeciągnij węzeł żądanie http na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz w polu Metoda opcję "POST".
  • Wybierz w polu Dane opcję "Wyślij jako treść żądania".
  • Wklej w polu Link link https://apis-sandbox.fedex.com/oauth/token.
  • Wybierz w polu Zwróć opcję "Obiekt JSON".

IMG2

3.3. Uzyskanie statusu przesyłki

  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".

IMG2

const token = msg.payload.access_token;

msg.headers = {
    'content-type': 'application/json',
    'authorization': `Bearer ${token}`
};

msg.payload = {
  "trackingInfo": [
    {
      "trackingNumberInfo": {
        "trackingNumber": msg.trackingNumber
      }
    }
  ],
  "includeDetailedScans": true
}

return msg;

Szczegóły dotyczące parametrów można znaleźć w dokumentacji FedEx

  • Przeciągnij węzeł żądanie http na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz w polu Metoda opcję "POST".
  • Wybierz w polu Dane opcję "Wyślij jako treść żądania".
  • Wklej w polu Link link https://apis-sandbox.fedex.com/track/v1/trackingnumbers.
  • Wybierz w polu Zwróć opcję "Obiekt JSON".

IMG2

  • Przeciągnij węzeł funkcja na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wklej kod z przykładu w polu "Funkcja".

IMG2

msg.payload = msg.payload.output.completeTrackResults[0].trackResults[0].latestStatusDetail.statusByLocale;

return msg;

3.4. Aktualizacja statusu zamówienia

  • Przeciągnij węzeł przełącz na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Dodaj regułę do sprawdzenia. Wybierz warunek "==", w wartości wpisz "Gotowe do odbioru"

IMG2

  • Przeciągnij węzeł api na obszar roboczy i połącz z węzłem z poprzedniego kroku.
  • Wybierz metodę "Aktualizuj status zamówienia" i wklej kod z opisu poniżej w polu "Dane".

IMG2

{
  "orderId": "{{collection.entityId}}",
  "storageId": "test_order_storage",
  "statusIdentifier": "ready_for_pickup"
}
  • Przeciągnij węzeł debug na obszar roboczy i połącz z węzłem z poprzedniego kroku.

IMG2