Dataordbog for butiksmigrering

Dataordbogen for butiksmigrering indeholder oplysninger om REST Admin API-ressourcerne Customer, Order og Product. Dataordbogen er en supplerende ressource til erfarne partnere, der migrerer butikker til Shopify.

Bemærk: Oplysningerne i dataordbogen er bekræftet for version 2022-01 af Shopifys API'er. Du kan finde de mest opdaterede oplysninger og eksempler under referencedokumentationen for REST Admin API'en.

Customer ressourceegenskaber

Følgende tabel indeholder nogle nyttige oplysninger om egenskaberne for ressourcen REST Admin API Customer.

Data om vigtige egenskaber, som er relateret til ressourcen REST Customer
Egenskab Værdier Beskrivelse Datatype Feltlængde Feltadgang Påkrævet vigtigt felt
accepts_marketing Standard: 0 Om kunden har accepteret at modtage markedsføringsmateriale. Boolesk tinyint(1) Y
accepts_marketing_
updated_at
Dato og klokkeslæt (ISO 8601-format), hvor kunden gav samtykke eller fravalgte mod at modtage markedsføringsmateriale via mail. DateTime
adresser En liste over adresser, der er knyttet til kunden. [{ Address }]
valuta Koden på tre bogstaver (ISO 4217-format) for den valuta, som kunden brugte til betaling af sin seneste ordre. Streng Butikkens valuta skrivebeskyttet
created_at Standard: NULL Dato og klokkeslæt (ISO 8601-format), hvor kunden blev føjet til butikken. DateTime datetime skrivebeskyttet
default_address Kundens standardadresse. { Address }
mail Standard: NULL Kundens unikke mailadresse. Streng varchar(255)
first_name Standard: NULL Kundens fornavn. Streng varchar(255)
id Standard: NULL Globalt entydigt id. (Denne værdi forøges automatisk). Heltal bigint(20) Y
last_name Standard: NULL Kundens efternavn. Streng varchar(255)
last_order_id Standard: NULL Id'et for kundens seneste ordre. Heltal bigint(20) skrivebeskyttet
last_order_name Standard: NULL Navnet på kundens seneste ordre. Streng skrivebeskyttet
metafelt Standard: NULL Returnerer et metafelt efter det navneområde og den nøgle, der tilhører ressourcen. { Metafield }
marketing_opt_
in_level
  • null
  • single_opt_in
  • confirmed_opt_in
  • ukendt
Standard: NULL
Tilmeldingsniveauet for markedsføringsabonnementer (som beskrevet i de bedste fremgangsmåder for M3AAWG), som kunden gav med sit samtykke til at modtage markedsføringsmateriale via mail. String, enum
multipass_identifier Standard: NULL En entydig identifikator for den kunde, der bruges med Multipass-login. Streng varchar(255)
note Standard: NULL En bemærkning om kunden. Streng mediumtext
orders_count Standard: 0 Antal ordrer, som kunden har afgivet i butikken i hans eller hendes levetid. Heltal int(11) skrivebeskyttet
telefon Standard: NULL Det unikke telefonnummer (E.164-format) for denne kunde (på tværs af butikken). Streng varchar(255)
sms_marketing_
consent
Standard: NULL Den aktuelle status for sms-markedsføring for kundens telefonnummer. Streng
status
  • deaktiveret
  • inviteret
  • aktiveret
  • afvist
Standard: deaktiveret
Status for kundens konto i butikken. String, enum varchar(255) skrivebeskyttet
tags Standard: NULL En kommasepareret liste over op til 250 tags, der er blevet føjet til kunden. Streng 255 pr. tag
tax_exempt Standard: 0 Om kunden er fritaget for betaling af skat på deres ordrer. Boolesk tinyint(1) Y
tax_exemptions Du kan finde en komplet liste over værdier i ressourcen Kunde. Listen over skattefritagelser, der er relevante for kunden. Streng
total_spent Standard: 0 Det samlede beløb, som kunden har brugt på ordrer i sin levetid. Angives i butikkens valuta. Hvis du bruger multivalutaer, vises beløbet i standardvalutaen uden vekselkurs. Tal decimal(21,3) skrivebeskyttet
updated_at Dato og klokkeslæt, hvor kunden senest blev opdateret. Baseret på butikkens tidszone. DateTime datetime skrivebeskyttet
verified_email Standard: 1 Om kunden har bekræftet sin mailadresse. Standardværdien er “sand”, hvis kunden er oprettet via Shopify-administratoren eller API'en. Boolesk tinyint(1) skrivebeskyttet

CustomerAddress ressourceegenskaber

Følgende tabel indeholder nogle nyttige oplysninger om egenskaberne for ressourcen REST Admin API CustomerAddress. Der er ingen kritiske obligatoriske felter for denne ressource.

Data om vigtige egenskaber, som er relateret til ressourcen REST Customer Address
Egenskab Værdier Beskrivelse Datatype Feltlængde Feltadgang
adresse1 Standard: NULL Kundens postadresse. 100 pr. kundekonto. Streng varchar(255)
adresse2 Standard: NULL Et ekstra felt til kundens postadresse. Streng varchar(255)
by Standard: NULL Kundens by. Streng varchar(255)
firma Standard: NULL Kundens firma. Streng varchar(255)
land Standard: NULL Kundens land. Streng varchar(255)
first_name Standard: NULL Kundens fornavn. Streng varchar(255)
country_code Landekoden på to bogstaver, der svarer til kundens land. Streng skrivebeskyttet
country_name Kundens normaliserede landenavn. Streng
last_name Standard: NULL Kundens efternavn. Streng varchar(255)
navn Kundens for- og efternavn. Streng
telefon Standard: NULL Kundens telefonnummer for denne adresse. Streng varchar(255)
landsdel Standard: NULL Kundens områdenavn. Normalt en provins, en delstat eller et præfektur. Streng varchar(255)
province_code Koden på to bogstaver, der svarer til kundens område. Streng skrivebeskyttet
postnummer Standard: NULL Kundens postnummer. Streng varchar(255)

Order ressourceegenskaber

Følgende tabel indeholder nogle nyttige oplysninger om egenskaberne for ressourcen REST Admin API Order.

Data om vigtige egenskaber, som er relateret til ressourcen REST Order
Egenskab Værdier Beskrivelse Datatype Feltlængde Feltadgang Påkrævet vigtigt felt
app_id Standard: NULL Id'et for den app, der oprettede ordren. heltal bigint(20) skrivebeskyttet
billing_address Standard: NULL Den postadresse, der er knyttet til betalingsmetoden. Denne adresse er et valgfrit felt, der ikke er tilgængeligt for ordrer, som ikke kræver en betalingsmetode. heltal bigint(20)
browser_ip IP-adressen for den browser, som kunden benyttede, da vedkommende afgav ordren. Både IPv4 og IPv6 understøttes. streng varchar(255) skrivebeskyttet
buyer_accepts_marketing Standard: 0 Om kunden har givet samtykket til at modtage mailopdateringer fra butikken. boolesk tinyint(1)
cancel_reason
  • kunde
  • svindel
  • lager
  • afvist
  • andet
Standard: NULL
Årsag til annullering af ordren streng varchar(255)
cancelled_at Standard: NULL Dato og klokkeslæt, hvor ordren blev annulleret. Returnerer “NULL”, hvis ordren ikke er annulleret. dato datetime skrivebeskyttet
cart_token Standard: NULL En unik værdi ved henvisning til den indkøbskurv, der er knyttet til ordren. streng varchar(255) skrivebeskyttet
checkout_token Standard: NULL En unik værdi med henvisning til den betalingsproces, der er knyttet til ordren. streng varchar(64) skrivebeskyttet
client_details
  • accept_language
  • browser_height
  • browser_ip
  • browser_width
  • session_hash
  • user_agent
Oplysninger om den browser, som kunden benyttede, da vedkommende afgav sin ordre:

