apiship / yandex-market-php-client
Integration (SDK) with Yandex Market API
Installs: 1 080
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 3
Forks: 0
Open Issues: 1
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
This package is auto-updated.
Last update: 2024-10-24 12:36:16 UTC
README
API Яндекс Маркета помогает продавцам автоматизировать и упростить работу с маркетплейсом.
В числе возможностей интеграции:
-
управление каталогом товаров и витриной,
-
обработка заказов,
-
изменение настроек магазина,
-
получение отчетов.
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/apiship/yandex-market-php-client.git" } ], "require": { "GIT_USER_ID/GIT_REPO_ID": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/apiship/yandex-market-php-client/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: OAuth $config = YandexMarketApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new YandexMarketApi\Api\BidsApi( // 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 ); $business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto). ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html) $page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются. $limit = 20; // int | Количество товаров на одной странице. $get_bids_info_request = new \YandexMarketApi\Model\GetBidsInfoRequest(); // \YandexMarketApi\Model\GetBidsInfoRequest | description try { $result = $apiInstance->getBidsInfoForBusiness($business_id, $page_token, $limit, $get_bids_info_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling BidsApi->getBidsInfoForBusiness: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.partner.market.yandex.ru
Models
- AcceptOrderCancellationRequest
- AddHiddenOffersRequest
- AgeDTO
- AgeUnitType
- ApiClientDataErrorResponse
- ApiErrorDTO
- ApiErrorResponse
- ApiErrorResponseAllOf
- ApiForbiddenErrorResponse
- ApiLimitErrorResponse
- ApiLockedErrorResponse
- ApiNotFoundErrorResponse
- ApiResponse
- ApiResponseStatusType
- ApiServerErrorResponse
- ApiUnauthorizedErrorResponse
- BaseCampaignOfferDTO
- BaseOfferDTO
- BasePriceDTO
- BidRecommendationItemDTO
- BriefOrderItemDTO
- BriefOrderItemInstanceDTO
- BusinessDTO
- CampaignDTO
- CampaignSettingsDTO
- CampaignSettingsDeliveryDTO
- CampaignSettingsLocalRegionDTO
- CampaignSettingsScheduleDTO
- CampaignSettingsScheduleSourceType
- CampaignSettingsTimePeriodDTO
- CategoryContentParametersDTO
- CategoryParameterDTO
- ChangeOutletRequest
- ConfirmPricesRequest
- ConfirmShipmentRequest
- CreateOrderRequest
- CreateOrderResponse
- CreateOutletResponse
- CreateOutletResponseAllOf
- CurrencyType
- DayOfWeekType
- DeleteCampaignOffersDTO
- DeleteCampaignOffersRequest
- DeleteCampaignOffersResponse
- DeleteCampaignOffersResponseAllOf
- DeleteHiddenOffersRequest
- DeleteOffersDTO
- DeleteOffersRequest
- DeleteOffersResponse
- DeleteOffersResponseAllOf
- DeliveryServiceDTO
- DeliveryServiceInfoDTO
- DeliveryServicesDTO
- EacVerificationResultDTO
- EacVerificationStatusType
- EmptyApiResponse
- EnrichedMappingsOfferDTO
- EnrichedMappingsOfferDTOAllOf
- EnrichedModelDTO
- EnrichedModelDTOAllOf
- FeedCategoryDTO
- FeedContentDTO
- FeedContentErrorDTO
- FeedContentErrorType
- FeedDTO
- FeedDownloadDTO
- FeedDownloadErrorDTO
- FeedDownloadErrorType
- FeedIndexLogsErrorDTO
- FeedIndexLogsErrorType
- FeedIndexLogsFeedDTO
- FeedIndexLogsIndexType
- FeedIndexLogsOffersDTO
- FeedIndexLogsRecordDTO
- FeedIndexLogsResultDTO
- FeedIndexLogsStatusType
- FeedParameterDTO
- FeedPlacementDTO
- FeedPublicationDTO
- FeedPublicationFullDTO
- FeedPublicationPriceAndStockUpdateDTO
- FeedStatusType
- FeedbackAuthorDTO
- FeedbackCommentAuthorDTO
- FeedbackCommentAuthorType
- FeedbackCommentDTO
- FeedbackDTO
- FeedbackDeliveryType
- FeedbackFactorDTO
- FeedbackGradesDTO
- FeedbackListDTO
- FeedbackOrderDTO
- FeedbackShopDTO
- FeedbackStateType
- FieldStateType
- FlippingPagerDTO
- ForwardScrollingPagerDTO
- FulfillmentWarehouseDTO
- FulfillmentWarehousesDTO
- FullOutletDTO
- FullOutletDTOAllOf
- FullOutletLicenseDTO
- FullOutletLicenseDTOAllOf
- GenerateGoodsMovementReportRequest
- GenerateGoodsRealizationReportRequest
- GeneratePricesReportRequest
- GenerateReportDTO
- GenerateReportResponse
- GenerateReportResponseAllOf
- GenerateShowsSalesReportRequest
- GenerateStocksOnWarehousesReportRequest
- GenerateUnitedMarketplaceServicesReportRequest
- GenerateUnitedNettingReportRequest
- GetActualStocksDTO
- GetActualStocksResponse
- GetActualStocksResponseAllOf
- GetAllOffersResponse
- GetBidsInfoRequest
- GetBidsInfoResponse
- GetBidsInfoResponseAllOf
- GetBidsInfoResponseDTO
- GetBidsRecommendationsRequest
- GetBidsRecommendationsResponse
- GetBidsRecommendationsResponseAllOf
- GetBidsRecommendationsResponseDTO
- GetCampaignCategoriesResponse
- GetCampaignLoginsResponse
- GetCampaignOfferDTO
- GetCampaignOfferDTOAllOf
- GetCampaignOffersRequest
- GetCampaignOffersResponse
- GetCampaignOffersResponseAllOf
- GetCampaignOffersResultDTO
- GetCampaignRegionResponse
- GetCampaignResponse
- GetCampaignSettingsResponse
- GetCampaignsResponse
- GetCategoryContentParametersResponse
- GetCategoryContentParametersResponseAllOf
- GetDeliveryServicesResponse
- GetFeedCategoriesResponse
- GetFeedIndexLogsResponse
- GetFeedIndexLogsResponseAllOf
- GetFeedResponse
- GetFeedbackListResponse
- GetFeedbackListResponseAllOf
- GetFeedsResponse
- GetFulfillmentWarehousesResponse
- GetFulfillmentWarehousesResponseAllOf
- GetGoodsStatsRequest
- GetGoodsStatsResponse
- GetGoodsStatsResponseAllOf
- GetHiddenOffersResponse
- GetHiddenOffersResponseAllOf
- GetHiddenOffersResultDTO
- GetMappingDTO
- GetMappingDTOAllOf
- GetModelsOffersResponse
- GetModelsOffersResponseAllOf
- GetModelsRequest
- GetModelsResponse
- GetModelsResponseAllOf
- GetOfferCardsContentStatusRequest
- GetOfferCardsContentStatusResponse
- GetOfferCardsContentStatusResponseAllOf
- GetOfferDTO
- GetOfferDTOAllOf
- GetOfferMappingDTO
- GetOfferMappingEntriesResponse
- GetOfferMappingEntriesResponseAllOf
- GetOfferMappingsRequest
- GetOfferMappingsResponse
- GetOfferMappingsResponseAllOf
- GetOfferMappingsResultDTO
- GetOfferRecommendationsRequest
- GetOfferRecommendationsResponse
- GetOfferRecommendationsResponseAllOf
- GetOffersResponse
- GetOffersResponseAllOf
- GetOrderBuyerInfoResponse
- GetOrderBuyerInfoResponseAllOf
- GetOrderLabelsDataResponse
- GetOrderLabelsDataResponseAllOf
- GetOrderResponse
- GetOrdersResponse
- GetOrdersStatsRequest
- GetOrdersStatsResponse
- GetOrdersStatsResponseAllOf
- GetOutletLicensesResponse
- GetOutletLicensesResponseAllOf
- GetOutletResponse
- GetOutletsResponse
- GetPriceDTO
- GetPriceWithDiscountDTO
- GetPriceWithVatDTO
- GetPricesByOfferIdsRequest
- GetPricesByOfferIdsResponse
- GetPricesByOfferIdsResponseAllOf
- GetPricesResponse
- GetPricesResponseAllOf
- GetQuarantineOffersRequest
- GetQuarantineOffersResponse
- GetQuarantineOffersResponseAllOf
- GetQuarantineOffersResultDTO
- GetRegionWithChildrenResponse
- GetRegionsResponse
- GetReportInfoResponse
- GetReportInfoResponseAllOf
- GetReturnResponse
- GetReturnResponseAllOf
- GetReturnsResponse
- GetReturnsResponseAllOf
- GetShipmentOrdersInfoResponse
- GetShipmentOrdersInfoResponseAllOf
- GetShipmentResponse
- GetShipmentResponseAllOf
- GetSuggestedOfferMappingEntriesRequest
- GetSuggestedOfferMappingEntriesResponse
- GetSuggestedOfferMappingEntriesResponseAllOf
- GetSuggestedOfferMappingsRequest
- GetSuggestedOfferMappingsResponse
- GetSuggestedOfferMappingsResponseAllOf
- GetSuggestedOfferMappingsResultDTO
- GetWarehouseStocksDTO
- GetWarehouseStocksRequest
- GetWarehouseStocksResponse
- GetWarehouseStocksResponseAllOf
- GetWarehousesResponse
- GetWarehousesResponseAllOf
- GoodsStatsDTO
- GoodsStatsGoodsDTO
- GoodsStatsTariffDTO
- GoodsStatsTariffType
- GoodsStatsWarehouseDTO
- GoodsStatsWeightDimensionsDTO
- GpsDTO
- HiddenOfferDTO
- LicenseCheckStatusType
- LicenseType
- LogisticPickupPointDTO
- LogisticPointType
- MappingsOfferDTO
- ModelDTO
- ModelOfferDTO
- ModelPriceDTO
- OfferAvailabilityStatusType
- OfferCampaignStatusDTO
- OfferCampaignStatusType
- OfferCardDTO
- OfferCardRecommendationDTO
- OfferCardRecommendationType
- OfferCardStatusType
- OfferCardsContentStatusDTO
- OfferConditionDTO
- OfferConditionQualityType
- OfferConditionType
- OfferContentDTO
- OfferContentErrorDTO
- OfferContentErrorType
- OfferDTO
- OfferErrorDTO
- OfferForRecommendationDTO
- OfferMappingDTO
- OfferMappingEntriesDTO
- OfferMappingEntryDTO
- OfferMappingKindType
- OfferMappingSuggestionsListDTO
- OfferParamDTO
- OfferPriceByOfferIdsListResponseDTO
- OfferPriceByOfferIdsResponseDTO
- OfferPriceDTO
- OfferPriceFeedDTO
- OfferPriceListResponseDTO
- OfferPriceResponseDTO
- OfferProcessingNoteDTO
- OfferProcessingNoteType
- OfferProcessingStateDTO
- OfferProcessingStatusType
- OfferRecommendationDTO
- OfferRecommendationInfoDTO
- OfferRecommendationsResultDTO
- OfferSellingProgramDTO
- OfferSellingProgramStatusType
- OfferType
- OfferWeightDimensionsDTO
- OffersDTO
- OptionValuesLimitedDTO
- OrderBuyerDTO
- OrderBuyerType
- OrderCancellationReasonType
- OrderCourierDTO
- OrderCreateAddressDTO
- OrderCreateBuyerDTO
- OrderCreateDTO
- OrderCreateDeliveryDTO
- OrderCreateItemDTO
- OrderDTO
- OrderDeliveryAddressDTO
- OrderDeliveryDTO
- OrderDeliveryDateDTO
- OrderDeliveryDateReasonType
- OrderDeliveryDatesDTO
- OrderDeliveryDispatchType
- OrderDeliveryEacType
- OrderDeliveryPartnerType
- OrderDeliverySlotDTO
- OrderDeliveryType
- OrderDigitalItemDTO
- OrderItemDTO
- OrderItemDetailDTO
- OrderItemInstanceDTO
- OrderItemInstanceModificationDTO
- OrderItemInstanceType
- OrderItemModificationDTO
- OrderItemPromoDTO
- OrderItemStatusType
- OrderItemSubsidyDTO
- OrderItemsModificationRequestReasonType
- OrderItemsModificationResultDTO
- OrderLabelDTO
- OrderLiftType
- OrderParcelBoxDTO
- OrderParcelStatusType
- OrderPaymentMethodType
- OrderPaymentType
- OrderPromoType
- OrderShipmentDTO
- OrderStateDTO
- OrderStatsStatusType
- OrderStatusChangeDTO
- OrderStatusChangeDeliveryDTO
- OrderStatusChangeDeliveryDatesDTO
- OrderStatusType
- OrderSubsidyType
- OrderSubstatusType
- OrderTaxSystemType
- OrderTrackDTO
- OrderUpdateStatusType
- OrderVatType
- OrdersShipmentInfoDTO
- OrdersStatsCommissionDTO
- OrdersStatsCommissionType
- OrdersStatsDTO
- OrdersStatsDeliveryRegionDTO
- OrdersStatsDetailsDTO
- OrdersStatsItemDTO
- OrdersStatsItemStatusType
- OrdersStatsOrderDTO
- OrdersStatsOrderPaymentType
- OrdersStatsPaymentDTO
- OrdersStatsPaymentOrderDTO
- OrdersStatsPaymentSourceType
- OrdersStatsPaymentType
- OrdersStatsPriceDTO
- OrdersStatsPriceType
- OrdersStatsStockType
- OrdersStatsWarehouseDTO
- OutletAddressDTO
- OutletDTO
- OutletDeliveryRuleDTO
- OutletLicenseDTO
- OutletLicensesResponseDTO
- OutletResponseDTO
- OutletStatusType
- OutletType
- OutletVisibilityType
- OutletWorkingScheduleDTO
- OutletWorkingScheduleItemDTO
- PageFormatType
- PagedReturnsDTO
- PalletsCountDTO
- ParameterType
- ParameterValueConstraintsDTO
- ParameterValueDTO
- ParameterValueOptionDTO
- ParcelBoxDTO
- ParcelBoxLabelDTO
- ParcelDTO
- PartnerShipmentWarehouseDTO
- PickupAddressDTO
- PlacementType
- PriceCompetitivenessThresholdsDTO
- PriceCompetitivenessType
- PriceDTO
- PriceQuarantineVerdictDTO
- PriceQuarantineVerdictParamNameType
- PriceQuarantineVerdictParameterDTO
- PriceQuarantineVerdictType
- PriceRecommendationItemDTO
- PriceSuggestDTO
- PriceSuggestOfferDTO
- PriceSuggestType
- ProvideOrderDigitalCodesRequest
- ProvideOrderItemIdentifiersRequest
- ProvideOrderItemIdentifiersResponse
- ProvideOrderItemIdentifiersResponseAllOf
- PutSkuBidsRequest
- QuantumDTO
- QuarantineOfferDTO
- RecipientType
- RefundStatusType
- RegionDTO
- RegionType
- RegionalModelInfoDTO
- ReportFormatType
- ReportInfoDTO
- ReportStatusType
- ReportSubStatusType
- ReturnDTO
- ReturnDecisionDTO
- ReturnDecisionReasonType
- ReturnDecisionSubreasonType
- ReturnDecisionType
- ReturnInstanceDTO
- ReturnInstanceStatusType
- ReturnInstanceStockType
- ReturnItemDTO
- ReturnRequestDecisionType
- ReturnShipmentStatusType
- ReturnType
- ScrollingPagerDTO
- ScrollingPagerDTOAllOf
- SearchModelsResponse
- SearchShipmentsRequest
- SearchShipmentsResponse
- SearchShipmentsResponseAllOf
- SearchShipmentsResponseDTO
- SellingProgramType
- SetFeedParamsRequest
- SetOrderDeliveryDateRequest
- SetOrderDeliveryTrackCodeRequest
- SetOrderShipmentBoxesRequest
- SetOrderShipmentBoxesResponse
- SetOrderShipmentBoxesResponseAllOf
- SetReturnDecisionRequest
- SetShipmentPalletsCountRequest
- ShipmentActionType
- ShipmentBoxesDTO
- ShipmentDTO
- ShipmentInfoDTO
- ShipmentPalletLabelPageFormatType
- ShipmentStatusChangeDTO
- ShipmentStatusType
- ShipmentType
- ShowsSalesGroupingType
- SkuBidItemDTO
- SkuBidRecommendationItemDTO
- SortOrderType
- StockDTO
- StockItemDTO
- StockType
- SuggestOfferPriceDTO
- SuggestPricesRequest
- SuggestPricesResponse
- SuggestPricesResponseAllOf
- SuggestPricesResultDTO
- SuggestedOfferDTO
- SuggestedOfferMappingDTO
- TimePeriodDTO
- TimeUnitType
- TrackDTO
- TransferOrdersFromShipmentRequest
- TurnoverDTO
- TurnoverType
- UpdateBusinessOfferPriceDTO
- UpdateBusinessPricesRequest
- UpdateCampaignOfferDTO
- UpdateCampaignOfferDTOAllOf
- UpdateCampaignOffersRequest
- UpdateMappingDTO
- UpdateOfferContentRequest
- UpdateOfferContentResponse
- UpdateOfferContentResponseAllOf
- UpdateOfferContentResultDTO
- UpdateOfferDTO
- UpdateOfferDTOAllOf
- UpdateOfferMappingDTO
- UpdateOfferMappingEntryRequest
- UpdateOfferMappingsRequest
- UpdateOrderItemRequest
- UpdateOrderStatusDTO
- UpdateOrderStatusRequest
- UpdateOrderStatusResponse
- UpdateOrderStatusesDTO
- UpdateOrderStatusesRequest
- UpdateOrderStatusesResponse
- UpdateOrderStatusesResponseAllOf
- UpdateOrderStorageLimitRequest
- UpdateOutletLicenseRequest
- UpdatePriceWithDiscountDTO
- UpdatePriceWithDiscountDTOAllOf
- UpdatePricesRequest
- UpdateStocksRequest
- UpdateTimeDTO
- ValueRestrictionDTO
- VerifyOrderEacRequest
- VerifyOrderEacResponse
- VerifyOrderEacResponseAllOf
- WarehouseDTO
- WarehouseGroupDTO
- WarehouseOfferDTO
- WarehouseOffersDTO
- WarehouseStockDTO
- WarehouseStockType
- WarehousesDTO
Authorization
Authentication schemes defined for the API:
OAuth
- Type:
OAuth
- Flow:
implicit
- Authorization URL:
https://oauth.yandex.ru/authorize
- Scopes:
- market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
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
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen