Kaupan siirtämistä koskeva tietohakemisto

Kaupan siirtämistä koskevassa tietohakemistossa on tietoja REST Admin APIn Customer-, Order- ja Product-resursseista. Tietohakemisto on Shopifyhin kauppoja siirtäville kokeneille kumppaneille tarkoitettu täydentävä hakuteos.

Customer -resurssin ominaisuudet

Seuraavassa taulukossa luetellaan joitakin hyödyllisiä tietoja REST Admin APIn Customer-resurssin ominaisuuksista.

Tietoja REST Customer ‑resurssin tärkeistä ominaisuuksista
Ominaisuus Arvot Kuvaus Datatyyppi Kentän pituus Kentän käyttöoikeus Kriittinen pakollinen kenttä
accepts_marketing Oletus: 0 Onko asiakas suostunut vastaanottamaan markkinointimateriaalia. Totuusarvo tinyint(1) Y
accepts_marketing_
updated_at
ISO 8601 ‑muodossa oleva päivämäärä ja kellonaika, jolloin asiakas suostui vastaanottamaan markkinointimateriaalia sähköpostitse tai kieltäytyi siitä. Päivämäärä/aika
osoitteet Luettelo asiakkaaseen liittyvistä osoitteista. [{ Address }]
valuutta Asiakkaan viimeisimmän tilauksensa maksamiseen käyttämän valuutan kolmikirjaiminen koodi ISO 4217 ‑muodossa. Merkkijono Kaupan käyttämä valuutta vain luku
created_at Oletus: NULL ISO 8601 ‑muodossa oleva päivämäärä ja kellonaika, jolloin asiakas lisättiin kauppaan. Päivämäärä/aika Päivämäärä/aika vain luku
default_address Asiakkaan oletusosoite. { Address }
sähköposti Oletus: NULL Asiakkaan yksilöllinen sähköpostiosoite. Merkkijono varchar(255)
first_name (etunimi) Oletus: NULL Asiakkaan etunimi. Merkkijono varchar(255)
id Oletus: NULL Yleisesti yksilöivä tunniste. (Arvo kasvaa automaattisesti.) Kokonaisluku bigint(20) Y
last_name (sukunimi) Oletus: NULL Asiakkaan sukunimi. Merkkijono varchar(255)
last_order_id Oletus: NULL Asiakkaan viimeisimmän tilauksen tunnus. Kokonaisluku bigint(20) vain luku
last_order_name Oletus: NULL Asiakkaan viimeisimmän tilauksen nimi. Merkkijono vain luku
metakenttä Oletus: NULL Palauttaa resurssiin kuuluvan metakentän nimiavaruuden ja avaimen. { Metafield }
marketing_opt_
in_level
  • null
  • single_opt_in
  • confirmed_opt_in
  • unknown
Oletus: NULL
Markkinointitilauksen suostumustaso (parhaita käytäntöjä koskevan M3AAWG-ohjeen mukaan), jonka asiakas antoi suostuessaan vastaanottamaan markkinointimateriaalia sähköpostitse. Merkkijono, luettelointi
multipass_identifier Oletus: NULL Multipass-kirjautumisessa käytetty asiakkaan yksilöllinen tunniste. Merkkijono varchar(255)
huomaa Oletus: NULL Asiakasta koskeva kommentti. Merkkijono mediumtext
orders_count Oletus: 0 Asiakkaan kaupassa elinkaarensa aikana tekemien tilausten määrä. Kokonaisluku int(11) vain luku
puhelin Oletus: NULL Tämän asiakkaan yksilöllinen (koko kauppaa koskeva) puhelinnumero (E.164-muodossa). Merkkijono varchar(255)
sms_marketing_
consent
Oletus: NULL Asiakkaan puhelinnumeron nykyinen tekstiviestimarkkinoinnin tila. Merkkijono
Valtion
  • poissa käytöstä
  • kutsuttu
  • käytössä
  • hylätty
