Từ điển dữ liệu di chuyển cửa hàng

Từ điển dữ liệu di chuyển cửa hàng bao gồm thông tin về tài nguyên API quản trị REST Customer, OrderProduct. Từ điển dữ liệu cung cấp tài liệu tham khảo bổ sung cho các đối tác giàu kinh nghiệm đang di chuyển cửa hàng sang Shopify.

Customer thuộc tính tài nguyên

Bảng dưới đây liệt kê một số thông tin hữu ích về thuộc tính của tài nguyên API quản trị REST Customer.

Dữ liệu về thuộc tính quan trọng liên quan đến tài nguyên khách hàng REST
Thuộc tính Giá trị Mô tả Loại dữ liệu Độ dài trường Quyền truy cập trường Trường bắt buộc quan trọng
accepts_marketing Mặc định: 0 Khách hàng đồng ý nhận tài liệu tiếp thị hay không. Boolean tinyint(1) Y
accepts_marketing_
updated_at
Ngày giờ theo định dạng ISO 8601 khi khách hàng đồng ý hoặc phản đối nhận tài liệu tiếp thị qua email. DateTime
địa chỉ Danh sách địa chỉ liên kết với khách hàng. [{ Địa chỉ }]
đơn vị tiền tệ Mã gồm ba chữ cái theo định dạng ISO 4217 cho đơn vị tiền tệ mà khách hàng sử dụng khi thanh toán đơn hàng mới nhất. Chuỗi Đơn vị tiền tệ của cửa hàng chỉ đọc
created_at Mặc định: TRỐNG Ngày giờ theo định dạng ISO 8601 khi khách hàng được thêm vào cửa hàng. DateTime datetime chỉ đọc
default_address Địa chỉ mặc định dành cho khách hàng. { Address }
gửi email Mặc định: TRỐNG Địa chỉ email duy nhất của khách hàng. Chuỗi varchar(255)
first_name Mặc định: TRỐNG Tên của khách hàng. Chuỗi varchar(255)
id Mặc định: TRỐNG Mã nhận dạng duy nhất trên toàn hệ thống. (Giá trị này tự động gia tăng.) Số nguyên bigint(20) Y
last_name Mặc định: TRỐNG Họ của khách hàng. Chuỗi varchar(255)
last_order_id Mặc định: TRỐNG ID đơn hàng gần nhất của khách hàng. Số nguyên bigint(20) chỉ đọc
last_order_name Mặc định: TRỐNG Tên đơn hàng gần đây nhất của khách hàng. Chuỗi chỉ đọc
siêu trường Mặc định: TRỐNG Trả về trường thông tin bổ sung theo không gian tên và khóa thuộc về tài nguyên. { Trường thông tin bổ sung }
marketing_opt_
in_level
  • null
  • single_opt_in
  • confirmed_opt_in
  • không xác định
Mặc định: TRỐNG
Mức độ tham gia gói đăng ký tiếp thị (như mô tả trong hướng dẫn phương thức tối ưu của M3AAWG) mà khách hàng đưa ra khi họ đồng ý nhận tài liệu tiếp thị qua email. Chuỗi, enum
multipass_identifier Mặc định: TRỐNG Mã nhận dạng duy nhất dành cho khách hàng được dùng khi đăng nhập đa nền tảng. Chuỗi varchar(255)
lưu ý Mặc định: TRỐNG Ghi chú về khách hàng. Chuỗi mediumtext
orders_count Mặc định: 0 Số lượng đơn hàng mà khách hàng đã thực hiện tại cửa hàng từ trước tới nay. Số nguyên int (11) chỉ đọc
điện thoại Mặc định: TRỐNG Số điện thoại duy nhất (trên toàn cửa hàng) (định dạng E.164) cho khách hàng này. Chuỗi varchar(255)
sms_marketing_
consent
Mặc định: TRỐNG Trạng thái tiếp thị qua SMS hiện tại đối với số điện thoại của khách hàng. Chuỗi
trạng thái
  • đã tắt
  • đã mời
  • đã bật
  • đã từ chối
