Rest API Список документів на переміщення товару

22. Ресурс `/relocate-documents/` (Документ на переміщення товару, Колекція, Тільки для читання)

Документ на переміщення товару - це документ із зазначеними деталями відносно переміщення товару між складами та магазинами. З допомогою ресурсу /relocate-documents/ можна отримати доступ до списку документів на переміщення товарів. А також додавати в довідник нові документи на переміщення .

22.1. Структура об'єкта Relocate documents:

Назва поля	Тип поля	розмір	Обов'язково	Тільки читання	Примітка
`relocate_id`	рядок		так	ні	ідентифікатор документа
`url`	URL		ні	так	url цього об'єкта
`price_total`	число		так	ні	загальна вартість
`relocate_date`	дата, час	50	так	ні	дата та час документу на переміщення товару
`responsible`	рядок		так	ні	відповідальний
`sender_shop_id`	рядок	50	ні	ні	ідентифікатор магазину відправника
`sender_shop_url`	URL		ні	так	url цього об'єкта
`receiver_shop_id`	рядок	50	ні	ні	ідентифікатор магазину отримувача
`receiver_shop_url`	URL		ні	так	url цього об'єкта
`products`	список		так	ні	масив товарів

22.1.2. Структура об'єкта ТОВАРИ (`PRODUCTS`):

Кожен товар містить в собі певні характеристики, які можна виразити в такій структурі:

Назва поля	Тип поля	розмір	Обов'язково	Тільки читання	Примітка
`product_id`	рядок	200	так	ні	ідентифікатор товару з Довідника по товарах (див.[`/products/`])
`product_url`	URL		ні	так	url ідентифікатора товару
`qty`	число		так	так	кількість
`price`	число		ні	ні	реальна ціна позиції (якщо це поле відсутнє, чи `price`*`qty` <> `price_total`, то вираховується, як `price_total`/`qty`)
`price_total`	число		так	ні	загальна вартість позиції (= ціна * кількість)

22.2. Доступні команди

Для управління ресурсом /relocate-documents/ підтримуються наступні команди:

GET - отримати одну сторінку колекції
POST - завантажити документи на переміщення товару
OPTIONS - мета-інформація по структурі об'єкта
HEAD - аналог GET, але повертається тільки заголовок відповіді

22.2.1. `GET /relocate-documents/` - отримати одну сторінку колекції.

Вид команди: GET http://api.datawiz.io/api/v1/relocate-documents

Суфікси:

.json - Отримати відповідь з серверу в форматі JSON
.api - Отримати відповідь з серверу в форматі HTML (тестова платформа)

Параметри:

format = json | api - аналог вищевказаних суфіксів
page_size = nn - встановити розмір сторінки рівний nn об'єктів
page = n - завантажити сторінку n
search = text - відображати тільки об'єкти, в полі name яких знайдено "text"
ordering = name | identifier - сортувати по полю в алфавітному порядку (від меншого - до більшого)
ordering = -name | -identifier - сортувати по полю в зворотньому порядку

Відповідь сервера:

Об'єкт "колекція" складається з чотирьох полів (count, next, previous, results).

Приклад пустої колекції, отриманої в результаті запиту:

GET http://api.datawiz.io/api/v1/relocate-documents/.json/?search=unknown-string

{
     "count": 0,
     "next": null,
     "previous": null,
     "results": [] 
}