accept_language: Det sprog og de landestandarder, som browseren forstår.
browser_height: Browserens skærmhøjde i pixel (hvis tilgængeligt).
browser_ip: Browserens IP-adresse.
browser_width: Browserens skærmbredde i pixel (hvis tilgængeligt).
session_hash: En hash fra sessionen.
user_agent: Detaljer om browserklienten, herunder versioner af software og operativsystem.
objekt skrivebeskyttet
closed_at Standard: NULL Dato og klokkeslæt (ISO 8601-format), hvor ordren blev lukket. Returnerer “NULL”, hvis ordren ikke er lukket. dato datetime skrivebeskyttet
created_at Standard: NULL Automatisk genereret dato og klokkeslæt (ISO 8601-format), hvor ordren blev oprettet i Shopify. Værdien for denne egenskab kan ikke ændres. dato datetime(6) skrivebeskyttet
valuta Standard: NULL Koden på tre bogstaver (ISO 4217-format) for butikkens valuta. streng char(3)
current_subtotal_price Den aktuelle subtotalpris for ordren i butikkens valuta. Værdien af dette felt afspejler ordreændringer, returneringer og refusioner. streng varchar(255) skrivebeskyttet
current_subtotal_price_set Den aktuelle subtotal for ordren i butiks- og præsentationsvalutaerne. De beløbsværdier, der er knyttet til dette felt, afspejler ordreændringer, returneringer og refusioner. objekt skrivebeskyttet
current_total_discounts De aktuelle samlede rabatter på ordren i butikkens valuta. Værdien af dette felt afspejler ordreændringer, returneringer og refusioner. streng varchar(255) skrivebeskyttet
current_total_discounts_set De aktuelle samlede rabatter på ordren i butiks- og indberetningsvalutaen. De beløbsværdier, der er knyttet til dette felt, afspejler ordreændringer, returneringer og refusioner. objekt skrivebeskyttet
current_total_duties_set Den aktuelle samlede told, der er opkrævet for ordren i butiks- og indberetningsvalutaen. De beløbsværdier, der er knyttet til dette felt, afspejler ordreændringer, returneringer og refusioner. objekt skrivebeskyttet
current_total_price Den aktuelle samlede pris for ordren i butikkens valuta. Værdien af dette felt afspejler ordreændringer, returneringer og refusioner. streng varchar(255) skrivebeskyttet
current_total_price_set Den aktuelle samlede pris for ordren i butiks- og indberetningsvalutaen. De beløbsværdier, der er knyttet til dette felt, afspejler ordreændringer, returneringer og refusioner. objekt skrivebeskyttet
current_total_tax De aktuelle samlede, opkrævede skatter for ordren i butikkens valuta. Værdien af dette felt afspejler ordreændringer, returneringer og refusioner. streng varchar(255) skrivebeskyttet
current_total_tax_set De aktuelle samlede skatter, der er opkrævet for ordren i butiks- og indberetningsvalutaen. De beløbsværdier, der er knyttet til dette felt, afspejler ordreændringer, returneringer og refusioner. objekt skrivebeskyttet
kunde Standard: NULL Oplysninger om kunden. Ordren har muligvis ikke en kunde, og apps bør ikke være afhængige af eksistensen af et kundeobjekt. Denne værdi kan være “NULL”, hvis ordren blev oprettet via Shopify POS. heltal bigint(20)
customer_locale Standard: NULL Sprogkoden på to eller tre bogstaver. Valgfrit: Efterfølges af en områdemodifikator. streng varchar(255) skrivebeskyttet
discount_applications En sorteret liste over stablede rabattildelinger.

Egenskaben discount_applications omfatter tre typer: discount_code, manuel og script. Alle tre typer deler en fælles struktur og har nogle typespecifikke egenskaber.
matrix skrivebeskyttet
discount_codes En liste over rabatter, der er anvendt på ordren. matrix
mail Kundens mailadresse. varchar(255)
estimated_taxes Om der estimeres skatter for ordren. Mange faktorer kan ændre sig fra det tidspunkt, hvor en kunde afgiver en ordre til det tidspunkt, hvor ordren afsendes. Disse faktorer kan påvirke beregningen af skatter. Denne egenskab returnerer “falsk”, når skatterne for en ordre er færdigbehandlede og ikke kan ændres. boolesk tinyint(1)
financial_status
  • afventer
  • autoriseret
  • partially_paid
  • betalt
  • partially_refunded
  • refunderet
Standard: NULL
Status for betalinger, der er tilknyttet ordre. Kan kun angives, når ordren er oprettet. streng varchar(255) skrivebeskyttet
fulfillment_status
  • klargjort
  • ikke-klargjort
  • null
  • delvist
  • genopfyldt
