2 Commits

Author SHA1 Message Date
diPhantxm
9effb88b5f add all methods for promotions 2023-03-20 01:24:54 +03:00
diPhantxm
533a2439de add remained methods for managing prices and stocks 2023-03-19 23:20:45 +03:00
5 changed files with 1684 additions and 14 deletions

View File

@@ -32,23 +32,23 @@
- [x] Information about product quantity
- [x] Stocks in seller's warehouses (FBS и rFBS)
- [x] Update prices
- [ ] Get product price information
- [ ] Get information about the markdown and the main product by the markdown product SKU
- [ ] Set a discount on a markdown product
- [x] Get product price information
- [x] Get information about the markdown and the main product by the markdown product SKU
- [x] Set a discount on a markdown product
## Promotions
- [x] Available promotions
- [ ] Products that can participate in a promotion
- [ ] Products in a promotion
- [x] Products that can participate in a promotion
- [x] Products in a promotion
- [x] Add products to promotion
- [ ] Remove products from promotion
- [ ] List of available Hot Sale promotions
- [ ] List of products participating in the Hot Sale promotion
- [ ] Add products to the Hot Sale promotion
- [ ] Remove product from the Hot Sale promotion
- [ ] List of discount requests
- [ ] Approve a discount request
- [ ] Decline a discount request
- [x] Remove products from promotion
- [x] List of available Hot Sale promotions
- [x] List of products participating in the Hot Sale promotion
- [x] Add products to the Hot Sale promotion
- [x] Remove product from the Hot Sale promotion
- [x] List of discount requests
- [x] Approve a discount request
- [x] Decline a discount request
## Brand certificates
- [ ] List of certified brands

View File