Oletus: disabled
Asiakkaan kaupassa olevan tilin tila. Merkkijono, luettelointi varchar(255) vain luku
tunnisteet Oletus: NULL Pilkulla erotettu luettelo enintään 250 tunnisteesta, jotka on lisätty asiakkaaseen. Merkkijono 255 per tunniste
tax_exempt Oletus: 0 Onko asiakas vapautettu tilauksiaan koskevin verojen maksamisesta. Totuusarvo tinyint(1) Y
tax_exemptions Täydellinen luettelo arvoista on Customer-resurssissa. Luettelo asiakkaaseen sovellettavista verovapautuksista. Merkkijono
total_spent Oletus: 0 Kokonaissumma, jonka asiakas on käyttänyt tilauksiin elinkaarensa aikana. Näkyy kaupan valuutassa. Useita valuuttoja käytettäessä näkyvissä oleva summa on oletusvaluutassa ilman vaihtokurssia. Määrä decimal(21,3) vain luku
updated_at Päivämäärä ja kellonaika, jolloin asiakas päivitettiin viimeksi. Kaupan aikavyöhykkeen mukainen. Päivämäärä/aika Päivämäärä/aika vain luku
verified_email Oletus: 1 Onko asiakas vahvistanut sähköpostiosoitteensa. Oletusarvo on tosi, jos asiakas on luotu Shopify Adminin tai API:n kautta. Totuusarvo tinyint(1) vain luku

CustomerAddress -resurssin ominaisuudet

Seuraavassa taulukossa luetellaan joitakin hyödyllisiä tietoja REST Admin APIn CustomerAddress-resurssin ominaisuuksista. Tällä resurssilla ei ole kriittisiä pakollisia kenttiä.

Tietoja REST Customer Address ‑resurssin tärkeistä ominaisuuksista
Ominaisuus Arvot Kuvaus Datatyyppi Kentän pituus Kentän käyttöoikeus
address1 Oletus: NULL Asiakkaan postiosoite. 100 asiakastiliä kohti. Merkkijono varchar(255)
address2 Oletus: NULL Lisäkenttä asiakkaan postiosoitetta varten. Merkkijono varchar(255)
city Oletus: NULL Asiakkaan kaupunki tai kylä. Merkkijono varchar(255)
company Oletus: NULL Asiakkaan yritys. Merkkijono varchar(255)
maa Oletus: NULL Asiakkaan maa. Merkkijono varchar(255)
first_name (etunimi) Oletus: NULL Asiakkaan etunimi. Merkkijono varchar(255)
country_code Asiakkaan maata vastaava kaksikirjaiminen maakoodi. Merkkijono vain luku
country_name Asiakkaan maan normalisoitu nimi. Merkkijono
last_name (sukunimi) Oletus: NULL Asiakkaan sukunimi. Merkkijono varchar(255)
nimi Asiakkaan etu- ja sukunimet. Merkkijono
puhelin Oletus: NULL Asiakkaan puhelinnumero tässä osoitteessa. Merkkijono varchar(255)
province Oletus: NULL Asiakkaan alueen nimi. Yleensä provinssi, osavaltio tai prefektuuri. Merkkijono varchar(255)
province_code Asiakkaan alueen kaksikirjaiminen koodi. Merkkijono vain luku
postinumero Oletus: NULL Asiakkaan postinumero, josta voidaan käyttää myös nimityksiä zip-koodi, postikoodi, Eircode jne. Merkkijono varchar(255)

Order -resurssin ominaisuudet

Seuraavassa taulukossa luetellaan joitakin hyödyllisiä tietoja REST Admin APIn Order-resurssin ominaisuuksista.

Tietoja REST Order ‑resurssin tärkeistä ominaisuuksista
Ominaisuus Arvot Kuvaus Datatyyppi Kentän pituus Kentän käyttöoikeus Kriittinen pakollinen kenttä
app_id Oletus: NULL Tilauksen luoneen sovelluksen tunnus. kokonaisluku bigint(20) vain luku
billing_address Oletus: NULL Maksutapaan liitetty postiosoite. Tämä osoite on valinnainen kenttä, joka ei ole käytettävissä tilauksissa, joissa ei vaadita maksutapaa. kokonaisluku bigint(20)
browser_ip Asiakkaan tilauksen aikana käyttämän selaimen IP-osoite. Sekä IPv4- että IPv6-versiota tuetaan. merkkijono varchar(255) vain luku
buyer_accepts_marketing Oletus: 0 Onko asiakas suostunut vastaanottamaan sähköpostipäivityksiä kaupasta. totuusarvo tinyint(1)
cancel_reason
  • asiakas
  • petos
  • varasto
  • hylätty
  • muu
Oletus: NULL
Syy, miksi tilaus on peruutettu merkkijono varchar(255)
cancelled_at Oletus: NULL Päivämäärä ja kellonaika, jolloin tilaus on peruutettiin. Palauttaa tyhjäarvon, jos tilausta ei ole peruutettu. päivämäärä Päivämäärä/aika vain luku
cart_token Oletus: NULL Yksilöivä arvo, kun viitataan ostoskoriin, joka on liitetty tilaukseen. merkkijono varchar(255) vain luku
checkout_token Oletus: NULL Yksilöivä arvo, kun viitataan tilaukseen liittyvään kassaan. merkkijono varchar(64) vain luku
client_details
  • accept_language
  • browser_height
  • browser_ip
  • browser_width
  • session_hash
  • user_agent
Tiedot selaimesta, jota asiakas käytti tehdessään tilauksensa:

accept_language: selaimen ymmärtämät kielet ja kielialueet.
browser_height: selaimen näytön korkeus pikseleinä, jos se on saatavilla.
browser_ip: selaimen IP-osoite.
browser_width: selaimen näytön leveys pikseleinä, jos se on saatavilla.
session_hash: istunnon hajautusarvo.
user_agent: selaamiseen käytettävän asiakasohjelman tiedot, mukaan lukien ohjelmisto- ja käyttöversiot.
objekti vain luku
closed_at Oletus: NULL Päivämäärä ja kellonaika (ISO 8601 ‑muoto), jolloin tilaus suljettiin. Palauttaa tyhjäarvon, jos tilausta ei ole peruutettu. päivämäärä Päivämäärä/aika vain luku
created_at Oletus: NULL Automaattisesti luotu päivämäärä ja kellonaika (ISO 8601 -muoto), kun tilaus luotiin Shopifyssa. Tämän ominaisuuden arvoa ei voi muuttaa. päivämäärä datetime(6) vain luku
valuutta Oletus: NULL Kaupan valuutan kolmikirjaiminen koodi (ISO 4217 ‑muoto). merkkijono char(3)
current_subtotal_price Tilauksen nykyinen välisumma kaupan valuutassa. Tämän kentän arvo vastaa tilauksen muokkauksia, palautuksia ja maksun palautuksia. merkkijono varchar(255) vain luku
current_subtotal_price_set Tilauksen nykyinen välisumma kaupan valuutassa ja esitysvaluutassa. Tähän kenttään liittyvät summa-arvot vastaavat tilauksen muokkauksia, palautuksia ja maksun palautuksia. objekti vain luku
current_total_discounts Tilauksen nykyiset kokonaisalennukset kaupan valuutassa. Tämän kentän arvo vastaa tilauksen muokkauksia, palautuksia ja maksun palautuksia. merkkijono varchar(255) vain luku
current_total_discounts_set Tilauksen nykyiset kokonaisalennukset kaupan valuutassa ja esitysvaluutassa. Tähän kenttään liittyvät summa-arvot vastaavat tilauksen muokkauksia, palautuksia ja maksun palautuksia. objekti vain luku
current_total_duties_set Tilauksen nykyinen veloitettujen tullien kokonaissumma kaupan valuutassa ja esitysvaluutassa. Tähän kenttään liittyvät summa-arvot vastaavat tilauksen muokkauksia, palautuksia ja maksun palautuksia. objekti vain luku
current_total_price Tilauksen nykyinen kokonaissumma kaupan valuutassa. Tämän kentän arvo vastaa tilauksen muokkauksia, palautuksia ja maksun palautuksia. merkkijono varchar(255) vain luku
current_total_price_set Tilauksen nykyinen kokonaissumma kaupan valuutassa ja esitysvaluutassa. Tähän kenttään liittyvät summa-arvot vastaavat tilauksen muokkauksia, palautuksia ja maksun palautuksia. objekti vain luku
current_total_tax Tilauksen nykyinen veloitettujen verojen kokonaissumma kaupan valuutassa. Tämän kentän arvo vastaa tilauksen muokkauksia, palautuksia tai maksun palautuksia. merkkijono varchar(255) vain luku
current_total_tax_set Tilauksen nykyinen veloitettujen verojen kokonaissumma kaupan valuutassa ja esitysvaluutassa. Tähän kenttään liittyvät summa-arvot vastaavat tilauksen muokkauksia, palautuksia ja maksun palautuksia. objekti vain luku
asiakas Oletus: NULL Tietoja asiakkaasta. Tilauksella ei välttämättä ole asiakasta, eivätkä sovellukset saa olla riippuvaisia asiakasobjektin olemassaolosta. Tämä arvo voi olla tyhjäarvo, jos tilaus on luotu Shopify-myyntipisteen kautta. kokonaisluku bigint(20)
customer_locale Oletus: NULL Kaksi- tai kolmikirjaiminen kielikoodi, joita voi valinnaisesti seurata aluemäärite. merkkijono varchar(255) vain luku
discount_applications Päällekkäisten alennussovellusten järjestetty luettelo.

discount_applications-ominaisuudella on kolme tyyppiä: discount_code, manual ja script. Kaikilla kolmella tyypillä on yhteinen rakenne, ja niillä on joitakin tyyppikohtaisia määritteitä.
taulukko vain luku
discount_code Luettelo tilaukseen sovelletuista alennuksista. taulukko
sähköposti Asiakkaan sähköpostiosoite. varchar(255)
estimated_taxes Arvioidaanko tilauksen verot. Monet tekijät voivat muuttua tilauksen tekemisen ja lähettämisen ajankohtien välillä, mikä voi vaikuttaa verojen laskemiseen. Tämä ominaisuus palauttaa arvon epätosi, kun tilauksen verot on viimeistelty eikä niihin sovelleta muutoksia. totuusarvo tinyint(1)
financial_status
  • odottaa
  • authorized
  • partially_paid
  • maksettu
  • partially_refunded
  • refunded
Oletus: NULL
Tilaukseen liittyvien maksujen tila. Voidaan asettaa vain, kun tilaus luodaan. merkkijono varchar(255) vain luku
fulfillment_status
  • jaeltu
  • ei toteutunut
  • null
  • osittainen
  • restocked
Oletus: unfulfilled
Tilauksen tila jaeltujen rivikohtien osalta. merkkijono varchar(255)
jakelut Tilaukseen liittyvien jakelujen taulukko taulukko
id Oletus: NULL Tilauksen tunnus, jota käytetään API-tarkoituksiin. Tämä eroaa order_number-ominaisuudesta, joka on kaupan omistajan ja asiakkaan käyttämä tunnus. kokonaisluku bigint(20) vain luku
landing_site Oletus: NULL Sen sivun URL-osoite, jonne ostaja saapui tullessaan kauppaan. merkkijono varchar(4096) vain luku
line_items Luettelo rivikohtaobjekteista, joista jokainen sisältää tietoja tilauksessa olevasta kohteesta taulukko Y
location_id Oletus: NULL Sen fyysisen sijainnin tunnus, jossa tilaus käsiteltiin. Jos sinun on viitattava sijaintiin tilauksen vastaisesti, käytä FulfillmentOrder-resurssia. kokonaisluku bigint(20)
nimi Oletus: NULL Tilauksen nimi, joka on luotu yhdistämällä order_number-ominaisuuteen kauppiaan yleisissä asetuksissa määritetty tilauksen etu- ja jälkiliite. Tämä eroaa id-ominaisuudesta, joka on API:n käyttämän tilauksen tunnus. API voi myös määrittää tämän kentän miksi tahansa merkkijonoarvoksi. merkkijono varchar(255)
huomaa Oletus: NULL Valinnainen huomautus, jonka kaupan omistaja voi liittää tilaukseen. merkkijono
note_attributes Oletus: NULL Tilaukseen lisättävät lisätiedot. Näkyvät tilaustietosivun Lisätiedot-osiossa. Jokaisessa taulukkomerkinnässä on oltava hajautus, joka sisältää name- ja value-avaimen. merkkijono
määrä Oletus: NULL Tilauksen sijainti kaupan tilausmäärässä. Numerot ovat järjestyksessä ja alkavat numerosta 1. kokonaisluku int(11) vain luku
order_number Tilauksen sijainti kaupan tilausmäärässä alkaen numerosta 1001. Järjestysnumerot ovat järjestyksessä. kokonaisluku bigint(20) vain luku
order_status_url Tilauksen tilan verkkosivulle osoittava URL-osoite, jos sovellettavissa. merkkijono varchar(255) vain luku
original_total_duties_set Tilauksen alkuperäinen veloitettujen tullien kokonaissumma kaupan valuutassa ja esitysvaluutassa. objekti vain luku
payment_gateway_names Oletus: NULL Tilaukseen käytettyjen maksuportaalien luettelo.
varchar(255) vain luku
payment_terms Oletus: NULL Ehdot, joiden mukaan maksu on käsiteltävä. objekti bigint(20) vain luku
puhelin Oletus: NULL Asiakkaan puhelinnumero tekstiviesti-ilmoitusten vastaanottamista varten. merkkijono varchar(255)
presentment_currency Oletus: NULL Esitysvaluutta, jota käytettiin hintojen näyttämiseen asiakkaalle. merkkijono char(3)
processed_at Oletus: NULL Päivämäärä ja kellonaika (ISO 8601 -muoto), jolloin tilaus käsiteltiin. Tämä arvo on päivämäärä, joka näkyy tilauksissasi ja jota käytetään analyysiraporteissa. Jos tuot tilauksia sovelluksesta tai toisesta alustasta, voit määrittää processed_at-ominaisuuteen menneisyydessä olevan päivämäärän ja kellonajan vastaamaan alkuperäisen tilauksen luontiajankohtaa. päivämäärä datetime(6)
processing_method
  • maksu kassalla
  • suora
  • manuaalinen
  • offsite
  • express
  • ilmainen
