SNARTA

info@snarta.com

+7 499 677-22-98

Заказы

Свойства заказа

address_id - идентификатор заказа

  • Строка до 64 символов
  • Обязательно к заполнению

cust_id - идентификатор клиента

  • Строка до 64 символов
  • Обязательно к заполнению

contact_id - идентификатор контакта

  • Строка до 64 символов
  • Обязательно к заполнению

created_at - дата и время создания заказа

  • Строка
  • Обязательно к заполнению

status - статус заказа

  • Натуральное число
  • Обязательно к заполнению
  • Допустимые значения:
    • 0 - Новый
    • 1 - Получен
    • 2 - Готовится к отгрузке
    • 3 - Отгружен
    • 4 - Отменён

shipment_address_id - идентификатор адреса доставки

  • Строка до 64 символов
  • Допустимые значения:

    • пустая строка - адрес доставки отсуствует

      ИЛИ

    • идентификатор адреса доставки

shipment_date - дата получения заказа

  • Строка в формате ISO 8601
  • Допустимые значения:

    • пустая строка - дата получения отсуствует

      ИЛИ

    • дата получения заказа

shipment_trip - номер рейса доставки

  • Натуральное число
  • Минимальное значение - 0
  • Максимальное значение - 32767

discount - скидки, запрошенная пользователем

  • Натуральное число
  • Значение по-умолчанию - 0
  • Минимальное значение - 0
  • Максимальное значение - 2147483647

lines - строки заказа

Свойства строк заказа

id - идентификатор строки

  • Строка до 64 символов
  • Обязательно к заполнению

item_id - идентификатор товара

  • Строка до 64 символов
  • Обязательно к заполнению

qty - количество к заказу

  • Натуральное число
  • Обязательно к заполнению
  • Максимальное значение — 2147483647

ret - количество обмениваемых единиц товара

  • Натуральное число
  • Значение по-умолчанию - 0
  • Минимальное значение - 0
  • Максимальное значение — 2147483647

Показать заказы

GET /v2/orders

Параметры URL

page — номер страницы результатов запроса

  • Натуральное число
  • Опциональный параметр
  • Значение по-умолчанию — 1

status — фильтр по полю статус у заказов

  • Натуральное число
  • Опциональный параметр
  • Значение по-умолчанию — 0
  • Допустимые значения:
    • 0 — Новый (только что создан пользователем)
    • 1 — Получен
    • 2 — Готовится к отгрузке
    • 3 — Отгружен
    • 4 — Отменён

Пример запроса

curl --request GET \
  --url https://api.snarta.com/v2/orders \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'
curl --request GET \
  --url 'https://api.snarta.com/v2/orders?page=3&status=1' \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'

Успешный ответ

{
  "orders": [
    {
      "id": 22276,
      "created_at": "2021-02-28T12:35:38.699Z",
      "contact_id": "004f2962-931f-4da4-b148-fc115426a290",
      "cust_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
      "status": 1,
      "discount": 0,
      "shipment_date": "",
      "shipment_trip": 0,
      "shipment_address_id": "fde49b33-88b2-42fc-858a-614e8e294802",
      "lines": [
        {
          "id": 269989,
          "qty": 6,
          "item_id": "620e888a-fa0f-4081-ae68-562a6cd6d940"
        },
        {
          "id": 269988,
          "qty": 1,
          "item_id": "f870cee1-8d4c-4a96-bea9-4aefd573064b"
        }
      ]
    }
  ]
}

Показать заказ

GET /v2/orders/[id]

Параметры URL

id — номер страницы результатов запроса

  • Натуральное число
  • Обязательно к заполнению

Пример запроса

curl --request GET \
  --url https://api.snarta.com/v2/orders/22276 \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'

Успешный ответ

{
  "order": {
    "id": 22276,
    "created_at": "2021-02-28T12:35:38.699Z",
    "contact_id": "004f2962-931f-4da4-b148-fc115426a290",
    "cust_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
    "status": 1,
    "discount": 0,
    "shipment_date": "",
    "shipment_trip": 0,
    "shipment_address_id": "fde49b33-88b2-42fc-858a-614e8e294802",
    "lines": [
      {
        "id": 269989,
        "qty": 6,
        "item_id": "620e888a-fa0f-4081-ae68-562a6cd6d940"
      },
      {
        "id": 269988,
        "qty": 1,
        "item_id": "f870cee1-8d4c-4a96-bea9-4aefd573064b"
      }
    ]
  }
}

Ответ с ошибкой

{}

Изменить заказ

PUT /v2/orders/[id]

Параметры URL

id — номер обновляемого заказа

  • Натуральное число
  • Обязательно к заполнению

Параметры запроса

code — идентификатор заказа в 1с

  • Строка до 64 символов
  • Обязательно к заполнению

status — статус заказа

  • Натуральное число
  • Обязательно к заполнению
  • Допустимые значения:
    • 1 — Получен
    • 2 — Готовится к отгрузке
    • 3 — Отгружен
    • 4 — Отменён

Пример запроса

curl --request PUT \
  --url https://api.snarta.com/v2/orders/22276 \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "41136cdc-9352-4bb5-9f03-4d8d27d3ffb5",
    "status": 1
}'

Успешный ответ

{
  "order": {
    "id": 22276,
    "created_at": "2021-02-28T12:35:38.699Z",
    "contact_id": "004f2962-931f-4da4-b148-fc115426a290",
    "cust_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
    "status": 1,
    "discount": 0,
    "shipment_date": "",
    "shipment_trip": 0,
    "shipment_address_id": "fde49b33-88b2-42fc-858a-614e8e294802",
    "lines": [
      {
        "id": 269989,
        "qty": 6,
        "item_id": "620e888a-fa0f-4081-ae68-562a6cd6d940"
      },
      {
        "id": 269988,
        "qty": 1,
        "item_id": "f870cee1-8d4c-4a96-bea9-4aefd573064b"
      }
    ]
  }
}

Ответ с ошибкой

{}