Create Or Update Products - Gofive OpenAPI

สร้างและ แก้ไขสินค้า

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Content-Type

string

required

Example:

application/json

Ocp-Apim-Subscription-Key

string

required

รหัส subscription key ลูกค้า

Example:

Body Params application/json

products

array [object {25}]

required

productCode

string

required

รหัสสินค้า [ไม่ต้องกรอก ถ้าเป็น multi-SKU]

productBarcode

string

optional

รหัสบาร์โค้ด

productName

string

required

ชื่อสินค้า

productDescription

string

optional

รายละเอียดสินค้า

category

string

required

หมวดหมู่หลัก [ถ้ามีการส่งข้อมูลมาไม่ตรงกับระบบ ทางระบบจะทำการสร้าง Category ให้]

subCategory

string

optional

หมวดหมู่รอง [ถ้ามีการส่งข้อมูลมาไม่ตรงกับระบบ ทางระบบจะทำการสร้าง Category ให้]

sub_SubCategory

string

optional

หมวดหมู่ย่อย [ถ้ามีการส่งข้อมูลมาไม่ตรงกับระบบ ทางระบบจะทำการสร้าง Category ให้]

cost

number

required

ต้นทุนสินค้า [ระบบจะไม่ Required และไม่สนใจ ถ้าเป็น Multi SKU]

prices

array [object {5}]

required

รายการรายละเอียดราคาสินค้า

productUnitName

string

required

หน่วยสินค้า [ถ้าใส่ค่า Unit ไม่ตรงกับระบบ จะแสดง error]

productWeight

number

optional

น้ำหนักสินค้า

productWeightUnit

string

optional

หน่วยน้ำหนักสินค้า [ระบบ Default ให้ มี "gram" , "kilogram"]

productTag

array[string]

optional

ป้ายกำกับสินค้า [ถ้าไม่ตรงกับในระบบ จะสร้าง productTag ให้ใหม่]

productImage

array[string]

optional

รูปสินค้า ให้ส่งเป็น PublicUrl

trackInventory

boolean

required

จัดการข้อมูลคลังสินค้า [true = อนุญาตให้จัดการ , false = ไม่อนุญาตให้จัดการ]

qty

integer

optional

จำนวนสินค้า [เป็นจำนวนสินค้าของ Single Product]

lowStockAlert

integer

optional

แจ้งเตือนเมื่อสต็อกคงเหลือ

useWarranty

boolean

required

การรับประกันสินค้า [true = รับประกัน , false = ไม่รับประกัน]

timeWarrantyValue

integer

optional

ระยะเวลาการรับประกันสินค้า

timeWarrantyUnit

string

optional

หน่วยเวลาการรับประกันสินค้า [y = year ,m = month ,d = day]

warrantyNote

string

optional

บันทึกการรับประกันสินค้า

visibility

boolean

required

true = ทำรายการขายได้ , false = ทำรายการขายไม่ได้]

active

boolean

required

สถานะสินค้า [true = ใช้งาน , false = ไม่ใช้งาน]

productVariant

array [object {11}]

optional

ระบบ Required เมื่อเป็น สินค้า Multi SKU หรือไม่มี Product Code ด้านบน

brandName

string

optional

Example