Приклад колекції з 2-х елементів: GET http://api.datawiz.io/api/v1/relocate-documents/?format=api&page_size=2:

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
{
    "count": 11, 
    "next": "http://api.datawiz.io/api/v1/relocate-documents/?page=2&page_size=2&format=api", 
    "previous": null, 
    "results": [
        {
            "relocate_id": "11112",
            "url": "http://api.datawiz.io/api/v1/relocate-documents/11112/",
            "price_total": "48.0000",
            "relocate_date": "2016-01-01T00:00:00",
            "responsible": "",
            "sender_shop_id": null,
            "sender_shop_url": null,
            "receiver_shop_id": null,
            "receiver_shop_url": null,
            "products": [
                {
                    "product_id": "a26f866b-1465-11e5-80cb-a01d4897e530",
                    "product_url": "http://api.datawiz.io/api/v1/products/a26f866b-1465-11e5-80cb-a01d4897e530/",
                    "qty": "2.0000",
                    "price": "10.0000",
                    "price_total": "20.0000"
                }
{
                    "product_id": "a26f866b-1465-11e5-80cb-a01d4897e531",
                    "product_url": "http://api.datawiz.io/api/v1/products/a26f866b-1465-11e5-80cb-a01d4897e531/",
                    "qty": "2.0000",
                    "price": "14.0000",
                    "price_total": "28.0000"
                }
            ]
        }, 
        {
            "relocate_id": "11114",
            "url": "http://api.datawiz.io/api/v1/relocate-documents/11114/",
            "price_total": "33.0000",
            "relocate_date": "2016-02-01T00:00:00",
            "responsible": "",
            "sender_shop_id": null,
            "sender_shop_url": null,
            "receiver_shop_id": null,
            "receiver_shop_url": null,
            "products": [
                {
                    "product_id": "a26f866b-1465-11e5-80cb-a01d4897e531",
                    "product_url": "http://api.datawiz.io/api/v1/products/a26f866b-1465-11e5-80cb-a01d4897e531/",
                    "qty": "3.0000",
                    "price": "10.0000",
                    "price_total": "30.0000"
                }
{
                    "product_id": "a26f866b-1465-11e5-80cb-a01d4897e532",
                    "product_url": "http://api.datawiz.io/api/v1/products/a26f866b-1465-11e5-80cb-a01d4897e532/",
                    "qty": "3.0000",
                    "price": "1.0000",
                    "price_total": "3.0000"
                }
            ]
        }
    ]
}

Повідомлення про помилку:

У випадку виникнення помилки сервер повертає відповідь з відповідним статусом, а також повідомлення про помилку, записаним у ключі detail і/або в полі http.response.content:

HTTP 404 NOT FOUND 
Content-Type: application/json 
Vary: Accept 
Allow: GET, HEAD, OPTIONS, PATCH 
{
"detail": "Not found"
}

22.2.2 `POST /relocate-documents/` - додати інформацію по документу на отримання продукту

Вид команди: POST http://api.datawiz.io/api/v1/relocate-documents/?format=json

Суфікси:

.json - Отримати відповідь з сервера в форматі JSON
.api - Отримати відповідь з сервера в форматі HTML (тестова платформа)

Параметри:

format = json | api - аналог вищевказаних суфіксів

Дані запиту:

У запиті передається JSON-об'єкт типу словник (dictionary), який описує документ на отримання продукту. Важливі поля: relocate_id, relocate_date, price_total, responsible, products, product_id, qty, price. Послідовність полів не принципова.

Приклад запиту на завантаження документу на переміщення товару: POST http://api.datawiz.io/api/v1/relocate-documents/.json

{
            "relocate_id": "11113",
            "price_total": "30.0000",
            "relocate_date": "2016-02-01T00:00:00",
            "responsible": "",
            "sender_shop_id": null,
            "receiver_shop_id": null,
            "products": [
                {
                    "product_id": "a26f866b-1465-11e5-80cb-a01d4897e530",
                    "qty": "3.0000",
                    "price": "10.0000",
                    "price_total": "30.0000"
                }
            ]
        }

Відповідь сервера:

При коректній обробці запиту сервер повертає код статусу 201 і статус створення об'єкта.

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

HTTP 201 CREATED
Content-Type: application/json
Vary: Accept
Location: http://api.datawiz.io/api/v1/relocate-documents/124/
Allow: GET, POST, HEAD, OPTIONS
{
"updated": 0,
"inserted": 1
}

Умови та обмеження (Constraints):

Якщо об'єкт з ідентифікатором relocate_id вже існує на сервері, то вказаний запит замінить об'єкт на сервері (replace) без попередження.
Не можна додати на сервер об'єкт, якщо не існує товару з вказаним ідентифікатором product_id

Повідомлення про помилку:

У випадку виникнення помилки сервер повертає відповідь із відповідним статусом, а також повідомленням про помилку, записаним навпроти імені поля, з яким ця помилка пов'язана. Якщо помилка стосується не окремого поля, а всього об'єкта, то повідомлення про помилку буде записано навпроти ключа non_field_errors.

ПРИМІТКА. Кожне повідомлення про помилку являє собою колекцію (масив) рядкових символів.

Приклад відповіді сервера при виникненні помилки (поле product_id передано порожнім):

HTTP 400 BAD REQUEST 
Content-Type: application/json 
Vary: Accept 
Allow: GET, POST, HEAD, OPTIONS 
{
     "product_id": [
         "This field is required." 
     ] 
}

22.2.3. `OPTIONS /relocate-documents/` - мета-інформація по структурі об'єкта

