Get a Product by ProductCode

GET

https://api.gofive.co.th/v2/products/{productCode}

การแสดงสินค้าโดยใช้ productCode

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

productCode

string

required

รหัสสินค้า

Header Params

Ocp-Apim-Subscription-Key

string

required

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

Example:

<Your-Subscription-Key>

Content-Type

string

required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.gofive.co.th/v2/products/' \
--header 'Ocp-Apim-Subscription-Key: <Your-Subscription-Key>' \
--header 'Content-Type: application/json'

Responses

🟢200OK

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

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

optional

ต้นทุนสินค้า [ระบบจะไม่ 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 | null

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 = ไม่ใช้งาน]

Example

{
  "status": {
    "code": "1000",
    "description": "Success"
  },
  "data": {
    "productCode": "OSP100",
    "productBarcode": "",
    "productName": "Singel Open API-2",
    "productDescription": "Open API Test",
    "category": "Open API",
    "cost": 10,
    "prices": [
      {
        "priceTierName": "Normal Price",
        "regularPrice": 5000,
        "salePrice": 2500,
        "vatValue": 7,
        "useDefaultVat": false
      }
    ],
    "productUnitName": "API",
    "productTag": [],
    "productImage": [
      "https://i.postimg.cc/8zj5pZf8/Ea-Ix-XP-VAAY2-K8-X.jpg"
    ],
    "trackInventory": true,
    "qty": 90,
    "lowStockAlert": 10,
    "useWarranty": false,
    "visibility": true,
    "active": true
  }
}

🟠401Unauthorized

🟠400Bad Request

Modified at 2023-02-06 08:25:06

Get Products With Take & Status

Get Product Groups