OpenAPIClient-php

This is the Allegro.pl API. You can find more information on https://developer.allegro.pl/about.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/conviu/allegro-api.git"
    }
  ],
  "require": {
    "conviu/allegro-api": "*@dev"
  }
}

Then run composer install

Your project is free to choose the http client of your choice Please require packages that will provide http client functionality: https://packagist.org/providers/psr/http-client-implementation https://packagist.org/providers/php-http/async-client-implementation https://packagist.org/providers/psr/http-factory-implementation

As an example:

composer require guzzlehttp/guzzle php-http/guzzle7-adapter http-interop/http-factory-guzzle

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 OAuth2 access token for authorization: bearer-token-for-user
$config = AllegroApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AllegroApi\Api\AdditionalServicesApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$additional_services_group_request = new \AllegroApi\Model\AdditionalServicesGroupRequest(); // \AllegroApi\Model\AdditionalServicesGroupRequest | Additional service group body

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

API Endpoints

All URIs are relative to https://api.allegro.pl

Class	Method	HTTP request	Description
AdditionalServicesApi	createAdditionalServicesGroupUsingPOST	POST /sale/offer-additional-services/groups	Create additional services group
AdditionalServicesApi	getAdditionalServicesGroupUsingGET	GET /sale/offer-additional-services/groups/{groupId}	Get the details of an additional services group
AdditionalServicesApi	getListOfAdditionalServicesDefinitionsCategoriesUsingGET	GET /sale/offer-additional-services/categories	Get the additional services definitions by categories
AdditionalServicesApi	getListOfAdditionalServicesGroupsUsingGET	GET /sale/offer-additional-services/groups	Get the user's additional services groups
AdditionalServicesApi	modifyAdditionalServicesGroupUsingPUT	PUT /sale/offer-additional-services/groups/{groupId}	Modify an additional services group
AdditionalServicesTranslationsApi	deleteAdditionalServiceGroupTranslation	DELETE /sale/offer-additional-services/groups/{groupId}/translations/{language}	Delete a translation for a specified group and language
AdditionalServicesTranslationsApi	getAdditionalServiceGroupTranslations	GET /sale/offer-additional-services/groups/{groupId}/translations	Get translations for specified group
AdditionalServicesTranslationsApi	updateAdditionalServiceGroupTranslation	PATCH /sale/offer-additional-services/groups/{groupId}/translations/{language}	Create/Update translations for specified group and language
AdvanceShipNoticesApi	createAdvanceShipNotice	POST /fulfillment/advance-ship-notices	Create an Advance Ship Notice
AdvanceShipNoticesApi	createLabelsCommand	PUT /fulfillment/create-labels-commands/{command-id}	Create labels
AdvanceShipNoticesApi	deleteAdvanceShipNotice	DELETE /fulfillment/advance-ship-notices/{id}	Delete Advance Ship Notice
AdvanceShipNoticesApi	getAdvanceShipNotice	GET /fulfillment/advance-ship-notices/{id}	Get single Advance Ship Notice
AdvanceShipNoticesApi	getAdvanceShipNoticeLabels	GET /fulfillment/advance-ship-notices/{id}/labels	Get labels for Advance Ship Notice
AdvanceShipNoticesApi	getAdvanceShipNoticeReceivingState	GET /fulfillment/advance-ship-notices/{id}/receiving-state	Check current state and details of Advance Ship Notice receiving
AdvanceShipNoticesApi	getAdvanceShipNotices	GET /fulfillment/advance-ship-notices	Get list of Advance Ship Notices
AdvanceShipNoticesApi	getLabelCommand	GET /fulfillment/create-labels-commands/{command-id}	Get labels
AdvanceShipNoticesApi	getSubmitCommand	GET /fulfillment/submit-commands/{command-id}	Get submit status
AdvanceShipNoticesApi	submitCommand	PUT /fulfillment/submit-commands/{command-id}	Submit the Advance Ship Notice
AdvanceShipNoticesApi	updateAdvanceShipNotice	PUT /fulfillment/advance-ship-notices/{id}	Update Advance Ship Notice
AdvanceShipNoticesApi	updateSubmittedAdvanceShipNotice	PUT /fulfillment/advance-ship-notice/{id}/submitted	Update submitted Advance Ship Notice
AfterSaleServicesApi	createAfterSalesServiceConditionsAttachmentUsingPOST	POST /after-sales-service-conditions/attachments	Create a warranty attachment metadata
AfterSaleServicesApi	createAfterSalesServiceImpliedWarrantyUsingPOST	POST /after-sales-service-conditions/implied-warranties	Create new user's implied warranty
AfterSaleServicesApi	createAfterSalesServiceReturnPolicyUsingPOST	POST /after-sales-service-conditions/return-policies	Create new user's return policy
AfterSaleServicesApi	createAfterSalesServiceWarrantyUsingPOST	POST /after-sales-service-conditions/warranties	Create new user's warranty
AfterSaleServicesApi	getAfterSalesServiceImpliedWarrantyUsingGET	GET /after-sales-service-conditions/implied-warranties/{impliedWarrantyId}	Get the user's implied warranty
AfterSaleServicesApi	getAfterSalesServiceReturnPolicyUsingGET	GET /after-sales-service-conditions/return-policies/{returnPolicyId}	Get the user's return policy
AfterSaleServicesApi	getAfterSalesServiceWarrantyUsingGET	GET /after-sales-service-conditions/warranties/{warrantyId}	Get the user's warranty
AfterSaleServicesApi	getPublicSellerListingUsingGET	GET /after-sales-service-conditions/implied-warranties	Get the user's implied warranties
AfterSaleServicesApi	getPublicSellerListingUsingGET1	GET /after-sales-service-conditions/return-policies	Get the user's return policies
AfterSaleServicesApi	getPublicSellerListingUsingGET2	GET /after-sales-service-conditions/warranties	Get the user's warranties
AfterSaleServicesApi	updateAfterSalesServiceImpliedWarrantyUsingPUT	PUT /after-sales-service-conditions/implied-warranties/{impliedWarrantyId}	Change the user's implied warranty
AfterSaleServicesApi	updateAfterSalesServiceReturnPolicyUsingPUT	PUT /after-sales-service-conditions/return-policies/{returnPolicyId}	Change the user's return policy
AfterSaleServicesApi	updateAfterSalesServiceWarrantyUsingPUT	PUT /after-sales-service-conditions/warranties/{warrantyId}	Change the user's warranty
AfterSaleServicesApi	uploadAfterSalesServiceConditionsAttachmentUsingPUT	PUT /after-sales-service-conditions/attachments/{attachmentId}	Upload an warranty attachment
AllegroPricesApi	getAllegroPricesConsentForOffer	GET /sale/allegro-prices-offer-consents/{offerId}	Get the current consents' state for an offer
AllegroPricesApi	getAllegroPricesEligibilityForAccount	GET /sale/allegro-prices-account-eligibility	Get the current eligibility information for the account
AllegroPricesApi	updateAllegroPricesConsentForAccount	PUT /sale/allegro-prices-account-consent	Update consents for the account
AllegroPricesApi	updateAllegroPricesConsentForOffer	PUT /sale/allegro-prices-offer-consents/{offerId}	Update consents for an offer
AuctionsAndBiddingApi	getBid	GET /bidding/offers/{offerId}/bid	Get current user's bid information
AuctionsAndBiddingApi	placeBid	PUT /bidding/offers/{offerId}/bid	Place a bid in an auction
BadgeCampaignsApi	badgeApplicationsGetAll	GET /sale/badge-applications	Get a list of badge applications
BadgeCampaignsApi	badgeApplicationsGetOne	GET /sale/badge-applications/{applicationId}	Get a badge application details
BadgeCampaignsApi	badgeCampaignsGetAll	GET /sale/badge-campaigns	Get a list of available badge campaigns
BadgeCampaignsApi	badgeOperationsGetOne	GET /sale/badge-operations/{operationId}	Get badge operation details
BadgeCampaignsApi	getBadges	GET /sale/badges	Get a list of badges
BadgeCampaignsApi	patchBadge	PATCH /sale/badges/offers/{offerId}/campaigns/{campaignId}	Update campaign badge for the given offer
BadgeCampaignsApi	postBadges	POST /sale/badges	Apply for badge in selected offer
BatchOfferModificationApi	getGeneralReportUsingGET	GET /sale/offer-modification-commands/{commandId}	Modification command summary
BatchOfferModificationApi	getPriceModificationCommandStatusUsingGET	GET /sale/offer-price-change-commands/{commandId}	Change price command summary
BatchOfferModificationApi	getPriceModificationCommandTasksStatusesUsingGET	GET /sale/offer-price-change-commands/{commandId}/tasks	Change price command detailed report
BatchOfferModificationApi	getQuantityModificationCommandStatusUsingGET	GET /sale/offer-quantity-change-commands/{commandId}	Change quantity command summary
BatchOfferModificationApi	getQuantityModificationCommandTasksStatusesUsingGET	GET /sale/offer-quantity-change-commands/{commandId}/tasks	Change quantity command detailed report
BatchOfferModificationApi	getTasksUsingGET	GET /sale/offer-modification-commands/{commandId}/tasks	Modification command detailed report
BatchOfferModificationApi	getofferPriceAutomationModificationCommandStatusUsingGET	GET /sale/offer-price-automation-commands/{commandId}	Price automation command summary
BatchOfferModificationApi	getofferPriceAutomationModificationCommandTasksStatusesUsingGET	GET /sale/offer-price-automation-commands/{commandId}/tasks	Price automation command detailed report
BatchOfferModificationApi	modificationCommandUsingPUT	PUT /sale/offer-modification-commands/{commandId}	Batch offer modification
BatchOfferModificationApi	offerPriceAutomationModificationCommandUsingPOST	POST /sale/offer-price-automation-commands	Batch offer price automation rules modification
BatchOfferModificationApi	priceModificationCommandUsingPUT	PUT /sale/offer-price-change-commands/{commandId}	Batch offer price modification
BatchOfferModificationApi	quantityModificationCommandUsingPUT	PUT /sale/offer-quantity-change-commands/{commandId}	Batch offer quantity modification
BillingApi	getBillingEntries	GET /billing/billing-entries	Get a list of billing entries
BillingApi	getBillingTypes	GET /billing/billing-types	Get a list of billing types
CategoriesAndParametersApi	categorySuggestionUsingGET	GET /sale/matching-categories	Get categories suggestions
CategoriesAndParametersApi	getCategoriesUsingGET	GET /sale/categories	Get IDs of Allegro categories
CategoriesAndParametersApi	getCategoryEventsUsingGET1	GET /sale/category-events	Get changes in categories
CategoriesAndParametersApi	getCategoryParametersScheduledChangesUsingGET1	GET /sale/category-parameters-scheduled-changes	Get planned changes in category parameters
CategoriesAndParametersApi	getCategoryUsingGET1	GET /sale/categories/{categoryId}	Get a category by ID
CategoriesAndParametersApi	getFlatParametersUsingGET2	GET /sale/categories/{categoryId}/parameters	Get parameters supported by a category
CharityApi	searchFundraisingCampaigns	GET /charity/fundraising-campaigns	Search fundraising campaigns
ClassifiedsApi	assignClassifiedPackagesUsingPUT	PUT /sale/offer-classifieds-packages/{offerId}	Assign packages to a classified
ClassifiedsApi	classifiedOffersStatsGET	GET /sale/classified-offers-stats	Get the advertisements daily statistics
ClassifiedsApi	classifiedSellerOfferStatsGET	GET /sale/classified-seller-stats	Get the seller's advertisements daily statistics
ClassifiedsApi	getClassifiedPackageConfigurationUsingGET	GET /sale/classifieds-packages/{packageId}	Get the configuration of a package
ClassifiedsApi	getClassifiedPackageConfigurationsForCategoryUsingGET	GET /sale/classifieds-packages	Get configurations of packages
ClassifiedsApi	getClassifiedPackagesUsingGET	GET /sale/offer-classifieds-packages/{offerId}	Get classified packages assigned to an offer
CommissionRefundsApi	cancelRefundApplication	DELETE /order/refund-claims/{claimId}	Cancel a refund application
CommissionRefundsApi	createRefundApplication	POST /order/refund-claims	Create a refund application
CommissionRefundsApi	getRefundApplication	GET /order/refund-claims/{claimId}	Get a refund application details
CommissionRefundsApi	getRefundApplications	GET /order/refund-claims	Get a list of refund applications
CompatibilityListApi	getCategoriesThatSupportCompatibilityList	GET /sale/compatibility-list/supported-categories	Get list of categories where compatibility list is supported
CompatibilityListApi	getCompatibilityListSuggestion	GET /sale/compatibility-list-suggestions	Get suggested compatibility list.
CompatibilityListApi	getCompatibleProducts	GET /sale/compatible-products	Get list of compatible products
CompatibilityListApi	getCompatibleProductsGroups	GET /sale/compatible-products/groups	Get list of compatible product groups
ContactsApi	createContactUsingPOST	POST /sale/offer-contacts	Create a new contact
ContactsApi	getContactUsingGET	GET /sale/offer-contacts/{id}	Get contact details
ContactsApi	getListOfContactsUsingGET	GET /sale/offer-contacts	Get the user's contacts
ContactsApi	modifyContactUsingPUT	PUT /sale/offer-contacts/{id}	Modify contact details
CustomerReturnsApi	getCustomerReturnById	GET /order/customer-returns/{customerReturnId}	[BETA] Get customer return by id
CustomerReturnsApi	getCustomerReturns	GET /order/customer-returns	[BETA] Get customer returns by provided query parameters
CustomerReturnsApi	rejectCustomerReturnRefund	POST /order/customer-returns/{customerReturnId}/rejection	[BETA] Reject customer return refund
DeliveryApi	createShippingRatesSetUsingPOST	POST /sale/shipping-rates	Create a new shipping rates set
DeliveryApi	getListOfDeliveryMethodsUsingGET	GET /sale/delivery-methods	Get the list of delivery methods
DeliveryApi	getListOfShippingRatestUsingGET	GET /sale/shipping-rates	Get the user's shipping rates
DeliveryApi	getSaleDeliverySettings	GET /sale/delivery-settings	Get the user's delivery settings
DeliveryApi	getShippingRatesSetUsingGET	GET /sale/shipping-rates/{id}	Get the details of a shipping rates set
DeliveryApi	modifyShippingRatesSetUsingPUT	PUT /sale/shipping-rates/{id}	Edit a user's shipping rates set
DeliveryApi	putSaleDeliverySettings	PUT /sale/delivery-settings	Modify the user's delivery settings
DisputesApi	addMessageToDisputeUsingPOST	POST /sale/disputes/{disputeId}/messages	Add a message to a dispute
DisputesApi	createAnAttachmentUsingPOST	POST /sale/dispute-attachments	Create an attachment declaration
DisputesApi	getAttachmentUsingGET	GET /sale/dispute-attachments/{attachmentId}	Get an attachment
DisputesApi	getDisputeUsingGET	GET /sale/disputes/{disputeId}	Get a single dispute
DisputesApi	getListOfDisputesUsingGET	GET /sale/disputes	Get the user's disputes
DisputesApi	getMessagesFromDisputeUsingGET	GET /sale/disputes/{disputeId}/messages	Get the messages within a dispute
DisputesApi	uploadDisputeAttachmentUsingPUT	PUT /sale/dispute-attachments/{attachmentId}	Upload a dispute message attachment
FulfillmentParcelsApi	getFulfillmentOrderParcels	GET /fulfillment/orders/{orderId}/parcels	Get list of shipped parcels
FulfillmentProductsApi	getAvailableProducts	GET /fulfillment/available-products	Get list of available products
FulfillmentStockApi	getFulfillmentStock	GET /fulfillment/stock	Get available stock
ImagesAndAttachmentsApi	createOfferAttachmentUsingPOST	POST /sale/offer-attachments	Create an offer attachment
ImagesAndAttachmentsApi	uploadOfferAttachmentUsingPUT	PUT /sale/offer-attachments/{attachmentId}	Upload an offer attachment
ImagesAndAttachmentsApi	uploadOfferImageUsingPOST	POST /sale/images	Upload an offer image
InformationAboutMarketplacesApi	marketplacesGET	GET /marketplaces	Get details for all marketplaces in allegro
InformationAboutUserApi	addAdditionalEmailUsingPOST	POST /account/additional-emails	Add a new additional email address to user's account
InformationAboutUserApi	answerUserRatingUsingPUT	PUT /sale/user-ratings/{ratingId}/answer	Answer for user's rating
InformationAboutUserApi	deleteAdditionalEmailUsingDELETE	DELETE /account/additional-emails/{emailId}	Delete an additional email address
InformationAboutUserApi	getAdditionalEmailUsingGET	GET /account/additional-emails/{emailId}	Get information about a particular additional email
InformationAboutUserApi	getListOfAdditionalEmailsUsingGET	GET /account/additional-emails	Get user's additional emails
InformationAboutUserApi	getSellerSmartClassificationGET	GET /sale/smart	Get Smart! seller classification report
InformationAboutUserApi	getUserRatingUsingGET	GET /sale/user-ratings/{ratingId}	Get the user's rating by given rating id
InformationAboutUserApi	getUserRatingsUsingGET	GET /sale/user-ratings	Get the user's ratings
InformationAboutUserApi	meGET	GET /me	Get basic information about user
InformationAboutUserApi	userRatingRemovalUsingPUT	PUT /sale/user-ratings/{ratingId}/removal	Request removal of user's rating
MessageCenterApi	changeReadFlagOnThreadPUT	PUT /messaging/threads/{threadId}/read	Mark a particular thread as read
MessageCenterApi	deleteMessageDELETE	DELETE /messaging/messages/{messageId}	Delete single message
MessageCenterApi	downloadAttachmentGET	GET /messaging/message-attachments/{attachmentId}	Download attachment
MessageCenterApi	getMessageGET	GET /messaging/messages/{messageId}	Get single message
MessageCenterApi	getThreadGET	GET /messaging/threads/{threadId}	Get user thread
MessageCenterApi	listMessagesGET	GET /messaging/threads/{threadId}/messages	List messages in thread
MessageCenterApi	listThreadsGET	GET /messaging/threads	List user threads
MessageCenterApi	newAttachmentDeclarationPOST	POST /messaging/message-attachments	Add attachment declaration
MessageCenterApi	newMessageInThreadPOST	POST /messaging/threads/{threadId}/messages	Write a new message in thread
MessageCenterApi	newMessagePOST	POST /messaging/messages	Write a new message
MessageCenterApi	uploadAttachmentPUT	PUT /messaging/message-attachments/{attachmentId}	Upload attachment binary data
OfferManagementApi	changePublicationStatusUsingPUT	PUT /sale/offer-publication-commands/{commandId}	Batch offer publish / unpublish
OfferManagementApi	createChangePriceCommandUsingPUT	PUT /offers/{offerId}/change-price-commands/{commandId}	Modify the Buy Now price in an offer
OfferManagementApi	createProductOffers	POST /sale/product-offers	Create offer based on product
OfferManagementApi	deleteOfferUsingDELETE	DELETE /sale/offers/{offerId}	Delete a draft offer
OfferManagementApi	editProductOffers	PATCH /sale/product-offers/{offerId}	Edit an offer
OfferManagementApi	getAvailableOfferPromotionPackages	GET /sale/offer-promotion-packages	Get all available offer promotion packages
OfferManagementApi	getOfferPromoOptionsUsingGET	GET /sale/offers/{offerId}/promo-options	Get offer promotion packages
OfferManagementApi	getOffersUnfilledParametersUsingGET1	GET /sale/offers/unfilled-parameters	Get offers with missing parameters
OfferManagementApi	getProductOfferProcessingStatus	GET /sale/product-offers/{offerId}/operations/{operationId}	Check the processing status of a POST or PATCH request
OfferManagementApi	getPromoModificationCommandDetailedResultUsingGET	GET /sale/offers/promo-options-commands/{commandId}/tasks	Modification command detailed result
OfferManagementApi	getPromoModificationCommandResultUsingGET	GET /sale/offers/promo-options-commands/{commandId}	Modification command summary
OfferManagementApi	getPromoOptionsForSellerOffersUsingGET	GET /sale/offers/promo-options	Get promo options for seller's offers
OfferManagementApi	getPublicationReportUsingGET	GET /sale/offer-publication-commands/{commandId}	Publish command summary
OfferManagementApi	getPublicationTasksUsingGET	GET /sale/offer-publication-commands/{commandId}/tasks	Publish command detailed report
OfferManagementApi	modifyOfferPromoOptionsUsingPOST	POST /sale/offers/{offerId}/promo-options-modification	Modify offer promotion packages
OfferManagementApi	promoModificationCommandUsingPUT	PUT /sale/offers/promo-options-commands/{commandId}	Batch offer promotion package modification
OfferRatingApi	offerRatingGET	GET /sale/offers/{offerId}/rating	Get offer rating
OfferTagsApi	assignTagToOfferPOST	POST /sale/offers/{offerId}/tags	Assign tags to an offer
OfferTagsApi	createTagPOST1	POST /sale/offer-tags	Create a tag
OfferTagsApi	deleteTagUsingDELETE	DELETE /sale/offer-tags/{tagId}	Delete a tag
OfferTagsApi	listAssignedOfferTagsGET	GET /sale/offers/{offerId}/tags	Get tags assigned to an offer
OfferTagsApi	listSellerTagsGET1	GET /sale/offer-tags	Get the user's tags
OfferTagsApi	updateTagPUT	PUT /sale/offer-tags/{tagId}	Modify a tag
OfferTranslationsApi	deleteManualTranslationUsingDELETE	DELETE /sale/offers/{offerId}/translations/{language}	Delete offer translation
OfferTranslationsApi	getOfferTranslationUsingGET	GET /sale/offers/{offerId}/translations	Get offer translations
OfferTranslationsApi	updateOfferTranslationUsingPATCH	PATCH /sale/offers/{offerId}/translations/{language}	Update offer translation
OfferVariantsApi	createVariantSet	POST /sale/offer-variants	Create variant set
OfferVariantsApi	deleteVariantSet	DELETE /sale/offer-variants/{setId}	Delete a variant set
OfferVariantsApi	getVariantSet	GET /sale/offer-variants/{setId}	Get a variant set
OfferVariantsApi	getVariantSets	GET /sale/offer-variants	Get the user's variant sets
OfferVariantsApi	updateVariantSet	PUT /sale/offer-variants/{setId}	Update variant set
OrderManagementApi	addOrderInvoicesMetadata	POST /order/checkout-forms/{id}/invoices	Post new invoice
OrderManagementApi	createOrderShipmentsUsingPOST	POST /order/checkout-forms/{id}/shipments	Add a parcel tracking number
OrderManagementApi	getAllegroPickupDropOffPointsGET	GET /order/carriers/ALLEGRO/points	Get Allegro pickup drop off points
OrderManagementApi	getListOfOrdersUsingGET	GET /order/checkout-forms	Get the user's orders
OrderManagementApi	getOrderEventsStatisticsUsingGET	GET /order/event-stats	Get order events statistics
OrderManagementApi	getOrderEventsUsingGET	GET /order/events	Get order events
OrderManagementApi	getOrderInvoicesDetails	GET /order/checkout-forms/{id}/invoices	Get order invoices details
OrderManagementApi	getOrderShipmentsUsingGET	GET /order/checkout-forms/{id}/shipments	Get a list of parcel tracking numbers
OrderManagementApi	getOrdersCarriersUsingGET	GET /order/carriers	Get a list of available shipping carriers
OrderManagementApi	getOrdersDetailsUsingGET	GET /order/checkout-forms/{id}	Get an order's details
OrderManagementApi	getParcelTrackingUsingGET	GET /order/carriers/{carrierId}/tracking	Get carrier parcel tracking history
OrderManagementApi	setOrderFulfillmentUsingPUT	PUT /order/checkout-forms/{id}/fulfillment	Set seller order status
OrderManagementApi	uploadOrderInvoiceFile	PUT /order/checkout-forms/{id}/invoices/{invoiceId}/file	Upload invoice file
ParcelManagementApi	cancelParcel	PUT /parcel-management/parcel-cancel-commands/{commandId}	Cancel parcel
ParcelManagementApi	createNewParcel	PUT /parcel-management/parcel-create-commands/{commandId}	Create a new parcel
ParcelManagementApi	getAvailableDeliveryServices	GET /parcel-management/delivery-services	Get available delivery services
ParcelManagementApi	getParcelCancellationStatus	GET /parcel-management/parcel-cancel-commands/{commandId}	Get parcel cancellation status
ParcelManagementApi	getParcelCreationStatus	GET /parcel-management/parcel-create-commands/{commandId}	Get parcel creation status
ParcelManagementApi	getParcelDetails	GET /parcel-management/parcels/{parcelId}	Get parcel details
ParcelManagementApi	getParcelLabel	GET /parcel-management/parcels/label	Get parcel label
ParcelManagementApi	getParcelPickupStatus	GET /parcel-management/parcel-pickup-request-commands/{commandId}	Get parcel pickup status
ParcelManagementApi	getParcelsPickupDateProposals	GET /parcel-management/pickup-date-proposals	Get parcels pickup date proposals
ParcelManagementApi	getParcelsProtocol	GET /parcel-management/parcels/protocol	Get parcels protocol
ParcelManagementApi	requestParcelPickup	PUT /parcel-management/parcel-pickup-request-commands/{commandId}	Request parcel pickup
PaymentsApi	getPaymentsOperationHistory	GET /payments/payment-operations	Payment operations history
PaymentsApi	getRefundedPayments	GET /payments/refunds	Get a list of refunded payments
PaymentsApi	initiateRefund	POST /payments/refunds	Initiate a refund of a payment
PointsOfServiceApi	createPOSUsingPOST	POST /points-of-service	Create a point of service
PointsOfServiceApi	deletePOSUsingDELETE	DELETE /points-of-service/{id}	Delete a point of service
PointsOfServiceApi	getPOSDataUsingGET	GET /points-of-service/{id}	Get the details of a point of service
PointsOfServiceApi	getPOSListUsingGET	GET /points-of-service	Get the user's points of service
PointsOfServiceApi	modifyPOSUsingPUT	PUT /points-of-service/{id}	Modify a point of service
PriceAutomationApi	getPriceAutomationRulesForOfferUsingGET	GET /sale/price-automation/offers/{offerId}/rules	Get price automation rules assigned to the offer
PriceAutomationApi	getPriceAutomationRulesUsingGET	GET /sale/price-automation/rules	Get price automation rules
PricingApi	calculateFeePreviewUsingPOST	POST /pricing/offer-fee-preview	Calculate fee and commission for an offer
PricingApi	offerQuotesPublicUsingGET	GET /pricing/offer-quotes	Get the user's current offer quotes
ProductsApi	getFlatProductParametersUsingGET	GET /sale/categories/{categoryId}/product-parameters	Get product parameters available in given category
ProductsApi	getProductChangeProposal	GET /sale/products/change-proposals/{changeProposalId}	Get all data of the particular product changes proposal
ProductsApi	getSaleProduct	GET /sale/products/{productId}	Get all data of the particular product
ProductsApi	getSaleProducts	GET /sale/products	Get search products results
ProductsApi	productChangeProposal	POST /sale/products/{productId}/change-proposals	Propose changes in product
ProductsApi	proposeSaleProduct	POST /sale/product-proposals	Propose a product
PublicOfferInformationApi	getListing	GET /offers/listing	Search offers
PublicUserInformationApi	getUserSummaryUsingGET	GET /users/{userId}/ratings-summary	Get any user's ratings summary
RebatesAndPromotionsApi	createPromotionUsingPOST1	POST /sale/loyalty/promotions	Create a new promotion
RebatesAndPromotionsApi	deactivatePromotionUsingDELETE	DELETE /sale/loyalty/promotions/{promotionId}	Deactivate a promotion by id
RebatesAndPromotionsApi	getPromotionUsingGET	GET /sale/loyalty/promotions/{promotionId}	Get a promotion data by id
RebatesAndPromotionsApi	listSellerPromotionsUsingGET1	GET /sale/loyalty/promotions	Get the user's list of promotions
RebatesAndPromotionsApi	updatePromotionUsingPUT	PUT /sale/loyalty/promotions/{promotionId}	Modify a promotion
ResponsiblePersonsApi	responsiblePersonsGET	GET /sale/responsible-persons	Get the list of responsible persons
ResponsiblePersonsApi	responsiblePersonsPOST	POST /sale/responsible-persons	Create responsible person
ResponsiblePersonsApi	responsiblePersonsPUT	PUT /sale/responsible-persons/{id}	Update responsible person
ShipmentManagementApi	cancelShipment	POST /shipment-management/shipments/cancel-commands	Cancel shipment
ShipmentManagementApi	createNewShipment	POST /shipment-management/shipments/create-commands	Create new shipment
ShipmentManagementApi	createPickup	POST /shipment-management/pickups/create-commands	Request shipments pickup
ShipmentManagementApi	createPickupStatus	GET /shipment-management/pickups/create-commands/{commandId}	Create pickup command status
ShipmentManagementApi	getDeliveryServices	GET /shipment-management/delivery-services	Get available delivery services
ShipmentManagementApi	getPickupProposals	POST /shipment-management/pickup-proposals	Get shipments pickup proposals
ShipmentManagementApi	getShipmentCancellationStatus	GET /shipment-management/shipments/cancel-commands/{commandId}	Get shipment cancellation status
ShipmentManagementApi	getShipmentCreationStatus	GET /shipment-management/shipments/create-commands/{commandId}	Get shipment creation command status
ShipmentManagementApi	getShipmentDetails	GET /shipment-management/shipments/{shipmentId}	Get shipment details
ShipmentManagementApi	getShipmentLabels	POST /shipment-management/label	Get shipments labels
ShipmentManagementApi	getShipmentProtocol	POST /shipment-management/protocol	Get shipments protocol
SizeTablesApi	createTableUsingPOST	POST /sale/size-tables	Create a size table
SizeTablesApi	getTableUsingGET	GET /sale/size-tables/{tableId}	Get a size table
SizeTablesApi	getTablesTemplatesUsingGET	GET /sale/size-tables-templates	Get the size tables templates
SizeTablesApi	getTablesUsingGET	GET /sale/size-tables	Get the user's size tables
SizeTablesApi	modifyTableUsingPUT	PUT /sale/size-tables/{tableId}	Update a size table
TaxSettingsApi	getTaxSettingsForCategory	GET /sale/tax-settings	Get all tax settings for category
UsersOfferInformationApi	getOfferEvents	GET /sale/offer-events	Get events about the seller's offers
UsersOfferInformationApi	getOfferSmartClassificationGET	GET /sale/offers/{offerId}/smart	Get Smart! classification report of the particular offer
UsersOfferInformationApi	getProductOffer	GET /sale/product-offers/{offerId}	Get all data of the particular product-offer
UsersOfferInformationApi	searchOffersUsingGET	GET /sale/offers	Get seller's offers

Models

Authorization

bearer-token-for-user

Type: OAuth
Flow: accessCode
Authorization URL: https://allegro.pl/auth/oauth/authorize
Scopes: N/A

bearer-token-for-application

Type: OAuth
Flow: application
Authorization URL: ``
Scopes: N/A

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
- Generator version: 7.6.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

naturalGroove/allegro-api