Mặc định: đã tắt
Trạng thái tài khoản của khách hàng với cửa hàng. Chuỗi, enum varchar(255) chỉ đọc
thẻ Mặc định: TRỐNG Danh sách phân tách bằng dấu phẩy gồm tối đa 250 thẻ đã được thêm vào khách hàng. Chuỗi 255 mỗi thẻ
tax_exempt Mặc định: 0 Khách hàng có được miễn thuế trên đơn hàng của họ hay không. Boolean tinyint(1) Y
tax_exemptions Tham khảo tài nguyên Khách hàng để biết danh sách giá trị đầy đủ. Danh sách miễn thuế áp dụng cho khách hàng. Chuỗi
total_spent Mặc định: 0 Tổng số tiền mà khách hàng đã chi để đặt hàng từ trước tới nay. Được niêm yết theo đơn vị tiền tệ của cửa hàng. Nếu sử dụng nhiều đơn vị tiền tệ, số tiền hiển thị sẽ là đơn vị tiền tệ mặc định không có tỷ giá hối đoái. Số lượng decimal(21,3) chỉ đọc
updated_at Ngày giờ cập nhật khách hàng gần nhất. Dựa trên múi giờ của Shop. DateTime datetime chỉ đọc
verified_email Mặc định: 1 Khách hàng đã xác minh địa chỉ email hay chưa. Mặc định là true nếu khách hàng được tạo thông qua trang quản trị Shopify hoặc API. Boolean tinyint(1) chỉ đọc

CustomerAddress thuộc tính tài nguyên

Bảng dưới đây liệt kê một số thông tin hữu ích về thuộc tính của tài nguyên API quản trị REST CustomerAddress đó. Không có trường bắt buộc quan trọng cho tài nguyên này.

Dữ liệu về thuộc tính quan trọng liên quan đến tài nguyên Địa chỉ của khách hàng REST
Thuộc tính Giá trị Mô tả Loại dữ liệu Độ dài trường Quyền truy cập trường
address1 Mặc định: TRỐNG Địa chỉ gửi thư của khách hàng. 100 mỗi tài khoản khách hàng. Chuỗi varchar(255)
address2 Mặc định: TRỐNG Trường bổ sung cho địa chỉ gửi thư của khách hàng. Chuỗi varchar(255)
city Mặc định: TRỐNG Thành phố, thị trấn hoặc làng của khách hàng. Chuỗi varchar(255)
company Mặc định: TRỐNG Công ty của khách hàng. Chuỗi varchar(255)
quốc gia Mặc định: TRỐNG Quốc gia của khách hàng. Chuỗi varchar(255)
first_name Mặc định: TRỐNG Tên của khách hàng. Chuỗi varchar(255)
country_code Mã quốc gia có hai chữ cái tương ứng với quốc gia của khách hàng. Chuỗi chỉ đọc
country_name Tên quốc gia được bình thường hóa của khách hàng. Chuỗi
last_name Mặc định: TRỐNG Họ của khách hàng. Chuỗi varchar(255)
tên Họ và tên của khách hàng. Chuỗi
điện thoại Mặc định: TRỐNG Số điện thoại của khách hàng tại địa chỉ này. Chuỗi varchar(255)
province Mặc định: TRỐNG Tên vùng của khách hàng. Thường là tỉnh, tiểu bang hoặc quận. Chuỗi varchar(255)
province_code Mã có hai chữ cái cho vùng của khách hàng. Chuỗi chỉ đọc
ZIP Mặc định: TRỐNG Mã bưu chính của khách hàng, còn được gọi là mã ZIP, mã bưu điện, Eircode, v.v. Chuỗi varchar(255)

Order thuộc tính tài nguyên

Bảng dưới đây liệt kê một số thông tin hữu ích về thuộc tính của tài nguyên API quản trị REST Order.

Dữ liệu về thuộc tính quan trọng của tài nguyên Đơn hàng REST
Thuộc tính Giá trị Mô tả Loại dữ liệu Độ dài trường Quyền truy cập trường Trường bắt buộc quan trọng
app_id Mặc định: TRỐNG ID của ứng dụng đã tạo đơn hàng. số nguyên bigint(20) chỉ đọc
billing_address Mặc định: TRỐNG Địa chỉ gửi thư liên kết với phương thức thanh toán. Địa chỉ này là trường tùy chọn không áp dụng cho đơn hàng không yêu cầu phương thức thanh toán. số nguyên bigint(20)
browser_ip Địa chỉ IP của trình duyệt mà khách hàng sử dụng khi đặt đơn hàng. Cả IPv4 và IPv6 đều được hỗ trợ. string varchar(255) chỉ đọc
buyer_accepts_marketing Mặc định: 0 Khách hàng có đồng ý nhận thông tin cập nhật qua email từ cửa hàng hay không. boolean tinyint(1)
cancel_reason
  • khách hàng
  • gian lận
  • hàng trong kho
  • đã từ chối
  • khác
Mặc định: TRỐNG
Lý do đơn hàng bị hủy string varchar(255)
cancelled_at Mặc định: TRỐNG Ngày giờ hủy đơn hàng. Trả về nội dung trống nếu đơn hàng không bị hủy. date datetime chỉ đọc
cart_token Mặc định: TRỐNG Giá trị duy nhất khi tham chiếu giỏ hàng liên quan đến đơn hàng. string varchar(255) chỉ đọc
checkout_token Mặc định: TRỐNG Giá trị duy nhất khi tham chiếu thanh toán liên quan đến đơn hàng. string varchar(64) chỉ đọc
client_details
  • accept_language
  • browser_height
  • browser_ip
  • browser_width
  • session_hash
  • user_agent
