README

ChannelEngine API for merchants

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/friends-of-ce/channel-api-client-php.git"
    }
  ],
  "require": {
    "friends-of-ce/channel-api-client-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: apiKey
$config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new FriendsOfCE\Channel\ApiClient\Api\CancellationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$merchantCancellationRequest = new \FriendsOfCE\Channel\ApiClient\Model\MerchantCancellationRequest(); // \FriendsOfCE\Channel\ApiClient\Model\MerchantCancellationRequest

try {
    $result = $apiInstance->cancellationCreate($merchantCancellationRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CancellationApi->cancellationCreate: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://demo.channelengine.net/api

Class	Method	HTTP request	Description
CancellationApi	cancellationCreate	POST /v2/cancellations	Create Cancellation.
CancellationApi	cancellationGetForMerchant	GET /v2/cancellations/merchant	Get Cancellations.
ChannelsApi	channelPluginsGet	GET /v2/channels	Get Channels.
CompetitionPriceApi	competitionPricesGetBuyBoxPrices	GET /v2/competitionprices/buyboxprices	Get the BuyBox winner prices
ListedProductsApi	listedProductGetByFilter	GET /v2/channels/{channelId}/products	Get Listed Products
NotificationApi	notificationIndex	GET /v2/notifications	Get Notifications.
OfferApi	offerGetStock	GET /v2/offer/stock	Get stock for products.
OfferApi	offerStockPriceUpdate	PUT /v2/offer	Update stock and/or price.
OfferApi	offerStockUpdate	PUT /v2/offer/stock	Update only stock.
OrderApi	orderAcknowledge	POST /v2/orders/acknowledge	Acknowledge Order.
OrderApi	orderGetByFilter	GET /v2/orders	Get Orders By Filter.
OrderApi	orderGetNew	GET /v2/orders/new	Get New Orders.
OrderApi	orderInvoice	GET /v2/orders/{merchantOrderNo}/invoice	Download Invoice.
OrderApi	orderPackingSlip	GET /v2/orders/{merchantOrderNo}/packingslip	Download Packing Slip.
OrderApi	orderUpdate	PUT /v2/orders/comment	Update Comment.
OrderApi	orderUploadInvoice	POST /v2/orders/{merchantOrderNo}/invoice	Upload Invoice.
ProductApi	productBulkDelete	POST /v2/products/bulkdelete	Delete multiple Products.
ProductApi	productBulkPatch	PATCH /v2/products	Bulk Patch Products
ProductApi	productBulkPatchExtraDataItems	PATCH /v2/products/extra-data/bulk	Add/Update/Delete product extra data items.
ProductApi	productCreate	POST /v2/products	Upsert Products.
ProductApi	productDelete	DELETE /v2/products/{merchantProductNo}	Delete Product.
ProductApi	productGetByFilter	GET /v2/products	Get Products.
ProductApi	productGetByMerchantProductNo	GET /v2/products/{merchantProductNo}	Get Product.
ProductApi	productPatch	PATCH /v2/products/{merchantProductNo}	Patch product
ProductApi	productPatchExtraDataItems	PATCH /v2/products/extra-data	Add/Update/Delete a product's extra data items
ProductAttributeGroupApi	productAttributeGroupAddProductExtraData	PUT /v2/product-attribute-group/{groupName}/add	Adds multiple product extra data to product attribute group.
ProductAttributeGroupApi	productAttributeGroupCreate	POST /v2/product-attribute-group	Create product attribute groups.
ProductAttributeGroupApi	productAttributeGroupDelete	DELETE /v2/product-attribute-group/{groupName}	Delete product attribute group.
ProductAttributeGroupApi	productAttributeGroupGetByFilter	GET /v2/product-attribute-group	Get product attribute groups with the keys of all linked custom fields.
ProductAttributeGroupApi	productAttributeGroupGetWithChannelsByFilter	GET /v2/product-attribute-group/linked-channels	Get product attribute groups with linked channels.
ProductAttributeGroupApi	productAttributeGroupRemoveProductExtraData	PUT /v2/product-attribute-group/{groupName}/remove	Removes multiple product extra data from product attribute group.
ProductAttributeGroupApi	productAttributeGroupRenameProductAttributeGroup	POST /v2/product-attribute-group/rename	Renames multiple product attribute groups.
ProductBundleApi	productBundleGetByFilter	GET /v2/productbundles	Get product bundles.
ReportApi	reportCreateSettlementsReport	POST /v2/reports/settlements	Create settlements report
ReportApi	reportGetReport	GET /v2/reports/{reportId}	Get report
ReportApi	reportGetStatus	GET /v2/reports/{reportId}/status	Check report status
ReturnApi	returnAcknowledge	POST /v2/returns/merchant/acknowledge	Acknowledge Return.
ReturnApi	returnDeclareForMerchant	POST /v2/returns/merchant	Create Return.
ReturnApi	returnGetByMerchantOrderNo	GET /v2/returns/merchant/{merchantOrderNo}	Get Return.
ReturnApi	returnGetDeclaredByChannel	GET /v2/returns/merchant	Get Returns.
ReturnApi	returnGetReturns	GET /v2/returns	Get Returns.
ReturnApi	returnGetUnhandled	GET /v2/returns/merchant/new	Get Unhandled Returns.
ReturnApi	returnUpdateForMerchant	PUT /v2/returns	Mark a return as received.
SettingsApi	settingsGet	GET /v2/settings	Get settings.
SettlementApi	settlementGetByFilter	GET /v2/settlements	Get settelmets
ShipmentApi	shipmentCreate	POST /v2/shipments	Create Shipment.
ShipmentApi	shipmentCreateForChannelMethod	POST /v2/shipments/channelmethod	Create shipment for channel provided shipping labels
ShipmentApi	shipmentGetShipmentLabelCarriers	POST /v2/carriers/{merchantOrderNo}	Get carriers for channel provided shipping labels
ShipmentApi	shipmentIndex	GET /v2/shipments/merchant	Get Shipments
ShipmentApi	shipmentShippingLabel	GET /v2/orders/{merchantShipmentNo}/shippinglabel	Download shipping label.
ShipmentApi	shipmentUpdate	PUT /v2/shipments/{merchantShipmentNo}	Update Shipment.
StockLocationApi	stockLocationCreate	POST /v2/stocklocations
StockLocationApi	stockLocationIndex	GET /v2/stocklocations	Get the stock locations (or virtual warehouses).
WebhookApi	webhooksCreate	POST /v2/webhooks	Create Webhook.
WebhookApi	webhooksDelete	DELETE /v2/webhooks/{webhookName}	Delete Webhook.
WebhookApi	webhooksGetAll	GET /v2/webhooks	Get Webhooks.
WebhookApi	webhooksUpdate	PUT /v2/webhooks	Update Webhook.

Models

Authorization

Authentication schemes defined for the API:

apiKey

Type: API key
API key parameter name: apikey
Location: URL query string

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 2.13.0
- Package version: 2.13.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

friends-of-ce / channel-api-client-php

Maintainers

Details