Адреса доставки

Свойства адреса

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

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

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

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

address - адрес доставка

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

status - статус адреса

• Натуральное число
• Обязательно к заполнению
• Допустимые значения:
  • 0 - Активный
  • 1 - Заблокирован

returns_amount_limit - максимально допустимая сумма возврата товаров в копейках

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

deadline - крайнее время приёма заказа

• Строка 5 символов
• Опциональный параметр
• Минимальное значение - 00:00
• Максимальное значение - 23:59

Показать адреса клиента

GET /v2/customers/[customer_id]/addresses

Параметры URL

customer_id — идентификатор клиента

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

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

curl --request GET \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b/addresses \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'

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

{
  "addresses": [
    {
      "customer_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
      "address_id": "a8b0bbae-e439-4f0a-82c1-1f10a048fea1",
      "address": "г. Сочи, пер. Летний, 5",
      "status": 0,
      "limit": 0,
      "deadline": null
    },
    {
      "customer_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
      "address_id": "fde49b33-88b2-42fc-858a-614e8e294802",
      "address": "г. Геленджик, 76",
      "status": 0,
      "limit": 100,
      "deadline": "18:45"
    }
  ]
}

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

{}

Показать адрес клиента

GET /v2/customers/[customer_id]/addresses/[address_id]

Параметры URL

customer_id — идентификатор клиента

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

address_id — идентификатор адреса

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

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

curl --request GET \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b/addresses/fde49b33-88b2-42fc-858a-614e8e294802 \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'

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

{
  "address": {
    "customer_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
    "address_id": "fde49b33-88b2-42fc-858a-614e8e294802",
    "address": "г. Геленджик, 76",
    "status": 0,
    "limit": 100,
    "deadline": "18:45"
  }
}

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

{}

Создать адрес

POST /v2/customers/[customer_id]/addresses

Параметры URL

customer_id — идентификатор клиента

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

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

curl --request POST \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b/addresses \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb' \
  --header 'Content-Type: application/json' \
  --data '{
    "address_id": "fde49b33-88b2-42fc-858a-614e8e294802",
    "address": "г. Геленджик, 76",
    "status": 0,
    "limit": 100,
    "deadline": "18:45"
}'

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

{
  "address": {
    "customer_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
    "address_id": "fde49b33-88b2-42fc-858a-614e8e294802",
    "address": "г. Геленджик, 76",
    "status": 0,
    "limit": 100,
    "deadline": "18:45"
  }
}

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

{
  "address_id": "The id field is required."
}

{}

{
  "id": "Duplicate value."
}

Изменить адрес

PUT /v2/customers/[customer_id]/addresses/[address_id]

Параметры URL

customer_id — идентификатор клиента

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

address_id — идентификатор адреса

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

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

curl --request PUT \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b/addresses/fde49b33-88b2-42fc-858a-614e8e294802 \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb' \
  --header 'Content-Type: application/json' \
  --data '{
  "address": "г. Геленджик, 76",
  "status": 0,
  "limit": 200,
  "deadline": "20:00"
}'

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

{
  "address": {
    "customer_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
    "address_id": "fde49b33-88b2-42fc-858a-614e8e294802",
    "address": "г. Геленджик, 76",
    "status": 0,
    "limit": 200,
    "deadline": "20:00"
  }
}

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

{
  "address_id": "The id field is required."
}

{}