Contents x
    Add products to a shortform
      • Print
      Contents

      Add products to a shortform

        • Print
        Article summary

        Post
        /v2/{accessKey}/shortform/{shortformId}/product
        Header parameters
        Authorization
        stringRequired

        Authorization: Bearer

        Path parameters
        accessKey
        stringRequired

        Customer access key

        shortformId
        stringRequired

        shortform id

        Body parameters
        example

        Example of Body

        [
  {
    "productId": 207426
  }
]
        Expand All
        items
        object
        productId
        integer (int64)

        Automatically generated unique product ID

        customerProductId
        string

        Customer's product ID and must be unique(defined by the customer).

        Responses
        200

        200

        Result
        "{\n    \"results\": [\n        {\n            \"productId\": \"1234\",\n            \"message\": null,\n            \"status\": \"SUCCESS\"\n        },\n        {\n            \"productId\": \"1235\",\n            \"message\": \"The product is already registered.\",\n            \"status\": \"FAIL\"\n        }\n    ],\n    \"successCount\": 1,\n    \"warnCount\": 0,\n    \"failCount\": 1,\n    \"totalCount\": 2\n}"
        Expand All
        object
        results
        Array of object
        object
        productId
        string
        Example1234
        message
        status
        string
        ExampleSUCCESS
        successCount
        integer
        Default0
        Example1
        warnCount
        integer
        Default0
        Example0
        failCount
        integer
        Default0
        Example1
        totalCount
        integer
        Default0
        Example2
        4XX

        4XX

        Result
        "{\n    \"_s\": -000,\n    \"_e\": \"Error message\"\n}"
        What's Next