Files
Sipro-Marketplaces/pkg/api/yandex/ymclient/docs/SupplyRequestsAPI.md
2025-08-15 11:10:28 +03:00

16 KiB
Raw Blame History

\SupplyRequestsAPI

All URIs are relative to https://api.partner.market.yandex.ru

Method HTTP request Description
GetSupplyRequestDocuments Post /campaigns/{campaignId}/supply-requests/documents Получение документов по заявке на поставку, вывоз или утилизацию
GetSupplyRequestItems Post /campaigns/{campaignId}/supply-requests/items Получение товаров в заявке на поставку, вывоз или утилизацию
GetSupplyRequests Post /campaigns/{campaignId}/supply-requests Получение информации о заявках на поставку, вывоз и утилизацию

GetSupplyRequestDocuments

GetSupplyRequestDocumentsResponse GetSupplyRequestDocuments(ctx, campaignId).GetSupplyRequestDocumentsRequest(getSupplyRequestDocumentsRequest).Execute()

Получение документов по заявке на поставку, вывоз или утилизацию

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	campaignId := int64(789) // int64 | Идентификатор кампании.  Его можно узнать с помощью запроса [:no-translate[GET campaigns]](:no-translate[../../reference/campaigns/getCampaigns.md]) или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:    * **Модули и :no-translate[API]** → блок **Передача данных Маркету**.   * **Лог запросов** → выпадающий список в блоке **Показывать логи**.  ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. 
	getSupplyRequestDocumentsRequest := *openapiclient.NewGetSupplyRequestDocumentsRequest(int64(123)) // GetSupplyRequestDocumentsRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupplyRequestsAPI.GetSupplyRequestDocuments(context.Background(), campaignId).GetSupplyRequestDocumentsRequest(getSupplyRequestDocumentsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupplyRequestsAPI.GetSupplyRequestDocuments``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSupplyRequestDocuments`: GetSupplyRequestDocumentsResponse
	fmt.Fprintf(os.Stdout, "Response from `SupplyRequestsAPI.GetSupplyRequestDocuments`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
campaignId int64 Идентификатор кампании. Его можно узнать с помощью запроса :no-translate[GET campaigns] или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу: * Модули и :no-translate[API] → блок Передача данных Маркету. * Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Other Parameters

Other parameters are passed through a pointer to a apiGetSupplyRequestDocumentsRequest struct via the builder pattern

Name Type Description Notes

getSupplyRequestDocumentsRequest | GetSupplyRequestDocumentsRequest | |

Return type

GetSupplyRequestDocumentsResponse

Authorization

ApiKey, OAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSupplyRequestItems

GetSupplyRequestItemsResponse GetSupplyRequestItems(ctx, campaignId).GetSupplyRequestItemsRequest(getSupplyRequestItemsRequest).PageToken(pageToken).Limit(limit).Execute()

Получение товаров в заявке на поставку, вывоз или утилизацию

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	campaignId := int64(789) // int64 | Идентификатор кампании.  Его можно узнать с помощью запроса [:no-translate[GET campaigns]](:no-translate[../../reference/campaigns/getCampaigns.md]) или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:    * **Модули и :no-translate[API]** → блок **Передача данных Маркету**.   * **Лог запросов** → выпадающий список в блоке **Показывать логи**.  ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. 
	getSupplyRequestItemsRequest := *openapiclient.NewGetSupplyRequestItemsRequest(int64(123)) // GetSupplyRequestItemsRequest | 
	pageToken := "eyBuZXh0SWQ6IDIzNDIgfQ==" // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается первая страница.  Рекомендуем передавать значение выходного параметра :no-translate[`nextPageToken`], полученное при последнем запросе.  Если задан :no-translate[`page_token`] и в запросе есть параметры :no-translate[`page`] и :no-translate[`pageSize`], они игнорируются.  (optional)
	limit := int32(20) // int32 | Количество значений на одной странице.  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupplyRequestsAPI.GetSupplyRequestItems(context.Background(), campaignId).GetSupplyRequestItemsRequest(getSupplyRequestItemsRequest).PageToken(pageToken).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupplyRequestsAPI.GetSupplyRequestItems``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSupplyRequestItems`: GetSupplyRequestItemsResponse
	fmt.Fprintf(os.Stdout, "Response from `SupplyRequestsAPI.GetSupplyRequestItems`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
campaignId int64 Идентификатор кампании. Его можно узнать с помощью запроса :no-translate[GET campaigns] или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу: * Модули и :no-translate[API] → блок Передача данных Маркету. * Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Other Parameters

Other parameters are passed through a pointer to a apiGetSupplyRequestItemsRequest struct via the builder pattern

Name Type Description Notes

getSupplyRequestItemsRequest | GetSupplyRequestItemsRequest | | pageToken | string | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуем передавать значение выходного параметра :no-translate[`nextPageToken`], полученное при последнем запросе. Если задан :no-translate[`page_token`] и в запросе есть параметры :no-translate[`page`] и :no-translate[`pageSize`], они игнорируются. | limit | int32 | Количество значений на одной странице. |

Return type

GetSupplyRequestItemsResponse

Authorization

ApiKey, OAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSupplyRequests

GetSupplyRequestsResponse GetSupplyRequests(ctx, campaignId).PageToken(pageToken).Limit(limit).GetSupplyRequestsRequest(getSupplyRequestsRequest).Execute()

Получение информации о заявках на поставку, вывоз и утилизацию

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	campaignId := int64(789) // int64 | Идентификатор кампании.  Его можно узнать с помощью запроса [:no-translate[GET campaigns]](:no-translate[../../reference/campaigns/getCampaigns.md]) или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:    * **Модули и :no-translate[API]** → блок **Передача данных Маркету**.   * **Лог запросов** → выпадающий список в блоке **Показывать логи**.  ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. 
	pageToken := "eyBuZXh0SWQ6IDIzNDIgfQ==" // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается первая страница.  Рекомендуем передавать значение выходного параметра :no-translate[`nextPageToken`], полученное при последнем запросе.  Если задан :no-translate[`page_token`] и в запросе есть параметры :no-translate[`page`] и :no-translate[`pageSize`], они игнорируются.  (optional)
	limit := int32(20) // int32 | Количество значений на одной странице.  (optional)
	getSupplyRequestsRequest := *openapiclient.NewGetSupplyRequestsRequest() // GetSupplyRequestsRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupplyRequestsAPI.GetSupplyRequests(context.Background(), campaignId).PageToken(pageToken).Limit(limit).GetSupplyRequestsRequest(getSupplyRequestsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupplyRequestsAPI.GetSupplyRequests``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSupplyRequests`: GetSupplyRequestsResponse
	fmt.Fprintf(os.Stdout, "Response from `SupplyRequestsAPI.GetSupplyRequests`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
campaignId int64 Идентификатор кампании. Его можно узнать с помощью запроса :no-translate[GET campaigns] или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу: * Модули и :no-translate[API] → блок Передача данных Маркету. * Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Other Parameters

Other parameters are passed through a pointer to a apiGetSupplyRequestsRequest struct via the builder pattern

Name Type Description Notes

pageToken | string | Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуем передавать значение выходного параметра :no-translate[`nextPageToken`], полученное при последнем запросе. Если задан :no-translate[`page_token`] и в запросе есть параметры :no-translate[`page`] и :no-translate[`pageSize`], они игнорируются. | limit | int32 | Количество значений на одной странице. | getSupplyRequestsRequest | GetSupplyRequestsRequest | |

Return type

GetSupplyRequestsResponse

Authorization

ApiKey, OAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]