Thông tin về trình duyệt mà khách hàng sử dụng khi đặt đơn hàng:

accept_language: Ngôn ngữ và vùng miền mà trình duyệt hiểu.
browser_height: Chiều cao màn hình trình duyệt theo pixel, nếu có.
browser_ip: Địa chỉ IP của trình duyệt.
browser_width: Chiều rộng màn hình trình duyệt theo pixel, nếu có.
session_hash: Hàm băm của phiên.
user_agent: Thông tin chi tiết về máy khách duyệt, bao gồm phiên bản phần mềm và phiên bản hệ điều hành.
đối tượng chỉ đọc
closed_at Mặc định: TRỐNG Ngày giờ (định dạng ISO 8601) khi đóng đơn hàng. Trả về nội dung trống nếu đơn hàng chưa đóng. date datetime chỉ đọc
created_at Mặc định: TRỐNG Ngày giờ tự tạo (định dạng ISO 8601) khi đơn hàng được tạo trong Shopify. Không thể thay đổi giá trị cho thuộc tính này. date datetime(6) chỉ đọc
đơn vị tiền tệ Mặc định: TRỐNG Mã gồm ba chữ cái (định dạng ISO 4217) cho đơn vị tiền tệ của cửa hàng. string char(3)
current_subtotal_price Giá tổng phụ hiện tại của đơn hàng theo đơn vị tiền tệ của cửa hàng. Giá trị của trường này thể hiện nội dung chỉnh sửa đơn hàng, đơn hàng trả lại và hoàn tiền. string varchar(255) chỉ đọc
current_subtotal_price_set Giá tổng phụ hiện tại của đơn hàng theo đơn vị tiền tệ hiển thị và đơn vị tiền tệ của cửa hàng. Giá trị khoản tiền liên kết với trường này thể hiện nội dung chỉnh sửa đơn hàng, đơn hàng trả lại và hoàn tiền. đối tượng chỉ đọc
current_total_discounts Tổng ưu đãi giảm giá hiện tại của đơn hàng theo đơn vị tiền tệ của cửa hàng. Giá trị của trường này thể hiện nội dung chỉnh sửa đơn hàng, đơn hàng trả lại và hoàn tiền. string varchar(255) chỉ đọc
current_total_discounts_set Tổng ưu đãi giảm giá hiện tại của đơn hàng theo đơn vị tiền tệ hiển thị và đơn vị tiền tệ của cửa hàng. Giá trị khoản tiền liên quan đến trường này thể hiện nội dung chỉnh sửa đơn hàng, đơn hàng trả lại và hoàn tiền. đối tượng chỉ đọc
current_total_duties_set Tổng thuế hiện tại được tính cho đơn hàng theo đơn vị tiền tệ của cửa hàng và đơn vị tiền tệ hiển thị. Giá trị khoản tiền liên quan đến trường này thể hiện nội dung chỉnh sửa đơn hàng, đơn hàng trả lại và hoàn tiền. đối tượng chỉ đọc
current_total_price Tổng giá hiện tại của đơn hàng theo đơn vị tiền tệ của cửa hàng. Giá trị của trường này thể hiện nội dung chỉnh sửa đơn hàng, đơn hàng trả lại và hoàn tiền. string varchar(255) chỉ đọc
current_total_price_set Tổng giá hiện tại của đơn hàng theo đơn vị tiền tệ của cửa hàng và đơn vị tiền tệ hiển thị. Giá trị khoản tiền liên quan đến trường này thể hiện nội dung chỉnh sửa đơn hàng, đơn hàng trả lại và hoàn tiền. đối tượng chỉ đọc
current_total_tax Tổng thuế hiện tại được tính cho đơn hàng theo đơn vị tiền tệ của cửa hàng. Giá trị của trường này thể hiện nội dung chỉnh sửa đơn hàng, đơn hàng trả lại hoặc hoàn tiền. string varchar(255) chỉ đọc
current_total_tax_set Tổng thuế hiện tại được tính cho đơn hàng theo đơn vị tiền tệ của cửa hàng và đơn vị tiền tệ hiển thị. Giá trị khoản tiền liên quan đến trường này thể hiện nội dung chỉnh sửa đơn hàng, đơn hàng trả lại và hoàn tiền. đối tượng chỉ đọc
khách hàng Mặc định: TRỐNG Thông tin về khách hàng. Đơn hàng có thể không có khách hàng và ứng dụng không nên phụ thuộc vào sự tồn tại của đối tượng khách hàng. Giá trị này có thể là trống nếu đơn hàng được tạo qua Shopify POS số nguyên bigint(20)
customer_locale Mặc định: TRỐNG Mã ngôn ngữ gồm hai hoặc ba chữ cái, có thể đi kèm trình sửa vùng. string varchar(255) chỉ đọc
discount_applications Danh sách ứng dụng giảm giá được sắp xếp theo thứ tự.

