friends-of-ce / merchant-api-client-php
ChannelEngine API for merchants
Installs: 4 418
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
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/merchant-api-client-php.git" } ], "require": { "friends-of-ce/merchant-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\Merchant\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = FriendsOfCE\Merchant\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer'); $apiInstance = new FriendsOfCE\Merchant\ApiClient\Api\CancellationsApi( // 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\Merchant\ApiClient\Model\MerchantCancellationRequest(); // \FriendsOfCE\Merchant\ApiClient\Model\MerchantCancellationRequest try { $result = $apiInstance->cancellationCreate($merchantCancellationRequest); print_r($result); } catch (Exception $e) { echo 'Exception when calling CancellationsApi->cancellationCreate: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://demo.channelengine.net/api
Models
- AddProductExtraDataRequests
- AdvanceSettingsResponse
- ApiResponse
- BulkMerchantCreatePurchaseOrderInvoicesRequest
- ChangePurchaseOrderShipmentLine
- ChannelCarrierCollectionMethodApi
- ChannelCarrierRecommendationApi
- ChannelChannelResponse
- ChannelExportStatus
- ChannelGlobalChannelResponse
- ChannelListedProductResponse
- CollectionOfChannelGlobalChannelResponse
- CollectionOfChannelListedProductResponse
- CollectionOfIPurchaseOrderByFilter
- CollectionOfIPurchaseOrderShipmentByFilter
- CollectionOfMerchantCancellationResponse
- CollectionOfMerchantFulfillmentStockStockLocationsResponse
- CollectionOfMerchantNotificationResponse
- CollectionOfMerchantOfferGetStockResponse
- CollectionOfMerchantOrderResponse
- CollectionOfMerchantProductAttributeGroupWithLinkedChannelsResponse
- CollectionOfMerchantProductAttributeGroupWithProductExtraDataResponse
- CollectionOfMerchantProductBundleResponse
- CollectionOfMerchantProductResponse
- CollectionOfMerchantProductWithBuyBoxPrice
- CollectionOfMerchantReturnResponse
- CollectionOfMerchantSettlementReportsResponse
- CollectionOfMerchantShipmentLabelCarrierResponse
- CollectionOfMerchantShipmentResponse
- CollectionOfMerchantSingleOrderReturnResponse
- CollectionOfMerchantStockLocationWithCountryIsoResponse
- CollectionOfMerchantWebhookResponse
- Condition
- CreatePurchaseOrderShipment
- CreatedByType
- CreatorFilter
- CreatorType
- ExtraDataType
- FreezeProductRequest
- FreezingActionRequest
- FulfillmentType
- Gender
- IImportInformation
- IPurchaseOrderByFilter
- IPurchaseOrderLineByFilter
- IPurchaseOrderShipmentByFilter
- IPurchaseOrderShipmentLineByFilter
- IRefund
- IRefundCurrency
- IRefundLine
- IReturn
- IReturnLine
- IReturnLineHandlingResult
- IVendorParty
- ListedProductChannelStatus
- ListedProductExportStatus
- MancoReason
- MerchantAcknowledgePurchaseOrder
- MerchantAcknowledgePurchaseOrderLine
- MerchantAcknowledgeRefund
- MerchantAcknowledgeReturn
- MerchantAddressResponse
- MerchantCancellationLineRequest
- MerchantCancellationLineResponse
- MerchantCancellationRequest
- MerchantCancellationResponse
- MerchantChannelLabelShipmentRequest
- MerchantCreateRefund
- MerchantCreateRefundLine
- MerchantCreateReportResponse
- MerchantCreateReturn
- MerchantCreateReturnLine
- MerchantCreateSettlementsReportRequest
- MerchantFulfillmentStockLocationItemResponse
- MerchantFulfillmentStockStockLocationsResponse
- MerchantGetReportStatusResponse
- MerchantHandleReturn
- MerchantInvoiceUploadRequest
- MerchantNotificationResponse
- MerchantOfferGetStockResponse
- MerchantOfferStockUpdateRequest
- MerchantOrderAcknowledgementRequest
- MerchantOrderCommentUpdateRequest
- MerchantOrderLineExtraDataResponse
- MerchantOrderLineResponse
- MerchantOrderResponse
- MerchantProductAttributeGroupChannelInfoResponse
- MerchantProductAttributeGroupWithLinkedChannelsResponse
- MerchantProductAttributeGroupWithProductExtraDataResponse
- MerchantProductBundlePartResponse
- MerchantProductBundleResponse
- MerchantProductExtraDataItemRequest
- MerchantProductExtraDataItemResponse
- MerchantProductExtraDataRequest
- MerchantProductExtraDataResponse
- MerchantProductRequest
- MerchantProductResponse
- MerchantProductWithBuyBoxPrice
- MerchantPurchaseOrderInvoice
- MerchantPurchaseOrderInvoiceLine
- MerchantReturnAcknowledgeRequest
- MerchantReturnLineRequest
- MerchantReturnLineResponse
- MerchantReturnLineUpdateRequest
- MerchantReturnRequest
- MerchantReturnResponse
- MerchantReturnUpdateRequest
- MerchantSettingsResponse
- MerchantSettlementReportsResponse
- MerchantShipmentLabelCarrierRequest
- MerchantShipmentLabelCarrierResponse
- MerchantShipmentLineRequest
- MerchantShipmentLineResponse
- MerchantShipmentPackageDimensionsRequest
- MerchantShipmentPackageWeightRequest
- MerchantShipmentRequest
- MerchantShipmentResponse
- MerchantShipmentTrackingRequest
- MerchantSingleOrderReturnLineResponse
- MerchantSingleOrderReturnResponse
- MerchantStockLocationAddressRequest
- MerchantStockLocationCreateRequest
- MerchantStockLocationResponse
- MerchantStockLocationUpdateRequest
- MerchantStockLocationWithCountryIsoResponse
- MerchantStockPriceUpdateRequest
- MerchantVendorParty
- MerchantWebhookRequest
- MerchantWebhookResponse
- ModuleFulfillmentType
- ModuleReturnReason
- ModuleReturnStatus
- ModulesAdditionalDetailsType
- ModulesAllowanceDetailsType
- ModulesChargeDetailsType
- ModulesPurchaseOrderInvoiceType
- ModulesPurchaseOrderStatus
- ModulesPurchaseOrderType
- ModulesTaxRegistrationType
- ModulesTaxType
- NotificationType
- Operation
- OrderIdentifier
- OrderLineIdentifier
- OrderStatusView
- OrderSupport
- PackageDimensionsUnit
- PackageWeightUnit
- PatchMerchantProductDto
- ProductAttributeGroupRequest
- ProductCreationResult
- ProductExtraDataRequest
- ProductMessage
- PurchaseOrderAcknowledgementCode
- PurchaseOrderIdentifierType
- PurchaseOrderInvoiceAdditionalDetails
- PurchaseOrderInvoiceAllowanceDetails
- PurchaseOrderInvoiceChargeDetails
- PurchaseOrderInvoiceTaxDetails
- PurchaseOrderLineIdentifierType
- PurchaseOrderLineUnitOfMeasure
- PurchaseOrderRejectionReason
- PurchaseOrderRelatedItemExportStatus
- PurchaseOrderShipmentIdentifierTypeValue
- RefundByFilterIdentifier
- RefundIdentifier
- RefundReason
- RemoveProductExtraDataRequests
- RenameProductAttributeGroupRequests
- ReportStatus
- ReportType
- ReturnByFilterIdentifier
- ReturnHandlingAction
- ReturnIdentifier
- ReturnLineIdentifier
- ReturnReason
- ReturnStatus
- SettingsResponse
- ShipmentFulfillmentType
- ShipmentLineStatus
- ShipmentSettingsResponse
- ShipmentType
- SingleMerchantAcknowledgePurchaseOrderLinesRequest
- SingleMerchantAcknowledgeRefundRequest
- SingleMerchantAcknowledgeReturnRequest
- SingleMerchantCreatePurchaseOrderInvoiceRequest
- SingleMerchantCreatePurchaseOrderShipmentRequest
- SingleMerchantCreateRefundRequest
- SingleMerchantCreateReturnRequest
- SingleMerchantHandleReturnRequest
- SingleMerchantUpdatePurchaseOrderShipmentRequest
- SingleOfApiResponse
- SingleOfDictionaryOfStringAndListOfString
- SingleOfIRefund
- SingleOfIReturn
- SingleOfMerchantProductResponse
- SingleOfMerchantSettingsResponse
- SingleOfProductCreationResult
- UpdatePurchaseOrderShipment
- VatRateType
- VatSettingsResponse
- VolumeUnitOfMeasure
- WebhookEventType
- WeightUnitOfMeasure
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.15.0
- Package version:
2.15.0.1
- Generator version:
7.7.0
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen