Перейти к основному содержимому

Пример интеграции с 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

Подробно о ноде Events можно узнать здесь.

2.2. Получение токена

  • Перетащите ноду "function" на рабочую область и соедините с нодой из предыдущего шага.
  • Вставьте код из примера в поле "Function".
  • Заменить YOUR_CLIENT_ID и OUR_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

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

IMG2

Подробно о ноде HTTP Request можно узнать здесь.
  • Перетащите ноду "function" на рабочую область и соедините с нодой из предыдущего шага.
  • Вставьте код из примера в поле "Function".

IMG2

msg.access_token = msg.payload.access_token;

return msg;
Подробно о ноде Function можно узнать здесь.

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

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

IMG2

{
  "collectionIdentifier": "delivery",
  "entityId": "{{orderEvent.order.id}}",
  "entityType": "orders",
  "langCode": "en_US",
  "limit": 1,
  "offset": 0
}
Подробно о ноде API можно узнать здесь.
  • Перетащите ноду "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.collection = collection;

msg.payload = {
  "labelResponseOptions": "URL_ONLY",
  "accountNumber": {
    "value": "510087020"
  },
  "requestedShipment": {
    "shipper": {
      "contact": {
        "personName": "SENDER NAME",
        "phoneNumber": "9018328595"
      },
      "address": {
        "streetLines": [
          "SENDER ADDRESS 1"
        ],
        "city": "MEMPHIS",
        "stateOrProvinceCode": "TN",
        "postalCode": "38116",
        "countryCode": "US"
      }
    },
    "recipients": [
      recipient
    ],
    "serviceType": "STANDARD_OVERNIGHT",
    "packagingType": "YOUR_PACKAGING",
    "pickupType": "DROPOFF_AT_FEDEX_LOCATION",
    "shippingChargesPayment": {
      "paymentType": "SENDER",
      "payor": {
        "responsibleParty": {
          "accountNumber": {
            "value": "510087020",
            "key": ""
          }
        },
        "address": {
          "streetLines": [
            "SENDER ADDRESS 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;

Подробнее о параметрах можно узнать в документации FedEx

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

IMG2

Подробно о ноде HTTP Request можно узнать здесь.
  • Перетащите ноду "Debug" на рабочую область и соедините с нодой из предыдущего шага.

IMG2

Подробно о ноде Debug можно узнать здесь.
  • Перетащите ноду "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;
Подробно о ноде Function можно узнать здесь.
  • Перетащите ноду "api" на рабочую область и соедините с нодой из предыдущего шага.
  • Выберите метод "Update collection row".

IMG2

Подробно о ноде API можно узнать здесь.

2.4. Обновление статуса заказа

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

IMG2

{
  "orderId": "{{collection.entityId}}",
  "storageId": "test_order_storage",
  "statusIdentifier": "order_delivery_started"
}
Подробно о ноде API можно узнать здесь.
  • Перетащите ноду "Debug" на рабочую область и соедините с нодой из предыдущего шага.

IMG2

Подробно о ноде Debug можно узнать здесь.

3. Отслеживание статуса отправления​

3.1. Получение заказов для отслеживания

  • Перетащите ноду "Interval" на рабочую область и соедините с нодой из предыдущего шага.
  • Введите интервал в минутах.

IMG2

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

IMG2

{
  "storageId": "test_order_storage",
  "statusIdentifier": "order_delivery_started"
}
Подробно о ноде API можно узнать здесь.
  • Перетащите ноду "function" на рабочую область и соедините с нодой из предыдущего шага.
  • Вставьте код из примера в поле "Function".

IMG2

msg.payload = msg.payload.items;

return msg;
Подробно о ноде Function можно узнать здесь.
  • Перетащите ноду "Split" на рабочую область и соедините с нодой из предыдущего шага.
  • Введите длину.

IMG2

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

IMG2

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

IMG2

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

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

IMG2

Подробно о ноде switch можно узнать здесь.
  • Перетащите ноду "function" на рабочую область и соедините с нодой из предыдущего шага.
  • Вставьте код из примера в поле "Function".

IMG2

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

msg.collection = msg.payload;

return msg;
Подробно о ноде Function можно узнать здесь.

3.2. Получение токена

  • Перетащите ноду "function" на рабочую область и соедините с нодой из предыдущего шага.
  • Вставьте код из примера в поле "Function".
  • Заменить YOUR_CLIENT_ID и OUR_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

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

IMG2

Подробно о ноде HTTP Request можно узнать здесь.

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

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

IMG2

Подробно о ноде HTTP Request можно узнать здесь.
  • Перетащите ноду "function" на рабочую область и соедините с нодой из предыдущего шага.
  • Вставьте код из примера в поле "Function".

IMG2

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

return msg;
Подробно о ноде Function можно узнать здесь.

3.4. Обновление статуса заказа

  • Перетащите ноду "swith" на рабочую область и соедините с нодой из предыдущего шага.
  • Добавьте правило для проверки. Выберите условие "==", в значении введите "Ready for pickup"

IMG2

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

IMG2

{
  "orderId": "{{collection.entityId}}",
  "storageId": "test_order_storage",
  "statusIdentifier": "ready_for_pickup"
}
Подробно о ноде API можно узнать здесь.
  • Перетащите ноду "Debug" на рабочую область и соедините с нодой из предыдущего шага.

IMG2

Подробно о ноде Debug можно узнать здесь.