Описание API Тестовый контур
Используйте тестовый контур сервиса, чтобы настроить интеграции и эмулировать действия покупателя.
Чтобы протестировать основные сценарии работы, используйте тестовые методы, указанные в блоках Sandbox документации Wb API.
Для авторизации нужен токен с типом Тестовый контур.
Использование тестового контура не несёт риска непреднамеренного раскрытия информации.
Используйте тестовый контур сервиса, чтобы настроить интеграции и эмулировать действия покупателя.
Чтобы протестировать основные сценарии работы, используйте тестовые методы, указанные в блоках Sandbox документации Wb API.
Для авторизации нужен токен с типом Тестовый контур.
Использование тестового контура не несёт риска непреднамеренного раскрытия информации.
Для доступа к тестовому контуру используйте адрес https://advert-api-sandbox.wildberries.kg.
Кампании будут удалены через 30 дней с момента внесения последних изменений.
Удаленные кампании (статус -1) будут удалены через 3 минуты.
Можно создать максимум 50 кампаний.
Максимальное количество запросов такое же, как и в основном API.
Статистика генерируется только для кампаний типа 8 — автоматическая кампания и 9 — Аукцион.
Для генерации статистики:
- кампания должна быть в статусе
9— идут показы - у кампании типа
8должна быть положительная ставка - у кампании типа
9должна быть положительная ставка в каталоге - бюджет кампании должен быть положительным
Вы можете создать карточки товара в песочнице контента и использовать созданные карточки товаров в песочнице продвижения.
Пополнить тестовый баланс{{ /adv/v1/test/update/balance }} Deprecated
Метод будет отключен 5 ноября.
Authorizations:
Request Body schema: application/json
| balance | integer Сумма пополнения счёта, ₽ |
| net | integer Сумма пополнения баланса, ₽ |
| bonus | integer Сумма пополнения бонусов, ₽ |
Responses
Request samples
- Payload
{- "balance": 1000,
- "net": 1000,
- "bonus": 1000
}Response samples
- 200
- 400
- 401
- 403
- 429
{- "balance": 9100,
- "net": 8000,
- "bonus": 10000
}Для доступа к тестовому контуру используйте адрес https://marketplace-api-sandbox.wildberries.kg.
Вы можете создать карточки товара в песочнице контента и использовать созданные баркоды карточек товаров в песочнице Маркетплейса.
Используются регулярные выражения для:
- ID поставок —
^WB-GI-SAND-[0-9]+$ - ID коробок —
^WB-TRBX-SAND-[0-9]+$
Для сборочных заданий есть два типа статуса:
supplierStatus— статус, который может изменить продавецwbStatus— статус в системе. Его может изменить только WB
В песочнице вы можете эмулировать действия WB, меняя поле wbStatus вручную. Используйте статусы:
| wbStatus | supplierStatus | Описание | Как перевести сборочное задание в данный статус |
|---|---|---|---|
| waiting | new | Новое сборочное задание | Создать тестовое сборочное задание FBS |
| declined_by_client | new | Сборочное задание отменено покупателем. Доступно в течение часа после создания сборочного задания, только в песочнице. | Сообщить, что покупатель отменил заказ |
| waiting | confirm | На сборке | Добавить сборочное задание к поставке |
| canceled | cancel | Сборочное задание отменено продавцом. Доступно на любом этапе до перевода поставки в доставку. | Отменить сборочное задание |
| waiting | complete | В доставке | Передать поставку в доставку |
| sorted | complete | WB принял сборочное задание | Закрыть поставку |
| ready_for_pickup | complete | Заказ поступил на пункт выдачи | Сообщить, что заказ поступил в пункт выдачи |
| sold | complete | Покупатель получил заказ в пункте выдачи | Сообщить, что заказ принят покупателем |
| canceled_by_client | complete | Покупатель отказался от заказа в пункте выдачи | Сообщить, что покупатель отказался от заказа |
| defect | complete | Покупатель отменил заказ из-за брака | Сообщить, что покупатель отменил заказ из-за брака |
Создать тестовые сборочные задания FBS{{ /api/v3/test/fbs/orders/make }}
Метод позволяет создать тестовые сборочные задания для FBS, эмулируя действия покупателя.
Один запрос создает сборочные задания по товарам из одной корзины покупателя. У них единый ID транзакции — orderUid, который передается в ответах методов получения новых и всех сборочных заданий.
Сборочное задание будет создано, если:
- Все баркоды товаров из запроса имеют остатки на FBS складах.
- Остаток на складе больше или равен сумме в запросе.
- Цена товара не равна нулю.
Authorizations:
Request Body schema: application/jsonrequired
required | Array of objects or null [ 1 .. 10 ] items |
Responses
Request samples
- Payload
{- "orders": [
- {
- "amount": 1,
- "sku": "SKUTest123"
}
]
}Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Сообщить, что покупатель отменил заказ{{ /api/v3/test/fbs/orders/{orderId}/decline }}
Метод переводит сборочное задание в "wbStatus":"declined_by_client" — покупатель отменил заказ. Доступно в течение часа после создания сборочного задания.
Метод эмулирует действия WB
Authorizations:
path Parameters
| orderId required | integer <int64> >= 1 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Закрыть поставку{{ /api/v3/test/fbs/supplies/{supplyId}/close }}
Метод закрывает поставку FBS и помечает все сборочные задания как требующие в повторной отгрузки.
Все перечисленные в запросе orderId помечаются, как требующие повторную отгрузку. Неуказанные orderId, относящиеся к данному supplyId переводятся в "wbStatus": "sorted".
Метод эмулирует действия WB
Authorizations:
path Parameters
| supplyId required | string^WB-GI-SAND-[0-9]+$ ID поставки |
Request Body schema: application/json
| orderIds required | Array of integers or null <int64> >= 0 |
Responses
Request samples
- Payload
{- "orderIds": [
- 9007199254740991
]
}Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Сообщить, что заказ поступил в пункт выдачи{{ /api/v3/test/fbs/orders/{orderId}/deliver }}
Метод переводит сборочное задание в "wbStatus":"ready_for_pickup" — заказ поступил в пункт выдачи.
Метод эмулирует действия WB
Authorizations:
path Parameters
| orderId required | integer <int64> >= 1 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Сообщить, что заказ принят покупателем{{ /api/v3/test/fbs/orders/{orderId}/receive }}
Метод переводит сборочное задание в "wbStatus":"sold" — получено покупателем.
Метод эмулирует действия WB
Authorizations:
path Parameters
| orderId required | integer <int64> >= 1 ID сборочного задания |
Request Body schema: application/json
| code required | string Код получения заказа. В тестовом контуре можно использовать любую комбинацию символов |
Responses
Request samples
- Payload
{- "code": "string"
}Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Сообщить, что покупатель отказался от заказа{{ /api/v3/test/fbs/orders/{orderId}/reject }}
Метод переводит сборочное задание в "wbStatus":"canceled_by_client" — отказ при получении.
Метод эмулирует действия WB
Authorizations:
path Parameters
| orderId required | integer <int64> >= 1 ID сборочного задания |
Request Body schema: application/json
| code required | string Код получения заказа. В тестовом контуре можно использовать любую комбинацию символов |
Responses
Request samples
- Payload
{- "code": "string"
}Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Сообщить, что покупатель отменил заказ из-за брака{{ /api/v3/test/fbs/orders/{orderId}/defect }}
Метод переводит сборочное задание в "wbStatus":"defect" — отмена заказа из-за брака.
Метод эмулирует действия WB
Authorizations:
path Parameters
| orderId required | integer <int64> >= 1 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Для доступа к тестовому контуру используйте адрес https://marketplace-api-sandbox.wildberries.kg.
Вы можете создать карточки товара в песочнице контента и использовать созданные баркоды карточек товаров в песочнице Маркетплейса.
Для кода получения заказа в методах подтверждения получения и отказа от получения можно использовать любую комбинацию символов.
Для сборочных заданий есть два типа статуса:
supplierStatus— статус, который может изменить продавецwbStatus— статус в системе. Его может изменить только WB
В песочнице вы можете эмулировать действия WB, меняя поле wbStatus вручную. Используйте статусы:
| wbStatus | supplierStatus | Описание | Как перевести сборочное задание в данный статус |
|---|---|---|---|
| waiting | new | Новое сборочное задание | Создать тестовое сборочное задание DBS |
| declined_by_client | new | Сборочное задание отменено покупателем. Доступно в течение часа после создания сборочного задания, только в песочнице. | Сообщить, что покупатель отменил заказ |
| canceled | cancel | Сборочное задание отменено продавцом. Доступно до перевода сборочного задания на сборку. | Отменить сборочное задание |
| waiting | confirm | На сборке | Перевести сборочное задание на сборку |
| waiting | deliver | В доставке | Перевести сборочное задание в доставку |
| sold | receive | Покупатель получил заказ | Сообщить, что заказ принят покупателем |
| canceled_by_client | reject | Покупатель отказался от заказа | Сообщить, что покупатель отказался от заказа |
Создать тестовые сборочные задания DBS{{ /api/v3/test/dbs/orders/make }}
Метод позволяет создать тестовые сборочные задания для DBS, эмулируя действия покупателя.
Один запрос создает сборочные задания по товарам из одной корзины покупателя. У них единый ID транзакции — orderUid, который передается в ответах методов получения новых и завершённых сборочных заданий.
Сборочное задание будет создано, если:
- Все баркоды товаров из запроса имеют остатки на DBS складах.
- Остаток на складе больше или равен сумме в запросе.
- Цена товара не равна нулю.
Authorizations:
Request Body schema: application/jsonrequired
required | Array of objects [ 1 .. 10 ] items Массив баркодов товаров и количества товаров для сборочного задания |
| deliveryType | string Default: dbs Enum: dbs dbsPickupPoint edbs Тип доставки:
|
object Адрес доставки сборочного задания. |
Responses
Request samples
- Payload
{- "orders": [
- {
- "sku": "SKUTest123",
- "amount": 1
}
], - "deliveryType": "edbs",
- "address": {
- "region": "Челябинская область",
- "locality": "Архангельское",
- "street": "переулок Солнечный",
- "houseNumber": "8А к 1",
- "entrance": "5",
- "intercom": "4857",
- "floor": "4",
- "apartment": "18"
}
}Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Сообщить, что покупатель отменил заказ{{ /api/v3/test/dbs/orders/{orderId}/decline }}
Метод переводит сборочное задание в "wbStatus":"declined_by_client" — покупатель отменил заказ. Доступно в течение часа после создания сборочного задания.
Метод эмулирует действия WB
Authorizations:
path Parameters
| orderId required | integer <int64> >= 1 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Для доступа к тестовому контуру используйте адрес https://marketplace-api-sandbox.wildberries.kg.
Вы можете создать карточки товара в песочнице контента и использовать созданные баркоды карточек товаров в песочнице Маркетплейса.
Используются регулярные выражения для:
- ID поставок —
^WB-GI-SAND-[0-9]+$ - ID коробок —
^WB-TRBX-SAND-[0-9]+$
"11111" в параметре запроса passCode тестового метода проверки, принадлежит ли сборочное задание покупателю
Для сборочных заданий есть два типа статуса:
supplierStatus— статус, который может изменить продавецwbStatus— статус в системе. Его может изменить только WB
В песочнице вы можете эмулировать действия WB, меняя поле wbStatus вручную. Используйте статусы:
| wbStatus | supplierStatus | Описание | Как перевести сборочное задание в данный статус |
|---|---|---|---|
| waiting | new | Новое сборочное задание | Создать тестовое сборочное задание Самовывоз |
| declined_by_client | new | Сборочное задание отменено покупателем. Доступно в течение часа после создания сборочного задания, только в песочнице. | Сообщить, что покупатель отменил заказ |
| waiting | confirm | На сборке | Перевести сборочное задание на сборку |
| canceled | cancel | Сборочное задание отменено продавцом. Доступно до подтверждения выдачи сборочного задания. | Отменить сборочное задание |
| ready_for_pickup | prepare | Заказ готов к выдаче | Сообщить, что заказ готов к выдаче |
| sold | receive | Покупатель получил заказ | Сообщить, что заказ принят покупателем |
| canceled_by_client | reject | Покупатель отказался от заказа | Сообщить, что покупатель отказался от заказа |
Создать тестовые сборочные задания Самовывоз{{ /api/v3/test/click-collect/orders/make }}
Метод позволяет создать тестовые сборочные задания для Самовывоза, эмулируя действия покупателя.
Один запрос создает сборочные задания по товарам из одной корзины покупателя c одинаковым orderCode — ID заказа покупателя, который передаётся в ответе метода получения новых сборочных заданий.
Сборочное задание будет создано, если:
- Все баркоды товаров из запроса имеют остатки на складах.
- Остаток на складе больше или равен сумме в запросе.
- Цена товара не равна нулю.
Authorizations:
Request Body schema: application/jsonrequired
required | Array of objects or null [ 1 .. 10 ] items |
Responses
Request samples
- Payload
{- "orders": [
- {
- "amount": 1,
- "sku": "SKUTest123"
}
]
}Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Сообщить, что покупатель отменил заказ{{ /api/v3/test/click-collect/orders/{orderId}/decline }}
Метод переводит сборочное задание в "wbStatus":"declined_by_client" — покупатель отменил заказ. Доступно в течение часа после создания сборочного задания.
Метод эмулирует действия WB
Authorizations:
path Parameters
| orderId required | integer <int64> >= 1 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Incorrect parameter"
}Для доступа к тестовому контуру используйте адрес https://feedbacks-api-sandbox.wildberries.kg.
В песочнице вы можете создавать тестовые вопросы и отзывы. Созданные вопросы и отзывы хранятся 5 дней
Создать тестовые отзывы{{ /api/v1/test/make/feedbacks/batch }}
Метод создаёт тестовые отзывы для тестовых артикулов WB.
nmID, вы получите успешный ответ, но отзывы не будут созданы.
Authorizations:
Request Body schema: application/json
required | Array of objects <= 1000 items |
Responses
Request samples
- Payload
{- "feedbacks": [
- {
- "nmId": 123456789,
- "texts": [
- "Первый отзыв",
- "Второй отзыв",
- "Третий отзыв"
]
}, - {
- "nmId": 987654321,
- "texts": [ ]
}
]
}Response samples
- 200
- 400
- 401
- 403
- 429
{- "data": [
- {
- "nmId": 123456789,
- "feedbackIds": [
- "THI5C30CUyyHR9a6",
- "GZ1cVhwiVISKBwDW",
- "u4H0tIKOapinkxRN"
]
}, - {
- "nmId": 331645,
- "feedbackIds": [
- "ZAgd9FSSWglIuGrB"
]
}
]
}Удалить тестовые отзывы{{ /api/v1/test/delete/feedbacks }}
Метод удаляет тестовые отзывы.
Authorizations:
Request Body schema: application/jsonrequired
| ids required | Array of strings <= 1000 items Список ID отзывов |
Responses
Request samples
- Payload
{- "ids": [
- "vRyfJrG7LLiNtEQJ",
- "aB3cD4eF5gH6iJ7k"
]
}Response samples
- 200
- 400
- 401
- 403
- 429
{- "results": [
- {
- "id": "vRyfJrG7LLiNtEQJ",
- "success": true
}, - {
- "id": "aB3cD4eF5gH6iJ7k",
- "error": {
- "status": 404,
- "title": "Not Found",
- "detail": "Feedback aB3cD4eF5gH6iJ7k not found"
}
}
]
}Создать тестовые вопросы{{ /api/v1/test/make/questions/batch }}
Метод создаёт тестовые вопросы для тестовых артикулов WB.
nmID, вы получите успешный ответ, но вопросы не будут созданы.
Authorizations:
Request Body schema: application/json
required | Array of objects <= 1000 items |
Responses
Request samples
- Payload
{- "questions": [
- {
- "nmId": 123456789,
- "texts": [
- "Первый вопрос",
- "Второй вопрос",
- "Третий вопрос"
]
}, - {
- "nmId": 987654321,
- "texts": [ ]
}
]
}Response samples
- 200
- 400
- 401
- 403
- 429
{- "data": [
- {
- "nmId": 333885,
- "questionIds": [
- "z1euscflMAbjVnp5",
- "5XS3EkL2keJJdKMO",
- "5UZ69YEGdwODwX8d"
]
}, - {
- "nmId": 331645,
- "questionIds": [
- "VXp6I50x9XT8UQZd"
]
}
]
}Удалить тестовые вопросы{{ /api/v1/test/delete/questions }}
Метод удаляет тестовые вопросы.
Authorizations:
Request Body schema: application/jsonrequired
| ids required | Array of strings <= 1000 items Список ID вопросов |
Responses
Request samples
- Payload
{- "ids": [
- "HZcc1B6yfYERUVcu",
- "aB3cD4eF5gH6iJ7k"
]
}Response samples
- 200
- 400
- 401
- 403
- 429
{- "results": [
- {
- "id": "HZcc1B6yfYERUVcu",
- "success": true
}, - {
- "id": "aB3cD4eF5gH6iJ7k",
- "error": {
- "status": 404,
- "title": "Not Found",
- "detail": "Question aB3cD4eF5gH6iJ7k not found"
}
}
]
}Для доступа к тестовому контуру используйте адрес https://content-api-sandbox.wildberries.kg
Удалить карточки товаров из корзины{{ /content/v1/cards/delete }}
Метод удаляет карточки товаров из корзины без возможности восстановления.
Используйте метод, чтобы освободить место для создания новых карточек, в том числе при приближении или достижении лимита по количеству карточек.
Authorizations:
Request Body schema: application/jsonrequired
| nmIds required | Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ] Список артикулов WB |
Responses
Request samples
- Payload
{- "nmIds": [
- 123456789,
- 987654321
]
}Response samples
- 200
- 400
- 401
- 403
- 429
{- "data": [
- {
- "nmId": 320791,
- "error": {
- "status": 404,
- "title": "Not Found",
- "detail": "nmID 123456789 does not exist"
}
}, - {
- "nmId": 987654321,
- "success": true
}
], - "error": false,
- "errorText": "",
- "additionalErrors": { }
}