พจนานุกรมข้อมูลสำหรับการย้ายร้านค้า
พจนานุกรมข้อมูลสำหรับการย้ายร้านค้ามีข้อมูลเกี่ยวกับ REST Admin API Customer
, Order
และทรัพยากรProduct
โดยพจนานุกรมข้อมูลนั้นเป็นข้อมูลอ้างอิงเพิ่มเติมสำหรับพาร์ทเนอร์ที่มีประสบการณ์ซึ่งย้ายร้านค้าไปยัง Shopify
หมายเหตุ: ข้อมูลในพจนานุกรมข้อมูลนั้นได้รับการตรวจสอบยืนยันสำหรับ API ของ Shopify เวอร์ชัน 2022-01 หากต้องการข้อมูลและตัวอย่างล่าสุด ให้ดูที่เอกสารอ้างอิง REST Admin API
Customer
คุณสมบัติของทรัพยากร
ตารางต่อไปนี้แสดงข้อมูลที่มีประโยชน์เกี่ยวกับคุณสมบัติของทรัพยากร Customer
REST Admin API
คุณสมบัติ | ค่า | คำอธิบาย | ประเภทของข้อมูล | ความยาวของช่อง | สิทธิ์เข้าถึงช่อง | ช่องที่ต้องกรอก |
---|---|---|---|---|---|---|
accepts_marketing | ค่าเริ่มต้น: 0 | ลูกค้าได้ตกลงที่จะรับเอกสารทางการตลาดหรือไม่ | บูลีน | tinyint(1) | Y | |
accepts_marketing_ updated_at |
วันและเวลาในรูปแบบ ISO 8601 เมื่อลูกค้ายินยอมหรือคัดค้านการรับเอกสารสารตลาดทางอีเมล | Datetime | ที่อยู่ | รายการที่อยู่ที่เกี่ยวข้องกับลูกค้า | [{ ที่อยู่ }] | |
currency | โค้ดสามตัวอักษรในรูปแบบ ISO 4217 สำหรับสกุลเงินที่ลูกค้าใช้ในการชำระเงินคำสั่งซื้อล่าสุด | สตริง | สกุลเงินของร้านค้า | อ่านอย่างเดียว | ||
created_at | ค่าเริ่มต้น: NULL | วันและเวลาในรูปแบบ ISO 8601 เมื่อลูกค้าเพิ่มไปยังร้านค้า | Datetime | Datetime | อ่านอย่างเดียว | |
default_address | ที่อยู่เริ่มต้นสำหรับลูกค้า | { ที่อยู่ } | ||||
ค่าเริ่มต้น: NULL | ที่อยู่อีเมลเฉพาะของลูกค้า | สตริง | varchar(255) | |||
first_name | ค่าเริ่มต้น: NULL | ชื่อจริงของลูกค้า | สตริง | varchar(255) | ||
id | ค่าเริ่มต้น: NULL | รหัสเฉพาะทั่วโลก (ค่านี้เพิ่มจำนวนโดยอัตโนมัติ) | จำนวนเต็ม | bigint(20) | Y | |
last_name | ค่าเริ่มต้น: NULL | นามสกุลของลูกค้า | สตริง | varchar(255) | ||
last_order_id | ค่าเริ่มต้น: NULL | ID ของคำสั่งซื้อล่าสุดของลูกค้า | จำนวนเต็ม | bigint(20) | อ่านอย่างเดียว | |
last_order_name | ค่าเริ่มต้น: NULL | ชื่อคำสั่งซื้อสุดท้ายของลูกค้า | สตริง | อ่านอย่างเดียว | ||
metafield | ค่าเริ่มต้น: NULL | แสดงเมตาฟิลด์โดยเนมสเปซและคีย์ที่เป็นของทรัพยากร | { เมตาฟิลด์ } | |||
marketing_opt_ in_level |
|
ระดับของการเลือกใช้การสมัครรับข้อมูลทางการตลาด (ตามที่อธิบายไว้ในแนวทางหลักปฏิบัติที่ดีที่สุด M3AAWG) ซึ่งลูกค้ามอบให้เมื่อพวกเขายินยอมที่จะรับเอกสารสารตลาดทางอีเมล | String, enum | |||
multipass_identifier | ค่าเริ่มต้น: NULL | รหัสเฉพาะสำหรับลูกค้าซึ่งใช้กับการเข้าสู่ระบบแบบ Multipass | สตริง | varchar(255) | ||
note | ค่าเริ่มต้น: NULL | หมายเหตุเกี่ยวกับลูกค้ารายนี้ | สตริง | mediumtext | ||
orders_count | ค่าเริ่มต้น: 0 | จำนวนคำสั่งซื้อที่ผ่านมาทั้งหมดของลูกค้า | จำนวนเต็ม | int(11) | อ่านอย่างเดียว | |
โทรศัพท์ | ค่าเริ่มต้น: NULL | หมายเลขโทรศัพท์ (ในร้านค้า) เฉพาะ (รูปแบบ E.164) สำหรับลูกค้ารายนี้ | สตริง | varchar(255) | ||
sms_marketing_ consent |
ค่าเริ่มต้น: NULL | สถานะของการตลาดผ่าน SMS ในปัจจุบันสำหรับหมายเลขโทรศัพท์ของลูกค้า | สตริง | |||
สถานะ |
|
สถานะของบัญชีผู้ใช้ของลูกค้ากับร้านค้า | String, enum | varchar(255) | อ่านอย่างเดียว | |
แท็ก | ค่าเริ่มต้น: NULL | รายการแท็กสูงสุด 250 รายการที่คั่นด้วยเครื่องหมายจุลภาคซึ่งถูกเพิ่มไปยังลูกค้า | สตริง | 255 ต่อแท็ก | ||
tax_exempt | ค่าเริ่มต้น: 0 | ลูกค้าได้รับการยกเว้นภาษีจากคำสั่งซื้อของพวกเขาหรือไม่ | บูลีน | tinyint(1) | Y | |
tax_exemptions | ดูที่ทรัพยากรลูกค้าเพื่อดูรายการค่าฉบับเต็ม | รายการการยกเว้นภาษีที่มีผลกับลูกค้า | สตริง | |||
total_spent | ค่าเริ่มต้น: 0 | ยอดรวมที่ลูกค้าใช้จ่ายกับคำสั่งซื้อที่ผ่านมาทั้งหมด โดยมีหน่วยเป็นสกุลเงินของร้านค้า หากใช้หลายสกุลเงิน จํานวนเงินที่แสดงจะเป็นสกุลเงินตามค่าเริ่มต้นโดยไม่มีอัตราแลกเปลี่ยน | ตัวเลข | decimal(21,3) | อ่านอย่างเดียว | |
updated_at | วันที่และเวลาเมื่อลูกค้าอัปเดตล่าสุด โดยอิงตามเขตเวลาของ Shop | Datetime | Datetime | อ่านอย่างเดียว | ||
verified_email | ค่าเริ่มต้น: 1 | ข้อมูลที่ระบุว่าลูกค้าตรวจสอบยืนยันที่อยู่อีเมลของตนแล้วหรือไม่ โดยค่าเริ่มต้นเป็นจริง หากสร้างลูกค้าผ่านส่วนผู้ดูแล Shopify หรือ API | บูลีน | tinyint(1) | อ่านอย่างเดียว |
CustomerAddress
คุณสมบัติของทรัพยากร
ตารางต่อไปนี้แสดงรายการข้อมูลที่มีประโยชน์บางประการเกี่ยวกับคุณสมบัติของทรัพยากร REST Admin API CustomerAddress
ไม่มีช่องที่ต้องกรอกสำหรับทรัพยากรนี้
คุณสมบัติ | ค่า | คำอธิบาย | ประเภทของข้อมูล | ความยาวของช่อง | สิทธิ์เข้าถึงช่อง |
---|---|---|---|---|---|
address1 | ค่าเริ่มต้น: NULL | ที่อยู่ทางไปรษณีย์ของลูกค้า โดยมี 100 รายการต่อบัญชีผู้ใช้ของลูกค้า | สตริง | varchar(255) | |
address2 | ค่าเริ่มต้น: NULL | ช่องเพิ่มเติมสำหรับที่อยู่ทางไปรษณีย์ของลูกค้า | สตริง | varchar(255) | |
city | ค่าเริ่มต้น: NULL | เมือง ตัวเมือง หรือหมู่บ้านของลูกค้า | สตริง | varchar(255) | |
company | ค่าเริ่มต้น: NULL | บริษัทของลูกค้า | สตริง | varchar(255) | |
ประเทศ | ค่าเริ่มต้น: NULL | ประเทศของลูกค้า | สตริง | varchar(255) | |
first_name | ค่าเริ่มต้น: NULL | ชื่อจริงของลูกค้า | สตริง | varchar(255) | |
country_code | รหัสประเทศสองตัวอักษรที่สอดคล้องกับประเทศของลูกค้า | สตริง | อ่านอย่างเดียว | ||
country_name | ชื่อประเทศมาตรฐานของลูกค้า | สตริง | |||
last_name | ค่าเริ่มต้น: NULL | นามสกุลของลูกค้า | สตริง | varchar(255) | |
ชื่อ | ชื่อและนามสกุลของลูกค้า | สตริง | |||
โทรศัพท์ | ค่าเริ่มต้น: NULL | หมายเลขโทรศัพท์ของลูกค้าในที่อยู่นี้ | สตริง | varchar(255) | |
province | ค่าเริ่มต้น: NULL | ชื่อภูมิภาคของลูกค้า โดยทั่วไปแล้วจะเป็นจังหวัด รัฐ หรืออำเภอ | สตริง | varchar(255) | |
province_code | รหัสตัวอักษรสองตัวของภูมิภาคของลูกค้า | สตริง | อ่านอย่างเดียว | ||
รหัสไปรษณีย์ | ค่าเริ่มต้น: NULL | รหัสไปรษณีย์ของลูกค้า หรือที่เรียกว่ารหัส zip, รหัสไปรษณีย์, Eircodes ฯลฯ | สตริง | varchar(255) |
Order
คุณสมบัติของทรัพยากร
ตารางต่อไปนี้แสดงข้อมูลที่มีประโยชน์เกี่ยวกับคุณสมบัติของทรัพยากร Order
REST Admin API
คุณสมบัติ | ค่า | คำอธิบาย | ประเภทของข้อมูล | ความยาวของช่อง | สิทธิ์เข้าถึงช่อง | ช่องที่ต้องกรอก |
---|---|---|---|---|---|---|
app_id | ค่าเริ่มต้น: NULL | ID ของแอปที่สร้างคำสั่งซื้อ | จำนวนเต็ม | bigint(20) | อ่านอย่างเดียว | |
billing_address | ค่าเริ่มต้น: NULL | ที่อยู่ทางไปรษณีย์ซึ่งเกี่ยวข้องกับวิธีการชำระเงิน โดยที่อยู่นี้เป็นช่องที่ไม่จำเป็นต้องกรอก ซึ่งจะไม่สามารถใช้งานได้ในคำสั่งซื้อที่ไม่ต้องใช้วิธีการชำระเงิน | จำนวนเต็ม | bigint(20) | ||
browser_ip | ที่อยู่ IP ของเบราว์เซอร์ที่ลูกค้าใช้เมื่อทำการสั่งซื้อ โดยรองรับทั้ง IPv4 และ IPv6 | สตริง | varchar(255) | อ่านอย่างเดียว | ||
buyer_accepts_marketing | ค่าเริ่มต้น: 0 | ข้อมูลที่ระบุว่าลูกค้ายินยอมที่จะรับการอัปเดตทางอีเมลจากร้านค้าหรือไม่ | บูลีน | tinyint(1) | ||
cancel_reason |
|
เหตุผลที่ยกเลิกคำสั่งซื้อ | สตริง | varchar(255) | ||
cancelled_at | ค่าเริ่มต้น: NULL | วันที่และเวลาที่คำสั่งซื้อถูกยกเลิก แสดง null หากคำสั่งซื้อไม่ถูกยกเลิก | วันที่ | Datetime | อ่านอย่างเดียว | |
cart_token | ค่าเริ่มต้น: NULL | ค่าที่ไม่ซ้ำเมื่ออ้างอิงจากตะกร้าสินค้าที่เกี่ยวข้องกับคำสั่งซื้อ | สตริง | varchar(255) | อ่านอย่างเดียว | |
checkout_token | ค่าเริ่มต้น: NULL | ค่าเฉพาะเมื่ออ้างอิงจากขั้นตอนการชำระเงินที่เกี่ยวข้องกับคำสั่งซื้อ | สตริง | varchar(64) | อ่านอย่างเดียว | |
client_details |
|
ข้อมูลเกี่ยวกับเบราว์เซอร์ที่ลูกค้าใช้เมื่อพวกเขาทำการสั่งซื้อ: accept_language: ภาษาและตำแหน่งที่ตั้งที่เบราว์เซอร์เข้าใจ browser_height: ความสูงของหน้าจอเบราว์เซอร์ในหน่วยพิกเซล หากมี browser_ip: ที่อยู่ IP ของเบราว์เซอร์ browser_width: ความกว้างของหน้าจอเบราว์เซอร์ในหน่วยพิกเซล หากมี session_hash: แฮชเซสชัน user_agent: รายละเอียดของลูกค้าที่เรียกดู รวมถึงซอฟต์แวร์และเวอร์ชันปฏิบัติการ |
วัตถุ | อ่านอย่างเดียว | ||
closed_at | ค่าเริ่มต้น: NULL | วันที่และเวลา (รูปแบบ ISO 8601) เมื่อปิดการสั่งซื้อ แสดง null หากไม่ได้ปิดการสั่งซื้อ | วันที่ | Datetime | อ่านอย่างเดียว | |
created_at | ค่าเริ่มต้น: NULL | วันที่และเวลาที่สร้างโดยอัตโนมัติ (รูปแบบ ISO 8601) เมื่อสร้างคำสั่งซื้อใน Shopify โดยค่าสำหรับคุณสมบัตินี้ไม่สามารถเปลี่ยนแปลงได้ | วันที่ | datetime(6) | อ่านอย่างเดียว | |
currency | ค่าเริ่มต้น: NULL | รหัสสามตัวอักษร (รูปแบบ ISO 4217) สำหรับสกุลเงินของร้านค้า | สตริง | char(3) | ||
current_subtotal_price | ราคายอดรวมของคำสั่งซื้อในสกุลเงินของร้านค้าในขณะนี้ ค่าของช่องนี้แสดงถึงการแก้ไขคำสั่งซื้อ การคืนสินค้า และการคืนเงิน | สตริง | varchar(255) | อ่านอย่างเดียว | ||
current_subtotal_price_set | ยอดรวมย่อยทั้งหมดของคำสั่งซื้อในร้านค้าและในสกุลเงินที่แสดงในขณะนี้ โดยค่าจำนวนที่เกี่ยวข้องกับช่องนี้แสดงถึงการแก้ไขคำสั่งซื้อ การคืนสินค้าและการคืนเงิน | วัตถุ | อ่านอย่างเดียว | |||
current_total_discounts | ส่วนลดทั้งหมดของคำสั่งซื้อในสกุลเงินของร้านค้าในขณะนี้ ค่าของช่องนี้แสดงถึงการแก้ไขคำสั่งซื้อ การคืนสินค้า และการคืนเงิน | สตริง | varchar(255) | อ่านอย่างเดียว | ||
current_total_discounts_set | ส่วนลดทั้งหมดของคำสั่งซื้อในสกุลเงินที่แสดงในร้านค้าในขณะนี้ ค่าจำนวนที่เกี่ยวข้องกับช่องนี้แสดงถึงการแก้ไขคำสั่งซื้อ การคืนสินค้าและการคืนเงิน | วัตถุ | อ่านอย่างเดียว | |||
current_total_duties_set | อากรทั้งหมดที่เรียกเก็บจากคำสั่งซื้อในสกุลเงินที่แสดงในร้านค้าในขณะนี้ ค่าจำนวนที่เกี่ยวข้องกับช่องนี้แสดงถึงการแก้ไขคำสั่งซื้อ การคืนสินค้า และการคืนเงิน | วัตถุ | อ่านอย่างเดียว | |||
current_total_price | ราคารวมของคำสั่งซื้อในสกุลเงินของร้านค้าในขณะนี้ ค่าของช่องนี้แสดงถึงการแก้ไขคำสั่งซื้อ การคืนสินค้าและการคืนเงิน | สตริง | varchar(255) | อ่านอย่างเดียว | ||
current_total_price_set | ราคายอดรวมทั้งหมดของคำสั่งซื้อในร้านค้าและในสกุลเงินที่แสดงในขณะนี้ ค่าจำนวนที่เกี่ยวข้องกับช่องนี้แสดงถึงการแก้ไขคำสั่งซื้อ การคืนสินค้า และการคืนเงิน | วัตถุ | อ่านอย่างเดียว | |||
current_total_tax | ภาษีทั้งหมดที่เรียกเก็บจากคำสั่งซื้อในสกุลเงินของร้านค้าในขณะนี้ ค่าของช่องนี้แสดงถึงการแก้ไขคำสั่งซื้อ การคืนสินค้า และการคืนเงิน | สตริง | varchar(255) | อ่านอย่างเดียว | ||
current_total_tax_set | อากรทั้งหมดที่เรียกเก็บจากคำสั่งซื้อในสกุลเงินที่แสดงในร้านค้าในขณะนี้ ค่าจำนวนที่เกี่ยวข้องกับช่องนี้แสดงถึงการแก้ไขคำสั่งซื้อ การคืนสินค้า และการคืนเงิน | วัตถุ | อ่านอย่างเดียว | |||
customer | ค่าเริ่มต้น: NULL | ข้อมูลเกี่ยวกับลูกค้า โดยคำสั่งซื้ออาจไม่มีลูกค้า และแอปไม่ควรขึ้นอยู่กับการมีอยู่ของอ็อบเจกต์ลูกค้า ทั้งนี้ ค่านี้อาจมีค่าเป็น null หากมีการสร้างคำสั่งซื้อผ่าน Shopify POS | จำนวนเต็ม | bigint(20) | ||
customer_locale | ค่าเริ่มต้น: NULL | รหัสภาษาสองหรือสามตัวอักษร โดยอาจตามด้วยรหัสภูมิภาคหรือไม่ก็ได้ | สตริง | varchar(255) | อ่านอย่างเดียว | |
discount_applications | รายการแบบเรียงลำดับของแอปพลิเคชันส่วนลดแบบซ้อนกัน โดยคุณสมบัติ discount_applications มี 3 ประเภท ได้แก่ discount_code, แบบกำหนดเอง และสคริปต์ ทั้งนี้ คุณสมบัติทั้ง 3 ประเภทมีโครงสร้างเดียวกันและมีคุณลักษณะเฉพาะบางประเภท |
array | อ่านอย่างเดียว | |||
discount_codes | รายการของส่วนลดที่ใช้กับคำสั่งซื้อ | array | ||||
อีเมลของลูกค้า | varchar(255) | |||||
estimated_taxes | ข้อมูลที่ระบุว่ามีการประเมินภาษีของคำสั่งซื้อแล้วหรือไม่ โดยปัจจัยหลายอย่างอาจมีการเปลี่ยนแปลงในระหว่างเวลาที่ลูกค้าทำการสั่งซื้อและเวลาในการจัดส่งสินค้าซึ่งอาจส่งผลกระทบต่อการคํานวณภาษี คุณสมบัตินี้แสดงผลเป็นเท็จเมื่อมีการสรุปภาษีของคำสั่งซื้อและไม่ได้มีการเปลี่ยนแปลงใดๆ | บูลีน | tinyint(1) | |||
financial_status |
|
สถานะของการชำระเงินที่เกี่ยวข้องกับคำสั่งซื้อ สามารถตั้งค่าได้เมื่อมีการสร้างคำสั่งซื้อเท่านั้น | สตริง | varchar(255) | อ่านอย่างเดียว | |
fulfillment_status |
|
สถานะของคำสั่งซื้อในข้อกำหนดของสินค้าเฉพาะรายการที่จัดการแล้ว | สตริง | varchar(255) | ||
การจัดการคำสั่งซื้อ | อาร์เรย์ของการจัดการคำสั่งซื้อที่เกี่ยวข้องกับคำสั่งซื้อ | array | ||||
id | ค่าเริ่มต้น: NULL | ID ของคำสั่งซื้อที่ใช้เพื่อวัตถุประสงค์ API โดยต่างจากคุณสมบัติ order_number ซึ่ง ID ถูกนำไปใช้โดยเจ้าของร้านค้าและลูกค้า | จำนวนเต็ม | bigint(20) | อ่านอย่างเดียว | |
landing_site | ค่าเริ่มต้น: NULL | URL ของหน้าซึ่งลูกค้าจะพบเมื่อพวกเขาเข้ามาในร้านค้า | สตริง | varchar(4096) | อ่านอย่างเดียว | |
line_items | รายการของอ็อบเจกต์สินค้าเฉพาะรายการ โดยแต่ละรายการมีข้อมูลเกี่ยวกับสินค้าในคำสั่งซื้อ | array | Y | |||
location_id | ค่าเริ่มต้น: NULL | ID ของตำแหน่งที่ตั้งจริงที่มีการประมวลผลคำสั่งซื้อ หากคุณต้องอ้างอิงตำแหน่งที่ตั้งสำหรับคำสั่งซื้อ ให้ใช้ทรัพยากร FulfillmentOrder | จำนวนเต็ม | bigint(20) | ||
ชื่อ | ค่าเริ่มต้น: NULL | ชื่อคำสั่งซื้อ ซึ่งสร้างโดยการรวมคุณสมบัติ order_number ทั้งหมดเข้ากับคำนำหน้าหรือคำต่อท้ายคำสั่งซื้อที่ตั้งค่าไว้ในการตั้งค่าทั่วไปของผู้ขาย ซึ่งแตกต่างจากคุณสมบัติ ID ซึ่งเป็น ID ของคำสั่งซื้อที่ API ใช้ นอกจากนี้ ช่องนี้ยังสามารถตั้งค่าโดย API ให้เป็นค่าสตริงใดก็ได้ | สตริง | varchar(255) | ||
note | ค่าเริ่มต้น: NULL | หมายเหตุแบบไม่บังคับใช้ ซึ่งเจ้าของร้านค้าสามารถใช้แนบไปกับคำสั่งซื้อได้ | สตริง | |||
note_attributes | ค่าเริ่มต้น: NULL | ข้อมูลเพิ่มเติมที่เพิ่มไปยังคำสั่งซื้อ โดยปรากฏในส่วนรายละเอียดเพิ่มเติมของหน้ารายละเอียดคำสั่งซื้อ การป้อนข้อมูลอาร์เรย์แต่ละรายการต้องมีแฮชที่มีชื่อและคีย์ค่า | สตริง | |||
number | ค่าเริ่มต้น: NULL | ตําแหน่งของคำสั่งซื้อในยอดคำสั่งซื้อของร้านค้า หมายเลขจะจัดเรียงตามลำดับและเริ่มต้นที่ 1 | จำนวนเต็ม | int(11) | อ่านอย่างเดียว | |
order_number | ตำแหน่งของคำสั่งซื้อในยอดคำสั่งซื้อของร้านค้าโดยเริ่มท่ี 1,001 โดยคำสั่งซื้อจะจัดเรียงตามลำดับ | จำนวนเต็ม | bigint(20) | อ่านอย่างเดียว | ||
order_status_url | URL ที่ชี้ไปยังเว็บเพจแสดงสถานะคำสั่งซื้อ หากมี | สตริง | varchar(255) | อ่านอย่างเดียว | ||
original_total_duties_set | อากรเดิมทั้งหมดที่เรียกเก็บจากคำสั่งซื้อในสกุลเงินที่แสดงในร้านค้า | วัตถุ | อ่านอย่างเดียว | |||
payment_gateway_names | ค่าเริ่มต้น: NULL | รายการของช่องทางการชำระเงินที่ใช้กับคำสั่งซื้อ |
varchar(255) | อ่านอย่างเดียว | ||
payment_terms | ค่าเริ่มต้น: NULL | ข้อกำหนดและเงื่อนไขซึ่งต้องปฏิบัติตามในการประมวลผลการชำระเงิน | วัตถุ | bigint(20) | อ่านอย่างเดียว | |
โทรศัพท์ | ค่าเริ่มต้น: NULL | หมายเลขโทรศัพท์ของลูกค้าเพื่อรับการแจ้งเตือนผ่าน SMS | สตริง | varchar(255) | ||
presentment_currency | ค่าเริ่มต้น: NULL | สกุลเงินที่แสดงซึ่งใช้ในการแสดงราคาแก่ลูกค้า | สตริง | char(3) | ||
processed_at | ค่าเริ่มต้น: NULL | วันที่และเวลา (รูปแบบ ISO 8601) เมื่อประมวลผลคำสั่งซื้อ โดยค่านี้เป็นวันที่ที่ปรากฏบนคำสั่งซื้อของคุณและวันที่ที่ใช้ในรายงานการวิเคราะห์ หากคุณจะนําเข้าสินค้าจากแอปหรือแพลตฟอร์มอื่น คุณสามารถตั้งค่า processed_at ให้แก่วันที่และเวลาในอดีตให้ตรงกับเวลาที่สร้างคำสั่งซื้อเดิมได้ | วันที่ | datetime(6) | ||
processing_method |
|
วิธีการประมวลผลการชำระเงิน | สตริง | varchar(255) | อ่านอย่างเดียว | |
referring_site | ค่าเริ่มต้น: NULL | เว็บไซต์ที่ลูกค้าคลิกลิงก์ไปยังร้านค้า | สตริง | varchar(4096) | ||
การคืนเงิน | รายการการคืนเงินที่ใช้กับคำสั่งซื้อ | array | อ่านอย่างเดียว | |||
shipping_address | ค่าเริ่มต้น: NULL | ที่อยู่ทางไปรษณีย์ที่จะจัดส่งคำสั่งซื้อ โดยที่อยู่นี้ไม่จำเป็นต้องกรอก และจะไม่สามารถใช้งานได้ในการสั่งซื้อที่ไม่มีการจัดส่ง | จำนวนเต็ม | bigint(20) | ||
shipping_lines | อาร์เรย์ของอ็อบเจกต์ ซึ่งแต่ละรายการแสดงรายละเอียดของวิธีจัดส่งที่ใช้ | array | ||||
source_name | ค่าเริ่มต้น: NULL | ต้นทางของคำสั่งซื้อ โดยสามารถตั้งค่าได้เฉพาะในระหว่างคำสั่งซื้อและจะไม่สามารถเขียนได้ในภายหลัง ค่าของช่องทาง Shopify ได้รับการคุ้มครองและไม่สามารถกำหนดโดยไคลเอนต์ API อื่นๆ ได้: เว็บ, pos, shopify_draft_order, iPhone และ Android ทั้งนี้ สตริงอื่นๆ ที่คุณเลือกสามารถกำหนดคำสั่งซื้อที่สร้างโดย API ได้ หากไม่ได้กำหนด คำสั่งซื้อรายการใหม่จะกำหนดค่า ID ของแอปของคุณ | สตริง | varchar(255) | ||
subtotal_price | ราคาของคำสั่งซื้อในสกุลเงินของร้านค้าหลังใช้ส่วนลด แต่ยังไม่รวมการจัดส่ง อากร ภาษี และทิป | จำนวนเต็ม | bigint(20) | |||
subtotal_price_set | ยอดรวมย่อยของคำสั่งซื้อในร้านค้าและสกุลเงินที่แสดงในขณะนี้หลังใช้ส่วนลด แต่ยังไม่รวมการจัดส่ง อากร ภาษี และทิป | วัตถุ | ||||
แท็ก | แท็กที่แนบกับคำสั่งซื้อ ซึ่งได้รับการจัดรูปแบบเป็นสตริงที่คั่นด้วยเครื่องหมายจุลภาค โดยแท็กคือตัวอธิบายเพิ่มเติมสั้นๆ ซึ่งปกติจะใช้ในการกรองและการค้นหา โดยแท็กแต่ละแท็กมีความยาวจํากัด 40 อักขระ | สตริง | varchar(4096) | |||
tax_lines | อาร์เรย์ของอ็อบเจกต์บรรทัดภาษี ซึ่งแต่ละรายการจะแสดงรายละเอียดภาษีที่มีผลกับคำสั่งซื้อ แต่ละอ็อบเจกต์มีคุณสมบัติดังต่อไปนี้ เมื่อสร้างคำสั่งซื้อผ่าน API ระบบจะสามารถระบุบรรทัดภาษีในคำสั่งซื้อหรือสินค้าเฉพาะรายการได้อย่างใดอย่างหนึ่งเท่านั้น โดยบรรทัดภาษีที่ระบุในคำสั่งซื้อจะถูกแบ่งตามสินค้าเฉพาะรายการที่ต้องเสียภาษีในคำสั่งซื้อที่สร้างขึ้น |
array | ||||
taxes_included |
|
ข้อมูลที่ระบุว่าจะมีการรวมภาษีอยู่ในยอดรวมย่อยของคำสั่งซื้อหรือไม่ | บูลีน | tinyint(1) | ||
ทดสอบ |
|
ข้อมูลที่ระบุว่านี่คือคำสั่งซื้อสำหรับทดสอบหรือไม่ | บูลีน | tinyint(1) | อ่านอย่างเดียว | |
token | ค่าเริ่มต้น: NULL | ค่าเฉพาะเมื่ออ้างอิงคำสั่งซื้อ | สตริง | varchar(32) | อ่านอย่างเดียว | |
total_discounts | ค่าเริ่มต้น: 0 | ส่วนลดทั้งหมดที่ใช้กับราคาของคำสั่งซื้อในสกุลเงินของร้านค้า | สตริง | decimal(21,3) | ||
total_discounts_set | ส่วนลดทั้งหมดที่ใช้กับราคาของคำสั่งซื้อในสกุลเงินของร้านค้าและในสกุลเงินที่แสดงในขณะนี้ | วัตถุ | ||||
total_line_items_price | ค่าเริ่มต้น: 0 | ผลรวมของราคาสินค้าเฉพาะรายการทั้งหมดในสกุลเงินของร้านค้า | สตริง | decimal(21,3) | ||
total_line_items_price_set | ยอดรวมของราคาสินค้าเฉพาะรายการทั้งหมดในสกุลเงินของร้านค้าและในสกุลเงินที่แสดงในขณะนี้ | วัตถุ | ||||
total_outstanding | ค่าเริ่มต้น: 0 | ยอดรวมของยอดค้างชำระของคำสั่งซื้อในสกุลเงินของร้านค้า | สตริง | decimal(21,3) | ||
total_price | ค่าเริ่มต้น: 0 | ผลรวมของราคาสินค้าเฉพาะรายการ ส่วนลด การจัดส่ง ภาษี และทิปทั้งหมดในสกุลเงินของร้านค้า ต้องเป็นค่าบวก | สตริง | decimal(21,3) | ||
total_price_set | ราคารวมทั้งหมดของคำสั่งซื้อในสกุลเงินของร้านค้าและในสกุลเงินที่แสดงในขณะนี้ | วัตถุ | ||||
total_shipping_price_set | ราคารวมของการจัดส่งคำสั่งซื้อในสกุลเงินของร้านค้าและในสกุลเงินที่แสดงในขณะนี้ โดยไม่รวมส่วนลดและการคืนสินค้า หาก taxes_included ตั้งค่าเป็นจริง total_shipping_price_set จะรวมภาษีด้วย | วัตถุ | ||||
total_tax | ค่าเริ่มต้น: 0 | ผลรวมของภาษีทั้งหมดที่มีผลกับคำสั่งซื้อในสกุลเงินของร้านค้า ต้องเป็นค่าบวก | สตริง | decimal(21,3) | ||
total_tax_set | ภาษีทั้งหมดที่มีผลกับคำสั่งซื้อในสกุลเงินของร้านค้าและในสกุลเงินที่แสดงในขณะนี้ | วัตถุ | ||||
total_tip_received | ผลรวมของทิปทั้งหมดในคำสั่งซื้อในสกุลเงินของร้านค้า | จำนวนเต็ม | bigint(20) | อ่านอย่างเดียว | ||
total_weight | ค่าเริ่มต้น: 0 | ผลรวมของน้ําหนักสินค้าเฉพาะรายการทั้งหมดในหน่วยกรัม ทั้งนี้ ระบบจะไม่ปรับผลรวมดังกล่าวเมื่อสินค้าถูกลบออกจากคำสั่งซื้อ | จำนวนเต็ม | bigint(20) unsigned | ||
updated_at | วันที่และเวลา (รูปแบบ ISO 8601) ที่มีการแก้ไขคำสั่งซื้อล่าสุด | วันที่ | datetime(6) | อ่านอย่างเดียว | ||
user_id | ค่าเริ่มต้น: NULL | ID ของผู้ใช้ที่เข้าสู่ระบบ Shopify POS ที่ประมวลผลคำสั่งซื้อ หากมี | จำนวนเต็ม | bigint(20) |
Product
คุณสมบัติของทรัพยากร
ตารางต่อไปนี้แสดงข้อมูลที่มีประโยชน์เกี่ยวกับคุณสมบัติของทรัพยากร Product
REST Admin API
คุณสมบัติ | ค่า | คำอธิบาย | ประเภทของข้อมูล | ความยาวของช่อง | สิทธิ์เข้าถึงช่อง | ช่องที่ต้องกรอก |
---|---|---|---|---|---|---|
body_html | ค่าเริ่มต้น: NULL | คำอธิบายสินค้า รองรับการจัดรูปแบบ HTML | สตริง | mediumtext | ||
created_at | ค่าเริ่มต้น: NULL | วันที่และเวลา (รูปแบบ ISO 8601) ที่สร้างสินค้าขึ้น | วันที่ | Datetime | อ่านอย่างเดียว | |
handle | ค่าเริ่มต้น: NULL | สตริง | varchar(255) | |||
id | ค่าเริ่มต้น: NULL | จํานวนเต็ม 64 บิตที่ไม่ได้ลงนาม ซึ่งใช้เป็นรหัสเฉพาะสำหรับสินค้า โดยแต่ละ ID จะมีเอกลักษณ์เฉพาะตัวในระบบ Shopify สินค้าสองรายการจะไม่มี ID เดียวกัน แม้ว่าสินค้าเหล่านั้นมาจากร้านค้าที่ต่างกันก็ตาม | จำนวนเต็ม | bigint(20) | อ่านอย่างเดียว | Y |
รูปภาพ | รายการอ็อบเจกต์รูปภาพสินค้า โดยแต่ละรายการแสดงรูปภาพที่เกี่ยวข้องกับสินค้านั้น | [{ product_image}] | ||||
ตัวเลือก | คุณสมบัติของสินค้าที่ปรับแต่งเอง ตัวอย่างเช่น ขนาด สี และวัสดุ สินค้าแต่ละรายการสามารถมีตัวเลือกสูงสุดได้ 3 ตัวเลือก และแต่ละค่าตัวเลือกสามารถมีอักขระได้ไม่เกิน 255 ตัว ตัวเลือกสินค้าสร้างขึ้นจากการรวมค่าตัวเลือกต่างๆ ทั้งนี้ ไม่สามารถสร้างตัวเลือกโดยไม่มีค่าได้ หากต้องการสร้างตัวเลือกใหม่ จะต้องสร้างตัวเลือกสินค้าที่มีค่าตัวเลือกที่เกี่ยวข้องด้วย | array | ||||
product_type | ค่าเริ่มต้น: NULL | การจัดหมวดหมู่สินค้าที่ใช้สำหรับการกรองและการค้นหา | สตริง | varchar(255) | ||
published_at | ค่าเริ่มต้น: NULL | วันที่และเวลา (รูปแบบ ISO 8601) เมื่อมีการเผยแพร่สินค้า สามารถตั้งค่าเป็น null เพื่อยกเลิกการเผยแพร่สินค้าจากช่องทางร้านค้าออนไลน์ได้ | วันที่ | Datetime | ||
published_scope |
|
ข้อมูลที่ระบุว่าสินค้าได้รับการเผยแพร่ไปยังช่องทาง Point of Sale หรือไม่ | สตริง | |||
สถานะ |
|
สถานะของสินค้า | สตริง | varchar(32) | ||
แท็ก | สตริงของแท็กที่คั่นด้วยเครื่องหมายจุลภาคซึ่งใช้ในการกรองและการค้นหา สินค้าสามารถมีแท็กได้สูงสุดถึง 250 รายการ โดยแต่ละแท็กสามารถมีอักขระได้สูงสุด 255 ตัว | สตริง | ||||
template_suffix | ค่าเริ่มต้น: NULL | คำต่อท้ายของเทมเพลต Liquid ที่ใช้กับหน้าสินค้า หากมีการระบุคุณสมบัตินี้ หน้าสินค้าจะใช้เทมเพลตที่ชื่อว่า “product.suffix.liquid” โดยที่ “คำต่อท้าย” คือค่าของคุณสมบัตินี้ หากคุณสมบัตินี้เป็น “” หรือ null หน้าสินค้าจะใช้ “product.liquid” ซึ่งเป็นเทมเพลตเริ่มต้น | สตริง | varchar(255) | ||
title | ค่าเริ่มต้น: NULL | ชื่อของสินค้า | สตริง | varchar(255) | ||
updated_at | ค่าเริ่มต้น: NULL | วันที่และเวลา (รูปแบบ ISO 8601) เมื่อมีการแก้ไขสินค้าครั้งล่าสุด ค่าสินค้า updated_at จะสามารถเปลี่ยนแปลงได้ด้วยเหตุผลที่แตกต่างกัน ตัวอย่างเช่น หากมีการสั่งซื้อสินค้าที่มีการตั้งค่าการติดตามสินค้าคงคลัง การปรับปรุงสินค้าคงคลังก็จะถูกนับเป็นการอัปเดต | วันที่ | Datetime | อ่านอย่างเดียว | |
ตัวเลือกสินค้า | อาร์เรย์ของตัวเลือกสินค้า ซึ่งแต่ละรายการแสดงถึงสินค้าในเวอร์ชันที่แตกต่างกัน คุณสมบัติตําแหน่งเป็นแบบอ่านอย่างเดียว ตําแหน่งของตัวเลือกสินค้าจะกำหนดโดยคำสั่งซื้อที่มีตัวเลือกสินค้าดังกล่าว | array | ||||
เวนเดอร์ | ค่าเริ่มต้น: NULL | ชื่อของเวนเดอร์สินค้า | สตริง | varchar(255) |
ProductImage
คุณสมบัติของทรัพยากร
ตารางต่อไปนี้แสดงรายการข้อมูลที่มีประโยชน์บางประการเกี่ยวกับคุณสมบัติของทรัพยากร REST Admin API ProductImage
ไม่มีช่องที่ต้องกรอกในการอ่านอย่างเดียวสำหรับทรัพยากรนี้
คุณสมบัติ | ค่า | คำอธิบาย | ประเภทของข้อมูล | ความยาวของช่อง |
---|---|---|---|---|
created_at | ค่าเริ่มต้น: NULL | วันและเวลาที่สร้างรูปภาพสินค้า API ส่งคืนค่านี้ในรูปแบบ ISO 8601 | วันที่ | Datetime |
height | ค่าเริ่มต้น: NULL | ขนาดความสูงของรูปภาพซึ่งกําหนดในการอัปโหลด | smallint(4) unsigned | |
id | ค่าเริ่มต้น: NULL | รหัสตัวเลขเฉพาะของรูปภาพสินค้า (auto_increment) | จำนวนเต็ม | bigint(20) |
position | ค่าเริ่มต้น: 0 | คำสั่งซื้อของรูปภาพสินค้าในรายการ โดยรูปภาพสินค้ารูปแรกอยู่ในตําแหน่งที่ 1 และเป็นรูปภาพ “หลัก” ของสินค้า | ไม่ได้ลงนาม smallint(5) | |
product_id | ค่าเริ่มต้น: NULL | ID ของผลิตภัณฑ์ที่เกี่ยวข้องกับรูปภาพ | bigint(20) | |
src | ระบุถึงตำแหน่งที่ตั้งของรูปภาพสินค้า พารามิเตอร์นี้รองรับตัวกรอง URL ที่คุณสามารถใช้เพื่อกู้คืนสำเนาของรูปภาพที่แก้ไขแล้วได้ ตัวอย่างเช่น เพิ่ม _small ไปยังชื่อไฟล์เพื่อกู้คืนสําเนาแบบปรับขนาดของรูปภาพที่มีขนาด 100 x 100 พิกเซล (ตัวอย่างเช่น ipod-nano_small.png) หรือเพิ่ม _2048x2048 เพื่อกู้คืนสําเนาของรูปภาพที่ถูกจำกัดด้วยความละเอียด 2048 x 2048 พิกเซล (ตัวอย่างเช่น ipod-nano_2048x2048.png) | |||
updated_at | ค่าเริ่มต้น: NULL | วันที่และเวลาที่แก้ไขรูปภาพสินค้าครั้งล่าสุด โดย API จะแสดงผลค่านี้ในรูปแบบ ISO 8601 | วันที่ | Datetime |
variant_id | อาร์เรย์ของ ID ตัวเลือกสินค้าที่เกี่ยวข้องกับรูปภาพ | |||
width | ค่าเริ่มต้น: NULL | ขนาดความกว้างของรูปภาพที่จะถูกกําหนดในการอัปโหลด | smallint(4) unsigned |
ProductVariant
คุณสมบัติของทรัพยากร
ตารางต่อไปนี้แสดงรายการข้อมูลที่มีประโยชน์บางประการเกี่ยวกับคุณสมบัติของทรัพยากร REST Admin API ProductVariant
ไม่มีช่องที่ต้องกรอกสำหรับทรัพยากรนี้
คุณสมบัติ | ค่า | คำอธิบาย | ประเภทของข้อมูล | ความยาวของช่อง | สิทธิ์เข้าถึงช่อง |
---|---|---|---|---|---|
บาร์โค้ด | ค่าเริ่มต้น: NULL | บาร์โค้ด, UPC, หรือหมายเลข ISBN ของสินค้า | varchar(255) | ||
compare_at_price | ค่าเริ่มต้น: NULL | ราคาเดิมของสินค้าก่อนการปรับเปลี่ยนหรือลดราคา | decimal(20,2) | ||
created_at | ค่าเริ่มต้น: NULL | วันและเวลาในรูปแบบ ISO 8601 เมื่อมีการสร้างตัวเลือกสินค้า | วันที่ | Datetime | |
fulfillment_service |
|
บริการจัดการคำสั่งซื้อที่เกี่ยวข้องกับตัวเลือกสินค้า | varchar(255) | ||
กรัม | น้ำหนักของสินค้าหรือตัวเลือกสินค้าในหน่วยกรัม | ||||
id | ค่าเริ่มต้น: NULL | รหัสตัวเลขเฉพาะสำหรับตัวเลือกสินค้า โดยค่านี้เพิ่มจำนวนโดยอัตโนมัติ | bigint(20) | ||
image_id | ค่าเริ่มต้น: NULL | รหัสตัวเลขเฉพาะสำหรับรูปภาพสินค้า โดยรูปภาพต้องเกี่ยวข้องกับสินค้าเช่นเดียวกันกับตัวเลือกสินค้า | bigint(20) | ||
inventory_item_id | รหัสเฉพาะสำหรับรายการสินค้าคงคลังซึ่งใช้ใน API สินค้าคงคลังเพื่อสืบค้นข้อมูลสินค้าคงคลัง | ||||
inventory_management |
|
บริการจัดการคำสั่งซื้อที่ติดตามจํานวนสินค้าในสต็อกสำหรับตัวเลือกสินค้า | varchar(255) | ||
inventory_policy |
|
ลูกค้าสามารถสร้างคำสั่งซื้อสำหรับตัวเลือกสินค้าดังกล่าวเมื่อตัวเลือกสินค้านั้นหมดสต็อกได้หรือไม่ | varchar(40) | ||
inventory_quantity | ค่าเริ่มต้น: 1 | ผลรวมของสินค้าคงคลังจากทุกตำแหน่งที่ตั้งทุกแห่ง หากต้องการปรับสินค้าคงคลังในตำแหน่งที่ตั้งแห่งใดแห่งหนึ่ง ให้ใช้ทรัพยากร InventoryLevel | int(11) | อ่านอย่างเดียว | |
option | คุณสมบัติที่กําหนดเองที่เจ้าของร้านค้าใช้ในการกําหนดตัวเลือกสินค้า คุณสามารถกําหนดตัวเลือกสำหรับตัวเลือกสินค้าได้ 3 ตัวเลือก ได้แก่ ตัวเลือกที่ 1, ตัวเลือกที่ 2, ตัวเลือกที่ 3 ค่าเริ่มต้น: ชื่อเริ่มต้น ช่องชื่อคือส่วนต่อของช่องตัวเลือกที่ 1 ตัวเลือกที่ 2 และตัวเลือกที่ 3 การอัปเดตช่องตัวเลือกจะอัปเดตช่องชื่อด้วยเช่นกัน | ||||
position | ค่าเริ่มต้น: 0 | คำสั่งซื้อของตัวเลือกสินค้าในรายการตัวเลือกสินค้า โดยตําแหน่งแรกในรายการคือ 1 ตําแหน่งของตัวเลือกสินค้าจะกำหนดโดยคำสั่งซื้อที่มีตัวเลือกสินค้าดังกล่าว | ไม่ได้ลงนาม smallint(5) | อ่านอย่างเดียว | |
presentment_prices | รายการราคาที่แสดงในขณะนี้ของตัวเลือกสินค้าและราคาเปรียบเทียบในสกุลเงินที่แสดงในขณะนี้ที่ร้านค้าเปิดใช้ โดยอ็อบเจกต์ราคาแต่ละรายการมีคุณสมบัติดังต่อไปนี้ -currency_code: รหัสสามตัวอักษร (รูปแบบ ISO 4217) ของหนึ่งในสกุลเงินที่แสดงในขณะนี้ที่ร้านค้าเปิดใช้ -จํานวน: ราคาหรือราคาเปรียบเทียบของตัวเลือกสินค้าในสกุลเงินที่แสดงในขณะนี้ ต้องใช้ส่วนหัว ''X-Shopify-Api-Features': 'include-presentment-prices' |
อ่านอย่างเดียว | |||
price | ค่าเริ่มต้น: 0 | ราคาของตัวเลือกสินค้า | decimal(20,2) | ||
product_id | ค่าเริ่มต้น: NULL | รหัสตัวเลขเฉพาะสำหรับสินค้า | bigint(20) | ||
requires_shipping | ค่าเริ่มต้น: 1 | คุณสมบัตินี้เลิกใช้แล้ว โปรดใช้คุณสมบัติ `requires_shipping` กับแหล่งข้อมูล InventoryItem แทน | บูลีน | tinyint(1) | |
sku | รหัสเฉพาะของตัวเลือกสินค้าในร้านค้า จำเป็นต้องระบุในคำสั่งซื้อเพื่อเชื่อมต่อกับบริการจัดการคำสั่งซื้อ | varchar(255) | |||
tax_code | พารามิเตอร์นี้ใช้กับร้านค้าที่ติดตั้งแอป Avalara AvaTax เท่านั้น โปรดระบุรหัสภาษี Avalara สำหรับตัวเลือกสินค | ||||
เสียภาษี | ค่าเริ่มต้น: 1 | มีการเรียกเก็บภาษีเมื่อมีการขายตัวเลือกสินค้าหรือไม่ | บูลีน | tinyint(1) | |
title | ชื่อของตัวเลือกสินค้า ช่องชื่อคือส่วนต่อของช่องตัวเลือกที่ 1 ตัวเลือกที่ 2 และตัวเลือกที่ 3 คุณสามารถอัปเดตชื่อทางอ้อมได้โดยการใช้ช่องตัวเลือก | varchar(255) | อ่านอย่างเดียว | ||
updated_at | ค่าเริ่มต้น: NULL | วันและเวลาที่มีการแก้ไขตัวเลือกสินค้าครั้งล่าสุด ได้รับการแสดงผลในรูปแบบ ISO 8601 | วันที่ | Datetime | |
weight | น้ําหนักของตัวเลือกสินค้าในระบบหน่วยวัด โดยระบุด้วย weight_unit | ||||
weight_unit |
|
หน่วยวัดที่ใช้กับน้ําหนักของตัวเลือกสินค้า หากคุณไม่ได้ระบุค่า weight_unit ระบบจะใช้งานหน่วยการวัดตามค่าเริ่มต้นของร้านค้า | varchar(2) |