Update December 25, 2023 (#57)

client.go

@@ -7,6 +7,7 @@ import (
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
+	"net/url"
 )
 
 type HttpClient interface {
@@ -34,14 +35,17 @@ func NewMockClient(handler http.HandlerFunc) *Client {
 	}
 }
 
-func (c Client) newRequest(ctx context.Context, method string, url string, body interface{}) (*http.Request, error) {
+func (c Client) newRequest(ctx context.Context, method string, uri string, body interface{}) (*http.Request, error) {
 	bodyJson, err := json.Marshal(body)
 	if err != nil {
 		return nil, err
 	}
 
-	url = c.baseUrl + url
+	uri, err = url.JoinPath(c.baseUrl, uri)
-	req, err := http.NewRequestWithContext(ctx, method, url, bytes.NewBuffer(bodyJson))
+	if err != nil {
+		return nil, err
+	}
+	req, err := http.NewRequestWithContext(ctx, method, uri, bytes.NewBuffer(bodyJson))
 	if err != nil {
 		return nil, err
 	}

ozon/categories.go

@@ -25,7 +25,7 @@ type GetProductTreeResponse struct {
 
 type GetProductTreeResult struct {
 	// Category identifier
-	CategoryId int64 `json:"category_id"`
+	DescriptionCategoryId int64 `json:"description_category_id"`
 
 	// Category name
 	CategoryName string `json:"category_name"`
@@ -64,7 +64,7 @@ func (c *Categories) Tree(ctx context.Context, params *GetProductTreeParams) (*G
 
 type GetCategoryAttributesParams struct {
 	// Category identifier
-	CategoryId int64 `json:"category_id"`
+	DescriptionCategoryId int64 `json:"description_category_id"`
 
 	// Response language
 	Language Language `json:"language"`
@@ -123,6 +123,12 @@ type GetCategoryAttributesResult struct {
 
 	// Characteristic type
 	Type string `json:"type"`
+
+	// Complex attribute identifier
+	AttributeComplexId int64 `json:"attribute_complex_id"`
+
+	// Maximum number of values for attribute
+	MaxValueCount int64 `json:"max_value_count"`
 }
 
 // Getting characteristics for specified product category and type.
@@ -149,7 +155,7 @@ type GetAttributeDictionaryParams struct {
 	AttributeId int64 `json:"attribute_id"`
 
 	// Category identifier
-	CategoryId int64 `json:"category_id"`
+	DescriptionCategoryId int64 `json:"description_category_id"`
 
 	// Response language
 	Language Language `json:"language"`
@@ -200,7 +206,7 @@ type GetAttributeDictionaryResult struct {
 // 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"
+	url := "/v1/description-category/attribute/values"
 
 	resp := &GetAttributeDictionaryResponse{}
 

ozon/categories_test.go

@@ -27,7 +27,7 @@ func TestGetProductTree(t *testing.T) {
 			`{
 				"result": [
 				  {
-					"category_id": 0,
+					"description_category_id": 0,
 					"category_name": "string",
 					"children": [],
 					"disabled": true,
@@ -81,9 +81,9 @@ func TestGetCategoryAttributes(t *testing.T) {
 			http.StatusOK,
 			map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
 			&GetCategoryAttributesParams{
-				CategoryId: 12345,
+				DescriptionCategoryId: 12345,
-				Language:   English,
+				Language:              English,
-				TypeId:     2,
+				TypeId:                2,
 			},
 			`{
 				"result": [
@@ -97,7 +97,9 @@ func TestGetCategoryAttributes(t *testing.T) {
 					"is_collection": true,
 					"is_required": true,
 					"name": "string",
-					"type": "string"
+					"type": "string",
+					"attribute_complex_id": 0,
+					"max_value_count": 0
 				  }
 				]
 			}`,
@@ -146,12 +148,12 @@ func TestGetAttributeDictionary(t *testing.T) {
 			http.StatusOK,
 			map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
 			&GetAttributeDictionaryParams{
-				AttributeId: 123456,
+				AttributeId:           123456,
-				CategoryId:  12,
+				DescriptionCategoryId: 12,
-				Language:    English,
+				Language:              English,
-				LastValueId: 1,
+				LastValueId:           1,
-				Limit:       5,
+				Limit:                 5,
-				TypeId:      6,
+				TypeId:                6,
 			},
 			`{
 				"has_next": true,

ozon/chats.go

@@ -16,8 +16,8 @@ type ListChatsParams struct {
 	// Chats filter
 	Filter ListChatsFilter `json:"filter"`
 
-	// Number of values in the response. Default value is 1
+	// Number of values in the response. The default value is 30. The maximum value is 1000
-	Limit int64 `json:"limit" default:"1"`
+	Limit int64 `json:"limit" default:"30"`
 
 	// Number of elements that will be skipped in the response.
 	// For example, if offset=10, the response will start with the 11th element found
@@ -173,7 +173,7 @@ type ChatHistoryParams struct {
 	// Default value is the last visible message
 	FromMessageId string `json:"from_message_id"`
 
-	// Number of messages in the response. The default value is 50
+	// Number of messages in the response. The default value is 50. The maximum value is 1000
 	Limit int64 `json:"limit" default:"50"`
 }
 

ozon/fbs.go

@@ -1750,18 +1750,76 @@ func (c FBS) GetDropOffPointRestrictions(ctx context.Context, params *GetDropOff
 }
 
 type CheckProductItemsDataParams struct {
+	// Quantity of boxes the product is packed in
+	MultiBoxQuantity int32 `json:"multi_box_qty"`
+
 	// Shipment number
 	PostingNumber string `json:"posting_number"`
 
-	Products CheckProductItemsDataProduct `json:"products"`
+	// Product list
+	Products []CheckProductItemsDataProduct `json:"products"`
 }
 
 type CheckProductItemsDataProduct struct {
 	// Product items data
-	Exemplars []FBSProductExemplar `json:"exemplars"`
+	Exemplars []CheckProductItemsDataProductExemplar `json:"exemplars"`
 
-	// SKU, FBS product identifier in the Ozon system
+	// Indication that you need to pass the сustoms cargo declaration
+	// (CCD) number for the product and shipment
+	IsGTDNeeded bool `json:"is_gtd_needed"`
+
+	// Indication that you need to pass the "Chestny ZNAK" labeling
+	IsMandatoryMarkNeeded bool `json:"is_mandatory_mark_needed"`
+
+	// Indication that you need to pass the product batch registration number
+	IsRNPTNeeded bool `json:"is_rnpt_needed"`
+
+	// Product ID
 	ProductId int64 `json:"product_id"`
+
+	// Items quantity
+	Quantity int32 `json:"quantity"`
+}
+
+type CheckProductItemsDataProductExemplar struct {
+	// Item identifier
+	ExemplarId int64 `json:"exemplar_id"`
+
+	// Customs cargo declaration (CCD) number
+	GTD string `json:"gtd"`
+
+	// Сustoms cargo declaration (CCD) check status
+	GTDCheckStatus string `json:"gtd_check_status"`
+
+	// Сustoms cargo declaration (CCD) check error codes
+	GTDErrorCodes []string `json:"gtd_error_codes"`
+
+	// Indication that the customs cargo declaration (CCD) number isn't specified
+	IsGTDAbsent bool `json:"is_gtd_absent"`
+
+	// "Chestny ZNAK" labeling check status
+	MandatoryMarkCheckStatus MandatoryMarkStatus `json:"mandatory_mark_check_status"`
+
+	// "Chestny ZNAK" labeling check error codes
+	MandatoryMarkErrorCodes []string `json:"mandatory_mark_error_codes"`
+
+	// Indication that the product batch registration number isn't specified
+	IsRNPTAbsent bool `json:"is_rnpt_absent"`
+
+	// Mandatory "Chestny ZNAK" labeling
+	MandatoryMark string `json:"mandatory_mark"`
+
+	// Product batch registration number
+	RNPT string `json:"rnpt"`
+
+	// Product batch registration number check status
+	RNPTCheckStatus string `json:"rnpt_check_status"`
+
+	// Product batch registration number check error codes
+	RNPTErrorCodes []string `json:"rnpt_error_codes"`
+
+	// Unique identifier of charges of the jewelry
+	JWUIN string `json:"jw_uin"`
 }
 
 type CheckProductItemsDataResponse struct {
@@ -1772,20 +1830,23 @@ type CheckProductItemsDataResponse struct {
 }
 
 // Asynchronous method:
-//   - for checking the availability of product items in the “Chestny ZNAK” labeling system
-//   - for saving product items data
 //
-// To get the checks results, use the `/v4/fbs/posting/product/exemplar/status method`
+// for checking the availability of product items in the “Chestny ZNAK” labeling system;
+// for saving product items data.
+// To get the checks results, use the `/v4/fbs/posting/product/exemplar/status` method.
+// To get data about created items, use the `/v5/fbs/fbs/posting/product/exemplar/create-or-get` method.
 //
-// If necessary, specify the number of the cargo customs declaration in the gtd parameter. If it is missing, pass the value `is_gtd_absent` = true
+// If necessary, specify the number of the cargo customs declaration in the gtd parameter.
+// If it is missing, pass the value `is_gtd_absent` = true.
 //
-// If you have multiple identical products in a shipment, specify one `product_id` and `exemplars` array for each product in the shipment
+// If you have multiple identical products in a shipment, specify one `product_id` and exemplars array for each product in the shipment.
 //
-// # Always pass a complete set of product items data
+// Always pass a complete set of product items data.
 //
 // For example, you have 10 product items in your system.
-// You have passed them for checking and saving. Then they added another 60 product items to your system.
+// You've passed them for checking and saving.
-// When you pass product items for checking and saving again, pass all of them: both old and newly added
+// Then you added another 60 product items to your system.
+// When you pass product items for checking and saving again, pass all of them: both old and newly added.
 func (c FBS) CheckProductItemsData(ctx context.Context, params *CheckProductItemsDataParams) (*CheckProductItemsDataResponse, error) {
 	url := "/v4/fbs/posting/product/exemplar/set"
 
@@ -1996,8 +2057,8 @@ type PartialPackOrderParams struct {
 }
 
 type PartialPackOrderProduct struct {
-	// Data array on product items
+	// Product item identifiers
-	ExemplarInfo []FBSProductExemplar `json:"exemplar_info"`
+	ExemplarIds []string `json:"exemplarIds"`
 
 	// FBS product identifier in the Ozon system, SKU
 	ProductId int64 `json:"product_id"`
@@ -2009,11 +2070,8 @@ type PartialPackOrderProduct struct {
 type PartialPackOrderResponse struct {
 	core.CommonResponse
 
-	// Additional data about shipments
+	// Shipments numbers formed after packaging
-	AdditionalData []PartialPackOrderAdditionalData `json:"additional_data"`
+	Result string `json:"result"`
-
-	// Identifiers of shipments that were created after package
-	Result []string `json:"result"`
 }
 
 type PartialPackOrderAdditionalData struct {
@@ -2029,7 +2087,7 @@ type PartialPackOrderAdditionalData struct {
 //
 // The status of the original shipment will only change when the split shipments status changes
 func (c FBS) PartialPackOrder(ctx context.Context, params *PartialPackOrderParams) (*PartialPackOrderResponse, error) {
-	url := "/v3/posting/fbs/ship/package"
+	url := "/v4/posting/fbs/ship/package"
 
 	resp := &PartialPackOrderResponse{}
 
@@ -2791,3 +2849,36 @@ func (c FBS) GetActPDF(ctx context.Context, params *GetActPDFParams) (*GetActPDF
 
 	return resp, nil
 }
+
+type CreateOrGetProductExemplarParams struct {
+	// Shipment number
+	PostingNumber string `json:"posting_number"`
+}
+
+type CreateOrGetProductExemplarResponse struct {
+	core.CommonResponse
+
+	// Quantity of boxes the product is packed in
+	MultiBoxQuantity int32 `json:"multi_box_qty"`
+
+	// Shipment number
+	PostingNumber string `json:"posting_number"`
+
+	// Product list
+	Products []CheckProductItemsDataProduct `json:"products"`
+}
+
+// Method returns the created items data passed in the `/v5/fbs/posting/product/exemplar/set` method.
+func (c FBS) CreateOrGetProductExemplar(ctx context.Context, params *CreateOrGetProductExemplarParams) (*CreateOrGetProductExemplarResponse, error) {
+	url := "/v5/fbs/posting/product/exemplar/create-or-get"
+
+	resp := &CreateOrGetProductExemplarResponse{}
+
+	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
+}

ozon/fbs_test.go

@@ -1395,15 +1395,27 @@ func TestCheckProductItemsData(t *testing.T) {
 			http.StatusOK,
 			map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
 			&CheckProductItemsDataParams{
-				PostingNumber: "48173252-0034-4",
+				MultiBoxQuantity: 0,
-				Products: CheckProductItemsDataProduct{
+				PostingNumber:    "1234",
-					Exemplars: []FBSProductExemplar{
+				Products: []CheckProductItemsDataProduct{
-						{
+					{
-							IsGTDAbsest:   true,
+						Exemplars: []CheckProductItemsDataProductExemplar{
-							MandatoryMark: "010290000151642731tVMohkbfFgunB",
+							{
+								ExemplarId:    1,
+								GTD:           "string",
+								IsGTDAbsent:   true,
+								IsRNPTAbsent:  true,
+								MandatoryMark: "string",
+								RNPT:          "string",
+								JWUIN:         "string",
+							},
 						},
+						IsGTDNeeded:           true,
+						IsMandatoryMarkNeeded: true,
+						IsRNPTNeeded:          true,
+						ProductId:             22,
+						Quantity:              11,
 					},
-					ProductId: 476925391,
 				},
 			},
 			`{
@@ -1784,22 +1796,15 @@ func TestPartialPackOrder(t *testing.T) {
 				PostingNumber: "48173252-0034-4",
 				Products: []PartialPackOrderProduct{
 					{
-						ExemplarInfo: []FBSProductExemplar{
+						ExemplarIds: []string{"string"},
-							{
+						ProductId:   247508873,
-								MandatoryMark: "mark",
+						Quantity:    1,
-								GTD:           "gtd",
-								IsGTDAbsest:   true,
-							},
-						},
-						ProductId: 247508873,
-						Quantity:  1,
 					},
 				},
 			},
-			`{
+			`
-				"result": [
+			{
-				  "48173252-0034-9"
+				"result": "48173252-0034-9"
-				]
 			}`,
 		},
 		// Test No Client-Id or Api-Key
@@ -2843,3 +2848,74 @@ func TestGetActPDF(t *testing.T) {
 		}
 	}
 }
+
+func TestCreateOrGetProductExemplar(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		statusCode int
+		headers    map[string]string
+		params     *CreateOrGetProductExemplarParams
+		response   string
+	}{
+		// Test Ok
+		{
+			http.StatusOK,
+			map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"},
+			&CreateOrGetProductExemplarParams{
+				PostingNumber: "string",
+			},
+			`{
+				"multi_box_qty": 0,
+				"posting_number": "string",
+				"products": [
+				  {
+					"exemplars": [
+					  {
+						"exemplar_id": 0,
+						"gtd": "string",
+						"is_gtd_absent": true,
+						"is_rnpt_absent": true,
+						"mandatory_mark": "string",
+						"rnpt": "string",
+						"jw_uin": "string"
+					  }
+					],
+					"is_gtd_needed": true,
+					"is_mandatory_mark_needed": true,
+					"is_rnpt_needed": true,
+					"product_id": 0,
+					"quantity": 0
+				  }
+				]
+			}`,
+		},
+		// Test No Client-Id or Api-Key
+		{
+			http.StatusUnauthorized,
+			map[string]string{},
+			&CreateOrGetProductExemplarParams{},
+			`{
+				"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().CreateOrGetProductExemplar(ctx, test.params)
+		if err != nil {
+			t.Error(err)
+			continue
+		}
+
+		compareJsonResponse(t, test.response, &CreateOrGetProductExemplarResponse{})
+
+		if resp.StatusCode != test.statusCode {
+			t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode)
+		}
+	}
+}

ozon/ozon.go

@@ -10,6 +10,15 @@ const (
 	DefaultAPIBaseUrl = "https://api-seller.ozon.ru"
 )
 
+type ClientOptions struct {
+	client core.HttpClient
+
+	baseUri string
+
+	apiKey   string
+	clientId string
+}
+
 type Client struct {
 	client *core.Client
 
@@ -110,10 +119,46 @@ func (c Client) Barcodes() *Barcodes {
 	return c.barcodes
 }
 
-func NewClient(httpClient core.HttpClient, clientId, apiKey string) *Client {
+type ClientOption func(c *ClientOptions)
-	coreClient := core.NewClient(httpClient, DefaultAPIBaseUrl, map[string]string{
+
-		"Client-Id": clientId,
+func WithHttpClient(httpClient core.HttpClient) ClientOption {
-		"Api-Key":   apiKey,
+	return func(c *ClientOptions) {
+		c.client = httpClient
+	}
+}
+
+func WithURI(uri string) ClientOption {
+	return func(c *ClientOptions) {
+		c.baseUri = uri
+	}
+}
+
+func WithClientId(clientId string) ClientOption {
+	return func(c *ClientOptions) {
+		c.clientId = clientId
+	}
+}
+
+func WithAPIKey(apiKey string) ClientOption {
+	return func(c *ClientOptions) {
+		c.apiKey = apiKey
+	}
+}
+
+func NewClient(opts ...ClientOption) *Client {
+	// default values
+	options := &ClientOptions{
+		client:  http.DefaultClient,
+		baseUri: DefaultAPIBaseUrl,
+	}
+
+	for _, opt := range opts {
+		opt(options)
+	}
+
+	coreClient := core.NewClient(options.client, options.baseUri, map[string]string{
+		"Client-Id": options.clientId,
+		"Api-Key":   options.apiKey,
 	})
 
 	return &Client{

ozon/ozon_test.go

@@ -0,0 +1,27 @@
+package ozon
+
+import (
+	"net/http"
+	"testing"
+)
+
+const (
+	apiKey   = "some_key"
+	clientId = "some_client_id"
+)
+
+func TestNewClient(t *testing.T) {
+	client := NewClient(
+		WithAPIKey(apiKey),
+		WithClientId(clientId),
+		WithURI(DefaultAPIBaseUrl),
+		WithHttpClient(http.DefaultClient),
+	)
+
+	if client.client.Options["Api-Key"] != apiKey {
+		t.Errorf("expected api key: %s, but got: %s", apiKey, client.client.Options["Api-Key"])
+	}
+	if client.client.Options["Client-Id"] != clientId {
+		t.Errorf("expected client id: %s, but got: %s", clientId, client.client.Options["Client-Id"])
+	}
+}

ozon/products.go

@@ -130,6 +130,9 @@ type ProductDetails struct {
 	// Category identifier
 	DescriptionCategoryId int64 `json:"description_category_id"`
 
+	// Product type identifier
+	TypeId int64 `json:"type_id"`
+
 	// Marketing color
 	ColorImage string `json:"color_image"`
 
@@ -888,7 +891,7 @@ type CreateOrUpdateProductResult struct {
 
 // This method allows you to create products and update their details
 func (c Products) CreateOrUpdateProduct(ctx context.Context, params *CreateOrUpdateProductParams) (*CreateOrUpdateProductResponse, error) {
-	url := "/v2/product/import"
+	url := "/v3/product/import"
 
 	resp := &CreateOrUpdateProductResponse{}
 

ozon/products_test.go

@@ -127,7 +127,7 @@ func TestGetProductDetails(t *testing.T) {
 					"7533900005"
 				  ],
 				  "buybox_price": "",
-				  "description_category_id": 17038062,
+				  "type_id": 0,
 				  "created_at": "2021-10-21T15:48:03.529178Z",
 				  "images": [
 					"https://cdn1.ozone.ru/s3/multimedia-5/6088931525.jpg",
@@ -141,6 +141,7 @@ func TestGetProductDetails(t *testing.T) {
 					"reserved": 0
 				  },
 				  "currency_code": "RUB",
+				  "description_category_id": 12,
 				  "marketing_price": "",
 				  "min_price": "",
 				  "old_price": "",
@@ -1378,6 +1379,7 @@ func TestListProductsByIDs(t *testing.T) {
 					  ],
 					  "buybox_price": "",
 					  "description_category_id": 93726157,
+					  "type_id": 0,
 					  "created_at": "2021-06-03T03:40:05.871465Z",
 					  "images": [],
 					  "has_discounted_item": true,
@@ -1420,7 +1422,24 @@ func TestListProductsByIDs(t *testing.T) {
 						"active_product": false,
 						"reasons": {}
 					  },
-					  "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
+						}
+					  },
 					  "images360": [],
 					  "is_kgt": false,
 					  "color_image": "",