При виконанні даної команди повертається така JSON-структура:

OPTIONS /api/v1/relocate-documents/

HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept
{
"name": "Relocate Document List",
"description": "this is my text. You can see this text on the REST-page",
"renders": [
"application/json",
"text/html"
],
"parses": [
"application/json",
"application/x-www-form-urlencoded",
"multipart/form-data"
],
"actions": {
"POST": {
"relocate_id": {
"type": "string",
"required": true,
"read_only": false,
"label": "Relocate id"
},
"url": {
"type": "field",
"required": false,
"read_only": true,
"label": "Url"
},
"price_total": {
"type": "decimal",
"required": true,
"read_only": false,
"label": "Total price"
},
"relocate_date": {
"type": "datetime",
"required": true,
"read_only": false,
"label": "Relocate date"
},
"responsible": {
"type": "string",
"required": true,
"read_only": false,
"label": "Responsible",
"max_length": 200
},
"sender_shop_id": {
"type": "string",
"required": false,
"read_only": false,
"label": "Sender shop id",
"max_length": 50
},
"sender_shop_url": {
"type": "field",
"required": false,
"read_only": true,
"label": "Sender shop url"
},
"receiver_shop_id": {
"type": "string",
"required": false,
"read_only": false,
"label": "Receiver shop id",
"max_length": 50
},
"receiver_shop_url": {
"type": "field",
"required": false,
"read_only": true,
"label": "Receiver shop url"
},
"products": {
"type": "field",
"required": true,
"read_only": false,
"label": "Products",
"child": {
"type": "nested object",
"required": true,
"read_only": false,
"children": {
"product_id": {
"type": "string",
"required": true,
"read_only": false,
"label": "Product id"
},
"product_url": {
"type": "field",
"required": false,
"read_only": true,
"label": "Product url"
},
"qty": {
"type": "decimal",
"required": true,
"read_only": false,
"label": "Qty"
},
"price": {
"type": "decimal",
"required": true,
"read_only": false,
"label": "Price"
},
"price_total": {
"type": "decimal",
"required": true,
"read_only": false,
"label": "Total price"
}
}
}
}
}
}
}

Rest API Список документів на переміщення товару - datawizio/pythonAPI GitHub Wiki

22. Ресурс `/relocate-documents/` (Документ на переміщення товару, Колекція, Тільки для читання)

22.1. Структура об'єкта Relocate documents:

22.1.2. Структура об'єкта ТОВАРИ (`PRODUCTS`):

22.2. Доступні команди

22.2.1. `GET /relocate-documents/` - отримати одну сторінку колекції.

Суфікси:

Параметри:

Відповідь сервера:

Повідомлення про помилку:

22.2.2 `POST /relocate-documents/` - додати інформацію по документу на отримання продукту

Суфікси:

Параметри:

Дані запиту:

Відповідь сервера:

Умови та обмеження (Constraints):

Повідомлення про помилку:

22.2.3. `OPTIONS /relocate-documents/` - мета-інформація по структурі об'єкта

⚠️ GitHub.com Fallback ⚠️

Rest API Список документів на переміщення товару - datawizio/pythonAPI GitHub Wiki

22. Ресурс /relocate-documents/ (Документ на переміщення товару, Колекція, Тільки для читання)

22.1. Структура об'єкта Relocate documents:

22.1.2. Структура об'єкта ТОВАРИ (PRODUCTS):

22.2. Доступні команди

22.2.1. GET /relocate-documents/ - отримати одну сторінку колекції.

Суфікси:

Параметри:

Відповідь сервера:

Повідомлення про помилку:

22.2.2 POST /relocate-documents/ - додати інформацію по документу на отримання продукту

Суфікси:

Параметри:

Дані запиту:

Відповідь сервера:

Умови та обмеження (Constraints):

Повідомлення про помилку:

22.2.3. OPTIONS /relocate-documents/ - мета-інформація по структурі об'єкта

⚠️ **GitHub.com Fallback** ⚠️

22. Ресурс `/relocate-documents/` (Документ на переміщення товару, Колекція, Тільки для читання)

22.1.2. Структура об'єкта ТОВАРИ (`PRODUCTS`):

22.2.1. `GET /relocate-documents/` - отримати одну сторінку колекції.

22.2.2 `POST /relocate-documents/` - додати інформацію по документу на отримання продукту

22.2.3. `OPTIONS /relocate-documents/` - мета-інформація по структурі об'єкта

⚠️ GitHub.com Fallback ⚠️