Miten maksu on käsitelty merkkijono varchar(255) vain luku
referring_site Oletus: NULL Verkkosivusto, jossa asiakas klikkasi kaupan linkkiä. merkkijono varchar(4096)
maksun palautukset Luettelo tilaukseen sovelletuista maksun palautuksista taulukko vain luku
shipping_address Oletus: NULL Postiosoite, johon tilaus lähetetään. Tämä osoite on valinnainen, eikä se ole käytettävissä tilauksissa, jotka eivät edellytä toimitusta kokonaisluku bigint(20)
shipping_lines Käytetyn toimitustavan määrittävien objektien taulukko. taulukko
source_name Oletus: NULL Mistä tilaus on peräisin. Voidaan asettaa vain tilauksen luonnin aikana, eikä sitä voi kirjoittaa sen jälkeen. Shopify-kanavien arvot web, pos, shopify_draft_order, iphone ja android ovat suojattuja, eikä niitä voi määrittää muilla API-asiakasohjelmilla. API:n kautta luoduille tilauksille voidaan määrittää mikä tahansa muu valitsemasi merkkijono. Määrittämättömille uusille tilauksille määritetään sovelluksesi tunnuksen arvo. merkkijono varchar(255)
subtotal_price Tilauksen hinta kaupan valuutassa alennusten jälkeen, mutta ennen toimitusta, tulleja, veroja ja tippejä. kokonaisluku bigint(20)
subtotal_price_set Tilauksen välisumma kaupan valuutassa ja esitysvaluutassa alennusten jälkeen, mutta ennen toimitusta, tulleja, veroja ja tippejä. objekti
tunnisteet Tilaukseen liitetyt tunnisteet, jotka on muotoiltu pilkulla erotettujen arvojen merkkijonoksi. Tunnisteet ovat ylimääräisiä lyhyitä määritteitä, joita käytetään yleisesti suodatukseen ja hakuun. Jokaisessa yksittäisessä tunnisteessa on enintään 40 merkkiä. merkkijono varchar(4096)
tax_lines Joukko veroriviobjekteja, joista jokainen määrittää tilaukseen sovellettavan veron. Jokaisella objektilla on seuraavat ominaisuudet:

Kun luot tilauksen API:n kautta, verorivit voidaan määrittää tilaukselle tai rivikohdille, mutta ei molemmille. Tilaukselle määritetyt verorivit jakautuvat luodun tilauksen verotettaviin rivikohtiin.
taulukko
taxes_included
  • tosi
  • epätosi
Oletus: 0
Sisältyvätkö verot tilauksen välisummaan. totuusarvo tinyint(1)
testi
  • tosi
  • epätosi
