Download the PHP package friends-of-ce/merchant-api-client-php without Composer

On this page you can find all versions of the php package friends-of-ce/merchant-api-client-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of friends-of-ce/merchant-api-client-php

Informations about the package merchant-api-client-php

OpenAPIClient-php

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:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Getting Started

Please follow the installation procedure and then run the following:

API Endpoints

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

Class Method HTTP request Description
CancellationsApi cancellationCreate POST /v2/cancellations Creates a cancelation
CancellationsApi cancellationGetForMerchant GET /v2/cancellations/merchant Gets cancelations
CancellationsApi cancellationMarkExportAsFailed POST /v2/cancellations/mark-export-as-failed
ChannelsApi channelPluginsGet GET /v2/channels Gets channels
CompetitionPricesApi competitionPricesGetBuyBoxPrices GET /v2/competitionprices/buyboxprices Gets the price from the buy box winner
CustomFieldsApi customFieldsDeleteCustomFields DELETE /v2/custom-fields Delete custom fields by a given list of custom field ids (product extra data ids)
CustomFieldsApi customFieldsGetCustomFields GET /v2/custom-fields Gets custom fields
FulfillmentStockApi fulfillmentStockGetFulfillmentStockWithStockLocations GET /v2/fulfillmentstock Gets product stock across all warehouses with stock locations - Channel Fulfillment location
ListedProductsApi listedProductGetByFilter GET /v2/channels/{channelId}/products Gets products listed by channel
NotificationsApi notificationIndex GET /v2/notifications Gets notifications
OffersApi offerDeleteProductLevelStockLimits DELETE /v2/offer/{channelId}/product-level-stock-limitations Remove product-level stock limitations for a specific channel.
OffersApi offerGetProductLevelStockLimits GET /v2/offer/{channelId}/product-level-stock-limitations Get product-level stock limitations for a specific channel.
OffersApi offerGetStock GET /v2/offer/stock Gets product stock across all warehouses
OffersApi offerPostProductLevelStockLimits POST /v2/offer/{channelId}/product-level-stock-limitations Sets product-level stock limitations for a specific channel.
OffersApi offerStockPriceUpdate PUT /v2/offer Updates stock and price
OffersApi offerStockUpdate PUT /v2/offer/stock Updates stock
OrderDocumentsApi orderDocumentsAcknowledgeDocument POST /v2/orders/documents/acknowledge Acknowledge a document.
OrderDocumentsApi orderDocumentsGetDocumentFileForOrder GET /v2/orders/documents/file Get document file for order.
OrderDocumentsApi orderDocumentsGetDocumentsByFilter GET /v2/orders/documents Get documents by filters
OrdersApi orderAcknowledge POST /v2/orders/acknowledge Acknowledges orders
OrdersApi orderGetByFilter GET /v2/orders Gets orders by filter
OrdersApi orderGetNew GET /v2/orders/new Gets new orders
OrdersApi orderInvoice GET /v2/orders/{merchantOrderNo}/invoice Generates an order invoice
OrdersApi orderMarkExportAsFailed POST /v2/orders/mark-export-as-failed
OrdersApi orderPackingSlip GET /v2/orders/{merchantOrderNo}/packingslip Generates a packing slip
OrdersApi orderUpdate PUT /v2/orders/comment Updates an order comment
OrdersApi orderUploadInvoice POST /v2/orders/{merchantOrderNo}/invoice Uploads an order invoice
OrdersApi orderUploadInvoiceAsString POST /v2/orders/{merchantOrderNo}/invoice-base64 Uploads an order invoice PDF from Base64 string.
ProductAttributesApi productAttributeGroupAddProductExtraData PUT /v2/product-attribute-group/{groupName}/add Adds custom attributes to a group
ProductAttributesApi productAttributeGroupCreate POST /v2/product-attribute-group Creates a custom attribute group
ProductAttributesApi productAttributeGroupDelete DELETE /v2/product-attribute-group/{groupName} Deletes a custom attribute group
ProductAttributesApi productAttributeGroupGetByFilter GET /v2/product-attribute-group Gets custom attribute groups
ProductAttributesApi productAttributeGroupGetWithChannelsByFilter GET /v2/product-attribute-group/linked-channels Gets custom attribute groups and linked marketplaces
ProductAttributesApi productAttributeGroupRemoveProductExtraData PUT /v2/product-attribute-group/{groupName}/remove Deletes custom attributes from a group
ProductAttributesApi productAttributeGroupRenameProductAttributeGroup POST /v2/product-attribute-group/rename Renames custom attribute groups
ProductBundlesApi productBundleCreate POST /v2/productbundles Create product bundles
ProductBundlesApi productBundleGetByFilter GET /v2/productbundles Gets product bundles
ProductBundlesApi productBundleUpdate PUT /v2/productbundles Update product bundles
ProductsApi productBulkDelete POST /v2/products/bulkdelete Deletes products
ProductsApi productBulkPatch PATCH /v2/products Updates products attributes
ProductsApi productBulkPatchExtraDataItems PATCH /v2/products/extra-data/bulk Adds, updates, or deletes custom attributes
ProductsApi productCreate POST /v2/products Updates or creates products
ProductsApi productDelete DELETE /v2/products/{merchantProductNo} Deletes a product
ProductsApi productFreeze POST /v2/products/freeze Updates selected products and sets them either to frozen or not-frozen status.
ProductsApi productGetByFilter GET /v2/products Gets products
ProductsApi productGetByMerchantProductNo GET /v2/products/{merchantProductNo} Gets a product
ProductsApi productPatch PATCH /v2/products/{merchantProductNo} Updates product attributes
ProductsApi productPatchExtraDataItems PATCH /v2/products/extra-data Adds, updates, or deletes a custom attribute
ProductsApi productV21Create POST /v2.1/products [CLOSED BETA - AUTHORIZED USERS ONLY] Create or update a product
ProductsApi productV21Delete DELETE /v2.1/products [CLOSED BETA - AUTHORIZED USERS ONLY] Delete a product
ProductsApi productV21Patch PATCH /v2.1/products [CLOSED BETA - AUTHORIZED USERS ONLY] Update part of a product
PurchaseOrdersApi acknowledge POST /v2/purchase-orders/lines/acknowledge Acknowledges lines of a purchase order
PurchaseOrdersApi create POST /v2/purchase-orders/shipments Create a purchase order shipment.
PurchaseOrdersApi getByFilter GET /v2/purchase-orders/shipments/merchant Gets purchase order shipments by filter
PurchaseOrdersApi getByFilter_0 GET /v2/purchase-orders Gets purchase orders by filter
PurchaseOrdersApi purchaseOrdersCreateInvoice POST /v2/purchase-orders/invoice Creates a purchase order invoice
PurchaseOrdersApi purchaseOrdersCreateInvoices POST /v2/purchase-orders/invoice/bulk Creates a purchase order invoices in a bulk
PurchaseOrdersApi update PUT /v2/purchase-orders/shipments Update a purchase order shipment.
RefundsApi refundAcknowledge POST /v2.1/refunds/merchant/acknowledge [CLOSED BETA - AUTHORIZED USERS ONLY] Acknowledge a refund
RefundsApi refundCreate POST /v2.1/refunds/merchant [CLOSED BETA - AUTHORIZED USERS ONLY] Create a refund
RefundsApi refundGet GET /v2.1/refunds/merchant/{identifier} [CLOSED BETA - AUTHORIZED USERS ONLY] Get refund by identifier
RefundsApi refundGetByFilter GET /v2.1/refunds/merchant [CLOSED BETA - AUTHORIZED USERS ONLY] Get refunds by filter
RefundsApi refundUpsertReturnExtraData PATCH /v2.1/refunds/merchant/extra-data [CLOSED BETA - AUTHORIZED USERS ONLY] Upsert extra data for a refund
ReportsApi reportCreateSettlementsReport POST /v2/reports/settlements Creates a settlement report
ReportsApi reportGetAvailableReports GET /v2/reports/available Gets a report
ReportsApi reportGetReport GET /v2/reports/{reportId} Gets a report
ReportsApi reportGetStatus GET /v2/reports/{reportId}/status Gets the status of a report
ReturnsApi returnAcknowledge POST /v2.1/returns/merchant/acknowledge [CLOSED BETA - AUTHORIZED USERS ONLY] Acknowledge a return
ReturnsApi returnAcknowledge_0 POST /v2/returns/merchant/acknowledge Acknowledges a return
ReturnsApi returnBulkHandle POST /v2.1/returns/merchant/bulk-handle [CLOSED BETA - AUTHORIZED USERS ONLY] Handles returns in bulk
ReturnsApi returnCreate POST /v2.1/returns/merchant [CLOSED BETA - AUTHORIZED USERS ONLY] Create a return
ReturnsApi returnDeclareForMerchant POST /v2/returns/merchant Creates merchant return
ReturnsApi returnGet GET /v2.1/returns/merchant/{identifier} [CLOSED BETA - AUTHORIZED USERS ONLY] Get return by identifier
ReturnsApi returnGetByFilter GET /v2.1/returns/merchant [CLOSED BETA - AUTHORIZED USERS ONLY] Get returns by filter
ReturnsApi returnGetByMerchantOrderNo GET /v2/returns/merchant/{merchantOrderNo} Gets a return
ReturnsApi returnGetDeclaredByChannel GET /v2/returns/merchant Gets marketplace returns
ReturnsApi returnGetReturns GET /v2/returns Gets returns by filter
ReturnsApi returnGetUnhandled GET /v2/returns/merchant/new Gets unhandled returns
ReturnsApi returnHandle POST /v2.1/returns/merchant/handle [CLOSED BETA - AUTHORIZED USERS ONLY] Handle a return
ReturnsApi returnMarkExportAsFailed POST /v2/returns/mark-export-as-failed
ReturnsApi returnUpdateForMerchant PUT /v2/returns Marks returns as received
ReturnsApi returnUpsertReturnExtraData PATCH /v2.1/returns/merchant/extra-data [CLOSED BETA - AUTHORIZED USERS ONLY] Upsert extra data for a return
SettingsApi settingsGet GET /v2/settings Gets settings
SettlementsApi settlementGetByFilter GET /v2/settlements Gets settlements
SettlementsApi settlementUploadSettlement POST /v2/settlements/upload Uploads a settlement file to ChannelEngine.
ShipmentsApi shipmentAirWaybillNo GET /v2/orders/{merchantShipmentNo}/airwaybillno Get the Air Waybill No for a shipment
ShipmentsApi shipmentCreate POST /v2/shipments Creates shipments
ShipmentsApi shipmentCreateForChannelMethod POST /v2/shipments/channelmethod Creates a shipment and initiates shipping label generation
ShipmentsApi shipmentGetShipmentLabelCarriers POST /v2/carriers/{merchantOrderNo} Gets carriers providing shipping labels
ShipmentsApi shipmentIndex GET /v2/shipments/merchant Gets shipments by filter
ShipmentsApi shipmentMarkImportAsFailed POST /v2/shipments/mark-import-as-failed
ShipmentsApi shipmentShippingLabel GET /v2/orders/{merchantShipmentNo}/shippinglabel Gets a shipping label
ShipmentsApi shipmentUpdate PUT /v2/shipments/{merchantShipmentNo} Updates a shipment
ShipmentsApi shipmentUploadProofOfDelivery POST /v2/shipments/{merchantShipmentNo}/proof-of-delivery Uploads a proof of delivery document
ShipmentsApi shipmentUpsertDeliveryState PUT /v2/shipments/{merchantShipmentNo}/delivery-state
StockLocationsApi stockLocationCreate POST /v2/stocklocations Creates a stock location
StockLocationsApi stockLocationIndex GET /v2/stocklocations Gets stock locations
SupportApi supportCreateTestOrderDocuments POST /v2/testorderdocument
SupportApi supportCreateTestOrders POST /v2/supportorder
SupportApi supportCreateTestShippingLabels POST /v2/testshippinglabel
TargetsApi targetsCreateTargets POST /v2/targets Creates multiple targets
TargetsApi targetsDeleteTargets DELETE /v2/targets Deletes multiple targets
TargetsApi targetsEditTargets PUT /v2/targets Edits multiple targets
WebhooksApi webhooksCreate POST /v2/webhooks Creates a webhook or update a deleted webhook and undelete it
WebhooksApi webhooksDelete DELETE /v2/webhooks/{webhookName} Deletes a webhook
WebhooksApi webhooksGetAll GET /v2/webhooks Gets webhooks
WebhooksApi webhooksUpdate PUT /v2/webhooks Updates a webhook

Models

Authorization

Authentication schemes defined for the API:

apiKey

Tests

To run the tests, use:

Author

About this package

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

All versions of merchant-api-client-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package friends-of-ce/merchant-api-client-php contains the following files

Loading the files please wait ...