Product Creation - createProducts()

Product Creation

The createProducts method on the Horoz Logistics E-Export Integration should be used to define the products that will be used in the order creation step in the Horoz system to the Horoz Logistics system. Important information about the createProduct() method and the things to be considered when creating products in the Horoz Logistics system are listed below for the information of clients.

createProduct() method is a RESFtul web service method that receives data in JSON format with POST method.
When sending a product definition to the Horoz system with the createProduct() method, the information about the product must be passed to the body of the method in JSON data type. The processKey information of the client must be passed to the header part of the method in parameter type. The submission made with the createProduct() method must be encoded as UTF-8 and transmitted to Horoz Logistics E-Export Integration Web service.
While defining the products into the system, they must be defined with the product code, product name, product group selection and size information provided by HOROZ, as provided in the seller's definitions. An order is placed for such defined products by entering the product code or name and the quantity values in the order at the time of order entry.
The products entered with this method do not have a deletion feature. The updateProduct method must be used in order to correct the product descriptions, especially those whose size information has been entered incorrectly by the seller.
The singularity is checked based on the seller and product code information defined in the system. The same product may not be added to the system twice.
While defining the products, especially the mixed parcel needs, which are required in the content of the order, must be defined into the system by the seller before any order is entered by means of this method. While performing this definition, the product code and product name may be determined by the seller, by taking into account the singularity approach, since it is a mixed parcel.The transport parcels may be created and used based on the needs in the manner of PRODUCT CODE: PARCEL1, PRODUCT NAME: VOLUMETRIC WEIGHT OF 50 PARCELS; PRODUCT CODE: PARCEL2, PRODUCT NAME: VOLUMETRIC WEIGHT OF 100 PARCELS”. In this usage, while entering the order, the number of products, which will be included in the parcels, must be entered as the total sales quantity at the time of order entry.
Product descriptions require information such as the number of containers and parcels, which directly affects the order, and which is especially effective in the formation of ETGB. This is determined by the type to be selected in product definitions while adding the products to the system. Types are Normal product, Component Product and Bulk product. Normal product 1 container represents 1 piece, e.g. a television. The number of containers on the ETGB must be the same as the sales quantity selected when entering the order.
The component product is especially valid for the furniture, and it must be used for the types, in which all parts of the furniture will be entered in order to include the disassembled components of the furniture on the ETGB in terms of container quantity and to determine the total volume and weight of the product. For example, any wardrobe sold is added to the orders as a wardrobe with a sales quantity. However, the components for the wardrobe (door, shelf, drawer, upper-lower table) are added to the ETGB and order details based on the value entered into the system as the number of containers. Bulk product, which means mixed parcel, covers the situations in which the sellers mostly ship the fragmented products as a single parcel. E.g. creation of a 50-desi parcel containing shirts and socks. Here, the sales numbers of shirts and socks represent the number of goods and the number of 50-desi parcel containers used.

PRODUCT TYPE	PRODUCT NAME	NUMBER OF ITEMS	NUMBER OF CONTAINERS
NORMAL PRODUCT	TELEVISION	1 pc	1 pc
COMPONENT PRODUCT	WARDROBE	1 pc	1.Door, 2.Shelf, 3.Drawer, 4.Top tray- 5. Lower tray (5 pieces in total)
BULK PRODUCT	MIXED PARCEL	30 Socks, 20 Shirts (50 pieces in total)	1 pc

