Phpmd enum

Đơn đặt hàng mở rộng AbstractApiResourceGrouptrong góiCrm bán lẻapiNhóm tài nguyên

Đơn hàng. php. 48

Đơn đặt hàng lớp học

thẻ
thể loại

đơn đặt hàng

Ngăn chặnCảnh báo

(PHPMD. Độ dài lớp quá mức)

Ngăn chặnCảnh báo

(PHPMD. Khớp nối giữa các đối tượng)

Mục lục

cancelBonusOperations() . OrderGetResponse Thực hiện yêu cầu POST "/api/v5/orders/loyalty/cancel-bonus-operations". kết hợp() . OrderCombineResponse Thực hiện yêu cầu POST "/api/v5/orders/combine". tạo() . OrderCreateResponse Thực hiện yêu cầu POST "/api/v5/orders/create". hủy giao hàng() . SuccessResponse Thực hiện yêu cầu POST "/api/v5/orders/{externalId}/delivery/cancel". chỉnh sửa() . OrderCreateResponse Thực hiện yêu cầu POST "/api/v5/orders/{externalId}/edit". fixExternalIds() . SuccessResponse Thực hiện yêu cầu POST "/api/v5/orders/fix-external-ids". lấy()  . OrdersGetResponse Makes GET "/api/v5/orders" request. history()  . OrdersHistoryResponse Thực hiện yêu cầu NHẬN "/api/v5/orders/history". linksCreate() . SuccessResponse Thực hiện yêu cầu POST "/api/v5/orders/links/create". danh sách()  . OrderResponse Makes GET "/api/v5/orders" request. loyaltyApply()  . OrdersLoyaltyApplyResponse Makes POST "/api/v5/orders/loyalty/apply" request. paymentsCreate()  . IdResponse Makes POST "/api/v5/orders/payments/create" request. paymentsDelete()  . SuccessResponse Makes POST "/api/v5/orders/payments/{id}/delete" request. paymentsEdit()  . IdResponse Makes POST "/api/v5/orders/payments/{id}/edit" request. platesPrint()  . FilesDownloadResponse Makes GET "/api/v5/orders/{externalId}/plates/{plateId}/print" request. statuses()  . OrdersStatusesResponse Makes GET "/api/v5/orders/statuses" request. upload()  . OrdersUploadResponseThực hiện yêu cầu POST "/api/v5/orders/upload"

phương pháp

hủy bỏBonusOperations()

Đơn hàng. php. 603

Thực hiện yêu cầu POST "/api/v5/orders/loyalty/cancel-bonus-operations"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
4

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
Thông số
$request . Mức độ trung thành của đơn hàng Hủy Tiền thưởngYêu cầu hoạt động
thẻ
throwAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientExceptionthrowsApiExceptionInterfacethrowsClientExceptionInterface
Giá trị trả về
OrdersGetResponse

phối hợp()

Đơn hàng. php. 160

Thực hiện yêu cầu POST "/api/v5/orders/combine"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
5

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
Thông số
$request . OrdersCombineRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
OrdersCombineResponse

tạo ra()

Đơn hàng. php. 296

Thực hiện yêu cầu POST "/api/v5/orders/create"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
6

Ví dụ

use RetailCrm\Api\Enum\CountryCodeIso3166;
use RetailCrm\Api\Enum\Customers\CustomerType;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Delivery\OrderDeliveryAddress;
use RetailCrm\Api\Model\Entity\Orders\Delivery\SerializedOrderDelivery;
use RetailCrm\Api\Model\Entity\Orders\Items\Offer;
use RetailCrm\Api\Model\Entity\Orders\Items\OrderProduct;
use RetailCrm\Api\Model\Entity\Orders\Items\PriceType;
use RetailCrm\Api\Model\Entity\Orders\Items\Unit;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Entity\Orders\Payment;
use RetailCrm\Api\Model\Entity\Orders\SerializedRelationCustomer;
use RetailCrm\Api\Model\Request\Orders\OrdersCreateRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request         = new OrdersCreateRequest();
$order           = new Order();
$payment         = new Payment();
$delivery        = new SerializedOrderDelivery();
$deliveryAddress = new OrderDeliveryAddress();
$offer           = new Offer();
$item            = new OrderProduct();

$payment->type   = 'bank-card';
$payment->status = 'paid';
$payment->amount = 1000;
$payment->paidAt = new DateTime();

$deliveryAddress->index      = '344001';
$deliveryAddress->countryIso = CountryCodeIso3166::RUSSIAN_FEDERATION;
$deliveryAddress->region     = 'Ростовская область';
$deliveryAddress->city       = 'г. Ростов-на-Дону';
$deliveryAddress->street     = 'ул. Пушкинская';
$deliveryAddress->building   = '10';

$delivery->address = $deliveryAddress;
$delivery->cost    = 0;
$delivery->netCost = 0;

$offer->name        = 'Сборка №1445123';
$offer->displayName = 'Сборка №1445123';
$offer->xmlId       = 'tGunLo27jlPGmbA8BrHxY2';
$offer->article     = '14451445-14451445';
$offer->unit        = new Unit('796', 'Штука', 'шт');

$item->offer         = $offer;
$item->priceType     = new PriceType('base');
$item->quantity      = 1;
$item->purchasePrice = 60;

$order->delivery      = $delivery;
$order->items         = [$item];
$order->payments      = [$payment];
$order->orderType     = 'test';
$order->orderMethod   = 'phone';
$order->countryIso    = CountryCodeIso3166::RUSSIAN_FEDERATION;
$order->firstName     = 'Test';
$order->lastName      = 'User';
$order->patronymic    = 'Patronymic';
$order->phone         = '89003005069';
$order->email         = '[email protected]';
$order->managerId     = 28;
$order->customer      = SerializedRelationCustomer::withIdAndType(
    4924,
    CustomerType::CUSTOMER
);
$order->status        = 'assembling';
$order->statusComment = 'Assembling order';
$order->weight        = 1000;
$order->shipmentStore = 'main12';
$order->shipmentDate  = (new DateTime())->add(new DateInterval('P7D'));
$order->shipped       = false;
$order->customFields  = [
    "galka" => false,
    "test_number" => 0,
    "otpravit_dozakaz" => false,
];

$request->order = $order;
$request->site  = 'moysklad';