Thuộc tính discount_applications bao gồm 3 loại: discount_code, thủ công và tập lệnh. Cả 3 loại đều có cấu trúc chung và có một số thuộc tính của riêng loại đó.
array chỉ đọc
discount_codes Danh sách ưu đãi giảm giá áp dụng cho đơn hàng. array
gửi email Địa chỉ email của khách hàng. varchar(255)
estimated_taxes Thuế trên đơn hàng có được ước tính hay không. Nhiều yếu tố có thể thay đổi giữa thời điểm khách đặt đơn hàng đến thời điểm vận chuyển đơn hàng, điều này có thể ảnh hưởng đến việc tính thuế. Thuộc tính này trả về giá trị false khi thuế trên đơn hàng là chính thức và không chịu bất kỳ thay đổi nào. boolean tinyint(1)
financial_status
  • đang chờ
  • đã ủy quyền
  • partially_paid
  • đã thanh toán
  • partially_refunded
  • đã hoàn tiền
Mặc định: TRỐNG
Trạng thái của các khoản thanh toán liên quan đến đơn hàng. Chỉ có thể thiết lập khi đơn hàng được tạo. string varchar(255) chỉ đọc
fulfillment_status
  • đã thực hiện
  • chưa thực hiện
  • null
  • một phần
  • đã trả về kho
Mặc định: chưa thực hiện
Trạng thái đơn hàng theo mục hàng đã thực hiện. string varchar(255)
thực hiện đơn hàng Một loạt quá trình thực hiện liên quan đến đơn hàng array
id Mặc định: TRỐNG ID đơn hàng được sử dụng cho mục đích API. ID này khác với thuộc tính order_number được chủ sở hữu cửa hàng và khách hàng sử dụng. số nguyên bigint(20) chỉ đọc
landing_site Mặc định: TRỐNG URL của trang mà người mua đã đến khi họ vào cửa hàng. string varchar(4096) chỉ đọc
line_items Danh sách đối tượng mục hàng, mỗi mục chứa thông tin về một mặt hàng trong đơn hàng array Y
location_id Mặc định: TRỐNG ID địa điểm thực tế nơi xử lý đơn hàng. Nếu bạn cần tham chiếu địa điểm với đơn hàng, sử dụng tài nguyên FulfillmentOrder. số nguyên bigint(20)
tên Mặc định: TRỐNG Tên đơn hàng, được tạo bằng cách kết hợp thuộc tính order_number với tiền tố order và hậu tố được đặt trong cài đặt chung của thương nhân. ID này khác với thuộc tính id là ID của đơn hàng được API sử dụng. API cũng có thể đặt trường này là bất kỳ giá trị chuỗi nào. string varchar(255)
lưu ý Mặc định: TRỐNG Ghi chú tùy chọn mà chủ sở hữu cửa hàng có thể đính kèm đơn hàng. string
note_attributes Mặc định: TRỐNG Thông tin phụ được thêm vào đơn hàng. Xuất hiện trong mục Chi tiết bổ sung của trang thông tin chi tiết đơn hàng. Mỗi mục nhập mảng phải chứa hàm băm gồm tên và khóa giá trị. string
number Mặc định: TRỐNG Vị trí của đơn hàng trong số lượng đơn hàng của cửa hàng. Số có thứ tự và bắt đầu từ 1. số nguyên int (11) chỉ đọc
order_number Vị trí của đơn hàng trong số lượng đơn hàng của cửa hàng bắt đầu từ 1001. Số đơn hàng có thứ tự. số nguyên bigint(20) chỉ đọc
order_status_url URL trỏ đến trang web trạng thái đơn hàng, nếu có. string varchar(255) chỉ đọc
original_total_duties_set Tổng thuế ban đầu được tính cho đơn hàng theo đơn vị tiền tệ của cửa hàng và đơn vị tiền tệ hiển thị. đối tượng chỉ đọc
payment_gateway_names Mặc định: TRỐNG Danh sách cổng thanh toán được sử dụng cho đơn hàng.
varchar(255) chỉ đọc
payment_terms Mặc định: TRỐNG Các điều khoản và điều kiện để xử lý thanh toán. đối tượng bigint(20) chỉ đọc
điện thoại Mặc định: TRỐNG Số điện thoại của khách hàng để nhận thông báo qua SMS. string varchar(255)
presentment_currency Mặc định: TRỐNG Đơn vị tiền tệ hiển thị dùng để hiển thị giá cho khách hàng. string char(3)
processed_at Mặc định: TRỐNG Ngày giờ (định dạng ISO 8601) khi xử lý đơn hàng. Giá trị này là ngày hiển thị trên đơn hàng của và được sử dụng trong báo cáo phân tích. Nếu đang nhập đơn hàng từ một ứng dụng hoặc nền tảng khác, bạn có thể đặt processed_at thành ngày giờ trong quá khứ để khớp với thời gian tạo đơn hàng ban đầu. date datetime(6)
processing_method
  • thanh toán
  • trực tiếp
  • thủ công
  • ngoài trang web
  • express
  • miễn phí