Oletus: 0
Onko kyseessä testitilaus. totuusarvo tinyint(1) vain luku
token Oletus: NULL Yksilöllinen arvo tilaukseen viitattaessa. merkkijono varchar(32) vain luku
total_discounts Oletus: 0 Tilauksen hintaan sovellettavat kokonaisalennukset kaupan valuutassa. merkkijono decimal(21,3)
total_discounts_set Tilauksen hintaan sovellettavat kokonaisalennukset kaupan valuutassa ja esitysvaluutassa. objekti
total_line_items_price Oletus: 0 Kaikkien rivikohtien hintojen summa kaupan valuutassa. merkkijono decimal(21,3)
total_line_items_price_set Kaikkien rivikohtien hintojen kokonaissumma kaupan valuutassa ja esitysvaluutassa. objekti
total_outstanding Oletus: 0 Tilauksen jäljellä oleva kokonaissumma kaupan valuutassa. merkkijono decimal(21,3)
total_price Oletus: 0 Kaikkien rivikohtien hintojen, alennusten, toimituskulujen, verojen ja tippien summa kaupan valuutassa. On oltava positiivinen. merkkijono decimal(21,3)
total_price_set Tilauksen kokonaishinta kaupan valuutassa ja esitysvaluutassa. objekti
total_shipping_price_set Tilauksen kokonaistoimitushinta, alennukset ja palautukset pois lukien, kaupan valuutassa ja esitysvaluutassa. Jos taxes_included-arvoksi on määritetty tosi, total_shipping_price_set sisältää verot. objekti
total_tax Oletus: 0 Kaikkien tilaukseen sovellettavien verojen summa kaupan valuutassa. On oltava positiivinen. merkkijono decimal(21,3)
total_tax_set Tilaukseen sovellettavien verojen kokonaissumma kaupan valuutassa ja esitysvaluutassa. objekti
total_tip_received Tilauksen kaikkien tippien summa kaupan valuutassa. kokonaisluku bigint(20) vain luku
total_weight Oletus: 0 Kaikkien rivikohtien painojen summa grammoina. Summaa ei muuteta, kun tuotteita poistetaan tilauksesta. kokonaisluku bigint(20) unsigned
updated_at Päivämäärä ja kellonaika (ISO 8601 -muoto) tilauksen edellisen muokkauksen yhteydessä. päivämäärä datetime(6) vain luku
user_id Oletus: NULL Shopify POS ‑sovellukseen kirjautuneen ja tilauksen käsitelleen käyttäjän tunnus, jos sovellettavissa. kokonaisluku bigint(20)

Product -resurssin ominaisuudet

Seuraavassa taulukossa luetellaan joitakin hyödyllisiä tietoja REST Admin APIn Product-resurssin ominaisuuksista.

Tietoja REST Product ‑resurssin tärkeistä ominaisuuksista
Ominaisuus Arvot Kuvaus Datatyyppi Kentän pituus Kentän käyttöoikeus Kriittinen pakollinen kenttä
body_html Oletus: NULL Tuotteen kuvaus. Tukee HTML-muotoilua. merkkijono mediumtext
created_at Oletus: NULL Päivämäärä ja kellonaika (ISO 8601 -muoto) tuotteen luomisen yhteydessä. päivämäärä Päivämäärä/aika vain luku
handle Oletus: NULL merkkijono varchar(255)
id Oletus: NULL Allekirjoittamaton 64-bittinen kokonaisluku, jota käytetään tuotteen yksilöllisenä tunnisteena. Jokainen tunnus on yksilöllinen Shopify-järjestelmässä. Kahdella eri tuotteella ei voi olla samaa tunnusta, vaikka ne olisivatkin peräisin eri kaupoista. kokonaisluku bigint(20) vain luku Y
kuvat Luettelo tuotekuvaobjekteista, joista jokainen edustaa tuotteeseen liittyvää kuvaa. [{ product_image }]
vaihtoehdot Mukautetut tuoteominaisuudet. Esimerkiksi koko, väri ja materiaali. Jokaisella tuotteella voi olla enintään 3 vaihtoehtoa, ja jokaisen vaihtoehdon arvon pituus voi olla enintään 255 merkkiä. Tuoteversiot koostuvat vaihtoehtojen arvojen yhdistelmistä. Vaihtoehtoja ei voi luoda ilman arvoja. Uusien vaihtoehtojen luominen edellyttää, että luodaan myös tuoteversio, jolla on niihin liittyvä vaihtoehdon arvo. taulukko
product_type Oletus: NULL Tuotteiden suodatukseen ja hakuun käytettävä tuotteen luokittelu. merkkijono varchar(255)
published_at Oletus: NULL Päivämäärä ja kellonaika (ISO 8601 ‑muoto), jolloin tuote julkaistiin. Arvoksi voidaan asettaa tyhjäarvo, jos haluat peruuttaa tuotteen julkaisemisen verkkokauppakanavassa. päivämäärä Päivämäärä/aika
published_scope
  • web
  • global
Onko tuote julkaistu Point of Sale ‑kanavassa. merkkijono
tila
  • aktiivinen
  • arkistoitu
  • luonnos