try {
    $response = $client->orders->create($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

printf(
    'Created order id = %d with following data: %s',
    $response->id,
    print_r($response->order, true)
);
Thông số
$request . OrdersCreateRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
OrdersCreateResponse

giao hàngCancel()

Đơn hàng. php. 1155

Thực hiện yêu cầu POST "/api/v5/orders/{externalId}/delivery/cancel"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
7

Ví dụ

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
Thông số
$identifier . int. chuỗi$request . Đặt hàngDeliveryHủyYêu cầu
thẻ
throwApiExceptionthrowClientExceptionthrowHandlerExceptionthrowsApiExceptionInterface
Giá trị trả về
Phản hồi thành công

chỉnh sửa()

Đơn hàng. php. 1099

Thực hiện yêu cầu POST "/api/v5/orders/{externalId}/edit"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
8

Ví dụ

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
Thông số
$identifier . int. chuỗi$request . Yêu cầu chỉnh sửa đơn đặt hàng
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
OrdersCreateResponse

fixExternalIds()

Đơn hàng. php. 356

Thực hiện yêu cầu POST "/api/v5/orders/fix-external-ids"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
9

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
1
Thông số
$request . OrdersFixExternalIdsRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
Phản hồi thành công

được()

Đơn hàng. php. 1033

Thực hiện yêu cầu GET "/api/v5/orders"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
0

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
3
Thông số
$identifier . int. chuỗi$request . BySiteRequest. không
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
OrdersGetResponse

Môn lịch sử()

Đơn hàng. php. 418

Thực hiện yêu cầu GET "/api/v5/orders/history"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
1

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
5
Thông số
$request . Lịch sử đơn hàngYêu cầu. null = null
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
Lịch sử đơn hàngPhản hồi

liên kếtTạo ()

Đơn hàng. php. 482

Thực hiện yêu cầu POST "/api/v5/orders/links/create"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
2

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
7
Thông số
$request . OrdersLinksCreateRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
Phản hồi thành công

danh sách()

Đơn hàng. php. 98

Thực hiện yêu cầu GET "/api/v5/orders"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
3

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
9
Thông số
$request . Yêu cầu đơn hàng. null = null
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
Đơn hàng phản hồi

áp dụng lòng trung thành ()

Đơn hàng. php. 543

Thực hiện yêu cầu POST "/api/v5/orders/loyalty/apply"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
4

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
0
Thông số
$request . Yêu cầu về mức độ trung thành của đơn đặt hàng
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
Đơn hàng LoyaltyApplyResponse

thanh toánCreate()

Đơn hàng. php. 668

Thực hiện yêu cầu POST "/api/v5/orders/payments/create"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
5

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
1
Thông số
$request . Đơn hàngThanh toánTạoYêu cầu
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
IdResponse

thanh toánXóa()

Đơn hàng. php. 718

Thực hiện yêu cầu POST "/api/v5/orders/payments/{id}/delete"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
6

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
2
Thông số
$id . int
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
Phản hồi thành công

thanh toánSửa()

Đơn hàng. php. 783

Thực hiện yêu cầu POST "/api/v5/orders/payments/{id}/edit"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
7

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
3
Thông số
$identifier . int. chuỗi$request . Đơn hàngThanh toánTạoYêu cầu
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
IdResponse

tấmPrint()

Đơn hàng. php. 1212

Thực hiện yêu cầu GET "/api/v5/orders/{externalId}/plates/{plateId}/print"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
8

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
4
Thông số
$identifier . chuỗi. int$plateId . int$request . BySiteRequest
thẻ
throwApiExceptionthrowClientExceptionthrowHandlerExceptionthrowsApiExceptionInterface
Giá trị trả về
Phản hồi tải xuống tệp

trạng thái()

Đơn hàng. php. 841

Thực hiện yêu cầu GET "/api/v5/orders/status"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
9

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
5
Thông số
$request . OrdersStatusesRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
OrdersStatusesResponse

tải lên()

Đơn hàng. php. 973

Thực hiện yêu cầu POST "/api/v5/orders/upload"

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
10

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
6
Thông số
$request . OrdersUploadRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowsApiErrorExceptionthrowsMissingCredentialsExceptionthrowsMissingParameterExceptionthrowsValidationExceptionthrowsHandlerExceptionthrowsHttpClientException
Giá trị trả về
OrdersUploadResponse

hủy bỏBonusOperations()

Đơn hàng. php. 603

Thực hiện yêu cầu POST "/api/v5/orders/loyalty/cancel-bonus-operations"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
4

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
Thông số
$request . Đặt hàng Mức độ trung thành Hủy bỏTiền thưởngHoạt độngYêu cầu
thẻ
throwAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionthrowHttpClientExceptionthrowApiExceptionInterfacenémClientExceptionGiao diện
Giá trị trả về
OrdersGetResponse

phối hợp()

Đơn hàng. php. 160

Thực hiện yêu cầu POST "/api/v5/orders/combine"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
5

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
Thông số
$request . Đơn đặt hàngKết hợpYêu cầu
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
OrdersCombineResponse

tạo ra()

Đơn hàng. php. 296

Thực hiện yêu cầu POST "/api/v5/orders/create"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
6

Ví dụ

use RetailCrm\Api\Enum\CountryCodeIso3166;
use RetailCrm\Api\Enum\Customers\CustomerType;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Delivery\OrderDeliveryAddress;
use RetailCrm\Api\Model\Entity\Orders\Delivery\SerializedOrderDelivery;
use RetailCrm\Api\Model\Entity\Orders\Items\Offer;
use RetailCrm\Api\Model\Entity\Orders\Items\OrderProduct;
use RetailCrm\Api\Model\Entity\Orders\Items\PriceType;
use RetailCrm\Api\Model\Entity\Orders\Items\Unit;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Entity\Orders\Payment;
use RetailCrm\Api\Model\Entity\Orders\SerializedRelationCustomer;
use RetailCrm\Api\Model\Request\Orders\OrdersCreateRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request         = new OrdersCreateRequest();
$order           = new Order();
$payment         = new Payment();
$delivery        = new SerializedOrderDelivery();
$deliveryAddress = new OrderDeliveryAddress();
$offer           = new Offer();
$item            = new OrderProduct();

$payment->type   = 'bank-card';
$payment->status = 'paid';
$payment->amount = 1000;
$payment->paidAt = new DateTime();

$deliveryAddress->index      = '344001';
$deliveryAddress->countryIso = CountryCodeIso3166::RUSSIAN_FEDERATION;
$deliveryAddress->region     = 'Ростовская область';
$deliveryAddress->city       = 'г. Ростов-на-Дону';
$deliveryAddress->street     = 'ул. Пушкинская';
$deliveryAddress->building   = '10';

$delivery->address = $deliveryAddress;
$delivery->cost    = 0;
$delivery->netCost = 0;

$offer->name        = 'Сборка №1445123';
$offer->displayName = 'Сборка №1445123';
$offer->xmlId       = 'tGunLo27jlPGmbA8BrHxY2';
$offer->article     = '14451445-14451445';
$offer->unit        = new Unit('796', 'Штука', 'шт');

$item->offer         = $offer;
$item->priceType     = new PriceType('base');
$item->quantity      = 1;
$item->purchasePrice = 60;

$order->delivery      = $delivery;
$order->items         = [$item];
$order->payments      = [$payment];
$order->orderType     = 'test';
$order->orderMethod   = 'phone';
$order->countryIso    = CountryCodeIso3166::RUSSIAN_FEDERATION;
$order->firstName     = 'Test';
$order->lastName      = 'User';
$order->patronymic    = 'Patronymic';
$order->phone         = '89003005069';
$order->email         = '[email protected]';
$order->managerId     = 28;
$order->customer      = SerializedRelationCustomer::withIdAndType(
    4924,
    CustomerType::CUSTOMER
);
$order->status        = 'assembling';
$order->statusComment = 'Assembling order';
$order->weight        = 1000;
$order->shipmentStore = 'main12';
$order->shipmentDate  = (new DateTime())->add(new DateInterval('P7D'));
$order->shipped       = false;
$order->customFields  = [
    "galka" => false,
    "test_number" => 0,
    "otpravit_dozakaz" => false,
];

$request->order = $order;
$request->site  = 'moysklad';

try {
    $response = $client->orders->create($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

printf(
    'Created order id = %d with following data: %s',
    $response->id,
    print_r($response->order, true)
);
Thông số
$request . Đơn đặt hàngTạoYêu cầu
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
OrdersCreateResponse

giao hàngCancel()

Đơn hàng. php. 1155

Thực hiện yêu cầu POST "/api/v5/orders/{externalId}/delivery/cancel"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
7

Ví dụ

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
Thông số
$identifier . int. string$request . OrderDeliveryCancelRequest
thẻ
throwApiExceptionthrowsClientExceptionthrowsHandlerExceptionthrowsApiExceptionInterface
Giá trị trả về
Phản hồi thành công

chỉnh sửa()

Đơn hàng. php. 1099

Thực hiện yêu cầu POST "/api/v5/orders/{externalId}/edit"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
8

Ví dụ

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
Thông số
$identifier . int. string$request . OrdersEditRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
OrdersCreateResponse

fixExternalIds()

Đơn hàng. php. 356

Thực hiện yêu cầu POST "/api/v5/orders/fix-external-ids"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Request\Orders\OrderDeliveryCancelRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request        = new OrderDeliveryCancelRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->force = true;

try {
    $response = $client->orders->deliveryCancel('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Order delivery cancel result: ' . print_r($response->success, true);
9

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
1
Thông số
$request . OrdersFixExternalIdsRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
Phản hồi thành công

được()

Đơn hàng. php. 1033

Thực hiện yêu cầu GET "/api/v5/orders"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
0

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
3
Thông số
$identifier . int. string$request . BySiteRequest. null
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
OrdersGetResponse

Môn lịch sử()

Đơn hàng. php. 418

Thực hiện yêu cầu GET "/api/v5/orders/history"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
1

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
5
Thông số
$request . OrdersHistoryRequest. null = null
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
Lịch sử đơn hàngPhản hồi

liên kếtTạo ()

Đơn hàng. php. 482

Thực hiện yêu cầu POST "/api/v5/orders/links/create"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
2

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
7
Thông số
$request . OrdersLinksCreateRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
Phản hồi thành công

danh sách()

Đơn hàng. php. 98

Thực hiện yêu cầu GET "/api/v5/orders"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
3

Ví dụ

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
9
Thông số
$request . OrdersRequest. null = null
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
Đơn hàng phản hồi

áp dụng lòng trung thành ()

Đơn hàng. php. 543

Thực hiện yêu cầu POST "/api/v5/orders/loyalty/apply"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
4

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
0
Thông số
$request . OrdersLoyaltyApplyRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
Đơn hàng LoyaltyApplyResponse

thanh toánCreate()

Đơn hàng. php. 668

Thực hiện yêu cầu POST "/api/v5/orders/payments/create"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
5

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
1
Thông số
$request . OrdersPaymentsCreateRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
IdResponse

thanh toánXóa()

Đơn hàng. php. 718

Thực hiện yêu cầu POST "/api/v5/orders/payments/{id}/delete"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
6

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
2
Thông số
$id . int
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
Phản hồi thành công

thanh toánSửa()

Đơn hàng. php. 783

Thực hiện yêu cầu POST "/api/v5/orders/payments/{id}/edit"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
7

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
3
Thông số
$identifier . int. chuỗi$request . OrdersPaymentsCreateRequest
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
IdResponse

tấmPrint()

Đơn hàng. php. 1212

Thực hiện yêu cầu GET "/api/v5/orders/{externalId}/plates/{plateId}/print"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
8

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
4
Thông số
$identifier . chuỗi. int$plateId . int$request . Theo trang webYêu cầu
thẻ
throwApiExceptionthrowsClientExceptionthrowsHandlerExceptionthrowsApiExceptionInterface
Giá trị trả về
Phản hồi tải xuống tệp

trạng thái()

Đơn hàng. php. 841

Thực hiện yêu cầu GET "/api/v5/orders/status"

use RetailCrm\Api\Enum\ByIdentifier;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\Order;
use RetailCrm\Api\Model\Request\Orders\OrdersEditRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$order                 = new Order();
$order->managerComment = 'Manager comment';

$request        = new OrdersEditRequest();
$request->by    = ByIdentifier::EXTERNAL_ID;
$request->site  = 'aliexpress';
$request->order = $order;

try {
    $response = $client->orders->edit('8123522898559160', $request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Edited order: ' . print_r($response->order, true);
9

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
5
Thông số
$request . Đơn đặt hàngTrạng tháiYêu cầu
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
OrdersStatusesResponse

tải lên()

Đơn hàng. php. 973

Thực hiện yêu cầu POST "/api/v5/orders/upload"

use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Delivery\SerializedEntityOrder;
use RetailCrm\Api\Model\Request\Orders\OrderLoyaltyCancelBonusOperationsRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
$request = new OrderLoyaltyCancelBonusOperationsRequest(
    SerializedEntityOrder::withId(7751),
    'bitrix-test'
);

try {
    $response = $client->orders->cancelBonusOperations($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Current loyalty account balance: ' . $response->order->loyaltyAccount->amount . ' bonuses.';
10

Ví dụ

use RetailCrm\Api\Enum\CombineTechnique;
use RetailCrm\Api\Factory\SimpleClientFactory;
use RetailCrm\Api\Interfaces\ApiExceptionInterface;
use RetailCrm\Api\Model\Entity\Orders\SerializedOrderReference;
use RetailCrm\Api\Model\Request\Orders\OrdersCombineRequest;

$client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');

$request              = new OrdersCombineRequest();
$request->order       = new SerializedOrderReference(7143);
$request->resultOrder = new SerializedOrderReference(7140);
$request->technique   = CombineTechnique::SUMM;

try {
    $response = $client->orders->combine($request);
} catch (ApiExceptionInterface $exception) {
    echo sprintf(
        'Error from RetailCRM API (status code: %d): %s',
        $exception->getStatusCode(),
        $exception->getMessage()
    );

    if (count($exception->getErrorResponse()->errors) > 0) {
        echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors);
    }

    return;
}

echo 'Combine errors: ' . print_r($response->errors, true);
6
Thông số
$request . Đơn đặt hàngTải lênYêu cầu
thẻ
throwApiExceptionInterfacethrowClientExceptionInterfacethrowAccountDoesNotExistExceptionthrowApiErrorExceptionthrowMissingCredentialsExceptionthrowMissingParameterExceptionthrowValidationExceptionthrowHandlerExceptionnémHttpClientException
Giá trị trả về
OrdersUploadResponse

PHPMD là gì?

PHPMD là một dự án phụ của PHP Depend và nhằm mục đích trở thành một PHP tương đương với công cụ Java nổi tiếng PMD . PHPMD có thể được coi là một ứng dụng lối vào thân thiện với người dùng cho luồng số liệu thô được đo bằng PHP Depend. https. //phpmd. tổ chức.

Trình phát hiện lộn xộn PHP là gì?

Sửa đổi lần cuối. 05 Tháng mười hai 2022. Ngoài hỗ trợ mã hóa tích hợp, PhpStorm cung cấp khả năng kiểm tra mã nguồn thông qua tích hợp với công cụ PHP Mess Detector, giúp phát hiện các vấn đề tiềm ẩn liên quan đến kích thước mã, tính không nhất quán, mã không được sử dụng, vi phạm đặt tên . .

Làm cách nào để cài đặt PHPMD?

PHPMD - Trình phát hiện lộn xộn PHP .
Tải xuống
Cài đặt dưới dạng Phar. Bạn luôn có thể tìm nạp phiên bản ổn định mới nhất dưới dạng kho lưu trữ phar thông qua liên kết bất khả tri của phiên bản sau. . ~ $ quên -c https. //phpmd. org/tĩnh/mới nhất/phpmd. phar
Cài đặt qua Composer. .
Từ kho lưu trữ github