README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/christian71-stack/miraklfront.git"
    }
  ],
  "require": {
    "christian71-stack/miraklfront": "^1.0"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new cbdesk\mirakl\Api\InvoicingAndAccountingApi(
    // 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()
);
$document_request_id = array('document_request_id_example'); // string[] | The document request unique identifier. This parameter can be supplied multiple times.
$document_id = array('document_id_example'); // string[] | Document identifiers. This parameter can be supplied multiple times.
$document_format = array('document_format_example'); // string[] | Document formats. This parameter can be supplied multiple times.
$entity_id = array('entity_id_example'); // string[] | Entity identifiers related to the documents to download. This parameter can be supplied multiple times.<br>The <code>entity_type</code> must be specified to use this filter, otherwise an error 400 will be returned.<br>Example: entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER
$entity_type = array('entity_type_example'); // string[] | Entity types related to the documents to download. This parameter can be supplied multiple times.

try {
    $result = $apiInstance->dR73($document_request_id, $document_id, $document_format, $entity_id, $entity_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoicingAndAccountingApi->dR73: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://your-instance.mirakl.net

Class	Method	HTTP request	Description
InvoicingAndAccountingApi	dR73	GET /api/document-request/documents/download	Download accounting documents
InvoicingAndAccountingApi	iV01	GET /api/invoices	List accounting documents
MessagesApi	m10	GET /api/inbox/threads/{thread_id}	Retrieve a thread
MessagesApi	m11	GET /api/inbox/threads	List all threads
MessagesApi	m13	GET /api/inbox/threads/{attachment_id}/download	Download an attachment
MultipleShipmentsApi	sT01	POST /api/shipments	Create shipments
MultipleShipmentsApi	sT06	PUT /api/shipments/delete	Delete shipments
MultipleShipmentsApi	sT11	GET /api/shipments	List shipments
MultipleShipmentsApi	sT12	GET /api/shipments/items_to_ship	List items to ship
MultipleShipmentsApi	sT23	POST /api/shipments/tracking	Update carrier tracking information for shipments
MultipleShipmentsApi	sT24	PUT /api/shipments/ship	Validate shipments as shipped
MultipleShipmentsApi	sT26	PUT /api/shipments/ready_for_pick_up	Validate shipments as ready to pick up
OffersApi	oF22	GET /api/offers/{offer}	Get information about an offer
OffersApi	oF51	GET /api/offers/export	Get offers CSV file
OffersApi	oF52	POST /api/offers/export/async	Export offers CSV or JSON file asynchronously
OffersApi	oF53	GET /api/offers/export/async/status/{tracking_id}	Poll the status of an asynchronous offer export (OF52)
OffersApi	p11	GET /api/products/offers	List offers for each given product
OrdersApi	oR04	PUT /api/orders	Patch update orders
OrdersApi	oR07	PUT /api/orders/shipping_from	Update order line shipping origin
OrdersApi	oR11	GET /api/orders	List orders with pagination
OrdersApi	oR13	POST /api/orders/async-export	Export orders asynchronously
OrdersApi	oR14	GET /api/orders/async-export/status/{tracking_id}	Get the status of an asynchronous order export.
OrdersApi	oR21	PUT /api/orders/{order_id}/accept	Accept or refuse order lines
OrdersApi	oR23	PUT /api/orders/{order_id}/tracking	Update carrier tracking information for a specific order
OrdersApi	oR24	PUT /api/orders/{order_id}/ship	Validate the shipment of an order
OrdersApi	oR29	PUT /api/orders/{order_id}/cancel	Perform a full cancelation of an order
OrdersApi	oR30	PUT /api/orders/cancel	Perform cancelations on order lines
OrdersApi	oR31	PUT /api/orders/{order_id}/additional_fields	Update the custom fields of an order and its order lines
OrdersApi	oR51	GET /api/orders/{order_id}/evaluation	Get the evaluation of an order
OrdersApi	oR72	GET /api/orders/documents	Lists order's documents
OrdersApi	oR73	GET /api/orders/documents/download	Download one or multiple documents attached to one or multiple orders
OrdersApi	oR75	GET /api/orders/taxes	List all the order taxes available on the platform
OrdersApi	oR76	DELETE /api/orders/documents/{document_id}	Delete an order document
PicklistsApi	pL11	GET /api/picklists	List picklists
PlatformSettingsApi	aF01	GET /api/additional_fields	List all custom fields
PlatformSettingsApi	cH11	GET /api/channels	List all enabled channels
PlatformSettingsApi	cUR01	GET /api/currencies	List currency codes and labels
PlatformSettingsApi	dO01	GET /api/documents	List all document types
PlatformSettingsApi	l01	GET /api/locales	List locale codes and labels
PlatformSettingsApi	oF61	GET /api/offers/states	List offer conditions
PlatformSettingsApi	pC01	GET /api/platform/configuration	List platform configurations
PlatformSettingsApi	rE01	GET /api/reasons	List reasons
PlatformSettingsApi	sH11	GET /api/shipping/zones	List all active shipping zones
PlatformSettingsApi	sH12	GET /api/shipping/types	List all active shipping methods
PlatformSettingsApi	sH21	GET /api/shipping/carriers	List all carriers
PlatformSettingsApi	sH31	GET /api/shipping/logistic_classes	List all logistic classes
ProductsApi	h11	GET /api/hierarchies	List Catalog categories (parents and children) related to a Catalog category
ProductsApi	p31	GET /api/products	Get products for a list of product references
ProductsApi	p42	GET /api/products/imports/{import}	Get the import status for a product import
ProductsApi	p44	GET /api/products/imports/{import}/error_report	Get the error report file for a product import ("Non-integrated products report")
ProductsApi	p45	GET /api/products/imports/{import}/new_product_report	Get the product integration report file for a product import ("Added products report")
ProductsApi	p46	GET /api/products/imports/{import}/transformed_file	Get the transformed file for a product import ("File in operator format")
ProductsApi	p47	GET /api/products/imports/{import}/transformation_error_report	Get the transformation error report file for a product import ("Source file error report")
ProductsApi	p51	GET /api/products/imports	Get information about product import statuses
ProductsApi	pM11	GET /api/products/attributes	Get the product attribute configuration
ProductsApi	vL11	GET /api/values_lists	Get information about operator's value lists
PromotionsApi	pR01	GET /api/promotions	List promotions
ReturnsApi	rT11	GET /api/returns	List returns
ReturnsApi	rT25	PUT /api/returns/receive	Validate returns as received
ReturnsApi	rT29	PUT /api/returns/cancel	Mark a return as canceled
StoresApi	s30	GET /api/shops/documents	List shop's documents
StoresApi	s31	GET /api/shops/documents/download	Download documents for one or multiple shops
StoresApi	s33	DELETE /api/shops/documents/{document_id}	Delete a shop document
UsersApi	rO02	GET /api/users/shops/roles	List shop roles

Models

Authorization

Authentication schemes defined for the API:

front_api_key

Type: API key
API key parameter name: Authorization
Location: HTTP header

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: latest-release
- Package version: 1.0.0
- Generator version: 7.17.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

christian71-stack / miraklfront

Maintainers

Details