Standard: ikke-klargjort
Ordrens status med hensyn til klargjorte varelinjer. streng varchar(255)
klargøringer En række klargøringer, der er knyttet til ordren matrix
id Standard: NULL Id'et for ordren, som blev anvendt til API-formål. Dette id-nummer er ikke det samme som egenskaben order_number, som er det id, der anvendes af butiksejeren og kunden. heltal bigint(20) skrivebeskyttet
landing_site Standard: NULL Webadressen for den side, hvor køberen landede, da vedkommende kom ind i butikken. streng varchar(4096) skrivebeskyttet
line_items En liste over varelinjeobjekter, som alle indeholder oplysninger om en vare i ordren matrix Y
location_id Standard: NULL Id'et for den fysiske lokation, hvor ordren blev behandlet. Hvis du har brug for at referere lokationen mod en ordre, skal du bruge ressourcen FulfillmentOrder. heltal bigint(20)
navn Standard: NULL Det ordrenavn, der genereres ved at kombinere egenskaben order_number med den ordrepræfiks og -suffiks, der er angivet i shopejerens generelle indstillinger. Dette er forskelligt fra id-egenskaben, som er det id for ordren, der blev anvendt af API'en. Dette felt kan også angives til en hvilken som helst strengværdi af API'en. streng varchar(255)
note Standard: NULL En valgfri bemærkning, som en butiksejer kan give ordren. streng
note_attributes Standard: NULL Yderligere oplysninger, der føjes til ordren. Vises i afsnittet Yderligere oplysninger på siden med ordrens oplysninger. Alle matrixposter skal indeholde en hash med navne- og værdinøgler. streng
number Standard: NULL Ordrens placering i butikkens antal af ordrer. Tallene er i rækkefølge og starter med 1. heltal int(11) skrivebeskyttet
order_number Ordrens placering i butikkens antal af ordrer (starter med 1001). Ordretal er i rækkefølge. heltal bigint(20) skrivebeskyttet
order_status_url Webadressen, der peger på websiden med ordrestatus (hvis relevant). streng varchar(255) skrivebeskyttet
original_total_duties_set Den oprindelige samlede told, der blev opkrævet for ordren i butiks- og præsentationsvalutaerne. objekt skrivebeskyttet
payment_gateway_names Standard: NULL Listen over betalingsgateways, der blev brugt til ordren.
varchar(255) skrivebeskyttet
payment_terms Standard: NULL De vilkår og betingelser og betingelser, som en betaling skal behandles under. objekt bigint(20) skrivebeskyttet
telefon Standard: NULL Kundens telefonnummer til modtagelse af sms-meddelelser. streng varchar(255)
presentment_currency Standard: NULL Præsentationsvalutaen, der blev brugt til at vise priser til kunden. streng char(3)
processed_at Standard: NULL Dato og klokkeslæt (ISO 8601-format), hvor en ordre blev behandlet. Denne værdi er den dato, der vises på dine ordrer og som bruges i analyserapporterne. Hvis du importerer ordrer fra en app eller en anden platform, kan du angive processed_at til en dato og et klokkeslæt i fortiden, der matcher den dato og det klokkeslæt, hvor den oprindelige ordre blev oprettet. dato datetime(6)
processing_method
  • betaling
  • direkte
  • manuel
  • offsite
  • express
  • gratis
Sådan blev betalingen behandlet streng varchar(255) skrivebeskyttet
referring_site Standard: NULL Det website, hvor kunden klikkede på et link til butikken. streng varchar(4096)
refusioner En liste over refusioner vedrørende ordren matrix skrivebeskyttet
shipping_address Standard: NULL Den postadresse, som ordren vil blive afsendt til. Denne adresse er valgfri og er ikke tilgængelig for ordrer, der ikke kræver levering. heltal bigint(20)
shipping_lines En række af objekter, som alle angiver en anvendt leveringsmetode. matrix
source_name Standard: NULL Hvor ordren opstod oprindeligt. Kan kun angives under oprettelse af ordren – er ikke skrivbar efterfølgende. Værdierne for Shopify-kanaler er beskyttet og kan ikke tildeles af andre API-klienter: web, pos, shopify_draft_order, iphone og android. Ordrer, der oprettes via API'en kan tildeles alle andre strenge. Hvis dette ikke er angivet, får nye ordrer tildelt værdien af din apps id. streng varchar(255)
subtotal_price Prisen på ordren i butikkens valuta efter rabatter, men før levering, told, skatter og drikkepenge. heltal bigint(20)
subtotal_price_set Ordrens subtotal i butiks- og præsentationsvalutaerne efter rabatter, men før levering, told, skatter og drikkepenge. objekt
tags Tags, der er knyttet til ordren, formateret som en streng af kommaseparerede værdier. Tags er yderligere korte beskrivelser, der normalt bruges til filtrering og søgning. Alle individuelle tags er begrænset til en længde på 40 tegn. streng varchar(4096)
tax_lines En række skattelinjeobjekter, som alle indeholder detaljer vedrørende ordren. Alle objekter har følgende egenskaber:

