README

API pozwala na zarządzanie zamówieniami, produktami i wiadomościami.

  <a href='/svc/shop-api/doc/CHANGELOG.txt'>CHANGELOG</a><br />
  <a href='/svc/shop-api/doc'>Informacje o API</a>

Build

To generate library run make generate. To generate and release new package version run make publish.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

Run composer require opero-crm/erli-api

Laravel Integration

When using in a Laravel application, the package auto-registers the service provider and Erli facade. Set token and host before making API calls:

use OperoCRM\ErliApi\Laravel\Facades\Erli;

// Set credentials on the default instance (fluent)
Erli::setToken($token);
$orders = Erli::order()->getOrders();

// Multiple instances - create separate API clients per account
$shop1 = Erli::create($token1);
$shop2 = Erli::create($token2);
$orders1 = $shop1->order()->getOrders();
$orders2 = $shop2->order()->getOrders();

Or via dependency injection:

use OperoCRM\ErliApi\Laravel\ErliApi;

public function __construct(ErliApi $erliApi)
{
    $this->erliApi = $erliApi;
}

// Configure and use
$this->erliApi->setToken($token)->order()->...

API Endpoints

All URIs are relative to https://erli.pl/svc/shop-api

Class	Method	HTTP request	Description
BillingApi	billingCompanyEntriesPost	POST /billing/company/entries	historia rozliczeń firmy z ERLI (dotyczy wszystkich sklepów)
BillingApi	billingCompanyRebatesPost	POST /billing/company/rebates	rezerwa i historia rabatów firmy (dotyczy wszystkich sklepów)
BillingApi	billingEntriesPost	POST /billing/entries	historia rozliczeń sklepu z ERLI (należy używać /billing/company/entries z filtrem shopId)
CampaignsApi	campaignsCampaignsSummaryGet	GET /campaigns/campaigns-summary	podsumowanie kosztów dla sklepu
CommissionApi	commissionsEstimatePost	POST /commissions/_estimate	estymowana na aktualny dzień prowizja
DictionaryApi	dictionariesAttachmentAttachPatch	PATCH /dictionaries/attachment/attach	dodaj produkty do załącznika
DictionaryApi	dictionariesAttachmentDetachPatch	PATCH /dictionaries/attachment/detach	usuń produkty z załącznika
DictionaryApi	dictionariesAttachmentPatch	PATCH /dictionaries/attachment	aktualizuj załącznik
DictionaryApi	dictionariesAttachmentPost	POST /dictionaries/attachment	utwórz załącznik
DictionaryApi	dictionariesAttachmentsDelete	DELETE /dictionaries/attachments	usuń załączniki
DictionaryApi	dictionariesAttachmentsGet	GET /dictionaries/attachments	pobierz listę załączników
DictionaryApi	dictionariesAttributeValuesSearchPost	POST /dictionaries/attributeValues/_search	pobierz listę wartości atrybutów słownikowych
DictionaryApi	dictionariesAttributesSearchPost	POST /dictionaries/attributes/_search	pobierz listę atrybutów
DictionaryApi	dictionariesBillingEntryTypesGet	GET /dictionaries/billingEntryTypes	typy operacji
DictionaryApi	dictionariesCategoriesSearchPost	POST /dictionaries/categories/_search	pobierz listę kategorii
DictionaryApi	dictionariesCategorySearchPost	POST /dictionaries/category/_search	pobierz listę kategorii
DictionaryApi	dictionariesDeliveryMethodsGet	GET /dictionaries/deliveryMethods	pobierz listę metod dostawy
DictionaryApi	dictionariesDeliveryMethodsPriceListGet	GET /dictionaries/deliveryMethods/{priceList}	pobierz listę metod dostawy dla danego cennika
DictionaryApi	dictionariesDeliveryVendorsGet	GET /dictionaries/deliveryVendors	pobierz listę firm przewozowych
DictionaryApi	dictionariesResponsiblePersonsGet	GET /dictionaries/responsiblePersons	pobierz listę osób odpowiedzialnych za wprowadzenie produktu
DictionaryApi	dictionariesResponsiblePersonsIdDelete	DELETE /dictionaries/responsiblePersons/{id}	usuń osobę odpowiedzialną za wprowadzenie produktu
DictionaryApi	dictionariesResponsiblePersonsIdPatch	PATCH /dictionaries/responsiblePersons/{id}	aktualizuj osobę odpowiedzialną za wprowadzenie produktu
DictionaryApi	dictionariesResponsiblePersonsPost	POST /dictionaries/responsiblePersons	utwórz osobę odpowiedzialną za wprowadzenie produktu
DictionaryApi	dictionariesResponsibleProducersGet	GET /dictionaries/responsibleProducers	pobierz listę producentów produktu
DictionaryApi	dictionariesResponsibleProducersIdDelete	DELETE /dictionaries/responsibleProducers/{id}	usuń producenta produktu
DictionaryApi	dictionariesResponsibleProducersIdPatch	PATCH /dictionaries/responsibleProducers/{id}	aktualizuj producenta produktu
DictionaryApi	dictionariesResponsibleProducersPost	POST /dictionaries/responsibleProducers	utwórz producenta produktu
DictionaryApi	dictionariesShippingMethodsGet	GET /dictionaries/shippingMethods	pobierz listę metod dostaw ERLI
HookApi	hooksCheckBuyabilityRunPost	POST /hooks/checkBuyability/run	Uruchom hook \"checkBuyability\"
HookApi	hooksGet	GET /hooks	pobierz listę hooków
HookApi	hooksHookNameDelete	DELETE /hooks/{hookName}	usuń hook
HookApi	hooksHookNamePut	PUT /hooks/{hookName}	utwórz/nadpisz hook
HookApi	hooksProductsNeedSyncRunPost	POST /hooks/productsNeedSync/run	Uruchom hook \"productsNeedSync\"
InboxApi	inboxGet	GET /inbox	pobierz 500 najstarszych nieprzeczytanych wiadomości
InboxApi	inboxMarkReadPost	POST /inbox/mark-read	potwierdź pobranie wiadomości
InboxApi	inboxSearchPost	POST /inbox/_search	wyszukaj po kryteriach 500 najstarszych nieprzeczytanych wiadomości
OrderApi	ordersIdGet	GET /orders/{id}	pobierz zamówienie
OrderApi	ordersIdPatch	PATCH /orders/{id}	aktualizuj zamówienie
OrderApi	ordersIdStatusPatch	PATCH /orders/{id}/status	zmień status zamówienia
OrderApi	ordersSearchPost	POST /orders/_search	wyszukaj zamówienia
PaymentApi	paymentsIdGet	GET /payments/{id}	pobierz płatność
PaymentApi	paymentsOperationsIdGet	GET /payments/operations/{id}	pobierz operację płatności, wypłaty lub zwrotu
PaymentApi	paymentsOperationsSearchPost	POST /payments/operations/_search	wyszukaj operacje płatności, wypłat lub zwrotów
PaymentApi	paymentsPayoutsIdGet	GET /payments/payouts/{id}	pobierz wypłatę
PaymentApi	paymentsPayoutsSearchPost	POST /payments/payouts/_search	wyszukaj wypłaty
PaymentApi	paymentsSearchPost	POST /payments/_search	wyszukaj płatności
PriceListApi	deliveryPriceListIdPatch	PATCH /delivery/priceList/{id}	zaktualizuj cennik dostaw
PriceListApi	deliveryPriceListPost	POST /delivery/priceList	utwórz nowy cennik dostaw
PriceListApi	deliveryPriceListsDetailsGet	GET /delivery/priceListsDetails	pobierz szczegółową listę cenników dostaw
PriceListApi	deliveryPriceListsGet	GET /delivery/priceLists	pobierz listę cenników dostaw
ProductApi	productsBatchUpdatePatch	PATCH /products/batch-update	aktualizuj wiele produktów jednocześnie
ProductApi	productsExternalIdDiscountGet	GET /products/{externalId}/discount	pobierz promocję czasową
ProductApi	productsExternalIdDiscountPost	POST /products/{externalId}/discount	utwórz promocję czasową
ProductApi	productsExternalIdGet	GET /products/{externalId}	pobierz produkt
ProductApi	productsExternalIdPatch	PATCH /products/{externalId}	zaktualizuj produkt
ProductApi	productsExternalIdPost	POST /products/{externalId}	utwórz nowy produkt
ProductApi	productsSearchPost	POST /products/_search	wyszukaj produkty
ShippingApi	shippingExternalIdDelete	DELETE /shipping/external/{id}	Usuń paczkę zewnętrzną
ShippingApi	shippingExternalIdGet	GET /shipping/external/{id}	Pobierz dane paczki zewnętrznej
ShippingApi	shippingExternalIdPatch	PATCH /shipping/external/{id}	Edytuj paczkę zewnętrzną
ShippingApi	shippingExternalPost	POST /shipping/external	Utwórz paczki zewnętrzne
ShippingApi	shippingParcelsIdDelete	DELETE /shipping/parcels/{id}	Anuluj paczkę
ShippingApi	shippingParcelsIdGet	GET /shipping/parcels/{id}	Pobierz dane paczki
ShippingApi	shippingParcelsPost	POST /shipping/parcels/	Utwórz paczki do nadania
ShippingApi	shippingParcelsSearchPost	POST /shipping/parcels/_search	Wyszukaj paczki
ShippingApi	shippingPickupProtocolsGet	GET /shipping/pickupProtocols	Pobierz url do potwierdzeń odebrania paczek przez kuriera
ShippingApi	shippingPostingPointsGet	GET /shipping/postingPoints	Pobierz listę zdefiniowanych punktów nadania paczek
ShopApi	meGet	GET /me	pobierz mój sklep