Cách xử lý thanh toán string varchar(255) chỉ đọc
referring_site Mặc định: TRỐNG Trang web nơi khách hàng nhấp vào liên kết đến cửa hàng. string varchar(4096)
hoàn tiền Danh sách các khoản hoàn tiền áp dụng cho đơn hàng array chỉ đọc
shipping_address Mặc định: TRỐNG Địa chỉ gửi thư nơi đơn hàng được vận chuyển đến. Địa chỉ này không bắt buộc và không áp dụng cho đơn hàng không yêu cầu vận chuyển số nguyên bigint(20)
shipping_lines Một loạt đối tượng, mỗi đối tượng có các thông tin chi tiết về phương thức vận chuyển được sử dụng. array
source_name Mặc định: TRỐNG Nơi xuất phát của đơn hàng. Chỉ có thể đặt trong quá trình tạo đơn hàng và không thể chỉnh sửa sau đó. Các giá trị cho kênh Shopify được bảo vệ và không thể được chỉ định bởi máy khách API khác: web, pos, shopify_draft_order, iphone và android. Có thể chỉ định tùy ý các đơn hàng được tạo qua API. Nếu chưa xác định, đơn hàng mới sẽ được chỉ định giá trị ID ứng dụng. string varchar(255)
subtotal_price Giá đơn hàng theo đơn vị tiền tệ của cửa hàng sau khi giảm giá nhưng chưa tính phí vận chuyển, thuế, thuế nhập khẩu và tiền boa. số nguyên bigint(20)
subtotal_price_set Tổng phụ của đơn hàng theo đơn vị tiền tệ cửa hàng và đơn vị tiền tệ hiển thị sau khi giảm giá, nhưng chưa tính phí vận chuyển, thuế, thuế nhập khẩu và tiền boa. đối tượng
thẻ Thẻ được gắn vào đơn hàng, có định dạng là chuỗi các giá trị phân tách bằng dấu phẩy. Thẻ là những mã mô tả ngắn bổ sung, thường được dùng để lọc và tìm kiếm. Độ dài của từng thẻ giới hạn trong vòng 40 ký tự. string varchar(4096)
tax_lines Một loạt đối tượng loại thuế, mỗi đối tượng gồm thông tin chi tiết về thuế áp dụng cho đơn hàng. Mỗi đối tượng có các thuộc tính sau:

Khi tạo đơn hàng qua API, có thể chỉ định loại thuế trên đơn hàng hoặc mục hàng nhưng không thể chỉ định cho cả hai. Loại thuế được chỉ định trên đơn hàng được phân chia theo các mục hàng chịu thuế trong đơn hàng đã tạo.
array
taxes_included
  • true
  • false
Mặc định: 0
Thuế có được thêm vào tổng phụ của đơn hàng hay không. boolean tinyint(1)
thử nghiệm
  • true
  • false
