Перейти до основного вмісту

Приклад інтеграції з FedEx

В цьому навчальному уроці ми покажемо, як інтегрувати FedEx

1. Попередня підготовка​

1.1. Створіть акаунт у FedEx

Створіть акаунт на порталі розробника

1.2. Створіть проекти та отримайте токени

Створіть 2 проекти в розділі мої проекти і збережіть client id та client secret

Перший проект для управління доставками

Другий проект для відстеження доставок

1.3. Створіть статуси для доставки

У вкладці статуси сховища замовлень створіть статуси:

  • order_delivery
  • order_delivery_started
  • ready_for_pickup

1.4. Створіть подію для відстеження статусів

В модулі Events створіть подію для відстеження зміни статусу замовлення order_delivery.

IMG2

1.5. Створіть колекцію для доставки

В модулі Integration Collections створіть колекцію для доставки з атрибутами:

  • 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. Створіть тестове замовлення

Створіть замовлення та запис у колекції для цього замовлення.

IMG2

IMG2

2. Створення відправлення​

2.1. Відстеження події доставки

  • Перетягніть ноду events на робочу область.
  • Введіть назву ноди
  • Змініть значення в полі "Set" на "orderEvent".
  • Подія збережеться в об'єкті "msg.orderEvent" і її можна буде використовувати в інших нодах.
  • Виберіть зі списку створену подію "order delivery" і натисніть "submit"

IMG2

2.2. Отримання токена

  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".
  • Замість YOUR_CLIENT_ID та YOUR_CLIENT_SECRET вставте свої

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;

Детальніше про параметри можна дізнатися в документації FedEx

  • Перетягніть ноду http request на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть у полі Method варіант "POST".
  • Виберіть у полі Data варіант "Send as request body".
  • Вставте в поле Link посилання https://apis-sandbox.fedex.com/oauth/token.
  • Виберіть у полі Return варіант "Object JSON".

IMG2

  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".

IMG2

msg.access_token = msg.payload.access_token;

return msg;

2.3. Створення відправлення

  • Перетягніть ноду api на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть метод "Find collection rows" і вставте код з опису нижче в поле "Data".

IMG2

{
  "collectionIdentifier": "delivery",
  "entityId": "{{orderEvent.order.id}}",
  "entityType": "orders",
  "langCode": "en_US",
  "limit": 1,
  "offset": 0
}
  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".

IMG2

// отримуємо раніше збережений токен
const token = msg.access_token;

// встановлюємо заголовки
msg.headers = {
    'Content-Type': 'application/json',
    'authorization': `Bearer ${token}`
};

// отримуємо колекції з попереднього кроку
const collection = msg.payload.items[0];
// перетворюємо масив в об'єкт
const formData = collection.formData.reduce((acc, item) => {
  acc[item.marker] = item.value;
  return acc;
}, {});
// встановлюємо параметри отримувача з форми
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
  }
}
// встановлюємо дані колекції в msg, щоб використовувати в майбутньому
msg.collection = collection;
// встановлюємо параметри запиту для fedex
msg.payload = {
  "labelResponseOptions": "URL_ONLY",
  "accountNumber": {
    "value": "510087020"
  },
  "requestedShipment": {
    "shipper": {
      "contact": {
        "personName": "ІМ'Я ВІДПРАВНИКА",
        "phoneNumber": "9018328595"
      },
      "address": {
        "streetLines": [
          "АДРЕСА ВІДПРАВНИКА 1"
        ],
        "city": "МЕМФІС",
        "stateOrProvinceCode": "TN",
        "postalCode": "38116",
        "countryCode": "US"
      }
    },
    "recipients": [
      recipient
    ],
    "serviceType": "STANDARD_OVERNIGHT",
    "packagingType": "ВАША УПАКОВКА",
    "pickupType": "DROPOFF_AT_FEDEX_LOCATION",
    "shippingChargesPayment": {
      "paymentType": "SENDER",
      "payor": {
        "responsibleParty": {
          "accountNumber": {
            "value": "510087020",
            "key": ""
          }
        },
        "address": {
          "streetLines": [
            "АДРЕСА ВІДПРАВНИКА 1"
          ],
          "city": "МЕМФІС",
          "stateOrProvinceCode": "TN",
          "postalCode": "38116",
          "countryCode": "US"
        }
      }
    },
    "labelSpecification": {},
    "requestedPackageLineItems": [
      {
        "customerReferences": [
          {
            "customerReferenceType": "CUSTOMER_REFERENCE",
            "value": `Collection${collection.id}`
          }
        ],
        "weight": {
          "units": "LB",
          "value": "20"
        }
      }
    ]
  }
};

return msg;