Oletus: active
Tuotteen tila. merkkijono varchar(32)
tunnisteet Pilkulla erotettujen tunnisteiden merkkijono, jota käytetään suodatukseen ja hakuun. Tuotteella voi olla enintään 250 tunnistetta. Jokaisessa tunnisteessa voi olla enintään 255 merkkiä. merkkijono
template_suffix Oletus: NULL Tuotesivulla käytettävä Liquid-mallin jälkiliite. Jos tämä ominaisuus on määritetty, tuotesivulla käytetään mallia, jonka nimi on "product.suffix.liquid", jossa "suffix" on tämän ominaisuuden arvo. Jos tämä ominaisuus on "" tai tyhjäarvo, tuotesivulla käytetään oletusmallia "product.liquid". merkkijono varchar(255)
otsikko Oletus: NULL Tuotteen nimi merkkijono varchar(255)
updated_at Oletus: NULL Päivämäärä ja kellonaika (ISO 8601 ‑muoto) tilauksen edellisen muokkauksen yhteydessä. Tuotteen updated_at-arvo voi muuttua eri syistä. Jos esimerkiksi tilaus on tehty sellaisesta tuotteesta, jolle on määritetty varaston seuranta, varaston muutokset lasketaan päivitykseksi. päivämäärä Päivämäärä/aika vain luku
versiot Tuotteen eri versioita edustavien tuoteversioiden taulukko. Sijainnin ominaisuus on vain luku ‑tyyppinen. Tuoteversioiden sijainti ilmaistaan niiden luettelointijärjestyksellä. taulukko
kauppias Oletus: NULL Tuotteen myyjän nimi. merkkijono varchar(255)

ProductImage -resurssin ominaisuudet

Seuraavassa taulukossa luetellaan joitakin hyödyllisiä tietoja REST Admin API ProductImage ‑resurssin ominaisuuksista. Tällä resurssilla ei ole vain luku ‑kenttiä tai kriittisiä pakollisia kenttiä.

Tietoja REST ProductImage ‑resurssin tärkeistä ominaisuuksista
Ominaisuus Arvot Kuvaus Datatyyppi Kentän pituus
created_at Oletus: NULL Päivämäärä ja kellonaika, jolloin tuotekuva luotiin. API palauttaa tämän arvon ISO 8601 ‑muodossa. päivämäärä Päivämäärä/aika
height Oletus: NULL Ladattaessa määritettävä kuvan korkeusmitta. smallint(4) unsigned
id Oletus: NULL Tuotekuvan yksilöllinen numeerinen tunniste. (auto_increment) kokonaisluku bigint(20)
position Oletus: 0 Tuotekuvan järjestys luettelossa. Ensimmäisen tuotekuvan sijoitus on 1, ja se on tuotteen pääkuva. smallint(5) unsigned
product_id Oletus: NULL Kuvaan liittyvän tuotteen tunnus. bigint(20)
src Määrittää tuotekuvan sijainnin. Tämä parametri tukee URL-suodattimia, joita voit käyttää kuvan muokattujen kopioiden noutamiseen. Voit esimerkiksi noutaa 100 x 100 pikselin skaalatun kopion kuvasta lisäämällä tiedostonimeen _small (esimerkiksi ipod-nano_small.png) tai voit noutaa kopion kuvasta, joka on rajoitettu 2 048 x 2 048 pikselin resoluutioon, lisäämällä tiedostonimeen _2048x2048 (esimerkiksi ipod-nano_2048x2048.png).
updated_at Oletus: NULL Päivämäärä ja kellonaika, jolloin tuotekuvaa muokattiin viimeksi. API palauttaa tämän arvon ISO 8601 ‑muodossa. päivämäärä Päivämäärä/aika
variant_ids Kuvaan liitettyjen tuoteversiotunnusten taulukko.
width Oletus: NULL Ladattaessa määritettävä kuvan leveysmitta. smallint(4) unsigned

ProductVariant -resurssin ominaisuudet

Seuraavassa taulukossa luetellaan joitakin hyödyllisiä tietoja REST Admin APIn ProductVariant-resurssin ominaisuuksista. Tällä resurssilla ei ole kriittisiä pakollisia kenttiä.

Tietoja REST ProductVariant ‑resurssin tärkeistä ominaisuuksista
Ominaisuus Arvot Kuvaus Datatyyppi Kentän pituus Kentän käyttöoikeus
viivakoodi Oletus: NULL Tuotteen viivakoodi, UPC- tai ISBN-numero. varchar(255)
compare_at_price Oletus: NULL Tuotteen alkuperäinen hinta ennen oikaisua tai alennusmyyntiä. decimal(20,2)
created_at Oletus: NULL ISO 8601 ‑muodossa oleva päivämäärä ja kellonaika, kun tuoteversio luotiin. päivämäärä Päivämäärä/aika
fulfillment_service
  • manuaalinen
  • { handle of fulfillment service }