@@ -1283,7 +1283,7 @@ type GetDescriptionOfProductResponse struct {
// Product characteristic value
Value string `json:"value"`
} `json:"values"`
} `json:"attributes`
} `json:"attributes"`
} `json:"complex_attributes"`
// Depth
@@ -1714,3 +1714,293 @@ func (c Products) StatusOfUploadingActivationCodes(params *StatusOfUploadingActi
return resp, nil
}
type GetProductPriceInfoParams struct {
// Filter by product
Filter GetProductPriceInfoFilter `json:"filter"`
// Identifier of the last value on page.
//
// To get the next values, specify the recieved value in the next request in the `last_id` parameter
LastId string `json:"last_id"`
// Number of values per page. Minimum is 1, maximum is 1000
Limit int32 `json:"limit"`
}
type GetProductPriceInfoFilter struct {
// Filter by the `offer_id` parameter. It is possible to pass a list of values
OfferId []string `json:"offer_id"`
// Filter by the `product_id` parameter. It is possible to pass a list of up to 1000 values
ProductId []int64 `json:"product_id"`
// Filter by product visibility
Visibility string `json:"visibility" default:"ALL"`
}
type GetProductPriceInfoResponse struct {
core.CommonResponse
// Result
Result struct {
// Products list
Items []struct {
// Commissions information
Commissions struct {
// Last mile (FBO)
FBOLastMile float64 `json:"fbo_deliv_to_customer_amount"`
// Pipeline to (FBO)
FBOPipelineTo float64 `json:"fbo_direct_flow_trans_max_amount"`
// Pipeline from (FBO)
FBOPipelineFrom float64 `json:"fbo_direct_flow_trans_min_amount"`
// Order packaging fee (FBO)
FBOOrderPackagingFee float64 `json:"fbo_fulfillment_amount"`
// Return and cancellation fees (FBO)
FBOReturnCancellationFee float64 `json:"fbo_return_flow_amount"`
// Reverse logistics fee from (FBO)
FBOReverseLogisticsFeeFrom float64 `json:"fbo_return_flow_trans_min_amount"`
// Reverse logistics fee to (FBO)
FBOReverseLogisticsFeeTo float64 `json:"fbo_return_flow_trans_max_amount"`
// Last mile (FBS)
FBSLastMile float64 `json:"fbs_deliv_to_customer_amount"`
// Pipeline to (FBS)
FBSPipelineTo float64 `json:"fbs_direct_flow_trans_max_amount"`
// Pipeline from (FBS)
FBSPipelineFrom float64 `json:"fbs_direct_flow_trans_min_amount"`
// Shipment processing fee to (FBS)
FBSShipmentProcessingToFee float64 `json:"fbs_first_mile_min_amount"`
// Shipment processing fee from (FBS)
FBSShipmentProcessingFromFee float64 `json:"Shipment processing fee from (FBS)"`
// Return and cancellation fees, shipment processing (FBS)
FBSReturnCancellationProcessingFee float64 `json:"fbs_return_flow_amount"`
// Return and cancellation fees, pipeline to (FBS)
FBSReturnCancellationToFees float64 `json:"fbs_return_flow_trans_max_amount"`
// Return and cancellation fees, pipeline from (FBS)
FBSReturnCancellationFromFees float64 `json:"fbs_return_flow_trans_min_amount"`
// Sales commission percentage (FBO and FBS)
SalesCommissionRate float64 `json:"sales_percent"`
} `json:"commissions"`
// Promotions information
MarketingActions []struct {
// Seller's promotions. The parameters date_from, date_to, discount_value and title are specified for each seller's promotion
Actions []struct {
// Date and time when the seller's promotion starts
DateFrom time.Time `json:"date_from"`
// Date and time when the seller's promotion ends
DateTo time.Time `json:"date_to"`
// Discount on the seller's promotion
DiscountValue string `json:"discount_value"`
// Promotion name
Title string `json:"title"`
} `json:"actions"`
// Current period start date and time for all current promotions
CurrentPeriodFrom time.Time `json:"current_period_from"`
// Current period end date and time for all current promotions
CurrentPeriodTo time.Time `json:"current_period_to"`
// If a promotion can be applied to the product at the expense of Ozon, this field is set to true
OzonActionsExist bool `json:"ozon_actions_exist"`
} `json:"marketing_actions"`
// Seller product identifier
OfferId string `json:"offer_id"`
// Product price
Price struct {
// If promos auto-application is enabled, the value is true
AutoActionEnabled bool `json:"auto_action_enabled"`
// Currency of your prices. It matches the currency set in the personal account settings
CurrencyCode string `json:"currency_code"`
// Product price including all promotion discounts. This value will be indicated on the Ozon storefront
MarketingPrice string `json:"marketing_price"`
// Product price with seller's promotions applied
MarketingSellerPrice string `json:"marketing_seller_price"`
// Minimum price for similar products on Ozon
MinOzonPrice string `json:"min_ozon_price"`
// Minimum product price with all promotions applied
MinPrice string `json:"min_price"`
// Price before discounts. Displayed strikethrough on the product description page
OldPrice string `json:"old_price"`
// Price for customers with an Ozon Premium subscription
PremiumPrice string `json:"premium_price"`
// Product price including discounts. This value is shown on the product description page
Price string `json:"price"`
// Product price suggested by the system based on similar offers
RecommendedPrice string `json:"recommended_price"`
// Retailer price
RetailPrice string `json:"retail_price"`
// Product VAT rate
VAT string `json:"vat"`
} `json:"price"`
// Price index
PriceIndex string `json:"price_index"`
// Product identifier
ProductId int64 `json:"product_id"`
// Product volume weight
VolumeWeight float64 `json:"volume_weight"`
} `json:"items"`
// Identifier of the last value on page. Leave this field blank in the first request.
//
// To get the next values, specify last_id from the response of the previous request
LastId string `json:"last_id"`
// Products number in the list
Total int32 `json:"total"`
} `json:"result"`
}
// You can specify up to 1000 products in the request
func (c Products) GetProductPriceInfo(params *GetProductPriceInfoParams) (*GetProductPriceInfoResponse, error) {
url := "/v4/product/info/prices"
resp := &GetProductPriceInfoResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type GetMarkdownInfoParams struct {
// Markdown products SKUs list
DiscountedSKUs []string `json:"discounted_skus"`
}
type GetMarkdownInfoResponse struct {
core.CommonResponse
// Information about the markdown and the main product
Items []struct{
// Comment on the damage reason
CommentReasonDamaged string `json:"comment_reason_damaged"`
// Product condition: new or used
Condition string `json:"condition"`
// Product condition on a 1 to 7 scale.
// - 1 — satisfactory,
// - 2 — good,
// - 3 — very good,
// - 4 — excellent,
// - 57 — like new
ConditionEstimate string `json:"condition_estimate"`
// Product defects
Defects string `json:"defects"`
// Markdown product SKU
DiscountedSKU int64 `json:"discounted_sku"`
// Mechanical damage description
MechanicalDamage string `json:"mechanical_damage"`
// Packaging damage description
PackageDamage string `json:"package_damage"`
// Indication of package integrity damage
PackagingViolation string `json:"packaging_violation"`
// Damage reason
ReasonDamaged string `json:"reason_damaged"`
// Indication of repaired product
Repair string `json:"repair"`
// Indication that the product is incomplete
Shortage string `json:"shortage"`
// Main products SKU
SKU int64 `json:"sku"`
// Indication that the product has a valid warranty
WarrantyType string `json:"warranty_type"`
} `json:"items"`
}
// Get information about the markdown and the main product by the markdown product SKU
//
// A method for getting information about the condition and defects of a markdown product by its SKU.
// The method also returns the SKU of the main product
func (c Products) GetMarkdownInfo(params *GetMarkdownInfoParams) (*GetMarkdownInfoResponse, error) {
url := "/v1/product/info/discounted"
resp := &GetMarkdownInfoResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type SetDiscountOnMarkdownProductParams struct{
// Discount amount: from 3 to 99 percents
Discount int32 `json:"discount"`
// Product identifier
ProductId int64 `json:"product_id"`
}
type SetDiscountOnMarkdownProductResponse struct{
core.CommonResponse
// Method result. true if the query was executed without errors
Result bool `json:"result"`
}
// A method for setting the discount percentage on markdown products sold under the FBS scheme
func (c Products) SetDiscountOnMarkdownProduct(params *SetDiscountOnMarkdownProductParams) (*SetDiscountOnMarkdownProductResponse, error) {
url := "/v1/product/update/discount"
resp := &SetDiscountOnMarkdownProductResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}

View File

@@ -2197,3 +2197,213 @@ func TestStatusOfUploadingActivationCodes(t *testing.T) {
}
}
}
func TestGetProductPriceInfo(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetProductPriceInfoParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetProductPriceInfoParams{
Filter: GetProductPriceInfoFilter{
OfferId: []string{"356792"},
ProductId: []int64{243686911},
Visibility: "ALL",
},
},
`{
"result": {
"items": [
{
"product_id": 243686911,
"offer_id": "356792",
"price": {
"currency_code": "RUB",
"price": "499.0000",
"old_price": "579.0000",
"premium_price": "",
"recommended_price": "",
"retail_price": "",
"vat": "0.200000",
"min_ozon_price": "",
"marketing_price": "",
"marketing_seller_price": "",
"auto_action_enabled": true
},
"price_index": "0.00",
"commissions": {
"sales_percent": 15,
"fbo_fulfillment_amount": 0,
"fbo_direct_flow_trans_min_amount": 31,
"fbo_direct_flow_trans_max_amount": 46.5,
"fbo_deliv_to_customer_amount": 14.75,
"fbo_return_flow_amount": 50,
"fbo_return_flow_trans_min_amount": 21.7,
"fbo_return_flow_trans_max_amount": 21.7,
"fbs_first_mile_min_amount": 0,
"fbs_first_mile_max_amount": 0,
"fbs_direct_flow_trans_min_amount": 41,
"fbs_direct_flow_trans_max_amount": 61.5,
"fbs_deliv_to_customer_amount": 60,
"fbs_return_flow_amount": 40,
"fbs_return_flow_trans_min_amount": 41,
"fbs_return_flow_trans_max_amount": 61.5
},
"marketing_actions": null,
"volume_weight": 0
}
],
"total": 1,
"last_id": "ceVуbA=="
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetProductPriceInfoParams{},
`{
"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))
resp, err := c.Products().GetProductPriceInfo(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetMarkdownInfo(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetMarkdownInfoParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetMarkdownInfoParams{
DiscountedSKUs: []string{"635548518"},
},
`{
"items": [
{
"discounted_sku": 635548518,
"sku": 320067758,
"condition_estimation": "4",
"packaging_violation": "",
"warranty_type": "",
"reason_damaged": "Механическое повреждение",
"comment_reason_damaged": "повреждена заводская упаковка",
"defects": "",
"mechanical_damage": "",
"package_damage": "",
"shortage": "",
"repair": "",
"condition": ""
}
]
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetMarkdownInfoParams{},
`{
"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))
resp, err := c.Products().GetMarkdownInfo(test.params)
if err != nil {
t.Error(err)
}
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.Items) > 0 {
if fmt.Sprint(resp.Items[0].DiscountedSKU) != test.params.DiscountedSKUs[0] {
t.Errorf("SKUs in reqest and resonse are not equal")
}
}
}
}
}
func TestSetDiscountOnMarkdownProductParams(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *SetDiscountOnMarkdownProductParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&SetDiscountOnMarkdownProductParams{
Discount: 0,
ProductId: 0,
},
`{
"result": true
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&SetDiscountOnMarkdownProductParams{},
`{
"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))
resp, err := c.Products().SetDiscountOnMarkdownProduct(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}

View File

@@ -2,6 +2,7 @@ package ozon
import (
"net/http"
"time"
core "github.com/diphantxm/ozon-api-client"
)
@@ -136,3 +137,543 @@ func (c Promotions) AddToPromotion(params *AddProductToPromotionParams) (*AddPro
return resp, nil
}
type ProductsAvailableForPromotionParams struct {
// Promotion identifier
ActionId float64 `json:"action_id"`
// Number of values in the response. The default value is 100
Limit float64 `json:"limit"`
// Number of elements that will be skipped in the response.
// For example, if offset=10, the response will start with the 11th element found
Offset float64 `json:"offset"`
}
type ProductsAvailableForPromotionResponse struct {
core.CommonResponse
// Method result
Result struct {
// Products list
Products []PromotionProduct `json:"products"`
// Total number of products that can participate in the promotion
Total float64 `json:"total"`
} `json:"result"`
}
type PromotionProduct struct {
// Product identifier
Id float64 `json:"id"`
// Current product price without a discount
Price float64 `json:"price"`
// Promotional product price
ActionPrice float64 `json:"action_price"`
// Maximum possible promotional product price
MaxActionType float64 `json:"max_action_type"`
// Type of adding a product to the promotion: automatically or manually by the seller
AddMode string `json:"add_mode"`
// Minimum number of product units in a stock discount type promotion
MinStock float64 `json:"min_stock"`
// Number of product units in a stock discount type promotion
Stock float64 `json:"stock"`
}
// A method for getting a list of products that can participate in the promotion by the promotion identifier
func (c Promotions) ProductsAvailableForPromotion(params *ProductsAvailableForPromotionParams) (*ProductsAvailableForPromotionResponse, error) {
url := "/v1/actions/candidates"
resp := &ProductsAvailableForPromotionResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type ProductsInPromotionParams struct {
// Promotion identifier
ActionId float64 `json:"action_id"`
// Number of values in the response. The default value is 100
Limit float64 `json:"limit"`
// Number of elements that will be skipped in the response. For example, if offset=10, the response will start with the 11th element found
Offset float64 `json:"offset"`
}
type ProductsInPromotionResponse struct {
core.CommonResponse
// Method result
Result struct {
// Products list
Products []PromotionProduct `json:"products"`
// Total number of products that can participate in the promotion
Total float64 `json:"total"`
} `json:"reuslt"`
}
// A method for getting the list of products participating in the promotion by its identifier
func (c Promotions) ProductsInPromotion(params *ProductsInPromotionParams) (*ProductsInPromotionResponse, error) {
url := "/v1/actions/products"
resp := &ProductsInPromotionResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type RemoveProductFromPromotionParams struct {
// Promotion identifier
ActionId float64 `json:"action_id"`
// List of products identifiers
ProductIds []float64 `json:"product_ids"`
}
type RemoveProductFromPromotionResponse struct {
core.CommonResponse
// Method result
Result struct {
// List of product identifiers that were removed from the promotion
ProductIds []float64 `json:"product_ids"`
// List of product identifiers that weren't removed from the promotion
Rejected []struct {
// Product identifier
ProductId float64 `json:"product_id"`
// Reason why the product wasn't removed from the promotion
Reason string `json:"reason"`
} `json:"rejected"`
} `json:"result"`
}
// A method for removing products from the promotion
func (c Promotions) RemoveProduct(params *RemoveProductFromPromotionParams) (*RemoveProductFromPromotionResponse, error) {
url := "/v1/actions/products/deactivate"
resp := &RemoveProductFromPromotionResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type ListHotSalePromotionsResponse struct {
core.CommonResponse
// Method result
Result []struct {
// Promotion end date
DateEnd string `json:"date_end"`
// Promotion start date
DateStart string `json:"date_start"`
// Promotion description
Description string `json:"description"`
// Promotion freeze date.
//
// If the field is filled, the seller can't increase prices, change the list of products,
// or decrease the number of product units in the promotion.
//
// The seller can lower prices and increase the product units number in the promotion
FreezeDate string `json:"freeze_date"`
// Hot Sale promotion identifier
HotsaleId float64 `json:"hotsale_id"`
// Indication that you participate in this promotion
IsParticipating bool `json:"is_participating"`
// Promotion name
Title string `json:"title"`
} `json:"result"`
}
// List of available Hot Sale promotions
func (c Promotions) ListHotSalePromotions() (*ListHotSalePromotionsResponse, error) {
url := "/v1/actions/hotsales/list"
resp := &ListHotSalePromotionsResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type ProductsAvailableForHotSalePromotionParams struct {
// Hot Sale promotion identifier
HotSaleId float64 `json:"hotsale_id"`
// Number of elements in the response. Default value is 100
Limit float64 `json:"limit"`
// Number of elements that will be skipped in the response. For example, if offset=10, the response will start with the 11th element found
Offset float64 `json:"offset"`
}
type ProductsAvailableForHotSalePromotionResponse struct {
core.CommonResponse
// Method result
Result struct {
// Products list
Products []struct {
// Promotional product price
ActionPrice float64 `json:"action_price"`
// Date when the product participates in the promotion in the YYYY-MM-DD format
DateDayPromo string `json:"date_day_promo"`
// Product identifier
Id float64 `json:"id"`
// Indication that product participates in the promotion
IsActive bool `json:"is_active"`
// Maximum possible promotional price of the product
MaxActionPrice float64 `json:"max_action_type"`
// Minimum number of product units in a stock discount type promotion
MinStock float64 `json:"min_stock"`
// Number of product units in a stock discount type promotion
Stock float64 `json:"stock"`
} `json:"products"`
// Total number of products that are available for the promotion
Total float64 `json:"total"`
} `json:"result"`
}
// Method for getting a list of products that can participate or are already participating in the Hot Sale promotion
func (c Promotions) ProductsAvailableForHotSalePromotion(params *ProductsAvailableForHotSalePromotionParams) (*ProductsAvailableForHotSalePromotionResponse, error) {
url := "/v1/actions/hotsales/products"
resp := &ProductsAvailableForHotSalePromotionResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type AddProductsToHotSaleParams struct {
// Hot Sale promotion identifier
HotSaleId float64 `json:"hotsale_id"`
// Products to be added to the promotion. The maximum number in one request is 100
Products []AddProductsToHotSaleProduct `json:"products"`
}
type AddProductsToHotSaleProduct struct {
// Promotional product price
ActionPrice float64 `json:"action_price"`
// Product identifier
ProductId float64 `json:"product_id"`
// Number of product units in a stock discount type promotion
Stock float64 `json:"stock"`
}
type ProductsToHotSaleResponse struct {
core.CommonResponse
// Method result
Result struct {
// List of products that haven't been added to the promotion
Rejected []struct {
//Product identifier
ProductId float64 `json:"product_id"`
// Reason why the product hasn't been added to the promotion
Reason string `json:"reason"`
} `json:"rejected"`
} `json:"result"`
}
func (c Promotions) AddProductsToHotSale(params *AddProductsToHotSaleParams) (*ProductsToHotSaleResponse, error) {
url := "/v1/actions/hotsales/activate"
resp := &ProductsToHotSaleResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type RemoveProductsToHotSaleParams struct {
// Hot Sale promotion identifier
HotSaleId float64 `json:"hotsale_id"`
// List of products identifiers. Maximum number of values in one request is 100
ProductIds []float64 `json:"product_ids"`
}
// Remove product from the Hot Sale promotion
func (c Promotions) RemoveProductsToHotSale(params *RemoveProductsToHotSaleParams) (*ProductsToHotSaleResponse, error) {
url := "/v1/actions/hotsales/activate"
resp := &ProductsToHotSaleResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type ListDiscountRequestsParams struct {
// Discount request status
Status string `json:"status" default:"UNKNOWN"`
// Page number from which you want to download the list of discount requests
Page uint64 `json:"page"`
// The maximum number of requests on a page
Limit uint64 `json:"limit"`
}
type ListDiscountRequestsResponse struct {
core.CommonResponse
// List of requests
Result []struct {
// Request ID
Id uint64 `json:"id"`
// Request created date
CreatedAt time.Time `json:"created_at"`
// End time of the request
EndAt time.Time `json:"end_at"`
// Time to change the decision
EditedTill time.Time `json:"edited_till"`
// Request status
Status string `json:"status"`
// Customer's name
CustomerName string `json:"customer_name"`
// Product identifier in the Ozon system, SKU
SKU uint64 `json:"sku"`
// Customer's comment on the request
UserComment string `json:"user_comment"`
// Seller's comment on the request
SellerComment string `json:"seller_comment"`
// Requested price
RequestedPrice float64 `json:"requested_price"`
// Approved price
ApprovedPrice float64 `json:"approved_price"`
// Product price before all discounts
OriginalPrice float64 `json:"original_price"`
// Discount in rubles
Discount float64 `json:"discount"`
// Discount percentage
DiscountPercent float64 `json:"discount_percent"`
// Base price at which a product is selling on Ozon, if not eligible for a promotion
BasePrice float64 `json:"base_price"`
// The minimum price after auto-application of discounts and promotions
MinAutoPrice float64 `json:"min_auto_price"`
// ID of the previous customer request for this product
PrevTaskId uint64 `json:"prev_task_id"`
// If product is damaged — true
IsDamaged bool `json:"is_damaged"`
// Moderation date: review, approval or decline of the request
ModeratedAt time.Time `json:"moderated_at"`
// Discount in rubles approved by the seller. Pass the value 0 if the seller did not approve the request
ApprovedDiscount float64 `json:"approved_discount"`
// Discount percentage approved by the seller. Pass the value 0 if the seller did not approve the request
ApprovedDiscountPercent float64 `json:"approved_discount_percent"`
// Whether the customer has purchased the product. true if purchased
IsPurchased bool `json:"is_purchased"`
// Whether the request was moderated automatically. true if moderation was automatic
IsAutoModerated bool `json:"is_auto_moderated"`
// Product identifier in the seller's system
OfferId string `json:"offer_id"`
// Email of the user who processed the request
Email string `json:"email"`
// Last name of the user who processed the request
LastName string `json:"last_name"`
// First name of the user who processed the request
FirstName string `json:"first_name"`
// Patronymic of the user who processed the request
Patronymic string `json:"patronymic"`
// Approved minimum quantity of products
ApprovedQuantityMin uint64 `json:"approved_quantity_min"`
// Approved maximum quantity of products
ApprovedQuantityMax uint64 `json:"approved_quantity_max"`
// Requested minimum number of products
RequestedQuantityMin uint64 `json:"requested_quantity_min"`
// Requested maximum number of products
RequestedQuantityMax uint64 `json:"requested_quantity_max"`
// Requested price with fee
RequestedPriceWithFee float64 `json:"requested_price_with_fee"`
// Approved price with fee
ApprovedPriceWithFee float64 `json:"approved_price_with_fee"`
// Approved price fee percent
ApprovedPriceFeePercent float64 `json:"approved_price_fee_percent"`
} `json:"result"`
}
// Method for getting a list of products that customers want to buy with discount
func (c Promotions) ListDiscountRequests(params *ListDiscountRequestsParams) (*ListDiscountRequestsResponse, error) {
url := "/v1/actions/discounts-task/list"
resp := &ListDiscountRequestsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type DiscountRequestParams struct {
// List of discount requests
Tasks []DiscountRequestTask `json:"tasks"`
}
type DiscountRequestTask struct {
// Request ID
Id uint64 `json:"id"`
// Approved price
ApprovedPrice float64 `json:"approved_price"`
// Seller's comment on the request
SellerComment string `json:"seller_comment"`
// Approved minimum quantity of products
ApprovedQuantityMin uint64 `json:"approved_quantity_min"`
// Approved maximum quantity of products
ApprovedQuantityMax uint64 `json:"approved_quantity_max"`
}
type DiscountRequestResponse struct {
core.CommonResponse
// Method result
Result struct {
// Errors when creating a request
FailDetails []struct {
// Request ID
TaskId uint64 `json:"task_id"`
// Error message
ErrorForUser string `json:"error_for_user"`
} `json:"fail_details"`
// The number of requests with a successful status change
SuccessCount int32 `json:"success_count"`
// The number of requests that failed to change their status
FailCount int32 `json:"fail_count"`
} `json:"result"`
}
// You can approve applications in statuses:
// - NEW — new
// - SEEN — viewed
func (c Promotions) ApproveDiscountRequest(params *DiscountRequestParams) (*DiscountRequestResponse, error) {
url := "/v1/actions/discounts-task/approve"
resp := &DiscountRequestResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
// You can decline applications in statuses:
// - NEW—new
// - SEEN—viewed
func (c Promotions) DeclineDiscountRequest(params *DiscountRequestParams) (*DiscountRequestResponse, error) {
url := "/v1/actions/discounts-task/decline"
resp := &DiscountRequestResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}

View File

@@ -141,3 +141,632 @@ func TestAddToPromotion(t *testing.T) {
}
}
}
func TestProductsAvailableForPromotion(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ProductsAvailableForPromotionParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ProductsAvailableForPromotionParams{
ActionId: 63337,
Limit: 10,
Offset: 0,
},
`{
"result": {
"products": [
{
"id": 226,
"price": 250,
"action_price": 0,
"max_action_price": 175,
"add_mode": "NOT_SET",
"stock": 0,
"min_stock": 0
},
{
"id": 1366,
"price": 2300,
"action_price": 630,
"max_action_price": 770,
"add_mode": "MANUAL",
"stock": 0,
"min_stock": 0
}
],
"total": 2
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ProductsAvailableForPromotionParams{},
`{
"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))
resp, err := c.Promotions().ProductsAvailableForPromotion(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestProductsInPromotion(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ProductsInPromotionParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ProductsInPromotionParams{
ActionId: 66011,
Limit: 10,
Offset: 0,
},
`{
"result": {
"products": [
{
"id": 1383,
"price": 5503,
"action_price": 621,
"max_action_price": 3712.1,
"add_mode": "MANUAL",
"stock": 0,
"min_stock": 0
}
],
"total": 1
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ProductsInPromotionParams{},
`{
"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))
resp, err := c.Promotions().ProductsInPromotion(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestRemoveProduct(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *RemoveProductFromPromotionParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&RemoveProductFromPromotionParams{
ActionId: 66011,
ProductIds: []float64{14975},
},
`{
"result": {
"product_ids": [
14975
],
"rejected": []
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&RemoveProductFromPromotionParams{},
`{
"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))
resp, err := c.Promotions().RemoveProduct(test.params)
if err != nil {
t.Error(err)
}
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.ProductIds) > 0 {
if resp.Result.ProductIds[0] != test.params.ProductIds[0] {
t.Errorf("Product ids in request and response are not equal")
}
}
}
}
}
func TestListHotSalePromotions(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
`{
"result": [
{
"date_end": "string",
"date_start": "string",
"description": "string",
"freeze_date": "string",
"hotsale_id": 0,
"is_participating": true,
"title": "string"
}
]
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
`{
"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))
resp, err := c.Promotions().ListHotSalePromotions()
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestProductsAvailableForHotSalePromotion(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ProductsAvailableForHotSalePromotionParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ProductsAvailableForHotSalePromotionParams{
HotSaleId: 0,
Limit: 0,
Offset: 0,
},
`{
"result": {
"products": [
{
"action_price": 0,
"date_day_promo": "string",
"id": 0,
"is_active": true,
"max_action_price": 0,
"min_stock": 0,
"stock": 0
}
],
"total": 0
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ProductsAvailableForHotSalePromotionParams{},
`{
"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))
resp, err := c.Promotions().ProductsAvailableForHotSalePromotion(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestAddProductsToHotSale(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *AddProductsToHotSaleParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&AddProductsToHotSaleParams{
HotSaleId: 1234,
Products: []AddProductsToHotSaleProduct{
{
ActionPrice: 12,
ProductId: 111,
Stock: 45,
},
},
},
`{
"result": {
"rejected": [
{
"product_id": 0,
"reason": "string"
}
]
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&AddProductsToHotSaleParams{},
`{
"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))
resp, err := c.Promotions().AddProductsToHotSale(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestRemoveProductsToHotSale(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *RemoveProductsToHotSaleParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&RemoveProductsToHotSaleParams{
HotSaleId: 12345,
ProductIds: []float64{111},
},
`{
"result": {
"rejected": [
{
"product_id": 0,
"reason": "string"
}
]
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&RemoveProductsToHotSaleParams{},
`{
"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))
resp, err := c.Promotions().RemoveProductsToHotSale(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestListDiscountRequests(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ListDiscountRequestsParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ListDiscountRequestsParams{
Status: "UNKNOWN",
Page: 0,
Limit: 100,
},
`{
"result": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z",
"edited_till": "2019-08-24T14:15:22Z",
"status": "string",
"customer_name": "string",
"sku": 0,
"user_comment": "string",
"seller_comment": "string",
"requested_price": 0,
"approved_price": 0,
"original_price": 0,
"discount": 0,
"discount_percent": 0,
"base_price": 0,
"min_auto_price": 0,
"prev_task_id": 0,
"is_damaged": true,
"moderated_at": "2019-08-24T14:15:22Z",
"approved_discount": 0,
"approved_discount_percent": 0,
"is_purchased": true,
"is_auto_moderated": true,
"offer_id": "string",
"email": "string",
"last_name": "string",
"first_name": "string",
"patronymic": "string",
"approved_quantity_min": 0,
"approved_quantity_max": 0,
"requested_quantity_min": 0,
"requested_quantity_max": 0,
"requested_price_with_fee": 0,
"approved_price_with_fee": 0,
"approved_price_fee_percent": 0
}
]
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ListDiscountRequestsParams{},
`{
"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))
resp, err := c.Promotions().ListDiscountRequests(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestApproveDiscountRequest(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *DiscountRequestParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&DiscountRequestParams{
Tasks: []DiscountRequestTask{
{
Id: 123,
ApprovedPrice: 11,
SellerComment: "string",
ApprovedQuantityMin: 1,
ApprovedQuantityMax: 2,
},
},
},
`{
"result": {
"fail_details": [
{
"task_id": 1234,
"error_for_user": "string"
}
],
"success_count": 1,
"fail_count": 1
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&DiscountRequestParams{},
`{
"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))
resp, err := c.Promotions().ApproveDiscountRequest(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestDeclineDiscountRequest(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *DiscountRequestParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&DiscountRequestParams{
Tasks: []DiscountRequestTask{
{
Id: 123,
ApprovedPrice: 11,
SellerComment: "string",
ApprovedQuantityMin: 1,
ApprovedQuantityMax: 2,
},
},
},
`{
"result": {
"fail_details": [
{
"task_id": 1234,
"error_for_user": "string"
}
],
"success_count": 1,
"fail_count": 1
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&DiscountRequestParams{},
`{
"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))
resp, err := c.Promotions().DeclineDiscountRequest(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}