Детальніше про параметри можна дізнатися в документації FedEx

  • Перетягніть ноду http request на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть у полі Method варіант "POST".
  • Виберіть у полі Data варіант "Send as request body".
  • Вставте в поле Link посилання https://apis-sandbox.fedex.com/ship/v1/shipments.
  • Виберіть у полі Return варіант "Object JSON".

IMG2

  • Перетягніть ноду debug на робочу область і з'єднайте з нодою з попереднього кроку.

IMG2

  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".

IMG2

// отримуємо дані відправлення
const shipment = msg.payload.output.transactionShipments[0];
// отримуємо дані колекції, збережені раніше
const collection = msg.collection;

// записуємо в атрибути форми дані з відправлення
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'
  }
]

// встановлюємо параметри для оновлення колекції
msg.payload = {
  id: collection.id,
  collectionIdentifier: 'delivery',
  formData: {
    en_US: newFormData
  },
  formIdentifier: 'delivery_form',
  entityId: collection.entityId,
  entityType: collection.entityType,
  langCode: 'en_US',
}

// зберігаємо дані колекції, щоб використовувати далі
msg.collection = msg.payload;

return msg;
  • Перетягніть ноду api на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть метод "Update collection row".

IMG2

2.4. Оновлення статусу замовлення

  • Перетягніть ноду api на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть метод "Update order status" і вставте код з опису нижче в поле "Data".

IMG2

{
  "orderId": "{{collection.entityId}}",
  "storageId": "test_order_storage",
  "statusIdentifier": "order_delivery_started"
}
  • Перетягніть ноду debug на робочу область і з'єднайте з нодою з попереднього кроку.

IMG2

3. Відстеження статусу відправлення​

3.1. Отримання замовлень для відстеження

  • Перетягніть ноду interval на робочу область і з'єднайте з нодою з попереднього кроку.
  • Введіть інтервал у хвилинах.

IMG2

  • Перетягніть ноду api на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть метод "Find orders by status" і вставте код з опису нижче в поле "Data".

IMG2

{
  "storageId": "test_order_storage",
  "statusIdentifier": "order_delivery_started"
}
  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".

IMG2

msg.payload = msg.payload.items;

return msg;
  • Перетягніть ноду split на робочу область і з'єднайте з нодою з попереднього кроку.
  • Введіть довжину.

IMG2

  • Перетягніть ноду api на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть метод "Find collection row" і вставте код з опису нижче в поле "Data".

IMG2

{
  "collectionIdentifier": "delivery",
  "entityId": "{{payload.id}}",
  "entityType": "orders",
  "langCode": "en_US",
  "limit": 1,
  "offset": 0
}
  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".

IMG2

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

return msg;
  • Перетягніть ноду switch на робочу область і з'єднайте з нодою з попереднього кроку.
  • Додайте правило для перевірки. Виберіть умову "not empty".

IMG2

  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".

IMG2

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

msg.collection = msg.payload;

return msg;

3.2. Отримання токена

  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".
  • Замість YOUR_CLIENT_ID та YOUR_CLIENT_SECRET вставте свої

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;

Детальніше про параметри можна дізнатися в документації FedEx

  • Перетягніть ноду http request на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть у полі Method варіант "POST".
  • Виберіть у полі Data варіант "Send as request body".
  • Вставте в поле Link посилання https://apis-sandbox.fedex.com/oauth/token.
  • Виберіть у полі Return варіант "Object JSON".

IMG2

3.3. Отримання статусу відправлення

  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".

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;

Детальніше про параметри можна дізнатися в документації FedEx

  • Перетягніть ноду http request на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть у полі Method варіант "POST".
  • Виберіть у полі Data варіант "Send as request body".
  • Вставте в поле Link посилання https://apis-sandbox.fedex.com/track/v1/trackingnumbers.
  • Виберіть у полі Return варіант "Object JSON".

IMG2

  • Перетягніть ноду function на робочу область і з'єднайте з нодою з попереднього кроку.
  • Вставте код з прикладу в поле "Function".

IMG2

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

return msg;

3.4. Оновлення статусу замовлення

  • Перетягніть ноду switch на робочу область і з'єднайте з нодою з попереднього кроку.
  • Додайте правило для перевірки. Виберіть умову "==", в значенні введіть "Готово до отримання"

IMG2

  • Перетягніть ноду api на робочу область і з'єднайте з нодою з попереднього кроку.
  • Виберіть метод "Update order status" і вставте код з опису нижче в поле "Data".

IMG2

{
  "orderId": "{{collection.entityId}}",
  "storageId": "test_order_storage",
  "statusIdentifier": "ready_for_pickup"
}
  • Перетягніть ноду debug на робочу область і з'єднайте з нодою з попереднього кроку.

IMG2