fakz9/ozon-api-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update December 17, 2024 (#129)

Browse Source
This commit is contained in:
Kirill
2025-01-10 21:21:03 +03:00
committed by GitHub
parent 7f705a4eb5
commit 7654f5b7c5
2 changed files with 253 additions and 414 deletions
Download Patch File Download Diff File Expand all files Collapse all files

186
ozon/products.go
View File

@@ -105,28 +105,7 @@ func (c Products) GetStocksInfo(ctx context.Context, params *GetStocksInfoParams
return resp, nil
}
type GetProductDetailsParams struct {
// Product identifier in the seller's system
OfferId string `json:"offer_id,omitempty"`
// Product identifier
ProductId int64 `json:"product_id,omitempty"`
// Product identifier in the Ozon system, SKU
SKU int64 `json:"sku,omitempty"`
}
type GetProductDetailsResponse struct {
core.CommonResponse
// Request results
Result ProductDetails `json:"result"`
}
type ProductDetails struct {
// Barcode
Barcode string `json:"barcode"`
// All product barcodes
Barcodes []string `json:"barcodes"`
@@ -138,11 +117,20 @@ type ProductDetails struct {
// Category identifier
DescriptionCategoryId int64 `json:"description_category_id"`
// Markdown product stocks at the Ozon warehouse
DiscountedFBOStocks int32 `json:"discounted_fbo_stocks"`
// Details on errors when creating or validating a product
Errors []ProductDetailsError `json:"errors"`
// Indication that the product has similar markdown products at the Ozon warehouse
HasDiscountedFBOItem bool `json:"has_discounted_fbo_item"`
// Product type identifier
TypeId int64 `json:"type_id"`
// Marketing color
ColorImage string `json:"color_image"`
ColorImage []string `json:"color_image"`
// Commission fees details
Commissions []ProductDetailCommission `json:"commissions"`
@@ -166,7 +154,7 @@ type ProductDetails struct {
Images []string `json:"images"`
// Main product image
PrimaryImage string `json:"primary_image"`
PrimaryImage []string `json:"primary_image"`
// Array of 360 images
Images360 []string `json:"images360"`
@@ -260,20 +248,112 @@ type ProductDetails struct {
// 'true' if the item is archived automatically.
IsArchivedAuto bool `json:"is_autoarchived"`
// Product status details
Statuses ProductDetailsStatus `json:"statuses"`
// Product model details
ModelInfo ProductDetailsModelInfo `json:"model_info"`
// Indication of a super product
IsSuper bool `json:"is_super"`
}
type ProductDetailsError struct {
// Characteristic identifier
AttributeId int64 `json:"attribute_id"`
// Error code
Code string `json:"code"`
// Field in which the error occurred
Field string `json:"field"`
// Error level description
Level string `json:"level"`
// Status of the product with the error
State string `json:"state"`
// Error description
Texts ProductDetailsErrorText `json:"texts"`
}
type ProductDetailsErrorText struct {
// Attribute name
AttributeName string `json:"attribute_name"`
// Error description
Description string `json:"description"`
// Error code in the Ozon system
HintCode string `json:"hint_code"`
// Error message
Message string `json:"message"`
// Short description of the error
ShortDescription string `json:"short_description"`
// Parameters in which the error occurred
Params []NameValue `json:"params"`
}
type NameValue struct {
Name string `json:"name"`
Value string `json:"value"`
}
type ProductDetailsStatus struct {
// true, if the product is created correctly
IsCreated bool `json:"is_created"`
// Moderation status
ModerateStatus string `json:"moderate_status"`
// Product status
Status string `json:"status"`
// Product status description
Description string `json:"status_description"`
// Status of the product where the error occurred
Failed string `json:"status_failed"`
// Product status name
Name string `json:"status_name"`
// Status description
Tooltip string `json:"status_tooltip"`
// Time of the last status change
UpdatedAt time.Time `json:"status_updated_at"`
// Validation status
ValidationStatus string `json:"validation_status"`
}
type ProductDetailsModelInfo struct {
// Number of products in the response
Count int64 `json:"count"`
// Identifier of the product model
ModelId int64 `json:"model_id"`
}
type ProductDetailCommission struct {
// Delivery cost
DeliveryAmount float64 `json:"deliveryAmount"`
DeliveryAmount float64 `json:"delivery_amount"`
// Commission percentage
Percent float64 `json:"percent"`
// Return cost
ReturnAmount float64 `json:"returnAmount"`
ReturnAmount float64 `json:"return_amount"`
// Sale scheme
SaleSchema string `json:"saleSchema"`
SaleSchema string `json:"sale_schema"`
// Commission fee amount
Value float64 `json:"value"`
@@ -286,8 +366,8 @@ type ProductDetailPriceIndex struct {
// Competitors' product price on Ozon
OzonIndexData ProductDetailPriceIndexOzon `json:"ozon_index_data"`
// Resulting price index of the product
PriceIndex string `json:"price_index"`
// Types of price index
ColorIndex string `json:"color_index"`
// Price of your product on other marketplaces
SelfMarketplaceIndexData ProductDetailPriceIndexSelfMarketplace `json:"self_marketplaces_index_data"`
@@ -365,25 +445,42 @@ type ProductDetailStatus struct {
}
type ProductDetailSource struct {
// Indication that the source is taken into account when calculating the market value
IsEnabled bool `json:"is_enabled"`
// Product creation date
CreatedAt time.Time `json:"created_at"`
// Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
// Link to the source
Source string `json:"source"`
// Package type
ShipmentType string `json:"shipment_type"`
// List of MOQs with products
QuantCode string `json:"quant_code"`
}
type ProductDetailStock struct {
// Supply expected
Coming int32 `json:"coming"`
// true, if there are stocks at the warehouses
HasStock bool `json:"has_stock"`
// Status of product stocks
Stocks []ProductDetailStockStock `json:"stocks"`
}
type ProductDetailStockStock struct {
// Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
// Currently at the warehouse
Present int32 `json:"present"`
// Reserved
Reserved int32 `json:"reserved"`
// Sales scheme
Source string `json:"source"`
}
type ProductDetailVisibilityDetails struct {
@@ -438,24 +535,6 @@ type GetProductDetailsResponseItemError struct {
OptionalDescriptionElements map[string]string `json:"optional_description_elements"`
}
// Get product details
//
// Check a minimum product price with all promotions applied in your personal account.
// The min_price parameter from the method response is in development and returns 0
func (c Products) GetProductDetails(ctx context.Context, params *GetProductDetailsParams) (*GetProductDetailsResponse, error) {
url := "/v2/product/info"
resp := &GetProductDetailsResponse{}
response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type UpdateStocksParams struct {
// Stock details
Stocks []UpdateStocksStock `json:"stocks"`
@@ -1374,11 +1453,6 @@ type ListProductsByIDsParams struct {
type ListProductsByIDsResponse struct {
core.CommonResponse
// Request results
Result ListProductsByIDsResult `json:"result"`
}
type ListProductsByIDsResult struct {
// Data array
Items []ProductDetails `json:"items"`
}
@@ -1389,7 +1463,7 @@ type ListProductsByIDsResult struct {
//
// For each shipment in the items array the fields match the ones recieved in the /v2/product/info method
func (c Products) ListProductsByIDs(ctx context.Context, params *ListProductsByIDsParams) (*ListProductsByIDsResponse, error) {
url := "/v2/product/info/list"
url := "/v3/product/info/list"
resp := &ListProductsByIDsResponse{}

427
ozon/products_test.go
View File

@@ -95,208 +95,6 @@ func TestGetStocksInfo(t *testing.T) {
}
}
func TestGetProductDetails(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetProductDetailsParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetProductDetailsParams{
ProductId: 137208233,
},
`{
"result": {
"id": 137208233,
"name": "Комплект защитных плёнок для X3 NFC. Темный хлопок",
"offer_id": "143210586",
"barcode": "",
"barcodes": [
"2335900005",
"7533900005"
],
"buybox_price": "",
"type_id": 0,
"created_at": "2021-10-21T15:48:03.529178Z",
"images": [
"https://cdn1.ozone.ru/s3/multimedia-5/6088931525.jpg",
"https://cdn1.ozone.ru/s3/multimedia-p/6088915813.jpg"
],
"has_discounted_item": true,
"is_discounted": true,
"discounted_stocks": {
"coming": 0,
"present": 0,
"reserved": 0
},
"currency_code": "RUB",
"description_category_id": 12,
"marketing_price": "",
"min_price": "",
"old_price": "",
"price": "590.0000",
"sources": [
{
"is_enabled": true,
"sku": 522759607,
"source": "fbo"
},
{
"is_enabled": true,
"sku": 522759608,
"source": "fbs"
}
],
"stocks": {
"coming": 0,
"present": 0,
"reserved": 0
},
"updated_at": "2023-02-09T06:46:44.152Z",
"vat": "0.0",
"visible": false,
"visibility_details": {
"has_price": true,
"has_stock": false,
"active_product": false
},
"price_indexes": {
"external_index_data": {
"minimal_price": "string",
"minimal_price_currency": "string",
"price_index_value": 0
},
"ozon_index_data": {
"minimal_price": "string",
"minimal_price_currency": "string",
"price_index_value": 0
},
"price_index": "WITHOUT_INDEX",
"self_marketplaces_index_data": {
"minimal_price": "string",
"minimal_price_currency": "string",
"price_index_value": 0
}
},
"commissions": [],
"volume_weight": 0.1,
"is_prepayment": false,
"is_prepayment_allowed": true,
"images360": [],
"is_kgt": false,
"color_image": "",
"primary_image": "https://cdn1.ozone.ru/s3/multimedia-p/6088931545.jpg",
"status": {
"state": "imported",
"state_failed": "imported",
"moderate_status": "",
"decline_reasons": [],
"validation_state": "pending",
"state_name": "Не продается",
"state_description": "Не создан",
"is_failed": true,
"is_created": false,
"state_tooltip": "",
"item_errors": [
{
"code": "error_attribute_values_empty",
"field": "attribute",
"attribute_id": 9048,
"state": "imported",
"level": "error",
"description": "Не заполнен обязательный атрибут. Иногда мы обновляем обязательные атрибуты или добавляем новые. Отредактируйте товар или загрузите новый XLS-шаблон с актуальными атрибутами. ",
"optional_description_elements": {},
"attribute_name": "Название модели"
},
{
"code": "error_attribute_values_empty",
"field": "attribute",
"attribute_id": 5076,
"state": "imported",
"level": "error",
"description": "Не заполнен обязательный атрибут. Иногда мы обновляем обязательные атрибуты или добавляем новые. Отредактируйте товар или загрузите новый XLS-шаблон с актуальными атрибутами. ",
"optional_description_elements": {},
"attribute_name": "Рекомендовано для"
},
{
"code": "error_attribute_values_empty",
"field": "attribute",
"attribute_id": 8229,
"state": "imported",
"level": "error",
"description": "Не заполнен обязательный атрибут. Иногда мы обновляем обязательные атрибуты или добавляем новые. Отредактируйте товар или загрузите новый XLS-шаблон с актуальными атрибутами. ",
"optional_description_elements": {},
"attribute_name": "Тип"
},
{
"code": "error_attribute_values_empty",
"field": "attribute",
"attribute_id": 85,
"state": "imported",
"level": "error",
"description": "Не заполнен обязательный атрибут. Иногда мы обновляем обязательные атрибуты или добавляем новые. Отредактируйте товар или загрузите новый XLS-шаблон с актуальными атрибутами. ",
"optional_description_elements": {},
"attribute_name": "Бренд"
}
],
"state_updated_at": "2021-10-21T15:48:03.927309Z"
},
"is_archived": false,
"is_autoarchived": false
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetProductDetailsParams{},
`{
"code": 16,
"message": "Client-Id and Api-Key headers are required"
}`,
},
}
for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetProductDetails(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetProductDetailsResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
if resp.StatusCode == http.StatusOK {
if resp.Result.Id != test.params.ProductId {
t.Errorf("Id of product in response is not equal product_id in request")
}
if resp.Result.OfferId == "" {
t.Errorf("Offer id cannot be empty")
}
if resp.Result.DescriptionCategoryId == 0 {
t.Errorf("Category id cannot be 0")
}
if resp.Result.CurrencyCode == "" {
t.Errorf("Currency code cannot be empty")
}
}
}
}
func TestUpdateStocks(t *testing.T) {
t.Parallel()
@@ -1364,61 +1162,75 @@ func TestListProductsByIDs(t *testing.T) {
OfferId: []string{"010", "23"},
},
`{
"result": {
"items": [
{
"id": 78712196,
"name": "Как выбрать детские музыкальные инструменты. Ксилофон, бубен, маракасы и другие инструменты для детей до 6 лет. Мастер-класс о раннем музыкальном развитии от Монтессори-педагога",
"offer_id": "010",
"barcode": "",
"barcodes": [
"2335900005",
"7533900005"
"string"
],
"buybox_price": "",
"description_category_id": 93726157,
"type_id": 0,
"created_at": "2021-06-03T03:40:05.871465Z",
"images": [],
"has_discounted_item": true,
"is_discounted": true,
"discounted_stocks": {
"coming": 0,
"present": 0,
"reserved": 0
},
"currency_code": "RUB",
"marketing_price": "",
"min_price": "",
"old_price": "1000.0000",
"price": "690.0000",
"sources": [
"color_image": [
"string"
],
"commissions": [
{
"is_enabled": true,
"sku": 269628393,
"source": "fbo"
},
{
"is_enabled": true,
"sku": 269628396,
"source": "fbs"
"delivery_amount": 0,
"percent": 0,
"return_amount": 0,
"sale_schema": "string",
"value": 0
}
],
"stocks": {
"coming": 0,
"present": 13,
"reserved": 0
},
"updated_at": "2023-02-09T06:46:44.152Z",
"vat": "0.0",
"visible": true,
"visibility_details": {
"has_price": false,
"has_stock": true,
"active_product": false,
"reasons": {}
"created_at": "2019-08-24T14:15:22Z",
"currency_code": "string",
"description_category_id": 0,
"discounted_fbo_stocks": 0,
"errors": [
{
"attribute_id": 0,
"code": "string",
"field": "string",
"level": "ERROR_LEVEL_UNSPECIFIED",
"state": "string",
"texts": {
"attribute_name": "string",
"description": "string",
"hint_code": "string",
"message": "string",
"params": [
{
"name": "string",
"value": "string"
}
],
"short_description": "string"
}
}
],
"has_discounted_fbo_item": true,
"id": 0,
"images": [
"string"
],
"images360": [
"string"
],
"is_archived": true,
"is_autoarchived": true,
"is_discounted": true,
"is_kgt": true,
"is_prepayment_allowed": true,
"is_super": true,
"marketing_price": "string",
"min_price": "string",
"model_info": {
"count": 0,
"model_id": 0
},
"name": "string",
"offer_id": "string",
"old_price": "string",
"price": "string",
"price_indexes": {
"color_index": "COLOR_INDEX_UNSPECIFIED",
"external_index_data": {
"minimal_price": "string",
"minimal_price_currency": "string",
@@ -1429,92 +1241,56 @@ func TestListProductsByIDs(t *testing.T) {
"minimal_price_currency": "string",
"price_index_value": 0
},
"price_index": "WITHOUT_INDEX",
"self_marketplaces_index_data": {
"minimal_price": "string",
"minimal_price_currency": "string",
"price_index_value": 0
}
},
"images360": [],
"is_kgt": false,
"color_image": "",
"primary_image": "https://cdn1.ozone.ru/s3/multimedia-y/6077810038.jpg",
"status": {
"state": "price_sent",
"state_failed": "",
"moderate_status": "approved",
"decline_reasons": [],
"validation_state": "success",
"state_name": "Продается",
"state_description": "",
"is_failed": false,
"is_created": true,
"state_tooltip": "",
"item_errors": [],
"state_updated_at": "2021-07-26T04:50:08.486697Z"
}
},
{
"id": 76723583,
"name": "Онлайн-курс по дрессировке собак \"Собака: инструкция по применению. Одинокий волк\"",
"offer_id": "23",
"barcode": "",
"buybox_price": "",
"created_at": "2021-05-26T20:26:07.565586Z",
"images": [],
"marketing_price": "",
"min_price": "",
"old_price": "12200.0000",
"price": "6100.0000",
"primary_image": [
"string"
],
"sources": [
{
"is_enabled": true,
"sku": 267684495,
"source": "fbo"
},
{
"is_enabled": true,
"sku": 267684498,
"source": "fbs"
"created_at": "2019-08-24T14:15:22Z",
"quant_code": "string",
"shipment_type": "SHIPMENT_TYPE_UNSPECIFIED",
"sku": 0,
"source": "string"
}
],
"stocks": {
"coming": 0,
"present": 19,
"reserved": 0
},
"updated_at": "2023-02-09T06:46:44.152Z",
"vat": "0.0",
"visible": true,
"visibility_details": {
"has_price": false,
"has_stock": true,
"active_product": false,
"reasons": {}
},
"price_index": "0.00",
"images360": [],
"is_kgt": false,
"color_image": "",
"primary_image": "https://cdn1.ozone.ru/s3/multimedia-v/6062554531.jpg",
"status": {
"state": "price_sent",
"state_failed": "",
"moderate_status": "approved",
"decline_reasons": [],
"validation_state": "success",
"state_name": "Продается",
"state_description": "",
"is_failed": false,
"statuses": {
"is_created": true,
"state_tooltip": "",
"item_errors": [],
"state_updated_at": "2021-05-31T12:35:09.714641Z"
}
"moderate_status": "string",
"status": "string",
"status_description": "string",
"status_failed": "string",
"status_name": "string",
"status_tooltip": "string",
"status_updated_at": "2019-08-24T14:15:22Z",
"validation_status": "string"
},
"stocks": {
"has_stock": true,
"stocks": [
{
"present": 0,
"reserved": 0,
"sku": 0,
"source": "string"
}
]
},
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"vat": "string",
"visibility_details": {
"has_price": true,
"has_stock": true
},
"volume_weight": 0
}
]
}`,
},
// Test No Client-Id or Api-Key
@@ -1544,17 +1320,6 @@ func TestListProductsByIDs(t *testing.T) {
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
if resp.StatusCode == http.StatusOK {
if len(resp.Result.Items) != len(test.params.OfferId) {
t.Errorf("Amount of offer ids in request and response are not equal")
}
if len(resp.Result.Items) > 0 {
if resp.Result.Items[0].OfferId != test.params.OfferId[0] {
t.Errorf("Offer ids in request and response are not equal")
}
}
}
}
}