Получаване на заданията в опашката

GET /api/hype-custom/integrations/{integrationId}/queue-jobs

Връща заданията в опашката на интеграцията с 200 OK. Празна опашка връща []. Заявка за интеграция извън удостоверения акаунт се отхвърля с 500 и {"error": 1, "message": "This action is unauthorized."}.

Тези задания създават задачите за синхронизация, връщани от /tasks/hype-custom/[Entity]. Задание може да завърши с грешка, когато свързан запис, например артикул в поръчка, още не е синхронизиран между двата акаунта. HES спира временно опашката, докато липсващият запис се синхронизира, после опитва отново да създаде задачата за поръчката към платформата получател.

Отговорът е масив от обекти със следните полета:

id е уникалният идентификатор на заданието в опашката.

request_method е методът на заявката от акаунта източник.

entity е името на обекта, върху който работи заданието.

payload съдържа данните, подадени от платформата източник за синхронизация.

source идентифицира акаунта в платформата източник.

status показва дали заданието е завършило с грешка или чака обработка. Стойностите са failed и pending.

error_msg описва грешката при обработка, когато статусът е failed.

{
  "id": "1f6cc4e9-222f-4ee1-95fd-517e9b28dde8",
  "entity": "CategoryEntity",
  "request_method": "PUT",
  "payload": {
    "id": 53,
    "name": "TEST 4",
    "color": "#674AEF",
    "order": 9007199254740991,
    "createdAt": "2024-04-15T12:15:37.013Z",
    "updatedAt": "2024-04-15T12:15:57.000Z",
    "mainCategoryId": null
  },
  "source": {
    "id": "9a583928-13d9-4a0f-bb7f-c02b847a927c",
    "name": "hype-fe.stage.scalewest.com"
  },
  "status": "failed",
  "error_msg": "The entity with name TEST 4, which the platform is attempting to update, has not yet been fully synchronized between the two platforms."
}

Примерът показва задание за промяна на категория от hype-fe.stage.scalewest.com; същото задание е първо в списъка по-долу. HES още не може да създаде задачата за промяна, защото задача в /tasks/hype-custom/categories трябва първо да създаде записа в платформата получател. Обработете първоначалната POST задача, преди HES да създаде задача за промяна.

Заявка

GET https://es.dev.hype-software.com/api/hype-custom/integrations/{integrationId}/queue-jobs
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json
Content-Type: application/json

Параметри в пътя

Параметър	Пример
integrationId	Вашият integrationId

Примери за отговор

200 · Получаване на заданията в опашката

[
  {
    "id": "1f6cc4e9-222f-4ee1-95fd-517e9b28dde8",
    "entity": "CategoryEntity",
    "request_method": "PUT",
    "payload": {
      "id": 53,
      "name": "TEST 4",
      "color": "#674AEF",
      "order": 9007199254740991,
      "createdAt": "2024-04-15T12:15:37.013Z",
      "updatedAt": "2024-04-15T12:15:57.000Z",
      "mainCategoryId": null
    },
    "source": {
      "id": "9a583928-13d9-4a0f-bb7f-c02b847a927c",
      "name": "hype-fe.stage.scalewest.com"
    },
    "status": "failed",
    "error_msg": "The entity with name TEST 4, which the platform is attempting to update, has not yet been fully synchronized between the two platforms."
  },
  {
    "id": "e333eb4b-3d15-4b51-805f-0f95b7c9791f",
    "entity": "CategoryEntity",
    "request_method": "POST",
    "payload": {
      "id": 54,
      "name": "Специална бира",
      "color": "#E5E5E7",
      "order": 9007199254740991,
      "createdAt": "2024-04-18T11:49:05.955Z",
      "updatedAt": "2024-04-18T11:49:05.955Z",
      "mainCategoryId": null
    },
    "source": {
      "id": "9a583928-13d9-4a0f-bb7f-c02b847a927c",
      "name": "demo.hype-software.com"
    },
    "status": "pending",
    "error_msg": null
  },
  {
    "id": "ebb32f39-0c13-4d2a-9ded-fd72358367b7",
    "entity": "CategoryEntity",
    "request_method": "POST",
    "payload": {
      "id": 55,
      "name": "Много специална бира",
      "color": "#E5E5E7",
      "order": 9007199254740991,
      "createdAt": "2024-04-18T13:38:47.546Z",
      "updatedAt": "2024-04-18T13:38:47.546Z",
      "mainCategoryId": null
    },
    "source": {
      "id": "9a583928-13d9-4a0f-bb7f-c02b847a927c",
      "name": "hype-fe.stage.scalewest.com"
    },
    "status": "pending",
    "error_msg": null
  },
  {
    "id": "7e228673-30ef-4ad2-8920-75120488f8ab",
    "entity": "CategoryEntity",
    "request_method": "POST",
    "payload": {
      "id": 56,
      "name": "Специално червено вино",
      "color": "#674AEF",
      "order": 9007199254740991,
      "createdAt": "2024-04-19T07:44:58.162Z",
      "updatedAt": "2024-04-26T11:39:12.000Z",
      "mainCategoryId": 4
    },
    "source": {
      "id": "9a583928-13d9-4a0f-bb7f-c02b847a927c",
      "name": "hype-fe.stage.scalewest.com"
    },
    "status": "pending",
    "error_msg": null
  },
  {
    "id": "5de7fd5e-9fb0-4e19-9c01-8763a90094a3",
    "entity": "OrderRequestStatusEntity",
    "request_method": "POST",
    "payload": {
      "id": 1,
      "translationKey": "NEW",
      "src_status": {}
    },
    "source": {
      "id": "9a583928-13d9-4a0f-bb7f-c02b847a927c",
      "name": "hype-fe.stage.scalewest.com"
    },
    "status": "pending",
    "error_msg": null
  }
]