ProductDto รีเฟอเรนซ์
สำหรับนักพัฒนาที่จัดการมาสเตอร์สินค้า(PIM)ของ ReceiptRoller ผ่าน API・MCP・Webhook อธิบายโครงสร้างต่าง ๆ เช่น ข้อมูลสินค้าที่ดึงมาจาก POS ราคารายร้าน ตัวเลือกย่อย และต้นทุน
ProductDto คือโมเดลมาตรฐานของมาสเตอร์สินค้า(PIM)ของ ReceiptRoller ทั้งสินค้าที่ลงทะเบียนในหน้าจัดการสินค้าของแดชบอร์ดร้านค้า สินค้าที่ซิงก์มาจาก Square Catalog และสินค้าที่นำเข้าด้วย CSV import — ทั้งหมดถูกรวมไว้ในชนิดเดียวนี้
มาสเตอร์สินค้าจัดการในระดับบัญชีธุรกิจ และแชร์ได้กับร้านค้าภายใต้บัญชีนั้น หากต้องการให้แต่ละร้านมีราคาต่างกัน ให้ใช้ StorePricesJson ที่กล่าวถึงด้านล่าง
ฟิลด์หลัก
ตัวระบุ・ข้อมูลพื้นฐาน
| ฟิลด์ | ชนิด | เนื้อหา |
|---|---|---|
OrganizationId | string | ID บัญชีธุรกิจ PartitionKey |
ProductId | string | ID สินค้าภายในของ RR(GUID)RowKey |
ProductName | string | ชื่อสินค้า |
SKU | string | หน่วยจัดการสต็อก(รหัส SKU)เมื่อเชื่อมต่อ Square จะเป็น SKU ของ Variation |
JanCode | string | รหัส JAN(บาร์โค้ด) |
Category | string | ชื่อหมวดหมู่(สตริง)เป็นการจัดหมวดแบบแบน ไม่ใช่โครงสร้างลำดับชั้น |
Brand / Supplier / Description / Unit | string | แบรนด์, ซัพพลายเออร์, คำอธิบาย, หน่วย(ชิ้น・ขวด・kg ฯลฯ) |
ข้อมูลจำเพาะสินค้า
ModelNumber / Series / Color / Size / Weight / ContentVolume / Material / Specification / CountryOfOrigin ทั้งหมดเป็น string และไม่บังคับ ออกแบบมาสำหรับมาสเตอร์สินค้าประเภทสินค้าจับต้องได้
B2B・โลจิสติกส์・พิธีการศุลกากร
CasePackSize(จำนวนต่อลัง), MinimumOrderQuantity, LeadTimeDays, HsCode(รหัส HS), StorageRequirements(เงื่อนไขการจัดเก็บ), Certifications เป็นฟิลด์ส่วนขยายสำหรับธุรกิจที่ทำค้าส่ง・นำเข้าส่งออก
ราคา・ต้นทุน
| ฟิลด์ | ชนิด | เนื้อหา |
|---|---|---|
BasePrice | decimal | ราคาขายไม่รวมภาษี(ราค ามาตรฐาน) |
BaseCostPrice | decimal | ต้นทุน(มาตรฐาน)ข้อมูลพื้นฐานสำหรับการวิเคราะห์กำไร |
TaxRate | decimal | อัตราภาษี ค่าเริ่มต้น 0.10(มาตรฐานญี่ปุ่น) |
StorePricesJson | string (JSON) | การโอเวอร์ไรด์ราคา・ต้นทุนรายร้าน เข้าถึงเป็นอาร์เรย์ได้ด้วยพร็อพเพอร์ตี StorePrices มีเฮลเปอร์ GetPriceForStore(storeId) / GetCostPriceForStore(storeId) |
เฮลเปอร์การคำนวณ:TaxIncludedPrice(ราคารวมภาษี), ProfitMargin(อัตรากำไรขั้นต้น %), MinVariantPrice / MaxVariantPrice(ช่วงราคาเมื่อมีตัวเลือกย่อย)
รูปภาพ
ImageUrl(URL รูปปก)และ ImageUrlsJson(อาร์เรย์ JSON ของแกลเลอรีทั้งหมด)อ่านเป็นอาร์เรย์ได้ด้วยพร็อพเพอร์ตี ImageUrls เพื่อความเข้ากันได้ย้อนหลังกับสินค้าที่มีรูปภาพเดียวแบบเก่า เมื่อ ImageUrlsJson ว่างจะฟอลแบ็กเป็นอาร์เรย์องค์ประกอบเดียวที่มี ImageUrl
ตัวเลือกย่อย
HasVariants(มีตัวเลือกย่อยหรือไม่), VariantOptionsJson(นิยามตัวเลือก เช่น สี・ขนาด), Variants(อาร์เรย์ของ ProductVariantDto)ใช้ในกรณีที่จัดการสี・ขนาดที่ต่างกันเป็นสินค้ารายการเดียว
ฟิลด์สำหรับการเชื่อมต่อ POS
| ฟิลด์ | เนื้อหา |
|---|---|
SquareCatalogObjectId | Item object ID ของ Square Catalog(รูปแบบ #XXXX)ตั้งค่าตอนซิงก์ |
SquareVariationId | Variation object ID ของ Square Catalog เก็บตัวเลือกย่อยแรกไว้ |
พรีออเดอร์・สถานะ・การตรวจสอบ
IsPreOrder, PreOrderReleaseDate, PreOrderNote(วันวางจำหน่าย / หมายเหตุของสินค้าพรีออเดอร์)Status(Active / Discontinued / Draft), SortOrder, InternalMemo, CreatedAt, UpdatedAt
การแมปปิงจาก POS
ข้อมูลสินค้าของแต่ละ POS สอดคล้องกับฟิลด์ใดของ ProductDto นั้น สรุปไว้ในบทความแยกของเฮลป์ร้านค้า โปรดระวังว่ารายการที่แต่ละ POS จัดการได้แตกต่างกันมาก
- การแมปปิงข้อมูลสินค้าของ Square กับข้อมูลสินค้าของ ReceiptRoller — การซิงก์สองทางที่สมบูรณ์ด้วย Catalog API
- การแมปปิงข้อมูลสินค้าของ スマレジ กับข้อมูลสินค้าของ ReceiptRoller — เวอร์ชันปัจจุบันผ่านรายละเอียดธุรกรรมเท่านั้น
ข้อควรทราบ
- คีย์ที่ไม่ซ้ำคือการรวม
OrganizationIdกับProductIdแม้ชื่อสินค้าเดียวกัน หากบัญชีธุรกิจต่างกันก็เป็นคนละสินค้า BaseCostPriceถูกใช้โดยตรงในการคำนวณกำไรของการวิเคราะห์ยอดขาย การอัปเดตค่าไม่ได้เก็บประวัติ ดังนั้นหากจำเป็นต้องมีสแนปช็อตตอนเปลี่ยนต้นทุน ต้องออกแบบเพิ่มต่างหาก(กำลังพิจารณาในกลุ่มการขยายข้อมูลต้นทุน t-e9a2f447)StorePricesJsonเป็นการโอเวอร์ไรด์รายร้าน สำหรับร้านที่ยังไม่ได้ตั้งค่าจะใช้BasePrice/BaseCostPriceตามเดิม- สินค้าที่ดึงมาจาก Square Catalog จะถูกตั้ง
SquareCatalogObjectIdและตอนซิงก์ซ้ำจะเทียบด้วย ID นี้ อย่าเขียนทับด้วยมือ
คู่มือที่เกี่ยวข้อง
- PosTransactionDto รีเฟอเรนซ์ — โมเดลมาตรฐานของธุรกรรม POS
- CrmCustomerDto รีเฟอเรนซ์ — โมเดลมาตรฐานของมาสเตอร์ลูกค้า
- กลับไปที่หน้าแรกเฮลป์สำหรับนักพัฒนา
-
ข้อมูลหลักของสินค้า (PIM) และหมวดหมู่อธิบายโครงสร้างข้อมูลหลักของสินค้า (PIM) หมวดหมู่ และวาเรียนต์ของ ReceiptRoller การดำเนินการแบบ CRUD การจัดการ SKU และรูปแบบการซิงค์กับ EC
-
วิธีใช้ API จัดการสินค้า (Products API)คู่มือสำหรับการดำเนินการ CRUD กับสินค้าภายใต้บัญชีธุรกิจผ่าน API จัดการสินค้าของ ReceiptRoller (/api/v1/products) เป็นบทความเริ่มต้นสำหรับการอ่านและเขียน PIM (มาสเตอร์สินค้า) จากแอป Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์