Gofive OpenAPI
empeoVenioeTaxGo
empeoVenioeTaxGo
  1. Product
  • Introduction
  • Activity
    • Get a Activity
      GET
    • Activities Enquiry
      POST
  • Authentication API
    • Authorization
      POST
  • Customer
    • Create or Update customer
      POST
    • Get a Customer By CustomerCode
      GET
    • Customers Enquiry
      POST
    • Get a Customer By CustomerName
      GET
    • Create Customer Satisfaction
      POST
    • Add Customer Event
      POST
    • Get Customer Events by Customer Code
      GET
    • Edit Customer Event
      PUT
    • Delete Customer Event
      DELETE
    • Get Customer Event Types
      GET
  • Case
    • Add Case
    • Edit Case by CaseNo
    • Get Case by CaseNo
    • Get Case Categories
  • Deal
    • Create Deal
    • Update Deal
    • Deal Enquiry
    • Get Deal
    • Get Deal Board
    • Get Deal Stage
    • Get Deal Interest
    • Get DealLabel
    • Get Deal Missed Reason Categories
  • Employee
    • Employees Enquiry
    • Get a Employee
  • Expense
    • Create Expense
    • Update Expense
    • Expense Enquiry
    • Get a Expense
  • Product
    • Create Or Update Products
      POST
    • Get a Product Ticket
      GET
    • Get Products With Take & Status
      POST
    • Get a Product by ProductCode
      GET
    • Get Product Groups
      GET
    • Get Product Properties
      GET
    • Get Products By Filter
      POST
    • Verify Serial Number
      POST
    • /v3/Products/serials/status
      GET
    • Create or Update Codeguard Products
      POST
    • Update Product Stock
      PUT
    • /v1/products/units
      GET
    • /v1/products/units Copy
      GET
  • Quotation
    • Create Update Quotation
    • Convert Quotation To SalesOrder
    • Quotation Enquiry
    • Get a Quotation By QuotationNo
    • Cancel Quotation
  • SalesOrder
    • Create Or Update SalesOrder
    • Get a SalesOrders By Id
    • Get a SalesOrder By SalesOrderNo
    • Get Sale Order Attachment
    • Reject SaleOrder
    • Approve Sale Order
    • Update SalesOrder Payment
  • Webhooks
    • Webhook Payload
  • Task
    • CreateTask
  • Setting
    • Get HeaderTemplate
  1. Product

Get Products By Filter

POST
https://api.gofive.co.th/v1/products/getProduct
ดึงข้อมูล product โดยการ filter

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:
<Your-Subscription-Key>
Body Params application/json
productType
integer 
required
ประเภทสินค้า
Product = 1301
Bundle = 1302
productFor
string  | null 
optional
สินค้าสำหรับ
typeFor
integer  | null 
optional
null = all
1 = for sale
2 = for inventory
none
productGroupIds
array[integer] | null 
optional
รายการรหัสกลุ่มสินค้า
status
array[integer]
required
สถานะ
skip
integer 
optional
จำนวนรายการที่ข้าม
take
integer 
required
จำนวนรายการที่ต้องการแสดง
smartSearch
string  | null 
optional
คำค้นหา
orderBy
string  | null 
optional
จัดเรียงตาม
Example
{
  "productFor": "string",
  "typeFor": 0,
  "productType": 1031,
  "productGroupIds": [
    0
  ],
  "status": [
    true
  ],
  "skip": 0,
  "take": 0,
  "smartSearch": "string",
  "orderBy": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.gofive.co.th/v1/products/getProduct' \
--header 'Ocp-Apim-Subscription-Key: <Your-Subscription-Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productFor": "string",
    "typeFor": 0,
    "productType": 1031,
    "productGroupIds": [
        0
    ],
    "status": [
        true
    ],
    "skip": 0,
    "take": 0,
    "smartSearch": "string",
    "orderBy": "string"
}'

Responses

🟢200OK
application/json
Body
statusCode
integer 
required

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

httpStatusCode
integer 
required
สถานะ code ของ httpเช่น
200 Ok
201 Created
400 BadRequest
401 Unauthorized
404 Record not found
500 Internal Server Error
data
object 
required
value
array [object {18}] 
required
statusCode
integer 
required
สถานะ code ของ httpเช่น
200 Ok
201 Created
400 BadRequest
401 Unauthorized
404 Record not found
500 Internal Server Error
Example
{
  "data": {
    "value": [
      {
        "productId": 0,
        "productType": 1031,
        "productCode": "string",
        "groupId": 20,
        "groupName": "string",
        "productName": "string",
        "qty": 1,
        "price": 10,
        "companyId": 0,
        "unitId": 2,
        "unitName": "กล่อง",
        "notes": "string",
        "isForInventory": true,
        "isForPurchase": true,
        "isActive": true,
        "productValues": [],
        "attachments": [
          {
            "attachmentId": 1,
            "refId": 1,
            "type": 40007,
            "filename": "string",
            "extension": "image/jpeg",
            "fileSize": 1,
            "isActive": true,
            "createdByUserId": "string",
            "dateCreated": "2021-09-15T10:04:42+0700",
            "resourceUrl": "string",
            "companyId": 1015,
            "url": "string",
            "urlResponseUpload": "string",
            "thumbnail": "string"
          }
        ]
      }
    ],
    "statusCode": 200
  },
  "statusCode": 1000,
  "httpStatusCode": 200
}
🟠401Unauthorized
🟠400Bad Request
🟠403Forbidden
Modified at 2023-02-01 06:34:29
Previous
Get Product Properties
Next
Verify Serial Number
Built with