{
    "products": [
        {
            "productCode": "<string>", // Required if no product sku
            "productBarcode": "<string>",
            "productName": "<string>", // Required
            "productDescription": "<string>",
            "category": "<string>", // Required
            "subCategory": "<string>",
            "sub_SubCategory": "<string>",
            "cost": 0.0, // Required
            "prices": [
                {
                    "priceTierName": "<string>", // Required
                    "regularPrice": 0.0, // Required
                    "salePrice": 0.0,
                    "vatValue": 0.0, 
                    "useDefaultVat" : true
                }
            ], // Required
            "productUnitName": "<string>", // Required
            "productWeight": 0.0,
            "productWeightUnit": "<string>",
            "productTag": ["string"],
            "productImage": [
                "<string>"
            ],
            "trackInventory": true, // Required
            "qty": 0,
            "lowStockAlert": 0,
            "useWarranty": false, // Required
            "timeWarrantyValue": 0,
            "timeWarrantyUnit": "<string>", // [y = year ,m = month ,d = day]
            "warrantyNote": "<string>",
            "visibility": true, // Required
            "active": true, // Required
            "brandName": "<string>",
            "productVariant": [
                {
                    "productCode": "<string>", // Required
                    "productName": "<string>", // Required
                    "productBarcode": "<string>",
                    "productDescription": "<string>",
                    "cost": 0.0,
                    "prices": [
                        {
                            "priceTierName": "<string>",
                            "regularPrice": 0.0,
                            "salePrice": 0.0,
                            "vat": 0.0
                        }
                    ], // Required
                    "productImage": [
                        "<string>"
                    ],
                    "qty": 0,
                    "lowStockAlert": 0,
                    "active": "<boolean>", // Required
                    "attribute": [
                        {
                            "attributeName": "<string>", // Required
                            "attributeValueName": "<string>" // Required
                        }
                    ] // Required
                }
            ]
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.gofive.co.th/v3/Products' \
--header 'Ocp-Apim-Subscription-Key: <Your Subscription-Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "products": [
        {
            "productCode": "<string>", // Required if no product sku
            "productBarcode": "<string>",
            "productName": "<string>", // Required
            "productDescription": "<string>",
            "category": "<string>", // Required
            "subCategory": "<string>",
            "sub_SubCategory": "<string>",
            "cost": 0.0, // Required
            "prices": [
                {
                    "priceTierName": "<string>", // Required
                    "regularPrice": 0.0, // Required
                    "salePrice": 0.0,
                    "vatValue": 0.0, 
                    "useDefaultVat" : true
                }
            ], // Required
            "productUnitName": "<string>", // Required
            "productWeight": 0.0,
            "productWeightUnit": "<string>",
            "productTag": ["string"],
            "productImage": [
                "<string>"
            ],
            "trackInventory": true, // Required
            "qty": 0,
            "lowStockAlert": 0,
            "useWarranty": false, // Required
            "timeWarrantyValue": 0,
            "timeWarrantyUnit": "<string>", // [y = year ,m = month ,d = day]
            "warrantyNote": "<string>",
            "visibility": true, // Required
            "active": true, // Required
            "brandName": "<string>",
            "productVariant": [
                {
                    "productCode": "<string>", // Required
                    "productName": "<string>", // Required
                    "productBarcode": "<string>",
                    "productDescription": "<string>",
                    "cost": 0.0,
                    "prices": [
                        {
                            "priceTierName": "<string>",
                            "regularPrice": 0.0,
                            "salePrice": 0.0,
                            "vat": 0.0
                        }
                    ], // Required
                    "productImage": [
                        "<string>"
                    ],
                    "qty": 0,
                    "lowStockAlert": 0,
                    "active": "<boolean>", // Required
                    "attribute": [
                        {
                            "attributeName": "<string>", // Required
                            "attributeValueName": "<string>" // Required
                        }
                    ] // Required
                }
            ]
        }
    ]
}'

Responses

🟢200Success

application/json

Body

status

object

required

code

string

required

สถานะของ Business Code ถ้า
Success = 1000
Error 1 ตัว = 4001
Error มากกว่า 1 ตัว = 4002
หรือเป็น Subcode ที่ต้องการจะแสดงเพื่อสื่อความหมายของ Error โดย subcode จะเป็นตัวเดียวกับ business error code หรือไม่ก็ได้ เพื่อความสะดวกในการแสดงผล

description

string

required

คำอธิบายข้อความที่จะแสดง

data

object

required

ticketId

integer

required

เลขที่ตั๋ว

Example

{
    "status": {
        "code": "1000",
        "description": "Success"
    },
    "data": {
        "ticketId": 284
    }
}

🟠401Unauthorized

🟠400Bad Request

🔴500Server Error

🟠401User authentication required V2.