Når der oprettes en ordre via API'en, kan der angives skattelinjer for ordren eller varelinjerne, men ikke for begge dele. Skattelinjerne, der er angivet for ordren, opdeles på tværs af de skattepligtige varelinjer i den oprettede ordre.
matrix
taxes_included
  • sandt
  • falsk
Standard: 0
Om skatter er inkluderet i ordrens subtotal. boolesk tinyint(1)
test
  • sandt
  • falsk
Standard: 0
Om dette er en testordre. boolesk tinyint(1) skrivebeskyttet
token Standard: NULL En unik værdi ved henvisning til ordren. streng varchar(32) skrivebeskyttet
total_discounts Standard: 0 De samlede rabatter, der er anvendt på ordrens pris i butikkens valuta. streng decimal(21,3)
total_discounts_set De samlede rabatter, der er anvendt på ordrens pris i butiks- og præsentationsvalutaerne. objekt
total_line_items_price Standard: 0 Summen af alle varelinjepriser i butikkens valuta. streng decimal(21,3)
total_line_items_price_set Den samlede pris for alle varelinjepriserne i butiks- og præsentationsvalutaerne. objekt
total_outstanding Standard: 0 Det samlede udestående beløb for ordren i butikkens valuta. streng decimal(21,3)
total_price Standard: 0 Summen af alle varelinjepriser, rabatter, levering, skatter og drikkepenge i butikkens valuta. Skal være et positivt tal. streng decimal(21,3)
total_price_set Den samlede pris for ordren i butiks- og præsentationsvalutaerne. objekt
total_shipping_price_set Ordrens samlede leveringspris, eksklusive rabatter og returneringer, i butiks- og præsentationsvalutaerne. Hvis taxes_included er angivet til “sand”, vil total_shipping_price_set inkludere skatter. objekt
total_tax Standard: 0 Summen af alle de skatter, der er anvendt på ordren, i butikkens valuta. Skal være et positivt tal. streng decimal(21,3)
total_tax_set Den samlede skat, der er anvendt på ordren, i butiks- og præsentationsvalutaerne. objekt
total_tip_received Summen af alle drikkepenge for ordren i butikkens valuta. heltal bigint(20) skrivebeskyttet
total_weight Standard: 0 Summen af alle varelinjernes vægt i gram. Summen justeres ikke, når varer fjernes fra ordren. heltal bigint(20) ikke-signeret
updated_at Dato og klokkeslæt (ISO 8601-format), da ordren sidst blev ændret. dato datetime(6) skrivebeskyttet
user_id Standard: NULL Id'et for den bruger, der var logget ind på Shopify POS og behandlede ordren (hvis relevant). heltal bigint(20)

Product ressourceegenskaber

Følgende tabel indeholder nogle nyttige oplysninger om egenskaberne for ressourcen REST Admin API Product.

Data om vigtige egenskaber, som er relateret til ressourcen REST Product
Egenskab Værdier Beskrivelse Datatype Feltlængde Feltadgang Påkrævet vigtigt felt
body_html Standard: NULL En beskrivelse af produktet. Understøtter HTML-formatering. streng mediumtext
created_at Standard: NULL Dato og klokkeslæt (ISO 8601-format), da produktet blev oprettet. dato datetime skrivebeskyttet
handle Standard: NULL streng varchar(255)
id Standard: NULL Et ikke-signeret 64-bit heltal, der bruges som et entydigt id for produktet. Alle id'er er unikke på tværs af Shopifys system. Der er ikke to produkter med samme id, heller ikke selvom de kommer fra forskellige butikker. heltal bigint(20) skrivebeskyttet Y
billeder En liste over produktbilledobjekter, som alle repræsenterer et billede, der er knyttet til produktet. [{ product_image }]
muligheder De tilpassede produktegenskaber. For eksempel: Størrelse, farve og materiale. Hvert produkt kan have op til 3 valgmuligheder, og hver værdi for valgmulighederne kan indeholde op til 255 tegn. Produktvarianter består af kombinationer af værdier for valgmuligheder. Du kan ikke oprette valgmuligheder uden værdier. Hvis du vil oprette nye valgmuligheder, skal du også oprette en variant med en tilknyttet værdi for valgmuligheden. matrix
product_type Standard: NULL En kategorisering af produktet, som bruges til filtrering og søgning efter produkter. streng varchar(255)
published_at Standard: NULL Dato og klokkeslæt (ISO 8601-format), hvor produktet blev udgivet. Kan angives til “NULL” for at annullere udgivelsen af produktet på Webshop-kanalen. dato datetime
published_scope
  • Web
  • global
