mzubkov/goods-api-php-library

Goods.ru: Partner API PHP Library

dev-master 2019-01-14 04:20 UTC

This package is not auto-updated.

Last update: 2024-09-29 06:06:03 UTC


README

https://packagist.org/packages/mzubkov/goods-api-php-library

Инициализация

Для работы необходим конфигурационный .ini файл.

Инициализация заказа на основе данных, полученных магазином от Goods.ru с помощью POST order/new:

$goodsMarket = new GoodsMarket($token);
$json = file_get_contents("php://input"); //получение данных о новом заказе от Goods.ru
$goodsOrder = $goodsMarket->newOrder($json);

newOrder($json) - возвращает объект класса GoodsOrder

$json - данные запроса, полученного от Goods.ru

Инициализация заказа по номеру:

$goodsOrder = new GoodsOrder($token, $merchantId, $shipmentId, $orderCode);

$token - токен

$merchantId - идентификатор продавца

$shipmentId - номер заказа

$orderCode - номер заказа продавца (необязательный аргумент)

Подтверждение заказа

Перевод указанных лотов в статус "Подтверждено".

    $itemsConfirm = [106449, 70992, 106449, 47940];
    $resultConfirm = $goodsOrder->orderConfirm($itemsConfirm);

Возвращает массив вида:

    ["success" => 1, "result" => "OK"]

$itemsConfirm - массив с офферами для подтверждения в любом порядке (offerId). Не переданные в массиве лоты будут отменены (отправлен order/reject)

Комплектация заказа

Перевод указанных лотов в статус "Скомплектовано".

    $goodsOrder->setOrderCode("abc123"); //установка номера заказа (если не был задан на этапе инициализации)
    $itemsPacking = [array(106449, 47940), array(106449)];
    $resultPacking = $goodsOrder->orderPacking($itemsPacking);

Возвращает массив вида:

    ["success" => 1, "result" => "OK"]

$itemsPacking - массив массивов с офферами для комплектации (распределения по грузовым местам) в любом порядке (offerId). Не переданные в массиве лоты будут отменены (отправлен order/reject)

Получение статуса заказа

    $result = goodsOrder->getOrderStatus();

Возвращает массив вида:

    ["success" => 1, "result" => $orderStatus]

где $orderStatus - статус заказа (NEW, CONFIRMED, PACKED, CANCELED, Заказ в обработке)

Получение информации по заказу

    $result = goodsOrder->getOrderInfo();

Возвращает массив вида:

    ["success" => 1, "result" => $orderInfo]

где $orderInfo - массив с подробной информацией по заказу

Получение этикетки

    $label = $goodsOrder->getLabel();

Отдает этикетки по всем лотам в формате HTML. В случае, если заказ не был ранее скомплектован, возвращается шаблон этикетки без штрих-кода

Возвращает массив вида:

    ["success" => 1, "result" => "label_in_html_format"]

Дополнительные методы

    $goodsOrder->setOrderCode($orderCode); //Установка номера заказа
    $orderCode = $goodsOrder->getOrderCode(); //Получение номера заказа
    $shipmentId = $goodsOrder->getShipmentId(); //Получение номера отправления