Повернення

Базова адреса для функцій роботи з методами /return_products/.

Додавання товарів до списку повернень

POST /return_products/returns/product

Приклад запиту, передача payload як масив:

[
  {
    "document_uuid": "817B005056A44C2211EAF680E7FCB900",
    "product_uuid": "809FF373C0D536474F976C432D54DA89",
    "return_cause_uuid": "81CB005056AC66D611E899490EDD0238",
    "quantity": 1
  }
]

Приклад запиту, передача payload як об’єкт:

{
  "payload": [
    {
      "document_uuid": "817B005056A44C2211EAF680E7FCB900",
      "product_uuid": "809FF373C0D536474F976C432D54DA89",
      "return_cause_uuid": "81CB005056AC66D611E899490EDD0238",
      "quantity": 1
    }
  ]
}

Приклад відповіді:

{
  "success_rows": [
    {
      "document_uuid": "817B005056A44C2211EAF680E7FCB900",
      "product_uuid": "AE7663D180D7164B4C3D13CEF33A0DB5",
      "return_cause_uuid": "8339005056BAFBEA11EB7D9C80AB3A01",
      "quantity": 1,
      "price": 578.64,
      "client_uuid": "812D000C2999A7E611E576524555E66A",
      "product": {
        "uuid": "AE7663D180D7164B4C3D13CEF33A0DB5",
        "brand": {
          "uuid": "812C000C2999A7E611E55EBAE141FA93",
          "name": "KNECHT"
        },
        "article": "HX 163KIT",
        "name": "Фильтр АКПП BMW 3 (E36)/5 (E34/E39)/7 (E38) 2.0-3.0 i -03 (с прокладкой) "
      }
    }
  ],
  "err_rows": None
}

Імпорт товарів із Excel файлу до списку повернень

POST /return_products/import/from_file

Примітка

Файл необхідно передавати “POST” запитом з типом “multipart/form-data” та ключем “file”. Для імпорту, можна використовувати Excel файли у форматах “xls” та “xlsx”.

Приклад відповіді:

{
  "success_rows": [
    {
      "document_number": "ДГ000929364",
      "quantity": 6,
      "product": {
        "article": "005568H",
        "brand": {
          "name": "CORTECO"
        }
      },
      "document_link": "https://b2b.bm.parts/documents/0000013C/81C7005056BA39E811EE2A2708F622B2"
    },
  ],
  "error_rows": [
    {
      "reason_for_return": "Брак",
      "document_number": "ДГ000929354",
      "quantity": 1,
      "product": {
        "article": "2088495",
        "brand": {
          "name": "HENKEL"
        }
      },
      "document_link": null,
      "error": "Одне з полів 'Артикул' або 'Номер реалізації' некоректне."
    }
  ],
  "download_error_rows": "https://api.bm.parts/return_products/download/unreturned"
}

Акти рекламації

GET /return_products/reclamations
Query Parameters:
 
  • page – номер сторінки
  • per_page – кількість записів на сторінці
  • direction – напрямок сортування. Може бути asc або desc.

За замовчуванням: desc

Приклад відповіді:

{
  "acts": [
    {
      "attachments": [
        "https://cdn.bm.parts/devapibox/b2b/11E1111111BAA11111ECB11111E1EDBF/test.png",
        "devapibox/b2b/11E1111111BAA11111ECB11111E1EDBF/test.png",
      ],
      "car_brand": "",
      "car_code": "",
      "car_engine": "",
      "car_model": "",
      "car_number": "",
      "comment": "TEST",
      "created_at": "2021-12-07T22:15:40+00:00",
      "defect_cause": "TEST",
      "defect_description": "Виявлено дефект після встановлення",
      "defect_detection_case": "B5CAA78769F881864B054462F1187D13",
      "diagnostic_equipment": "TEST",
      "disassembling_at": "2001-01-01T00:00:00+00:00",
      "installation_at": "2001-01-01T00:00:00+00:00",
      "number": "000011027",
      "odometer_end": 123,
      "odometer_start": 123,
      "partner_address": "TEST",
      "partner_name": "TEST",
      "partner_phone": "TEST",
      "prod_year": "",
      "photo_or_video": True,
      "product": {
        "article": "100 142 0006",
        "brand": {
          "name": "MEYLE",
          "uuid": "812C000C2999A7E611E55EBAE141FAA7"
        },
        "default_image": "photo\e\e\s\i\i\feb93791.jpeg",
        "name": "Цилиндр сцепления (рабочий) VW T3 1.9-2.1/1.6TD 81-92",
        "uuid": "897BB2C3B310CDC24EBC81A58659D502"
      },
      "quantity": 1,
      "reject_cause": "TEST2",
      "responsible_uuid": "00000000000000000000000000000000",
      "sales_doc": {
        "currency": {
          "name": "ГРН"
        },
        "document_name": "Реалізація товарів та послуг",
        "document_url": "https://api.bm.parts/documents/0000013C/81A1005056BA39E811EC4BABA4EAF82F",
        "number": "ПП000386407",
        "uuid": "81A1005056BA39E811EC4BABA4EAF82F",
        "owner": {
          "uuid": "812D000C2999A7E611E576524555E66A",
          "name": "Назва",
          "number": "1439400",
          "code": "1439400",
          "f": 2
        }
      },
      "sale_doc_product": {
        "price": 3.54, "quantity": 1
      },
      "unit_uuid": "00000000000000000000000000000000",
      "uuid": "3C881CA0E3DF46D7897E7DB9A7BC2858"
    }
  ]
}