Om produktet er udgivet på Point of Sale-kanalen. streng
status
  • aktiv
  • arkiveret
  • kladde
Standard: aktiv
Produktets status. streng varchar(32)
tags En streng af kommaseparerede tags, der bruges til filtrering og søgning. Et produkt kan have op til 250 tags. Hvert tag kan indeholde op til 255 tegn. streng
template_suffix Standard: NULL Suffikset for den Liquid-skabelon, der bruges til produktsiden. Hvis denne egenskab er angivet, bruger produktsiden en skabelon kaldet “product.suffix.liquid”, hvor “suffix” er værdien for denne egenskab. Hvis denne egenskab er “” eller “NULL”, vil produktsiden bruge standardskabelonen “product.liquid”. streng varchar(255)
titel Standard: NULL Navnet på produktet streng varchar(255)
updated_at Standard: NULL Dato og klokkeslæt (ISO 8601-format), hvor produktet sidst blev redigeret. Der kan være flere forskellige årsager til, at værdien updated_at ændres for et produkt. Hvis der f.eks. afgives en ordre på et produkt med opsat lagersporing, vil lagerjusteringen tælle som en opdatering. dato datetime skrivebeskyttet
varianter En række produktvarianter, som alle repræsenterer en forskellig version af produktet. Placeringsegenskaben er skrivebeskyttet. Varianternes placering indikeres af den rækkefølge, som de er angivet i. matrix
forhandler Standard: NULL Navnet på produktets forhandler. streng varchar(255)

ProductImage ressourceegenskaber

Følgende tabel indeholder nogle nyttige oplysninger om egenskaberne for ressourcen REST Admin API ProductImage. Der er ingen skrivebeskyttede eller kritiske obligatoriske felter for denne ressource.

Data om vigtige egenskaber, som er relateret til ressourcen REST ProductImage
Egenskab Værdier Beskrivelse Datatype Feltlængde
created_at Standard: NULL Dato og klokkeslæt, hvor billedet blev oprettet. API'en returnerer denne værdi i ISO 8601-format. dato datetime
højde Standard: NULL Højdedimensionen på billedet, som bestemmes ved upload. smallint(4) ikke-signeret
id Standard: NULL Et entydigt numerisk id for produktbilledet. (auto_increment) heltal bigint(20)
position Standard: 0 Rækkefølgen på produktbilledet på listen. Det første produktbillede er placering 1 – dette er også produktets “hovedbillede”. smallint(5) ikke-signeret
product_id Standard: NULL Id'et for det produkt, der er knyttet til billedet. bigint(20)
src Angiver produktbilledets placering. Denne parameter understøtter webadresse-filtre, som du kan bruge til at hente redigerede kopier af billedet. Du kan f.eks. føje _small til filnavnet for at hente en skaleret kopi af billedet i 100 x 100 px (f.eks. ipod-nano_small.png). Du kan også tilføje _2048x2048 for at hente en kopi af billedet, der er begrænset til opløsningen 2048 x 2048 px (f.eks. ipod-nano_2048x2048.png).
updated_at Standard: NULL Dato og klokkeslæt, hvor produktbilledet senest blev redigeret. API'en returnerer denne værdi i ISO 8601-format. dato datetime
variant_ids En række variant-id'er, der er knyttet til billedet.
bredde Standard: NULL Breddedimensionen for billedet, som bestemmes ved upload. smallint(4) ikke-signeret

ProductVariant ressourceegenskaber

Følgende tabel indeholder nogle nyttige oplysninger om egenskaberne for ressourcen REST Admin API ProductVariant. Der er ingen kritiske obligatoriske felter for denne ressource.