Oletus: manual
Tuoteversioon liitetty jakelupalvelu. varchar(255)
grammat Tuoteversion paino grammoina.
id Oletus: NULL Tuoteversion yksilöllinen numeerinen tunniste. (Arvo kasvaa automaattisesti). bigint(20)
image_id Oletus: NULL Tuotteen kuvan yksilöllinen numeerinen tunniste. Kuvan on liityttävä samaan tuotteeseen kuin tuoteversio. bigint(20)
inventory_item_id Varastokohteen yksilöllinen tunniste, jota käytetään Inventory API:ssa varastotietojen kyselyyn.
inventory_management
  • Shopify
  • null
  • { handle of fulfillment service }
  • Oletus: NULL
    Jakelupalvelu, joka seuraa tuoteversion varastossa olevien tuotteiden määrää. varchar(255)
    inventory_policy
    • deny
    • continue
    Oletus: deny
    Voivatko asiakkaat tilata tuoteversion, kun se on loppunut varastosta. varchar(40)
    inventory_quantity Oletus: 1 Kaikkien sijaintien varaston kokonaismäärä. Voit säätää tietyn sijainnin varastoa käyttämällä InventoryLevel-resurssia. int(11) vain luku
    option Mukautetut ominaisuudet, joita kaupan omistaja käyttää tuoteversioiden määrittämiseen. Voit määrittää tuoteversiolle kolme vaihtoehtoa: option1, option2 ja option3. Oletusarvo: Default Title. Otsikkokenttä on option1-, option2- ja option3-kenttien ketjutus. Valintakenttien päivittäminen päivittää otsikkokentän.
    position Oletus: 0 Tuoteversioiden järjestys tuoteversioluettelossa. Luettelon ensimmäinen sijainti on 1. Tuoteversioiden sijainti ilmaistaan niiden luettelointijärjestyksellä. smallint(5) unsigned vain luku
    presentment_prices Luettelo tuoteversion esityshinnoista ja vertailuhinnoista kaikissa kaupan käytössä olevissa esitysvaluutoissa. Jokaisella hintaobjektilla on seuraavat ominaisuudet:
    -currency_code: jonkin kaupan käyttöönottaman esitysvaluutan kolmikirjaiminen koodi (ISO 4217 ‑muoto).
    -määrä: tuoteversion hinta tai vertailuhinta esitysvaluutassa.
    Edellyttää otsikkoa "X-Shopify-Api-Features": "include-presentment-prices".
    vain luku
    hinta Oletus: 0 Tuoteversion hinta. decimal(20,2)
    product_id Oletus: NULL Tuotteen yksilöllinen numeerinen tunniste. bigint(20)
    requires_shipping Oletus: 1 Tämä ominaisuus on vanhentunut. Käytä sen sijaan InventoryItem-resurssin requires_shipping-ominaisuutta. totuusarvo tinyint(1)
    sku Kaupan tuoteversion yksilöllinen tunniste. Tarvitaan jakelupalveluun yhdistämiseksi. varchar(255)
    tax_code Tämä parametri koskee vain kauppoja, joissa on asennettuna Avalara AvaTax ‑sovellus. Määrittää tuoteversiolle Avalara-verokoodin.
    verotettavat Oletus: 1 Veloitetaanko tuoteversion myynnin yhteydessä veroa. totuusarvo tinyint(1)
    otsikko Tuoteversion otsikko. Otsikkokenttä on option1-, option2- ja option3-kenttien ketjutus. Voit päivittää otsikon vain epäsuoraan vaihtoehtokenttien avulla. varchar(255) vain luku
    updated_at Oletus: NULL Päivämäärä ja kellonaika, jolloin tuoteversiota muokattiin viimeksi. Palautetaan ISO 8601 ‑muodossa. päivämäärä Päivämäärä/aika
    weight Tuoteversion paino weight_unit-ominaisuudella määritetyssä yksikköjärjestelmässä.
    weight_unit
    • g
    • kg
    • unssia
    • lb
    Oletus: NULL
    Tuoteversion painoon sovellettava mittayksikkö. Jos et määritä weight_unit-ominaisuudelle arvoa, käytetään kaupan oletusarvoista mittayksikköä. varchar(2)