Search product information by page

Created by Yee Sin Lum, Modified on Fri, 17 Jun 2022 at 12:00 AM by Yee Sin Lum

Search product information by page

interface address

hostname/openapi/v1/productOpenApi/queryProductPages

Request header

User-Agent: openApi

Content-Type: application/json; charset=utf-8

Accept-encoding: gzip,deflate

Time-stamp: 1437528688233

Data-signature: BF706E6AC693BA3B1BABD32E6713431D

Request method

POST

Request body

{

     "appId": "abcdefghijklmn",

     "categoryUid": "123456789",

     "postBackParameter": {

          "parameterType": "abcd", taken directly from the returned result

          "parameterValue": "abcd"

     }

}

parameter name

Is it necessary

Types of

Instructions

appId

Yes

String

KYBIO configured access credentials

categoryUid

no

Long

Product category unique identifier, according to product classification query Product

postBackParameter

no

Json

Able to skip at home page, subsequently, content will be obtained from returned results

parameterType

Yes

Json

Obtained from returned results

parameterValue

Yes

String

Obtained from returned results

Return result

{

     "status": "success",

     "messages": [],

     "data":{

          "postBackParameter": {

               "parameterType": "abcd", taken directly from the returned result

               "parameterValue": "abcd"

          },

          "result": [

          {

               "uid": 1366004607492564649,

               "categoryUid": 813701230071893827,

               "name": "Jade cabbage" {

               "barcode": "1001",

               "buyPrice": 10000,

               "sellPrice": 15000,

               "stock": 0,

               "pinyin": "CYBC",

               "customerPrice": 15000,

               "isCustomerDiscount": 1,

               "description": "Dimensions: Length 18.7 centimeters, width 9.1 centimeters, thickness 5.07 centimeters"

          "attribute1":"y",

          "attribute2":"",

          "attribute3":"",

          "attribute4":""

          }

          ],

          "pageSize": 100

     }

}

Field name

Types of

Instructions

Status

String

Whether the request is processed correctly, return success or error, case-insensitive

Messages

String[]

Processing result message

errorCode

Int

Operation process error code, see error code table

pageSize

Int

This query is expected to take the number of records from the inventory. If the length of the result set is less than pageSize, no query is required on the next page.

postBackParameter

Json

The parameter structure of the paging query sent back to the server must be passed back from the second page. If not, each query is the first page.

parameterType

String

Taken directly from the returned result for postback, value cannot be changed

parameterValue

String

Taken directly from the returned result for postback, value cannot be changed

Result

List

Product entity information, field information reference 3

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article