57 Commits

Author SHA1 Message Date
Kirill
1494ff5905 Better tests (check that response match the structure) (#52)
Trailing zeros were removed from time in responses because of json marshaling features
2023-12-11 03:19:12 +03:00
Kirill
922e2de8b0 Update December 7, 2023 (#51) 2023-12-09 16:05:52 +03:00
Kirill
af7c167edf Update November 30, 2023 (#50)
Method for RFBS returns operations
2023-11-30 18:16:34 +03:00
Kirill
ba8f4ca1b2 Update November 9, 2023 (#49) 2023-11-11 16:05:36 +03:00
Kirill
52b18252b1 Update November 8, 2023 (#48) 2023-11-11 15:37:26 +03:00
Kirill
b496767c5b Update October 30, 2023 (#47) 2023-10-31 01:44:56 +03:00
Kirill
40dd5b86a8 Update October 26, 2023 (#46) 2023-10-27 20:06:33 +03:00
Antares
e5f2007a8e Fix fields in Finance methods (#45)
Fixed operation type field in getting transaction list
Fixed fields in params for getting finance realization report
2023-10-26 14:48:31 +03:00
Kirill
40d9fc32cb Update October 19, 2023 (#44) 2023-10-20 00:58:22 +03:00
Kirill
b07968d280 update/6-october-2023 - New Categories' methods version (#43) 2023-10-08 19:02:14 +03:00
Kirill
699d210296 update/4-october-2023 - Barcodes (#42) 2023-10-08 18:27:39 +03:00
Kirill
07d38a8456 remove deprecated method Delete Polygon (#41) 2023-09-05 23:11:43 +03:00
Kirill
0f1d0410bc update some methods description (#40) 2023-09-05 23:06:04 +03:00
Kirill
6d4d97e3c8 added comments on restrictions for seller without Premium subscription (#39) 2023-08-25 16:38:38 +03:00
Kirill
85543f45b0 update comments on price in Update Price params (#38) 2023-08-25 16:36:25 +03:00
Kirill
854d110ab1 Configure HttpClient, added context parameter to all methods (#37)
Context is needed to limit time of execution of a method. Previously, context was passed to structure and it was stored inside structure which is a bad practice. Now we need to pass context to function, which is a best practice
2023-08-05 13:50:34 +03:00
Kirill
018d40e641 Update August 2, 2023 (#34) 2023-08-03 21:02:08 +03:00
Kirill
72b25b673d fix tests (#33) 2023-08-02 01:57:08 +03:00
Kirill
cb24f19e83 fbs_sku and fbo_sku are now just sku (#32) 2023-08-02 01:19:21 +03:00
Kirill
588f4748a9 Update 28 July, 2023 (#31) 2023-07-31 00:20:07 +03:00
Kirill
651c39595f add tests for notification server errors (#30) 2023-07-29 02:59:03 +03:00
Kirill
6c1a5e35c0 enhance tests for notification server
enhance tests for notification server
2023-07-29 01:37:01 +03:00
diPhantxm
580a752012 enhance tests for notification server 2023-07-29 01:29:38 +03:00
diPhantxm
83fd8cf825 fix examlpe for notification server 2023-07-27 03:20:32 +03:00
Kirill
ebbc21b618 Notification Server
Push-Notifications
2023-07-27 02:51:36 +03:00
diPhantxm
f53b573d62 fix tests 2023-07-27 02:49:55 +03:00
diPhantxm
eb0ce6feb6 update readme 2023-07-27 00:44:36 +03:00
diPhantxm
9a41bb1196 add notification server, tests 2023-07-27 00:23:47 +03:00
diPhantxm
e76b9f3961 add notification server message types 2023-07-26 04:18:24 +03:00
diPhantxm
add4202b3e added new response fields to GetProductPriceInfo: result.items.acquiring, result.items.commissions.sales_percent_fbo/fbs 2023-07-25 17:41:27 +03:00
diPhantxm
7beee39eb2 Added the prices.price_strategy_enabled parameter to the method request 2023-07-20 02:48:09 +03:00
diPhantxm
baeeef9b46 fix json names for GetDigitalActResponse 2023-07-15 03:02:45 +03:00
diPhantxm
336c49baa4 Added the response example to TestGetLabeling 2023-07-15 03:02:45 +03:00
diPhantxm
f11ccb4714 updated the schemas and examples for method responses: methods return the result in binary format 2023-07-15 03:02:45 +03:00
diPhantxm
1958dfb94e Added a method for getting a barcode from the /v2/posting/fbs/act/get-barcode response in text format 2023-07-12 19:14:48 +03:00
diPhantxm
2ca20d9b12 Added a method for getting a barcode used during product shipment 2023-07-12 19:14:48 +03:00
Anton Salnikov
eea0f99066 Change address field tag 2023-07-09 19:54:28 +03:00
diPhantxm
7adaa92ad4 Specify enum values for status in GetFBOReturns method 2023-07-06 19:48:33 +03:00
diPhantxm
f54aa64b63 Update GetFBSReturns to v3. Add exemplar_id and return_barcode fields to method reponse 2023-07-06 19:39:54 +03:00
diPhantxm
e7c5dc320e fix params field in GetReportsListResultReport 2023-06-24 02:06:18 +03:00
diPhantxm
006ecdf877 commmented all data types and methods 2023-06-23 23:23:23 +03:00
diPhantxm
f81e4ed350 flat structures 2023-06-23 20:57:38 +03:00
Kirill
e7290069f5 Create LICENSE
Add MIT License
2023-06-20 23:33:02 +03:00
diphantxm
422f959b9f add prr option to some methods 2023-06-16 21:52:49 +03:00
diphantxm
ac99c5ba2f added new status to getting act list filter, updated descriptions, changed test according to examples 2023-06-16 21:35:33 +03:00
diPhantxm
e60a3f1ca2 add method for getting ozon warehouses workload 2023-06-02 18:55:45 +03:00
diPhantxm
2f1dbd5c00 add method for updating product characteristics 2023-06-02 18:55:33 +03:00
diPhantxm
387af0e30e add pricing strategy methods 2023-04-24 01:03:24 +03:00
diPhantxm
c1e7f2b370 add optional paramter with_details to request and details to response in GetFinancial in reports 2023-04-24 01:03:24 +03:00
diPhantxm
a1c92ae26f change price index to multiple indexes in product/info/prices 2023-04-12 01:32:24 +03:00
diPhantxm
08180d901c update posting methods status/substatus, changed price index to multiple indexes in products responses 2023-04-12 01:32:24 +03:00
diPhantxm
838f28d3d9 fix 2023-04-11 23:20:46 +03:00
diPhantxm
226f40275a add supply order methods 2023-04-11 23:18:10 +03:00
Kirill
4139692ac3 Merge pull request #5 from diPhantxm/refactor-enum-types
add enum types where possible
2023-04-02 12:54:17 +03:00
diPhantxm
3507be6ec2 add enum types where possible 2023-04-02 12:52:55 +03:00
Kirill
9990719060 Merge pull request #4 from diPhantxm/feature/add-content-type-to-request
add Content-Type to request header
2023-03-25 17:22:33 +03:00
diPhantxm
18470fcae5 add Content-Type to request header 2023-03-25 17:18:20 +03:00
50 changed files with 11164 additions and 3589 deletions

View File

@@ -57,7 +57,7 @@
- [x] List of accordance types (version 2) - [x] List of accordance types (version 2)
- [x] Directory of document types - [x] Directory of document types
- [x] List of certified categories - [x] List of certified categories
- [ ] Adding certificates for products - [x] Adding certificates for products
- [x] Link the certificate to the product - [x] Link the certificate to the product
- [x] Delete certificate - [x] Delete certificate
- [x] Certificate information - [x] Certificate information

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 Kirill
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -11,6 +11,7 @@ Read full [documentation](https://docs.ozon.ru/api/seller/en/#tag/Introduction)
You can check [list of supported endpoints](ENDPOINTS.md) You can check [list of supported endpoints](ENDPOINTS.md)
## How to start ## How to start
### API
Get Client-Id and Api-Key in your seller profile [here](https://seller.ozon.ru/app/settings/api-keys?locale=en) Get Client-Id and Api-Key in your seller profile [here](https://seller.ozon.ru/app/settings/api-keys?locale=en)
Just add dependency to your project and you're ready to go. Just add dependency to your project and you're ready to go.
@@ -35,7 +36,8 @@ func main() {
client := ozon.NewClient("my-client-id", "my-api-key") client := ozon.NewClient("my-client-id", "my-api-key")
// Send request with parameters // Send request with parameters
resp, err := client.Products().GetProductDetails(&ozon.GetProductDetailsParams{ ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := client.Products().GetProductDetails(&ozon.GetProductDetailsParams{
ProductId: 123456789, ProductId: 123456789,
}) })
if err != nil || resp.StatusCode != http.StatusOK { if err != nil || resp.StatusCode != http.StatusOK {
@@ -49,6 +51,43 @@ func main() {
} }
``` ```
### Notifications
Ozon can send push-notifications to your REST server. There is an implementation of REST server that handles notifications in this library.
[Official documentation](https://docs.ozon.ru/api/seller/en/#tag/push_intro)
How to use:
```Golang
package main
import (
"log"
"github.com/diphantxm/ozon-api-client/ozon/notifications"
)
func main() {
// Create server
port := 5000
server := notifications.NewNotificationServer(port)
// Register handlers passing message type and handler itself
server.Register(notifications.ChatClosedType, func(req interface{}) error {
notification := req.(*notifications.ChatClosed)
// Do something with the notification here...
log.Printf("chat %s has been closed\n", notification.ChatId)
return nil
})
// Run server
if err := server.Run(); err != nil {
log.Printf("error while running notification server: %s", err)
}
}
```
## Contribution ## Contribution
If you need some endpoints ASAP, create an issue and list all the endpoints. I will add them to library soon. If you need some endpoints ASAP, create an issue and list all the endpoints. I will add them to library soon.

View File

@@ -15,36 +15,33 @@ type HttpClient interface {
type Client struct { type Client struct {
baseUrl string baseUrl string
ctx context.Context
Options map[string]string Options map[string]string
client HttpClient client HttpClient
} }
func NewClient(baseUrl string, opts map[string]string) *Client { func NewClient(client HttpClient, baseUrl string, opts map[string]string) *Client {
return &Client{ return &Client{
Options: opts, Options: opts,
ctx: context.Background(), client: client,
client: http.DefaultClient,
baseUrl: baseUrl, baseUrl: baseUrl,
} }
} }
func NewMockClient(handler http.HandlerFunc) *Client { func NewMockClient(handler http.HandlerFunc) *Client {
return &Client{ return &Client{
ctx: context.Background(),
client: NewMockHttpClient(handler), client: NewMockHttpClient(handler),
} }
} }
func (c Client) newRequest(method string, url string, body interface{}) (*http.Request, error) { func (c Client) newRequest(ctx context.Context, method string, url string, body interface{}) (*http.Request, error) {
bodyJson, err := json.Marshal(body) bodyJson, err := json.Marshal(body)
if err != nil { if err != nil {
return nil, err return nil, err
} }
url = c.baseUrl + url url = c.baseUrl + url
req, err := http.NewRequestWithContext(c.ctx, method, url, bytes.NewBuffer(bodyJson)) req, err := http.NewRequestWithContext(ctx, method, url, bytes.NewBuffer(bodyJson))
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -56,8 +53,8 @@ func (c Client) newRequest(method string, url string, body interface{}) (*http.R
return req, nil return req, nil
} }
func (c Client) Request(method string, path string, req, resp interface{}) (*Response, error) { func (c Client) Request(ctx context.Context, method string, path string, req, resp interface{}, options map[string]string) (*Response, error) {
httpReq, err := c.newRequest(method, path, req) httpReq, err := c.newRequest(ctx, method, path, req)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,8 +1,14 @@
package core package core
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
"time"
)
const (
testTimeout = 5 * time.Second
) )
type TestRequestRequest struct { type TestRequestRequest struct {
@@ -55,10 +61,12 @@ func TestRequest(t *testing.T) {
c := NewMockClient(NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(NewMockHttpHandler(test.statusCode, test.response, test.headers))
respStruct := &TestRequestResponse{} respStruct := &TestRequestResponse{}
resp, err := c.Request(http.MethodPost, "/", test.params, respStruct) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Request(ctx, http.MethodPost, "/", test.params, respStruct, nil)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -19,21 +20,25 @@ type GetAnalyticsDataParams struct {
DateTo time.Time `json:"date_to"` DateTo time.Time `json:"date_to"`
// Items Enum: "unknownDimension" "sku" "spu" "day" "week" "month" "year" "category1" "category2" "category3" "category4" "brand" "modelID" // Items Enum: "unknownDimension" "sku" "spu" "day" "week" "month" "year" "category1" "category2" "category3" "category4" "brand" "modelID"
Dimension []string `json:"dimension"` // Data grouping available to all sellers:
// - unknownDimension—unknown,
// - sku—product identifier,
// - spu—product identifier,
// - day—day,
// - week—week,
// - month—month.
// Data grouping available to sellers with Premium subscription:
// - year—year,
// - category1—first level category,
// - category2—second level category,
// - category3—third level category,
// - category4—fourth level category,
// - brand—brand,
// - modelID—model.
Dimension []GetAnalyticsDataDimension `json:"dimension"`
// Filters // Filters
Filters []struct { Filters []GetAnalyticsDataFilter `json:"filters"`
// Sorting parameter. You can pass any attribute from the `dimension` and `metric` parameters except the `brand` attribute
Key string `json:"key"`
// Comparison operation
//
// Enum: "EQ" "GT" "GTE" "LT" "LTE"
Operation string `json:"operation"`
// Value for comparison
Value string `json:"value"`
} `json:"filters"`
// Number of items in the respones: // Number of items in the respones:
// - maximum is 1000, // - maximum is 1000,
@@ -41,11 +46,31 @@ type GetAnalyticsDataParams struct {
Limit int64 `json:"limit"` Limit int64 `json:"limit"`
// Specify up to 14 metrics. If there are more, you will get an error with the InvalidArgument code // Specify up to 14 metrics. If there are more, you will get an error with the InvalidArgument code
// The list of metrics for which the report will be generated.
// //
// Items Enum: "unknown_metric" "hits_view_search" "hits_view_pdp" "hits_view" "hits_tocart_search" "hits_tocart_pdp" "hits_tocart" "session_view_search" // Metrics available to all sellers:
// "session_view_pdp" "session_view" "conv_tocart_search" "conv_tocart_pdp" "conv_tocart" "revenue" "returns" "cancellations" "ordered_units" "delivered_units" //
// "adv_view_pdp" "adv_view_search_category" "adv_view_all" "adv_sum_all" "position_category" "postings" "postings_premium" // - revenue—ordered amount,
Metrics []string `json:"metrics"` // - ordered_units—ordered products.
// Metrics available to sellers with Premium subscription:
// - unknown_metric—unknown metric,
// - hits_view_search—impressions in search and category,
// - hits_view_pdp—impressions on the product description page,
// - hits_view—total impressions,
// - hits_tocart_search—added to cart from search or category,
// - hits_tocart_pdp—added to cart from the product description page,
// - hits_tocart—added to cart total,
// - session_view_search—sessions with impressions in search or category,
// - session_view_pdp—sessions with impressions on the product description page,
// - session_view—sessions total,
// - conv_tocart_search—conversion to cart from search or category,
// - conv_tocart_pdp—conversion to cart from a product description page,
// - conv_tocart—total conversion to cart,
// - returns—returned products,
// - cancellations—canceled products,
// - delivered_units—delivered products,
// - position_category—position in search and category.
Metrics []GetAnalyticsDataFilterMetric `json:"metrics"`
// Number of elements that will be skipped in the response. For example, if `offset=10`, the response will start with the 11th element found // 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 int64 `json:"offset"` Offset int64 `json:"offset"`
@@ -54,52 +79,74 @@ type GetAnalyticsDataParams struct {
Sort []GetAnalyticsDataSort `json:"sort"` Sort []GetAnalyticsDataSort `json:"sort"`
} }
type GetAnalyticsDataFilter struct {
// Sorting parameter. You can pass any attribute from the `dimension` and `metric` parameters except the `brand` attribute
Key string `json:"key"`
// Comparison operation
Operation GetAnalyticsDataFilterOperation `json:"operation"`
// Value for comparison
Value string `json:"value"`
}
// Report sorting settings // Report sorting settings
type GetAnalyticsDataSort struct { type GetAnalyticsDataSort struct {
// Metric by which the method result will be sorted // Metric by which the method result will be sorted
Key string `json:"key"` Key GetAnalyticsDataFilterMetric `json:"key"`
// Sorting type // Sorting type
// - ASC — in ascending order, Order Order `json:"order"`
// - DESC — in descending order.
Order string `json:"order"`
} }
type GetAnalyticsDataResponse struct { type GetAnalyticsDataResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result GetAnalyticsDataResult `json:"result"`
// Data array
Data []struct {
// Data grouping in the report
Dimensions []struct {
// Identifier
Id string `json:"id"`
// Name
Name string `json:"name"`
} `json:"dimensions"`
// Metric values list
Metrics []float64 `json:"metrics"`
} `json:"data"`
// Total and average metrics values
Totals []float64 `json:"totals"`
} `json:"result"`
// Report creation time // Report creation time
Timestamp string `json:"timestamp"` Timestamp string `json:"timestamp"`
} }
type GetAnalyticsDataResult struct {
// Data array
Data []GetAnalyticsDataResultData `json:"data"`
// Total and average metrics values
Totals []float64 `json:"totals"`
}
type GetAnalyticsDataResultData struct {
// Data grouping in the report
Dimensions []GetAnalyticsDataResultDimension `json:"dimensions"`
// Metric values list
Metrics []float64 `json:"metrics"`
}
type GetAnalyticsDataResultDimension struct {
// Identifier
Id string `json:"id"`
// Name
Name string `json:"name"`
}
// Specify the period and metrics that are required. The response will contain analytical data grouped by the `dimensions` parameter. // Specify the period and metrics that are required. The response will contain analytical data grouped by the `dimensions` parameter.
func (c Analytics) GetAnalyticsData(params *GetAnalyticsDataParams) (*GetAnalyticsDataResponse, error) { //
// There are restrictions for sellers without Premium subscription:
//
// - data is available for the last 3 months,
// - some of the data grouping methods and metrics aren't available.
//
// There are no restrictions for sellers with Premium subscription
func (c Analytics) GetAnalyticsData(ctx context.Context, params *GetAnalyticsDataParams) (*GetAnalyticsDataResponse, error) {
url := "/v1/analytics/data" url := "/v1/analytics/data"
resp := &GetAnalyticsDataResponse{} resp := &GetAnalyticsDataResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -118,50 +165,51 @@ type GetStocksOnWarehousesParams struct {
Offset int64 `json:"offset"` Offset int64 `json:"offset"`
// Warehouse type filter: // Warehouse type filter:
// - EXPRESS_DARK_STORE — Ozon warehouses with Fresh delivery. WarehouseType WarehouseType `json:"warehouse_type"`
// - NOT_EXPRESS_DARK_STORE — Ozon warehouses without Fresh delivery.
// - ALL — all Ozon warehouses.
WarehouseType string `json:"warehouse_type"`
} }
type GetStocksOnWarehousesResponse struct { type GetStocksOnWarehousesResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result GetStocksOnWarehousesResult `json:"result"`
// Information about products and stocks }
Rows []struct {
// Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
// Product identifier in the seller's system type GetStocksOnWarehousesResult struct {
ItemCode string `json:"item_code"` // Information about products and stocks
Rows []GetStocksOnWarehousesResultRow `json:"rows"`
}
// Product name in the Ozon system type GetStocksOnWarehousesResultRow struct {
ItemName string `json:"item_name"` // Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
// Product amount available for sale on Ozon // Product identifier in the seller's system
FreeToSellAmount int64 `json:"free_to_sell_amount"` ItemCode string `json:"item_code"`
// Product amount specified for confirmed future supplies // Product name in the Ozon system
PromisedAmount int64 `json:"promised_amount"` ItemName string `json:"item_name"`
// Product amount reserved for purchase, returns, and transportation between warehouses // Product amount available for sale on Ozon
ReservedAmount int64 `json:"reserved_amount"` FreeToSellAmount int64 `json:"free_to_sell_amount"`
// Name of the warehouse where the products are stored // Product amount specified for confirmed future supplies
WarehouseName string `json:"warehouse_name"` PromisedAmount int64 `json:"promised_amount"`
} `json:"rows"`
} `json:"result"` // Product amount reserved for purchase, returns, and transportation between warehouses
ReservedAmount int64 `json:"reserved_amount"`
// Name of the warehouse where the products are stored
WarehouseName string `json:"warehouse_name"`
} }
// Report on stocks and products movement at Ozon warehouses // Report on stocks and products movement at Ozon warehouses
func (c Analytics) GetStocksOnWarehouses(params *GetStocksOnWarehousesParams) (*GetStocksOnWarehousesResponse, error) { func (c Analytics) GetStocksOnWarehouses(ctx context.Context, params *GetStocksOnWarehousesParams) (*GetStocksOnWarehousesResponse, error) {
url := "/v2/analytics/stock_on_warehouses" url := "/v2/analytics/stock_on_warehouses"
resp := &GetStocksOnWarehousesResponse{} resp := &GetStocksOnWarehousesResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -23,12 +24,12 @@ func TestGetAnalyticsData(t *testing.T) {
&GetAnalyticsDataParams{ &GetAnalyticsDataParams{
DateFrom: core.TimeFromString(t, "2006-01-02", "2020-09-01"), DateFrom: core.TimeFromString(t, "2006-01-02", "2020-09-01"),
DateTo: core.TimeFromString(t, "2006-01-02", "2021-10-15"), DateTo: core.TimeFromString(t, "2006-01-02", "2021-10-15"),
Dimension: []string{"sku", "day"}, Dimension: []GetAnalyticsDataDimension{SKUDimension, DayDimension},
Metrics: []string{"hits_view_search"}, Metrics: []GetAnalyticsDataFilterMetric{HistViewPDP},
Sort: []GetAnalyticsDataSort{ Sort: []GetAnalyticsDataSort{
{ {
Key: "hits_view_search", Key: HistViewPDP,
Order: "DESC", Order: Descending,
}, },
}, },
Limit: 1000, Limit: 1000,
@@ -59,11 +60,15 @@ func TestGetAnalyticsData(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Analytics().GetAnalyticsData(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Analytics().GetAnalyticsData(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetAnalyticsDataResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -119,11 +124,15 @@ func TestGetStocksOnWarehouses(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Analytics().GetStocksOnWarehouses(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Analytics().GetStocksOnWarehouses(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetStocksOnWarehousesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

111
ozon/barcodes.go Normal file
View File

@@ -0,0 +1,111 @@
package ozon
import (
"context"
"net/http"
core "github.com/diphantxm/ozon-api-client"
)
type Barcodes struct {
client *core.Client
}
type GenerateBarcodesParams struct {
// List of products for which you want to generate barcodes
ProductIds []int64 `json:"product_ids"`
}
type GenerateBarcodesResponse struct {
core.CommonResponse
Errors []GenerateBarcodesError `json:"errors"`
}
type GenerateBarcodesError struct {
// Error code
Code string `json:"code"`
// Error details
Error string `json:"error"`
// Barcode that is failed to generate
Barcode string `json:"barcode"`
// Product identifier for which the barcode generation failed
ProductId int64 `json:"product_id"`
}
// If a product doesn't have a barcode, you can create it using this method. If a barcode already exists,
// but it isn't specified in your account, you can bind it using the `/v1/barcode/add` method.
//
// You can't generate barcodes for more than 100 products per request.
// You can use the method no more than 20 times per minute.
func (b *Barcodes) Generate(ctx context.Context, params *GenerateBarcodesParams) (*GenerateBarcodesResponse, error) {
url := "/v1/barcode/generate"
resp := &GenerateBarcodesResponse{}
response, err := b.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type BindBarcodesParams struct {
// List of barcodes and products
Barcodes []BindBarcode `json:"barcodes"`
}
type BindBarcode struct {
// Barcode. Maximum 100 characters
Barcode string `json:"barcode"`
// Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
}
type BindBarcodesResponse struct {
core.CommonResponse
// Errors while binding barcodes
Errors []BindBarcodesError `json:"errors"`
}
type BindBarcodesError struct {
// Error code
Code string `json:"code"`
// Error details
Error string `json:"error"`
// Barcode that is failed to generate
Barcode string `json:"barcode"`
// SKU of the product for which the barcode binding failed
SKU int64 `json:"sku"`
}
// If a product has a barcode that isn't specified in your account,
// bind it using this method. If a product doesn't have a barcode,
// you can create it using the `/v1/barcode/generate` method.
//
// You can't bind barcodes to more than 100 products per request.
// Each product can have up to 100 barcodes.
// You can use the method no more than 20 times per minute.
func (b *Barcodes) Bind(ctx context.Context, params *BindBarcodesParams) (*BindBarcodesResponse, error) {
url := "/v1/barcode/add"
resp := &BindBarcodesResponse{}
response, err := b.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}

147
ozon/barcodes_test.go Normal file
View File

@@ -0,0 +1,147 @@
package ozon
import (
"context"
"net/http"
"testing"
core "github.com/diphantxm/ozon-api-client"
)
func TestGenerateBarcodes(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GenerateBarcodesParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GenerateBarcodesParams{
ProductIds: []int64{123456789},
},
`{
"errors": [
{
"code": "code 200",
"error": "no error",
"barcode": "456",
"product_id": 123456789
}
]
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GenerateBarcodesParams{},
`{
"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.Barcodes().Generate(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GenerateBarcodesResponse{})
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.Errors) != 0 {
if resp.Errors[0].ProductId != test.params.ProductIds[0] {
t.Errorf("Product ids are not equal")
}
}
}
}
}
func TestBindBarcodes(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *BindBarcodesParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&BindBarcodesParams{
Barcodes: []BindBarcode{
{
Barcode: "some barcode",
SKU: 123456789,
},
},
},
`{
"errors": [
{
"code": "code 200",
"error": "no error",
"barcode": "some barcode",
"sku": 123456789
}
]
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&BindBarcodesParams{},
`{
"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.Barcodes().Bind(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &BindBarcodesResponse{})
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.Errors) != 0 {
if resp.Errors[0].Barcode != test.params.Barcodes[0].Barcode {
t.Errorf("Barcodes are not equal")
}
if resp.Errors[0].SKU != test.params.Barcodes[0].SKU {
t.Errorf("Barcodes are not equal")
}
}
}
}
}

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
core "github.com/diphantxm/ozon-api-client" core "github.com/diphantxm/ozon-api-client"
@@ -22,30 +23,34 @@ type ListCertifiedBrandsResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result ListCertifiedBrandsResult `json:"result"`
// Certified brands details }
BrandCertification []struct {
// Brand name
BrandName string `json:"brand_name"`
// Indication that the certificate is required: type ListCertifiedBrandsResult struct {
// - true if the certificate is required; // Certified brands details
// - false if not BrandCertification []ListCertifiedBrandsResultCertificate `json:"brand_certification"`
HasCertificate bool `json:"has_certificate"`
} `json:"brand_certification"`
// Total number of brands // Total number of brands
Total int64 `json:"total"` Total int64 `json:"total"`
} `json:"result"` }
type ListCertifiedBrandsResultCertificate struct {
// Brand name
BrandName string `json:"brand_name"`
// Indication that the certificate is required:
// - true if the certificate is required;
// - false if not
HasCertificate bool `json:"has_certificate"`
} }
// List of certified brands // List of certified brands
func (c Brands) List(params *ListCertifiedBrandsParams) (*ListCertifiedBrandsResponse, error) { func (c Brands) List(ctx context.Context, params *ListCertifiedBrandsParams) (*ListCertifiedBrandsResponse, error) {
url := "/v1/brand/company-certification/list" url := "/v1/brand/company-certification/list"
resp := &ListCertifiedBrandsResponse{} resp := &ListCertifiedBrandsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -28,7 +29,6 @@ func TestListCertifiedBrands(t *testing.T) {
"result": { "result": {
"brand_certification": [ "brand_certification": [
{ {
"brand_id": 135476863,
"brand_name": "Sea of Spa", "brand_name": "Sea of Spa",
"has_certificate": false "has_certificate": false
} }
@@ -52,11 +52,15 @@ func TestListCertifiedBrands(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Brands().List(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Brands().List(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListCertifiedBrandsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -31,13 +32,7 @@ type CancellationInfo struct {
PostingNumber string `json:"posting_number"` PostingNumber string `json:"posting_number"`
// Cancellation reason // Cancellation reason
CancellationReason struct { CancellationReason CancellationInfoReason `json:"cancellation_reason"`
// Cancellation reason identifier
Id int64 `json:"id"`
// Cancellation reason name
Name string `json:"name"`
} `json:"cancellation_reason"`
// Cancellation request creation date // Cancellation request creation date
CancelledAt time.Time `json:"cancelled_at"` CancelledAt time.Time `json:"cancelled_at"`
@@ -49,16 +44,7 @@ type CancellationInfo struct {
TPLIntegrationType string `json:"tpl_integration_type"` TPLIntegrationType string `json:"tpl_integration_type"`
// Cancellation request status // Cancellation request status
State struct { State CancellationInfoState `json:"state"`
// Status identifier
Id int64 `json:"id"`
// Status name
Name string `json:"name"`
// Request status
State string `json:"state"`
} `json:"state"`
// Cancellation initiator // Cancellation initiator
CancellationInitiator string `json:"cancellation_initiator"` CancellationInitiator string `json:"cancellation_initiator"`
@@ -76,13 +62,32 @@ type CancellationInfo struct {
AutoApproveDate time.Time `json:"auto_approve_date"` AutoApproveDate time.Time `json:"auto_approve_date"`
} }
type CancellationInfoReason struct {
// Cancellation reason identifier
Id int64 `json:"id"`
// Cancellation reason name
Name string `json:"name"`
}
type CancellationInfoState struct {
// Status identifier
Id int64 `json:"id"`
// Status name
Name string `json:"name"`
// Request status
State string `json:"state"`
}
// Method for getting information about a rFBS cancellation request // Method for getting information about a rFBS cancellation request
func (c Cancellations) GetInfo(params *GetCancellationInfoParams) (*GetCancellationInfoResponse, error) { func (c Cancellations) GetInfo(ctx context.Context, params *GetCancellationInfoParams) (*GetCancellationInfoResponse, error) {
url := "/v1/delivery-method/list" url := "/v1/delivery-method/list"
resp := &GetCancellationInfoResponse{} resp := &GetCancellationInfoResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -134,25 +139,27 @@ type ListCancellationsResponse struct {
Total int32 `json:"total"` Total int32 `json:"total"`
// Counter of requests in different statuses // Counter of requests in different statuses
Counters struct { Counters ListCancellationResponseCounters `json:"counters"`
// Number of requests for approval }
OnApproval int64 `json:"on_approval"`
// Number of approved requests type ListCancellationResponseCounters struct {
Approved int64 `json:"approved"` // Number of requests for approval
OnApproval int64 `json:"on_approval"`
// Number of rejected requests // Number of approved requests
Rejected int64 `json:"rejected"` Approved int64 `json:"approved"`
} `json:"counters"`
// Number of rejected requests
Rejected int64 `json:"rejected"`
} }
// Method for getting a list of rFBS cancellation requests // Method for getting a list of rFBS cancellation requests
func (c Cancellations) List(params *ListCancellationsParams) (*ListCancellationsResponse, error) { func (c Cancellations) List(ctx context.Context, params *ListCancellationsParams) (*ListCancellationsResponse, error) {
url := "/v1/conditional-cancellation/list" url := "/v1/conditional-cancellation/list"
resp := &ListCancellationsResponse{} resp := &ListCancellationsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -175,12 +182,12 @@ type ApproveRejectCancellationsResponse struct {
// The method allows to approve an rFBS cancellation request in the ON_APPROVAL status. // The method allows to approve an rFBS cancellation request in the ON_APPROVAL status.
// The order will be canceled and the money will be returned to the customer // The order will be canceled and the money will be returned to the customer
func (c Cancellations) Approve(params *ApproveRejectCancellationsParams) (*ApproveRejectCancellationsResponse, error) { func (c Cancellations) Approve(ctx context.Context, params *ApproveRejectCancellationsParams) (*ApproveRejectCancellationsResponse, error) {
url := "/v1/conditional-cancellation/approve" url := "/v1/conditional-cancellation/approve"
resp := &ApproveRejectCancellationsResponse{} resp := &ApproveRejectCancellationsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -190,14 +197,14 @@ func (c Cancellations) Approve(params *ApproveRejectCancellationsParams) (*Appro
} }
// The method allows to reject an rFBS cancellation request in the ON_APPROVAL status. Explain your decision in the comment parameter. // The method allows to reject an rFBS cancellation request in the ON_APPROVAL status. Explain your decision in the comment parameter.
// //
// The order will remain in the same status and must be delivered to the customer // The order will remain in the same status and must be delivered to the customer
func (c Cancellations) Reject(params *ApproveRejectCancellationsParams) (*ApproveRejectCancellationsResponse, error) { func (c Cancellations) Reject(ctx context.Context, params *ApproveRejectCancellationsParams) (*ApproveRejectCancellationsResponse, error) {
url := "/v1/conditional-cancellation/reject" url := "/v1/conditional-cancellation/reject"
resp := &ApproveRejectCancellationsResponse{} resp := &ApproveRejectCancellationsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -62,11 +63,15 @@ func TestGetCancellationInfo(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Cancellations().GetInfo(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Cancellations().GetInfo(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetCancellationInfoResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -121,9 +126,9 @@ func TestListCancellations(t *testing.T) {
"state": "APPROVED" "state": "APPROVED"
}, },
"cancellation_initiator": "CLIENT", "cancellation_initiator": "CLIENT",
"order_date": "2021-09-03T07:04:53.220Z", "order_date": "2021-09-03T07:04:53.22Z",
"approve_comment": "", "approve_comment": "",
"approve_date": "2021-09-03T09:13:12.614200Z", "approve_date": "2021-09-03T09:13:12.6142Z",
"auto_approve_date": "2021-09-06T07:17:12.116114Z" "auto_approve_date": "2021-09-06T07:17:12.116114Z"
}, },
{ {
@@ -171,11 +176,15 @@ func TestListCancellations(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Cancellations().List(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Cancellations().List(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListCancellationsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -215,11 +224,15 @@ func TestApproveCancellations(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Cancellations().Approve(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Cancellations().Approve(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ApproveRejectCancellationsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -259,11 +272,15 @@ func TestRejectCancellations(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Cancellations().Reject(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Cancellations().Reject(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ApproveRejectCancellationsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
core "github.com/diphantxm/ozon-api-client" core "github.com/diphantxm/ozon-api-client"
@@ -11,39 +12,48 @@ type Categories struct {
} }
type GetProductTreeParams struct { type GetProductTreeParams struct {
// Category identifier
CategoryId int64 `json:"category_id"`
// Response language // Response language
Language string `json:"language" default:"DEFAULT"` Language Language `json:"language"`
} }
type GetProductTreeResponse struct { type GetProductTreeResponse struct {
core.CommonResponse core.CommonResponse
// Category list // Categories list
Result []struct { Result []GetProductTreeResult `json:"result"`
// Category identifier }
CategoryId int64 `json:"category_id"`
// Subcategory tree type GetProductTreeResult struct {
Children []GetProductTreeResponse `json:"children"` // Category identifier
CategoryId int64 `json:"category_id"`
// Category name // Category name
Title string `json:"title"` CategoryName string `json:"category_name"`
} `json:"result"`
// `true`, if you can't create products in the category. `false`, if you can
Disabled bool `json:"disabled"`
// Product type identifier
TypeId int64 `json:"type_id"`
// Product type name
TypeName string `json:"type_name"`
// Subcategory tree
Children []GetProductTreeResult `json:"children"`
} }
// Returns product categories in the tree view. // Returns product categories in the tree view.
//
// New products can be created in the last level categories only. // New products can be created in the last level categories only.
// This means that you need to match these particular categories with the categories of your site. // This means that you need to match these particular categories with the categories of your site.
// It is not possible to create categories by user request // We don't create new categories by user request.
func (c Categories) Tree(params *GetProductTreeParams) (*GetProductTreeResponse, error) { func (c *Categories) Tree(ctx context.Context, params *GetProductTreeParams) (*GetProductTreeResponse, error) {
url := "/v2/category/tree" url := "/v1/description-category/tree"
resp := &GetProductTreeResponse{} resp := &GetProductTreeResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -53,87 +63,79 @@ func (c Categories) Tree(params *GetProductTreeParams) (*GetProductTreeResponse,
} }
type GetCategoryAttributesParams struct { type GetCategoryAttributesParams struct {
// Filter by characteristics
AttributeType string `json:"attribute_type" default:"ALL"`
// Category identifier // Category identifier
CategoryId []int64 `json:"category_id"` CategoryId int64 `json:"category_id"`
// Response language // Response language
Language string `json:"language" default:"DEFAULT"` Language Language `json:"language"`
// Product type identifier
TypeId int64 `json:"type_id"`
} }
type GetCategoryAttributesResponse struct { type GetCategoryAttributesResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result []struct { Result []GetCategoryAttributesResult `json:"result"`
// Array of product characteristics
Attributes []struct {
// Indication that the dictionary attribute values depend on the category:
// - true — the attribute has its own set of values for each category.
// - false — the attribute has the same set of values for all categories
CategoryDependent bool `json:"category_dependent"`
// Characteristic description
Description string `json:"description"`
// Directory identifier
DictionaryId int64 `json:"dictionary_id"`
// Characteristics group identifier
GroupId int64 `json:"group_id"`
// Characteristics group name
GroupName string `json:"group_name"`
// Document generation task number
Id int64 `json:"id"`
// Indicates that the attribute is aspect. An aspect attribute is a characteristic that distinguishes products of the same model.
//
// For example, clothes and shoes of the same model may have different colors and sizes. That is, color and size are aspect attributes.
//
// Values description:
// - true — the attribute is aspect and cannot be changed after the products are delivered to the warehouse or sold from the seller's warehouse.
// - false — the attribute is not aspect and can be changed at any time
IsAspect bool `json:"is_aspect"`
// Indicates that the characteristic is a set of values:
// - true — the characteristic is a set of values,
// - false — the characteristic consists of a single value
IsCollection bool `json:"is_collection"`
// Indicates that the characteristic is mandatory:
// - true — a mandatory characteristic,
// - false — you can leave the characteristic out
IsRequired bool `json:"is_required"`
// Name
Name string `json:"name"`
// Characteristic type
Type string `json:"type"`
} `json:"attributes"`
// Category identifier
CategoryId int64 `json:"category_id"`
} `json:"result"`
} }
// Getting characteristics for specified product category. type GetCategoryAttributesResult struct {
// Characteristic description
Description string `json:"description"`
// Directory identifier
DictionaryId int64 `json:"dictionary_id"`
// Characteristics group identifier
GroupId int64 `json:"group_id"`
// Characteristics group name
GroupName string `json:"group_name"`
// Number of document generation task
Id int64 `json:"id"`
// Indicates that the attribute is aspect. An aspect attribute is a characteristic that distinguishes products of the same model.
//
// For example, clothes or shoes of the same model may have different colors and sizes. That is, color and size are aspect attributes.
//
// Values description:
//
// - `true`—the attribute is aspect and can't be changed after the products are delivered to the warehouse or sold from the seller's warehouse.
// - `false`—the attribute is not aspect and can be changed at any time
IsAspect bool `json:"is_aspect"`
// Indicates that the characteristic is a set of values:
//
// - `true`—the characteristic is a set of values,
// - `false`—the characteristic consists of a single value
IsCollection bool `json:"is_collection"`
// Indicates that the characteristic is mandatory:
//
// - `true`—a mandatory characteristic,
// - `false`—an optional characteristic
IsRequired bool `json:"is_required"`
// Name
Name string `json:"name"`
// Characteristic type
Type string `json:"type"`
}
// Getting characteristics for specified product category and type.
// //
// Pass up to 20 category identifiers in the `category_id` list. // If the dictionary_id value is 0, there is no directory.
// // If the value is different, there are directories.
// You can check whether the attribute has a nested directory by the `dictionary_id` parameter. // Get them using the `/v1/description-category/attribute/values` method.
// The 0 value means there is no directory. If the value is different, then there are directories. func (c *Categories) Attributes(ctx context.Context, params *GetCategoryAttributesParams) (*GetCategoryAttributesResponse, error) {
// You can get them using the `/v2/category/attribute/values` method url := "/v1/description-category/attribute"
func (c Categories) Attributes(params *GetCategoryAttributesParams) (*GetCategoryAttributesResponse, error) {
url := "/v3/category/attribute"
resp := &GetCategoryAttributesResponse{} resp := &GetCategoryAttributesResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -150,41 +152,59 @@ type GetAttributeDictionaryParams struct {
CategoryId int64 `json:"category_id"` CategoryId int64 `json:"category_id"`
// Response language // Response language
// The default language is Russian Language Language `json:"language"`
Language string `json:"language" default:"DEFAULT"`
// Identifier of the directory to start the response with.
// If `last_value_id` is 10, the response will contain directories starting from the 11th
LastValueId int64 `json:"last_value_id"` LastValueId int64 `json:"last_value_id"`
// Number of values in the response: // Number of values in the response:
// - maximum — 5000 //
// - minimum — 1 // - maximum—5000,
// - minimum—1.
Limit int64 `json:"limit"` Limit int64 `json:"limit"`
// Product type identifier
TypeId int64 `json:"type_id"`
} }
type GetAttributeDictionaryResponse struct { type GetAttributeDictionaryResponse struct {
core.CommonResponse core.CommonResponse
// Indication that only part of characteristic values was returned in the response:
//
// - true—make a request with a new last_value_id parameter value for getting the rest of characteristic values;
// - false—all characteristic values were returned
HasNext bool `json:"has_next"` HasNext bool `json:"has_next"`
// Method result // Characteristic values
Result []struct { Result []GetAttributeDictionaryResult `json:"result"`
Id int64 `json:"id"`
Info string `json:"info"`
Picture string `json:"picture"`
// Product characteristic value
Value string `json:"value"`
} `json:"result"`
} }
// You can use the `/v3/category/attribute` method to check if an attribute has a nested directory. type GetAttributeDictionaryResult struct {
// If there are directories, get them using this method // Characteristic value identifier
func (c Categories) AttributesDictionary(params *GetAttributeDictionaryParams) (*GetAttributeDictionaryResponse, error) { Id int64 `json:"id"`
url := "/v2/category/attribute/values"
// Additional description
Info string `json:"info"`
// Image link
Picture string `json:"picture"`
// Product characteristic value
Value string `json:"value"`
}
// Returns characteristics value directory.
//
// To check if an attribute has a nested directory,
// use the `/v1/description-category/attribute` method.
func (c *Categories) AttributesDictionary(ctx context.Context, params *GetAttributeDictionaryParams) (*GetAttributeDictionaryResponse, error) {
url := "/v1/description-category/attribute"
resp := &GetAttributeDictionaryResponse{} resp := &GetAttributeDictionaryResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -21,14 +22,17 @@ func TestGetProductTree(t *testing.T) {
http.StatusOK, http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"}, map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetProductTreeParams{ &GetProductTreeParams{
CategoryId: 17034410, Language: English,
}, },
`{ `{
"result": [ "result": [
{ {
"category_id": 17034410, "category_id": 0,
"title": "Развивающие игрушки", "category_name": "string",
"children": [] "children": [],
"disabled": true,
"type_id": 0,
"type_name": "string"
} }
] ]
}`, }`,
@@ -48,22 +52,18 @@ func TestGetProductTree(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Categories().Tree(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Categories().Tree(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetProductTreeResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", 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) > 0 {
if resp.Result[0].CategoryId != test.params.CategoryId {
t.Errorf("First category ids in request and response are not equal")
}
}
}
} }
} }
@@ -81,25 +81,23 @@ func TestGetCategoryAttributes(t *testing.T) {
http.StatusOK, http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"}, map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetCategoryAttributesParams{ &GetCategoryAttributesParams{
CategoryId: []int64{17034410}, CategoryId: 12345,
Language: English,
TypeId: 2,
}, },
`{ `{
"result": [ "result": [
{ {
"category_id": 17034410, "description": "string",
"attributes": [ "dictionary_id": 0,
{ "group_id": 0,
"id": 85, "group_name": "string",
"name": "Бренд", "id": 0,
"description": "Укажите наименование бренда, под которым произведен товар. Если товар не имеет бренда, используйте значение \"Нет бренда\"", "is_aspect": true,
"type": "String", "is_collection": true,
"is_collection": false, "is_required": true,
"is_required": true, "name": "string",
"group_id": 0, "type": "string"
"group_name": "",
"dictionary_id": 28732849
}
]
} }
] ]
}`, }`,
@@ -119,25 +117,18 @@ func TestGetCategoryAttributes(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Categories().Attributes(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Categories().Attributes(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetCategoryAttributesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", 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) != len(test.params.CategoryId) {
t.Errorf("Length of categories in request and response are not equal")
}
if len(resp.Result) > 0 {
if resp.Result[0].CategoryId != test.params.CategoryId[0] {
t.Errorf("Category ids in request and response are not equal")
}
}
}
} }
} }
@@ -155,33 +146,23 @@ func TestGetAttributeDictionary(t *testing.T) {
http.StatusOK, http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"}, map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetAttributeDictionaryParams{ &GetAttributeDictionaryParams{
AttributeId: 10096, AttributeId: 123456,
CategoryId: 17028968, CategoryId: 12,
LastValueId: 0, Language: English,
Limit: 3, LastValueId: 1,
Limit: 5,
TypeId: 6,
}, },
`{ `{
"has_next": true,
"result": [ "result": [
{ {
"id": 61571, "id": 0,
"value": "белый", "info": "string",
"info": "", "picture": "string",
"picture": "" "value": "string"
},
{
"id": 61572,
"value": "прозрачный",
"info": "",
"picture": ""
},
{
"id": 61573,
"value": "бежевый",
"info": "",
"picture": ""
} }
], ]
"has_next": true
}`, }`,
}, },
// Test No Client-Id or Api-Key // Test No Client-Id or Api-Key
@@ -199,11 +180,15 @@ func TestGetAttributeDictionary(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Categories().AttributesDictionary(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Categories().AttributesDictionary(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetAttributeDictionaryResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -15,34 +16,40 @@ type ListOfAccordanceTypesResponse struct {
core.CommonResponse core.CommonResponse
// Accordance types // Accordance types
Result struct { Result ListOfAccordanceTypesResult `json:"result"`
// Main accordance types }
Base []struct {
// Accordance type code
Code string `json:"code"`
// Accordance type description type ListOfAccordanceTypesResult struct {
Title string `json:"title"` // Main accordance types
} `json:"base"` Base []ListOfAccordanceTypesResultBase `json:"base"`
// Main accordance types related to dangerous products // Main accordance types related to dangerous products
Hazard []struct { Hazard []ListOfAccordanceTypesResultHazard `json:"hazard"`
// Accordance type code }
Code string `json:"code"`
// Accordance type description type ListOfAccordanceTypesResultBase struct {
Title string `json:"title"` // Accordance type code
} `json:"hazard"` Code string `json:"code"`
} `json:"result"`
// Accordance type description
Title string `json:"title"`
}
type ListOfAccordanceTypesResultHazard struct {
// Accordance type code
Code string `json:"code"`
// Accordance type description
Title string `json:"title"`
} }
// List of accordance types (version 2) // List of accordance types (version 2)
func (c Certificates) ListOfAccordanceTypes() (*ListOfAccordanceTypesResponse, error) { func (c Certificates) ListOfAccordanceTypes(ctx context.Context) (*ListOfAccordanceTypesResponse, error) {
url := "/v2/product/certificate/accordance-types/list" url := "/v2/product/certificate/accordance-types/list"
resp := &ListOfAccordanceTypesResponse{} resp := &ListOfAccordanceTypesResponse{}
response, err := c.client.Request(http.MethodGet, url, nil, resp) response, err := c.client.Request(ctx, http.MethodGet, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -55,22 +62,24 @@ type DirectoryOfDocumentTypesResponse struct {
core.CommonResponse core.CommonResponse
// List of certificate types and names // List of certificate types and names
Result []struct { Result []DirectoryOfDocumentTypesResult `json:"result"`
// Certificate name }
Name string `json:"name"`
// Certificate type type DirectoryOfDocumentTypesResult struct {
Value string `json:"value"` // Certificate name
} `json:"result"` Name string `json:"name"`
// Certificate type
Value string `json:"value"`
} }
// Directory of document types // Directory of document types
func (c Certificates) DirectoryOfDocumentTypes() (*DirectoryOfDocumentTypesResponse, error) { func (c Certificates) DirectoryOfDocumentTypes(ctx context.Context) (*DirectoryOfDocumentTypesResponse, error) {
url := "/v1/product/certificate/types" url := "/v1/product/certificate/types"
resp := &DirectoryOfDocumentTypesResponse{} resp := &DirectoryOfDocumentTypesResponse{}
response, err := c.client.Request(http.MethodGet, url, nil, resp) response, err := c.client.Request(ctx, http.MethodGet, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -91,28 +100,32 @@ type ListOfCertifiedCategoriesResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result ListOfCertifiedCategoriesResult `json:"result"`
// Certified categories details }
Certification []struct {
// Category name
CategoryName string `json:"category_name"`
// Indication of a mandatory category type ListOfCertifiedCategoriesResult struct {
IsRequired bool `json:"is_required"` // Certified categories details
} `json:"certification"` Certification []ListOfCertifiedCategoriesResultCert `json:"certification"`
// Total number of categories // Total number of categories
Total int64 `json:"total"` Total int64 `json:"total"`
} `json:"reult"` }
type ListOfCertifiedCategoriesResultCert struct {
// Category name
CategoryName string `json:"category_name"`
// Indication of a mandatory category
IsRequired bool `json:"is_required"`
} }
// List of certified categories // List of certified categories
func (c Certificates) ListOfCertifiedCategories(params *ListOfCertifiedCategoriesParams) (*ListOfCertifiedCategoriesResponse, error) { func (c Certificates) ListOfCertifiedCategories(ctx context.Context, params *ListOfCertifiedCategoriesParams) (*ListOfCertifiedCategoriesResponse, error) {
url := "/v1/product/certificate/types" url := "/v1/product/certificate/types"
resp := &ListOfCertifiedCategoriesResponse{} resp := &ListOfCertifiedCategoriesResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -137,12 +150,12 @@ type LinkCertificateToProductResponse struct {
} }
// Link the certificate to the product // Link the certificate to the product
func (c Certificates) LinkToProduct(params *LinkCertificateToProductParams) (*LinkCertificateToProductResponse, error) { func (c Certificates) LinkToProduct(ctx context.Context, params *LinkCertificateToProductParams) (*LinkCertificateToProductResponse, error) {
url := "/v1/product/certificate/bind" url := "/v1/product/certificate/bind"
resp := &LinkCertificateToProductResponse{} resp := &LinkCertificateToProductResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -160,24 +173,26 @@ type DeleteCertificateResponse struct {
core.CommonResponse core.CommonResponse
// Result of deleting the certificate // Result of deleting the certificate
Result struct { Result DeleteCertificateResult `json:"result"`
// Indication that a certificate has been deleted: }
// - true — deleted
// - false — not deleted
IsDelete bool `json:"is_delete"`
// Description of errors during certificate deletion type DeleteCertificateResult struct {
ErrorMessage string `json:"error_message"` // Indication that a certificate has been deleted:
} `json:"result"` // - true — deleted
// - false — not deleted
IsDelete bool `json:"is_delete"`
// Description of errors during certificate deletion
ErrorMessage string `json:"error_message"`
} }
// Delete certificate // Delete certificate
func (c Certificates) Delete(params *DeleteCertificateParams) (*DeleteCertificateResponse, error) { func (c Certificates) Delete(ctx context.Context, params *DeleteCertificateParams) (*DeleteCertificateResponse, error) {
url := "/v1/product/certificate/delete" url := "/v1/product/certificate/delete"
resp := &DeleteCertificateResponse{} resp := &DeleteCertificateResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -195,49 +210,51 @@ type GetCertificateInfoResponse struct {
core.CommonResponse core.CommonResponse
// Certificate information // Certificate information
Result struct { Result GetCertificateInfoResult `json:"result"`
// Identifier }
CertificateId int32 `json:"certificate_id"`
// Number type GetCertificateInfoResult struct {
CertificateNumber string `json:"certificate_number"` // Identifier
CertificateId int32 `json:"certificate_id"`
// Name // Number
CertificateName string `json:"certificate_name"` CertificateNumber string `json:"certificate_number"`
// Type // Name
TypeCode string `json:"type_code"` CertificateName string `json:"certificate_name"`
// Status // Type
StatusCode string `json:"status_code"` TypeCode string `json:"type_code"`
// Accordance type // Status
AccordanceTypeCode string `json:"accordance_type_code"` StatusCode string `json:"status_code"`
// Certificate rejection reason // Accordance type
RejectionReasonCode string `json:"rejectio_reason_code"` AccordanceTypeCode string `json:"accordance_type_code"`
// Moderator's comment // Certificate rejection reason
VerificationComment string `json:"verification_comment"` RejectionReasonCode string `json:"rejection_reason_code"`
// Issue date // Moderator's comment
IssueDate time.Time `json:"issue_date"` VerificationComment string `json:"verification_comment"`
// Expire date // Issue date
ExpireDate time.Time `json:"expire_date"` IssueDate time.Time `json:"issue_date"`
// Number of products associated with a certificate // Expire date
ProductsCount int32 `json:"products_count"` ExpireDate time.Time `json:"expire_date"`
} `json:"result"`
// Number of products associated with a certificate
ProductsCount int32 `json:"products_count"`
} }
// Certificate information // Certificate information
func (c Certificates) GetInfo(params *GetCertificateInfoParams) (*GetCertificateInfoResponse, error) { func (c Certificates) GetInfo(ctx context.Context, params *GetCertificateInfoParams) (*GetCertificateInfoResponse, error) {
url := "/v1/product/certificate/info" url := "/v1/product/certificate/info"
resp := &GetCertificateInfoResponse{} resp := &GetCertificateInfoResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -268,55 +285,59 @@ type ListCertificatesResponse struct {
core.CommonResponse core.CommonResponse
// Certificates // Certificates
Result struct { Result ListCertificatesResult `json:"result"`
// Сertificate information }
Certificates []struct {
// Identifier
CertificateId int32 `json:"certificate_id"`
// Number type ListCertificatesResult struct {
CertificateNumber string `json:"certificate_number"` // Сertificate information
Certificates []ListCertificatesResultCert `json:"certificates"`
// Name // Number of pages
CertificateName string `json:"certificate_name"` PageCount int32 `json:"page_count"`
}
// Type type ListCertificatesResultCert struct {
TypeCode string `json:"type"` // Identifier
CertificateId int32 `json:"certificate_id"`
// Status // Number
StatusCode string `json:"status_code"` CertificateNumber string `json:"certificate_number"`
// Accordance type // Name
AccordanceTypecode string `json:"accordance_type_code"` CertificateName string `json:"certificate_name"`
// Certificate rejection reason // Type
RejectionReasonCode string `json:"rejectio_reason_code"` TypeCode string `json:"type_code"`
// Moderator's comment // Status
VerificationComment string `json:"verification_comment"` StatusCode string `json:"status_code"`
// Issue date // Accordance type
IssueDate time.Time `json:"issue_data"` AccordanceTypecode string `json:"accordance_type_code"`
// Expire date // Certificate rejection reason
ExpireDate time.Time `json:"expire_date"` RejectionReasonCode string `json:"rejection_reason_code"`
// Number of products associated with a certificate // Moderator's comment
ProductsCount int32 `json:"products_count"` VerificationComment string `json:"verification_comment"`
} `json:"certificates"`
// Number of pages // Issue date
PageCount int32 `json:"page_count"` IssueDate time.Time `json:"issue_date"`
} `json:"result"`
// Expire date
ExpireDate time.Time `json:"expire_date"`
// Number of products associated with a certificate
ProductsCount int32 `json:"products_count"`
} }
// Certificates list // Certificates list
func (c Certificates) List(params *ListCertificatesParams) (*ListCertificatesResponse, error) { func (c Certificates) List(ctx context.Context, params *ListCertificatesParams) (*ListCertificatesResponse, error) {
url := "/v1/product/certificate/list" url := "/v1/product/certificate/list"
resp := &ListCertificatesResponse{} resp := &ListCertificatesResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -329,21 +350,23 @@ type ProductStatusesResponse struct {
core.CommonResponse core.CommonResponse
// Product statuses // Product statuses
Result []struct { Result []ProductStatusesResult `json:"result"`
// Product status code when linking it to the certificate
Code string `json:"code"`
// Status description
Name string `json:"name"`
} `json:"result"`
} }
func (c Certificates) ProductStatuses() (*ProductStatusesResponse, error) { type ProductStatusesResult struct {
// Product status code when linking it to the certificate
Code string `json:"code"`
// Status description
Name string `json:"name"`
}
func (c Certificates) ProductStatuses(ctx context.Context) (*ProductStatusesResponse, error) {
url := "/v1/product/certificate/list" url := "/v1/product/certificate/list"
resp := &ProductStatusesResponse{} resp := &ProductStatusesResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp) response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -370,28 +393,30 @@ type ListProductsForCertificateResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result ListProductsForCertificateResult `json:"result"`
// List of products }
Items []struct {
// Product identifier
ProductId int64 `json:"product_id"`
// Status of the product processing when binding to a certificate type ListProductsForCertificateResult struct {
ProductStatusCode string `json:"product_status_code"` // List of products
} `json:"items"` Items []struct {
// Product identifier
ProductId int64 `json:"product_id"`
// Number of products found // Status of the product processing when binding to a certificate
Count int64 `json:"count"` ProductStatusCode string `json:"product_status_code"`
} `json:"result"` } `json:"items"`
// Number of products found
Count int64 `json:"count"`
} }
// A method for getting a list of possible statuses of products when binding them to a certificate // A method for getting a list of possible statuses of products when binding them to a certificate
func (c Certificates) ListProductsForCertificate(params *ListProductsForCertificateParams) (*ListProductsForCertificateResponse, error) { func (c Certificates) ListProductsForCertificate(ctx context.Context, params *ListProductsForCertificateParams) (*ListProductsForCertificateResponse, error) {
url := "/v1/product/certificate/products/list" url := "/v1/product/certificate/products/list"
resp := &ListProductsForCertificateResponse{} resp := &ListProductsForCertificateResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -412,27 +437,29 @@ type UnlinkFromProductResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result []struct { Result []UnlinkFromProductResult `json:"result"`
// Error message when unbinding a product }
Error string `json:"error"`
// Product identifier type UnlinkFromProductResult struct {
ProductId int64 `json:"product_id"` // Error message when unbinding a product
Error string `json:"error"`
// Indication that the product was unbound from a certificate: // Product identifier
// - true — it was unbound, ProductId int64 `json:"product_id"`
// - false — it is still bound
Updated bool `json:"updated"` // Indication that the product was unbound from a certificate:
} `json:"result"` // - true — it was unbound,
// - false — it is still bound
Updated bool `json:"updated"`
} }
// Unbind products from a certificate // Unbind products from a certificate
func (c Certificates) UnlinkFromProduct(params *UnlinkFromProductParams) (*UnlinkFromProductResponse, error) { func (c Certificates) UnlinkFromProduct(ctx context.Context, params *UnlinkFromProductParams) (*UnlinkFromProductResponse, error) {
url := "/v1/product/certificate/unbind" url := "/v1/product/certificate/unbind"
resp := &UnlinkFromProductResponse{} resp := &UnlinkFromProductResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -445,22 +472,24 @@ type PossibleRejectReasonsResponse struct {
core.CommonResponse core.CommonResponse
// Certificate rejection reasons // Certificate rejection reasons
Result []struct { Result []PossibleRejectReasonsResult `json:"result"`
// Сode of a certificate rejection reason }
Code string `json:"code"`
// Description of a certificate rejection reason type PossibleRejectReasonsResult struct {
Name string `json:"name"` // Сode of a certificate rejection reason
} `json:"result"` Code string `json:"code"`
// Description of a certificate rejection reason
Name string `json:"name"`
} }
// Possible certificate rejection reasons // Possible certificate rejection reasons
func (c Certificates) PossibleRejectReasons() (*PossibleRejectReasonsResponse, error) { func (c Certificates) PossibleRejectReasons(ctx context.Context) (*PossibleRejectReasonsResponse, error) {
url := "/v1/product/certificate/rejection_reasons/list" url := "/v1/product/certificate/rejection_reasons/list"
resp := &PossibleRejectReasonsResponse{} resp := &PossibleRejectReasonsResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp) response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -473,21 +502,69 @@ type PossibleStatusesResponse struct {
core.CommonResponse core.CommonResponse
// Possible certificate statuses // Possible certificate statuses
Result []struct { Result []PossibleStatusesResult `json:"result"`
// Certificate status code
Code string `json:"code"`
// Status description
Name string `json:"name"`
} `json:"result"`
} }
func (c Certificates) PossibleStatuses() (*PossibleStatusesResponse, error) { type PossibleStatusesResult struct {
// Certificate status code
Code string `json:"code"`
// Status description
Name string `json:"name"`
}
func (c Certificates) PossibleStatuses(ctx context.Context) (*PossibleStatusesResponse, error) {
url := "/v1/product/certificate/status/list" url := "/v1/product/certificate/status/list"
resp := &PossibleStatusesResponse{} resp := &PossibleStatusesResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp) response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type AddCertificatesForProductsParams struct {
// Array of certificates for the product. Valid extensions are jpg, jpeg, png, pdf
Files []byte `json:"files"`
// Certificate name. No more than 100 characters
Name string `json:"name"`
// Certificate number. No more than 100 characters
Number string `json:"number"`
// Certificate type. To get the list of types, use the GET `/v1/product/certificate/types` method
TypeCode string `json:"type_code"`
// Accordance type. To get the list of types, use the GET `/v1/product/certificate/accordance-types` method
AccordanceTypeCode string `json:"accordance_type_code"`
// Issue date of the certificate
IssueDate time.Time `json:"issue_date"`
// Expiration date of the certificate. Can be empty for permanent certificates
ExpireDate time.Time `json:"expire_date"`
}
type AddCertificatesForProductsResponse struct {
core.CommonResponse
Id int `json:"id"`
}
// Adding certificates for products
func (c Certificates) AddForProducts(ctx context.Context, params *AddCertificatesForProductsParams) (*AddCertificatesForProductsResponse, error) {
url := "/v1/product/certificate/create"
resp := &AddCertificatesForProductsResponse{}
response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, map[string]string{
"Content-Type": "multipart/form-data",
})
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,8 +1,10 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
"time"
core "github.com/diphantxm/ozon-api-client" core "github.com/diphantxm/ozon-api-client"
) )
@@ -50,11 +52,15 @@ func TestListOfAccordanceTypes(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().ListOfAccordanceTypes() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().ListOfAccordanceTypes(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListOfAccordanceTypesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -112,11 +118,15 @@ func TestDirectoryOfDocumentTypes(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().DirectoryOfDocumentTypes() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().DirectoryOfDocumentTypes(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &DirectoryOfDocumentTypesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -167,11 +177,15 @@ func TestListOfCertifiedCategories(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().ListOfCertifiedCategories(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().ListOfCertifiedCategories(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListOfCertifiedCategoriesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -214,11 +228,15 @@ func TestLinkCertificateToProduct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().LinkToProduct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().LinkToProduct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &LinkCertificateToProductResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -263,11 +281,15 @@ func TestDeleteCertificate(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().Delete(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().Delete(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &DeleteCertificateResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -321,11 +343,15 @@ func TestGetCertificateInfo(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().GetInfo(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().GetInfo(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetCertificateInfoResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -394,11 +420,15 @@ func TestListCertificates(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().List(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().List(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListCertificatesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -440,11 +470,15 @@ func TestProductStatuses(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().ProductStatuses() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().ProductStatuses(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ProductStatusesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -497,11 +531,15 @@ func TestListProductsForCertificate(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().ListProductsForCertificate(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().ListProductsForCertificate(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListProductsForCertificateResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -550,11 +588,15 @@ func TestUnlinkFromProduct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().UnlinkFromProduct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().UnlinkFromProduct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &UnlinkFromProductResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -596,11 +638,15 @@ func TestPossibleRejectReasons(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().PossibleRejectReasons() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().PossibleRejectReasons(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &PossibleRejectReasonsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -642,11 +688,71 @@ func TestPossibleStatuses(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Certificates().PossibleStatuses() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Certificates().PossibleStatuses(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &PossibleStatusesResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestAddCertificatesForProducts(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *AddCertificatesForProductsParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&AddCertificatesForProductsParams{
Files: []byte{10, 15, 2, 0},
Name: "Certificate name",
Number: "10a-d5s9-4asdf2",
TypeCode: "declaration",
AccordanceTypeCode: "gost",
IssueDate: time.Now(),
ExpireDate: time.Now(),
},
`{
"id": 50058
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&AddCertificatesForProductsParams{},
`{
"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.Certificates().AddForProducts(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &AddCertificatesForProductsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -38,36 +39,7 @@ type ListChatsResponse struct {
core.CommonResponse core.CommonResponse
// Chats data // Chats data
Chats []struct { Chats []ListChatsChat `json:"chats"`
// Chat data
Chat struct {
// Chat identifier
ChatId string `json:"chat_id"`
// Chat status:
// - All
// - Opened
// - Closed
ChatStatus string `json:"chat_status"`
// Chat type:
// - Seller_Support — support chat
// - Buyer_Seller — chat with a customer
ChatType string `json:"chat_type"`
// Chat creation date
CreatedAt time.Time `json:"created_at"`
} `json:"chat"`
// Identifier of the first unread chat message
FirstUnreadMessageId string `json:"first_unread_message_id"`
// Identifier of the last message in the chat
LastMessageId string `json:"last_message_id"`
// Number of unread messages in the chat
UnreadCount int64 `json:"unread_count"`
} `json:"chats"`
// Total number of chats // Total number of chats
TotalChatsCount int64 `json:"total_chats_count"` TotalChatsCount int64 `json:"total_chats_count"`
@@ -76,13 +48,46 @@ type ListChatsResponse struct {
TotalUnreadCount int64 `json:"total_unread_count"` TotalUnreadCount int64 `json:"total_unread_count"`
} }
type ListChatsChat struct {
// Chat data
Chat ListChatsChatData `json:"chat"`
// Identifier of the first unread chat message
FirstUnreadMessageId string `json:"first_unread_message_id"`
// Identifier of the last message in the chat
LastMessageId string `json:"last_message_id"`
// Number of unread messages in the chat
UnreadCount int64 `json:"unread_count"`
}
type ListChatsChatData struct {
// Chat identifier
ChatId string `json:"chat_id"`
// Chat status:
// - All
// - Opened
// - Closed
ChatStatus string `json:"chat_status"`
// Chat type:
// - Seller_Support — support chat
// - Buyer_Seller — chat with a customer
ChatType string `json:"chat_type"`
// Chat creation date
CreatedAt time.Time `json:"created_at"`
}
// Returns information about chats by specified filters // Returns information about chats by specified filters
func (c Chats) List(params *ListChatsParams) (*ListChatsResponse, error) { func (c Chats) List(ctx context.Context, params *ListChatsParams) (*ListChatsResponse, error) {
url := "/v2/chat/list" url := "/v2/chat/list"
resp := &ListChatsResponse{} resp := &ListChatsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -107,12 +112,12 @@ type SendMessageResponse struct {
} }
// Sends a message to an existing chat by its identifier // Sends a message to an existing chat by its identifier
func (c Chats) SendMessage(params *SendMessageParams) (*SendMessageResponse, error) { func (c Chats) SendMessage(ctx context.Context, params *SendMessageParams) (*SendMessageResponse, error) {
url := "/v1/chat/send/message" url := "/v1/chat/send/message"
resp := &SendMessageResponse{} resp := &SendMessageResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -140,12 +145,12 @@ type SendFileResponse struct {
} }
// Sends a file to an existing chat by its identifier // Sends a file to an existing chat by its identifier
func (c Chats) SendFile(params *SendFileParams) (*SendFileResponse, error) { func (c Chats) SendFile(ctx context.Context, params *SendFileParams) (*SendFileResponse, error) {
url := "/v1/chat/send/file" url := "/v1/chat/send/file"
resp := &SendFileResponse{} resp := &SendFileResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -179,42 +184,46 @@ type ChatHistoryResponse struct {
HasNext bool `json:"has_next"` HasNext bool `json:"has_next"`
// An array of messages sorted according to the direction parameter in the request body // An array of messages sorted according to the direction parameter in the request body
Messages []struct { Messages []ChatHistoryMessage `json:"messages"`
// Message creation date }
CreatedAt time.Time `json:"created_at"`
// Array with message content in Markdown format type ChatHistoryMessage struct {
Data []string `json:"data"` // Message creation date
CreatedAt time.Time `json:"created_at"`
// Indication of the read message // Array with message content in Markdown format
IsRead bool `json:"is_read"` Data []string `json:"data"`
// Message identifier // Indication of the read message
MessageId string `json:"message_id"` IsRead bool `json:"is_read"`
// Chat participant identifier // Message identifier
User struct { MessageId string `json:"message_id"`
// Chat participant identifier
Id string `json:"id"`
// Chat participant type: // Chat participant identifier
// - customer User ChatHistoryMessageUser `json:"user"`
// - seller }
// - crm—system messages
// - courier type ChatHistoryMessageUser struct {
// - support // Chat participant identifier
Type string `json:"type"` Id string `json:"id"`
} `json:"user"`
} `json:"messages"` // Chat participant type:
// - customer
// - seller
// - crm—system messages
// - courier
// - support
Type string `json:"type"`
} }
// Chat history // Chat history
func (c Chats) History(params *ChatHistoryParams) (*ChatHistoryResponse, error) { func (c Chats) History(ctx context.Context, params *ChatHistoryParams) (*ChatHistoryResponse, error) {
url := "/v2/chat/history" url := "/v2/chat/history"
resp := &ChatHistoryResponse{} resp := &ChatHistoryResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -238,89 +247,103 @@ type UpdateChatResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result []struct { Result []UpdateChatResult `json:"result"`
// An order or a product user wrote about in the chat }
Context struct {
// Product inforamtion
Item struct {
// Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
} `json:"item"`
// Order information type UpdateChatResult struct {
Order struct { // An order or a product user wrote about in the chat
// Order number Context UpdateChatResultContext `json:"context"`
OrderNumber string `json:"order_number"`
// Shipment information // Creation date and time
Postings []struct { CreatedAt time.Time `json:"created_at"`
// Delivery scheme:
// - FBO
// - FBS
// - RFBS
// - Crossborder
DeliverySchema string `json:"delivery_schema"`
// Shipment number // Information about the file in the chat. Displayed only for `type = file`
PostingNumber string `json:"posting_number"` File UpdateChatResultFile `json:"file"`
// List of product identifiers in the shipment // File identifier
SKUList []int64 `json:"sku_list"` Id uint64 `json:"id"`
} `json:"postings"`
} `json:"order"`
} `json:"context"`
// Creation date and time // Message. Displayed only for `type = text`
CreatedAt time.Time `json:"created_at"` Text string `json:"text"`
// Information about the file in the chat. Displayed only for `type = file` // Message type:
File struct { // - text
// File type // - file
Mime string `json:"mime"` Type string `json:"type"`
// File name // Chat participant information
Name string `json:"name"` User UpdateChatResultUser `json:"user"`
}
// File size in bytes type UpdateChatResultContext struct {
Size int64 `json:"size"` // Product inforamtion
Item UpdateChatResultContextItem `json:"item"`
// File URL // Order information
URL string `json:"url"` Order UpdateChatResultContextOrder `json:"order"`
} `json:"file"` }
// File identifier type UpdateChatResultContextItem struct {
Id uint64 `json:"id"` // Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
}
// Message. Displayed only for `type = text` type UpdateChatResultContextOrder struct {
Text string `json:"text"` // Order number
OrderNumber string `json:"order_number"`
// Message type: // Shipment information
// - text Postings []UpdateChatResultContextOrderPosting `json:"postings"`
// - file }
Type string `json:"type"`
// Chat participant information type UpdateChatResultContextOrderPosting struct {
User struct { // Delivery scheme:
// Chat participant identifier // - FBO
Id string `json:"id"` // - FBS
// - RFBS
// - Crossborder
DeliverySchema string `json:"delivery_schema"`
// Chat participant chat: // Shipment number
// - customer PostingNumber string `json:"posting_number"`
// - seller
// - crm—system messages // List of product identifiers in the shipment
// - courier SKUList []int64 `json:"sku_list"`
Type string `json:"type"` }
} `json:"user"`
} `json:"result"` type UpdateChatResultFile struct {
// File type
Mime string `json:"mime"`
// File name
Name string `json:"name"`
// File size in bytes
Size int64 `json:"size"`
// File URL
URL string `json:"url"`
}
type UpdateChatResultUser struct {
// Chat participant identifier
Id string `json:"id"`
// Chat participant chat:
// - customer
// - seller
// - crm—system messages
// - courier
Type string `json:"type"`
} }
// Update chat // Update chat
func (c Chats) Update(params *UpdateChatParams) (*UpdateChatResponse, error) { func (c Chats) Update(ctx context.Context, params *UpdateChatParams) (*UpdateChatResponse, error) {
url := "/v1/chat/updates" url := "/v1/chat/updates"
resp := &UpdateChatResponse{} resp := &UpdateChatResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -338,19 +361,21 @@ type CreateNewChatResponse struct {
core.CommonResponse core.CommonResponse
//Method result //Method result
Result struct { Result CreateNewChatResult `json:"result"`
// Chat identifier }
ChatId string `json:"chat_id"`
} `json:"result"` type CreateNewChatResult struct {
// Chat identifier
ChatId string `json:"chat_id"`
} }
// Creates a new chat on the shipment with the customer. For example, to clarify the address or the product model // Creates a new chat on the shipment with the customer. For example, to clarify the address or the product model
func (c Chats) Create(params *CreateNewChatParams) (*CreateNewChatResponse, error) { func (c Chats) Create(ctx context.Context, params *CreateNewChatParams) (*CreateNewChatResponse, error) {
url := "/v1/chat/start" url := "/v1/chat/start"
resp := &CreateNewChatResponse{} resp := &CreateNewChatResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -375,12 +400,12 @@ type MarkAsReadResponse struct {
} }
// A method for marking the selected message and messages before it as read // A method for marking the selected message and messages before it as read
func (c Chats) MarkAsRead(params *MarkAsReadParams) (*MarkAsReadResponse, error) { func (c Chats) MarkAsRead(ctx context.Context, params *MarkAsReadParams) (*MarkAsReadResponse, error) {
url := "/v2/chat/read" url := "/v2/chat/read"
resp := &MarkAsReadResponse{} resp := &MarkAsReadResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -61,11 +62,15 @@ func TestListChats(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Chats().List(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Chats().List(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListChatsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -119,11 +124,15 @@ func TestSendMessage(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Chats().SendMessage(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Chats().SendMessage(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &SendMessageResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -167,11 +176,15 @@ func TestSendFile(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Chats().SendFile(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Chats().SendFile(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &SendFileResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -230,11 +243,15 @@ func TestChatHistory(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Chats().History(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Chats().History(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ChatHistoryResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -296,11 +313,15 @@ func TestUpdateChat(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Chats().Update(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Chats().Update(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &UpdateChatResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -344,11 +365,15 @@ func TestCreateNewChat(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Chats().Create(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Chats().Create(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CreateNewChatResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -397,11 +422,15 @@ func TestMarkAsRead(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Chats().MarkAsRead(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Chats().MarkAsRead(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &MarkAsReadResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

681
ozon/common.go Normal file
View File

@@ -0,0 +1,681 @@
package ozon
import "time"
const (
testTimeout = 5 * time.Second
)
type Order string
const (
Ascending Order = "ASC"
Descending Order = "DESC"
)
type GetAnalyticsDataFilterOperation string
const (
Equal GetAnalyticsDataFilterOperation = "EQ"
Greater GetAnalyticsDataFilterOperation = "GT"
GreaterEqual GetAnalyticsDataFilterOperation = "GTE"
Lesser GetAnalyticsDataFilterOperation = "LT"
LesserEqual GetAnalyticsDataFilterOperation = "LTE"
)
type GetAnalyticsDataFilterMetric string
const (
UnknownMetric GetAnalyticsDataFilterMetric = "unknown_metric"
HitsViewSearch GetAnalyticsDataFilterMetric = "hits_view_search"
HistViewPDP GetAnalyticsDataFilterMetric = "hits_view_pdp"
HitsView GetAnalyticsDataFilterMetric = "hist_view"
HitsToCartSearch GetAnalyticsDataFilterMetric = "hits_tocart_search"
HitsToCartPDP GetAnalyticsDataFilterMetric = "hits_tocart_pdp"
SessionViewSearch GetAnalyticsDataFilterMetric = "session_view_search"
SessionViewPDP GetAnalyticsDataFilterMetric = "session_view_pdp"
SessionView GetAnalyticsDataFilterMetric = "session_view"
ConvToCartSearch GetAnalyticsDataFilterMetric = "conv_tocart_search"
ConvToCartPDP GetAnalyticsDataFilterMetric = "conv_tocart_pdp"
ConvToCart GetAnalyticsDataFilterMetric = "conv_tocart"
Revenue GetAnalyticsDataFilterMetric = "revenue"
ReturnsMetric GetAnalyticsDataFilterMetric = "returns"
CancellationsMetric GetAnalyticsDataFilterMetric = "cancellations"
OrderedUnits GetAnalyticsDataFilterMetric = "ordered_units"
DeliveredUnits GetAnalyticsDataFilterMetric = "delivered_units"
PositionCategory GetAnalyticsDataFilterMetric = "position_category"
)
type WarehouseType string
const (
// Ozon warehouses with Fresh delivery
ExpressDarkStore WarehouseType = "EXPRESS_DARK_STORE"
// Ozon warehouses without Fresh delivery
NotExressDarkStore WarehouseType = "NOT_EXPRESS_DARK_STORE"
// All Ozon warehouses
ALLWarehouseType WarehouseType = "ALL"
)
type Language string
const (
Default Language = "DEFAULT"
Russian Language = "RU"
English Language = "EN"
Turkish Language = "TR"
Chinese Language = "ZH_HANS"
)
type AttributeType string
const (
All AttributeType = "ALL"
Required AttributeType = "REQUIRED"
Optional AttributeType = "OPTIONAL"
)
type ListDiscountRequestsStatus string
const (
New ListDiscountRequestsStatus = "NEW"
Seen ListDiscountRequestsStatus = "SEEN"
Approved ListDiscountRequestsStatus = "APPROVED"
PartlyApproved ListDiscountRequestsStatus = "PARTLY_APPROVED"
Declined ListDiscountRequestsStatus = "DECLINED"
AutoDeclined ListDiscountRequestsStatus = "AUTO_DECLINED"
DeclinedByUser ListDiscountRequestsStatus = "DECLINED_BY_USER"
Coupon ListDiscountRequestsStatus = "COUPON"
Purchased ListDiscountRequestsStatus = "PURCHASED"
)
type WorkingDay string
const (
Mon WorkingDay = "1"
Tue WorkingDay = "2"
Wed WorkingDay = "3"
Thu WorkingDay = "4"
Fri WorkingDay = "5"
Sat WorkingDay = "6"
Sun WorkingDay = "7"
)
type GetAnalyticsDataDimension string
const (
UnknownDimension GetAnalyticsDataDimension = "unknownDimension"
SKUDimension GetAnalyticsDataDimension = "sku"
SPUDimension GetAnalyticsDataDimension = "spu"
DayDimension GetAnalyticsDataDimension = "day"
WeekDimension GetAnalyticsDataDimension = "week"
MonthDimension GetAnalyticsDataDimension = "month"
YearDimension GetAnalyticsDataDimension = "year"
Category1Dimension GetAnalyticsDataDimension = "category1"
Category2Dimension GetAnalyticsDataDimension = "category2"
Category3Dimension GetAnalyticsDataDimension = "category3"
Category4Dimension GetAnalyticsDataDimension = "category4"
BrandDimension GetAnalyticsDataDimension = "brand"
ModelIDDimension GetAnalyticsDataDimension = "modelID"
)
type SupplyRequestState string
const (
// request draft. Only for supplies via vDC
Draft SupplyRequestState = "DRAFT"
// selecting supply options. Only for supplies via vDC
SupplyVariantsArranging SupplyRequestState = "SUPPLY_VARIANTS_ARRANGING"
// no supply options, the request is archived. Only for supplies via vDC
HasNoSupplyVariantsArchive SupplyRequestState = "HAS_NO_SUPPLY_VARIANTS_ARCHIVE"
// no supply options. Only for supplies via vDC
HasNoSupplyVariantsNew SupplyRequestState = "HAS_NO_SUPPLY_VARIANTS_NEW"
// supply being approved. Only for supplies via vDC
SupplyVariantsConfirmation SupplyRequestState = "SUPPLY_VARIANTS_CONFIRMATION"
// time reservation
TimeslotBooking SupplyRequestState = "TIMESLOT_BOOKING"
// filling in the data
DATA_FILLING SupplyRequestState = "DATA_FILLING"
// ready for shipment
ReadyToSupply SupplyRequestState = "READY_TO_SUPPLY"
// accepted at the shipping point
AcceptedAtSupplyWarehouse SupplyRequestState = "ACCEPTED_AT_SUPPLY_WAREHOUSE"
// on the way
InTransit SupplyRequestState = "IN_TRANSIT"
// acceptance at the warehouse
AcceptanceAtStorageWarehouse SupplyRequestState = "ACCEPTANCE_AT_STORAGE_WAREHOUSE"
// acts being approved
ReportsConfirmationAwaiting SupplyRequestState = "REPORTS_CONFIRMATION_AWAITING"
// dispute
ReportRejected SupplyRequestState = "REPORT_REJECTED"
// completed
Completed SupplyRequestState = "COMPLETED"
// refused acceptance
RejectedAtSupplyWarehouse SupplyRequestState = "REJECTED_AT_SUPPLY_WAREHOUSE"
// cancelled
Cancelled SupplyRequestState = "CANCELLED"
// overdue
Overdue SupplyRequestState = "OVERDUE"
)
type ShipmentStatus string
const (
// acceptance is in progress
AcceptanceInProgress ShipmentStatus = "acceptance_in_progress"
// arbitration
Arbitration ShipmentStatus = "arbitration"
// awaiting confirmation
AwaitingApprove ShipmentStatus = "awaiting_approve"
// awaiting shipping
AwaitingDeliver ShipmentStatus = "awaiting_deliver"
// awaiting packaging
AwaitingPackaging ShipmentStatus = "awaiting_packaging"
// created
AwaitingVerification ShipmentStatus = "awaiting_verification"
// cancelled
CancelledSubstatus ShipmentStatus = "cancelled"
// delivered
Delivered ShipmentStatus = "delivered"
// delivery is in progress
Delivering ShipmentStatus = "delivering"
// picked up by driver
DriverPickup ShipmentStatus = "driver_pickup"
// not accepted at the sorting center
NotAccepted ShipmentStatus = "not_accepted"
// sent by the seller
SentBySeller ShipmentStatus = "sent_by_seller"
)
type ShipmentSubstatus string
const (
// acceptance in progress
PostingAcceptanceInProgress ShipmentStatus = "posting_acceptance_in_progress"
// arbitrage
PostingInArbitration ShipmentStatus = "posting_in_arbitration"
// created
PostingCreated ShipmentStatus = "posting_created"
// in the freight
PostingInCarriage ShipmentStatus = "posting_in_carriage"
// not added to the freight
PostingNotInCarriage ShipmentStatus = "posting_not_in_carriage"
// registered
PostingRegistered ShipmentStatus = "posting_registered"
// is handed over to the delivery service
PostingTransferringToDelivery ShipmentStatus = "posting_transferring_to_delivery"
// waiting for passport data
PostingAwaitingPassportData ShipmentStatus = "posting_awaiting_passport_data"
// created
PostingCreatedSubstatus ShipmentStatus = "posting_created"
// awaiting registration
PostingAwaitingRegistration ShipmentStatus = "posting_awaiting_registration"
// registration error
PostingRegistrationError ShipmentStatus = "posting_registration_error"
// created
PostingSplitPending ShipmentStatus = "posting_split_pending"
// canceled
PostingCancelled ShipmentStatus = "posting_canceled"
// customer delivery arbitrage
PostingInClientArbitration ShipmentStatus = "posting_in_client_arbitration"
// delivered
PostingDelivered ShipmentStatus = "posting_delivered"
// recieved
PostingReceived ShipmentStatus = "posting_received"
// presumably delivered
PostingConditionallyDelivered ShipmentStatus = "posting_conditionally_delivered"
// courier on the way
PostingInCourierService ShipmentStatus = "posting_in_courier_service"
// at the pick-up point
PostingInPickupPoint ShipmentStatus = "posting_in_pickup_point"
// on the way to the city
PostingOnWayToCity ShipmentStatus = "posting_on_way_to_city"
// on the way to the pick-up point
PostingOnWayToPickupPoint ShipmentStatus = "posting_on_way_to_pickup_point"
// returned to the warehouse
PostingReturnedToWarehouse ShipmentStatus = "posting_returned_to_warehouse"
// is handed over to the courier
PostingTransferredToCourierService ShipmentStatus = "posting_transferred_to_courier_service"
// handed over to the driver
PostingDriverPickup ShipmentStatus = "posting_driver_pick_up"
// not accepted at the sorting center
PostingNotInSortCenter ShipmentStatus = "posting_not_in_sort_center"
// sent by the seller
SentBySellerSubstatus ShipmentStatus = "sent_by_seller"
)
type TPLIntegrationType string
const (
// delivery by the Ozon logistics
OzonTPLType TPLIntegrationType = "ozon"
// delivery by a third-party service, Ozon registers the order
AggregatorTPLType TPLIntegrationType = "aggregator"
// delivery by a third-party service, the seller registers the order
TrackingTPLType TPLIntegrationType = "3pl_tracking"
// delivery by the seller
NonIntegratedTPLType TPLIntegrationType = "non_integrated"
)
type DetailsDeliveryItemName string
const (
DirectFlowLogisticSumDetailsDeliveryItemName DetailsDeliveryItemName = "MarketplaceServiceItemDirectFlowLogisticSum"
DropoffDetailsDeliveryItemName DetailsDeliveryItemName = "MarketplaceServiceItemDropoff"
DelivToCustomerDetailsDeliveryItemName DetailsDeliveryItemName = "MarketplaceServiceItemDelivToCustomer"
)
type DetailsReturnServiceName string
const (
ReturnAfterDelivToCustomerDetailsReturnServiceName DetailsReturnServiceName = "MarketplaceServiceItemReturnAfterDelivToCustomer"
ReturnPartGoodsCustomerDetailsReturnServiceName DetailsReturnServiceName = "MarketplaceServiceItemReturnPartGoodsCustomer"
ReturnNotDelivToCustomerDetailsReturnServiceName DetailsReturnServiceName = "MarketplaceServiceItemReturnNotDelivToCustomer"
ReturnFlowLogisticDetailsReturnServiceName DetailsReturnServiceName = "MarketplaceServiceItemReturnFlowLogistic"
)
type DetailsServiceItemName string
const (
OtherMarketAndTech DetailsServiceItemName = "MarketplaceServiceItemOtherMarketAndTechService"
ReturnStorageServiceAtThePickupPointFbsItem DetailsServiceItemName = "MarketplaceReturnStorageServiceAtThePickupPointFbsItem"
SaleReviewsItem DetailsServiceItemName = "MarketplaceSaleReviewsItem"
ServicePremiumCashbackIndividualPoints DetailsServiceItemName = "MarketplaceServicePremiumCashbackIndividualPoints"
ServiceStorageItem DetailsServiceItemName = "MarketplaceServiceStorageItem"
ServiceStockDisposal DetailsServiceItemName = "MarketplaceServiceStockDisposal"
ReturnDisposalServiceFbsItem DetailsServiceItemName = "MarketplaceReturnDisposalServiceFbsItem"
ServiceItemFlexiblePaymentSchedule DetailsServiceItemName = "MarketplaceServiceItemFlexiblePaymentSchedule"
ServiceProcessingSpoilage DetailsServiceItemName = "MarketplaceServiceProcessingSpoilage"
ServiceProcessingIdentifiedSurplus DetailsServiceItemName = "MarketplaceServiceProcessingIdentifiedSurplus"
ServiceProcessingIdentifiedDiscrepancies DetailsServiceItemName = "MarketplaceServiceProcessingIdentifiedDiscrepancies"
ServiceItemInternetSiteAdvertising DetailsServiceItemName = "MarketplaceServiceItemInternetSiteAdvertising"
ServiceItemPremiumSubscribtion DetailsServiceItemName = "MarketplaceServiceItemPremiumSubscribtion"
AgencyFeeAggregator3PLGlobalItem DetailsServiceItemName = "MarketplaceAgencyFeeAggregator3PLGlobalItem"
)
type DetailsOtherItemName string
const (
RedistributionOfAcquiringOperation DetailsOtherItemName = "MarketplaceRedistributionOfAcquiringOperation"
CompensationLossOfGoodsOperation DetailsOtherItemName = "MarketplaceSellerCompensationLossOfGoodsOperation"
CorrectionOperation DetailsOtherItemName = "MarketplaceSellerCorrectionOperation"
OperationCorrectionSeller DetailsOtherItemName = "OperationCorrectionSeller"
OperationMarketplaceWithHoldingForUndeliverableGoods DetailsOtherItemName = "OperationMarketplaceWithHoldingForUndeliverableGoods"
OperationClaim DetailsOtherItemName = "OperationClaim"
)
type StrategyType string
const (
MinExtPrice StrategyType = "MIN_EXT_PRICE"
CompPrice StrategyType = "COMP_PRICE"
)
type StrategyUpdateType string
const (
StrategyEnabled StrategyUpdateType = "strategyEnabled"
StrategyDisabled StrategyUpdateType = "strategyDisabled"
StrategyChanged StrategyUpdateType = "strategyChanged"
StrategyCreated StrategyUpdateType = "strategyCreated"
StrategyItemsListChanged StrategyUpdateType = "strategyItemsListChanged"
)
type ShipmentCertificateFilterStatus string
const (
// new
ShitmentCertificateFilterNew ShipmentCertificateFilterStatus = "new"
// retry creation
ShitmentCertificateFilterAwaitingRetry ShipmentCertificateFilterStatus = "awaiting-retry"
// is being packaged
ShitmentCertificateFilterInProcess ShipmentCertificateFilterStatus = "in_process"
// created
ShitmentCertificateFilterSuccess ShipmentCertificateFilterStatus = "success"
// creation error
ShitmentCertificateFilterError ShipmentCertificateFilterStatus = "error"
// sent
ShitmentCertificateFilterSend ShipmentCertificateFilterStatus = "sent"
// received
ShitmentCertificateFilterReceived ShipmentCertificateFilterStatus = "received"
// packaged
ShitmentCertificateFilterFormed ShipmentCertificateFilterStatus = "formed"
// canceled
ShitmentCertificateFilterCancelled ShipmentCertificateFilterStatus = "cancelled"
// in the queue for packaging
ShitmentCertificateFilterPending ShipmentCertificateFilterStatus = "pending"
// in the queue for completion
ShitmentCertificateFilterCompletionEnqueued ShipmentCertificateFilterStatus = "completion_enqueued"
// in the process of completion
ShitmentCertificateFilterCompletionProcessing ShipmentCertificateFilterStatus = "completion_processing"
// completion error
ShitmentCertificateFilterCompletionFailed ShipmentCertificateFilterStatus = "completion_failed"
// in the queue for cancellation
ShitmentCertificateFilterCancelationEnqueued ShipmentCertificateFilterStatus = "cancelation_enqueued"
// in the process of cancellation
ShitmentCertificateFilterCancelationProcessing ShipmentCertificateFilterStatus = "cancelation_processing"
// cancellation error
ShitmentCertificateFilterCancelationFailed ShipmentCertificateFilterStatus = "cancelation_failed"
// completed
ShitmentCertificateFilterCompleted ShipmentCertificateFilterStatus = "completed"
// closed
ShitmentCertificateFilterClosed ShipmentCertificateFilterStatus = "closed"
)
type PRROptionStatus string
const (
// carrying the bulky product using the elevator
PRROptionLift PRROptionStatus = "lift"
// carrying the bulky product upstairs
PRROptionStairs PRROptionStatus = "stairs"
// the customer canceled the service,
// you don't need to lift the shipment
PRROptionNone PRROptionStatus = "none"
// delivery is included in the price.
// According to the offer you need to
// deliver products to the floor
PRROptionDeliveryDefault PRROptionStatus = "delivery_default"
)
type GetFBSReturnsFilterStatus string
const (
ReturnedToSeller GetFBSReturnsFilterStatus = "returned_to_seller"
WaitingForSeller GetFBSReturnsFilterStatus = "waiting_for_seller"
AcceptedFromCustomer GetFBSReturnsFilterStatus = "accepted_from_customer"
CancelledWithCompensation GetFBSReturnsFilterStatus = "cancelled_with_compensation"
ReadyForShipment GetFBSReturnsFilterStatus = "ready_for_shipment"
)
type GetFBOReturnsFilterStatus string
const (
GetFBOReturnsFilterStatusReturnedToOzon GetFBOReturnsFilterStatus = "ReturnedToOzon"
GetFBOReturnsFilterStatusCancelled GetFBOReturnsFilterStatus = "Cancelled"
)
type GetFBOReturnsReturnStatus string
const (
GetFBOReturnsReturnStatusCancelled GetFBOReturnsReturnStatus = "Возврат отменен"
GetFBOReturnsReturnStatusAcceptedFromCustomer GetFBOReturnsReturnStatus = "Принят от покупателя"
GetFBOReturnsReturnStatusReceivedAtOzon GetFBOReturnsReturnStatus = "Получен в Ozon"
)
type DigitalActType string
const (
// acceptance certificate
DigitalActTypeOfAcceptance DigitalActType = "act_of_acceptance"
// discrepancy certificate
DigitalActTypeOfMismatch DigitalActType = "act_of_mismatch"
// surplus certificate
DigitalActTypeOfExcess DigitalActType = "act_of_excess"
)
type PriceStrategy string
const (
// enable
PriceStrategyEnabled PriceStrategy = "ENABLED"
// disable
PriceStrategyDisabled PriceStrategy = "DISABLED"
// don't change anything. Default value
PriceStrategyUnknown PriceStrategy = "UNKNOWN"
)
type FBPFilter string
const (
// all shipments matching other filters will be returned in the response
FBPFilterAll FBPFilter = "all"
// only FBP shipments will be returned
FBPFilterOnly FBPFilter = "only"
// all shipments except FBP will be returned
FBPFilterWithout FBPFilter = "without"
)
type InvoiceCurrency string
const (
// dollar
InvoiceCurrencyUSD InvoiceCurrency = "USD"
// euro
InvoiceCurrencyEUR InvoiceCurrency = "EUR"
// Turkish lira
InvoiceCurrencyTRY InvoiceCurrency = "TRY"
// yuan
InvoiceCurrencyCNY InvoiceCurrency = "CNY"
// ruble
InvoiceCurrencyRUB InvoiceCurrency = "RUB"
// pound sterling
InvoiceCurrencyGBP InvoiceCurrency = "GBP"
)
type ReportType string
const (
// products report
ReportTypeSellerProducts ReportType = "SELLER_PRODUCTS"
// transactions report
ReportTypeSellerTransactions ReportType = "SELLER_TRANSACTIONS"
// product prices report
ReportTypeSellerProductPrices ReportType = "SELLER_PRODUCT_PRICES"
// stocks report
ReportTypeSellerStock ReportType = "SELLER_STOCK"
// products movement report
ReportTypeSellerProductMovement ReportType = "SELLER_PRODUCT_MOVEMENT"
// returns report
ReportTypeSellerReturns ReportType = "SELLER_RETURNS"
// shipments report
ReportTypeSellerPostings ReportType = "SELLER_POSTINGS"
// financial report
ReportTypeSellerFinance ReportType = "SELLER_FINANCE"
)
type ReportInfoStatus string
const (
ReportInfoWaiting ReportInfoStatus = "waiting"
ReportInfoProcessing ReportInfoStatus = "processing"
ReportInfoSuccess ReportInfoStatus = "success"
ReportInfoFailed ReportInfoStatus = "failed"
)
type SKUAvailability string
const (
SKUAvailabilityHidden = "HIDDEN"
SKUAvailabilityAvailable = "AVAILABLE"
// SKU is deleted
SKUAvailabilityUnavailable = "UNAVAILABLE"
)
type RFBSReturnsGroupState string
const (
// All requests
RFBSReturnsGroupStateAll RFBSReturnsGroupState = "All"
// New
RFBSReturnsGroupStateNew RFBSReturnsGroupState = "New"
// Returned product is on the way for check
RFBSReturnsGroupStateDelivering RFBSReturnsGroupState = "Delivering"
// Returned product is being checked
RFBSReturnsGroupStateCheckout RFBSReturnsGroupState = "Checkout"
// Disputed
RFBSReturnsGroupStateArbitration RFBSReturnsGroupState = "Arbitration"
// Approved
RFBSReturnsGroupStateApproved RFBSReturnsGroupState = "Approved"
// Rejected
RFBSReturnsGroupStateRejected RFBSReturnsGroupState = "Rejected"
)
type GetRFBSReturnsCurrency string
const (
// Russian ruble
GetRFBSReturnsCurrencyRUB GetRFBSReturnsCurrency = "RUB"
// Belarusian ruble
GetRFBSReturnsCurrencyBYN GetRFBSReturnsCurrency = "BYN"
// Tenge
GetRFBSReturnsCurrencyKZT GetRFBSReturnsCurrency = "KZT"
// Euro
GetRFBSReturnsCurrencyEUR GetRFBSReturnsCurrency = "EUR"
// US dollar
GetRFBSReturnsCurrencyUSD GetRFBSReturnsCurrency = "USD"
// Yuan
GetRFBSReturnsCurrencyCNY GetRFBSReturnsCurrency = "CNY"
)
type GiveoutStatus string
const (
// Undefined, contact support team
GiveoutStatusUnspecified GiveoutStatus = "GIVEOUT_STATUS_UNSPECIFIED"
// Created
GiveoutStatusCreated GiveoutStatus = "GIVEOUT_STATUS_CREATED"
// Approved
GiveoutStatusApproved GiveoutStatus = "GIVEOUT_STATUS_APPROVED"
// Completed
GiveoutStatusCompleted GiveoutStatus = "GIVEOUT_STATUS_COMPLETED"
// Cancelled
GiveoutStatusCancelled GiveoutStatus = "GIVEOUT_STATUS_CANCELLED"
)
type GiveoutDeliverySchema string
const (
// Undefined, contact support team
GiveoutDeliverySchemaUnspecified GiveoutDeliverySchema = "GIVEOUT_DELIVERY_SCHEMA_UNSPECIFIED"
// FBO
GiveoutDeliverySchemaFBO GiveoutDeliverySchema = "GIVEOUT_DELIVERY_SCHEMA_FBO"
// FBS
GiveoutDeliverySchemaFBS GiveoutDeliverySchema = "GIVEOUT_DELIVERY_SCHEMA_FBS"
)
type MandatoryMarkStatus string
const (
// Labeling is processed
MandatoryMarkStatusProcessing MandatoryMarkStatus = "processing"
// Check is passed
MandatoryMarkStatusPassed MandatoryMarkStatus = "passed"
// Check is failed
MandatoryMarkStatusFailed MandatoryMarkStatus = "failed"
)

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -56,69 +57,75 @@ type GetFBOShipmentsListResponse struct {
core.CommonResponse core.CommonResponse
// Shipments list // Shipments list
Result []struct { Result []GetFBOShipmentsListResult `json:"result"`
// Additional data for shipment list }
AdditionalData []struct {
Key string `json:"key"`
Value string `json:"value"`
} `json:"additional_data"`
// Analytical data type GetFBOShipmentsListResult struct {
AnalyticsData struct { // Additional data for shipment list
// Delivery city AdditionalData []GetFBOShipmentsListResultAdditionalData `json:"additional_data"`
City string `json:"city"`
// Delivery method // Analytical data
DeliveryType string `json:"delivery_type"` AnalyticsData GetFBOShipmentsListResultAnalyticsData `json:"analytics_data"`
// Indication that the recipient is a legal person // Shipment cancellation reason identifier
// * true — a legal person, CancelReasonId int64 `json:"cancel_reason_id"`
// * false — a natural person.
IsLegal bool `json:"is_legal"`
// Premium subscription // Date and time of shipment creation
IsPremium bool `json:"is_premium"` CreatedAt time.Time `json:"created_at"`
// Payment method // Financial data
PaymentTypeGroupName string `json:"payment_type_group_name"` FinancialData FBOFinancialData `json:"financial_data"`
// Delivery region // Date and time of shipment processing start
Region string `json:"region"` InProccessAt time.Time `json:"in_process_at"`
// Warehouse identifier // Identifier of the order to which the shipment belongs
WarehouseId int64 `json:"warehouse_id"` OrderId int64 `json:"order_id"`
// Name of the warehouse from which the order is shipped // Number of the order to which the shipment belongs
WarehouseName string `json:"warehouse_name"` OrderNumber string `json:"order_number"`
} `json:"analytics_data"`
// Shipment cancellation reason identifier // Shipment number
CancelReasonId int64 `json:"cancel_reason_id"` PostingNumber string `json:"posting_number"`
// Date and time of shipment creation // Number of products in the shipment
CreatedAt time.Time `json:"created_at"` Products []FBOPostingProduct `json:"products"`
// Financial data // Shipment status
FinancialData FBOFinancialData `json:"financial_data"` Status string `json:"status"`
}
// Date and time of shipment processing start type GetFBOShipmentsListResultAdditionalData struct {
InProccessAt time.Time `json:"in_process_at"` Key string `json:"key"`
Value string `json:"value"`
}
// Identifier of the order to which the shipment belongs type GetFBOShipmentsListResultAnalyticsData struct {
OrderId int64 `json:"order_id"` // Delivery city
City string `json:"city"`
// Number of the order to which the shipment belongs // Delivery method
OrderNumber string `json:"order_number"` DeliveryType string `json:"delivery_type"`
// Shipment number // Indication that the recipient is a legal person
PostingNumber string `json:"posting_number"` // * true — a legal person,
// * false — a natural person.
IsLegal bool `json:"is_legal"`
// Number of products in the shipment // Premium subscription
Products []FBOPostingProduct `json:"products"` IsPremium bool `json:"is_premium"`
// Shipment status // Payment method
Status string `json:"status"` PaymentTypeGroupName string `json:"payment_type_group_name"`
} `json:"result"`
// Delivery region
Region string `json:"region"`
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
// Name of the warehouse from which the order is shipped
WarehouseName string `json:"warehouse_name"`
} }
type FBOPostingProduct struct { type FBOPostingProduct struct {
@@ -159,12 +166,12 @@ type FBOFinancialData struct {
} }
// Returns a list of shipments for a specified period of time. You can additionally filter the shipments by their status // Returns a list of shipments for a specified period of time. You can additionally filter the shipments by their status
func (c FBO) GetShipmentsList(params *GetFBOShipmentsListParams) (*GetFBOShipmentsListResponse, error) { func (c FBO) GetShipmentsList(ctx context.Context, params *GetFBOShipmentsListParams) (*GetFBOShipmentsListResponse, error) {
url := "/v2/posting/fbo/list" url := "/v2/posting/fbo/list"
resp := &GetFBOShipmentsListResponse{} resp := &GetFBOShipmentsListResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -173,7 +180,7 @@ func (c FBO) GetShipmentsList(params *GetFBOShipmentsListParams) (*GetFBOShipmen
return resp, nil return resp, nil
} }
type GetShipmentDetailsParams struct{ type GetShipmentDetailsParams struct {
// Shipment number // Shipment number
PostingNumber string `json:"posting_number"` PostingNumber string `json:"posting_number"`
@@ -184,7 +191,7 @@ type GetShipmentDetailsParams struct{
With GetShipmentDetailsWith `json:"with"` With GetShipmentDetailsWith `json:"with"`
} }
type GetShipmentDetailsWith struct{ type GetShipmentDetailsWith struct {
// Specify true to add analytics data to the response // Specify true to add analytics data to the response
AnalyticsData bool `json:"analytics_data"` AnalyticsData bool `json:"analytics_data"`
@@ -192,82 +199,363 @@ type GetShipmentDetailsWith struct{
FinancialData bool `json:"financial_data"` FinancialData bool `json:"financial_data"`
} }
type GetShipmentDetailsResponse struct{ type GetShipmentDetailsResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct{ Result GetShipmentDetailsResult `json:"result"`
// Additional data }
AdditionalData []struct{
Key string `json:"key"`
Value string `json:"value"`
} `json:"additional_data"`
// Analytical data type GetShipmentDetailsResult struct {
AnalyticsData struct{ // Additional data
// Delivery city AdditionalData []GetShipmentDetailsResultAdditionalData `json:"additional_data"`
City string `json:"Delivery city"`
// Delivery method // Analytical data
DeliveryType string `json:"delivery_type"` AnalyticsData GetShipmentDetailsResultAnalyticsData `json:"analytics_data"`
// Indication that the recipient is a legal person: // Shipment cancellation reason identifier
// - true — a legal person CancelReasonId int64 `json:"cancel_reason_id"`
// - false — a natural person
IsLegal bool `json:"is_legal"`
// Premium subscription // Date and time of shipment creation
IsPremium bool `json:"is_premium"` CreatedAt time.Time `json:"created_at"`
// Payment method // Financial data
PaymentTypeGroupName string `json:"payment_type_group_name"` FinancialData FBOFinancialData `json:"financial_data"`
// Delivery region // Date and time of shipment processing start
Region string `json:"region"` InProcessAt time.Time `json:"in_process_at"`
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
// Name of the warehouse from which the order is shipped // Identifier of the order to which the shipment belongs
WarehouseName string `json:"warehouse_name"` OrderId int64 `json:"order_id"`
} `json:"analytics_data"`
// Shipment cancellation reason identifier // Number of the order to which the shipment belongs
CancelReasonId int64 `json:"cancel_reason_id"` OrderNumber string `json:"order_number"`
// Date and time of shipment creation // Shipment number
CreatedAt time.Time `json:"created_at"` PostingNumber string `json:"posting_number"`
// Financial data // Number of products in the shipment
FinancialData FBOFinancialData `json:"financial_data"` Products []FBOPostingProduct `json:"products"`
// Date and time of shipment processing start // Shipment status
InProcessAt time.Time `json:"in_process_at"` Status string `json:"status"`
}
// Identifier of the order to which the shipment belongs type GetShipmentDetailsResultAdditionalData struct {
OrderId int64 `json:"order_id"` Key string `json:"key"`
Value string `json:"value"`
}
// Number of the order to which the shipment belongs type GetShipmentDetailsResultAnalyticsData struct {
OrderNumber string `json:"order_number"` // Delivery city
City string `json:"city"`
// Shipment number // Delivery method
PostingNumber string `json:"posting_number"` DeliveryType string `json:"delivery_type"`
// Number of products in the shipment // Indication that the recipient is a legal person:
Products []FBOPostingProduct `json:"products"` // - true — a legal person
// - false — a natural person
IsLegal bool `json:"is_legal"`
// Shipment status // Premium subscription
Status string `json:"status"` IsPremium bool `json:"is_premium"`
} `json:"result"`
// Payment method
PaymentTypeGroupName string `json:"payment_type_group_name"`
// Delivery region
Region string `json:"region"`
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
// Name of the warehouse from which the order is shipped
WarehouseName string `json:"warehouse_name"`
} }
// Returns information about the shipment by its identifier // Returns information about the shipment by its identifier
func (c FBO) GetShipmentDetails(params *GetShipmentDetailsParams) (*GetShipmentDetailsResponse, error) { func (c FBO) GetShipmentDetails(ctx context.Context, params *GetShipmentDetailsParams) (*GetShipmentDetailsResponse, error) {
url := "/v2/posting/fbo/get" url := "/v2/posting/fbo/get"
resp := &GetShipmentDetailsResponse{} resp := &GetShipmentDetailsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) 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 ListSupplyRequestsParams struct {
// Number of the page returned in the request
Page int32 `json:"page"`
// Number of elements on the page
PageSize int32 `json:"page_size"`
// Filter on status of a supply by request
States []SupplyRequestState `json:"states"`
}
type ListSupplyRequestsResponse struct {
core.CommonResponse
// Indicates that the response contains not the entire array of supply requests:
// - true — make a new request with a different page and page_size values to get information on the remaining requests;
// - false — the entire array of requests for the filter specified in the request was returned in the response
HasNext bool `json:"has_next"`
// Supply requests list
SupplyOrders []SupplyRequestCommonResponse `json:"supply_orders"`
// Total requests number
TotalSupplyOrdersCount int32 `json:"total_supply_orders_count"`
}
type SupplyRequestCommonResponse struct {
// Supply request creation date
CreatedAt string `json:"created_at"`
// Local time supply interval
LocalTimeslot SupplyRequestCommonResponseLocalTimeslot `json:"local_timeslot"`
// Date from which you want to bring the supply to the warehouse. Only for supplies via vDC
PreferredSupplyDateFrom string `json:"preferred_supply_date_from"`
// Date by which you want to bring the supply to the warehouse. Only for supplies via vDC
PreferredSupplyDateTo string `json:"preferred_supply_date_to"`
// Your own warehouse from which you'll take the products to the supply warehouse.
// Only for supplies via vDC
SellerWarehouse SupplyRequestSellerWarehouse `json:"seller_warehouse"`
// Status of a supply by request
State string `json:"state"`
// Supply request identifier
SupplyOrderId int64 `json:"supply_order_id"`
// Supply request number
SupplyOrderNumber string `json:"supply_order_number"`
// Supply warehouse
SupplyWarehouse SupplyRequestCommonResponseSupplyWarehouse `json:"supply_warehouse"`
// time_left_to_prepare_supply
TimeLeftToPrepareSupply int64 `json:"time_left_to_prepare_supply"`
// Time in seconds left to select the supply option. Only for supplies via vDC
TimeLeftToSelectSupplyVariant int64 `json:"time_left_to_select_supply_variant"`
// total_items_count
TotalItemsCount int32 `json:"total_items_count"`
// Total number of items in the request
TotalQuantity int32 `json:"total_quantity"`
}
type SupplyRequestSellerWarehouse struct {
// Warehouse address
Address string `json:"address"`
// Warehouse name
Name string `json:"name"`
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
}
type SupplyRequestCommonResponseLocalTimeslot struct {
// Interval start
From string `json:"from"`
// Interval end
To string `json:"to"`
}
type SupplyRequestCommonResponseSupplyWarehouse struct {
// Warehouse address
Address string `json:"address"`
// Warehouse name
Name string `json:"name"`
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
}
// Method for getting a list of supply requests to the Ozon warehouse.
// Requests with supply both to a specific warehouse and via a virtual
// distribution center (vDC) are taken into account
func (c FBO) ListSupplyRequests(ctx context.Context, params *ListSupplyRequestsParams) (*ListSupplyRequestsResponse, error) {
url := "/v1/supply-order/list"
resp := &ListSupplyRequestsResponse{}
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 GetSupplyRequestInfoParams struct {
// Supply request identifier
SupplyOrderId int64 `json:"supply_order_id"`
}
type GetSupplyRequestInfoResponse struct {
core.CommonResponse
SupplyRequestCommonResponse
// Driver and car information
VehicleInfo GetSupplyRequestInfoVehicle `json:"vehicle_info"`
}
type GetSupplyRequestInfoVehicle struct {
// Driver name
DriverName string `json:"driver_name"`
// Driver phone number
DriverPhone string `json:"driver_phone"`
// Car model
VehicleModel string `json:"vehicle_model"`
// Car number
VehicleNumber string `json:"vehicle_number"`
}
// Method for getting detailed information on a supply request.
// Requests with supply both to a specific warehouse and via a
// virtual distribution center (vDC) are taken into account
func (c FBO) GetSupplyRequestInfo(ctx context.Context, params *GetSupplyRequestInfoParams) (*GetSupplyRequestInfoResponse, error) {
url := "/v1/supply-order/get"
resp := &GetSupplyRequestInfoResponse{}
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 ListProductsInSupplyRequestParams struct {
// Number of the page returned in the query
Page int32 `json:"page"`
// Number of elements on the page
PageSize int32 `json:"page_size"`
// Supply request identifier
SupplyOrderId int64 `json:"supply_order_id"`
}
type ListProductsInSupplyRequestResponse struct {
core.CommonResponse
// Indicates that the response contains not the entire array of supply requests:
// - true — make a new request with a different page and page_size values to get the remaining products;
// - false — the entire array of product was returned in the response
HasNext bool `json:"has_next"`
// Products list
Items []ListProductsInSupplyRequestItem `json:"items"`
// Total number of products in the request
TotalItemsCount int32 `json:"total_items_count"`
}
type ListProductsInSupplyRequestItem struct {
// Link to product image
IconPath string `json:"icon_path"`
// Product name
Name string `json:"name"`
// Product ID
OfferId string `json:"offer_id"`
// Product quantity
Quantity int64 `json:"quantity"`
// Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
}
// List of products in the sullpy request
func (c FBO) ListProductsInSupplyRequest(ctx context.Context, params *ListProductsInSupplyRequestParams) (*ListProductsInSupplyRequestResponse, error) {
url := "/v1/supply-order/items"
resp := &ListProductsInSupplyRequestResponse{}
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 GetWarehouseWorkloadResponse struct {
core.CommonResponse
// Method result
Result []GetWarehouseWorkloadResult `json:"result"`
}
type GetWarehouseWorkloadResult struct {
// Workload
Schedule GetWarehouseWorkloadResultSchedule `json:"schedule"`
// Warehouse
Warehouse GetWarehouseWorkloadResultWarehouse `json:"warehouse"`
}
type GetWarehouseWorkloadResultSchedule struct {
// Data on the products quantity supplied to the warehouse
Capacity []GetWarehouseWorkloadResultScheduleCapacity `json:"capacity"`
// The closest available date for supply, local time
Date time.Time `json:"date"`
}
type GetWarehouseWorkloadResultScheduleCapacity struct {
// Period start, local time
Start time.Time `json:"start"`
// Period end, local time
End time.Time `json:"end"`
// Average number of products that the warehouse can accept per day for the period
Value int32 `json:"value"`
}
type GetWarehouseWorkloadResultWarehouse struct {
// Warehouse identifier
Id string `json:"id"`
// Warehouse name
Name string `json:"name"`
}
// Method returns a list of active Ozon warehouses with information about their average workload in the nearest future
func (c FBO) GetWarehouseWorkload(ctx context.Context) (*GetWarehouseWorkloadResponse, error) {
url := "/v1/supplier/available_warehouses"
resp := &GetWarehouseWorkloadResponse{}
response, err := c.client.Request(ctx, http.MethodGet, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -44,7 +45,7 @@ func TestGetFBOShipmentsList(t *testing.T) {
"status": "delivered", "status": "delivered",
"cancel_reason_id": 0, "cancel_reason_id": 0,
"created_at": "2021-09-01T00:23:45.607Z", "created_at": "2021-09-01T00:23:45.607Z",
"in_process_at": "2021-09-01T00:25:30.120Z", "in_process_at": "2021-09-01T00:25:30.12Z",
"products": [ "products": [
{ {
"sku": 160249683, "sku": 160249683,
@@ -133,11 +134,15 @@ func TestGetFBOShipmentsList(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBO().GetShipmentsList(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBO().GetShipmentsList(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetFBOShipmentsListResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -261,11 +266,15 @@ func TestGetShipmentDetails(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBO().GetShipmentDetails(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBO().GetShipmentDetails(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetShipmentDetailsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -277,3 +286,282 @@ func TestGetShipmentDetails(t *testing.T) {
} }
} }
} }
func TestListSupplyRequests(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ListSupplyRequestsParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ListSupplyRequestsParams{
Page: 0,
PageSize: 0,
States: []SupplyRequestState{AcceptanceAtStorageWarehouse},
},
`{
"has_next": true,
"supply_orders": [
{
"created_at": "string",
"local_timeslot": {
"from": "string",
"to": "string"
},
"preferred_supply_date_from": "string",
"preferred_supply_date_to": "string",
"state": "string",
"supply_order_id": 0,
"supply_order_number": "string",
"supply_warehouse": {
"address": "string",
"name": "string",
"warehouse_id": 0
},
"time_left_to_prepare_supply": 0,
"time_left_to_select_supply_variant": 0,
"total_items_count": 0,
"total_quantity": 0
}
],
"total_supply_orders_count": 0
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ListSupplyRequestsParams{},
`{
"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.FBO().ListSupplyRequests(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &ListSupplyRequestsResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetSupplyRequestInfo(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetSupplyRequestInfoParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetSupplyRequestInfoParams{
SupplyOrderId: 0,
},
`{
"created_at": "string",
"local_timeslot": {
"from": "string",
"to": "string"
},
"preferred_supply_date_from": "string",
"preferred_supply_date_to": "string",
"seller_warehouse": {
"address": "string",
"name": "string",
"warehouse_id": 0
},
"state": "string",
"supply_order_id": 0,
"supply_order_number": "string",
"supply_warehouse": {
"address": "string",
"name": "string",
"warehouse_id": 0
},
"time_left_to_prepare_supply": 0,
"time_left_to_select_supply_variant": 0,
"total_items_count": 0,
"total_quantity": 0,
"vehicle_info": {
"driver_name": "string",
"driver_phone": "string",
"vehicle_model": "string",
"vehicle_number": "string"
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetSupplyRequestInfoParams{},
`{
"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.FBO().GetSupplyRequestInfo(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetSupplyRequestInfoResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestListProductsInSupplyRequest(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ListProductsInSupplyRequestParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ListProductsInSupplyRequestParams{
Page: 0,
PageSize: 0,
SupplyOrderId: 0,
},
`{
"has_next": true,
"items": [
{
"icon_path": "string",
"name": "string",
"offer_id": "string",
"quantity": 0,
"sku": 0
}
],
"total_items_count": 0
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ListProductsInSupplyRequestParams{},
`{
"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.FBO().ListProductsInSupplyRequest(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &ListProductsInSupplyRequestResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetWarehouseWorkload(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": [
{
"schedule": {
"capacity": [
{
"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"value": 0
}
],
"date": "2019-08-24T14:15:22Z"
},
"warehouse": {
"id": "string",
"name": "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))
ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBO().GetWarehouseWorkload(ctx)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetWarehouseWorkloadResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -167,11 +168,15 @@ func TestListUnprocessedShipments(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().ListUnprocessedShipments(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().ListUnprocessedShipments(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListUnprocessedShipmentsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -194,16 +199,22 @@ func TestGetFBSShipmentsList(t *testing.T) {
&GetFBSShipmentsListParams{ &GetFBSShipmentsListParams{
Direction: "ASC", Direction: "ASC",
Filter: GetFBSShipmentsListFilter{ Filter: GetFBSShipmentsListFilter{
Since: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-11-01T00:00:00.000Z"), Since: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-11-01T00:00:00.000Z"),
To: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-12-01T23:59:59.000Z"), To: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-12-01T23:59:59.000Z"),
Status: "awaiting_packaging", Status: "awaiting_packaging",
WarehouseId: []int64{123},
ProviderId: []int64{223},
FBPFilter: FBPFilterAll,
DeliveryMethodId: []int64{456},
OrderId: 0,
}, },
Limit: 100, Limit: 0,
Offset: 0, Offset: 0,
With: GetFBSShipmentsListWith{ With: GetFBSShipmentsListWith{
AnalyticsData: true, AnalyticsData: true,
FinancialData: true, FinancialData: true,
Translit: true, Translit: true,
Barcodes: true,
}, },
}, },
`{ `{
@@ -214,6 +225,7 @@ func TestGetFBSShipmentsList(t *testing.T) {
"order_id": 680420041, "order_id": 680420041,
"order_number": "05708065-0029", "order_number": "05708065-0029",
"status": "awaiting_deliver", "status": "awaiting_deliver",
"substatus": "posting_awaiting_passport_data",
"delivery_method": { "delivery_method": {
"id": 21321684811000, "id": 21321684811000,
"name": "Ozon Логистика самостоятельно, Красногорск", "name": "Ozon Логистика самостоятельно, Красногорск",
@@ -278,11 +290,15 @@ func TestGetFBSShipmentsList(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().GetFBSShipmentsList(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().GetFBSShipmentsList(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetFBSShipmentsListResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -339,11 +355,15 @@ func TestPackOrder(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().PackOrder(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().PackOrder(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &PackOrderResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -416,11 +436,15 @@ func TestValidateLabelingCodes(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().ValidateLabelingCodes(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().ValidateLabelingCodes(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ValidateLabelingCodesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -460,31 +484,8 @@ func TestGetShipmentDataByBarcode(t *testing.T) {
"order_id": 438764970, "order_id": 438764970,
"order_number": "57195475-0050", "order_number": "57195475-0050",
"status": "awaiting_packaging", "status": "awaiting_packaging",
"delivery_method": {
"id": 18114520187000,
"name": "Ozon Логистика самостоятельно, Москва",
"warehouse_id": 18114520187000,
"warehouse": "Москва основной",
"tpl_provider_id": 24,
"tpl_provider": "Ozon Логистика"
},
"tracking_number": "",
"tpl_integration_type": "ozon",
"in_process_at": "2021-11-20T09:14:16Z", "in_process_at": "2021-11-20T09:14:16Z",
"shipment_date": "2021-11-23T10:00:00Z", "shipment_date": "2021-11-23T10:00:00Z",
"delivering_date": null,
"provider_status": "",
"delivery_price": "",
"cancellation": {
"cancel_reason_id": 0,
"cancel_reason": "",
"cancellation_type": "",
"cancelled_after_ship": false,
"affect_cancellation_rating": false,
"cancellation_initiator": ""
},
"customer": null,
"addressee": null,
"products": [ "products": [
{ {
"price": "279.0000", "price": "279.0000",
@@ -492,25 +493,12 @@ func TestGetShipmentDataByBarcode(t *testing.T) {
"name": "Кофе ароматизированный \"Шоколадный апельсин\" 250 гр", "name": "Кофе ароматизированный \"Шоколадный апельсин\" 250 гр",
"sku": 180550365, "sku": 180550365,
"quantity": 1, "quantity": 1,
"mandatory_mark": [], "mandatory_mark": []
"dimensions": {
"height": "40.00",
"length": "240.00",
"weight": "260",
"width": "140.00"
}
} }
], ],
"barcodes": null, "barcodes": null,
"analytics_data": null, "analytics_data": null,
"financial_data": null, "financial_data": null
"additional_data": [],
"is_express": false,
"requirements": {
"products_requiring_gtd": [],
"products_requiring_country": []
},
"product_exemplars": null
} }
}`, }`,
}, },
@@ -529,11 +517,15 @@ func TestGetShipmentDataByBarcode(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().GetShipmentDataByBarcode(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().GetShipmentDataByBarcode(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetShipmentDataByBarcodeResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -642,11 +634,15 @@ func TestGetShipmentDataByIdentifier(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().GetShipmentDataByIdentifier(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().GetShipmentDataByIdentifier(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetShipmentDataByIdentifierResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -714,11 +710,15 @@ func TestAddTrackingNumbers(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().AddTrackingNumbers(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().AddTrackingNumbers(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &AddTrackingNumbersResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -751,11 +751,11 @@ func TestListOfShipmentCertificates(t *testing.T) {
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"}, map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ListOfShipmentCertificatesParams{ &ListOfShipmentCertificatesParams{
Limit: 100, Limit: 100,
Filter: ListOfShipmentCertificates{ Filter: ListOfShipmentCertificatesFilter{
DateFrom: "2021-08-04", DateFrom: "2021-08-04",
DateTo: "2022-08-04", DateTo: "2022-08-04",
IntegrationType: "ozon", IntegrationType: "ozon",
Status: []string{"delivered"}, Status: []ShipmentCertificateFilterStatus{ShitmentCertificateFilterFormed},
}, },
}, },
`{ `{
@@ -807,11 +807,15 @@ func TestListOfShipmentCertificates(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().ListOfShipmentCertificates(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().ListOfShipmentCertificates(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListOfShipmentCertificatesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -868,11 +872,15 @@ func TestSignShipmentCertificate(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().SignShipmentCertificate(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().SignShipmentCertificate(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &SignShipmentCertificateResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -943,24 +951,34 @@ func TestChangeStatusTo(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
deliveringResp, err := c.FBS().ChangeStatusToDelivering(test.params) deliveringctx, _ := context.WithTimeout(context.Background(), testTimeout)
deliveringResp, err := c.FBS().ChangeStatusToDelivering(deliveringctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
lastMileResp, err := c.FBS().ChangeStatusToLastMile(test.params) compareJsonResponse(t, test.response, &ChangeStatusToResponse{})
lastMilectx, _ := context.WithTimeout(context.Background(), testTimeout)
lastMileResp, err := c.FBS().ChangeStatusToLastMile(lastMilectx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
deliveredResp, err := c.FBS().ChangeStatusToDelivered(test.params) deliveredctx, _ := context.WithTimeout(context.Background(), testTimeout)
deliveredResp, err := c.FBS().ChangeStatusToDelivered(deliveredctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
sendBySellerResp, err := c.FBS().ChangeStatusToSendBySeller(test.params) sendBySellerctx, _ := context.WithTimeout(context.Background(), testTimeout)
sendBySellerResp, err := c.FBS().ChangeStatusToSendBySeller(sendBySellerctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
assertResponse(t, &test, deliveringResp) assertResponse(t, &test, deliveringResp)
@@ -1005,11 +1023,15 @@ func TestPassShipmentToShipping(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().PassShipmentToShipping(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().PassShipmentToShipping(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &PassShipmentToShippingResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1053,11 +1075,15 @@ func TestCancelShipment(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().CancelShipment(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().CancelShipment(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CancelShipmentResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1103,11 +1129,15 @@ func TestCreateAct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().CreateAct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().CreateAct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CreateActResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1132,9 +1162,8 @@ func TestGetLabeling(t *testing.T) {
}, },
`{ `{
"result": { "result": {
"error": "24", "status": "completed",
"file_url": "some-url", "file_url": "https://cdn1.ozone.ru/s3/sc-temporary/e6/0c/e60cdfd7aed78c2b44d134504fbd591d.pdf"
"status": "completed"
} }
}`, }`,
}, },
@@ -1153,11 +1182,15 @@ func TestGetLabeling(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().GetLabeling(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().GetLabeling(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetLabelingResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1186,7 +1219,9 @@ func TestPrintLabeling(t *testing.T) {
PostingNumber: []string{"48173252-0034-4"}, PostingNumber: []string{"48173252-0034-4"},
}, },
`{ `{
"content": "https://cdn1.ozone.ru/s3/ozon-disk-api/c4a11c8b748033daf6cdd44aca7ed4c492e55d6f4810f13feae4792afa7934191647255705" "content_type": "application/pdf",
"file_name": "ticket-170660-2023-07-13T13:17:06Z.pdf",
"file_content": "%PDF-1.7\n%âãÏÓ\n53 0 obj\n<</MarkInfo<</Marked true/Type/MarkInfo>>/Pages 9 0 R/StructTreeRoot 10 0 R/Type/Catalog>>\nendobj\n8 0 obj\n<</Filter/FlateDecode/Length 2888>>\nstream\nxœå[[ݶ\u0011~?¿BÏ\u0005Bs†\u001c^\u0000Àwí5ú\u0010 m\u0016Èsà¦)\n;hÒ\u0014èÏïG‰\u0014)‰<{äµ] ]?¬¬oIÎ}†¤F±‰óϤñï\u001bÕü×X­´OÏï?^~¹$<ø¨È9q\u0013Y\u0012åñì§_¼|ÿ‡égü\t+\u0012\u001bxžª}Æxšҿ¿¼›–‡_º¼xg¦Ÿþ5Oku˜œÌ3ýíògüûå\"Ni\u0016C\u0001°\u000fA9g‰'r¢\"\u0013YóĪ\u0018NÑ{\u001d–ÕóZ¬\\Ô\""
}`, }`,
}, },
// Test No Client-Id or Api-Key // Test No Client-Id or Api-Key
@@ -1204,14 +1239,24 @@ func TestPrintLabeling(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().PrintLabeling(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().PrintLabeling(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &PrintLabelingResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", 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.Content == "" {
t.Error("content cannot be empty")
}
}
} }
} }
@@ -1252,11 +1297,15 @@ func TestCreateTaskForGeneratingLabel(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().CreateTaskForGeneratingLabel(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().CreateTaskForGeneratingLabel(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CreateTaskForGeneratingLabelResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1312,11 +1361,15 @@ func TestGetDropOffPointRestrictions(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().GetDropOffPointRestrictions(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().GetDropOffPointRestrictions(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetDropOffPointRestrictionsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1372,11 +1425,15 @@ func TestCheckProductItemsData(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().CheckproductItemsData(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().CheckProductItemsData(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CheckProductItemsDataResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1435,11 +1492,15 @@ func TestGetProductItemsCheckStatuses(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().GetProductItemsCheckStatuses(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().GetProductItemsCheckStatuses(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetProductItemsCheckStatusesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1480,8 +1541,8 @@ func TestRescheduleShipmentDeliveryDate(t *testing.T) {
&RescheduleShipmentDeliveryDateParams{ &RescheduleShipmentDeliveryDateParams{
PostingNumber: "23281294-0063-2", PostingNumber: "23281294-0063-2",
NewTimeslot: RescheduleShipmentDeliveryDateTimeslot{ NewTimeslot: RescheduleShipmentDeliveryDateTimeslot{
DeliveryDateBegin: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2023-03-03T11:07:00.381Z"), From: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2023-03-25T08:51:56.932Z"),
DeliveryDateEnd: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2023-03-03T11:07:00.381Z"), To: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2023-03-25T08:51:56.932Z"),
}, },
}, },
`{ `{
@@ -1503,11 +1564,15 @@ func TestRescheduleShipmentDeliveryDate(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().RescheduleShipmentDeliveryDate(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().RescheduleShipmentDeliveryDate(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &RescheduleShipmentDeliveryDateResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1554,11 +1619,15 @@ func TestDateAvailableForDeliverySchedule(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().DateAvailableForDeliverySchedule(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().DateAvailableForDeliverySchedule(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &DateAvailableForDeliveryScheduleResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1613,11 +1682,15 @@ func TestListManufactoruingCountries(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().ListManufacturingCountries(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().ListManufacturingCountries(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListManufacturingCountriesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1673,11 +1746,15 @@ func TestSetManufacturingCountry(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().SetManufacturingCountry(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().SetManufacturingCountry(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &SetManufacturingCountryResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1740,11 +1817,15 @@ func TestPartialPackOrder(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().PartialPackOrder(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().PartialPackOrder(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &PartialPackOrderResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1812,11 +1893,15 @@ func TestAvailableFreightsList(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().AvailableFreightsList(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().AvailableFreightsList(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &AvailableFreightsListResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1859,11 +1944,15 @@ func TestGenerateAct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().GenerateAct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().GenerateAct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GenerateActResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1888,9 +1977,9 @@ func TestGetDigitalAct(t *testing.T) {
DocType: "act_of_acceptance", DocType: "act_of_acceptance",
}, },
`{ `{
"content": "string", "content_type": "application/pdf",
"name": "string", "file_name": "20816409_act_of_mismatch.pdf",
"type": "string" "file_content": "%PDF-1.4\n%ÓôÌá\n1 0 obj\n<<\n/Creator(Chromium)\n/Producer(PDFsharp 1.50.5147 \\([www.pdfsharp.com|http://www.pdfsharp.com/]\\) \\(Original: Skia/PDF m103\\))\n/CreationDate(D:20230625092529+00'00')\n/ModDate(D:20230625092529+00'00')\n>>\nendobj\n2 0 obj\n<<\n/Type/Page\n/Resources\n<<\n/ProcSet[/PDF/Text/ImageB/ImageC/ImageI]\n/ExtGState\n<<\n/G3 3 0 R\n/G8 8 0 R\n>>\n/XObject\n<<\n/X6 6 0 R\n/X7 7 0 R\n>>\n/Font\n<<\n/F4 4 0 R\n/F5 5 0 R\n>>\n>>\n/MediaBox[0 0 594.96 841.92]\n/Contents 9 0 R\n/StructParents 0\n/Parent 13 0 R\n/Group\n<<\n/CS/DeviceRGB\n/S/Transparency\n>>\n>>\nendobj\n3 0 obj\n<<\n/ca 1\n/BM/Normal\n>>\nendobj\n4 0 obj\n<<\n/Type/Font\n/Subtype/Type0\n/BaseFont/AAAAAA+LiberationSans\n/Encoding/Identity-H\n/DescendantFonts[160 0 R]\n/ToUnicode 161 0 R\n>>\nendobj\n5 0 obj\n<<\n/Type/Font\n/Subtype/Type0\n/BaseFont/BAAAAA+LiberationSans-Bold\n/Encoding/Identity-H\n/DescendantFonts[164 0"
}`, }`,
}, },
// Test No Client-Id or Api-Key // Test No Client-Id or Api-Key
@@ -1908,11 +1997,15 @@ func TestGetDigitalAct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().GetDigitalAct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().GetDigitalAct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetDigitalActResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1962,11 +2055,15 @@ func TestPackageUnitLabels(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().PackageUnitLabel(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().PackageUnitLabel(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &PackageUnitLabelsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2014,11 +2111,15 @@ func TestOpenDisputeOverShipment(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().OpenDisputeOverShipment(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().OpenDisputeOverShipment(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &OpenDisputeOverShipmentResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2081,11 +2182,15 @@ func TestShipmentCancellationReasons(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().ShipmentCancellationReasons(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().ShipmentCancellationReasons(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ShipmentCancellationReasonsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2176,11 +2281,15 @@ func TestShipmentsCancellationReasons(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().ShipmentsCancellationReasons() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().ShipmentsCancellationReasons(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ShipmentsCancellationReasonsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2237,11 +2346,15 @@ func TestAddWeightForBulkProduct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().AddWeightForBulkProduct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().AddWeightForBulkProduct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &AddWeightForBulkProductResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2297,11 +2410,15 @@ func TestCancelSending(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().CancelSending(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().CancelSending(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CancelSendingResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2362,11 +2479,15 @@ func TestListShipmentInCertificate(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().ListShipmentInCertificate(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().ListShipmentInCertificate(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListShipmentInCertificateResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2410,11 +2531,15 @@ func TestSpecifyNumberOfBoxes(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().SpecifyNumberOfBoxes(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().SpecifyNumberOfBoxes(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &SpecifyNumberOfBoxesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2439,7 +2564,13 @@ func TestStatusOfAct(t *testing.T) {
}, },
`{ `{
"result": { "result": {
"result": true "added_to_act": [
"true"
],
"removed_from_act": [
"false"
],
"status": "ready"
} }
}`, }`,
}, },
@@ -2458,11 +2589,15 @@ func TestStatusOfAct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().StatusOfAct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().StatusOfAct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &StatusOfActResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2516,13 +2651,195 @@ func TestETGBCustomsDeclarations(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.FBS().ETGBCustomsDeclarations(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.FBS().ETGBCustomsDeclarations(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ETGBCustomsDeclarationsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
} }
} }
func TestBarcodeFromProductShipment(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *BarcodeFromProductShipmentParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&BarcodeFromProductShipmentParams{
Id: 295662811,
},
`{
"content_type": "image/png",
"file_name": "20913984_barcode.png",
"file_content": "‰PNG\r\n\u001a\n\u0000\u0000\u0000\rIHDR\u0000\u0000\u0003\u0010\u0000\u0000\u0000\u0010\u0000\u0000\u0000\u0000íZ\u000e'\u0000\u0000\u0002pIDATxœìÕÁJ\u00031\u0014@Q+þÿ/×E\u0017\u000e¼›\u0010u¡-ç¬$£Éˌp?î÷·§t» }ýü¸ÃcåzŸ¹2w˜OWû\\Ϛ뫧×Ùö;œì|rÇýßîç¼úî{˜§¬N?™í7oì•v¸®Ÿµ¹Ãù„û•¹¾ÿÏ9ÿî?›až¸ºéê7O&߿É9çÉ\u000eÏáý¯\u0007\u0000à\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000$\u0000 \t\u0004\u0000I \u0000H\u0002\u0001@\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000$\u0000 \t\u0004\u0000I \u0000H\u0002\u0001@\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000$\u0000 \t\u0004\u0000I \u0000H\u0002\u0001@\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000$\u0000 \t\u0004\u0000I \u0000H\u0002\u0001@\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000"
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&BarcodeFromProductShipmentParams{},
`{
"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.FBS().BarcodeFromProductShipment(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &BarcodeFromProductShipmentResponse{})
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.Content == "" {
t.Errorf("content cannot be empty")
}
if resp.Type == "" {
t.Error("type cannot be empty")
}
if resp.Name == "" {
t.Error("name cannot be empty")
}
}
}
}
func TestBarcodeValueFromProductShipment(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *BarcodeValueFromProductShipmentParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&BarcodeValueFromProductShipmentParams{
Id: 295662811,
},
`{
"result": "%303%24276481394"
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&BarcodeValueFromProductShipmentParams{},
`{
"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.FBS().BarcodeValueFromProductShipment(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &BarcodeValueFromProductShipmentResponse{})
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 == "" {
t.Errorf("result cannot be empty")
}
}
}
}
func TestGetActPDF(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetActPDFParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetActPDFParams{
Id: 22435521842000,
},
`{
"content_type": "application/pdf",
"file_name": "20928233.pdf",
"file_content": "binarystring"
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetActPDFParams{},
`{
"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.FBS().GetActPDF(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetActPDFResponse{})
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.FileContent == "" {
t.Errorf("result cannot be empty")
}
}
}
}

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -20,137 +21,143 @@ type ReportOnSoldProductsResponse struct {
core.CommonResponse core.CommonResponse
// Query result // Query result
Result []struct { Result ReportonSoldProductsResult `json:"result"`
// Report title page }
Header []struct {
// Report ID
Id string `json:"num"`
// Report generation date type ReportonSoldProductsResult struct {
DocDate string `json:"doc_date"` // Report title page
Header ReportOnSoldProductsResultHeader `json:"header"`
// Date of the offer agreement // Report table
ContractDate string `json:"contract_date"` Rows []ReportOnSoldProductsResultRow `json:"rows"`
}
// Offer agreement number type ReportOnSoldProductsResultHeader struct {
ContractNum string `json:"contract_num"` // Report ID
Id string `json:"num"`
// Currency of your prices // Report generation date
CurrencyCode string `json:"currency_code"` DocDate string `json:"doc_date"`
// Amount to accrue // Date of the offer agreement
DocAmount float64 `json:"doc_amount"` ContractDate string `json:"contract_date"`
// Amount to accrue with VAT // Offer agreement number
VATAmount float64 `json:"vat_amount"` ContractNum string `json:"contract_num"`
// Payer's TIN // Currency of your prices
PayerINN string `json:"payer_inn"` CurrencyCode string `json:"currency_code"`
// Payer's Tax Registration Reason Code (KPP) // Amount to accrue
PayerKPP string `json:"payer_kpp"` DocAmount float64 `json:"doc_amount"`
// Payer's name // Amount to accrue with VAT
PayerName string `json:"payer_name"` VATAmount float64 `json:"vat_amount"`
// Recipient's TIN // Payer's TIN
RecipientINN string `json:"rcv_inn"` PayerINN string `json:"payer_inn"`
// Recipient's Tax Registration Reason Code (KPP) // Payer's Tax Registration Reason Code (KPP)
RecipientKPP string `json:"rcv_kpp"` PayerKPP string `json:"payer_kpp"`
// Recipient's name // Payer's name
RecipientName string `json:"rcv_name"` PayerName string `json:"payer_name"`
// Period start in the report // Recipient's TIN
StartDate string `json:"start_date"` RecipientINN string `json:"rcv_inn"`
// Period end in the report // Recipient's Tax Registration Reason Code (KPP)
StopDate string `json:"stop_date"` RecipientKPP string `json:"rcv_kpp"`
} `json:"header"`
// Report table // Recipient's name
Rows []struct { RecipientName string `json:"rcv_name"`
// Row number
RowNumber int32 `json:"row_number"`
// Product ID // Period start in the report
ProductId int64 `json:"product_id"` StartDate string `json:"start_date"`
// Product name // Period end in the report
ProductName string `json:"product_name"` StopDate string `json:"stop_date"`
}
// Product barcode type ReportOnSoldProductsResultRow struct {
Barcode string `json:"barcode"` // Row number
RowNumber int32 `json:"row_number"`
// Product identifier in the seller's system // Product ID
OfferId string `json:"offer_id"` ProductId int64 `json:"product_id"`
// Sales commission by category // Product name
CommissionPercent float64 `json:"commission_percent"` ProductName string `json:"product_name"`
// Seller's price with their discount // Product barcode
Price float64 `json:"price"` Barcode string `json:"barcode"`
// Selling price: the price at which the customer purchased the product. For sold products // Product identifier in the seller's system
PriceSale float64 `json:"price_sale"` OfferId string `json:"offer_id"`
// Sold for amount. // Sales commission by category
// CommissionPercent float64 `json:"commission_percent"`
// Sold products cost considering the quantity and regional coefficients. Calculation is made by the sale_amount price
SaleAmount float64 `json:"sale_amount"`
// Commission for sold products, including discounts and extra charges // Seller's price with their discount
SaleCommission float64 `json:"sale_commission"` Price float64 `json:"price"`
// Extra charge at the expense of Ozon. // Selling price: the price at which the customer purchased the product. For sold products
// PriceSale float64 `json:"price_sale"`
// Amount that Ozon will compensate the seller if the Ozon discount is greater than or equal to the sales commission
SaleDiscount float64 `json:"sale_discount"`
// Total accrual for the products sold. // Sold for amount.
// //
// Amount after deduction of sales commission, application of discounts and extra charges // Sold products cost considering the quantity and regional coefficients. Calculation is made by the sale_amount price
SalePriceSeller float64 `json:"sale_price_seller"` SaleAmount float64 `json:"sale_amount"`
// Quantity of products sold at the price_sale price // Commission for sold products, including discounts and extra charges
SaleQuantity int32 `json:"sale_qty"` SaleCommission float64 `json:"sale_commission"`
// Price at which the customer purchased the product. For returned products // Extra charge at the expense of Ozon.
ReturnSale float64 `json:"return_sale"` //
// Amount that Ozon will compensate the seller if the Ozon discount is greater than or equal to the sales commission
SaleDiscount float64 `json:"sale_discount"`
// Cost of returned products, taking into account the quantity and regional coefficients. // Total accrual for the products sold.
// Calculation is carried out at the return_sale price //
ReturnAmount float64 `json:"return_amount"` // Amount after deduction of sales commission, application of discounts and extra charges
SalePriceSeller float64 `json:"sale_price_seller"`
// Commission including the quantity of products, discounts and extra charges. // Quantity of products sold at the price_sale price
// Ozon compensates it for the returned products SaleQuantity int32 `json:"sale_qty"`
ReturnCommission float64 `json:"return_commission"`
// Extra charge at the expense of Ozon. // Price at which the customer purchased the product. For returned products
// ReturnSale float64 `json:"return_sale"`
// Amount of the discount at the expense of Ozon on returned products.
// Ozon will compensate it to the seller if the Ozon discount is greater than or equal to the sales commission
ReturnDiscount float64 `json:"return_discount"`
// Amount charged to the seller for returned products after deducing sales commissions, applying discounts and extra charges // Cost of returned products, taking into account the quantity and regional coefficients.
ReturnPriceSeller float64 `json:"return_price_seller"` // Calculation is carried out at the return_sale price
ReturnAmount float64 `json:"return_amount"`
// Quantity of returned products // Commission including the quantity of products, discounts and extra charges.
ReturnQuantity int32 `json:"return_qty"` // Ozon compensates it for the returned products
} `json:"rows"` ReturnCommission float64 `json:"return_commission"`
} `json:"result"`
// Extra charge at the expense of Ozon.
//
// Amount of the discount at the expense of Ozon on returned products.
// Ozon will compensate it to the seller if the Ozon discount is greater than or equal to the sales commission
ReturnDiscount float64 `json:"return_discount"`
// Amount charged to the seller for returned products after deducing sales commissions, applying discounts and extra charges
ReturnPriceSeller float64 `json:"return_price_seller"`
// Quantity of returned products
ReturnQuantity int32 `json:"return_qty"`
} }
// Returns information on products sold and returned within a month. Canceled or non-purchased products are not included. // Returns information on products sold and returned within a month. Canceled or non-purchased products are not included.
// //
// Report is returned no later than the 5th day of the next month // Report is returned no later than the 5th day of the next month
func (c Finance) ReportOnSoldProducts(params *ReportOnSoldProductsParams) (*ReportOnSoldProductsResponse, error) { func (c Finance) ReportOnSoldProducts(ctx context.Context, params *ReportOnSoldProductsParams) (*ReportOnSoldProductsResponse, error) {
url := "/v1/finance/realization" url := "/v1/finance/realization"
resp := &ReportOnSoldProductsResponse{} resp := &ReportOnSoldProductsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -196,49 +203,51 @@ type GetTotalTransactionsSumResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result GetTotalTransactionsSumResult `json:"result"`
// Total cost of products and returns for specified period }
AccrualsForSale float64 `json:"accruals_for_sale"`
// Compensations type GetTotalTransactionsSumResult struct {
CompensationAmount float64 `json:"compensatino_amount"` // Total cost of products and returns for specified period
AccrualsForSale float64 `json:"accruals_for_sale"`
// Charges for delivery and returns when working under rFBS scheme // Compensations
MoneyTransfer float64 `json:"money_transfer"` CompensationAmount float64 `json:"compensation_amount"`
// Other accurals // Charges for delivery and returns when working under rFBS scheme
OthersAmount float64 `json:"others_amount"` MoneyTransfer float64 `json:"money_transfer"`
// Cost of shipment processing, orders packaging, pipeline and last mile services, and delivery cost before the new commissions and rates applied from February 1, 2021. // Other accurals
// OthersAmount float64 `json:"others_amount"`
// Pipeline is delivery of products from one cluster to another.
//
// Last mile is products delivery to the pick-up point, parcle terminal, or by courier
ProcessingAndDelivery float64 `json:"processing_and_delivery"`
// Cost of reverse pipeline, returned, canceled and unredeemed orders processing, and return cost before the new commissions and rates applied from February 1, 2021. // Cost of shipment processing, orders packaging, pipeline and last mile services, and delivery cost before the new commissions and rates applied from February 1, 2021.
// //
// Pipeline is delivery of products from one cluster to another. // Pipeline is delivery of products from one cluster to another.
// //
// Last mile is products delivery to the pick-up point, parcle terminal, or by courier // Last mile is products delivery to the pick-up point, parcle terminal, or by courier
RefundsAndCancellations float64 `json:"refunds_and_cancellations"` ProcessingAndDelivery float64 `json:"processing_and_delivery"`
// The commission withheld when the product was sold and refunded when the product was returned // Cost of reverse pipeline, returned, canceled and unredeemed orders processing, and return cost before the new commissions and rates applied from February 1, 2021.
SaleCommission float64 `json:"sale_commission"` //
// Pipeline is delivery of products from one cluster to another.
//
// Last mile is products delivery to the pick-up point, parcle terminal, or by courier
RefundsAndCancellations float64 `json:"refunds_and_cancellations"`
// The additional services cost that are not directly related to deliveries and returns. // The commission withheld when the product was sold and refunded when the product was returned
// For example, promotion or product placement SaleCommission float64 `json:"sale_commission"`
ServicesAmount float64 `json:"services_amount"`
} `json:"result"` // The additional services cost that are not directly related to deliveries and returns.
// For example, promotion or product placement
ServicesAmount float64 `json:"services_amount"`
} }
// Returns total sums for transactions for specified period // Returns total sums for transactions for specified period
func (c Finance) GetTotalTransactionsSum(params *GetTotalTransactionsSumParams) (*GetTotalTransactionsSumResponse, error) { func (c Finance) GetTotalTransactionsSum(ctx context.Context, params *GetTotalTransactionsSumParams) (*GetTotalTransactionsSumResponse, error) {
url := "/v3/finance/transaction/totals" url := "/v3/finance/transaction/totals"
resp := &GetTotalTransactionsSumResponse{} resp := &GetTotalTransactionsSumResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -247,7 +256,7 @@ func (c Finance) GetTotalTransactionsSum(params *GetTotalTransactionsSumParams)
return resp, nil return resp, nil
} }
type ListTransactionsParams struct{ type ListTransactionsParams struct {
// Filter // Filter
Filter ListTransactionsFilter `json:"filter"` Filter ListTransactionsFilter `json:"filter"`
@@ -258,12 +267,12 @@ type ListTransactionsParams struct{
PageSize int64 `json:"page_size"` PageSize int64 `json:"page_size"`
} }
type ListTransactionsFilter struct{ type ListTransactionsFilter struct {
// Filter by date // Filter by date
Date ListTransactionsFilterDate `json:"date"` Date ListTransactionsFilterDate `json:"date"`
// Operation type // Operation type
OperationType string `json:"operation_type"` OperationType []string `json:"operation_type"`
// Shipment number // Shipment number
PostingNumber string `json:"posting_number"` PostingNumber string `json:"posting_number"`
@@ -272,112 +281,122 @@ type ListTransactionsFilter struct{
TransactionType string `json:"transaction_type"` TransactionType string `json:"transaction_type"`
} }
type ListTransactionsFilterDate struct{ type ListTransactionsFilterDate struct {
// Period start. // Period start.
// //
// Format: YYYY-MM-DDTHH:mm:ss.sssZ. // Format: YYYY-MM-DDTHH:mm:ss.sssZ.
// Example: 2019-11-25T10:43:06.51 // Example: 2019-11-25T10:43:06.51
From time.Time `json:"from"` From time.Time `json:"from"`
// Period end. // Period end.
// //
// Format: YYYY-MM-DDTHH:mm:ss.sssZ. // Format: YYYY-MM-DDTHH:mm:ss.sssZ.
// Example: 2019-11-25T10:43:06.51 // Example: 2019-11-25T10:43:06.51
To time.Time `json:"to"` To time.Time `json:"to"`
} }
type ListTransactionsResponse struct{ type ListTransactionsResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct{ Result ListTransactionsResult `json:"result"`
// Transactions infromation }
Operations []struct{
// Cost of the products with seller's discounts applied
AccrualsForSale float64 `json:"accruals_for_sale"`
// Total transaction sum type ListTransactionsResult struct {
Amount float64 `json:"amount"` // Transactions infromation
Operations []ListTransactionsResultOperation `json:"operations"`
// Delivery cost for charges by rates that were in effect until February 1, 2021, and for charges for bulky products // Number of pages
DeliveryCharge float64 `json:"delivery_charge"` PageCount int64 `json:"page_count"`
// Product information // Number of products
Items []struct{ RowCount int64 `json:"row_count"`
// Product name }
Name string `json:"name"`
// Product identifier in the Ozon system, SKU type ListTransactionsResultOperation struct {
SKU int64 `json:"sku"` // Cost of the products with seller's discounts applied
} `json:"items"` AccrualsForSale float64 `json:"accruals_for_sale"`
// Operation date // Total transaction sum
OperationDate string `json:"operation_date"` Amount float64 `json:"amount"`
// Operation identifier // Delivery cost for charges by rates that were in effect until February 1, 2021, and for charges for bulky products
OperationId int64 `json:"operation_id"` DeliveryCharge float64 `json:"delivery_charge"`
// Operation type // Product information
OperationType string `json:"operation_type"` Items []ListTransactionsResultOperationItem `json:"items"`
// Operation type name // Operation date
OperationTypeName string `json:"operation_type_name"` OperationDate string `json:"operation_date"`
// Shipment information // Operation identifier
Posting struct{ OperationId int64 `json:"operation_id"`
// Delivery scheme:
// - FBO — delivery to Ozon warehouse
// - FBS — delivery from seller's warehouse
// - RFBS — delivery service of seller's choice
// - Crossborder — delivery from abroad
DeliverySchema string `json:"delivery_schema"`
// Date the product was accepted for processing // Operation type
OrderDate string `json:"order_date"` OperationType string `json:"operation_type"`
// Shipment number // Operation type name
PostingNumber string `json:"posting_number"` OperationTypeName string `json:"operation_type_name"`
// Warehouse identifier // Shipment information
WarehouseId int64 `json:"warehouse_id"` Posting ListTransactionsResultOperationPosting `json:"posting"`
} `json:"posting"`
// Returns and cancellation cost for charges by rates that were in effect until February 1, 2021, and for charges for bulky products // Returns and cancellation cost for charges by rates that were in effect until February 1, 2021, and for charges for bulky products
ReturnDeliveryCharge float64 `json:"return_delivery_charge"` ReturnDeliveryCharge float64 `json:"return_delivery_charge"`
// Sales commission or sales commission refund // Sales commission or sales commission refund
SaleCommission float64 `json:"sale_commission"` SaleCommission float64 `json:"sale_commission"`
// Additional services // Additional services
Services []struct{ Services []ListTransactionsResultOperationService `json:"services"`
// Service name
Name string `json:"name"`
// Price // Transaction type
Price float64 `json:"price"` Type string `json:"type"`
} `json:"services"` }
// Transaction type type ListTransactionsResultOperationItem struct {
Type string `json:"type"` // Product name
} `json:"operations"` Name string `json:"name"`
// Number of pages // Product identifier in the Ozon system, SKU
PageCount int64 `json:"page_count"` SKU int64 `json:"sku"`
}
// Number of products type ListTransactionsResultOperationPosting struct {
RowCount int64 `json:"row_count"` // Delivery scheme:
} `json:"result"` // - FBO — delivery to Ozon warehouse
// - FBS — delivery from seller's warehouse
// - RFBS — delivery service of seller's choice
// - Crossborder — delivery from abroad
DeliverySchema string `json:"delivery_schema"`
// Date the product was accepted for processing
OrderDate string `json:"order_date"`
// Shipment number
PostingNumber string `json:"posting_number"`
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
}
type ListTransactionsResultOperationService struct {
// Service name
Name string `json:"name"`
// Price
Price float64 `json:"price"`
} }
// Returns detailed information on all accruals. The maximum period for which you can get information in one request is 1 month. // Returns detailed information on all accruals. The maximum period for which you can get information in one request is 1 month.
// //
// If you don't specify the posting_number in request, the response contains all shipments for the specified period or shipments of a certain type // If you don't specify the posting_number in request, the response contains all shipments for the specified period or shipments of a certain type
func (c Finance) ListTransactions(params *ListTransactionsParams) (*ListTransactionsResponse, error) { func (c Finance) ListTransactions(ctx context.Context, params *ListTransactionsParams) (*ListTransactionsResponse, error) {
url := "/v3/finance/transaction/list" url := "/v3/finance/transaction/list"
resp := &ListTransactionsResponse{} resp := &ListTransactionsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -25,53 +26,49 @@ func TestReportOnSoldProducts(t *testing.T) {
Date: "2022-09", Date: "2022-09",
}, },
`{ `{
"result": [ "result": {
{ "header": {
"header": [ "doc_date": "2022-09-22",
{ "num": "string",
"doc_date": "2022-09-22", "start_date": "2022-09-02",
"num": "string", "stop_date": "2022-09-22",
"start_date": "2022-09-02", "contract_date": "2022-09-02",
"stop_date": "2022-09-22", "contract_num": "string",
"contract_date": "2022-09-02", "payer_name": "string",
"contract_num": "string", "payer_inn": "string",
"payer_name": "string", "payer_kpp": "string",
"payer_inn": "string", "rcv_name": "string",
"payer_kpp": "string", "rcv_inn": "string",
"rcv_name": "string", "rcv_kpp": "string",
"rcv_inn": "string", "doc_amount": 1,
"rcv_kpp": "string", "vat_amount": 1,
"doc_amount": 1, "currency_code": "string"
"vat_amount": 1, },
"currency_code": "string" "rows": [
} {
], "row_number": 0,
"rows": [ "product_id": 0,
{ "product_name": "string",
"row_number": 0, "offer_id": "string",
"product_id": 0, "barcode": "string",
"product_name": "string", "price": 0,
"offer_id": "string", "commission_percent": 0,
"barcode": "string", "price_sale": 0,
"price": 0, "sale_qty": 0,
"commission_percent": 0, "sale_amount": 0,
"price_sale": 0, "sale_discount": 0,
"sale_qty": 0, "sale_commission": 0,
"sale_amount": 0, "sale_price_seller": 0,
"sale_discount": 0, "return_sale": 0,
"sale_commission": 0, "return_qty": 0,
"sale_price_seller": 0, "return_amount": 0,
"return_sale": 0, "return_discount": 0,
"return_qty": 0, "return_commission": 0,
"return_amount": 0, "return_price_seller": 0
"return_discount": 0, }
"return_commission": 0, ]
"return_price_seller": 0 }
} }`,
]
}
]
}`,
"", "",
}, },
// Test No Client-Id or Api-Key // Test No Client-Id or Api-Key
@@ -90,11 +87,15 @@ func TestReportOnSoldProducts(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Finance().ReportOnSoldProducts(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Finance().ReportOnSoldProducts(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ReportOnSoldProductsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -158,11 +159,15 @@ func TestGetTotalTransactionsSum(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Finance().GetTotalTransactionsSum(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Finance().GetTotalTransactionsSum(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetTotalTransactionsSumResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -246,11 +251,15 @@ func TestListTransactions(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Finance().ListTransactions(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Finance().ListTransactions(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListTransactionsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

View File

@@ -1,7 +1,9 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time"
core "github.com/diphantxm/ozon-api-client" core "github.com/diphantxm/ozon-api-client"
) )
@@ -16,6 +18,21 @@ type CreateUpdateProformaLinkParams struct {
// Proforma invoice link // Proforma invoice link
URL string `json:"url"` URL string `json:"url"`
// Invoice HS-code. Pass a number up to 12 characters long
HSCode string `json:"hs_code"`
// Invoice date
Date time.Time `json:"date"`
// Invoice number. The number can contain letters and digits, maximum length is 50 characters
Number string `json:"number"`
// Cost stated in the invoice. The fractional part is separated by decimal point, up to two digits after the decimal poin
Price float64 `json:"price"`
// Invoice currency
PriceCurrency InvoiceCurrency `json:"price_currency" default:"USD"`
} }
type CreateUpdateProformaLinkResponse struct { type CreateUpdateProformaLinkResponse struct {
@@ -26,12 +43,12 @@ type CreateUpdateProformaLinkResponse struct {
} }
// Create or edit proforma invoice link for VAT refund to Turkey sellers // Create or edit proforma invoice link for VAT refund to Turkey sellers
func (c Invoices) CreateUpdate(params *CreateUpdateProformaLinkParams) (*CreateUpdateProformaLinkResponse, error) { func (c Invoices) CreateUpdate(ctx context.Context, params *CreateUpdateProformaLinkParams) (*CreateUpdateProformaLinkResponse, error) {
url := "/v1/invoice/create-or-update" url := "/v1/invoice/create-or-update"
resp := &CreateUpdateProformaLinkResponse{} resp := &CreateUpdateProformaLinkResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -49,19 +66,21 @@ type GetProformaLinkResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result GetProformaLinkResult `json:"result"`
// Proforma invoice link }
FileURL string `json:"file_url"`
} `json:"result"` type GetProformaLinkResult struct {
// Proforma invoice link
FileURL string `json:"file_url"`
} }
// Get a proforma invoice link // Get a proforma invoice link
func (c Invoices) Get(params *GetProformaLinkParams) (*GetProformaLinkResponse, error) { func (c Invoices) Get(ctx context.Context, params *GetProformaLinkParams) (*GetProformaLinkResponse, error) {
url := "/v1/invoice/get" url := "/v1/invoice/get"
resp := &GetProformaLinkResponse{} resp := &GetProformaLinkResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -82,12 +101,12 @@ type DeleteProformaLinkResponse struct {
Result bool `json:"result"` Result bool `json:"result"`
} }
func (c Invoices) Delete(params *DeleteProformaLinkParams) (*DeleteProformaLinkResponse, error) { func (c Invoices) Delete(ctx context.Context, params *DeleteProformaLinkParams) (*DeleteProformaLinkResponse, error) {
url := "/v1/invoice/delete" url := "/v1/invoice/delete"
resp := &DeleteProformaLinkResponse{} resp := &DeleteProformaLinkResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -21,8 +22,13 @@ func TestCreateUpdateProformaLink(t *testing.T) {
http.StatusOK, http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"}, map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&CreateUpdateProformaLinkParams{ &CreateUpdateProformaLinkParams{
PostingNumber: "posting number", PostingNumber: "33920146-0252-1",
URL: "link", URL: "https://cdn.ozone.ru/s3/ozon-disk-api/techdoc/seller-api/earsivfatura_1690960445.pdf",
HSCode: "2134322",
Date: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2023-08-01T12:08:44.342Z"),
Number: "424fdsf234",
Price: 234.34,
PriceCurrency: InvoiceCurrencyRUB,
}, },
`{ `{
"result": true "result": true
@@ -43,11 +49,15 @@ func TestCreateUpdateProformaLink(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Invoices().CreateUpdate(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Invoices().CreateUpdate(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CreateUpdateProformaLinkResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -91,11 +101,15 @@ func TestGetProformaLink(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Invoices().Get(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Invoices().Get(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetProformaLinkResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -137,11 +151,15 @@ func TestDeleteProformaLink(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Invoices().Delete(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Invoices().Delete(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &DeleteProformaLinkResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

View File

@@ -0,0 +1,19 @@
package notifications
type MessageType string
const (
PingType MessageType = "TYPE_PING"
NewPostingType MessageType = "TYPE_NEW_POSTING"
PostingCancelledType MessageType = "TYPE_POSTING_CANCELLED"
StateChangedType MessageType = "TYPE_STATE_CHANGED"
CutoffDateChangedType MessageType = "TYPE_CUTOFF_DATE_CHANGED"
DeliveryDateChangedType MessageType = "TYPE_DELIVERY_DATE_CHANGED"
CreateOrUpdateType MessageType = "TYPE_CREATE_OR_UPDATE_ITEM"
PriceIndexChangedType MessageType = "TYPE_PRICE_INDEX_CHANGED"
StocksChangedType MessageType = "TYPE_STOCKS_CHANGED"
NewMessageType MessageType = "TYPE_NEW_MESSAGE"
UpdateMessageType MessageType = "TYPE_UPDATE_MESSAGE"
MessageReadType MessageType = "TYPE_MESSAGE_READ"
ChatClosedType MessageType = "TYPE_CHAT_CLOSED"
)

View File

@@ -0,0 +1,158 @@
package notifications
import (
"encoding/json"
"fmt"
"io/ioutil"
"log"
"net/http"
"time"
)
type Handler func(req interface{}) error
type NotificationServer struct {
port int
handlers map[MessageType]Handler
}
func NewNotificationServer(port int) *NotificationServer {
return &NotificationServer{
port: port,
handlers: map[MessageType]Handler{},
}
}
func (ns *NotificationServer) Run() error {
mux := http.NewServeMux()
mux.HandleFunc("/", ns.handler)
server := http.Server{
Addr: fmt.Sprintf("0.0.0.0:%d", ns.port),
Handler: mux,
}
return server.ListenAndServe()
}
func (ns *NotificationServer) handler(rw http.ResponseWriter, httpReq *http.Request) {
mt := &Common{}
content, err := ioutil.ReadAll(httpReq.Body)
if err != nil {
log.Print(err)
ns.error(rw, http.StatusBadRequest, err)
return
}
if err := json.Unmarshal(content, mt); err != nil {
log.Print(err)
ns.error(rw, http.StatusBadRequest, err)
return
}
if mt.MessageType == PingType {
resp := pingResponse{
Version: "1.0",
Name: "Ozon Seller API",
Time: time.Now(),
}
respJson, _ := json.Marshal(resp)
rw.WriteHeader(http.StatusOK)
rw.Write(respJson)
return
}
req, err := ns.unmarshal(mt.MessageType, content)
if err != nil {
log.Print(err)
ns.error(rw, http.StatusInternalServerError, err)
return
}
h, ok := ns.handlers[mt.MessageType]
if !ok {
ns.result(rw, true)
log.Printf("handler for %s is not registered", mt.MessageType)
return
}
if err := h(req); err != nil {
log.Print(err)
ns.result(rw, true)
return
}
ns.result(rw, true)
}
func (ns *NotificationServer) Register(mt MessageType, handler func(req interface{}) error) {
ns.handlers[mt] = handler
}
func (ns *NotificationServer) unmarshal(messageType MessageType, content []byte) (interface{}, error) {
switch messageType {
case NewPostingType:
v := &NewPosting{}
err := json.Unmarshal(content, v)
return v, err
case PostingCancelledType:
v := &PostingCancelled{}
err := json.Unmarshal(content, v)
return v, err
case StateChangedType:
v := &StateChanged{}
err := json.Unmarshal(content, v)
return v, err
case CutoffDateChangedType:
v := &CutoffDateChanged{}
err := json.Unmarshal(content, v)
return v, err
case DeliveryDateChangedType:
v := &DeliveryDateChanged{}
err := json.Unmarshal(content, v)
return v, err
case CreateOrUpdateType:
v := &CreateOrUpdateItem{}
err := json.Unmarshal(content, v)
return v, err
case PriceIndexChangedType:
v := &PriceIndexChanged{}
err := json.Unmarshal(content, v)
return v, err
case StocksChangedType:
v := &StocksChanged{}
err := json.Unmarshal(content, v)
return v, err
case NewMessageType:
v := &NewMessage{}
err := json.Unmarshal(content, v)
return v, err
case UpdateMessageType:
v := &UpdateMessage{}
err := json.Unmarshal(content, v)
return v, err
case MessageReadType:
v := &MessageRead{}
err := json.Unmarshal(content, v)
return v, err
case ChatClosedType:
v := &ChatClosed{}
err := json.Unmarshal(content, v)
return v, err
default:
return nil, fmt.Errorf("unsupported type: %s", messageType)
}
}
func (ns *NotificationServer) error(rw http.ResponseWriter, statusCode int, err error) {
errResp := errorResponse{
Data: errorData{
Code: fmt.Sprintf("%d", statusCode),
Message: err.Error(),
},
}
errJson, _ := json.Marshal(errResp)
rw.WriteHeader(statusCode)
rw.Write(errJson)
}
func (ns *NotificationServer) result(rw http.ResponseWriter, res bool) {
rw.WriteHeader(http.StatusOK)
rw.Write([]byte(fmt.Sprintf(`{"result": %t}`, res)))
}

View File

@@ -0,0 +1,687 @@
package notifications
import (
"encoding/json"
"fmt"
"io/ioutil"
"net"
"net/http"
"reflect"
"strings"
"testing"
"time"
core "github.com/diphantxm/ozon-api-client"
)
type testData struct {
raw string
object interface{}
}
func pingTest(t *testing.T) testData {
return testData{
object: &pingRequest{
Common: Common{MessageType: PingType},
Time: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2019-08-24T14:15:22Z"),
},
raw: `{
"message_type": "TYPE_PING",
"time": "2019-08-24T14:15:22Z"
}`,
}
}
func newPostingTest(t *testing.T) testData {
return testData{
object: &NewPosting{
Common: Common{MessageType: NewPostingType},
PostingNumber: "24219509-0020-1",
Products: []Product{
{
SKU: 147451959,
Quantity: 2,
},
},
InProccessAt: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-01-26T06:56:36.294Z"),
WarehouseId: 18850503335000,
SellerId: 15,
},
raw: `{
"message_type": "TYPE_NEW_POSTING",
"posting_number": "24219509-0020-1",
"products": [
{
"sku": 147451959,
"quantity": 2
}
],
"in_process_at": "2021-01-26T06:56:36.294Z",
"warehouse_id": 18850503335000,
"seller_id": 15
}`,
}
}
func postingCancelledTest(t *testing.T) testData {
return testData{
object: &PostingCancelled{
Common: Common{MessageType: PostingCancelledType},
PostingNumber: "24219509-0020-1",
Products: []Product{
{
SKU: 147451959,
Quantity: 1,
},
},
OldState: "posting_transferred_to_courier_service",
NewState: "posting_canceled",
ChangedStateDate: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-01-26T06:56:36.294Z"),
Reason: Reason{Id: 1, Message: "message"},
WarehouseId: 1,
SellerId: 15,
},
raw: `{
"message_type": "TYPE_POSTING_CANCELLED",
"posting_number": "24219509-0020-1",
"products": [
{
"sku": 147451959,
"quantity": 1
}
],
"old_state": "posting_transferred_to_courier_service",
"new_state": "posting_canceled",
"changed_state_date": "2021-01-26T06:56:36.294Z",
"reason": {
"id": 1,
"message": "message"
},
"warehouse_id": 1,
"seller_id": 15
}`,
}
}
func cutoffDateChangedTest(t *testing.T) testData {
return testData{
object: &CutoffDateChanged{
Common: Common{MessageType: CutoffDateChangedType},
PostingNumber: "24219509-0020-2",
NewCutoffDate: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-11-24T07:00:00Z"),
OldCutoffDate: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-11-21T10:00:00Z"),
WarehouseId: 1,
SellerId: 15,
},
raw: `{
"message_type": "TYPE_CUTOFF_DATE_CHANGED",
"posting_number": "24219509-0020-2",
"new_cutoff_date": "2021-11-24T07:00:00Z",
"old_cutoff_date": "2021-11-21T10:00:00Z",
"warehouse_id": 1,
"seller_id": 15
}`,
}
}
func deliveryDateChangedTest(t *testing.T) testData {
return testData{
object: &DeliveryDateChanged{
Common: Common{MessageType: DeliveryDateChangedType},
PostingNumber: "24219509-0020-2",
NewDeliveryDateBegin: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-11-24T07:00:00Z"),
NewDeliveryDateEnd: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-11-24T16:00:00Z"),
OldDeliveryDateBegin: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-11-21T10:00:00Z"),
OldDeliveryDateEnd: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-11-21T19:00:00Z"),
WarehouseId: 1,
SellerId: 15,
},
raw: `{
"message_type": "TYPE_DELIVERY_DATE_CHANGED",
"posting_number": "24219509-0020-2",
"new_delivery_date_begin": "2021-11-24T07:00:00Z",
"new_delivery_date_end": "2021-11-24T16:00:00Z",
"old_delivery_date_begin": "2021-11-21T10:00:00Z",
"old_delivery_date_end": "2021-11-21T19:00:00Z",
"warehouse_id": 1,
"seller_id": 15
}`,
}
}
func priceIndexChangedTest(t *testing.T) testData {
return testData{
object: &PriceIndexChanged{
Common: Common{MessageType: PriceIndexChangedType},
UpdatedAt: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-06-21T05:52:46.648533678Z"),
SKU: 147451959,
ProductId: 1234,
PriceIndex: 5678,
SellerId: 15,
},
raw: `{
"seller_id": 15,
"message_type": "TYPE_PRICE_INDEX_CHANGED",
"updated_at":"2022-06-21T05:52:46.648533678Z",
"sku": 147451959,
"product_id": 1234,
"price_index": 5678
}`,
}
}
func stocksChangedTest(t *testing.T) testData {
return testData{
object: &StocksChanged{
Common: Common{MessageType: StocksChangedType},
Items: []Item{
{
UpdatedAt: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-09-01T14:15:22Z"),
SKU: 5678,
ProductId: 1234,
Stocks: []Stock{
{
WarehouseId: 10,
Present: 50,
Reserved: 5,
},
},
},
},
SellerId: 15,
},
raw: `{
"message_type": "TYPE_STOCKS_CHANGED",
"seller_id": 15,
"items": [
{
"product_id": 1234,
"sku": 5678,
"updated_at": "2021-09-01T14:15:22Z",
"stocks": [
{
"warehouse_id": 10,
"present": 50,
"reserved": 5
}
]
}
]
}`,
}
}
func newMessageTest(t *testing.T) testData {
return testData{
object: &NewMessage{
Common: Common{MessageType: NewMessageType},
ChatId: "b646d975-0c9c-4872-9f41-8b1e57181063",
ChatType: "Buyer_Seller",
MessageId: "3000000000817031942",
CreatedAt: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-07-18T20:58:04.528Z"),
User: User{Id: "115568", Type: "Customer"},
Data: []string{"Message text"},
SellerId: 7,
},
raw: `{
"message_type": "TYPE_NEW_MESSAGE",
"chat_id": "b646d975-0c9c-4872-9f41-8b1e57181063",
"chat_type": "Buyer_Seller",
"message_id": "3000000000817031942",
"created_at": "2022-07-18T20:58:04.528Z",
"user": {
"id": "115568",
"type": "Customer"
},
"data": [
"Message text"
],
"seller_id": 7
}`,
}
}
func updateMessageTest(t *testing.T) testData {
return testData{
object: &UpdateMessage{
NewMessage: NewMessage{
Common: Common{MessageType: UpdateMessageType},
ChatId: "b646d975-0c9c-4872-9f41-8b1e57181063",
ChatType: "Buyer_Seller",
MessageId: "3000000000817031942",
CreatedAt: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-07-18T20:58:04.528Z"),
User: User{
Id: "115568",
Type: "Сustomer",
},
Data: []string{"Message text"},
SellerId: 7,
},
UpdatedAt: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-07-18T20:59:04.528Z"),
},
raw: `{
"message_type": "TYPE_UPDATE_MESSAGE",
"chat_id": "b646d975-0c9c-4872-9f41-8b1e57181063",
"chat_type": "Buyer_Seller",
"message_id": "3000000000817031942",
"created_at": "2022-07-18T20:58:04.528Z",
"updated_at": "2022-07-18T20:59:04.528Z",
"user": {
"id": "115568",
"type": "Сustomer"
},
"data": [
"Message text"
],
"seller_id": 7
}`,
}
}
func createUpdateItemTest(t *testing.T) testData {
return testData{
object: &CreateOrUpdateItem{
Common: Common{MessageType: "TYPE_CREATE_OR_UPDATE_ITEM"},
OfferId: "1234",
ProductId: 5678,
IsError: false,
ChangedAt: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-09-01T14:15:22Z"),
SellerId: 15,
},
raw: `{
"message_type": "TYPE_CREATE_OR_UPDATE_ITEM",
"seller_id": 15,
"offer_id": "1234",
"product_id": 5678,
"is_error": false,
"changed_at": "2022-09-01T14:15:22Z"
}`,
}
}
func stateChangedTest(t *testing.T) testData {
return testData{
object: &StateChanged{
Common: Common{MessageType: "TYPE_STATE_CHANGED"},
PostingNumber: "24219509-0020-2",
NewState: "posting_delivered",
ChangedStateDate: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2021-02-02T15:07:46.765Z"),
WarehouseId: 1,
SellerId: 15,
},
raw: `{
"message_type": "TYPE_STATE_CHANGED",
"posting_number": "24219509-0020-2",
"new_state": "posting_delivered",
"changed_state_date": "2021-02-02T15:07:46.765Z",
"warehouse_id": 1,
"seller_id": 15
}`,
}
}
func messageReadTest(t *testing.T) testData {
return testData{
object: &MessageRead{
LastReadMessageId: "3000000000817031942",
NewMessage: NewMessage{
Common: Common{MessageType: "TYPE_MESSAGE_READ"},
ChatId: "b646d975-0c9c-4872-9f41-8b1e57181063",
ChatType: "Buyer_Seller",
MessageId: "3000000000817031942",
CreatedAt: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-07-18T20:58:04.528Z"),
User: User{
Id: "115568",
Type: "Сustomer",
},
SellerId: 7,
},
},
raw: `{
"message_type": "TYPE_MESSAGE_READ",
"chat_id": "b646d975-0c9c-4872-9f41-8b1e57181063",
"chat_type": "Buyer_Seller",
"message_id": "3000000000817031942",
"created_at": "2022-07-18T20:58:04.528Z",
"user": {
"id": "115568",
"type": "Сustomer"
},
"last_read_message_id": "3000000000817031942",
"seller_id": 7
}`,
}
}
func chatClosedTest(t *testing.T) testData {
return testData{
object: &ChatClosed{
Common: Common{MessageType: ChatClosedType},
ChatId: "b646d975-0c9c-4872-9f41-8b1e57181063",
ChatType: "Buyer_Seller",
User: User{Id: "115568", Type: "Customer"},
SellerId: 7,
},
raw: `{
"message_type": "TYPE_CHAT_CLOSED",
"chat_id": "b646d975-0c9c-4872-9f41-8b1e57181063",
"chat_type": "Buyer_Seller",
"user": {
"id": "115568",
"type": "Customer"
},
"seller_id": 7
}`,
}
}
func TestNotificationServer(t *testing.T) {
testCases := []struct {
request testData
response string
}{
{
pingTest(t),
`{
"version": "1.0",
"name": "Ozon Seller API"
}`,
},
{
newPostingTest(t),
`{
"result": true
}`,
},
{
postingCancelledTest(t),
`{
"result": true
}`,
},
{
stateChangedTest(t),
`{
"result": true
}`,
},
{
cutoffDateChangedTest(t),
`{
"result": true
}`,
},
{
deliveryDateChangedTest(t),
`{
"result": true
}`,
},
{
createUpdateItemTest(t),
`{
"result": true
}`,
},
{
priceIndexChangedTest(t),
`{
"result": true
}`,
},
{
stocksChangedTest(t),
`{
"result": true
}`,
},
{
newMessageTest(t),
`{
"result": true
}`,
},
{
updateMessageTest(t),
`{
"result": true
}`,
},
{
messageReadTest(t),
`{
"result": true
}`,
},
{
chatClosedTest(t),
`{
"result": true
}`,
},
}
port := getFreePort()
client := http.Client{}
server := NewNotificationServer(port)
server.Register(NewPostingType, comparatorWith(newPostingTest(t).object))
server.Register(PostingCancelledType, comparatorWith(postingCancelledTest(t).object))
server.Register(StateChangedType, comparatorWith(stateChangedTest(t).object))
server.Register(CutoffDateChangedType, comparatorWith(cutoffDateChangedTest(t).object))
server.Register(DeliveryDateChangedType, comparatorWith(deliveryDateChangedTest(t).object))
server.Register(CreateOrUpdateType, comparatorWith(createUpdateItemTest(t).object))
server.Register(PriceIndexChangedType, comparatorWith(priceIndexChangedTest(t).object))
server.Register(StocksChangedType, comparatorWith(stocksChangedTest(t).object))
server.Register(NewMessageType, comparatorWith(newMessageTest(t).object))
server.Register(UpdateMessageType, comparatorWith(updateMessageTest(t).object))
server.Register(MessageReadType, comparatorWith(messageReadTest(t).object))
server.Register(ChatClosedType, comparatorWith(chatClosedTest(t).object))
go func() {
if err := server.Run(); err != nil {
t.Fatalf("notification server is down: %s", err)
}
}()
// TODO: get rid of it
// Needed to make sure server is running
time.Sleep(3 * time.Second)
for _, testCase := range testCases {
httpResp, err := client.Post(fmt.Sprintf("http://0.0.0.0:%d/", port), "application/json", strings.NewReader(testCase.request.raw))
if err != nil {
t.Error(err)
continue
}
gotJson, err := ioutil.ReadAll(httpResp.Body)
if err != nil {
t.Error(err)
continue
}
expected := map[string]interface{}{}
got := map[string]interface{}{}
err = json.Unmarshal(gotJson, &got)
if err != nil {
t.Error(err)
continue
}
err = json.Unmarshal([]byte(testCase.response), &expected)
if err != nil {
t.Error(err)
continue
}
if err := compare(expected, got); err != nil {
t.Error(err)
continue
}
}
}
func TestNotificationServerErrors(t *testing.T) {
testCases := []struct {
request testData
response string
}{
{
testData{
raw: `{
"message_type": "string"
}`,
},
`
{
"error": {
"code": "500",
"message": "unsupported type: string",
"details": ""
}
}`,
},
{
testData{
raw: `invalid json`,
},
`{
"error": {
"code": "400",
"message": "invalid character 'i' looking for beginning of value",
"details": ""
}
}`,
},
{
testData{
raw: `{
"message_type": "TYPE_NEW_POSTING",
"field": [[
}`,
},
`{
"error": {
"code": "400",
"message": "invalid character '}' looking for beginning of value",
"details": ""
}
}`,
},
{
testData{
raw: `{
"message_type": "TYPE_NEW_POSTING"
}`,
},
`{
"result": true
}`,
},
{
testData{
raw: `{
"message_type": "TYPE_PING",
"time": "2019-08-24T14:15:22Z",
}`,
},
`{
"error": {
"code": "400",
"message": "invalid character '}' looking for beginning of object key string",
"details": ""
}
}`,
},
{
testData{
raw: `{
"message_type": "TYPE_CHAT_CLOSED"
}`,
},
`{
"result": true
}`,
},
}
port := getFreePort()
client := http.Client{}
server := NewNotificationServer(port)
server.Register(NewPostingType, func(req interface{}) error {
return fmt.Errorf("just error")
})
go func() {
if err := server.Run(); err != nil {
t.Fatalf("notification server is down: %s", err)
}
}()
// TODO: get rid of it
// Needed to make sure server is running
time.Sleep(3 * time.Second)
for _, testCase := range testCases {
httpResp, err := client.Post(fmt.Sprintf("http://0.0.0.0:%d/", port), "application/json", strings.NewReader(testCase.request.raw))
if err != nil {
t.Error(err)
continue
continue
}
gotJson, err := ioutil.ReadAll(httpResp.Body)
if err != nil {
t.Error(err)
continue
continue
}
expected := map[string]interface{}{}
got := map[string]interface{}{}
err = json.Unmarshal(gotJson, &got)
if err != nil {
t.Error(err)
continue
continue
}
err = json.Unmarshal([]byte(testCase.response), &expected)
if err != nil {
t.Error(err)
continue
continue
}
if err := compare(expected, got); err != nil {
t.Error(err)
continue
continue
}
}
}
func compare(expected map[string]interface{}, got map[string]interface{}) error {
for k, v := range expected {
if gotValue, ok := got[k]; !ok {
return fmt.Errorf("key %s is expected to present", k)
} else if !reflect.DeepEqual(gotValue, v) {
return fmt.Errorf("key %s is not equal, got: %v, want: %v", k, gotValue, v)
}
}
return nil
}
func getFreePort() int {
listener, _ := net.Listen("tcp", ":0")
defer listener.Close()
return listener.Addr().(*net.TCPAddr).Port
}
func comparatorWith(v1 interface{}) func(v2 interface{}) error {
return func(v2 interface{}) error {
if !reflect.DeepEqual(v1, v2) {
return fmt.Errorf("objects are not equal:\n got: %#v,\n want: %#v", v2, v1)
}
return nil
}
}

321
ozon/notifications/types.go Normal file
View File

@@ -0,0 +1,321 @@
package notifications
import "time"
// Checking if the service is ready at initial connection and periodically after it
type pingRequest struct {
Common
// Date and time when the notification was sent in UTC format
Time time.Time `json:"time"`
}
type pingResponse struct {
// Application version
Version string `json:"version"`
// Application name
Name string `json:"name"`
// Date and time when notification processing started in UTC format
Time time.Time `json:"time"`
}
type Common struct {
MessageType MessageType `json:"message_type"`
}
// New shipment
type NewPosting struct {
Common
// Shipment number
PostingNumber string `json:"posting_number"`
// Products information
Products []Product `json:"products"`
// Date and time when the shipment processing started in the UTC format
InProccessAt time.Time `json:"in_process_at"`
// Warehouse identifier where the products for this shipment are stored
WarehouseId int64 `json:"warehouse_id"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
type Product struct {
// Product SKU
SKU int64 `json:"sku"`
// Product quantity
Quantity int64 `json:"quantity"`
}
// Shipment cancellation
type PostingCancelled struct {
Common
// Shipment number
PostingNumber string `json:"posting_number"`
// Products information
Products []Product `json:"products"`
// Previous shipment status
OldState string `json:"old_state"`
// New shipment status: posting_canceled—canceled
NewState string `json:"new_state"`
// Date and time when the shipment status was changed in UTC format
ChangedStateDate time.Time `json:"changed_state_date"`
// Information about cancellation reason
Reason Reason `json:"reason"`
// Warehouse identifier where the products for this shipment are stored
WarehouseId int64 `json:"warehouse_id"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
type Reason struct {
// Cancellation reason identifier
Id int64 `json:"id"`
// Cancellation reason
Message string `json:"message"`
}
// Shipment status change
type StateChanged struct {
Common
// Shipment number
PostingNumber string `json:"posting_number"`
// New shipment status
NewState string `json:"new_state"`
// Date and time when the shipment status was changed in UTC format
ChangedStateDate time.Time `json:"changed_state_date"`
// Warehouse identifier where the products for this shipment are stored
WarehouseId int64 `json:"warehouse_id"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
// Shipment shipping date change
type CutoffDateChanged struct {
Common
// Shipment number
PostingNumber string `json:"posting_number"`
// New shipping date and time in UTC format
NewCutoffDate time.Time `json:"new_cutoff_date"`
// Previous shipping date and time in UTC format
OldCutoffDate time.Time `json:"old_cutoff_date"`
// Warehouse identifier where the products for this shipment are stored
WarehouseId int64 `json:"warehouse_id"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
// Shipment delivery date change
type DeliveryDateChanged struct {
Common
// Shipment number
PostingNumber string `json:"posting_number"`
// New delivery start date and time in UTC format
NewDeliveryDateBegin time.Time `json:"new_delivery_date_begin"`
// New delivery end date and time in UTC format
NewDeliveryDateEnd time.Time `json:"new_delivery_date_end"`
// Previous delivery start date and time in UTC format
OldDeliveryDateBegin time.Time `json:"old_delivery_date_begin"`
// Previous delivery end date and time in UTC format
OldDeliveryDateEnd time.Time `json:"old_delivery_date_end"`
// Warehouse identifier where the products for this shipment are stored
WarehouseId int64 `json:"warehouse_id"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
// Product creation and update or processing error
type CreateOrUpdateItem struct {
Common
// Product identifier in the seller's system
OfferId string `json:"offer_id"`
// Product identifier
ProductId int64 `json:"product_id"`
// An indication that errors occurred during the product creation or update
IsError bool `json:"is_error"`
// Update date and time
ChangedAt time.Time `json:"changed_at"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
// Product price index change
type PriceIndexChanged struct {
Common
// Date and time of price index change
UpdatedAt time.Time `json:"updated_at"`
// Product SKU
SKU int64 `json:"sku"`
// Product identifier
ProductId int64 `json:"product_id"`
// Price index
PriceIndex int64 `json:"price_index"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
// Stock change at the seller's warehouse
type StocksChanged struct {
Common
// Array with products data
Items []Item `json:"items"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
type Item struct {
// Update date and time
UpdatedAt time.Time `json:"updated_at"`
// Product SKU when working under the FBS or rFBS schemes
SKU int64 `json:"sku"`
// Product identifier
ProductId int64 `json:"product_id"`
// Array with product stocks data
Stocks []Stock `json:"stocks"`
}
type Stock struct {
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
// Total product stocks at the warehouse
Present int64 `json:"present"`
// Number of reserved products at the warehouse
Reserved int64 `json:"reserved"`
}
// New message in chat
type NewMessage struct {
Common
// Chat identifier
ChatId string `json:"chat_id"`
// Chat type
ChatType string `json:"chat_type"`
// Message identifier
MessageId string `json:"message_id"`
// Message creation date
CreatedAt time.Time `json:"created_at"`
// Information about message sender
User User `json:"user"`
// Array with message content in Markdown format
Data []string `json:"data"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
type User struct {
// Sender identifier
Id string `json:"id"`
// Sender type
Type string `json:"type"`
}
// Message in chat has changed
type UpdateMessage struct {
NewMessage
// Message update date
UpdatedAt time.Time `json:"updated_at"`
}
// Customer or support read your message
type MessageRead struct {
NewMessage
// Last read message identifier
LastReadMessageId string `json:"last_read_message_id"`
}
// Chat is closed
type ChatClosed struct {
Common
// Chat identifier
ChatId string `json:"chat_id"`
// Chat type
ChatType string `json:"chat_type"`
// Information about the user who closed the chat
User User `json:"user"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
type Response struct {
// Notification is received
Result bool `json:"result"`
}
type errorResponse struct {
// Information about the error
Data errorData `json:"error"`
}
type errorData struct {
// Error code
Code string `json:"code"`
// Detailed error description
Message string `json:"message"`
// Additional information
Details string `json:"details"`
}

View File

@@ -30,6 +30,8 @@ type Client struct {
brands *Brands brands *Brands
chats *Chats chats *Chats
certificates *Certificates certificates *Certificates
strategies *Strategies
barcodes *Barcodes
} }
func (c Client) Analytics() *Analytics { func (c Client) Analytics() *Analytics {
@@ -100,8 +102,16 @@ func (c Client) Certificates() *Certificates {
return c.certificates return c.certificates
} }
func NewClient(clientId, apiKey string) *Client { func (c Client) Strategies() *Strategies {
coreClient := core.NewClient(DefaultAPIBaseUrl, map[string]string{ return c.strategies
}
func (c Client) Barcodes() *Barcodes {
return c.barcodes
}
func NewClient(httpClient core.HttpClient, clientId, apiKey string) *Client {
coreClient := core.NewClient(httpClient, DefaultAPIBaseUrl, map[string]string{
"Client-Id": clientId, "Client-Id": clientId,
"Api-Key": apiKey, "Api-Key": apiKey,
}) })
@@ -125,6 +135,8 @@ func NewClient(clientId, apiKey string) *Client {
brands: &Brands{client: coreClient}, brands: &Brands{client: coreClient},
chats: &Chats{client: coreClient}, chats: &Chats{client: coreClient},
certificates: &Certificates{client: coreClient}, certificates: &Certificates{client: coreClient},
strategies: &Strategies{client: coreClient},
barcodes: &Barcodes{client: coreClient},
} }
} }
@@ -150,5 +162,7 @@ func NewMockClient(handler http.HandlerFunc) *Client {
brands: &Brands{client: coreClient}, brands: &Brands{client: coreClient},
chats: &Chats{client: coreClient}, chats: &Chats{client: coreClient},
certificates: &Certificates{client: coreClient}, certificates: &Certificates{client: coreClient},
strategies: &Strategies{client: coreClient},
barcodes: &Barcodes{client: coreClient},
} }
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
core "github.com/diphantxm/ozon-api-client" core "github.com/diphantxm/ozon-api-client"
@@ -25,12 +26,12 @@ type CreateDeliveryPolygonResponse struct {
// You can link a polygon to the delivery method. // You can link a polygon to the delivery method.
// //
// Create a polygon getting its coordinates on https://geojson.io: mark at least 3 points on the map and connect them // Create a polygon getting its coordinates on https://geojson.io: mark at least 3 points on the map and connect them
func (c Polygons) CreateDelivery(params *CreateDeliveryPolygonParams) (*CreateDeliveryPolygonResponse, error) { func (c Polygons) CreateDelivery(ctx context.Context, params *CreateDeliveryPolygonParams) (*CreateDeliveryPolygonResponse, error) {
url := "/v1/polygon/create" url := "/v1/polygon/create"
resp := &CreateDeliveryPolygonResponse{} resp := &CreateDeliveryPolygonResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -71,36 +72,12 @@ type LinkDeliveryMethodToPolygonResponse struct {
} }
// Link delivery method to a delivery polygon // Link delivery method to a delivery polygon
func (c Polygons) Link(params *LinkDeliveryMethodToPolygonParams) (*LinkDeliveryMethodToPolygonResponse, error) { func (c Polygons) Link(ctx context.Context, params *LinkDeliveryMethodToPolygonParams) (*LinkDeliveryMethodToPolygonResponse, error) {
url := "/v1/polygon/bind" url := "/v1/polygon/bind"
resp := &LinkDeliveryMethodToPolygonResponse{} resp := &LinkDeliveryMethodToPolygonResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) 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 DeletePolygonParams struct {
// Polygons identifiers list
PolygonIds []int64 `json:"polygon_ids"`
}
type DeletePolygonResponse struct {
core.CommonResponse
}
// Delete polygon
func (c Polygons) Delete(params *DeletePolygonParams) (*DeletePolygonResponse, error) {
url := "/v1/polygon/delete"
resp := &DeletePolygonResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -24,7 +25,7 @@ func TestCreateDeliveryPolygon(t *testing.T) {
Coordinates: "[[[30.149574279785153,59.86550435303646],[30.21205902099609,59.846884387977326],[30.255661010742184,59.86240174913176],[30.149574279785153,59.86550435303646]]]", Coordinates: "[[[30.149574279785153,59.86550435303646],[30.21205902099609,59.846884387977326],[30.255661010742184,59.86240174913176],[30.149574279785153,59.86550435303646]]]",
}, },
`{ `{
"polygonId": "1323" "polygon_id": 1323
}`, }`,
}, },
// Test No Client-Id or Api-Key // Test No Client-Id or Api-Key
@@ -42,11 +43,15 @@ func TestCreateDeliveryPolygon(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Polygons().CreateDelivery(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Polygons().CreateDelivery(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CreateDeliveryPolygonResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -96,55 +101,15 @@ func TestLinkDeliveryMethodToPolygon(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Polygons().Link(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
if err != nil { resp, err := c.Polygons().Link(ctx, test.params)
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestDeletePolygon(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *DeletePolygonParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&DeletePolygonParams{
PolygonIds: []int64{1323},
},
`{}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&DeletePolygonParams{},
`{
"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.Polygons().Delete(test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &LinkDeliveryMethodToPolygonResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"fmt" "fmt"
"net/http" "net/http"
"testing" "testing"
@@ -70,11 +71,15 @@ func TestGetStocksInfo(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetStocksInfo(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetStocksInfo(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetStocksInfoResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -122,7 +127,7 @@ func TestGetProductDetails(t *testing.T) {
"7533900005" "7533900005"
], ],
"buybox_price": "", "buybox_price": "",
"category_id": 17038062, "description_category_id": 17038062,
"created_at": "2021-10-21T15:48:03.529178Z", "created_at": "2021-10-21T15:48:03.529178Z",
"images": [ "images": [
"https://cdn1.ozone.ru/s3/multimedia-5/6088931525.jpg", "https://cdn1.ozone.ru/s3/multimedia-5/6088931525.jpg",
@@ -159,7 +164,6 @@ func TestGetProductDetails(t *testing.T) {
"present": 0, "present": 0,
"reserved": 0 "reserved": 0
}, },
"errors": [],
"updated_at": "2023-02-09T06:46:44.152Z", "updated_at": "2023-02-09T06:46:44.152Z",
"vat": "0.0", "vat": "0.0",
"visible": false, "visible": false,
@@ -168,7 +172,24 @@ func TestGetProductDetails(t *testing.T) {
"has_stock": false, "has_stock": false,
"active_product": false "active_product": false
}, },
"price_index": "0.00", "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": [], "commissions": [],
"volume_weight": 0.1, "volume_weight": 0.1,
"is_prepayment": false, "is_prepayment": false,
@@ -233,7 +254,7 @@ func TestGetProductDetails(t *testing.T) {
"state_updated_at": "2021-10-21T15:48:03.927309Z" "state_updated_at": "2021-10-21T15:48:03.927309Z"
} }
} }
}`, }`,
}, },
// Test No Client-Id or Api-Key // Test No Client-Id or Api-Key
{ {
@@ -250,11 +271,15 @@ func TestGetProductDetails(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetProductDetails(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetProductDetails(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetProductDetailsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -266,7 +291,7 @@ func TestGetProductDetails(t *testing.T) {
if resp.Result.OfferId == "" { if resp.Result.OfferId == "" {
t.Errorf("Offer id cannot be empty") t.Errorf("Offer id cannot be empty")
} }
if resp.Result.CategoryId == 0 { if resp.Result.DescriptionCategoryId == 0 {
t.Errorf("Category id cannot be 0") t.Errorf("Category id cannot be 0")
} }
if resp.Result.CurrencyCode == "" { if resp.Result.CurrencyCode == "" {
@@ -324,11 +349,15 @@ func TestUpdateStocks(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().UpdateStocks(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().UpdateStocks(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &UpdateStocksResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -363,12 +392,12 @@ func TestStocksInSellersWarehouse(t *testing.T) {
http.StatusOK, http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"}, map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&StocksInSellersWarehouseParams{ &StocksInSellersWarehouseParams{
FBSSKU: []string{"123"}, SKU: []string{"123"},
}, },
`{ `{
"result": [ "result": [
{ {
"fbs_sku": 12, "sku": 12,
"present": 34, "present": 34,
"product_id": 548761, "product_id": 548761,
"reserved": 5, "reserved": 5,
@@ -393,21 +422,25 @@ func TestStocksInSellersWarehouse(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().StocksInSellersWarehouse(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().StocksInSellersWarehouse(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &StocksInSellersWarehouseResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", 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.StatusCode == http.StatusOK {
if len(resp.Result) != len(test.params.FBSSKU) { if len(resp.Result) != len(test.params.SKU) {
t.Errorf("Length of skus in request and response must be equal") t.Errorf("Length of skus in request and response must be equal")
} }
if len(resp.Result) > 0 { if len(resp.Result) > 0 {
if fmt.Sprint(resp.Result[0].FBSSKU) == test.params.FBSSKU[0] { if fmt.Sprint(resp.Result[0].SKU) == test.params.SKU[0] {
t.Errorf("fbs sku in request and response are not equal") t.Errorf("fbs sku in request and response are not equal")
} }
} }
@@ -431,12 +464,13 @@ func TestUpdatePrices(t *testing.T) {
&UpdatePricesParams{ &UpdatePricesParams{
Prices: []UpdatePricesPrice{ Prices: []UpdatePricesPrice{
{ {
AutoActionEnabled: "UNKNOWN", AutoActionEnabled: "UNKNOWN",
CurrencyCode: "RUB", CurrencyCode: "RUB",
MinPrice: "800", MinPrice: "800",
OldPrice: "0", OldPrice: "0",
Price: "1448", Price: "1448",
ProductId: 1386, ProductId: 1386,
PriceStrategyEnabled: PriceStrategyUnknown,
}, },
}, },
}, },
@@ -466,11 +500,15 @@ func TestUpdatePrices(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().UpdatePrices(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().UpdatePrices(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &UpdatePricesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -538,11 +576,15 @@ func TestUpdateQuantityStockProducts(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().UpdateQuantityStockProducts(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().UpdateQuantityStockProducts(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &UpdateQuantityStockProductsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -633,21 +675,21 @@ func TestCreateOrUpdateProduct(t *testing.T) {
}, },
}, },
}, },
Barcode: "112772873170", Barcode: "112772873170",
CategoryId: 17033876, DescriptionCategoryId: 17033876,
CurrencyCode: "RUB", CurrencyCode: "RUB",
Depth: 10, Depth: 10,
DimensionUnit: "mm", DimensionUnit: "mm",
Height: 250, Height: 250,
Name: "Комплект защитных плёнок для X3 NFC. Темный хлопок", Name: "Комплект защитных плёнок для X3 NFC. Темный хлопок",
OfferId: "143210608", OfferId: "143210608",
OldPrice: "1100", OldPrice: "1100",
PremiumPrice: "900", PremiumPrice: "900",
Price: "1000", Price: "1000",
VAT: "0.1", VAT: "0.1",
Weight: 100, Weight: 100,
WeightUnit: "g", WeightUnit: "g",
Width: 150, Width: 150,
}, },
}, },
}, },
@@ -672,11 +714,15 @@ func TestCreateOrUpdateProduct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().CreateOrUpdateProduct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().CreateOrUpdateProduct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CreateOrUpdateProductResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -739,11 +785,15 @@ func TestGetListOfProducts(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetListOfProducts(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetListOfProducts(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetListOfProductsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -985,11 +1035,15 @@ func TestGetProductsRatingBySKU(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetProductsRatingBySKU(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetProductsRatingBySKU(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetProductsRatingBySKUResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1052,11 +1106,15 @@ func TestGetProductImportStatus(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetProductImportStatus(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetProductImportStatus(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetProductImportStatusResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1123,11 +1181,15 @@ func TestCreateProductByOzonID(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().CreateProductByOzonID(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().CreateProductByOzonID(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &CreateProductByOzonIDResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1191,11 +1253,15 @@ func TestUpdateProductImages(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().UpdateProductImages(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().UpdateProductImages(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ProductInfoResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1259,11 +1325,15 @@ func TestCheckImageUploadingStatus(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().CheckImageUploadingStatus(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().CheckImageUploadingStatus(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ProductInfoResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1307,7 +1377,7 @@ func TestListProductsByIDs(t *testing.T) {
"7533900005" "7533900005"
], ],
"buybox_price": "", "buybox_price": "",
"category_id": 93726157, "description_category_id": 93726157,
"created_at": "2021-06-03T03:40:05.871465Z", "created_at": "2021-06-03T03:40:05.871465Z",
"images": [], "images": [],
"has_discounted_item": true, "has_discounted_item": true,
@@ -1336,13 +1406,11 @@ func TestListProductsByIDs(t *testing.T) {
"source": "fbs" "source": "fbs"
} }
], ],
"state": "",
"stocks": { "stocks": {
"coming": 0, "coming": 0,
"present": 13, "present": 13,
"reserved": 0 "reserved": 0
}, },
"errors": [],
"updated_at": "2023-02-09T06:46:44.152Z", "updated_at": "2023-02-09T06:46:44.152Z",
"vat": "0.0", "vat": "0.0",
"visible": true, "visible": true,
@@ -1378,7 +1446,6 @@ func TestListProductsByIDs(t *testing.T) {
"offer_id": "23", "offer_id": "23",
"barcode": "", "barcode": "",
"buybox_price": "", "buybox_price": "",
"category_id": 90635895,
"created_at": "2021-05-26T20:26:07.565586Z", "created_at": "2021-05-26T20:26:07.565586Z",
"images": [], "images": [],
"marketing_price": "", "marketing_price": "",
@@ -1399,13 +1466,11 @@ func TestListProductsByIDs(t *testing.T) {
"source": "fbs" "source": "fbs"
} }
], ],
"state": "",
"stocks": { "stocks": {
"coming": 0, "coming": 0,
"present": 19, "present": 19,
"reserved": 0 "reserved": 0
}, },
"errors": [],
"updated_at": "2023-02-09T06:46:44.152Z", "updated_at": "2023-02-09T06:46:44.152Z",
"vat": "0.0", "vat": "0.0",
"visible": true, "visible": true,
@@ -1454,11 +1519,15 @@ func TestListProductsByIDs(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().ListProductsByIDs(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().ListProductsByIDs(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListProductsByIDsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1503,7 +1572,7 @@ func TestGetDescriptionOfProduct(t *testing.T) {
{ {
"id": 213761435, "id": 213761435,
"barcode": "", "barcode": "",
"category_id": 17038062, "description_category_id": 17038062,
"name": "Пленка защитная для Xiaomi Redmi Note 10 Pro 5G", "name": "Пленка защитная для Xiaomi Redmi Note 10 Pro 5G",
"offer_id": "21470", "offer_id": "21470",
"height": 10, "height": 10,
@@ -1665,8 +1734,7 @@ func TestGetDescriptionOfProduct(t *testing.T) {
} }
], ],
"complex_attributes": [], "complex_attributes": [],
"color_image": "", "color_image": ""
"last_id": ""
} }
], ],
"total": 1, "total": 1,
@@ -1688,11 +1756,15 @@ func TestGetDescriptionOfProduct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetDescriptionOfProduct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetDescriptionOfProduct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetDescriptionOfProductResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1746,11 +1818,15 @@ func TestGetProductDescription(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetProductDescription(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetProductDescription(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetProductDescriptionResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1809,11 +1885,15 @@ func TestGetProductRangeLimit(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetProductRangeLimit() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetProductRangeLimit(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetProductRangeLimitResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1865,11 +1945,15 @@ func TestChangeProductIDs(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().ChangeProductIDs(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().ChangeProductIDs(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ChangeProductIDsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1911,11 +1995,15 @@ func TestArchiveProduct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().ArchiveProduct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().ArchiveProduct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ArchiveProductResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -1957,11 +2045,15 @@ func TestUnarchiveProduct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().UnarchiveProduct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().UnarchiveProduct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ArchiveProductResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2013,11 +2105,15 @@ func TestRemoveProductWithoutSKU(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().RemoveProductWithoutSKU(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().RemoveProductWithoutSKU(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &RemoveProductWithoutSKUResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2090,11 +2186,15 @@ func TestListGeoRestrictions(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().ListGeoRestrictions(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().ListGeoRestrictions(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListGeoRestrictionsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2139,11 +2239,15 @@ func TestUploadActivationCodes(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().UploadActivationCodes(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().UploadActivationCodes(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &UploadActivationCodesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2187,11 +2291,15 @@ func TestStatusOfUploadingActivationCodes(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().StatusOfUploadingActivationCodes(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().StatusOfUploadingActivationCodes(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &StatusOfUploadingActivationCodesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2222,6 +2330,7 @@ func TestGetProductPriceInfo(t *testing.T) {
"result": { "result": {
"items": [ "items": [
{ {
"acquiring": 0,
"product_id": 243686911, "product_id": 243686911,
"offer_id": "356792", "offer_id": "356792",
"price": { "price": {
@@ -2237,9 +2346,28 @@ func TestGetProductPriceInfo(t *testing.T) {
"marketing_seller_price": "", "marketing_seller_price": "",
"auto_action_enabled": true "auto_action_enabled": true
}, },
"price_index": "0.00", "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": { "commissions": {
"sales_percent": 15, "sales_percent": 15,
"sales_percent_fbo": 15,
"sales_percent_fbs": 0,
"fbo_fulfillment_amount": 0, "fbo_fulfillment_amount": 0,
"fbo_direct_flow_trans_min_amount": 31, "fbo_direct_flow_trans_min_amount": 31,
"fbo_direct_flow_trans_max_amount": 46.5, "fbo_direct_flow_trans_max_amount": 46.5,
@@ -2248,7 +2376,7 @@ func TestGetProductPriceInfo(t *testing.T) {
"fbo_return_flow_trans_min_amount": 21.7, "fbo_return_flow_trans_min_amount": 21.7,
"fbo_return_flow_trans_max_amount": 21.7, "fbo_return_flow_trans_max_amount": 21.7,
"fbs_first_mile_min_amount": 0, "fbs_first_mile_min_amount": 0,
"fbs_first_mile_max_amount": 0, "fbs_first_mile_max_amount": 25,
"fbs_direct_flow_trans_min_amount": 41, "fbs_direct_flow_trans_min_amount": 41,
"fbs_direct_flow_trans_max_amount": 61.5, "fbs_direct_flow_trans_max_amount": 61.5,
"fbs_deliv_to_customer_amount": 60, "fbs_deliv_to_customer_amount": 60,
@@ -2280,11 +2408,15 @@ func TestGetProductPriceInfo(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetProductPriceInfo(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetProductPriceInfo(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetProductPriceInfoResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -2342,9 +2474,11 @@ func TestGetMarkdownInfo(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().GetMarkdownInfo(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().GetMarkdownInfo(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
@@ -2352,6 +2486,8 @@ func TestGetMarkdownInfo(t *testing.T) {
} }
if resp.StatusCode == http.StatusOK { if resp.StatusCode == http.StatusOK {
compareJsonResponse(t, test.response, &GetMarkdownInfoResponse{})
if len(resp.Items) > 0 { if len(resp.Items) > 0 {
if fmt.Sprint(resp.Items[0].DiscountedSKU) != test.params.DiscountedSKUs[0] { if fmt.Sprint(resp.Items[0].DiscountedSKU) != test.params.DiscountedSKUs[0] {
t.Errorf("SKUs in reqest and resonse are not equal") t.Errorf("SKUs in reqest and resonse are not equal")
@@ -2397,13 +2533,219 @@ func TestSetDiscountOnMarkdownProduct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Products().SetDiscountOnMarkdownProduct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Products().SetDiscountOnMarkdownProduct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
compareJsonResponse(t, test.response, &SetDiscountOnMarkdownProductResponse{})
}
}
func TestNumberOfSubsToProductAvailability(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *NumberOfSubsToProductAvailabilityParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&NumberOfSubsToProductAvailabilityParams{
SKUS: []int64{1234},
},
`{
"result": [
{
"count": 2,
"sku": 1234
}
]
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&NumberOfSubsToProductAvailabilityParams{},
`{
"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().NumberOfSubsToProductAvailability(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
compareJsonResponse(t, test.response, &NumberOfSubsToProductAvailabilityResponse{})
if resp.StatusCode == http.StatusOK {
if len(resp.Result) != len(test.params.SKUS) {
t.Errorf("Length of SKUS in request and response are not equal")
}
if len(resp.Result) > 0 {
if resp.Result[0].SKU != test.params.SKUS[0] {
t.Errorf("SKU in request and response are not equal")
}
}
}
}
}
func TestUpdateCharacteristics(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *UpdateCharacteristicsParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&UpdateCharacteristicsParams{
Items: []UpdateCharacteristicsItem{
{
Attributes: []UpdateCharacteristicsItemAttribute{
{
ComplexId: 0,
Id: 0,
Values: []UpdateCharacteristicsItemValue{
{
DictionaryValueId: 0,
Value: "string",
},
},
},
},
OfferId: "string",
},
},
},
`{
"task_id": 0
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&UpdateCharacteristicsParams{},
`{
"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().UpdateCharacteristics(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
compareJsonResponse(t, test.response, &UpdateCharacteristicsResponse{})
}
}
func TestGetRelatedSKUs(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetRelatedSKUsParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetRelatedSKUsParams{
SKUs: []string{"321", "322"},
},
`{
"items": [
{
"availability": "HIDDEN",
"deleted_at": "2019-08-24T14:15:22Z",
"delivery_schema": "fbs",
"product_id": 123,
"sku": 321
}
],
"errors": [
{
"code": "test_code",
"sku": 322,
"message": "test_message"
}
]
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetRelatedSKUsParams{},
`{
"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().GetRelatedSKUs(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
compareJsonResponse(t, test.response, &GetRelatedSKUsResponse{})
if len(resp.Errors)+len(resp.Items) != len(test.params.SKUs) {
t.Errorf("expected equal length of skus in request and response")
}
} }
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -15,68 +16,70 @@ type GetAvailablePromotionsResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result []struct { Result []GetAvailablePromotionsResult `json:"result"`
// Promotion identifier }
Id float64 `json:"id"`
// Promotion name type GetAvailablePromotionsResult struct {
Title string `json:"title"` // Promotion identifier
Id float64 `json:"id"`
// Promotion type // Promotion name
ActionType string `json:"action_type"` Title string `json:"title"`
// Promotion description // Promotion type
Description string `json:"description"` ActionType string `json:"action_type"`
// Promotion start date // Promotion description
DateStart string `json:"date_start"` Description string `json:"description"`
// Promotion end date // Promotion start date
DateEnd string `json:"date_end"` DateStart string `json:"date_start"`
// Promotion freeze date. // Promotion end date
// DateEnd string `json:"date_end"`
// 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"`
// Number of products that can participate in the promotion // Promotion freeze date.
PotentialProductsCount float64 `json:"potential_products_count"` //
// 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"`
// Number of products that participate in the promotion // Number of products that can participate in the promotion
ParticipatingProductsCount float64 `json:"participating_products_count"` PotentialProductsCount float64 `json:"potential_products_count"`
// Whether or not you participate in the promotion // Number of products that participate in the promotion
IsParticipating bool `json:"participating"` ParticipatingProductsCount float64 `json:"participating_products_count"`
// Indication that customers need a promo code to participate in the promotion // Whether or not you participate in the promotion
IsVoucherAction bool `json:"is_voucher_action"` IsParticipating bool `json:"is_participating"`
// Number of blocked products // Indication that customers need a promo code to participate in the promotion
BannedProductsCount float64 `json:"banned_products_count"` IsVoucherAction bool `json:"is_voucher_action"`
// Indication of the promotion is with the target audience // Number of blocked products
WithTargeting bool `json:"with_targeting"` BannedProductsCount float64 `json:"banned_products_count"`
// Order amount // Indication of the promotion is with the target audience
OrderAmount float64 `json:"order_amount"` WithTargeting bool `json:"with_targeting"`
// Discount type // Order amount
DiscountType string `json:"discount_type"` OrderAmount float64 `json:"order_amount"`
// Discount size // Discount type
DiscountValue float64 `json:"discount_value"` DiscountType string `json:"discount_type"`
} `json:"result"`
// Discount size
DiscountValue float64 `json:"discount_value"`
} }
// A method for getting a list of promotions that you can participate in // A method for getting a list of promotions that you can participate in
func (c Promotions) GetAvailablePromotions() (*GetAvailablePromotionsResponse, error) { func (c Promotions) GetAvailablePromotions(ctx context.Context) (*GetAvailablePromotionsResponse, error) {
url := "/v1/actions" url := "/v1/actions"
resp := &GetAvailablePromotionsResponse{} resp := &GetAvailablePromotionsResponse{}
response, err := c.client.Request(http.MethodGet, url, nil, resp) response, err := c.client.Request(ctx, http.MethodGet, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -108,28 +111,32 @@ type AddProductToPromotionResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result AddProductToPromotionResult `json:"result"`
// List of product identifiers that were added to the promotion }
ProductIds []float64 `json:"product_ids"`
// List of products that weren't added to the promotion type AddProductToPromotionResult struct {
Rejected []struct { // List of product identifiers that were added to the promotion
// Product identifier ProductIds []float64 `json:"product_ids"`
ProductId float64 `json:"product_id"`
// Reason why the product wasn't added to the promotion // List of products that weren't added to the promotion
Reason string `json:"reason"` Rejected []AddProductToPromotionResultRejected `json:"rejected"`
} `json:"rejected"` }
} `json:"result"`
type AddProductToPromotionResultRejected struct {
// Product identifier
ProductId float64 `json:"product_id"`
// Reason why the product wasn't added to the promotion
Reason string `json:"reason"`
} }
// A method for adding products to an available promotion // A method for adding products to an available promotion
func (c Promotions) AddToPromotion(params *AddProductToPromotionParams) (*AddProductToPromotionResponse, error) { func (c Promotions) AddToPromotion(ctx context.Context, params *AddProductToPromotionParams) (*AddProductToPromotionResponse, error) {
url := "/v1/actions/products/activate" url := "/v1/actions/products/activate"
resp := &AddProductToPromotionResponse{} resp := &AddProductToPromotionResponse{}
response, err := c.client.Request(http.MethodGet, url, params, resp) response, err := c.client.Request(ctx, http.MethodGet, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -154,13 +161,15 @@ type ProductsAvailableForPromotionResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result ProductsAvailableForPromotionResult `json:"result"`
// Products list }
Products []PromotionProduct `json:"products"`
// Total number of products that can participate in the promotion type ProductsAvailableForPromotionResult struct {
Total float64 `json:"total"` // Products list
} `json:"result"` Products []PromotionProduct `json:"products"`
// Total number of products that can participate in the promotion
Total float64 `json:"total"`
} }
type PromotionProduct struct { type PromotionProduct struct {
@@ -174,7 +183,7 @@ type PromotionProduct struct {
ActionPrice float64 `json:"action_price"` ActionPrice float64 `json:"action_price"`
// Maximum possible promotional product price // Maximum possible promotional product price
MaxActionType float64 `json:"max_action_type"` MaxActionPrice float64 `json:"max_action_price"`
// Type of adding a product to the promotion: automatically or manually by the seller // Type of adding a product to the promotion: automatically or manually by the seller
AddMode string `json:"add_mode"` AddMode string `json:"add_mode"`
@@ -187,12 +196,12 @@ type PromotionProduct struct {
} }
// A method for getting a list of products that can participate in the promotion by the promotion identifier // 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) { func (c Promotions) ProductsAvailableForPromotion(ctx context.Context, params *ProductsAvailableForPromotionParams) (*ProductsAvailableForPromotionResponse, error) {
url := "/v1/actions/candidates" url := "/v1/actions/candidates"
resp := &ProductsAvailableForPromotionResponse{} resp := &ProductsAvailableForPromotionResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -216,22 +225,24 @@ type ProductsInPromotionResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result ProductsInPromotionResult `json:"result"`
// Products list }
Products []PromotionProduct `json:"products"`
// Total number of products that can participate in the promotion type ProductsInPromotionResult struct {
Total float64 `json:"total"` // Products list
} `json:"reuslt"` Products []PromotionProduct `json:"products"`
// Total number of products that can participate in the promotion
Total float64 `json:"total"`
} }
// A method for getting the list of products participating in the promotion by its identifier // A method for getting the list of products participating in the promotion by its identifier
func (c Promotions) ProductsInPromotion(params *ProductsInPromotionParams) (*ProductsInPromotionResponse, error) { func (c Promotions) ProductsInPromotion(ctx context.Context, params *ProductsInPromotionParams) (*ProductsInPromotionResponse, error) {
url := "/v1/actions/products" url := "/v1/actions/products"
resp := &ProductsInPromotionResponse{} resp := &ProductsInPromotionResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -252,28 +263,32 @@ type RemoveProductFromPromotionResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result RemoveProductFromPromotionResult `json:"result"`
// 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 type RemoveProductFromPromotionResult struct {
Rejected []struct { // List of product identifiers that were removed from the promotion
// Product identifier ProductIds []float64 `json:"product_ids"`
ProductId float64 `json:"product_id"`
// Reason why the product wasn't removed from the promotion // List of product identifiers that weren't removed from the promotion
Reason string `json:"reason"` Rejected []RemoveProductFromPromotionResultRejected `json:"rejected"`
} `json:"rejected"` }
} `json:"result"`
type RemoveProductFromPromotionResultRejected struct {
// Product identifier
ProductId float64 `json:"product_id"`
// Reason why the product wasn't removed from the promotion
Reason string `json:"reason"`
} }
// A method for removing products from the promotion // A method for removing products from the promotion
func (c Promotions) RemoveProduct(params *RemoveProductFromPromotionParams) (*RemoveProductFromPromotionResponse, error) { func (c Promotions) RemoveProduct(ctx context.Context, params *RemoveProductFromPromotionParams) (*RemoveProductFromPromotionResponse, error) {
url := "/v1/actions/products/deactivate" url := "/v1/actions/products/deactivate"
resp := &RemoveProductFromPromotionResponse{} resp := &RemoveProductFromPromotionResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -286,42 +301,44 @@ type ListHotSalePromotionsResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result []struct { Result []ListHotSalePromotionsResult `json:"result"`
// Promotion end date }
DateEnd string `json:"date_end"`
// Promotion start date type ListHotSalePromotionsResult struct {
DateStart string `json:"date_start"` // Promotion end date
DateEnd string `json:"date_end"`
// Promotion description // Promotion start date
Description string `json:"description"` DateStart string `json:"date_start"`
// Promotion freeze date. // Promotion description
// Description string `json:"description"`
// 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 // Promotion freeze date.
HotsaleId float64 `json:"hotsale_id"` //
// 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"`
// Indication that you participate in this promotion // Hot Sale promotion identifier
IsParticipating bool `json:"is_participating"` HotsaleId float64 `json:"hotsale_id"`
// Promotion name // Indication that you participate in this promotion
Title string `json:"title"` IsParticipating bool `json:"is_participating"`
} `json:"result"`
// Promotion name
Title string `json:"title"`
} }
// List of available Hot Sale promotions // List of available Hot Sale promotions
func (c Promotions) ListHotSalePromotions() (*ListHotSalePromotionsResponse, error) { func (c Promotions) ListHotSalePromotions(ctx context.Context) (*ListHotSalePromotionsResponse, error) {
url := "/v1/actions/hotsales/list" url := "/v1/actions/hotsales/list"
resp := &ListHotSalePromotionsResponse{} resp := &ListHotSalePromotionsResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp) response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -345,43 +362,47 @@ type ProductsAvailableForHotSalePromotionResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result ProductsAvailableForHotSalePromotionResult `json:"result"`
// 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 type ProductsAvailableForHotSalePromotionResult struct {
DateDayPromo string `json:"date_day_promo"` // Products list
Products []ProductsAvailableForHotSalePromotionResultProduct `json:"products"`
// Product identifier // Total number of products that are available for the promotion
Id float64 `json:"id"` Total float64 `json:"total"`
}
// Indication that product participates in the promotion type ProductsAvailableForHotSalePromotionResultProduct struct {
IsActive bool `json:"is_active"` // Promotional product price
ActionPrice float64 `json:"action_price"`
// Maximum possible promotional price of the product // Date when the product participates in the promotion in the YYYY-MM-DD format
MaxActionPrice float64 `json:"max_action_type"` DateDayPromo string `json:"date_day_promo"`
// Minimum number of product units in a stock discount type promotion // Product identifier
MinStock float64 `json:"min_stock"` Id float64 `json:"id"`
// Number of product units in a stock discount type promotion // Indication that product participates in the promotion
Stock float64 `json:"stock"` IsActive bool `json:"is_active"`
} `json:"products"`
// Total number of products that are available for the promotion // Maximum possible promotional price of the product
Total float64 `json:"total"` MaxActionPrice float64 `json:"max_action_price"`
} `json:"result"`
// 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"`
} }
// Method for getting a list of products that can participate or are already participating in the Hot Sale promotion // 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) { func (c Promotions) ProductsAvailableForHotSalePromotion(ctx context.Context, params *ProductsAvailableForHotSalePromotionParams) (*ProductsAvailableForHotSalePromotionResponse, error) {
url := "/v1/actions/hotsales/products" url := "/v1/actions/hotsales/products"
resp := &ProductsAvailableForHotSalePromotionResponse{} resp := &ProductsAvailableForHotSalePromotionResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -413,24 +434,28 @@ type ProductsToHotSaleResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result ProductsToHotSaleResult `json:"result"`
// 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) { type ProductsToHotSaleResult struct {
// List of products that haven't been added to the promotion
Rejected []ProductsToHotSaleResultRejected `json:"rejected"`
}
type ProductsToHotSaleResultRejected struct {
//Product identifier
ProductId float64 `json:"product_id"`
// Reason why the product hasn't been added to the promotion
Reason string `json:"reason"`
}
func (c Promotions) AddProductsToHotSale(ctx context.Context, params *AddProductsToHotSaleParams) (*ProductsToHotSaleResponse, error) {
url := "/v1/actions/hotsales/activate" url := "/v1/actions/hotsales/activate"
resp := &ProductsToHotSaleResponse{} resp := &ProductsToHotSaleResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -448,12 +473,12 @@ type RemoveProductsToHotSaleParams struct {
} }
// Remove product from the Hot Sale promotion // Remove product from the Hot Sale promotion
func (c Promotions) RemoveProductsToHotSale(params *RemoveProductsToHotSaleParams) (*ProductsToHotSaleResponse, error) { func (c Promotions) RemoveProductsToHotSale(ctx context.Context, params *RemoveProductsToHotSaleParams) (*ProductsToHotSaleResponse, error) {
url := "/v1/actions/hotsales/activate" url := "/v1/actions/hotsales/activate"
resp := &ProductsToHotSaleResponse{} resp := &ProductsToHotSaleResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -464,7 +489,7 @@ func (c Promotions) RemoveProductsToHotSale(params *RemoveProductsToHotSaleParam
type ListDiscountRequestsParams struct { type ListDiscountRequestsParams struct {
// Discount request status // Discount request status
Status string `json:"status" default:"UNKNOWN"` Status ListDiscountRequestsStatus `json:"status" default:"UNKNOWN"`
// Page number from which you want to download the list of discount requests // Page number from which you want to download the list of discount requests
Page uint64 `json:"page"` Page uint64 `json:"page"`
@@ -477,121 +502,123 @@ type ListDiscountRequestsResponse struct {
core.CommonResponse core.CommonResponse
// List of requests // List of requests
Result []struct { Result []ListDiscountRequestsResult `json:"result"`
// Request ID }
Id uint64 `json:"id"`
// Request created date type ListDiscountRequestsResult struct {
CreatedAt time.Time `json:"created_at"` // Request ID
Id uint64 `json:"id"`
// End time of the request // Request created date
EndAt time.Time `json:"end_at"` CreatedAt time.Time `json:"created_at"`
// Time to change the decision // End time of the request
EditedTill time.Time `json:"edited_till"` EndAt time.Time `json:"end_at"`
// Request status // Time to change the decision
Status string `json:"status"` EditedTill time.Time `json:"edited_till"`
// Customer's name // Request status
CustomerName string `json:"customer_name"` Status string `json:"status"`
// Product identifier in the Ozon system, SKU // Customer's name
SKU uint64 `json:"sku"` CustomerName string `json:"customer_name"`
// Customer's comment on the request // Product identifier in the Ozon system, SKU
UserComment string `json:"user_comment"` SKU uint64 `json:"sku"`
// Seller's comment on the request // Customer's comment on the request
SellerComment string `json:"seller_comment"` UserComment string `json:"user_comment"`
// Requested price // Seller's comment on the request
RequestedPrice float64 `json:"requested_price"` SellerComment string `json:"seller_comment"`
// Approved price // Requested price
ApprovedPrice float64 `json:"approved_price"` RequestedPrice float64 `json:"requested_price"`
// Product price before all discounts // Approved price
OriginalPrice float64 `json:"original_price"` ApprovedPrice float64 `json:"approved_price"`
// Discount in rubles // Product price before all discounts
Discount float64 `json:"discount"` OriginalPrice float64 `json:"original_price"`
// Discount percentage // Discount in rubles
DiscountPercent float64 `json:"discount_percent"` Discount float64 `json:"discount"`
// Base price at which a product is selling on Ozon, if not eligible for a promotion // Discount percentage
BasePrice float64 `json:"base_price"` DiscountPercent float64 `json:"discount_percent"`
// The minimum price after auto-application of discounts and promotions // Base price at which a product is selling on Ozon, if not eligible for a promotion
MinAutoPrice float64 `json:"min_auto_price"` BasePrice float64 `json:"base_price"`
// ID of the previous customer request for this product // The minimum price after auto-application of discounts and promotions
PrevTaskId uint64 `json:"prev_task_id"` MinAutoPrice float64 `json:"min_auto_price"`
// If product is damaged — true // ID of the previous customer request for this product
IsDamaged bool `json:"is_damaged"` PrevTaskId uint64 `json:"prev_task_id"`
// Moderation date: review, approval or decline of the request // If product is damaged — true
ModeratedAt time.Time `json:"moderated_at"` IsDamaged bool `json:"is_damaged"`
// Discount in rubles approved by the seller. Pass the value 0 if the seller did not approve the request // Moderation date: review, approval or decline of the request
ApprovedDiscount float64 `json:"approved_discount"` ModeratedAt time.Time `json:"moderated_at"`
// Discount percentage approved by the seller. Pass the value 0 if the seller did not approve the request // Discount in rubles approved by the seller. Pass the value 0 if the seller did not approve the request
ApprovedDiscountPercent float64 `json:"approved_discount_percent"` ApprovedDiscount float64 `json:"approved_discount"`
// Whether the customer has purchased the product. true if purchased // Discount percentage approved by the seller. Pass the value 0 if the seller did not approve the request
IsPurchased bool `json:"is_purchased"` ApprovedDiscountPercent float64 `json:"approved_discount_percent"`
// Whether the request was moderated automatically. true if moderation was automatic // Whether the customer has purchased the product. true if purchased
IsAutoModerated bool `json:"is_auto_moderated"` IsPurchased bool `json:"is_purchased"`
// Product identifier in the seller's system // Whether the request was moderated automatically. true if moderation was automatic
OfferId string `json:"offer_id"` IsAutoModerated bool `json:"is_auto_moderated"`
// Email of the user who processed the request // Product identifier in the seller's system
Email string `json:"email"` OfferId string `json:"offer_id"`
// Last name of the user who processed the request // Email of the user who processed the request
LastName string `json:"last_name"` Email string `json:"email"`
// First name of the user who processed the request // Last name of the user who processed the request
FirstName string `json:"first_name"` LastName string `json:"last_name"`
// Patronymic of the user who processed the request // First name of the user who processed the request
Patronymic string `json:"patronymic"` FirstName string `json:"first_name"`
// Approved minimum quantity of products // Patronymic of the user who processed the request
ApprovedQuantityMin uint64 `json:"approved_quantity_min"` Patronymic string `json:"patronymic"`
// Approved maximum quantity of products // Approved minimum quantity of products
ApprovedQuantityMax uint64 `json:"approved_quantity_max"` ApprovedQuantityMin uint64 `json:"approved_quantity_min"`
// Requested minimum number of products // Approved maximum quantity of products
RequestedQuantityMin uint64 `json:"requested_quantity_min"` ApprovedQuantityMax uint64 `json:"approved_quantity_max"`
// Requested maximum number of products // Requested minimum number of products
RequestedQuantityMax uint64 `json:"requested_quantity_max"` RequestedQuantityMin uint64 `json:"requested_quantity_min"`
// Requested price with fee // Requested maximum number of products
RequestedPriceWithFee float64 `json:"requested_price_with_fee"` RequestedQuantityMax uint64 `json:"requested_quantity_max"`
// Approved price with fee // Requested price with fee
ApprovedPriceWithFee float64 `json:"approved_price_with_fee"` RequestedPriceWithFee float64 `json:"requested_price_with_fee"`
// Approved price fee percent // Approved price with fee
ApprovedPriceFeePercent float64 `json:"approved_price_fee_percent"` ApprovedPriceWithFee float64 `json:"approved_price_with_fee"`
} `json:"result"`
// Approved price fee percent
ApprovedPriceFeePercent float64 `json:"approved_price_fee_percent"`
} }
// Method for getting a list of products that customers want to buy with discount // Method for getting a list of products that customers want to buy with discount
func (c Promotions) ListDiscountRequests(params *ListDiscountRequestsParams) (*ListDiscountRequestsResponse, error) { func (c Promotions) ListDiscountRequests(ctx context.Context, params *ListDiscountRequestsParams) (*ListDiscountRequestsResponse, error) {
url := "/v1/actions/discounts-task/list" url := "/v1/actions/discounts-task/list"
resp := &ListDiscountRequestsResponse{} resp := &ListDiscountRequestsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -626,33 +653,37 @@ type DiscountRequestResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result DiscountRequestResult `json:"result"`
// Errors when creating a request }
FailDetails []struct {
// Request ID
TaskId uint64 `json:"task_id"`
// Error message type DiscountRequestResult struct {
ErrorForUser string `json:"error_for_user"` // Errors when creating a request
} `json:"fail_details"` FailDetails []DiscountRequestResultFailDetail `json:"fail_details"`
// The number of requests with a successful status change // The number of requests with a successful status change
SuccessCount int32 `json:"success_count"` SuccessCount int32 `json:"success_count"`
// The number of requests that failed to change their status // The number of requests that failed to change their status
FailCount int32 `json:"fail_count"` FailCount int32 `json:"fail_count"`
} `json:"result"` }
type DiscountRequestResultFailDetail struct {
// Request ID
TaskId uint64 `json:"task_id"`
// Error message
ErrorForUser string `json:"error_for_user"`
} }
// You can approve applications in statuses: // You can approve applications in statuses:
// - NEW — new // - NEW — new
// - SEEN — viewed // - SEEN — viewed
func (c Promotions) ApproveDiscountRequest(params *DiscountRequestParams) (*DiscountRequestResponse, error) { func (c Promotions) ApproveDiscountRequest(ctx context.Context, params *DiscountRequestParams) (*DiscountRequestResponse, error) {
url := "/v1/actions/discounts-task/approve" url := "/v1/actions/discounts-task/approve"
resp := &DiscountRequestResponse{} resp := &DiscountRequestResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -664,12 +695,12 @@ func (c Promotions) ApproveDiscountRequest(params *DiscountRequestParams) (*Disc
// You can decline applications in statuses: // You can decline applications in statuses:
// - NEW—new // - NEW—new
// - SEEN—viewed // - SEEN—viewed
func (c Promotions) DeclineDiscountRequest(params *DiscountRequestParams) (*DiscountRequestResponse, error) { func (c Promotions) DeclineDiscountRequest(ctx context.Context, params *DiscountRequestParams) (*DiscountRequestResponse, error) {
url := "/v1/actions/discounts-task/decline" url := "/v1/actions/discounts-task/decline"
resp := &DiscountRequestResponse{} resp := &DiscountRequestResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -56,11 +57,15 @@ func TestGetAvailablePromotions(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().GetAvailablePromotions() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().GetAvailablePromotions(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetAvailablePromotionsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -125,11 +130,15 @@ func TestAddToPromotion(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().AddToPromotion(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().AddToPromotion(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &AddProductToPromotionResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -201,11 +210,15 @@ func TestProductsAvailableForPromotion(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().ProductsAvailableForPromotion(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().ProductsAvailableForPromotion(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ProductsAvailableForPromotionResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -262,11 +275,15 @@ func TestProductsInPromotion(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().ProductsInPromotion(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().ProductsInPromotion(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ProductsInPromotionResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -314,11 +331,15 @@ func TestRemoveProduct(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().RemoveProduct(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().RemoveProduct(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &RemoveProductFromPromotionResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -373,11 +394,15 @@ func TestListHotSalePromotions(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().ListHotSalePromotions() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().ListHotSalePromotions(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListHotSalePromotionsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -434,11 +459,15 @@ func TestProductsAvailableForHotSalePromotion(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().ProductsAvailableForHotSalePromotion(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().ProductsAvailableForHotSalePromotion(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ProductsAvailableForHotSalePromotionResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -494,11 +523,15 @@ func TestAddProductsToHotSale(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().AddProductsToHotSale(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().AddProductsToHotSale(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ProductsToHotSaleResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -548,11 +581,15 @@ func TestRemoveProductsToHotSale(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().RemoveProductsToHotSale(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().RemoveProductsToHotSale(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ProductsToHotSaleResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -634,11 +671,15 @@ func TestListDiscountRequests(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().ListDiscountRequests(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().ListDiscountRequests(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &ListDiscountRequestsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -661,9 +702,9 @@ func TestApproveDiscountRequest(t *testing.T) {
&DiscountRequestParams{ &DiscountRequestParams{
Tasks: []DiscountRequestTask{ Tasks: []DiscountRequestTask{
{ {
Id: 123, Id: 123,
ApprovedPrice: 11, ApprovedPrice: 11,
SellerComment: "string", SellerComment: "string",
ApprovedQuantityMin: 1, ApprovedQuantityMin: 1,
ApprovedQuantityMax: 2, ApprovedQuantityMax: 2,
}, },
@@ -697,11 +738,15 @@ func TestApproveDiscountRequest(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().ApproveDiscountRequest(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().ApproveDiscountRequest(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &DiscountRequestResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -724,9 +769,9 @@ func TestDeclineDiscountRequest(t *testing.T) {
&DiscountRequestParams{ &DiscountRequestParams{
Tasks: []DiscountRequestTask{ Tasks: []DiscountRequestTask{
{ {
Id: 123, Id: 123,
ApprovedPrice: 11, ApprovedPrice: 11,
SellerComment: "string", SellerComment: "string",
ApprovedQuantityMin: 1, ApprovedQuantityMin: 1,
ApprovedQuantityMax: 2, ApprovedQuantityMax: 2,
}, },
@@ -760,11 +805,15 @@ func TestDeclineDiscountRequest(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Promotions().DeclineDiscountRequest(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Promotions().DeclineDiscountRequest(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &DiscountRequestResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -15,81 +16,87 @@ type GetCurrentSellerRatingInfoResponse struct {
core.CommonResponse core.CommonResponse
// Rating groups list // Rating groups list
Groups []struct { Groups []GetCurrentSellerRatingInfoGroup `json:"groups"`
// Ratings group name
GroupName string `json:"group_name"`
// Ratings list // An indication that the penalty points balance is exceeded
Items []struct { PenaltyScoreExceeded bool `json:"penalty_score_exceeded"`
// Rating change: the ratio of the previous value to the current one // An indication that you participate in the Premium program
Change struct { Premium bool `json:"premium"`
// How the rating value has changed:
// - DIRECTION_UNKNOWN — unknown.
// - DIRECTION_NONE — has not changed.
// - DIRECTION_RISE — has increased.
// - DIRECTION_FALL — has dropped.
Direction string `json:"direction"`
// What the change means:
// - MEANING_UNKNOWN — unknown.
// - MEANING_NONE — neutral.
// - MEANING_GOOD — the indicator is improving, everything is good.
// - MEANING_BAD — the indicator is dropping, you should do something.
Meaning string `json:"meaning"`
} `json:"change"`
// Current rating value
CurrentValue float64 `json:"current_value"`
// Rating name
Name string `json:"name"`
// Previous rating value
PastValue float64 `json:"past_value"`
// System rating name
Rating string `json:"rating"`
// What should be the rating value to be considered good:
// - UNKNOWN_DIRECTION — unknown.
// - NEUTRAL — doesn't matter.
// - HIGHER_IS_BETTER — the higher the better.
// - LOWER_IS_BETTER — the lower the better.
RatingDirection string `json:"rating_direction"`
// Rating status:
// - UNKNOWN_STATUS — unknown status.
// - OK — everything is OK.
// - WARNING — indicators require attention.
// - CRITICAL — critical rating
Status string `json:"status"`
// Value type:
// - UNKNOWN_VALUE — unknown,
// - INDEX,
// - PERCENT,
// - TIME,
// - RATIO — coefficient,
// - REVIEW_SCORE — score,
// - COUNT
ValueType string `json:"value_type"`
} `json:"items"`
// An indication that the penalty points balance is exceeded
PenaltyScoreExceeded bool `json:"penalty_score_exceeded"`
// An indication that you participate in the Premium program
Premium bool `json:"premium"`
} `json:"groups"`
} }
func (c Rating) GetCurrentSellerRatingInfo() (*GetCurrentSellerRatingInfoResponse, error) { type GetCurrentSellerRatingInfoGroup struct {
// Ratings group name
GroupName string `json:"group_name"`
// Ratings list
Items []GetCurrentSellerRatingInfoGroupItem `json:"items"`
}
type GetCurrentSellerRatingInfoGroupItem struct {
// Rating change: the ratio of the previous value to the current one
Change GetCurrentSellerRatingInfoGroupItemChange `json:"change"`
// Current rating value
CurrentValue float64 `json:"current_value"`
// Rating name
Name string `json:"name"`
// Previous rating value
PastValue float64 `json:"past_value"`
// System rating name
Rating string `json:"rating"`
// What should be the rating value to be considered good:
// - UNKNOWN_DIRECTION — unknown.
// - NEUTRAL — doesn't matter.
// - HIGHER_IS_BETTER — the higher the better.
// - LOWER_IS_BETTER — the lower the better.
RatingDirection string `json:"rating_direction"`
// Rating status:
// - UNKNOWN_STATUS — unknown status.
// - OK — everything is OK.
// - WARNING — indicators require attention.
// - CRITICAL — critical rating
Status string `json:"status"`
// Value type:
// - UNKNOWN_VALUE — unknown,
// - INDEX,
// - PERCENT,
// - TIME,
// - RATIO — coefficient,
// - REVIEW_SCORE — score,
// - COUNT
ValueType string `json:"value_type"`
}
type GetCurrentSellerRatingInfoGroupItemChange struct {
// How the rating value has changed:
// - DIRECTION_UNKNOWN — unknown.
// - DIRECTION_NONE — has not changed.
// - DIRECTION_RISE — has increased.
// - DIRECTION_FALL — has dropped.
Direction string `json:"direction"`
// What the change means:
// - MEANING_UNKNOWN — unknown.
// - MEANING_NONE — neutral.
// - MEANING_GOOD — the indicator is improving, everything is good.
// - MEANING_BAD — the indicator is dropping, you should do something.
Meaning string `json:"meaning"`
}
func (c Rating) GetCurrentSellerRatingInfo(ctx context.Context) (*GetCurrentSellerRatingInfoResponse, error) {
url := "/v1/rating/summary" url := "/v1/rating/summary"
resp := &GetCurrentSellerRatingInfoResponse{} resp := &GetCurrentSellerRatingInfoResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp) response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -116,69 +123,79 @@ type GetSellerRatingInfoPeriodResponse struct {
core.CommonResponse core.CommonResponse
// Information on the Premium program penalty points // Information on the Premium program penalty points
PremiumScores []struct { PremiumScores []GetSellerRatingInfoPeriodPremiumScores `json:"premium_scores"`
// Rating name
Rating string `json:"rating"`
// Information on penalty points
Scores []struct {
// Date when the penalty points were received
Date time.Time `json:"date"`
// Rating value for which the penalty points were received
RatingValue float64 `json:"rating_value"`
// Number of received penalty points
Value int32 `json:"value"`
} `json:"scores"`
} `json:"premium_scores"`
// Information on the seller ratings // Information on the seller ratings
Ratings []struct { Ratings []GetSellerRatingInfoPeriodRating `json:"ratings"`
// Rating threshold, after which sales will be blocked
DangerThreshold float64 `json:"danger_threshold"`
// Rating threshold for participation in the Premium program
PremiumThreshold float64 `json:"premium_threshold"`
// Rating system name
Rating string `json:"rating"`
// Rating values list
Values []struct {
// Rating calculation start date
DateFrom time.Time `json:"date_from"`
// Rating calculation end date
DateTo time.Time `json:"date_to"`
// Rating status
Status struct {
// Indication if the rating threshold for blocking is exceeded
Danger bool `json:"danger"`
// Indication whether the threshold for participation in the Premium program has been reached
Premium bool `json:"premium"`
// Indication of a warning that the threshold for blocking may be exceeded
Warning bool `json:"warning"`
} `json:"status"`
// Rating value
Value float64 `json:"value"`
} `json:"values"`
// Rating threshold, after which a warning about possible blocking appears
WarningThreshold float64 `json:"warning_threshold"`
} `json:"ratings"`
} }
func (c Rating) GetSellerRatingInfoForPeriod(params *GetSellerRatingInfoForPeriodParams) (*GetSellerRatingInfoPeriodResponse, error) { type GetSellerRatingInfoPeriodPremiumScores struct {
// Rating name
Rating string `json:"rating"`
// Information on penalty points
Scores []GetSellerRatingInfoPeriodPremiumScore `json:"scores"`
}
type GetSellerRatingInfoPeriodPremiumScore struct {
// Date when the penalty points were received
Date time.Time `json:"date"`
// Rating value for which the penalty points were received
RatingValue float64 `json:"rating_value"`
// Number of received penalty points
Value int32 `json:"value"`
}
type GetSellerRatingInfoPeriodRating struct {
// Rating threshold, after which sales will be blocked
DangerThreshold float64 `json:"danger_threshold"`
// Rating threshold for participation in the Premium program
PremiumThreshold float64 `json:"premium_threshold"`
// Rating system name
Rating string `json:"rating"`
// Rating values list
Values []GetSellerRatingInfoPeriodRatingValue `json:"values"`
// Rating threshold, after which a warning about possible blocking appears
WarningThreshold float64 `json:"warning_threshold"`
}
type GetSellerRatingInfoPeriodRatingValue struct {
// Rating calculation start date
DateFrom time.Time `json:"date_from"`
// Rating calculation end date
DateTo time.Time `json:"date_to"`
// Rating status
Status GetSellerRatingInfoPeriodRatingValueStatus `json:"status"`
// Rating value
Value float64 `json:"value"`
}
type GetSellerRatingInfoPeriodRatingValueStatus struct {
// Indication if the rating threshold for blocking is exceeded
Danger bool `json:"danger"`
// Indication whether the threshold for participation in the Premium program has been reached
Premium bool `json:"premium"`
// Indication of a warning that the threshold for blocking may be exceeded
Warning bool `json:"warning"`
}
func (c Rating) GetSellerRatingInfoForPeriod(ctx context.Context, params *GetSellerRatingInfoForPeriodParams) (*GetSellerRatingInfoPeriodResponse, error) {
url := "/v1/rating/history" url := "/v1/rating/history"
resp := &GetSellerRatingInfoPeriodResponse{} resp := &GetSellerRatingInfoPeriodResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -58,11 +59,15 @@ func TestGetCurrentRatingInfo(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Rating().GetCurrentSellerRatingInfo() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Rating().GetCurrentSellerRatingInfo(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetCurrentSellerRatingInfoResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -146,11 +151,15 @@ func TestGetRatingInfoForPeriod(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Rating().GetSellerRatingInfoForPeriod(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Rating().GetSellerRatingInfoForPeriod(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetSellerRatingInfoPeriodResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -38,54 +39,60 @@ type GetReportsListResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result GetReportsListResult `json:"result"`
// Array with generated reports }
Reports []struct {
// Unique report identifier
Code string `json:"code"`
// Report creation date type GetReportsListResult struct {
CreatedAt time.Time `json:"created_at"` // Array with generated reports
Reports []GetReportsListResultReport `json:"reports"`
// Error code when generating the report // Total number of reports
Error string `json:"error"` Total int32 `json:"total"`
}
// Link to CSV file type GetReportsListResultReport struct {
File string `json:"file"` // Unique report identifier
Code string `json:"code"`
// Array with the filters specified when the seller created the report // Report creation date
Params struct { CreatedAt time.Time `json:"created_at"`
} `json:"params"`
// Report type: // Error code when generating the report
// - SELLER_PRODUCTS — products report, Error string `json:"error"`
// - SELLER_TRANSACTIONS — transactions report,
// - SELLER_PRODUCT_PRICES — product prices report,
// - SELLER_STOCK — stocks report,
// - SELLER_PRODUCT_MOVEMENT — products movement report,
// - SELLER_RETURNS — returns report,
// - SELLER_POSTINGS — shipments report,
// - SELLER_FINANCE — financial report
ReportType string `json:"report_type"`
// Report generation status // Link to CSV file
// - `success` //
// - `failed` // For a report with the SELLER_RETURNS type,
Status string `json:"status"` // the link is available within 5 minutes after making a request.
} `json:"reports"` File string `json:"file"`
// Total number of reports // Array with the filters specified when the seller created the report
Total int32 `json:"total"` Params map[string]string `json:"params"`
} `json:"result"`
// Report type:
// - SELLER_PRODUCTS — products report,
// - SELLER_TRANSACTIONS — transactions report,
// - SELLER_PRODUCT_PRICES — product prices report,
// - SELLER_STOCK — stocks report,
// - SELLER_PRODUCT_MOVEMENT — products movement report,
// - SELLER_RETURNS — returns report,
// - SELLER_POSTINGS — shipments report,
// - SELLER_FINANCE — financial report
ReportType string `json:"report_type"`
// Report generation status
// - `success`
// - `failed`
Status string `json:"status"`
} }
// Returns the list of reports that have been generated before // Returns the list of reports that have been generated before
func (c Reports) GetList(params *GetReportsListParams) (*GetReportsListResponse, error) { func (c Reports) GetList(ctx context.Context, params *GetReportsListParams) (*GetReportsListResponse, error) {
url := "/v1/report/list" url := "/v1/report/list"
resp := &GetReportsListResponse{} resp := &GetReportsListResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -103,47 +110,39 @@ type GetReportDetailsResponse struct {
core.CommonResponse core.CommonResponse
// Report details // Report details
Result struct { Result GetReportDetailResult `json:"result"`
// Unique report identifier }
Code string `json:"code"`
// Report creation date type GetReportDetailResult struct {
CreatedAt time.Time `json:"created_at"` // Unique report identifier
Code string `json:"code"`
// Error code when generating the report // Report creation date
Error string `json:"error"` CreatedAt time.Time `json:"created_at"`
// Link to CSV file // Error code when generating the report
File string `json:"file"` Error string `json:"error"`
// Array with the filters specified when the seller created the report // Link to CSV file
Params map[string]string `json:"params"` File string `json:"file"`
// Report type: // Array with the filters specified when the seller created the report
// - SELLER_PRODUCTS — products report, Params map[string]string `json:"params"`
// - SELLER_TRANSACTIONS — transactions report,
// - SELLER_PRODUCT_PRICES — product prices report,
// - SELLER_STOCK — stocks report,
// - SELLER_PRODUCT_MOVEMENT — products movement report,
// - SELLER_RETURNS — returns report,
// - SELLER_POSTINGS — shipments report,
// - SELLER_FINANCE — financial report
ReportType string `json:"report_type"`
// Report generation status: // Report type
// - success ReportType ReportType `json:"report_type"`
// - failed
Status string `json:"status"` // Report generation status
} `json:"result"` Status ReportInfoStatus `json:"status"`
} }
// Returns information about a created report by its identifier // Returns information about a created report by its identifier
func (c Reports) GetReportDetails(params *GetReportDetailsParams) (*GetReportDetailsResponse, error) { func (c Reports) GetReportDetails(ctx context.Context, params *GetReportDetailsParams) (*GetReportDetailsResponse, error) {
url := "/v1/report/info" url := "/v1/report/info"
resp := &GetReportDetailsResponse{} resp := &GetReportDetailsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -159,6 +158,9 @@ type GetFinancialReportParams struct {
// Number of the page returned in the request // Number of the page returned in the request
Page int64 `json:"page"` Page int64 `json:"page"`
// true, если нужно добавить дополнительные параметры в ответ
WithDetails bool `json:"with_details"`
// Number of items on the page // Number of items on the page
PageSize int64 `json:"page_size"` PageSize int64 `json:"page_size"`
} }
@@ -175,52 +177,221 @@ type GetFinancialReportResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result GetFinancialResultResult `json:"result"`
// Reports list }
CashFlows []struct {
// Period data
Period struct {
// Period identifier
Id int64 `json:"id"`
// Period start type GetFinancialResultResult struct {
Begin time.Time `json:"begin"` // Reports list
CashFlows []GetFinancialResultResultCashflow `json:"cash_flows"`
// Period end // Detailed info
End time.Time `json:"end"` Details GetFinancialResultResultDetail `json:"details"`
} `json:"period"`
// Sum of sold products prices // Number of pages with reports
OrdersAmount float64 `json:"order_amount"` PageCount int64 `json:"page_count"`
}
// Sum of returned products prices type GetFinancialResultResultCashflow struct {
ReturnsAmount float64 `json:"returns_amount"` // Period data
Period GetFinancialResultResultCashflowPeriod `json:"period"`
// Ozon sales commission // Sum of sold products prices
CommissionAmount float64 `json:"commission_amount"` OrdersAmount float64 `json:"orders_amount"`
// Additional services cost // Sum of returned products prices
ServicesAmount float64 `json:"services_amount"` ReturnsAmount float64 `json:"returns_amount"`
// Logistic services cost // Ozon sales commission
ItemDeliveryAndReturnAmount float64 `json:"item_delivery_and_return_amount"` CommissionAmount float64 `json:"commission_amount"`
// Code of the currency used to calculate the commissions // Additional services cost
CurrencyCode string `json:"currency_code"` ServicesAmount float64 `json:"services_amount"`
} `json:"cash_flows"`
// Number of pages with reports // Logistic services cost
PageCount int64 `json:"page_count"` ItemDeliveryAndReturnAmount float64 `json:"item_delivery_and_return_amount"`
} `json:"result"`
// Code of the currency used to calculate the commissions
CurrencyCode string `json:"currency_code"`
}
type GetFinancialResultResultCashflowPeriod struct {
// Period identifier
Id int64 `json:"id"`
// Period start
Begin time.Time `json:"begin"`
// Period end
End time.Time `json:"end"`
}
type GetFinancialResultResultDetail struct {
// Balance on the beginning of period
BeginBalanceAmount float64 `json:"begin_balance_amount"`
// Orders
Delivery GetFinancialResultResultDetailDelivery `json:"delivery"`
// Amount to be paid for the period
InvoiceTransfer float64 `json:"invoice_transfer"`
// Transfer under loan agreements
Loan float64 `json:"loan"`
// Paid for the period
Payments []GetFinancialResultResultDetailPayment `json:"payments"`
// Period data
Period GetFinancialResultResultDetailPeriod `json:"period"`
// Returns and cancellations
Return GetFinancialResultResultDetailReturn `json:"return"`
// rFBS transfers
RFBS GetFinancialResultResultDetailRFBS `json:"rfbs"`
// Services
Services GetFinancialResultResultDetailService `json:"services"`
// Compensation and other accruals
Others GetFinancialResultResultDetailOthers `json:"others"`
// Balance at the end of the period
EndBalanceAmount float64 `json:"end_balance_amount"`
}
type GetFinancialResultResultDetailDelivery struct {
// Total amount
Total float64 `json:"total"`
// Amount for which products were purchased, including commission fees
Amount float64 `json:"amount"`
// Processing and delivery fees
DeliveryServices GetFinancialResultResultDetailDeliveryServices `json:"delivery_services"`
}
type GetFinancialResultResultDetailDeliveryServices struct {
// Total amount
Total float64 `json:"total"`
// Details
Items []GetFinancialResultResultDetailDeliveryServicesItem `json:"items"`
}
type GetFinancialResultResultDetailDeliveryServicesItem struct {
// Operation name
Name DetailsDeliveryItemName `json:"name"`
// Amount by operation
Price float64 `json:"price"`
}
type GetFinancialResultResultDetailPayment struct {
// Currency
CurrencyCode string `json:"currency_code"`
// Payment amount
Payment float64 `json:"payment"`
}
type GetFinancialResultResultDetailPeriod struct {
// Period start
Begin time.Time `json:"begin"`
// Period end
End time.Time `json:"end"`
// Period identifier
Id int64 `json:"id"`
}
type GetFinancialResultResultDetailReturn struct {
// Total amount
Total float64 `json:"total"`
// Amount of returns received, including commission fees
Amount float64 `json:"amount"`
// Returns and cancellation fees
ReturnServices GetFinancialResultResultDetailReturnServices `json:"return_services"`
}
type GetFinancialResultResultDetailReturnServices struct {
// Total amount
Total float64 `json:"total"`
// Details
Items []GetFinancialResultResultDetailReturnServicesItem `json:"items"`
}
type GetFinancialResultResultDetailReturnServicesItem struct {
// Operation name
Name DetailsReturnServiceName `json:"name"`
// Amount by operation
Price float64 `json:"price"`
}
type GetFinancialResultResultDetailRFBS struct {
// Total amount
Total float64 `json:"total"`
// Transfers from customers
TransferDelivery float64 `json:"transfer_delivery"`
// Return of transfers to customers
TransferDeliveryReturn float64 `json:"transfer_delivery_return"`
// Compensation of delivery fees
CompensationDeliveryReturn float64 `json:"compensation_delivery_return"`
// Transfers of partial refunds to customers
PartialCompensation float64 `json:"partial_compensation"`
// Compensation of partial refunds
PartialCompensationReturn float64 `json:"partial_compensation_return"`
}
type GetFinancialResultResultDetailService struct {
// Total amount
Total float64 `json:"total"`
// Details
Items []GetFinancialResultResultDetailServiceItem `json:"items"`
}
type GetFinancialResultResultDetailServiceItem struct {
// Operation name
Name DetailsServiceItemName `json:"name"`
// Amount by operation
Price float64 `json:"price"`
}
type GetFinancialResultResultDetailOthers struct {
// Total amount
Total float64 `json:"total"`
// Details
Items []GetFinancialResultResultDetailOthersItem `json:"items"`
}
type GetFinancialResultResultDetailOthersItem struct {
// Operation name
Name DetailsOtherItemName `json:"name"`
// Amount by operation
Price float64 `json:"price"`
} }
// Returns information about a created report by its identifier // Returns information about a created report by its identifier
func (c Reports) GetFinancial(params *GetFinancialReportParams) (*GetFinancialReportResponse, error) { func (c Reports) GetFinancial(ctx context.Context, params *GetFinancialReportParams) (*GetFinancialReportResponse, error) {
url := "/v1/finance/cash-flow-statement/list" url := "/v1/finance/cash-flow-statement/list"
resp := &GetFinancialReportResponse{} resp := &GetFinancialReportResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -254,95 +425,21 @@ type GetProductsReportResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result GetProductsReportResult `json:"result"`
// Unique report identifier }
Code string `json:"code"`
} `json:"result"` type GetProductsReportResult struct {
// Unique report identifier
Code string `json:"code"`
} }
// Method for getting a report with products data. For example, Ozon ID, number of products, prices, status // Method for getting a report with products data. For example, Ozon ID, number of products, prices, status
func (c Reports) GetProducts(params *GetProductsReportParams) (*GetProductsReportResponse, error) { func (c Reports) GetProducts(ctx context.Context, params *GetProductsReportParams) (*GetProductsReportResponse, error) {
url := "/v1/report/products/create" url := "/v1/report/products/create"
resp := &GetProductsReportResponse{} resp := &GetProductsReportResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) 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 GetStocksReportParams struct {
// Default: "DEFAULT"
// Response language:
// - RU — Russian
// - EN — English
Language string `json:"language" default:"DEFAULT"`
}
type GetStocksReportResponse struct {
core.CommonResponse
// Method result
Result struct {
// Unique report identifier
Code string `json:"code"`
} `json:"result"`
}
// Report with information about the number of available and reserved products in stock
func (c Reports) GetStocks(params *GetStocksReportParams) (*GetStocksReportResponse, error) {
url := "/v1/report/stock/create"
resp := &GetStocksReportResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type GetProductsMovementReportParams struct {
// Date from which the data will be in the report
DateFrom time.Time `json:"date_from"`
// Date up to which the data will be in the report
DateTo time.Time `json:"date_to"`
// Default: "DEFAULT"
// Response language:
// - RU — Russian
// - EN — English
Language string `json:"language" default:"DEFAULT"`
}
type GetProductsMovementReportResponse struct {
core.CommonResponse
// Method result
Result struct {
// Unique report identifier
Code string `json:"code"`
} `json:"result"`
}
// Report with complete information on products, as well as the number of products with statuses:
// - products with defects or in inventory,
// - products in transit between the fulfillment centers,
// - products in delivery,
// - products to be sold
func (c Reports) GetProductsMovement(params *GetProductsMovementReportParams) (*GetProductsMovementReportResponse, error) {
url := "/v1/report/products/movement/create"
resp := &GetProductsMovementReportResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -377,21 +474,23 @@ type GetReturnsReportResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result GetReturnReportResult `json:"result"`
// Unique report identifier }
Code string `json:"code"`
} `json:"result"` type GetReturnReportResult struct {
// Unique report identifier. The report is available for downloading within 3 days after making a request.
Code string `json:"code"`
} }
// The report contains information about returned products that were accepted from the customer, ready for pickup, or delivered to the seller. // The report contains information about returned products that were accepted from the customer, ready for pickup, or delivered to the seller.
// //
// The method is only suitable for orders shipped from the seller's warehouse // The method is only suitable for orders shipped from the seller's warehouse
func (c Reports) GetReturns(params *GetReturnsReportParams) (*GetReturnsReportResponse, error) { func (c Reports) GetReturns(ctx context.Context, params *GetReturnsReportParams) (*GetReturnsReportResponse, error) {
url := "/v1/report/returns/create" url := "/v1/report/returns/create"
resp := &GetReturnsReportResponse{} resp := &GetReturnsReportResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -415,9 +514,12 @@ type GetShipmentReportFilter struct {
// Cancellation reason identifier // Cancellation reason identifier
CancelReasonId []int64 `json:"cancel_reason_id"` CancelReasonId []int64 `json:"cancel_reason_id"`
// Work scheme: FBO or FBS. // The scheme of operation is FBO or FBS.
// //
// To get an FBO scheme report, pass fbo in this parameter. For an FBS scheme report pass fbs // Only one of the parameters can be passed to the array per query:
//
// fbo - to get a report by FBO scheme,
// fbs - to get a report by FBS scheme
DeliverySchema []string `json:"delivery_schema"` DeliverySchema []string `json:"delivery_schema"`
// Product identifier // Product identifier
@@ -446,10 +548,12 @@ type GetShipmentReportResponse struct {
core.CommonResponse core.CommonResponse
// Method result // Method result
Result struct { Result GetShipmentReportResult `json:"result"`
// Unique report identifier }
Code string `json:"code"`
} `json:"result"` type GetShipmentReportResult struct {
// Unique report identifier
Code string `json:"code"`
} }
// Shipment report with orders details: // Shipment report with orders details:
@@ -459,12 +563,12 @@ type GetShipmentReportResponse struct {
// - shipment numbers // - shipment numbers
// - shipment costs // - shipment costs
// - shipments contents // - shipments contents
func (c Reports) GetShipment(params *GetShipmentReportParams) (*GetShipmentReportResponse, error) { func (c Reports) GetShipment(ctx context.Context, params *GetShipmentReportParams) (*GetShipmentReportResponse, error) {
url := "/v1/report/postings/create" url := "/v1/report/postings/create"
resp := &GetShipmentReportResponse{} resp := &GetShipmentReportResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -484,12 +588,12 @@ type IssueOnDiscountedProductsResponse struct {
// For example, Ozon can discount a product due to damage when delivering. // For example, Ozon can discount a product due to damage when delivering.
// //
// Returns report identifier. To get the report, send the identifier in the request body of a method `/v1/report/discounted/info` // Returns report identifier. To get the report, send the identifier in the request body of a method `/v1/report/discounted/info`
func (c Reports) IssueOnDiscountedProducts() (*IssueOnDiscountedProductsResponse, error) { func (c Reports) IssueOnDiscountedProducts(ctx context.Context) (*IssueOnDiscountedProductsResponse, error) {
url := "/v1/report/discounted/create" url := "/v1/report/discounted/create"
resp := &IssueOnDiscountedProductsResponse{} resp := &IssueOnDiscountedProductsResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp) response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -498,56 +602,36 @@ func (c Reports) IssueOnDiscountedProducts() (*IssueOnDiscountedProductsResponse
return resp, nil return resp, nil
} }
type ReportOnDiscountedProductsParams struct { type GetFBSStocksParams struct {
// Response language
Language string `json:"language"`
// Warehouses identifiers
WarehouseIds []int64 `json:"warehouse_id"`
}
type GetFBSStocksResponse struct {
core.CommonResponse
// Method result
Result GetFBSStocksResult `json:"result"`
}
type GetFBSStocksResult struct {
// Unique report identifier // Unique report identifier
Code string `json:"code"` Code string `json:"code"`
} }
type ReportOnDiscountedProductsResponse struct { // Report with information about the number of available and reserved products in stock.
core.CommonResponse //
// The method returns a report identifier.
// To get the report, send the identifier in the request of the `/v1/report/info` method.
func (c Reports) GetFBSStocks(ctx context.Context, params *GetFBSStocksParams) (*GetFBSStocksResponse, error) {
url := "/v1/report/warehouse/stock"
// Report information resp := &GetFBSStocksResponse{}
Report struct {
// Report creation date
CreatedAt time.Time `json:"created_at"`
// Link to report file response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, nil)
File string `json:"file"`
// Report status:
// - success — created
// - pending — waiting to be processed
// - processing — processed
// - failed — generation error
Status string `json:"status"`
// Report generation error code
Error string `json:"error"`
} `json:"report"`
}
// By report identifier, returns information about the report generated earlier
func (c Reports) ReportOnDiscountedProducts(params *ReportOnDiscountedProductsParams) (*ReportOnDiscountedProductsResponse, error) {
url := "/v1/report/discounted/info"
resp := &ReportOnDiscountedProductsResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
// By report identifier, returns information about the report generated earlier
func (c Reports) ListReportsOnDiscountedProducts() (*ReportOnDiscountedProductsResponse, error) {
url := "/v1/report/discounted/list"
resp := &ReportOnDiscountedProductsResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -69,11 +70,15 @@ func TestGetList(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Reports().GetList(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Reports().GetList(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetReportsListResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -111,7 +116,7 @@ func TestGetReportDetails(t *testing.T) {
"file": "https://storage.yandexcloud.net/ozon.reports/95/c1/95c1ae93320294cb.csv", "file": "https://storage.yandexcloud.net/ozon.reports/95/c1/95c1ae93320294cb.csv",
"report_type": "seller_products", "report_type": "seller_products",
"params": {}, "params": {},
"created_at": "2021-11-25T14:54:55.688260Z" "created_at": "2021-11-25T14:54:55.68826Z"
} }
}`, }`,
}, },
@@ -130,11 +135,15 @@ func TestGetReportDetails(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Reports().GetReportDetails(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Reports().GetReportDetails(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetReportDetailsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -165,27 +174,96 @@ func TestGetFinancialReport(t *testing.T) {
From: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-01-01T00:00:00.000Z"), From: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-01-01T00:00:00.000Z"),
To: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-12-31T00:00:00.000Z"), To: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2022-12-31T00:00:00.000Z"),
}, },
Page: 1, WithDetails: true,
PageSize: 1, Page: 1,
PageSize: 1,
}, },
`{ `{
"result": { "result": {
"cash_flows": [ "cash_flows": [
{ {
"period": {
"id": 11567022278500,
"begin": "2022-08-01T00:00:00Z",
"end": "2022-08-15T00:00:00Z"
},
"orders_amount": 1000,
"returns_amount": -3000,
"commission_amount": 1437, "commission_amount": 1437,
"services_amount": 8471.28, "currency_code": "string",
"item_delivery_and_return_amount": 1991, "item_delivery_and_return_amount": 1991,
"currency_code": "RUB" "orders_amount": 1000,
"period": {
"begin": "2023-04-03T09:12:10.239Z",
"end": "2023-04-03T09:12:10.239Z",
"id": 11567022278500
},
"returns_amount": -3000,
"services_amount": 8471.28
} }
], ],
"page_count": 15 "details": {
"period": {
"begin": "2023-04-03T09:12:10.239Z",
"end": "2023-04-03T09:12:10.239Z",
"id": 11567022278500
},
"payments": [
{
"payment": 0,
"currency_code": "string"
}
],
"begin_balance_amount": 0,
"delivery": {
"total": 0,
"amount": 0,
"delivery_services": {
"total": 0,
"items": [
{
"name": "string",
"price": 0
}
]
}
},
"return": {
"total": 0,
"amount": 0,
"return_services": {
"total": 0,
"items": [
{
"name": "string",
"price": 0
}
]
}
},
"loan": 0,
"invoice_transfer": 0,
"rfbs": {
"total": 0,
"transfer_delivery": 0,
"transfer_delivery_return": 0,
"compensation_delivery_return": 0,
"partial_compensation": 0,
"partial_compensation_return": 0
},
"services": {
"total": 0,
"items": [
{
"name": "string",
"price": 0
}
]
},
"others": {
"total": 0,
"items": [
{
"name": "string",
"price": 0
}
]
},
"end_balance_amount": 0
}
} }
}`, }`,
}, },
@@ -204,11 +282,15 @@ func TestGetFinancialReport(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Reports().GetFinancial(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Reports().GetFinancial(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetFinancialReportResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -258,117 +340,14 @@ func TestGetProductsReport(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Reports().GetProducts(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Reports().GetProducts(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
if resp.StatusCode != test.statusCode { compareJsonResponse(t, test.response, &GetProductsReportResponse{})
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
if resp.StatusCode == http.StatusOK {
if resp.Result.Code == "" {
t.Errorf("Code cannot be empty")
}
}
}
}
func TestGetStocksReport(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetStocksReportParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetStocksReportParams{},
`{
"result": {
"code": "d55f4517-8347-4e24-9d93-d6e736c1c07c"
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetStocksReportParams{},
`{
"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.Reports().GetStocks(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 resp.Result.Code == "" {
t.Errorf("Code cannot be empty")
}
}
}
}
func TestGetProductsMovementReport(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetProductsMovementReportParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetProductsMovementReportParams{
DateFrom: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2020-08-01T14:15:22Z"),
DateTo: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2020-08-01T14:15:22Z"),
},
`{
"result": {
"code": "h56f4917-1346-4e64-9d90-с6e736c1e07c"
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetProductsMovementReportParams{},
`{
"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.Reports().GetProductsMovement(test.params)
if err != nil {
t.Error(err)
}
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
@@ -421,11 +400,15 @@ func TestGetReturnsReport(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Reports().GetReturns(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Reports().GetReturns(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetReturnsReportResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -479,11 +462,15 @@ func TestGetShipmentReport(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Reports().GetShipment(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Reports().GetShipment(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetShipmentReportResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -526,9 +513,11 @@ func TestIssueOnDiscountedProducts(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Reports().IssueOnDiscountedProducts() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Reports().IssueOnDiscountedProducts(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
@@ -536,6 +525,7 @@ func TestIssueOnDiscountedProducts(t *testing.T) {
} }
if resp.StatusCode == http.StatusOK { if resp.StatusCode == http.StatusOK {
compareJsonResponse(t, test.response, &IssueOnDiscountedProductsResponse{})
if resp.Code == "" { if resp.Code == "" {
t.Errorf("Code cannot be empty") t.Errorf("Code cannot be empty")
} }
@@ -543,28 +533,26 @@ func TestIssueOnDiscountedProducts(t *testing.T) {
} }
} }
func TestReportOnDiscountedProducts(t *testing.T) { func TestGetFBSStocks(t *testing.T) {
t.Parallel() t.Parallel()
tests := []struct { tests := []struct {
statusCode int statusCode int
headers map[string]string headers map[string]string
params *ReportOnDiscountedProductsParams params *GetFBSStocksParams
response string response string
}{ }{
// Test Ok // Test Ok
{ {
http.StatusOK, http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"}, map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ReportOnDiscountedProductsParams{ &GetFBSStocksParams{
Code: "d55f4517-8347-4e24-9d93-d6e736c1c07c", Language: "EN",
WarehouseIds: []int64{123},
}, },
`{ `{
"report": { "result": {
"created_at": "2022-10-04T10:07:08.146Z", "code": "d55f4517-8347-4e24-9d93-d6e736c1c07c"
"error": "string",
"file": "string",
"status": "string"
} }
}`, }`,
}, },
@@ -572,7 +560,7 @@ func TestReportOnDiscountedProducts(t *testing.T) {
{ {
http.StatusUnauthorized, http.StatusUnauthorized,
map[string]string{}, map[string]string{},
&ReportOnDiscountedProductsParams{}, &GetFBSStocksParams{},
`{ `{
"code": 16, "code": 16,
"message": "Client-Id and Api-Key headers are required" "message": "Client-Id and Api-Key headers are required"
@@ -583,59 +571,15 @@ func TestReportOnDiscountedProducts(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Reports().ReportOnDiscountedProducts(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
if err != nil { resp, err := c.Reports().GetFBSStocks(ctx, test.params)
t.Error(err)
}
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestListReportsOnDiscountedProducts(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"},
`{
"reports": [
{
"created_at": "2022-10-04T10:07:08.146Z",
"error": "string",
"file": "string",
"status": "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.Reports().ListReportsOnDiscountedProducts()
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetFBSStocksResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -28,7 +29,8 @@ type GetFBOReturnsFilter struct {
// Shipment number // Shipment number
PostingNumber string `json:"posting_number"` PostingNumber string `json:"posting_number"`
Status []string `json:"status"` // Return status
Status []GetFBOReturnsFilterStatus `json:"status"`
} }
type GetFBOReturnsResponse struct { type GetFBOReturnsResponse struct {
@@ -38,49 +40,51 @@ type GetFBOReturnsResponse struct {
LastId int64 `json:"last_id"` LastId int64 `json:"last_id"`
// Returns information // Returns information
Returns []struct { Returns []GetFBOReturnsReturn `json:"returns"`
// Time when a return was received from the customer }
AcceptedFromCustomerMoment time.Time `json:"accepted_from_customer_moment"`
// Seller identifier type GetFBOReturnsReturn struct {
CompanyId int64 `json:"company_id"` // Time when a return was received from the customer
AcceptedFromCustomerMoment time.Time `json:"accepted_from_customer_moment"`
// Current return location // Seller identifier
CurrentPlaceName string `json:"current_place_name"` CompanyId int64 `json:"company_id"`
// Return destination // Current return location
DestinationPlaceName string `json:"dst_place_name"` CurrentPlaceName string `json:"current_place_name"`
// Return identifier // Return destination
Id int64 `json:"id"` DestinationPlaceName string `json:"dst_place_name"`
// Indication that the package has been opened. true, if it has been // Return identifier
IsOpened bool `json:"is_opened"` Id int64 `json:"id"`
// Shipment number // Indication that the package has been opened. true, if it has been
PostingNumber string `json:"posting_number"` IsOpened bool `json:"is_opened"`
// Return reason // Shipment number
ReturnReasonName string `json:"return_reason_name"` PostingNumber string `json:"posting_number"`
// Return delivery time to the Ozon warehouse // Return reason
ReturnedToOzonMoment time.Time `json:"returned_to_ozon_moment"` ReturnReasonName string `json:"return_reason_name"`
// Product identifier in the Ozon system, SKU // Return delivery time to the Ozon warehouse
SKU int64 `json:"sku"` ReturnedToOzonMoment time.Time `json:"returned_to_ozon_moment"`
// Return status // Product identifier in the Ozon system, SKU
Status string `json:"status_name"` SKU int64 `json:"sku"`
} `json:"returns"`
// Return status
Status GetFBOReturnsReturnStatus `json:"status_name"`
} }
// Method for getting information on returned products that are sold from the Ozon warehouse // Method for getting information on returned products that are sold from the Ozon warehouse
func (c Returns) GetFBOReturns(params *GetFBOReturnsParams) (*GetFBOReturnsResponse, error) { func (c Returns) GetFBOReturns(ctx context.Context, params *GetFBOReturnsParams) (*GetFBOReturnsResponse, error) {
url := "/v3/returns/company/fbo" url := "/v3/returns/company/fbo"
resp := &GetFBOReturnsResponse{} resp := &GetFBOReturnsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -98,9 +102,10 @@ type GetFBSReturnsParams struct {
// - minimum — 1 // - minimum — 1
Limit int64 `json:"limit"` Limit int64 `json:"limit"`
// Number of elements that will be skipped in the response. // Return identifier that was loaded the last time.
// For example, if offset=10, the response will start with the 11th element found // Return identifiers with the higher value than `last_id`
Offset int64 `json:"offset"` // will be returned in the response.
LastId int64 `json:"offset"`
} }
type GetFBSReturnsFilter struct { type GetFBSReturnsFilter struct {
@@ -108,7 +113,7 @@ type GetFBSReturnsFilter struct {
AcceptedFromCustomerMoment GetFBSReturnsFilterTimeRange `json:"accepted_from_customer_moment"` AcceptedFromCustomerMoment GetFBSReturnsFilterTimeRange `json:"accepted_from_customer_moment"`
// Last day of free storage // Last day of free storage
LastFreeWaitingDay []GetFBSReturnsFilterTimeRange `json:"last_free_waiting_dat"` LastFreeWaitingDay GetFBSReturnsFilterTimeRange `json:"last_free_waiting_dat"`
// Order ID // Order ID
OrderId int64 `json:"order_id"` OrderId int64 `json:"order_id"`
@@ -122,13 +127,8 @@ type GetFBSReturnsFilter struct {
// Product ID // Product ID
ProductOfferId string `json:"product_offer_id"` ProductOfferId string `json:"product_offer_id"`
// Return status: // Return status
// - returned_to_seller — returned to seller, Status GetFBSReturnsFilterStatus `json:"status"`
// - waiting_for_seller — waiting for seller,
// - accepted_from_customer — accepted from customer,
// - cancelled_with_compensation — cancelled with compensation,
// - ready_for_shipment — ready for shipment
Status string `json:"status"`
} }
type GetFBSReturnsFilterTimeRange struct { type GetFBSReturnsFilterTimeRange struct {
@@ -150,97 +150,724 @@ type GetFBSReturnsFilterTimeRange struct {
type GetFBSReturnsResponse struct { type GetFBSReturnsResponse struct {
core.CommonResponse core.CommonResponse
Result struct { // Return identifier that was loaded the last time.
// Elements counter in the response // Return identifiers with the higher value than `last_id`
Count int64 `json:"count"` // will be returned in the response
LastId int64 `json:"last_id"`
// Returns information // Returns information
Returns []struct { Returns []GetFBSReturnResultReturn `json:"returns"`
// Time of receiving the return from the customer }
AcceptedFromCustomerAmount string `json:"accepted_from_customer_amount"`
// Bottom barcode on the product label type GetFBSReturnResultReturn struct {
ClearingId int64 `json:"clearing_id"` // Time of receiving the return from the customer
AcceptedFromCustomerMoment string `json:"accepted_from_customer_moment"`
// Commission fee // Bottom barcode on the product label
Commission float64 `json:"commission"` ClearingId int64 `json:"clearing_id"`
// Commission percentage // Commission fee
CommissionPercent float64 `json:"commission_percent"` Commission float64 `json:"commission"`
// Return identifier // Commission percentage
Id int64 `json:"id"` CommissionPercent float64 `json:"commission_percent"`
// If the product is in transit — true // Product item identifier in the Ozon logistics system
IsMoving bool `json:"is_moving"` ExemplarId int64 `json:"exemplar_id"`
// Indication that the package has been opened. true, if it has been // Return identifier in the Ozon accounting system
IsOpened bool `json:"is_opened"` Id int64 `json:"id"`
// Last day of free storage // If the product is in transit — true
LastFreeWaitingDay string `json:"last_free_waiting_day"` IsMoving bool `json:"is_moving"`
// ID of the warehouse the product is being transported to // Indication that the package has been opened. true, if it has been
PlaceId int64 `json:"place_id"` IsOpened bool `json:"is_opened"`
// Name of the warehouse the product is being transported to // Last day of free storage
MovingToPlaceName string `json:"moving_to_place_name"` LastFreeWaitingDay string `json:"last_free_waiting_day"`
// Delivery cost // ID of the warehouse the product is being transported to
PickingAmount float64 `json:"picking_amount"` PlaceId int64 `json:"place_id"`
// Shipment number // Name of the warehouse the product is being transported to
PostingNumber string `json:"posting_number"` MovingToPlaceName string `json:"moving_to_place_name"`
// Current product price without a discount // Delivery cost
Price float64 `json:"price"` PickingAmount float64 `json:"picking_amount"`
// Product price without commission // Shipment number
PriceWithoutCommission float64 `json:"price_without_commission"` PostingNumber string `json:"posting_number"`
// Product identifier PickingTag string `json:"picking_tag"`
ProductId int64 `json:"product_id"`
// Product name // Current product price without a discount
ProductName string `json:"product_name"` Price float64 `json:"price"`
// Product quantity // Product price without commission
Quantity int64 `json:"quantity"` PriceWithoutCommission float64 `json:"price_without_commission"`
// Product return date // Product identifier
ReturnDate string `json:"return_date"` ProductId int64 `json:"product_id"`
// Return reason // Product name
ReturnReasonName string `json:"return_reason_name"` ProductName string `json:"product_name"`
// Date when the product is ready to be handed over to the seller // Product quantity
WaitingForSellerDate string `json:"waiting_for_seller_date_time"` Quantity int64 `json:"quantity"`
// Date of handing over the product to the seller // Barcode on the return label. Use this parameter value to work with the return label
ReturnedToSellerDate string `json:"returned_to_seller_date_time"` ReturnBarcode string `json:"return_barcode"`
// Return storage period in days // Package unit identifier in the Ozon logistics system
WaitingForSellerDays int64 `json:"waiting_for_seller_days"` ReturnClearingId int64 `json:"return_clearing_id"`
// Return storage cost // Product return date
ReturnsKeepingCost float64 `json:"returns_keeping_cost"` ReturnDate string `json:"return_date"`
// Product identifier in the Ozon system, SKU // Return reason
SKU int64 `json:"sku"` ReturnReasonName string `json:"return_reason_name"`
// Return status // Date when the product is ready to be handed over to the seller
Status string `json:"status"` WaitingForSellerDate string `json:"waiting_for_seller_date_time"`
} `json:"returns"`
} `json:"result"` // Date of handing over the product to the seller
ReturnedToSellerDate string `json:"returned_to_seller_date_time"`
// Return storage period in days
WaitingForSellerDays int64 `json:"waiting_for_seller_days"`
// Return storage cost
ReturnsKeepingCost float64 `json:"returns_keeping_cost"`
// Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
// Return status
Status string `json:"status"`
} }
// Method for getting information on returned products that are sold from the seller's warehouse // Method for getting information on returned products that are sold from the seller's warehouse
func (c Returns) GetFBSReturns(params *GetFBSReturnsParams) (*GetFBSReturnsResponse, error) { func (c Returns) GetFBSReturns(ctx context.Context, params *GetFBSReturnsParams) (*GetFBSReturnsResponse, error) {
url := "/v2/returns/company/fbs" url := "/v3/returns/company/fbs"
resp := &GetFBSReturnsResponse{} resp := &GetFBSReturnsResponse{}
response, err := c.client.Request(http.MethodPost, url, params, resp) 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 GetRFBSReturnsParams struct {
// Filter
Filter GetRFBSReturnsFilter `json:"filter"`
// Identifier of the last value on the page.
// Leave this field blank in the first request
LastId int32 `json:"last_id"`
// Number of values per page
Limit int32 `json:"limit"`
}
type GetRFBSReturnsFilter struct {
// Product identifier in the seller's system
OfferId string `json:"offer_id"`
// Shipment number
PostingNumber string `json:"posting_number"`
// Filter by request statuses
GroupState []RFBSReturnsGroupState `json:"group_state"`
// Period of request creation
CreatedAt GetRFBSReturnsFilterCreatedAt `json:"created_at"`
}
type GetRFBSReturnsFilterCreatedAt struct {
// Period start date
From time.Time `json:"from"`
// Period end date
To time.Time `json:"to"`
}
type GetRFBSReturnsResponse struct {
core.CommonResponse
// Information on return requests
Returns GetRFBSReturnsReturn `json:"returns"`
}
type GetRFBSReturnsReturn struct {
// Customer name
ClientName string `json:"client_name"`
// Request creation date
CreatedAt time.Time `json:"created_at"`
// Order number
OrderNumber string `json:"order_number"`
// Shipment number
PostingNumber string `json:"posting_number"`
// Product details
Product GetRFBSReturnsProduct `json:"product"`
// Return request identifier
ReturnId int64 `json:"return_id"`
// Return request number
ReturnNumber string `json:"return_number"`
// Request and refund statuses
State GetRFBSReturnsState `json:"state"`
}
type GetRFBSReturnsProduct struct {
// Product name
Name string `json:"name"`
// Product identifier in the seller's system
OfferId string `json:"offer_id"`
// Currency of your prices. It matches the currency set in your personal account
CurrencyCode GetRFBSReturnsCurrency `json:"currency_code"`
// Product price
Price string `json:"price"`
// Product identifier in the Ozon system, SKU
SKU int64 `json:"sku"`
}
type GetRFBSReturnsState struct {
// Request status by the applied filter
GroupState RFBSReturnsGroupState `json:"group_state"`
// Refund status
MoneyReturnStateName string `json:"money_return_state_name"`
// Request status
State string `json:"state"`
// Request status name in Russian
StateName string `json:"state_name"`
}
// Get a list of return requests
func (c Returns) GetRFBSReturns(ctx context.Context, params *GetRFBSReturnsParams) (*GetRFBSReturnsResponse, error) {
url := "/v2/returns/rfbs/list"
resp := &GetRFBSReturnsResponse{}
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 GetRFBSReturnParams struct {
// Request identifier
ReturnId int64 `json:"return_id"`
}
type GetRFBSReturnResponse struct {
core.CommonResponse
Returns GetRFBSReturn `json:"returns"`
}
type GetRFBSReturn struct {
// List of available actions on the request
AvailableActions []GetRFBSReturnAction `json:"available_actions"`
// Customer name
ClientName string `json:"client_name"`
// Links to product images
ClientPhoto []string `json:"client_photo"`
// Information on return method
ClientReturnMethodType GetRFBSReturnMethodType `json:"client_return_method_type"`
// Customer comment
Comment string `json:"comment"`
// Request creation date
CreatedAt time.Time `json:"created_at"`
// Order number
OrderNumber string `json:"order_number"`
// Shipment number
PostingNumber string `json:"posting_number"`
// Product details
Product GetRFBSReturnsProduct `json:"product"`
// Comment on request rejection
RejectionComment string `json:"rejection_comment"`
// Information on rejection reason
RejectionReason []GetRFBSReturnRejectionReason `json:"rejection_reason"`
// Method of product return
ReturnMethodDescription string `json:"return_method_description"`
// Return request number
ReturnNumber string `json:"return_number"`
// Information on return reason
ReturnReason GetRFBSReturnReason `json:"return_reason"`
// Postal tracking number
RUPostTrackingNumber string `json:"ru_post_tracking_number"`
// Information on return status
State GetRFBSReturnState `json:"state"`
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
}
type GetRFBSReturnAction struct {
// Action identifier
Id int32 `json:"id"`
// Action name
Name string `json:"name"`
}
type GetRFBSReturnMethodType struct {
// Identifier
Id int32 `json:"id"`
// Name
Name string `json:"name"`
}
type GetRFBSReturnRejectionReason struct {
// Hint on further actions with the return
Hint string `json:"hint"`
// Reason identifier
Id int32 `json:"id"`
// `true` if you need to attach a comment
IsCommentRequired bool `json:"is_comment_required"`
// Reason description
Name string `json:"name"`
}
type GetRFBSReturnReason struct {
// Reason identifier
Id int32 `json:"id"`
// `true` if the product is defective
IsDefect bool `json:"is_defect"`
// Reason description
Name string `json:"name"`
}
type GetRFBSReturnState struct {
// Status
State string `json:"state"`
// Status name in Russian
StateName string `json:"state_name"`
}
// Get information about a return request
func (c Returns) GetRFBSReturn(ctx context.Context, params *GetRFBSReturnParams) (*GetRFBSReturnResponse, error) {
url := "/v2/returns/rfbs/get"
resp := &GetRFBSReturnResponse{}
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 RejectRFBSReturnParams struct {
// Return request identifier
ReturnId int64 `json:"return_id"`
// Comment
//
// The comment is required if the
// `rejection_reason.is_comment_required` parameter is `true`
// in the response of the `/v2/returns/rfbs/get` method
Comment string `json:"comment"`
// Rejection reason identifier.
//
// Pass the value from the list of reasons received in the response
// of the `/v2/returns/rfbs/get` method in the `rejection_reason` parameter
RejectionReasonId int64 `json:"rejection_reason_id"`
}
type RejectRFBSReturnResponse struct {
core.CommonResponse
}
// The method rejects an rFBS return request. Explain your decision in the `comment` parameter
func (c Returns) RejectRFBSReturn(ctx context.Context, params *RejectRFBSReturnParams) (*RejectRFBSReturnResponse, error) {
url := "/v2/returns/rfbs/reject"
resp := &RejectRFBSReturnResponse{}
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 CompensateRFBSReturnParams struct {
// Compensation amount
CompensationAmount string `json:"compensation_amount"`
// Return request identifier
ReturnId int64 `json:"return_id"`
}
type CompensateRFBSReturnResponse struct {
core.CommonResponse
}
// Using this method you can confirm the partial compensation and agree to keep the product with the customer
func (c Returns) CompensateRFBSReturn(ctx context.Context, params *CompensateRFBSReturnParams) (*CompensateRFBSReturnResponse, error) {
url := "/v2/returns/rfbs/compensate"
resp := &CompensateRFBSReturnResponse{}
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 ApproveRFBSReturnParams struct {
// Return request identifier
ReturnId int64 `json:"return_id"`
// Method of product return
ReturnMethodDescription string `json:"return_method_description"`
}
type ApproveRFBSReturnResponse struct {
core.CommonResponse
}
// The method allows to approve an rFBS return request and agree to receive products for verification.
//
// Confirm that you've received the product using the `/v2/returns/rfbs/receive-return` method.
func (c Returns) ApproveRFBSReturn(ctx context.Context, params *ApproveRFBSReturnParams) (*ApproveRFBSReturnResponse, error) {
url := "/v2/returns/rfbs/verify"
resp := &ApproveRFBSReturnResponse{}
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 ReceiveRFBSReturnParams struct {
// Return request identifier
ReturnId int64 `json:"return_id"`
}
type ReceiveRFBSReturnResponse struct {
core.CommonResponse
}
// Confirm receipt of a product for check
func (c Returns) ReceiveRFBSReturn(ctx context.Context, params *ReceiveRFBSReturnParams) (*ReceiveRFBSReturnResponse, error) {
url := "/v2/returns/rfbs/receive-return"
resp := &ReceiveRFBSReturnResponse{}
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 RefundRFBSParams struct {
// Return request identifier
ReturnId int64 `json:"return_id"`
// Refund amount for shipping the product
ReturnForBackWay int64 `json:"return_for_back_way"`
}
type RefundRFBSResponse struct {
core.CommonResponse
}
// The method confirms the refund of the full product cost.
// Use the method if you agree to refund the customer:
//
// Immediately without receiving the product.
// After you received and checked the product.
// If the product is defective or damaged, you also refund its return shipment cost.
func (c Returns) RefundRFBS(ctx context.Context, params *RefundRFBSParams) (*RefundRFBSResponse, error) {
url := "/v2/returns/rfbs/return-money"
resp := &RefundRFBSResponse{}
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 IsGiveoutEnabledResponse struct {
core.CommonResponse
// `true` if you can pick up a return shipment by barcode.
Enabled bool `json:"enabled"`
}
// Check the ability to receive return shipments by barcode
//
// The `enabled` parameter is true if you can pick up return shipments by barcode.
func (c Returns) IsGiveoutEnabled(ctx context.Context) (*IsGiveoutEnabledResponse, error) {
url := "/v1/return/giveout/is-enabled"
resp := &IsGiveoutEnabledResponse{}
response, err := c.client.Request(ctx, http.MethodPost, url, struct{}{}, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type GetGiveoutResponse struct {
core.CommonResponse
// PDF file with barcode in binary format
FileContent string `json:"file_content"`
// File name
FileName string `json:"file_name"`
// File type
ContentType string `json:"content_type"`
}
// Barcode for return shipment in PDF format
//
// Returns a PDF file with a barcode
func (c Returns) GetGiveoutPDF(ctx context.Context) (*GetGiveoutResponse, error) {
url := "/v1/return/giveout/get-pdf"
resp := &GetGiveoutResponse{}
response, err := c.client.Request(ctx, http.MethodPost, url, struct{}{}, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
// Barcode for return shipment in PNG format
//
// Returns a PNG file with a barcode
func (c Returns) GetGiveoutPNG(ctx context.Context) (*GetGiveoutResponse, error) {
url := "/v1/return/giveout/get-png"
resp := &GetGiveoutResponse{}
response, err := c.client.Request(ctx, http.MethodPost, url, struct{}{}, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type GetGiveoutBarcodeResponse struct {
core.CommonResponse
// Barcode value in text format
Barcode string `json:"barcode"`
}
// Value of barcode for return shipments
//
// Use this method to get the barcode from the response of the
// `/v1/return/giveout/get-png` and `/v1/return/giveout/get-pdf` methods in text format
func (c Returns) GetGiveoutBarcode(ctx context.Context) (*GetGiveoutBarcodeResponse, error) {
url := "/v1/return/giveout/barcode"
resp := &GetGiveoutBarcodeResponse{}
response, err := c.client.Request(ctx, http.MethodPost, url, struct{}{}, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
// Use this method if an unauthorized person has gained access to your barcode.
//
// The method returns a PNG file with the new barcode. Once the method is used,
// you won't be able to get a return shipment using the old barcodes.
// To get a new barcode in PDF format, use the /v1/return/giveout/get-pdf method
func (c Returns) ResetGiveoutBarcode(ctx context.Context) (*GetGiveoutResponse, error) {
url := "/v1/return/giveout/barcode-reset"
resp := &GetGiveoutResponse{}
response, err := c.client.Request(ctx, http.MethodPost, url, struct{}{}, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type GetGiveoutListParams struct {
// Identifier of the last value on the page
LastId int64 `json:"last_id"`
// Number of values in the response
Limit int64 `json:"limit"`
}
type GetGiveoutListResponse struct {
core.CommonResponse
// Shipment identifier
Giveouts []GetGiveoutListGiveout `json:"giveouts"`
}
type GetGiveoutListGiveout struct {
// Number of products in shipment
ApprovedArticlesCount int32 `json:"approved_articles_count"`
// Creation date and time
CreatedAt time.Time `json:"created_at"`
// Shipment identifier
GiveoutId int64 `json:"giveout_id"`
// Return shipment status
GiveoutStatus GiveoutStatus `json:"giveout_status"`
// Total number of products to be picked up from the warehouse
TotalArticlesCount int32 `json:"total_articles_count"`
// Warehouse address
WarehouseAddress string `json:"warehouse_address"`
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
// Warehouse name
WarehouseName string `json:"warehouse_name"`
}
// Return shipments list
func (c Returns) GetGiveoutList(ctx context.Context, params *GetGiveoutListParams) (*GetGiveoutListResponse, error) {
url := "/v1/return/giveout/list"
resp := &GetGiveoutListResponse{}
response, err := c.client.Request(ctx, http.MethodPost, url, struct{}{}, resp, nil)
if err != nil {
return nil, err
}
response.CopyCommonResponse(&resp.CommonResponse)
return resp, nil
}
type GetGiveoutInfoParams struct {
// Shipment identifier
GiveoutId int64 `json:"giveout_id"`
}
type GetGiveoutInfoResponse struct {
core.CommonResponse
// Product IDs
Articles []GetGiveoutInfoArticle `json:"articles"`
// Shipment identifier
GiveoutId int64 `json:"giveout_id"`
// Return shipment status
GiveoutStatus GiveoutStatus `json:"giveout_status"`
// Warehouse address
WarehouseAddress string `json:"warehouse_address"`
// Warehouse name
WarehouseName string `json:"warehouse_name"`
}
type GetGiveoutInfoArticle struct {
// `true` if the shipment is confirmed
Approved bool `json:"approved"`
// Delivery schema
DeliverySchema GiveoutDeliverySchema `json:"delivery_schema"`
// Product name
Name string `json:"name"`
// Seller identifier
SellerId int64 `json:"seller_id"`
}
// Information on return shipment
func (c Returns) GetGiveoutInfo(ctx context.Context, params *GetGiveoutInfoParams) (*GetGiveoutInfoResponse, error) {
url := "/v1/return/giveout/info"
resp := &GetGiveoutInfoResponse{}
response, err := c.client.Request(ctx, http.MethodPost, url, struct{}{}, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -61,11 +62,15 @@ func TestGetFBOReturns(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Returns().GetFBOReturns(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Returns().GetFBOReturns(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetFBOReturnsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -105,42 +110,43 @@ func TestGetFBSReturns(t *testing.T) {
Status: "returned_to_seller", Status: "returned_to_seller",
}, },
Limit: 1000, Limit: 1000,
Offset: 0, LastId: 0,
}, },
`{ `{
"result": { "last_id": 0,
"returns": [ "returns": [
{ {
"id": 19166541735000, "accepted_from_customer_moment": "string",
"clearing_id": 19166541725000, "clearing_id": 23,
"posting_number": "07402477-0022-2", "commission": 21,
"product_id": 172423678, "commission_percent": 0,
"sku": 172423678, "exemplar_id": 42,
"status": "returned_to_seller", "id": 123,
"returns_keeping_cost": 0, "is_moving": true,
"return_reason_name": "5.12 Заказ более не актуален: долгие сроки доставки", "is_opened": true,
"return_date": "2020-08-12T17:27:50+00:00", "last_free_waiting_day": "string",
"quantity": 1, "place_id": 122,
"product_name": "Кофе ароматизированный \"Лесной орех\" 250 гр", "moving_to_place_name": "string",
"price": 294, "picking_amount": 0,
"waiting_for_seller_date_time": "2020-08-16T02:50:35+00:00", "posting_number": "string",
"returned_to_seller_date_time": "2020-08-21T10:07:13+00:00", "picking_tag": "string",
"last_free_waiting_day": "2020-08-19T23:59:59+00:00", "price": 0,
"is_opened": false, "price_without_commission": 0,
"place_id": 0, "product_id": 2222,
"commission_percent": 0, "product_name": "string",
"commission": 0, "quantity": 0,
"price_without_commission": 0, "return_barcode": "string",
"is_moving": false, "return_clearing_id": 0,
"moving_to_place_name": "МОСКВА_ХАБ", "return_date": "string",
"waiting_for_seller_days": 2, "return_reason_name": "string",
"picking_amount": null, "waiting_for_seller_date_time": "string",
"accepted_from_customer_moment": null, "returned_to_seller_date_time": "string",
"picking_tag": null "waiting_for_seller_days": 0,
} "returns_keeping_cost": 0,
], "sku": 33332,
"count": 1 "status": "string"
} }
]
}`, }`,
}, },
// Test No Client-Id or Api-Key // Test No Client-Id or Api-Key
@@ -158,33 +164,826 @@ func TestGetFBSReturns(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Returns().GetFBSReturns(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Returns().GetFBSReturns(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetFBSReturnsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", 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.StatusCode == http.StatusOK {
if int(resp.Result.Count) != len(resp.Result.Returns) { if len(resp.Returns) > 0 {
t.Errorf("Count must equal to length of returns") if resp.Returns[0].Id == 0 {
}
if len(resp.Result.Returns) > 0 {
if resp.Result.Returns[0].Id == 0 {
t.Errorf("Id cannot be 0") t.Errorf("Id cannot be 0")
} }
if resp.Result.Returns[0].ProductId == 0 { if resp.Returns[0].ProductId == 0 {
t.Errorf("Product id cannot be 0") t.Errorf("Product id cannot be 0")
} }
if resp.Result.Returns[0].SKU == 0 { if resp.Returns[0].SKU == 0 {
t.Errorf("SKU cannot be 0") t.Errorf("SKU cannot be 0")
} }
if resp.Result.Returns[0].Status == "" { if resp.Returns[0].Status == "" {
t.Errorf("Status cannot be empty") t.Errorf("Status cannot be empty")
} }
} }
} }
} }
} }
func TestGetRFBSReturns(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetRFBSReturnsParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetRFBSReturnsParams{
LastId: 999,
Limit: 555,
Filter: GetRFBSReturnsFilter{
OfferId: "123",
PostingNumber: "111",
GroupState: []RFBSReturnsGroupState{RFBSReturnsGroupStateAll},
CreatedAt: GetRFBSReturnsFilterCreatedAt{
From: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2019-08-24T14:15:22Z"),
To: core.TimeFromString(t, "2006-01-02T15:04:05Z", "2019-08-24T14:15:22Z"),
},
},
},
`{
"returns": {
"client_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"order_number": "string",
"posting_number": "111",
"product": {
"name": "string",
"offer_id": "123",
"currency_code": "string",
"price": "string",
"sku": 123
},
"return_id": 0,
"return_number": "string",
"state": {
"group_state": "All",
"money_return_state_name": "string",
"state": "string",
"state_name": "string"
}
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetRFBSReturnsParams{},
`{
"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.Returns().GetRFBSReturns(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetRFBSReturnsResponse{})
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.Returns.Product.OfferId != test.params.Filter.OfferId {
t.Errorf("expected offer ID %s, but got: %s", test.params.Filter.OfferId, resp.Returns.Product.OfferId)
}
if resp.Returns.PostingNumber != test.params.Filter.PostingNumber {
t.Errorf("expected posting number %s, but got: %s", test.params.Filter.PostingNumber, resp.Returns.PostingNumber)
}
if resp.Returns.State.GroupState != test.params.Filter.GroupState[0] {
t.Errorf("expected group state %s, but got: %s", test.params.Filter.GroupState[0], resp.Returns.State.GroupState)
}
}
}
}
func TestGetRFBSReturn(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetRFBSReturnParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetRFBSReturnParams{
ReturnId: 123,
},
`{
"returns": {
"available_actions": [
{
"id": 0,
"name": "string"
}
],
"client_name": "string",
"client_photo": [
"string"
],
"client_return_method_type": {
"id": 0,
"name": "string"
},
"comment": "string",
"created_at": "2019-08-24T14:15:22Z",
"order_number": "string",
"posting_number": "string",
"product": {
"name": "string",
"offer_id": "string",
"currency_code": "string",
"price": "string",
"sku": 0
},
"rejection_comment": "string",
"rejection_reason": [
{
"hint": "string",
"id": 0,
"is_comment_required": true,
"name": "string"
}
],
"return_method_description": "string",
"return_number": "string",
"return_reason": {
"id": 0,
"is_defect": true,
"name": "string"
},
"ru_post_tracking_number": "string",
"state": {
"state": "string",
"state_name": "string"
},
"warehouse_id": 0
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetRFBSReturnParams{},
`{
"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.Returns().GetRFBSReturn(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetRFBSReturnResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestRejectRFBSReturn(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *RejectRFBSReturnParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&RejectRFBSReturnParams{
ReturnId: 123,
Comment: "No comment",
RejectionReasonId: 111,
},
`{}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&RejectRFBSReturnParams{},
`{
"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.Returns().RejectRFBSReturn(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &RejectRFBSReturnResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestCompensateRFBSreturn(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *CompensateRFBSReturnParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&CompensateRFBSReturnParams{
ReturnId: 123,
CompensationAmount: "11",
},
`{}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&CompensateRFBSReturnParams{},
`{
"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.Returns().CompensateRFBSReturn(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &CompensateRFBSReturnResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestApproveRFBSReturn(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ApproveRFBSReturnParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ApproveRFBSReturnParams{
ReturnId: 123,
ReturnMethodDescription: "some description",
},
`{}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ApproveRFBSReturnParams{},
`{
"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.Returns().ApproveRFBSReturn(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &ApproveRFBSReturnResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestReceiveRFBSReturn(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ReceiveRFBSReturnParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ReceiveRFBSReturnParams{
ReturnId: 123,
},
`{}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ReceiveRFBSReturnParams{},
`{
"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.Returns().ReceiveRFBSReturn(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &ReceiveRFBSReturnResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestRefundRFBS(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *RefundRFBSParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&RefundRFBSParams{
ReturnId: 123,
ReturnForBackWay: 111,
},
`{}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&RefundRFBSParams{},
`{
"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.Returns().RefundRFBS(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &RefundRFBSResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestIsGiveoutEnabled(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"},
`{
"enabled": true
}`,
},
// 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))
ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Returns().IsGiveoutEnabled(ctx)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &IsGiveoutEnabledResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetGiveoutPDF(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"},
`{
"content_type": "application/pdf",
"file_name": "string",
"file_content": "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))
ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Returns().GetGiveoutPDF(ctx)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetGiveoutResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetGiveoutPNG(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"},
`{
"content_type": "image/png",
"file_name": "string",
"file_content": "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))
ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Returns().GetGiveoutPNG(ctx)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetGiveoutResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetGiveoutBarcode(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"},
`{
"barcode": "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))
ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Returns().GetGiveoutBarcode(ctx)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetGiveoutBarcodeResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestResetGiveoutBarcode(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"},
`{
"content_type": "image/png",
"file_name": "string",
"file_content": "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))
ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Returns().ResetGiveoutBarcode(ctx)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetGiveoutResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetGiveoutList(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetGiveoutListParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetGiveoutListParams{
LastId: 0,
Limit: 0,
},
`{
"giveouts": [
{
"approved_articles_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"giveout_id": 0,
"giveout_status": "string",
"total_articles_count": 0,
"warehouse_address": "string",
"warehouse_id": 0,
"warehouse_name": "string"
}
]
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetGiveoutListParams{},
`{
"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.Returns().GetGiveoutList(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetGiveoutListResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetGiveoutInfo(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetGiveoutInfoParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetGiveoutInfoParams{
GiveoutId: 11,
},
`{
"articles": [
{
"approved": true,
"delivery_schema": "string",
"name": "string",
"seller_id": 0
}
],
"giveout_id": 11,
"giveout_status": "string",
"warehouse_address": "string",
"warehouse_name": "string"
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetGiveoutInfoParams{},
`{
"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.Returns().GetGiveoutInfo(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetGiveoutInfoResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
if resp.GiveoutId != test.params.GiveoutId {
t.Errorf("expected giveout id to be equal: got: %d, expected: %d", resp.GiveoutId, test.params.GiveoutId)
}
}
}

472
ozon/strategies.go Normal file
View File

@@ -0,0 +1,472 @@
package ozon
import (
"context"
"net/http"
core "github.com/diphantxm/ozon-api-client"
)
type Strategies struct {
client *core.Client
}
type ListCompetitorsParams struct {
// Page number from which you want to download the list of competitors.
// The minimum value is 1
Page int64 `json:"page"`
// Maximum number of competitors on the page. Allowed values: 150
Limit int64 `json:"limit"`
}
type ListCompetitorsResponse struct {
core.CommonResponse
// List of competitors
Competitor []ListCompetitorsCompetitor `json:"competitor"`
// Total number of competitors
Total int32 `json:"total"`
}
type ListCompetitorsCompetitor struct {
// Competitor's name
Name string `json:"competitor_name"`
// Competitor identifier
Id int64 `json:"competitor_id"`
}
// Method for getting a list of competitors—sellers with similar products in other online stores and marketplaces
func (c Strategies) ListCompetitors(ctx context.Context, params *ListCompetitorsParams) (*ListCompetitorsResponse, error) {
url := "/v1/pricing-strategy/competitors/list"
resp := &ListCompetitorsResponse{}
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 ListStrategiesParams struct {
// Page number from which you want to download the list of competitors.
// The minimum value is 1
Page int64 `json:"page"`
// Maximum number of competitors on the page. Allowed values: 150
Limit int64 `json:"limit"`
}
type ListStrategiesResponse struct {
core.CommonResponse
// List of strategies
Strategies []ListStrategiesStrategy `json:"strategies"`
// Total number of strategies
Total int32 `json:"total"`
}
type ListStrategiesStrategy struct {
// Strategy identifier
Id string `json:"strategy_id"`
// Strategy name
Name string `json:"strategy_name"`
// Strategy type
Type StrategyType `json:"type"`
// Type of the last strategy change
UpdateType StrategyUpdateType `json:"update_type"`
// Date of last change
UpdatedAt string `json:"updated_at"`
// Number of products in the strategy
ProductsCount int64 `json:"products_count"`
// Number of selected competitors
CompetitorsCount int64 `json:"competitors_count"`
// Strategy status
Enabled bool `json:"enabled"`
}
func (c Strategies) List(ctx context.Context, params *ListStrategiesParams) (*ListStrategiesResponse, error) {
url := "/v1/pricing-strategy/list"
resp := &ListStrategiesResponse{}
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 CreateStrategyParams struct {
// List of competitors
Competitors []CreateStrategyCompetitor `json:"competitors"`
// Strategy name
StrategyName string `json:"strategy_name"`
}
type CreateStrategyCompetitor struct {
// Coefficient by which the minimum price among competitors will be multiplied.
// The allowed range is from 0.5 to 1.2
Coefficient float32 `json:"coefficient"`
// Competitor identifier
CompetitorId int64 `json:"competitor_id"`
}
type CreateStrategyResponse struct {
core.CommonResponse
// Method result
Result CreateStrategyResult `json:"result"`
}
type CreateStrategyResult struct {
// Strategy identifier
StrategyId string `json:"strategy_id"`
}
func (c Strategies) Create(ctx context.Context, params *CreateStrategyParams) (*CreateStrategyResponse, error) {
url := "/v1/pricing-strategy/create"
resp := &CreateStrategyResponse{}
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 InfoStrategyParams struct {
// Strategy identifier
StrategyId string `json:"strategy_id"`
}
type InfoStrategyResponse struct {
core.CommonResponse
// Method result
Result InfoStrategyResult `json:"result"`
}
type InfoStrategyResult struct {
// List of competitors
Competitors []CreateStrategyCompetitor `json:"competitors"`
// Strategy status
Enabled bool `json:"enabled"`
// Strategy name
Name string `json:"name"`
// Strategy type
Type StrategyType `json:"type"`
// Type of the last strategy change
UpdateType StrategyUpdateType `json:"update_type"`
}
func (c Strategies) Info(ctx context.Context, params *InfoStrategyParams) (*InfoStrategyResponse, error) {
url := "/v1/pricing-strategy/info"
resp := &InfoStrategyResponse{}
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 UpdateStrategyParams struct {
// List of competitors
Competitors []CreateStrategyCompetitor `json:"competitors"`
// Product identifier
StrategyId string `json:"strategy_id"`
// Strategy name
StrategyName string `json:"strategy_name"`
}
type UpdateStrategyResponse struct {
core.CommonResponse
}
func (c Strategies) Update(ctx context.Context, params *UpdateStrategyParams) (*UpdateStrategyResponse, error) {
url := "/v1/pricing-strategy/update"
resp := &UpdateStrategyResponse{}
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 AddProductsToStrategyParams struct {
// List of product identifiers. The maximum number is 50
ProductId []int64 `json:"product_id"`
// Product identifier
StrategyId string `json:"strategy_id"`
}
type AddProductsToStrategyResponse struct {
core.CommonResponse
// Method result
Result AddProductsToStrategyResult `json:"result"`
}
type AddProductsToStrategyResult struct {
// Products with errors
Errors []AddProductsToStrategyResultError `json:"errors"`
// Number of products with errors
FailedProductCount int32 `json:"failed_product_count"`
}
type AddProductsToStrategyResultError struct {
// Error code
Code string `json:"code"`
// Error message
Error string `json:"error"`
// Product identifier
ProductId int64 `json:"product_id"`
}
func (c Strategies) AddProducts(ctx context.Context, params *AddProductsToStrategyParams) (*AddProductsToStrategyResponse, error) {
url := "/v1/pricing-strategy/products/add"
resp := &AddProductsToStrategyResponse{}
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 GetStrategiesByProductIdsParams struct {
// List of product identifiers. The maximum number is 50
ProductId []int64 `json:"product_id"`
}
type GetStrategiesByProductIdsResponse struct {
core.CommonResponse
// Method result
Result GetStrategiesByProductIdsResult `json:"result"`
}
type GetStrategiesByProductIdsResult struct {
// Product information
ProductsInfo []GetStrategiesByProductIdsResultProductInfo `json:"products_info"`
}
type GetStrategiesByProductIdsResultProductInfo struct {
// Product identifier
ProductId int64 `json:"product_id"`
// Strategy identifier to which the product is bounded
StrategyId string `json:"strategy_id"`
}
func (c Strategies) GetByProductIds(ctx context.Context, params *GetStrategiesByProductIdsParams) (*GetStrategiesByProductIdsResponse, error) {
url := "/v1/pricing-strategy/strategy-ids-by-product-ids"
resp := &GetStrategiesByProductIdsResponse{}
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 ListProductsInStrategyParams struct {
// Strategy identifier
StrategyId string `json:"strategy_id"`
}
type ListProductsInStrategyResponse struct {
core.CommonResponse
// Method result
Result ListProductsInStrategyResult `json:"result"`
}
type ListProductsInStrategyResult struct {
// Product identifier
ProductId []string `json:"product_id"`
}
func (c Strategies) ListProducts(ctx context.Context, params *ListProductsInStrategyParams) (*ListProductsInStrategyResponse, error) {
url := "/v1/pricing-strategy/products/list"
resp := &ListProductsInStrategyResponse{}
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 GetCompetitorPriceParams struct {
// Product identifier
ProductId int64 `json:"product_id"`
}
type GetCompetitorPriceResponse struct {
core.CommonResponse
// Method result
Result GetCompetitorPriceResult `json:"result"`
}
type GetCompetitorPriceResult struct {
// Product identifier
StrategyId string `json:"strategy_id"`
// true if the product is in the pricing strategy
IsEnabled bool `json:"is_enabled"`
// Price of product in the strategy
StrategyProductPrice int32 `json:"strategy_product_price"`
// Price setting date
PriceDownloadedAt string `json:"price_downloaded_at"`
// Competitor identifier
StrategyCompetitorId int64 `json:"strategy_competitor_id"`
// Link to a competitor's product
StrategyCompetitorProductURL string `json:"strategy_competitor_product_url"`
}
func (c Strategies) GetCompetitorPrice(ctx context.Context, params *GetCompetitorPriceParams) (*GetCompetitorPriceResponse, error) {
url := "/v1/pricing-strategy/product/info"
resp := &GetCompetitorPriceResponse{}
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 RemoveProductsFromStrategyParams struct {
// List of product identifiers. The maximum number is 50
ProductId []int64 `json:"product_id"`
}
type RemoveProductsFromStrategyResponse struct {
core.CommonResponse
// Method result
Result RemoveProductsFromStrategyResult `json:"result"`
}
type RemoveProductsFromStrategyResult struct {
// Number of products with errors
FailedProductCount int32 `json:"failed_product_count"`
}
func (c Strategies) RemoveProducts(ctx context.Context, params *RemoveProductsFromStrategyParams) (*RemoveProductsFromStrategyResponse, error) {
url := "/v1/pricing-strategy/products/delete"
resp := &RemoveProductsFromStrategyResponse{}
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 ChangeStrategyStatusParams struct {
// Strategy status
Enabled bool `json:"enabled"`
// Product identifier
StrategyId string `json:"strategy_id"`
}
type ChangeStrategyStatusResponse struct {
core.CommonResponse
}
func (c Strategies) ChangeStatus(ctx context.Context, params *ChangeStrategyStatusParams) (*ChangeStrategyStatusResponse, error) {
url := "/v1/pricing-strategy/status"
resp := &ChangeStrategyStatusResponse{}
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 RemoveStrategyParams struct {
// Strategy identifier
StrategyId string `json:"strategy_id"`
}
type RemoveStrategyResponse struct {
core.CommonResponse
}
func (c Strategies) Remove(ctx context.Context, params *RemoveStrategyParams) (*RemoveStrategyResponse, error) {
url := "/v1/pricing-strategy/delete"
resp := &RemoveStrategyResponse{}
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
}

717
ozon/strategies_test.go Normal file
View File

@@ -0,0 +1,717 @@
package ozon
import (
"context"
"net/http"
"testing"
core "github.com/diphantxm/ozon-api-client"
)
func TestListCompetitors(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ListCompetitorsParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ListCompetitorsParams{
Page: 1,
Limit: 20,
},
`{
"competitor": [
{
"competitor_name": "string",
"competitor_id": 0
}
],
"total": 0
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ListCompetitorsParams{},
`{
"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.Strategies().ListCompetitors(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &ListCompetitorsResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestListStrategies(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ListStrategiesParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ListStrategiesParams{
Page: 1,
Limit: 20,
},
`{
"strategies": [
{
"strategy_id": "string",
"strategy_name": "string",
"type": "string",
"update_type": "string",
"updated_at": "string",
"products_count": 0,
"competitors_count": 0,
"enabled": true
}
],
"total": 0
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ListStrategiesParams{},
`{
"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.Strategies().List(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &ListStrategiesResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestCreateStrategy(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *CreateStrategyParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&CreateStrategyParams{
StrategyName: "New strategy",
Competitors: []CreateStrategyCompetitor{
{
CompetitorId: 1008426,
Coefficient: 1,
},
{
CompetitorId: 204,
Coefficient: 1,
},
{
CompetitorId: 91,
Coefficient: 1,
},
{
CompetitorId: 48,
Coefficient: 1,
},
},
},
`{
"result": {
"strategy_id": "4f3a1d4c-5833-4f04-b69b-495cbc1f6f1c"
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&CreateStrategyParams{},
`{
"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.Strategies().Create(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &CreateStrategyResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestInfoStrategy(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *InfoStrategyParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&InfoStrategyParams{
StrategyId: "1",
},
`{
"result": {
"name": "test1",
"enabled": true,
"update_type": "strategyItemsListChanged",
"type": "COMP_PRICE",
"competitors": [
{
"competitor_id": 204,
"coefficient": 1
},
{
"competitor_id": 1008426,
"coefficient": 1
}
]
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&InfoStrategyParams{},
`{
"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.Strategies().Info(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &InfoStrategyResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestUpdateStrategy(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *UpdateStrategyParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&UpdateStrategyParams{
StrategyId: "a3de1826-9c54-40f1-bb6d-1a9e2638b058",
StrategyName: "New Strategy",
Competitors: []CreateStrategyCompetitor{
{
CompetitorId: 1008426,
Coefficient: 1,
},
{
CompetitorId: 204,
Coefficient: 1,
},
{
CompetitorId: 91,
Coefficient: 1,
},
{
CompetitorId: 48,
Coefficient: 1,
},
{
CompetitorId: 45,
Coefficient: 1,
},
},
},
`{}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&UpdateStrategyParams{},
`{
"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.Strategies().Update(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &UpdateStrategyResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestAddProductsToStrategy(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *AddProductsToStrategyParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&AddProductsToStrategyParams{
ProductId: []int64{29209},
StrategyId: "e29114f0-177d-4160-8d06-2bc528470dda",
},
`{
"result": {
"failed_product_count": 0
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&AddProductsToStrategyParams{},
`{
"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.Strategies().AddProducts(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &AddProductsToStrategyResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetStrategiesByProductIds(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetStrategiesByProductIdsParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetStrategiesByProductIdsParams{
ProductId: []int64{29209},
},
`{
"result": {
"products_info": [
{
"product_id": 29209,
"strategy_id": "b7cd30e6-5667-424d-b105-fbec30a52477"
}
]
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetStrategiesByProductIdsParams{},
`{
"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.Strategies().GetByProductIds(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetStrategiesByProductIdsResponse{})
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.ProductsInfo) != len(test.params.ProductId) {
t.Errorf("Length of product ids in request and response are not equal")
}
if len(resp.Result.ProductsInfo) > 0 {
if resp.Result.ProductsInfo[0].ProductId != test.params.ProductId[0] {
t.Errorf("Product ids in request and response are not equal")
}
}
}
}
}
func TestListProductsInStrategy(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ListProductsInStrategyParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ListProductsInStrategyParams{
StrategyId: "string",
},
`{
"result": {
"product_id": [
"string"
]
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ListProductsInStrategyParams{},
`{
"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.Strategies().ListProducts(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &ListProductsInStrategyResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestGetCompetitorPrice(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *GetCompetitorPriceParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&GetCompetitorPriceParams{
ProductId: 0,
},
`{
"result": {
"strategy_id": "string",
"is_enabled": true,
"strategy_product_price": 0,
"price_downloaded_at": "2022-11-17T15:33:53.936Z",
"strategy_competitor_id": 0,
"strategy_competitor_product_url": "string"
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&GetCompetitorPriceParams{},
`{
"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.Strategies().GetCompetitorPrice(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &GetCompetitorPriceResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestRemoveProductsFromStrategy(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *RemoveProductsFromStrategyParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&RemoveProductsFromStrategyParams{
ProductId: []int64{0},
},
`{
"result": {
"failed_product_count": 0
}
}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&RemoveProductsFromStrategyParams{},
`{
"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.Strategies().RemoveProducts(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &RemoveProductsFromStrategyResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestChangeStrategyStatus(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *ChangeStrategyStatusParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&ChangeStrategyStatusParams{
Enabled: true,
StrategyId: "c7516438-7124-4e2c-85d3-ccd92b6b9b65",
},
`{}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&ChangeStrategyStatusParams{},
`{
"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.Strategies().ChangeStatus(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &ChangeStatusToResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}
func TestRemoveStrategy(t *testing.T) {
t.Parallel()
tests := []struct {
statusCode int
headers map[string]string
params *RemoveStrategyParams
response string
}{
// Test Ok
{
http.StatusOK,
map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
&RemoveStrategyParams{
StrategyId: "strategy",
},
`{}`,
},
// Test No Client-Id or Api-Key
{
http.StatusUnauthorized,
map[string]string{},
&RemoveStrategyParams{},
`{
"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.Strategies().Remove(ctx, test.params)
if err != nil {
t.Error(err)
continue
}
compareJsonResponse(t, test.response, &RemoveStrategyResponse{})
if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
}
}
}

83
ozon/utils.go Normal file
View File

@@ -0,0 +1,83 @@
package ozon
import (
"bytes"
"encoding/json"
"fmt"
"reflect"
"strings"
"testing"
)
func compareJsonResponse(t *testing.T, expectedJSON string, response interface{}) {
err := json.Unmarshal([]byte(expectedJSON), response)
if err != nil {
t.Errorf("got error: %s", err)
return
}
after, err := json.Marshal(response)
if err != nil {
t.Errorf("got error: %s", err)
return
}
var j1, j2 map[string]interface{}
if err := json.NewDecoder(strings.NewReader(expectedJSON)).Decode(&j1); err != nil {
t.Errorf("got error: %s", err)
return
}
if err := json.NewDecoder(bytes.NewReader(after)).Decode(&j2); err != nil {
t.Errorf("got error: %s", err)
return
}
if err := compareJson(j1, j2, ""); err != nil {
t.Errorf("jsons are not equal: %s", err)
return
}
}
func compareJson(expected interface{}, actual interface{}, prefix string) error {
if expected == nil {
return nil
}
expectedType := reflect.TypeOf(expected).Kind()
actualType := reflect.TypeOf(actual).Kind()
if expectedType != actualType {
return fmt.Errorf("type for key %s is different: expected: %s, \ngot: %s", prefix, expectedType, actualType)
}
switch expected.(type) {
case map[string]interface{}:
expectedMap := expected.(map[string]interface{})
actualMap := actual.(map[string]interface{})
for k, v := range expectedMap {
key := fmt.Sprintf("%s.%s", prefix, k)
actualValue, ok := actualMap[k]
if !ok {
return fmt.Errorf("key %s is absent", key)
}
if err := compareJson(v, actualValue, key); err != nil {
return err
}
}
case []interface{}:
expectedSlice := expected.([]interface{})
actualSlice := actual.([]interface{})
for i := range expectedSlice {
key := fmt.Sprintf("%s.%d", prefix, i)
if err := compareJson(expectedSlice[i], actualSlice[i], key); err != nil {
return err
}
}
default:
if !reflect.DeepEqual(expected, actual) {
return fmt.Errorf("value for key %s is different: expected: %s, \ngot: %s", prefix, expected, actual)
}
}
return nil
}

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"time" "time"
@@ -14,79 +15,83 @@ type Warehouses struct {
type GetListOfWarehousesResponse struct { type GetListOfWarehousesResponse struct {
core.CommonResponse core.CommonResponse
Result []struct { Result []GetListOfWarehousesResult `json:"result"`
// Trusted acceptance attribute. `true` if trusted acceptance is enabled in the warehouse }
HasEntrustedAcceptance bool `json:"has_entrusted_acceptance"`
// Indication that the warehouse works under the rFBS scheme: type GetListOfWarehousesResult struct {
// - true — the warehouse works under the rFBS scheme; // Trusted acceptance attribute. `true` if trusted acceptance is enabled in the warehouse
// - false — the warehouse does not work under the rFBS scheme. HasEntrustedAcceptance bool `json:"has_entrusted_acceptance"`
IsRFBS bool `json:"is_rfbs"`
// Warehouse name // Indication that the warehouse works under the rFBS scheme:
Name string `json:"name"` // - true — the warehouse works under the rFBS scheme;
// - false — the warehouse does not work under the rFBS scheme.
IsRFBS bool `json:"is_rfbs"`
// Warehouse identifier // Warehouse name
WarehouseId int64 `json:"warehouse_id"` Name string `json:"name"`
// Possibility to print an acceptance certificate in advance. `true` if printing in advance is possible // Warehouse identifier
CanPrintActInAdvance bool `json:"can_print_act_in_advance"` WarehouseId int64 `json:"warehouse_id"`
// FBS first mile // Possibility to print an acceptance certificate in advance. `true` if printing in advance is possible
FirstMileType struct { CanPrintActInAdvance bool `json:"can_print_act_in_advance"`
// DropOff point identifier
DropoffPointId string `json:"dropoff_point_id"`
// DropOff timeslot identifier // FBS first mile
DropoffTimeslotId int64 `json:"dropoff_timeslot_id"` FirstMileType GetListOfWarehousesResultFirstMile `json:"first_mile_type"`
// Indication that the warehouse settings are being updated // Indication if there is a limit on the minimum number of orders. `true` if there is such a limit
FirstMileIsChanging bool `json:"first_mile_is_changing"` HasPostingsLimit bool `json:"has_postings_limit"`
// First mile type: // Indication that the warehouse is not working due to quarantine
// IsKarantin bool `json:"is_karantin"`
// Enum: "DropOff" "Pickup"
// - DropOff
// - Pickup
FirstMileType string `json:"first_mile_type"`
} `json:"first_mile_type"`
// Indication if there is a limit on the minimum number of orders. `true` if there is such a limit // Indication that the warehouse accepts bulky products
HasPostingsLimit bool `json:"has_postings_limit"` IsKGT bool `json:"is_kgt"`
// Indication that the warehouse is not working due to quarantine // Indication that warehouse schedule can be changed
IsKarantin bool `json:"is_karantin"` IsTimetableEditable bool `json:"is_timetable_editable"`
// Indication that the warehouse accepts bulky products // Minimum limit value: the number of orders that can be brought in one shipment
IsKGT bool `json:"is_kgt"` MinPostingsLimit int32 `json:"min_postings_limit"`
// Indication that warehouse schedule can be changed // Limit value. -1 if there is no limit
IsTimetableEditable bool `json:"is_timetable_editable"` PostingsLimit int32 `json:"postings_limit"`
// Minimum limit value: the number of orders that can be brought in one shipment // Number of warehouse working days
MinPostingsLimit int32 `json:"min_postings_limit"` MinWorkingDays int64 `json:"min_working_days"`
// Limit value. -1 if there is no limit // Warehouse status
PostingsLimit int32 `json:"postings_limit"` Status string `json:"status"`
// Number of warehouse working days // Warehouse working days
MinWorkingDays int64 `json:"min_working_days"` WorkingDays []WorkingDay `json:"working_days"`
}
// Warehouse status type GetListOfWarehousesResultFirstMile struct {
Status string `json:"status"` // DropOff point identifier
DropoffPointId string `json:"dropoff_point_id"`
// Warehouse working days // DropOff timeslot identifier
WorkingDays []string `json:"working_days"` DropoffTimeslotId int64 `json:"dropoff_timeslot_id"`
} `json:"resulCommonResponse"`
// Indication that the warehouse settings are being updated
FirstMileIsChanging bool `json:"first_mile_is_changing"`
// First mile type:
//
// Enum: "DropOff" "Pickup"
// - DropOff
// - Pickup
FirstMileType string `json:"first_mile_type"`
} }
// You do not need to specify any parameters in the request. Your company will be identified by the Warehouses ID // You do not need to specify any parameters in the request. Your company will be identified by the Warehouses ID
func (c Warehouses) GetListOfWarehouses() (*GetListOfWarehousesResponse, error) { func (c Warehouses) GetListOfWarehouses(ctx context.Context) (*GetListOfWarehousesResponse, error) {
url := "/v1/warehouse/list" url := "/v1/warehouse/list"
resp := &GetListOfWarehousesResponse{} resp := &GetListOfWarehousesResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp) response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -131,50 +136,52 @@ type GetListOfDeliveryMethodsResponse struct {
HasNext bool `json:"has_next"` HasNext bool `json:"has_next"`
// Method result // Method result
Result []struct { Result []GetListOfDeliveryMethodsResult `json:"result"`
// Company identifier }
CompanyId int64 `json:"company_id"`
// Date and time of delivery method creation type GetListOfDeliveryMethodsResult struct {
CreatedAt time.Time `json:"created_at"` // Company identifier
CompanyId int64 `json:"company_id"`
// Time before an order must be packaged // Date and time of delivery method creation
Cutoff string `json:"cutoff"` CreatedAt time.Time `json:"created_at"`
// Delivery method identifier // Time before an order must be packaged
Id int64 `json:"id"` Cutoff string `json:"cutoff"`
// Delivery method name // Delivery method identifier
Name string `json:"name"` Id int64 `json:"id"`
// Delivery service identifier // Delivery method name
ProviderId int64 `json:"provider_id"` Name string `json:"name"`
// Delivery method status: // Delivery service identifier
// - NEW—created, ProviderId int64 `json:"provider_id"`
// - EDITED—being edited,
// - ACTIVE—active,
// - DISABLED—inactive
Status string `json:"status"`
// Order delivery service identifier // Delivery method status:
TemplateId int64 `json:"template_id"` // - NEW—created,
// - EDITED—being edited,
// - ACTIVE—active,
// - DISABLED—inactive
Status string `json:"status"`
// Date and time when the delivery method was last updated // Order delivery service identifier
UpdatedAt time.Time `json:"updated_at"` TemplateId int64 `json:"template_id"`
// Warehouse identifier // Date and time when the delivery method was last updated
WarehouseId int64 `json:"warehouse_id"` UpdatedAt time.Time `json:"updated_at"`
} `json:"result"`
// Warehouse identifier
WarehouseId int64 `json:"warehouse_id"`
} }
// This methods allows you to get list of all delivery methods that can be applied for this warehouse // This methods allows you to get list of all delivery methods that can be applied for this warehouse
func (c Warehouses) GetListOfDeliveryMethods(params *GetListOfDeliveryMethodsParams) (*GetListOfDeliveryMethodsResponse, error) { func (c Warehouses) GetListOfDeliveryMethods(ctx context.Context, params *GetListOfDeliveryMethodsParams) (*GetListOfDeliveryMethodsResponse, error) {
url := "/v1/delivery-method/list" url := "/v1/delivery-method/list"
resp := &GetListOfDeliveryMethodsResponse{} resp := &GetListOfDeliveryMethodsResponse{}
response, err := c.client.Request(http.MethodPost, url, nil, resp) response, err := c.client.Request(ctx, http.MethodPost, url, nil, resp, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@@ -1,6 +1,7 @@
package ozon package ozon
import ( import (
"context"
"net/http" "net/http"
"testing" "testing"
@@ -58,11 +59,15 @@ func TestGetListOfWarehouses(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Warehouses().GetListOfWarehouses() ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Warehouses().GetListOfWarehouses(ctx)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetListOfWarehousesResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }
@@ -133,11 +138,15 @@ func TestGetListOfDeliveryMethods(t *testing.T) {
for _, test := range tests { for _, test := range tests {
c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
resp, err := c.Warehouses().GetListOfDeliveryMethods(test.params) ctx, _ := context.WithTimeout(context.Background(), testTimeout)
resp, err := c.Warehouses().GetListOfDeliveryMethods(ctx, test.params)
if err != nil { if err != nil {
t.Error(err) t.Error(err)
continue
} }
compareJsonResponse(t, test.response, &GetListOfDeliveryMethodsResponse{})
if resp.StatusCode != test.statusCode { if resp.StatusCode != test.statusCode {
t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
} }