Although there are several different types of barcodes, the EAN symbol is a 12 or 13 digit product identification code. Each EAN uniquely identifies the product, manufacturer and its attributes; typically, the EAN is printed as a barcode on a product label 14 or packaging. An EAN code is a unique combination of digits used to identify an object on the basis of a European system. ('EAN' stands for 'The European Article Number')
Log code is the code that represents the version of the product available on the production line included in the EAN code.
to be ordered in the Horoz system. For clients, who will be involved in E-Export integration, it is essential to define the product before order placement processes.
As a parameter, the createProduct method receives the values of productCode, productName, productGroupName width, length, height, gross, netKg, desi, ean, logCode, packageType, stackStatus containerDefination as POST method in JSON format. In return, it returns the "responseCode", "responseMessage" and "productId" information to the client, and it reports the success/failure of the registration process.
The product definitions may be used as product definitions for single products within the order data. (Product code, Product name) The component product must be sent with the master record representing the product. (Ivory Children's Wardrobe) It is required to order the number of containers multiplied by the number of units sold and the number of pieces it has. The bulk product is sent to the system with the master record defined (parcel of 50). The sales quantity and physical container quantity may optionally be entered in the order values. (Parcel of 50 = 1 Sales Quantity= 20 Socks, 40 Shirts, etc.)

POST createProducts()

ENDPOINT

http://b2btest.horoz.com.tr:7801/eexport_test/v1/createProducts

Parameter Descriptions & Rules

The following table shows the input and output parameters of the createProducts() operation and their The types and formats of the parameters are listed.

Fields
Example Request
Example Response

PARAMETER	DESCRIPTION	DATA TYPE	LENGTH	FIELD LOCATION	REQUIRMENT
`processKey`	`processKey` information defined for the client	string	100	Header	Mandatory
`productCode`	Product code information	string	100	inBody Request	Mandatory
`productName`	Product name information	string	500	inBody Request	Mandatory
`productGroupName`	Product group code information	string	10	inBody Request	Mandatory
`productDetail`	Product details string	array	-	inBody Request	-
`width`	Width	float	-	inBody Request	Mandatory
`length`	length	float	-	inBody Request	Mandatory
`heigth`	heigth	float	-	inBody Request	Mandatory
`gross`	Gross Weight	float	-	inBody Request	Mandatory
`netKg`	Net Weight	float	-	inBody Request	Mandatory
`desi`	Desi	float	-	inBody Request	Optional
`ean`	Product EAN code	string	13	inBody Request	Optional
`logCode`	Product log code	string	7	inBody Request	Mandatory
`packageType`	Package type	string	100	inBody Request	Mandatory
`stackStatus`	Stack Status	boolean	-	inBody Request	Mandatory
`containerDefination`	Container definition	string	15	inBody Request	Mandatory

{
  "productCode": "TV10010",
  "productName": "TELEVİZYON",
  "productGroupName": "MOBİLYA",
  "productDetail": [
    {
      "width": 20,
      "length": 100,
      "height": 60,
      "gross": 20,
      "netKg": 20,
      "desi": 40
    }
  ],
  "ean": null,
  "logCode": null,
  "packageType": "KOLI",
  "stackStatus": "true",
  "containerDefination": "NORMAL ÜRÜN"
}

{
  "response": {
    "responseCode": "STA-100",
    "responseMessage": "Basarili",
    "createProductResponse": [
      {
        "productId": 10557
      }
    ]
  }
}

Any further information about the enum values expected in the createProduct() method is provided as follows.

ENUM FIELD	FIELD NAME	DESCRIPTION
productGroupName	Product group name	The productGroupName information, which obtained from the response returned from the `listProductGroups()` method, and which is appropriate for the product definition, must be entered as correct and UPPERCASE.
packageType	Package type	Package type may be declared by entering the appropriate value for the product definition among the values PALLET, CONTAINER, FILE, PARCEL.
containerDefination	Container definition	Container definition may be declared by entering the appropriate value for the product definition among the values NORMAL PRODUCT, BULK PRODUCT, COMPONENT PRODUCT.

The COMPONENT PRODUCT product notification, which is among the information to be entered in the containerDefinition information, refers to the product notification to be served for the products, which have the components, unlike the NORMAL PRODUCT and BULK PRODUCT notification. A WARDROBE, which may contain multiple component products, may be provided as an example for the COMPONENT PRODUCT notification.

While notifying the Horoz system of a COMPONENT PRODUCT, the containerDefination should be entered as COMPONENT PRODUCT, and the width, length, height, gross, netKg and desi information about the components of the product should be entered on a component basis in the productDetail array within the request. containerDefination : The BULK PRODUCT or containerDefination: For product notifications, which are NORMAL PRODUCT, the width, length, height, gross, netKg and desi information about only one product should be entered in the productDetail array. Each component available in a record containing multiple components in productDetail of the component product to be sent to the Horoz system means a product in the Horoz system.

For components recorded as products in the system, the product name and product code information is created by adding - 1, - 2.. to the end of the master product name and master product code information. During the component product creation phase, the productId, which is returned within the response, is the id information about the master product information regarding the component product.