Mặc định: 0
Đây có phải đơn hàng kiểm tra hay không. boolean tinyint(1) chỉ đọc
token Mặc định: TRỐNG Một giá trị duy nhất khi tham chiếu đơn hàng. string varchar(32) chỉ đọc
total_discounts Mặc định: 0 Tổng ưu đãi giảm giá áp dụng cho giá của đơn hàng theo đơn vị tiền tệ của cửa hàng. string decimal(21,3)
total_discounts_set Tổng ưu đãi giảm giá áp dụng cho giá của đơn hàng theo đơn vị tiền tệ của cửa hàng và đơn vị tiền tệ hiển thị. đối tượng
total_line_items_price Mặc định: 0 Tổng giá của tất cả mục hàng bằng đơn vị tiền tệ của cửa hàng. string decimal(21,3)
total_line_items_price_set Tổng giá của tất cả các mục hàng bằng đơn vị tiền tệ của cửa hàng và đơn vị tiền tệ hiển thị. đối tượng
total_outstanding Mặc định: 0 Tổng số tiền chưa thanh toán của đơn hàng bằng đơn vị tiền tệ của cửa hàng. string decimal(21,3)
total_price Mặc định: 0 Tổng giá của tất cả mục hàng, ưu đãi giảm giá, phí vận chuyển, thuế và tiền boa theo đơn vị tiền tệ của cửa hàng. Phải là số dương. string decimal(21,3)
total_price_set Tổng giá đơn hàng bằng đơn vị tiền tệ của cửa hàng và đơn vị tiền tệ hiển thị. đối tượng
total_shipping_price_set Tổng cước phí vận chuyển của đơn hàng, không bao gồm ưu đãi giảm giá và đơn hàng trả lại, theo đơn vị tiền tệ của cửa hàng và đơn vị tiền tệ hiển thị. Nếu taxes_included là true, total_shipping_price_set sẽ bao gồm thuế. đối tượng
total_tax Mặc định: 0 Tổng tất cả các khoản thuế áp dụng cho đơn hàng bằng đơn vị tiền tệ của cửa hàng. Phải là số dương. string decimal(21,3)
total_tax_set Tổng thuế áp dụng cho đơn hàng bằng đơn vị tiền tệ của cửa hàng và đơn vị tiền tệ hiển thị. đối tượng
total_tip_received Tổng tiền boa trong đơn hàng bằng đơn vị tiền tệ của cửa hàng. số nguyên bigint(20) chỉ đọc
total_weight Mặc định: 0 Tổng trọng lượng của tất cả mục hàng theo gam. Tổng này không được điều chỉnh vì các mặt hàng bị xóa khỏi đơn hàng. số nguyên bigint(20) không dấu
updated_at Ngày và giờ (định dạng theo ISO 8601) khi đơn hàng được sửa đổi gần đây nhất. date datetime(6) chỉ đọc
user_id Mặc định: TRỐNG ID của người dùng đã đăng nhập vào Shopify POS và xử lý đơn hàng, nếu có. số nguyên bigint(20)

Product thuộc tính tài nguyên

Bảng dưới đây liệt kê một số thông tin hữu ích về thuộc tính của tài nguyên API quản trị REST Product.

Dữ liệu về thuộc tính quan trọng của tài nguyên sản phẩm REST
Thuộc tính Giá trị Mô tả Loại dữ liệu Độ dài trường Quyền truy cập trường Trường bắt buộc quan trọng
body_html Mặc định: TRỐNG Mô tả sản phẩm. Hỗ trợ định dạng HTML. string mediumtext
created_at Mặc định: TRỐNG Ngày và giờ (định dạng theo ISO 8601) khi tạo sản phẩm. date datetime chỉ đọc
handle Mặc định: TRỐNG string varchar(255)
id Mặc định: TRỐNG Một số nguyên 64-bit không dấu được sử dụng làm mã nhận dạng duy nhất của sản phẩm. Mỗi ID đều là duy nhất trên toàn hệ thống Shopify. Không sản phẩm nào có cùng ID với sản phẩm khác, ngay cả khi các sản phẩm thuộc các cửa hàng khác nhau. số nguyên bigint(20) chỉ đọc Y
hình ảnh Danh sách đối tượng hình ảnh sản phẩm, mỗi đối tượng thể hiện hình ảnh đi kèm với sản phẩm. [{ hình ảnh sản phẩm }]
tùy chọn Thuộc tính sản phẩm tùy chỉnh. Ví dụ: Kích cỡ, màu sắc và chất liệu. Mỗi sản phẩm có thể có tối đa 3 tùy chọn và mỗi giá trị tùy chọn có thể lên đến 255 ký tự. Mẫu mã sản phẩm được tạo từ các tổ hợp giá trị tùy chọn. Không thể tạo tùy chọn nếu không có giá trị. Để tạo tùy chọn mới, cần tạo mẫu mã có giá trị tùy chọn tương ứng. array
product_type Mặc định: TRỐNG Phân loại sản phẩm dùng để lọc và tìm kiếm sản phẩm. string varchar(255)
published_at Mặc định: TRỐNG Ngày giờ (định dạng ISO 8601) đăng sản phẩm. Có thể đặt thành trống để hủy đăng sản phẩm trên kênh Cửa hàng trực tuyến. date datetime
published_scope
  • web
  • toàn cầu
Sản phẩm có được đăng lên kênh Điểm bán hàng hay không. string
trạng thái
  • đang hoạt động
  • đã lưu trữ
  • nháp
