Product Update - updateProduct()

Product Update

The updateProduct method on the Horoz Logistics E-Export Integration platform should be used to update the details of products previously defined in the Horoz system for use in the order creation step. Important information about the updateProduct() method and considerations when querying road shipment cargo statuses in the Horoz system are listed below for the clients' reference.

• updateProduct() is a RESTful web service method that accepts data in JSON format using the POST method.

• When using the updateProduct() method to update product information in the Horoz system, the relevant product details should be passed in the method's body as JSON. The processKey information specific to the client should be passed as a parameter in the header. Requests sent using the updateProduct() method must be encoded as UTF-8 and transmitted to the Horoz Logistics E-Export Integration Web Service.

• The updateProduct() method is specifically designed for correcting dimension information for product definitions entered incorrectly by the seller.

• In addition to updating dimension information, the updateProduct() method can update the container definition and change the product type from NORMAL and/or BULK PRODUCT to COMPONENT PRODUCT. The reverse transformation is also possible.

• The updateProduct() method is a web service method used to update the Horoz system's information for products that have already been registered in the system and will be included in orders.

• The updateProduct() method accepts the following parameters as a POST request in JSON format: productId, productCode, productName, productGroupName, width, length, height, gross, netKg, desi, ean, logCode, packageType, stackStatus, containerDefination.

• The response includes responseCode and responseMessage to notify the client about the success/failure of the update operation. Product updates cannot be performed for products already used in an order.

---

POST updateProduct()

ENDPOINT

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

Parameter Descriptions & Rules

The table below lists the input and output parameters for the updateProduct() operation along with their types and formats.

Fields

PARAMETER	DESCRIPTION	DATA TYPE	LENGTH	FIELD LOCATION	REQUIRMENT
processKey	processKey information defined for the client	string	100	Header	Mandatory
productId	Product Id information	Integer	-	inBody Request	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 – is the field of the productDetail array.	Float	-	inBody Request	Mandatory
length	Length – is the field of the productDetail array.	Float	-	inBody Request	Mandatory
height	Height – is the field of the productDetail array.	Float	-	inBody Request	Mandatory
gross	Gross Weight – is the field of the productDetail array.	Float	-	inBody Request	Mandatory
netKg	Net Weight – is the field of the productDetail array.	Float	-	inBody Request	Mandatory
desi	Desi – is the field of the productDetail array.	Float	-	inBody Request	Mandatory
ean	Product EAN code	string	13	inBody Request	Optional
logCode	Product log code	string	7	inBody Request	Optional
packageType	Package type	string	100	inBody Request	Mandatory
stackStatus	Stack Status	Boolean	-	inBody Request	Mandatory
containerDefination	Container definition	string	15	inBody Request	Mandatory

Example Request

  {
    "productId": 10545,
    "productCode": "KGN5618",
    "productName": "BEYAZ GARDIROP",
    "productGroupName": "MOBİLYA",
    "productDetail": [
      {
        "width": 10.2,
        "length": 10.2,
        "height": 10.2,
        "gross": 100.2,
        "netKg": 100.2,
        "desi": 55
      },
      {
        "width": 10.2,
        "length": 10.2,
        "height": 10.2,
        "gross": 100.2,
        "netKg": 100.2,
        "desi": 55
      }
    ],
    "ean": "123456",
    "logCode": "654321",
    "packageType": "PALET",
    "stackStatus": false,
    "containerDefination": "BİLEŞENLİ ÜRÜN"
  }

Example Response

  {
    "response": {
      "responseCode": "STA-100",
      "responseMessage": "Basarili",
      "updateProductResponse": [
        {
          "productId": 10565
        }
      ]
    }
  }

The expected enum values within the updateProduct() method are detailed below.

ENUM FIELD	FIELD NAME	DESCRIPTION
productGroupName	Product gorup 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.

---

Service Responses

You can access the successful/unsuccessful service responses here.