Получение списка позиций операции возврата покупателя
Операция: /cp/ts/customerComplaints/getPositions
Метод: GET
Возвращает список позиций операции возврата покупателя
Параметры запроса
Параметры авторизации описаны в общем справочнике.
| Параметр | Описание |
|---|---|
opId | ID операции |
ids | IDs позиций возврата через запятую. |
opIds | IDs операций через запятую. |
orderPickingGoodId | ID позиции отгрузки по выдаче клиенту. |
orderPickingNumber | Номер операции отгрузки. |
orderPickingGoodIds | IDs позиций отгрузки через запятую. |
executionDateStart | начальная дата диапазона поиска завершения позиции (RFC3339) |
executionDateEnd | конечная дата диапазона поиска завершения позиции (RFC3339) |
pickingIds | IDs операции отгрузки. |
coPositionIds | IDs позиций заказа через запятую. |
oldCoPositionIds | IDs позиции заказа через запятую. |
agreementId | ID договора с клиентом. |
clientId | ID клиента. |
oldItemId | ID старой партии. |
productIds | IDs карточек товаров через запятую. |
itemId | Числовой ID партии. |
shopLegalPersonIds | IDs юридических лиц магазина через запятую. |
tagIds | IDs тегов через запятую. |
auto | Автоопределяемый параметр для поиска по позиции. |
statuses | Статусы позиций через запятую (значения статусов). |
locId | ID места хранения. |
status | Статус позиции (значения статуса). |
type | Тип возврата (значения типа). |
dateStart | Минимальная дата создания операции в формате по времени создания (RFC3339) |
dateEnd | Максимальная дата создания операции в формате по времени создания (RFC3339) |
updateDateStart | Начальная дата диапазона поиска по времени обновления (RFC3339). |
updateDateEnd | Конечная дата диапазона поиска по времени обновления (RFC3339). |
skip | Количество операций в ответе, которое нужно пропустить. |
limit | Максимальное количество позиций, которое должно быть возвращено в ответе. |
sort | Как сортировать позиции: status — по статусу, createDate — по дате создания операции. |
output | Расширенный формат: e — загрузить данные о партиях, местах хранения, товарах и отгрузке; o — сведения о возврате; t — теги. |
fields | Дополнительные поля через запятую: item, oldItem, location, product, orderPickingInfo, operationInfo, tags, supplierReturnPos, supplierAgreement, coInfo. |
Пример запроса
- cURL
- JavaScript
- Go
- PHP
curl --get 'https://demo.public.api.abcp.ru/cp/ts/customerComplaints/getPositions' \
--data-urlencode 'userlogin=YOUR_LOGIN' \
--data-urlencode 'userpsw=YOUR_PASSWORD_MD5' \
--data-urlencode 'opId=100' \
--data-urlencode 'output=et' \
--data-urlencode 'limit=30'
const params = new URLSearchParams();
params.append('userlogin', 'YOUR_LOGIN');
params.append('userpsw', 'YOUR_PASSWORD_MD5');
params.append('opId', '100');
params.append('output', 'et');
params.append('limit', '30');
const response = await fetch(`https://demo.public.api.abcp.ru/cp/ts/customerComplaints/getPositions?${params}`);
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"io"
"log"
"net/http"
"net/url"
)
func main() {
values := url.Values{}
values.Add("userlogin", "YOUR_LOGIN")
values.Add("userpsw", "YOUR_PASSWORD_MD5")
values.Add("opId", "100")
values.Add("output", "et")
values.Add("limit", "30")
response, err := http.Get("https://demo.public.api.abcp.ru/cp/ts/customerComplaints/getPositions?" + values.Encode())
if err != nil {
log.Fatal(err)
}
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil {
log.Fatal(err)
}
fmt.Println(string(body))
}
<?php
$params = [
'userlogin' => 'YOUR_LOGIN',
'userpsw' => 'YOUR_PASSWORD_MD5',
] + [
'opId' => '100',
'output' => 'et',
'limit' => '30',
];
$url = 'https://demo.public.api.abcp.ru/cp/ts/customerComplaints/getPositions?' . http_build_query($params);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response;
?>
Метод возвращает список позиций операции возврата покупателя:
| Параметр | Описание |
|---|---|
id | Идентификатор позиции |
opId | Идентификатор операции |
status | Статус позиции (значения статуса) |
type | Тип возврата (значения типа) |
orderPickingGoodId | ID позиции отгрузки |
oldItemId | ID партии, отгруженной по операции отгрузки |
itemId | ID партии, созданной операцией возврат (назначается при переводе позиции в статус "в работе") |
locId | ID места хранения принятого товара |
quantity | Количество |
attrs | Структура объекта описана в справочнике attrs |
pickingDate | Дата и время выдачи товара обратно клиенту |
executionDate | Дата завершения позиции |
comment | Комментарий |
product | Карточка товара |
orderPickingGood | Объект позиции отгрузки |
orderPicking | Объект операции отгрузки |
availableQuantity | Количество товара, доступное к возврату по позиции отгрузки |
operationInfo | Дополнительные данные операции возврата. |
tags | Список тегов, назначенных позиции |
externalId | Параметр для связи с внешними сервисами |