Mặc định: đang hoạt động
Trạng thái của sản phẩm. string varchar(32)
thẻ Chuỗi các thẻ được phân tách bằng dấu phẩy dùng để lọc và tìm kiếm. Một sản phẩm có thể có tối đa 250 thẻ. Mỗi thẻ có thể có tối đa 255 ký tự. string
template_suffix Mặc định: TRỐNG Hậu tố của mẫu Liquid được dùng cho trang sản phẩm. Nếu chỉ định thuộc tính này, trang sản phẩm sẽ sử dụng mẫu có tên "product.suffix.liquid", trong đó "suffix" là giá trị của thuộc tính này. Nếu thuộc tính này là "" hoặc trống, trang sản phẩm sử dụng mẫu mặc định "product.liquid". string varchar(255)
tiêu đề Mặc định: TRỐNG Tên sản phẩm string varchar(255)
updated_at Mặc định: TRỐNG Ngày giờ (định dạng ISO 8601) khi sản phẩm được sửa đổi gần đây nhất. Giá trị updated_at của sản phẩm có thể thay đổi vì nhiều lý do. Ví dụ: Nếu đơn hàng được đặt cho sản phẩm đã thiết lập theo dõi hàng tồn kho, điều chỉnh hàng tồn kho sẽ được tính là cập nhật. date datetime chỉ đọc
mẫu mã Một loạt mẫu mã sản phẩm, mỗi mẫu mã thể hiện một phiên bản khác của sản phẩm. Thuộc tính vị trí là chỉ đọc. Vị trí của mẫu mã được thể hiện bằng đơn hàng được liệt kê trong đó. array
nhà cung cấp Mặc định: TRỐNG Tên nhà cung cấp sản phẩm. string varchar(255)

ProductImage thuộc tính tài nguyên

Bảng dưới đây liệt kê một số thông tin hữu ích về thuộc tính của tài nguyên API quản trị REST ProductImage. Không có trường bắt buộc chỉ đọc hoặc quan trọng cho tài nguyên này.

Dữ liệu về thuộc tính quan trọng liên quan đến tài nguyên ProductImage REST
Thuộc tính Giá trị Mô tả Loại dữ liệu Độ dài trường
created_at Mặc định: TRỐNG Ngày giờ tạo hình ảnh sản phẩm. API trả về giá trị này theo định dạng ISO 8601. date datetime
height Mặc định: TRỐNG Chiều cao của hình ảnh được xác định khi tải lên. smallint(4) không dấu
id Mặc định: TRỐNG Chuỗi số nhận dạng duy nhất cho hình ảnh sản phẩm. (auto_increment) số nguyên bigint(20)
position Mặc định: 0 Thứ tự hình ảnh sản phẩm trong danh sách. Hình ảnh sản phẩm đầu tiên ở vị trí 1 và là hình ảnh "chính" của sản phẩm. smallint(5) không dấu
product_id Mặc định: TRỐNG ID của sản phẩm liên quan đến hình ảnh. bigint(20)
src Chỉ định vị trí của hình ảnh sản phẩm. Tham số này hỗ trợ bộ lọc URL bạn có thể sử dụng để truy xuất bản sao hình ảnh đã sửa đổi. Ví dụ: Thêm _small vào tên tệp để truy xuất bản sao hình ảnh thu nhỏ ở độ phân giải 100 x 100 px (ví dụ: ipod-nano_small.png) hoặc thêm _2048x2048 để truy xuất bản sao hình ảnh bị hạn chế ở độ phân giải 2048 x 2048 px (ví dụ: ipod-nano_2048x2048.png).
updated_at Mặc định: TRỐNG Ngày giờ sửa đổi hình ảnh sản phẩm gần đây nhất. API trả về giá trị này theo định dạng ISO 8601. date datetime
variant_ids Một loạt ID mẫu mã liên quan đến hình ảnh.
width Mặc định: TRỐNG Chiều rộng của hình ảnh được xác định khi tải lên. smallint(4) không dấu

ProductVariant thuộc tính tài nguyên

Bảng dưới đây liệt kê một số thông tin hữu ích về thuộc tính của tài nguyên API quản trị REST ProductVariant đó. Không có trường bắt buộc quan trọng cho tài nguyên này.

Dữ liệu về thuộc tính quan trọng liên quan đến tài nguyên ProductVariant REST
Thuộc tính Giá trị Mô tả Loại dữ liệu Độ dài trường Quyền truy cập trường
mã vạch Mặc định: TRỐNG Mã vạch, UPC hoặc số ISBN của sản phẩm. varchar(255)
compare_at_price Mặc định: TRỐNG Giá ban đầu của mặt hàng trước khi điều chỉnh hoặc giảm giá. decimal(20,2)
created_at Mặc định: TRỐNG Ngày giờ theo định dạng ISO 8601 khi tạo mẫu mã sản phẩm. date datetime
fulfillment_service
  • thủ công
  • { mã điều khiển của dịch vụ hoàn tất đơn hàng }