Попередження

Зверніть увагу, що ключ photo_or_video є застарілим! 11.07.2024 його буде видалено.

Ключ sales_doc.owner.number залишений для сумісності та буде видалений 11.07.2024, використовуйте sales_doc.owner.code.

Створити Акт рекламації

POST /return_products/reclamation
Query Parameters:
 
  • attachments – Масив посилань на прикріплені фото з cdn
  • car_brand – Бренд авто, в який була встановлена запчастина
  • car_model – Модель авто
  • car_number – Номер авто
  • car_code – Код кузову
  • car_engine – Двигун
  • prod_year – Рік випуску
  • installation_at – Дата встановлення запчастини
  • disassembling_at – Дата демонтажу запчастини
  • odometer_start – Показники одометру на початок
  • odometer_end – Показники одометру на кінець
  • defect_description – Опис неполадки
  • defect_cause – Ймовірна причина неполадки
  • diagnostic_equipment – Діагностичне обладнання
  • defect_detection_case – Обставини виявлення неполадки (див. Обставини виявлення несправності)
  • quantity – Кількість
  • product_uuid – uuid товару
  • partner_name – Назва організації
  • partner_address – Адреса організації
  • partner_phone – Телефон організації
  • partner_unit – Співробітник організації
  • sales_doc_uuid – uuid документу продажу

Приклад payload:

{
  "attachments": [
    "https://cdn.bm.parts/devapibox/b2b/92E2011156BAA48611ECB71968E5EDBF/image_test.png",
    "https://cdn.bm.parts/devapibox/b2b/92E2011156BAA48611ECB71968E5EDBF/image_test2.png"
  ],
  "quantity": 1,
  "product_uuid": "B1BDED14C8F42B844FC89D02126B1F11",
  "sales_doc_uuid": "92F5005056BAD76D11EDED8B7D57111C",
  "defect_cause": "test",
  "defect_description": "test",
  "defect_detection_case": "B5CAA78769F881864B054462F1187D13",
  "diagnostic_equipment": "test",
  "disassembling_at": "1970-01-01T03:00:00Z",
  "installation_at": "1970-01-01T03:00:00Z",
  "partner_address": "test",
  "partner_name": "test",
  "partner_phone": "+38 (050) 111-11-11",
  "partner_unit": "test"
}

Приклад відповіді:

{
  "number": "000011028",
  "uuid": "B987AA61A27A454E8A5E245508C9CFD2",
  "document_name": "Заявка на рекламацию"
}

Товари до повернення.

GET /return_products/returns
Query Parameters:
 
  • direction – Напрямок сортування. Може бути asc або desc. За замовчуванням: desc
  • page – номер сторінки
  • per_page – кількість записів на сторінці

Приклад відповіді:

{
  'returns': [
    {
      'document': {
        'currency': {
          'name': 'ГРН'
        },
        'document_url': 'http://127.0.0.1:5000/documents/0000013C/817B005056A44C2211EAF680E7FCB900',
        'number': 'ДГ000255128',
        'owner': {
          'f': 0,
          'name': 'Иванов Иван',
          'number': '1439400',
          'code': '1439400',
          'uuid': '812D000C2999A7E611E576524555E66A'
        },
        'type': '0000013C',
        'uuid': '817B005056A44C2211EAF680E7FCB900'
      },
      'price': 560.88,
      'product': {
        'article': '22272',
        'brand': {
          'name': 'FEBI BILSTEIN',
          'uuid': '812C000C2999A7E611E55EB9C240D5F2'
        },
        'default_image': 'photo\o\b\d\w\h\78a9a1f5.jpeg',
        'name': 'Антифриз (красный) G12 (5L)',
        'uuid': '809FF373C0D536474F976C432D54DA89'
      },
      'return_cause': {'code': '000000008',
                       'name': 'Пробил не из того склада',
                       'uuid': '81CB005056AC66D611E899490EDD0238'},
      'quantity': 3,
      'available': 1,
      'sold_quantity': 4,
      'updated_at': '2020-11-18T09:42:46+00:00',
      'uuid': 'EA74977C45324347A6ADDCFB8870C844'
    }
  ]
}