Data om vigtige egenskaber, som er relateret til ressourcen REST ProductVariant
Egenskab Værdier Beskrivelse Datatype Feltlængde Feltadgang
stregkode Standard: NULL Produktets stregkodenummer, UPC eller ISBN. varchar(255)
compare_at_price Standard: NULL Varens oprindelige pris, før prisjustering eller udsalg. decimal(20,2)
created_at Standard: NULL Dato og klokkeslæt (ISO 8601-format), hvor produktvarianten blev oprettet. dato datetime
fulfillment_service
  • manuel
  • { handle of fulfillment service }
Standard: manuel
Den distributionstjeneste, der er knyttet til produktvarianten. varchar(255)
gram Vægten af produktvarianten i gram.
id Standard: NULL Den entydige numeriske id for produktvarianten. Denne værdi forøges automatisk. bigint(20)
image_id Standard: NULL Det entydige numeriske id for et produkts billede. Billedet skal være knyttet til det samme produkt som varianten. bigint(20)
inventory_item_id Det entydige id for lagervaren, som bruges i Inventory API'en, når der oprettes forespørgsler på lageroplysninger.
inventory_management
  • shopify
  • null
  • { handle of fulfillment service }
  • Standard: NULL
    Den distributionstjeneste, der sporer antallet af varer på lager for produktvarianten. varchar(255)
    inventory_policy
    • afvis
    • fortsæt
    Standard: afvis
    Om kunder kan afgive en ordre på produktvarianten, når den ikke er på lager. varchar(40)
    inventory_quantity Standard: 1 En samlet lagerbeholdning på tværs af alle lokation. Hvis du vil justere lagerbeholdningen for en specifik lokation, skal du bruge ressourcen InventoryLevel. int(11) skrivebeskyttet
    valgmulighed De tilpassede egenskaber, som butiksejere bruger til at definere produktvarianter. Du kan definere tre valgmuligheder for en produktvariant: valgmulighed1, valgmulighed2, valgmulighed3. Standardværdi: standardtitel. Titelfeltet er en sammenkædning af felterne valgmulighed1, valgmulighed2 og valgmulighed3. Hvis du opdaterer felterne for valgmulighederne, opdateres titelfeltet også.
    position Standard: 0 Rækkefølgen af produktvarianten på listen over produktvarianter. Den første placering på listen er 1. Varianternes placering indikeres af den rækkefølge, som de er angivet i. smallint(5) ikke-signeret skrivebeskyttet
    presentment_prices En liste over variantens præsentationspriser og sammenligningspriser for alle butikkens aktiverede præsentationsvalutaer. Alle prisobjekter har følgende egenskaber:
    -currency_code: Koden på tre bogstaver (ISO 4217-format) for en af butikkens aktiverede præsentationsvalutaer.
    -amount: Variantens pris eller sammenligningspris i præsentationsvalutaen.
    Kræver overskriften “X-Shopify-Api-Features”: “include-presentment-prices”.
    skrivebeskyttet
    pris Standard: 0 Prisen på produktvarianten. decimal(20,2)
    product_id Standard: NULL Det entydige numeriske id for produktet. bigint(20)
    requires_shipping Standard: 1 Denne egenskab er blevet udfaset. Brug egenskaben “requires_shipping” for ressourcen InventoryItem i stedet. boolesk tinyint(1)
    sku Et entydigt id for produktvarianten i butikken. Kræves for at kunne tilknytte en FulfillmentService. varchar(255)
    tax_code Denne parameter gælder kun for de butikker, der har installeret Avalara AvaTax-appen. Angiver Avalara-skattekoden for produktvarianten.
    afgiftspligtig Standard: 1 Om der opkræves skat ved salg af produktvarianten. boolesk tinyint(1)
    titel Produktvariantens titel. Titelfeltet er en sammenkædning af felterne valgmulighed1, valgmulighed2 og valgmulighed3. Du kan kun opdatere titlen indirekte ved hjælp af felterne for valgmulighederne. varchar(255) skrivebeskyttet
    updated_at Standard: NULL Dato og klokkeslæt, hvor produktvarianten senest blev redigeret. Bliver returneret i ISO 8601-format. dato datetime
    vægt Vægten af produktvarianten i det enhedssystem, der er angivet med weight_unit.
    weight_unit
    • g
    • kg
    • ounce(s)
    • pund
    Standard: NULL
    Den måleenhed, der gælder for produktvariantens vægt. Hvis du ikke angiver en værdi for weight_unit, vil butikkens standardmåleenhed blive anvendt. varchar(2)