Models

AddAttachmentRequest
AttachmentResponse
AttributeFilter
AttributeResponseInner
AttributeValuesFilter
AttributeValuesResponseInner
BillingEntriesRequest
BillingEntriesRequestPagination
BillingEntriesRequestSimpleFilter
BillingEntriesResponseInner
BillingEntriesResponseInnerRebateOriginInner
BillingEntryTypesResponseInner
CategoryAttributeResponse
CategoryAttributeResponseBreadcrumbInner
CategoryFilter
CategoryResponse
CheckBuyabilityRequestInner
CheckBuyabilityResponseInner
CreateDiscount
CreateExternalParcelInner
CreateExternalParcelInnerTrackingNumber
CreateExternalParcelResponse
CreateExternalParcelResponseAnyOf
CreateExternalParcelResponseAnyOf1
CreateParcelsInner
CreateParcelsInnerDimensions
CreateParcelsInnerShipping
CreateParcelsInnerShippingReceiver
CreatePriceListSchema
CreatePriceListSchemaPricesInner
CreatePriceListSchemaPricesInnerDeliveryMethod
CreatePriceListSchemaPricesInnerDeliveryMethodDeliveryTime
CreatePriceListSchemaPricesInnerLimit
CreatePriceListSchemaPricesInnerLimitOneOfInner
CreateResponsibleSchema
DeleteAttachmentsResponse
DeliveryMethod
Discount
EditExternalParcel
Error
ErrorPayload
ErrorResponseInner
EstimateCommissionRequest
EstimateCommissionResponse
ExternalParcel
ExternalParcelShipping
GetAttachmentsResponseInner
GetAttachmentsResponseInnerCreated
GetAttachmentsResponseInnerCreatedUser
HookResponseInner
HookSave
ManageAttachedProducts
MarkRead
MarkReadAnyOf
MarkReadAnyOf1
Message
MessagePayload
MessagePayloadAnyOf
MessagePayloadAnyOf1
MessagePayloadAnyOf2
MessagePayloadAnyOf3
MessageRequest
Order
OrderDelivery
OrderDeliveryPickupPlace
OrderDeliveryTracking
OrderDeliveryTrackingAnyOf
OrderDeliveryTrackingAnyOf1
OrderFilter
OrderFilterAnyOf
OrderFilterAnyOf1
OrderFilterAnyOf1Value
OrderFilterAnyOf1ValueAnyOfInner
OrderFilterAnyOf2
OrderFilterAnyOf3
OrderFilterAnyOfValue
OrderFilterAnyOfValueAnyOf
OrderItemsInner
OrderPayment
OrderRebate
OrderReturnsInner
OrderReturnsInnerBankAccount
OrderReturnsInnerItemsInner
OrderSearch
OrderSearchPagination
OrderSearchPaginationAfter
OrderSearchPaginationAfterAnyOf
OrderUpdate
OrderUpdateStatus
OrderUser
OrderUserDeliveryAddress
OrderUserInvoiceAddress
Parcel
ParcelShipping
ParcelShippingReceiver
ParcelShippingSender
ParcelStatusHistoryInner
PatchAttachmentRequest
Payment
PaymentsOperationsIdGet200Response
PaymentsOperationsSearchPost200ResponseInner
PaymentsOperationsSearchPostRequestInner
Payout
PayoutFilter
PickupProtocols
PostingPoint
PostingPointAnyOf
PostingPointAnyOf1
PostingPointAnyOf1Location
PostingPointAnyOf1PointAddress
PostingPointAnyOf2
PostingPointAnyOf2PointsInner
PriceListDetailsSchema
ProductBatchResponseInner
ProductBatchResponseInnerError
ProductBatchResponseInnerErrorPayload
ProductBatchResponseInnerResult
ProductCreate
ProductCreateDescription
ProductCreateDescriptionAnyOf
ProductCreateDescriptionAnyOfSectionsInner
ProductCreateDescriptionAnyOfSectionsInnerItemsInner
ProductCreateDispatchTime
ProductCreateDispatchTimePeriod
ProductCreateExternalAttributesInner
ProductCreateExternalAttributesInnerAnyOf
ProductCreateExternalAttributesInnerAnyOf1
ProductCreateExternalAttributesInnerAnyOf1Values
ProductCreateExternalAttributesInnerAnyOf2
ProductCreateExternalAttributesInnerAnyOf2ValuesInner
ProductCreateExternalAttributesInnerAnyOf3
ProductCreateExternalAttributesInnerAnyOfId
ProductCreateExternalCategoriesInner
ProductCreateExternalReferencesInner
ProductCreateExternalReferencesInnerAnyOf
ProductCreateExternalResponsiblePersonInner
ProductCreateExternalResponsibleProducerInner
ProductCreateExternalVariantGroup
ProductCreateExternalVariantGroupAttributesInner
ProductCreateFilesInner
ProductCreateFrozen
ProductCreateImagesInner
ProductCreatePackaging
ProductCreateProductAttachmentsInner
ProductFields
ProductFilter
ProductFilterAnyOf
ProductFilterAnyOf1
ProductFilterAnyOf1Value
ProductFilterAnyOf2
ProductFilterAnyOf2Value
ProductFilterAnyOf3
ProductFilterAnyOf4
ProductFilterAnyOfValue
ProductResponse
ProductResponseAttributesInner
ProductResponseCategoriesInnerInner
ProductResponseExternalId
ProductResponseFrozen
ProductResponseImagesInner
ProductResponseTranslations
ProductResponseTranslationsPl
ProductResponseTranslationsPlAttributesInner
ProductResponseTranslationsPlAttributesInnerValues
ProductResponseTranslationsPlAttributesInnerValuesAnyOf
ProductSearch
ProductSearchPagination
ProductSearchPaginationAfter
ProductUpdate
ProductUpdateFrozen
ProductUpdateOverrideFrozen
ProductUpdateResponse
ProductsBatchUpdatePatchRequestInner
ProductsNeedSyncRequest
PrzestarzaYSposBAktualizacjiPrzesyKi
PrzestarzaYSposBAktualizacjiPrzesyKi1
ResponsibleSchema
SearchParcels
SearchParcelsFilter
SearchParcelsFilterAnyOf
SearchParcelsFilterAnyOf1
SearchParcelsFilterAnyOf1Value
SearchParcelsFilterAnyOfValue
SearchPayments
SearchPaymentsFilter
SearchPaymentsFilterAnyOf
SearchPaymentsFilterAnyOf1
SearchPaymentsFilterAnyOf1Value
SearchPaymentsFilterAnyOfValue
SearchPaymentsPagination
SearchPaymentsPaginationAfter
SearchPayout
SearchPayoutFilter
SearchPayoutFilterAnyOf
SearchPayoutFilterAnyOf1
SearchPayoutFilterAnyOf2
SearchPayoutFilterAnyOf3
SearchPayoutFilterAnyOfValue
SearchPayoutPagination
SearchPayoutPaginationAfter
SearchTransactions
ShippingMethod
ShippingMethodMaxDimensions
ShippingMethodMaxDimensionsAnyOf
ShippingMethodMaxDimensionsAnyOf1
ShippingMethodMaxPointDimensions
ShippingMethodMinDimensions
ShopCampaignsCostSummaryRequest
ShopCampaignsCostSummaryResponse
ShopCampaignsCostSummaryResponseDataInner
ShopResponse
ShopResponseCompany
Transaction
TransactionCustomer
TransactionOrdersInner
TransactionOrdersInnerItemsInner
TransactionRefund
UpdatePriceListSchema
UpdateResponsibleSchema
Vendor

Authorization

Authentication schemes defined for the API:

bearer

Type: Bearer authentication

Author

OperoCRM - HexagonDev 2026

About this package

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

API version: 1.0
- Package version: 0.0.1
- Generator version: 7.19.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

opero-crm / erli-api

Maintainers

Package info

Statistics

Security