Попередження

Зверніть увагу, що поле document.owner.number залишено для сумісності та буде видалено 11.07.2024, використовуйте document.owner.code.

Список товарів до повернення з реалізацій.

GET /return_products/sold
Query Parameters:
 
  • direction – Напрямок сортування. Може бути asc або desc. За замовчуванням: desc
  • page – номер сторінки
  • per_page – кількість записів на сторінці
  • q – Пошуковий рядок. Дозволяє шукати за артикулом товару,назвою товару, назвою бренду чи номером реалізації
  • reason – Приймає значення returns і reclamations, returns - для повернень, reclamations - для акту рекламації. За замовчуванням: returns

Приклад відповіді:

{
  "products": [
    {
      "quantity": 4,
      "document": {
        "number": "ДГ000255128",
        "document_url": "https://devapi.bm.parts/documents/0000013C/817B005056A44C2211EAF680E7FCB900",
        "currency": {
          "name": "ГРН"
        },
        "type": "0000013C",
        "owner": {
          "uuid": "812D000C2999A7E611E576524555E66A",
          "name": "Давидюк Юрій",
          "f": 0,
          "code": "1439400",
          "number": "1439400"
        },
        "uuid": "817B005056A44C2211EAF680E7FCB900"
      },
      "price": 560.88,
      "product": {
        "name": "Антифриз (красный) G12 (5L)",
        "default_image": "photo\o\b\d\w\h\78a9a1f5.jpeg",
        "brand": {
          "name": "FEBI BILSTEIN",
          "uuid": "812C000C2999A7E611E55EB9C240D5F2"
        },
        "article": "22272",
        "uuid": "809FF373C0D536474F976C432D54DA89"
      }
    }
  ]
}

Попередження

Поле document.owner.number залишений для сумісності та буде видалений 11.07.2024, використовуйте document.owner.code.

Редагувати Акт рекламації

PUT /return_products/reclamation/(reclamation_uuid)
Query Parameters:
 
  • attachments – Масив посилань на прикріплені фото з cdn
  • car_brand – Бренд авто, в який була встановлена запчастина
  • car_model – Модель авто
  • car_number – Номер авто
  • car_code – Код кузову
  • car_engine – Двигун
  • prod_year – Рік випуску
  • installation_at – Дата встановлення запчастини в форматі 30-12-2001
  • disassembling_at – Дата демонтажу запчастини в форматі 30-12-2001
  • odometer_start – Показники одометру на початок
  • odometer_end – Показники одометру на кінець
  • defect_description – Опис неполадки
  • defect_cause – Ймовірна причина неполадки
  • diagnostic_equipment – Діагностичне обладнання
  • defect_detection_case – Обставини виявлення неполадки (див. Обставини виявлення несправності)
  • quantity – Кількість
  • product_uuid – uuid товару
  • partner_name – Назва організації
  • partner_address – Адреса організації
  • partner_phone – Телефон організації
  • partner_unit – Співробітник організації
  • sales_doc_uuid – uuid документу продажу

Приклад payload:

{
  "attachments": [
    "https://cdn.bm.parts/devapibox/b2b/92E2005056BAA48611ECB71911E1EDBF/image_test.png"
  ],
  "partner_name": "test",
  "defect_detection_case": "B5CAA78769F881864B054462F1111D11",
  "partner_phone": "+38 (050) 111-11-11",
  "defect_description": "test",
  "reject_cause": "",
  "odometer_start": 0,
  "uuid": "81C8005056BA39E811EE52E6F4B11160",
  "car_model": "",
  "partner_address": "test",
  "car_brand": "",
  "number": "000018595",
  "car_engine": "",
  "odometer_end": 0,
  "defect_cause": "test",
  "product_uuid": "B1BDED14C8F42B844FC89D01116B7F64",
  "car_code": "",
  "sale_doc_product": {
    "price": 5.22,
    "quantity": 1
  },
  "sales_doc_uuid": "92F5001116BAD76D11EDED8B7D57269C",
  "quantity": 1.00,
  "car_number": "",
  "disassembling_at": "1970-01-01T00:00:00Z",
  "created_at": "2023-09-14T13:10:40Z",
  "partner_unit": "test",
  "diagnostic_equipment": "test",
  "prod_year": "",
  "installation_at": "1970-01-01T00:00:00Z",
  "comment": ""
}

Акт рекламації по uuid

GET /return_products/reclamation/(string: reclamation_uuid)
Query Parameters:
 
  • reclamation_uuid – UUID документу рекламації

Приклад відповіді:

{
  "attachments": [
    "https://cdn.bm.parts/devapibox/b2b/11E1111111BAA11111ECB11111E1EDBF/test.png",
    "devapibox/b2b/11E1111111BAA11111ECB11111E1EDBF/test.png",
  ],
  "car_brand": "",
  "car_code": "",
  "car_engine": "",
  "car_model": "",
  "car_number": "",
  "comment": "TEST",
  "created_at": "2021-12-07T22:15:40+00:00",
  "defect_cause": "TEST",
  "defect_description": "Виявлено дефект після встановлення",
  "defect_detection_case": "B5CAA78769F881864B054462F1187D13",
  "diagnostic_equipment": "TEST",
  "disassembling_at": "2001-01-01T00:00:00+00:00",
  "installation_at": "2001-01-01T00:00:00+00:00",
  "number": "000011027",
  "odometer_end": 123,
  "odometer_start": 123,
  "organization_unit": "",
  "organization_uuid": "A358000C2947F7AE11E2403DA9341A6D",
  "partner_address": "TEST",
  "partner_name": "TEST",
  "partner_phone": "TEST",
  "prod_year": "",
  "photo_or_video": False,
  "product": {
    "article": "100 142 0006",
    "brand": {
      "name": "MEYLE",
      "uuid": "812C000C2999A7E611E55EBAE141FAA7"
    },
    "default_image": "photo\e\e\s\i\i\feb93791.jpeg",
    "name": "Цилиндр сцепления (рабочий) VW T3 1.9-2.1/1.6TD 81-92",
    "uuid": "897BB2C3B310CDC24EBC81A58659D502"
  },
  "quantity": 1.0,
  "responsible_uuid": "00000000000000000000000000000000",
  "sales_doc": {
    "currency": {"name": "ГРН"},
    "document_name": "Реалізація товарів та послуг",
    "document_url": "https://api.bm.parts/documents/0000013C/81A1005056BA39E811EC4BABA4EAF82F",
    "number": "ПП000386407",
    "uuid": "81A1005056BA39E811EC4BABA4EAF82F"
    "owner": {
      "uuid": "812D000C2999A7E611E576524555E66A",
      "name": "Назва",
      "number": "1439400",
      "code": "1439400",
      "f": 2
    }
  },
  "sale_doc_product": {"price": 3.54, "quantity": 1},
  "unit_uuid": "00000000000000000000000000000000",
  "uuid": "3C881CA0E3DF46D7897E7DB9A7BC2858"
}

Попередження

Зверніть увагу, що ключ photo_or_video є застарілим! 11.07.2024 його буде видалено.

Ключ sales_doc.owner.number залишений для сумісності та буде видалений 11.07.2024, використовуйте sales_doc.owner.code.

Видалити Акт рекламації

DELETE /return_products/reclamation/(reclamation_uuid)
query reclamation_uuid:
 UUID документу

Зміна к-сті товару зі списку поверненнь

PUT /return_products/returns/(string: uuid)/(int: quantity)
Query Parameters:
 
  • uuid – ID запису
  • quantity – Кількість товару

Приклад відповіді:

{
  'success': True,
  'message': 'Количество успешно изменено'
}

Завантажити excel-документ з товарами на повернення

GET /return_products/returns/(string: file_type)
query file_type:
 Можливі значення xls, xlsx (Обов’язковий).

Видалити товар з товарів до повернення

DELETE /return_products/returns/(string: uuid)
Query Parameters:
 
  • uuid – ID запису

Приклад відповіді:

{
  'success': True
}

Базова адреса для функцій роботи з методами /returns/.

Попередження

Дані методи збережені тільки для сумісності! Не використовуйте їх!

Список товарів для повернення.

GET /returns/products

Приклад відповіді:

{
  "returning_products": {
    "result": true,
    "error": null,
    "data": [
      {
        "code": "000026117",
        "article": "9960",
        "brand_name": "AUTOTECHTEILE",
        "name": "Втулка вилки переключения передач MB Sprinter 96-06",
        "count": 11
      },
      {
        "code": "000053284",
        "article": "394.090",
        "brand_name": "ELRING",
        "name": "Прокладка термостата Renault/Volvo",
        "count": 1
      }
    ]
  }
}

Створити заявку на повернення

POST /returns/request
Query Parameters:
 
  • params – [{“code”: “000053284”, “cause_code”: “000026117”, “count”: 3}]

Метод вертає статус 201 CREATED при успішній обробці

Список причин повернення.

GET /returns/causes

Приклад відповіді:

{
  "returning_causes": [
    {
      "uuid": "8B0F4DFF953148D04FCB68CA04CC335A",
      "code": "000000004",
      "name": "Отказался конечный покупатель"
    },
    {
      "uuid": "8F66D6E4D62509E84C84FD9250DAEEDE",
      "code": "000000005",
      "name": "Повреждена упаковка или товар"
    }
  ]
}

Повідомити про повернення

POST /returns/notify
query text:Текст повідомлення передається через POST запит