Mặc định: thủ công
Dịch vụ hoàn tất đơn hàng liên quan đến mẫu mã sản phẩm. varchar(255)
gam Trọng lượng của mẫu mã sản phẩm theo gam.
id Mặc định: TRỐNG Chuỗi số nhận dạng duy nhất cho mẫu mã sản phẩm. Giá trị này tự động gia tăng. bigint(20)
image_id Mặc định: TRỐNG Chuỗi số nhận dạng duy nhất cho hình ảnh sản phẩm. Hình ảnh phải được liên kết với cùng một sản phẩm theo mã. bigint(20)
inventory_item_id Mã nhận dạng duy nhất cho mặt hàng trong kho, được sử dụng trong API hàng trong kho để truy vấn thông tin hàng trong kho.
inventory_management
  • shopify
  • null
  • { mã điều khiển của dịch vụ hoàn tất đơn hàng }
  • Mặc định: TRỐNG
    Dịch vụ hoàn tất đơn hàng theo dõi số lượng mặt hàng trong kho đối với mẫu mã sản phẩm. varchar(255)
    inventory_policy
    • từ chối
    • tiếp tục
    Mặc định: từ chối
    Khách hàng có được phép đặt hàng mẫu mã sản phẩm khi mẫu mã sản phẩm đó hết hàng hay không. varchar(40)
    inventory_quantity Mặc định: 1 Tổng hợp hàng trong kho tại tất cả địa điểm. Để điều chỉnh hàng trong kho tại một địa điểm cụ thể, sử dụng tài nguyên InventoryLevel. int (11) chỉ đọc
    option Thuộc tính tùy chỉnh mà chủ cửa hàng sử dụng để xác định mẫu mã sản phẩm. Bạn có thể xác định ba tùy chọn cho mẫu mã sản phẩm: option1, option2, option3. Giá trị mặc định: Tiêu đề mặc định. Trường tiêu đề là kết hợp của các trường option1, option2 và option3. Cập nhật các trường tùy chọn sẽ cập nhật trường tiêu đề.
    position Mặc định: 0 Thứ tự của mẫu mã sản phẩm trong danh sách mẫu mã sản phẩm. Vị trí đầu tiên trong danh sách là 1. Vị trí của mẫu mã được thể hiện theo thứ tự được liệt kê. smallint(5) không dấu chỉ đọc
    presentment_prices Danh sách giá hiển thị và giá gốc của mẫu mã theo từng đơn vị tiền tệ hiển thị được kích hoạt của cửa hàng. Mỗi đối tượng giá có các thuộc tính sau:
    -currency_code: Mã gồm ba chữ cái (định dạng ISO 4217) cho một trong các đơn vị tiền tệ hiển thị được kích hoạt của cửa hàng.
    -amount: Giá hoặc giá gốc của mẫu mã bằng đơn vị tiền tệ hiển thị.
    Yêu cầu đầu trang "X-Shopify-Api-Features": "include-presentment-prices".
    chỉ đọc
    giá Mặc định: 0 Giá của mẫu mã sản phẩm. decimal(20,2)
    product_id Mặc định: TRỐNG Số định danh duy nhất cho sản phẩm. bigint(20)
    requires_shipping Mặc định: 1 Thuộc tính này đã lỗi thời. Thay vào đó, sử dụng thuộc tính "requires_shipping" trong tài nguyên InventoryItem. boolean tinyint(1)
    sku Mã nhận dạng duy nhất cho mẫu mã sản phẩm trong cửa hàng. Bắt buộc để kết nối với FulfillmentService. varchar(255)
    tax_code Tham số này chỉ áp dụng cho các cửa hàng đã cài đặt ứng dụng Avalara AvaTax. Chỉ định mã số thuế Avalara cho mẫu mã sản phẩm.
    chịu thuế Mặc định: 1 Có tính thuế khi bán mẫu mã sản phẩm hay không. boolean tinyint(1)
    tiêu đề Tiêu đề của mẫu mã sản phẩm. Trường tiêu đề là kết hợp của các trường option1, option2 và option3. Bạn chỉ có thể cập nhật tiêu đề gián tiếp qua các trường option. varchar(255) chỉ đọc
    updated_at Mặc định: TRỐNG Ngày giờ sửa đổi mẫu mã sản phẩm gần đây nhất. Trả về theo định dạng ISO 8601. date datetime
    weight Trọng lượng của mẫu mã sản phẩm theo hệ đơn vị được chỉ định bằng weight_unit.
    weight_unit
    • g
    • kg
    • oz
    • lb
    Mặc định: TRỐNG
    Đơn vị đo lường áp dụng cho trọng lượng của mẫu mã sản phẩm. Nếu bạn không chỉ định giá trị cho weight_unit, đơn vị đo lường mặc định của cửa hàng sẽ được áp dụng. varchar(2)