frankii-fixx / php-yandex-market-api-generated-by-open-api
API Яндекс Маркета帮助卖家自动化和简化与市场平台的操作。集成功能包括:* 商品目录和橱窗管理,* 订单处理,* 商店设置更改,* 报告获取。
v1.0.0
2024-02-26 10:13 UTC
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
README
API Яндекс Маркета帮助卖家自动化和简化与市场平台的操作。
集成功能包括
-
商品目录和橱窗管理,
-
订单处理,
-
商店设置更改,
-
报告获取。
安装与使用
要求
PHP 7.4及更高版本。也应在PHP 8.0上工作。
Composer
要通过Composer安装绑定,请将以下内容添加到composer.json
{ "repositories": [ { "type": "vcs", "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" } ], "require": { "GIT_USER_ID/GIT_REPO_ID": "*@dev" } }
然后运行composer install
手动安装
下载文件并包含autoload.php
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
入门指南
请遵循安装程序,然后运行以下操作
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure OAuth2 access token for authorization: OAuth $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new OpenAPI\Client\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 \OpenAPI\Client\Model\GetBidsInfoRequest(); // \OpenAPI\Client\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端点
所有URI均相对于https://api.partner.market.yandex.ru
模型
- AcceptOrderCancellationRequest
- AddHiddenOffersRequest
- AddOffersToArchiveDTO
- AddOffersToArchiveErrorDTO
- AddOffersToArchiveErrorType
- AddOffersToArchiveRequest
- AddOffersToArchiveResponse
- AgeDTO
- AgeUnitType
- ApiClientDataErrorResponse
- ApiErrorDTO
- ApiErrorResponse
- 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
- ChatMessageDTO
- ChatMessagePayloadDTO
- ChatMessageSenderType
- ChatMessagesResultDTO
- ChatStatusType
- ChatType
- ConfirmPricesRequest
- ConfirmShipmentRequest
- CreateChatRequest
- CreateChatResponse
- CreateChatResultDTO
- CreateOutletResponse
- CurrencyType
- DayOfWeekType
- DeleteCampaignOffersDTO
- DeleteCampaignOffersRequest
- DeleteCampaignOffersResponse
- DeleteHiddenOffersRequest
- DeleteOffersDTO
- DeleteOffersFromArchiveDTO
- DeleteOffersFromArchiveRequest
- DeleteOffersFromArchiveResponse
- DeleteOffersRequest
- DeleteOffersResponse
- DeliveryServiceDTO
- DeliveryServiceInfoDTO
- DeliveryServicesDTO
- DocumentDTO
- EacVerificationResultDTO
- EacVerificationStatusType
- EmptyApiResponse
- EnrichedMappingsOfferDTO
- EnrichedModelDTO
- EnrichedOrderBoxLayoutDTO
- 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
- FullOutletLicenseDTO
- GenerateGoodsMovementReportRequest
- GenerateGoodsRealizationReportRequest
- GenerateGoodsTurnoverRequest
- GeneratePricesReportRequest
- GenerateReportDTO
- GenerateReportResponse
- GenerateShowsSalesReportRequest
- GenerateStocksOnWarehousesReportRequest
- GenerateUnitedMarketplaceServicesReportRequest
- GenerateUnitedNettingReportRequest
- GenerateUnitedOrdersRequest
- GetActualStocksDTO
- GetActualStocksResponse
- GetAllOffersResponse
- GetBidsInfoRequest
- GetBidsInfoResponse
- GetBidsInfoResponseDTO
- GetBidsRecommendationsRequest
- GetBidsRecommendationsResponse
- GetBidsRecommendationsResponseDTO
- GetBusinessBuyerInfoResponse
- GetBusinessDocumentsInfoResponse
- GetCampaignCategoriesResponse
- GetCampaignLoginsResponse
- GetCampaignOfferDTO
- GetCampaignOffersRequest
- GetCampaignOffersResponse
- GetCampaignOffersResultDTO
- GetCampaignRegionResponse
- GetCampaignResponse
- GetCampaignSettingsResponse
- GetCampaignsResponse
- GetCategoryContentParametersResponse
- GetChatHistoryRequest
- GetChatHistoryResponse
- GetChatInfoDTO
- GetChatsInfoDTO
- GetChatsRequest
- GetChatsResponse
- GetDeliveryServicesResponse
- GetFeedCategoriesResponse
- GetFeedIndexLogsResponse
- GetFeedResponse
- GetFeedbackListResponse
- GetFeedsResponse
- GetFulfillmentWarehousesResponse
- GetGoodsStatsRequest
- GetGoodsStatsResponse
- GetHiddenOffersResponse
- GetHiddenOffersResultDTO
- GetMappingDTO
- GetModelsOffersResponse
- GetModelsRequest
- GetModelsResponse
- GetOfferCardsContentStatusRequest
- GetOfferCardsContentStatusResponse
- GetOfferDTO
- GetOfferMappingDTO
- GetOfferMappingEntriesResponse
- GetOfferMappingsRequest
- GetOfferMappingsResponse
- GetOfferMappingsResultDTO
- GetOfferRecommendationsRequest
- GetOfferRecommendationsResponse
- GetOffersResponse
- GetOrderBuyerInfoResponse
- GetOrderLabelsDataResponse
- GetOrderResponse
- GetOrdersResponse
- GetOrdersStatsRequest
- GetOrdersStatsResponse
- GetOutletLicensesResponse
- GetOutletResponse
- GetOutletsResponse
- GetPriceDTO
- GetPriceWithDiscountDTO
- GetPriceWithVatDTO
- GetPricesByOfferIdsRequest
- GetPricesByOfferIdsResponse
- GetPricesResponse
- GetQuarantineOffersRequest
- GetQuarantineOffersResponse
- GetQuarantineOffersResultDTO
- GetRegionWithChildrenResponse
- GetRegionsResponse
- GetReportInfoResponse
- GetReturnResponse
- GetReturnsResponse
- GetShipmentOrdersInfoResponse
- GetShipmentResponse
- GetSuggestedOfferMappingEntriesRequest
- GetSuggestedOfferMappingEntriesResponse
- GetSuggestedOfferMappingsRequest
- GetSuggestedOfferMappingsResponse
- GetSuggestedOfferMappingsResultDTO
- GetWarehouseStocksDTO
- GetWarehouseStocksRequest
- GetWarehouseStocksResponse
- GetWarehousesResponse
- GoodsStatsDTO
- GoodsStatsGoodsDTO
- GoodsStatsWarehouseDTO
- GoodsStatsWeightDimensionsDTO
- GpsDTO
- HiddenOfferDTO
- LicenseCheckStatusType
- LicenseType
- LogisticPickupPointDTO
- LogisticPointType
- MappingsOfferDTO
- MappingsOfferInfoDTO
- ModelDTO
- ModelOfferDTO
- ModelPriceDTO
- OfferAvailabilityStatusType
- OfferCampaignStatusDTO
- OfferCampaignStatusType
- OfferCardDTO
- OfferCardRecommendationDTO
- OfferCardRecommendationType
- OfferCardStatusType
- OfferCardsContentStatusDTO
- OfferConditionDTO
- OfferConditionQualityType
- OfferConditionType
- OfferContentDTO
- OfferContentErrorDTO
- OfferContentErrorType
- OfferDTO
- OfferErrorDTO
- OfferForRecommendationDTO
- OfferMappingDTO
- OfferMappingEntriesDTO
- OfferMappingEntryDTO
- OfferMappingInfoDTO
- OfferMappingKindType
- OfferMappingSuggestionsListDTO
- OfferParamDTO
- OfferPriceByOfferIdsListResponseDTO
- OfferPriceByOfferIdsResponseDTO
- OfferPriceDTO
- OfferPriceFeedDTO
- OfferPriceListResponseDTO
- OfferPriceResponseDTO
- OfferProcessingNoteDTO
- OfferProcessingNoteType
- OfferProcessingStateDTO
- OfferProcessingStatusType
- OfferRecommendationDTO
- OfferRecommendationInfoDTO
- OfferRecommendationsResultDTO
- OfferSellingProgramDTO
- OfferSellingProgramStatusType
- OfferType
- OfferWeightDimensionsDTO
- OffersDTO
- OptionValuesLimitedDTO
- OrderBoxLayoutDTO
- OrderBoxLayoutItemDTO
- OrderBoxLayoutPartialCountDTO
- OrderBoxesLayoutDTO
- OrderBusinessBuyerDTO
- OrderBusinessDocumentsDTO
- OrderBuyerBasicInfoDTO
- OrderBuyerDTO
- OrderBuyerInfoDTO
- OrderBuyerType
- OrderCancellationReasonType
- OrderCourierDTO
- OrderDTO
- OrderDeliveryAddressDTO
- OrderDeliveryDTO
- OrderDeliveryDateDTO
- OrderDeliveryDateReasonType
- OrderDeliveryDatesDTO
- OrderDeliveryDispatchType
- OrderDeliveryEacType
- OrderDeliveryPartnerType
- OrderDeliveryType
- OrderDigitalItemDTO
- OrderDocumentStatusType
- 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
- 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
- SearchModelsResponse
- SearchShipmentsRequest
- SearchShipmentsResponse
- SearchShipmentsResponseDTO
- SellingProgramType
- SendMessageToChatRequest
- SetFeedParamsRequest
- SetOrderBoxLayoutRequest
- SetOrderBoxLayoutResponse
- SetOrderDeliveryDateRequest
- SetOrderDeliveryTrackCodeRequest
- SetOrderShipmentBoxesRequest
- SetOrderShipmentBoxesResponse
- SetReturnDecisionRequest
- SetShipmentPalletsCountRequest
- ShipmentActionType
- ShipmentBoxesDTO
- ShipmentDTO
- 运输信息DTO
- 运输托盘标签页面格式类型
- 运输状态变更DTO
- 运输状态类型
- 运输类型
- 显示销售分组类型
- SKU竞标项目DTO
- SKU竞标推荐项目DTO
- 排序顺序类型
- 库存DTO
- 库存项目DTO
- 库存类型
- 建议出价DTO
- 建议价格请求
- 建议价格响应
- 建议价格结果DTO
- 建议出价DTO
- 建议出价映射DTO
- 关税DTO
- 关税类型
- 时间周期DTO
- 时间单位类型
- 跟踪DTO
- 从运输请求中传输订单
- 营业额DTO
- 营业额类型
- 更新业务出价DTO
- 更新业务价格请求
- 更新活动出价DTO
- 更新活动出价请求
- 更新映射DTO
- 更新映射出价DTO
- 更新出价内容请求
- 更新出价内容响应
- 更新出价内容结果DTO
- 更新出价DTO
- 更新出价映射DTO
- 更新出价映射条目DTO
- 更新出价映射条目请求
- 更新出价映射请求
- 更新订单项目请求
- 更新订单状态DTO
- 更新订单状态请求
- 更新订单状态响应
- 更新订单状态DTO
- 更新订单状态请求
- 更新订单状态响应
- 更新订单存储限制请求
- 更新出口许可证请求
- 更新带折扣价格DTO
- 更新价格请求
- 更新库存请求
- 更新时间DTO
- 价值限制DTO
- 验证订单Eac请求
- 验证订单Eac响应
- 仓库地址DTO
- 仓库DTO
- 仓库组DTO
- 仓库出价DTO
- 仓库出价DTO
- 仓库库存DTO
- 仓库库存类型
- 仓库DTO
授权
为API定义的认证方案
OAuth
- 类型:
OAuth
- 流程:
隐式
- 授权URL:
https://oauth.yandex.ru/authorize
- 作用域:
- market:partner-api: 伙伴API的Yandex.Market / 商品搜索伙伴
测试
运行测试,使用
composer install vendor/bin/phpunit
作者
关于此包
此PHP包由OpenAPI Generator项目自动生成
- API版本:
LATEST
- 构建包:
org.openapitools.codegen.languages.PhpClientCodegen