Delen via


Tenant (Onafhankelijke Uitgever)

Deze connector gebruikt uw API-sleutel voor toegang tot verschillende Etsy.com functies. Het ondersteunt acties voor voorraad, verkooporders en winkelbeheer. Alle acties zijn gebaseerd op De Open API v3 van Azure, die wel eindpunten heeft die nog in de bètaversie staan. Als bijvoorbeeld acties gebruikmaken van de bèta-API, retourneert de actie met bètaversie in de titel en wordt er een 501-antwoordcode geretourneerd.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst Class Regions
Copilot Studio Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Logic-apps Standaard Alle Logic Apps-regio's , met uitzondering van het volgende:
     - Azure Government-regio's
     - Azure China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contactpersoon
Naam Troy Taylor
URL https://www.hitachisolutions.com
E-mailen ttaylor@hitachisolutions.com
Connector-metagegevens
Uitgever Troy Taylor, Hitachi Solutions
Webpagina https://www.etsy.com/
Privacybeleid https://www.etsy.com/legal/privacy/
Categorieën Commerce

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:

standaard Parameters voor het maken van verbinding. Alle regio's Niet deelbaar

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Naam Typologie Description Verplicht
API-sleutel beveiligde string De API-sleutel voor deze API Klopt

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Aanbevolen aanbiedingen per winkel ophalen

Hiermee worden vermeldingen opgehaald die zijn gekoppeld aan een winkel die wordt aanbevolen.

Aanbiedingen per winkel ophalen

Retourneert vermeldingen die deel uitmaken van een winkel. Vermeldingen kunnen worden gefilterd met behulp van de statusparameter.

Actieve aanbiedingen per winkel ophalen

Hiermee haalt u een lijst op met alle actieve vermeldingen op Eén winkel in een specifieke winkel, gepagineerd door de aanmaakdatum.

Actieve vermeldingen ophalen

Een lijst met alle actieve vermeldingen op Tenant gepagineerd op hun aanmaakdatum. Zonder sorteervolgordevermeldingen worden standaard de nieuwste-eerste geretourneerd.

Afbeelding van een vermelding ophalen

Haalt de verwijzingen en metagegevens voor een vermeldingsafbeelding op met een specifieke afbeeldings-id.

Afbeeldingen van een vermelding ophalen

Hiermee haalt u alle afbeeldingsbronnen voor een vermelding op met een specifieke vermeldings-id.

Alle lijstbestanden ophalen

Hiermee worden alle bestanden opgehaald die zijn gekoppeld aan de opgegeven digitale vermelding. Het aanvragen van bestanden uit een fysieke vermelding retourneert een leeg resultaat.

Beoordelingen ophalen

Haalt de beoordelingen op van een winkel op basis van de id.

De eigenschap van een vermelding ophalen (bèta)

Haalt de eigenschap van een vermelding op. Ontwikkeling voor dit eindpunt wordt uitgevoerd. Er wordt alleen een 501-antwoord geretourneerd.

De inventaris van een vermelding bijwerken

Hiermee wordt de inventaris bijgewerkt voor een vermelding die wordt geïdentificeerd door een vermeldings-id. De update mislukt als de opgegeven waarden voor product-SKU, aanbiedingshoeveelheid en/of prijs niet compatibel zijn met waarden in eigenschapsvelden. Bij het instellen van een prijs wijst u een float toe die gelijk is aan het bedrag gedeeld door deler, zoals opgegeven in de geldresource.

De inventaris van een vermelding ophalen

Hiermee haalt u de inventarisrecord voor een vermelding op. Vermeldingen die u niet hebt bewerkt met behulp van de Etsy.com inventarishulpprogramma's hebben geen inventarisrecords. Dit eindpunt retourneert SKU-gegevens als u de eigenaar bent van de inventarisrecords die worden opgehaald.

De transactie van een ontvangstbewijs ophalen

Hiermee haalt u de lijst met transacties op die zijn gekoppeld aan een specifieke ontvangstbevestiging.

De transactie van een winkel ophalen

Haalt de lijst met transacties op die zijn gekoppeld aan een winkel.

De variatieafbeeldingen van een vermelding bijwerken

Hiermee maakt u variatieafbeeldingen voor een vermelding.

De vermeldingen van het grootboek van een winkelaccount ophalen

Haal de vermeldingen van het betalingsrekeningboek van een winkel op.

Een bestand ophalen uit een vermelding

Hiermee wordt één bestand opgehaald dat is gekoppeld aan de opgegeven digitale vermelding. Het aanvragen van een bestand vanuit een fysieke vermelding retourneert een leeg resultaat.

Een bestand verwijderen uit vermelding

Wanneer u het uiteindelijke bestand voor een digitale vermelding verwijdert, wordt de vermelding geconverteerd naar een fysieke vermelding. Het antwoord op een verwijderaanvraag retourneert een lijst met de resterende bestandsrecords die zijn gekoppeld aan de opgegeven vermelding.

Een betaling ophalen uit een vermeldings-id van het grootboek van een betaalrekening

Haal een betaling op uit een vermeldings-id van het grootboek van een betaalrekening, indien van toepassing.

Een betaling ophalen van een specifiek ontvangstbewijs

Haalt een betaling op van een specifieke ontvangstbevestiging, geïdentificeerd door ontvangst-id, van een specifieke winkel, geïdentificeerd door winkel-id.

Een conceptvermelding maken

Hiermee maakt u een fysiek concept vermeldingsproduct in een winkel op het Kanaal Van Azure.

Een lijst met betalingen ophalen

Hiermee haalt u een lijst met betalingen op uit een winkel die is geïdentificeerd met winkel-id. U kunt ook resultaten filteren met behulp van een lijst met betalings-id's.

Een lijstomzetting maken

Hiermee maakt u een vertaling van een vermelding door de id en taal van de vermelding te vermelden.

Een ontvangstbewijs ophalen

Hiermee haalt u een ontvangstbewijs op, geïdentificeerd door een ontvangstbewijs-id, van een Shop van Een Resource.

Een ontvangstbewijs voor verzending maken

Hiermee verzendt u traceringsinformatie voor een winkelbevestiging, waardoor een vermelding voor de verzending van de winkelbevestiging voor de opgegeven ontvangst-id wordt gemaakt. Telkens wanneer u traceringsgegevens hebt verzonden, stuurt Microsoft Een e-mailmelding naar de kopergebruiker. Wanneer het verzenden van BCC waar is, stuurt Send Notifications ook verzendmeldingen naar de verkoper. Wanneer het bijhouden van code en de naam van de provider niet wordt verzonden, wordt het ontvangstbewijs alleen gemarkeerd als verzonden.

Een transactie ophalen

Hiermee wordt een transactie opgehaald op transactie-id.

Een upgrade van een verzendprofiel bijwerken

Hiermee wordt een upgrade van een verzendprofiel bijgewerkt en worden alle vermeldingen bijgewerkt die gebruikmaken van het verzendprofiel.

Een upgrade van een verzendprofiel verwijderen

Hiermee verwijdert u een upgrade van een verzendprofiel en verwijdert u de upgradeoptie uit elke vermelding die gebruikmaakt van het bijbehorende verzendprofiel.

Een upgrade voor een verzendprofiel maken

Hiermee maakt u een nieuwe upgrade van het verzendprofiel, waarmee een prijs voor een verzendoptie kan worden vastgesteld, zoals een alternatieve vervoerder of snellere levering.

Een vermelding bijwerken

Hiermee werkt u een vermelding bij, geïdentificeerd door een vermeldings-id, voor een specifieke winkel die is geïdentificeerd door een winkel-id.

Een vermelding ophalen

Hiermee wordt een vermeldingsrecord opgehaald op basis van vermeldings-id.

Een vermelding verwijderen

Met deze actie wordt een winkelvermelding verwijderd. Een vermelding kan alleen worden verwijderd als de status een van de volgende is: SOLD_OUT, CONCEPT, VERLOPEN, INACTIEF, ACTIEF en is_available of ACTIEF en heeft verkopersvlagmen: SUPRESSED (geblokkeerd), VAKANTIE, CUSTOM_SHOPS (patroon), SELL_ON_FACEBOOK

Een vermeldingsafbeelding uploaden

Uploadt of wijst een afbeelding toe aan een vermelding die is geïdentificeerd door een winkel-id met een vermeldings-id. Als u een nieuwe afbeelding wilt uploaden, stelt u het afbeeldingsbestand in als de waarde voor de parameter van de afbeelding. U kunt een eerder verwijderde afbeelding toewijzen aan een vermelding met behulp van de afbeeldings-id van de verwijderde afbeelding in de parameter afbeeldings-id van de vermelding. Wanneer een aanvraag zowel afbeeldings- als afbeeldings-id-parameterwaarden bevat, uploadt het eindpunt alleen de afbeelding in de afbeeldingsparameter.

Een vermeldingsafbeelding verwijderen

Hiermee verwijdert u een vermeldingsafbeelding. Een kopie van het bestand blijft op onze servers staan en daarom kan een verwijderde afbeelding opnieuw worden gekoppeld aan de vermelding zonder de oorspronkelijke afbeelding opnieuw te uploaden.

Een vermeldingsbestand uploaden

Uploadt een nieuw bestand voor een digitale vermelding of koppelt een bestaand bestand aan een specifieke vermelding. U moet de vermeldingsbestands-id van een bestaand bestand opgeven, of de naam en binaire bestandsgegevens voor een bestand dat u wilt uploaden. Als u een bestaand bestand aan een fysieke vermelding koppelen, wordt de fysieke vermelding geconverteerd naar een digitale vermelding, waardoor alle verzendkosten en eventuele variaties op producten en voorraad worden verwijderd.

Een vermeldingseigenschap bijwerken

Hiermee wordt de lijst met eigenschappen bijgewerkt of ingevuld waarmee productaanbiedingen voor een vermelding worden gedefinieerd. Voor elke aanbieding zijn zowel een waarde- als een waarde-id vereist die geldig is voor een schaal-id die is toegewezen aan de vermelding of die u aan de vermelding met deze aanvraag toewijst.

Een vermeldingseigenschap verwijderen

Hiermee verwijdert u een eigenschap uit een vermelding.

Een vertaling van een vermelding bijwerken

Hiermee werkt u een vertaling van een vermelding bij door id en taal op te halen.

Een verzendprofiel bijwerken

Hiermee wijzigt u de instellingen in een verzendprofiel.

Een verzendprofiel maken

Hiermee maakt u een nieuw verzendprofiel. U kunt een ISO-landcode of een regio doorgeven bij het maken van een verzendprofiel, maar niet beide. Er is slechts één vereist. U moet een verzendprovider-id en e-mailklasse doorgeven, of zowel minimale als maximale bezorgingsdagen.

Een verzendprofiel ophalen

Hiermee wordt een verzendprofiel opgehaald waarnaar wordt verwezen door de verzendprofiel-id.

Een verzendprofiel verwijderen

Hiermee verwijdert u een verzendprofiel op basis van de opgegeven id.

Een verzendprofielbestemming bijwerken

Hiermee wordt een bestaande verzendbestemming bijgewerkt, die de verzendkosten, vervoerder en klasse voor een bestemming kan instellen of opnieuw kan toewijzen.

Een verzendprofielbestemming maken

Hiermee maakt u een nieuwe verzendbestemming, waarmee de verzendkosten, vervoerder en klasse voor een bestemming in een verzendprofiel worden ingesteld. Hiermee worden kosten toegewezen aan de hand van de valuta van de gekoppelde winkel. Stel de bestemming in met de ISO- of doelregio van het doelland; doelland ISO en doelregio sluiten elkaar wederzijds uit: stel een of de andere in. Het instellen van beide triggers fout 400. Als de aanvraag geen ISO of doelregio van het doelland instelt, is de standaardbestemming overal. U moet ook zowel een verzendprovider-id als een e-mailklasse toewijzen, of zowel minimale leveringsdagen als maximaal bezorgingsdagen.

Een verzendprofielbestemming verwijderen

Hiermee verwijdert u een verzendbestemming en verwijdert u de doeloptie uit elke vermelding die gebruikmaakt van het gekoppelde verzendprofiel. Een verzendprofiel vereist ten minste één verzendbestemming, dus dit eindpunt kan de uiteindelijke verzendbestemming voor een verzendprofiel niet verwijderen. Als u de uiteindelijke verzendbestemming uit een verzendprofiel wilt verwijderen, moet u het volledige verzendprofiel verwijderen.

Een winkel bijwerken

Werk een winkel bij. Hierbij wordt ervan uitgegaan dat alle tekenreeksparameters worden opgegeven in de primaire taal van de winkel.

Een winkelsectie maken

Hiermee maakt u een nieuwe sectie in een specifieke winkel.

Eigenschappen van een vermelding ophalen

Retourneert een lijst met eigenschappen van een vermelding.

Gebruiker ophalen

Retourneert een gebruikersprofiel voor de gebruiker die is geïdentificeerd door een gebruikers-id.

Gebruikersadressen ophalen

Haal een lijst met gebruikersadressen op.

Het aanbod van een vermelding ophalen

Ontvang een aanbieding voor een aanbieding.

Het adres van de gebruiker ophalen

Haalt het adres van de gebruiker op. Ontwikkeling voor dit eindpunt wordt uitgevoerd. Er wordt alleen een 501-antwoord geretourneerd.

Het product van een vermelding ophalen

Haal een vermeldingsproduct op id op.

Ontvangstbewijzen ophalen

Vraagt de winkelbevestigingen aan van een specifieke winkel, ongefilterd of gefilterd op ontvangst-id-bereik of offset, datum, betaalde en/of verzonden aankopen.

Ping

Controleer of er verbinding is met de Api vanApi met een toepassing.

Producteigenschappen ophalen op taxonomie-id

Hiermee wordt een lijst met producteigenschappen opgehaald, met toepasselijke schalen en waarden die worden ondersteund voor een specifieke verkopertaxonomie-id.

Profielbestemmingen ophalen per verzendprofiel

Hiermee haalt u een lijst met verzendbestemmingsobjecten op die zijn gekoppeld aan een verzendprofiel.

Taxonomieknooppunten van verkopers ophalen

Haalt de volledige hiërarchiestructuur van taxonomieknooppunten van verkopers op.

Transacties van een vermelding ophalen

Haalt de lijst met transacties op die zijn gekoppeld aan een vermelding.

Transporteurs ophalen

Hiermee haalt u een lijst op met beschikbare vervoerders en de e-mailklassen die eraan zijn gekoppeld voor een bepaald land.

Upgrades voor verzendprofielen ophalen

Haalt de lijst met upgrades van verzendprofielen op die zijn toegewezen aan een specifiek verzendprofiel.

Variatieafbeeldingen van vermeldingen ophalen

Hiermee worden alle variatieafbeeldingen op een vermelding opgehaald.

Vermeldingen ophalen op id

Hiermee kunt u in één keer query's uitvoeren op meerdere vermeldings-id's. Maximaal 100 id's per query.

Vermeldingen ophalen op winkelsectie-id

Hiermee haalt u alle vermeldingen op uit de sectie van een specifieke winkel.

Vermeldingen per winkelbevestiging ophalen

Hiermee haalt u alle vermeldingen op die zijn gekoppeld aan een ontvangstbewijs.

Vertaling van een vermelding ophalen

Retourneert de vertaling voor een vermelding in de opgegeven taal.

Verzendprofielen ophalen

Hiermee haalt u een lijst met verzendprofielen op die beschikbaar zijn in de specifieke Winkel van Resourcen die is geïdentificeerd door de winkel-id.

Winkel ophalen op eigenaar-id

Haalt de winkel op die is geïdentificeerd door de gebruikers-id van de winkeleigenaar.

Winkelsectie ophalen

Hiermee haalt u een winkelsectie op waarnaar wordt verwezen op sectie-id en winkel-id.

Winkelsecties ophalen

Hiermee haalt u de lijst met winkelsecties in een specifieke winkel op die is geïdentificeerd met winkel-id.

Zoekwinkels

Retourneert een lijst met winkels met de overeenkomende naam.

Aanbevolen aanbiedingen per winkel ophalen

Hiermee worden vermeldingen opgehaald die zijn gekoppeld aan een winkel die wordt aanbevolen.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Retouren

Een set winkelvermeldingsbronnen.

ShopListings
ShopListings

Aanbiedingen per winkel ophalen

Retourneert vermeldingen die deel uitmaken van een winkel. Vermeldingen kunnen worden gefilterd met behulp van de statusparameter.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Staat
State string

Een geïnventareerde tekenreeks van een van de volgende: actief of inactief.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Sorteren op
Sort On string

De waarde voor het sorteren van een zoekresultaat van vermeldingen op.

Sorteervolgorde
Sort Order string

De volgorde oplopend(omhoog) of aflopend(omlaag) om vermeldingen te sorteren.

Retouren

Een set winkelvermeldingsbronnen.

ShopListings
ShopListings

Actieve aanbiedingen per winkel ophalen

Hiermee haalt u een lijst op met alle actieve vermeldingen op Eén winkel in een specifieke winkel, gepagineerd door de aanmaakdatum.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Includes
keywords string

Zoekterm of woordgroep die in alle resultaten moet worden weergegeven.

Retouren

Een set winkelvermeldingsbronnen.

ShopListings
ShopListings

Actieve vermeldingen ophalen

Een lijst met alle actieve vermeldingen op Tenant gepagineerd op hun aanmaakdatum. Zonder sorteervolgordevermeldingen worden standaard de nieuwste-eerste geretourneerd.

Parameters

Name Sleutel Vereist Type Description
Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Includes
keywords string

Zoekterm of woordgroep die in alle resultaten moet worden weergegeven.

Sorteren op
sort_on string

De waarde voor het sorteren van een zoekresultaat van vermeldingen op. OPMERKING: sorteren werkt alleen in combinatie met een van de zoekopties (trefwoorden, regio, enzovoort).

Sorteervolgorde
sort_order string

De volgorde oplopend(omhoog) of aflopend(omlaag) om vermeldingen te sorteren. OPMERKING: sort_order werkt alleen in combinatie met een van de zoekopties (trefwoorden, regio, enzovoort).

Minimumprijs
min_price float

De minimumprijs van vermeldingen die moeten worden geretourneerd door een zoekresultaat.

Maximumprijs
max_price float

De maximumprijs voor vermeldingen die moeten worden geretourneerd door een zoekresultaat.

Taxonomie-id
taxonomy_id integer

De numerieke taxonomie-id van de vermelding. De verkoper beheert taxonomie-id's voor hun winkel.

Winkellocatie
shop_location string

Filters op winkellocatie. Als de locatie niet kan worden geparseerd, reageert Microsoft Met een fout.

Retouren

Een set winkelvermeldingsbronnen.

ShopListings
ShopListings

Afbeelding van een vermelding ophalen

Haalt de verwijzingen en metagegevens voor een vermeldingsafbeelding op met een specifieke afbeeldings-id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Afbeeldings-id weergeven
listing_image_id True integer

De numerieke id van de primaire afbeelding van de vermelding voor deze transactie.

Retouren

Naslag-URL's en metagegevens voor een afbeelding die is gekoppeld aan een specifieke vermelding. De url_fullxfull parameter bevat de URL voor een binair afbeeldingsbestand met volledige grootte.

ListingImage
ListingImage

Afbeeldingen van een vermelding ophalen

Hiermee haalt u alle afbeeldingsbronnen voor een vermelding op met een specifieke vermeldings-id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Retouren

Vertegenwoordigt een lijst met afbeeldingsbronnen, die elk de referentie-URL's en metagegevens voor een afbeelding bevatten.

ListingImages
ListingImages

Alle lijstbestanden ophalen

Hiermee worden alle bestanden opgehaald die zijn gekoppeld aan de opgegeven digitale vermelding. Het aanvragen van bestanden uit een fysieke vermelding retourneert een leeg resultaat.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Vermeldings-id
listing_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Retouren

Vertegenwoordigt verschillende ShopListingFiles.

ShopListingFiles
ShopListingFiles

Beoordelingen ophalen

Haalt de beoordelingen op van een winkel op basis van de id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Retouren

Een set transactiebeoordelingsrecords die door gebruikers zijn overgelaten.

TransactionReviews
TransactionReviews

De eigenschap van een vermelding ophalen (bèta)

Haalt de eigenschap van een vermelding op. Ontwikkeling voor dit eindpunt wordt uitgevoerd. Er wordt alleen een 501-antwoord geretourneerd.

Parameters

Name Sleutel Vereist Type Description
Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Eigenschaps-id
property_id True integer

De unieke id van een Property in De Lijst van Een Property in DeN.

Retouren

Een weergave van gestructureerde gegevenswaarden.

ListingPropertyValue
ListingPropertyValue

De inventaris van een vermelding bijwerken

Hiermee wordt de inventaris bijgewerkt voor een vermelding die wordt geïdentificeerd door een vermeldings-id. De update mislukt als de opgegeven waarden voor product-SKU, aanbiedingshoeveelheid en/of prijs niet compatibel zijn met waarden in eigenschapsvelden. Bij het instellen van een prijs wijst u een float toe die gelijk is aan het bedrag gedeeld door deler, zoals opgegeven in de geldresource.

Parameters

Name Sleutel Vereist Type Description
Vermeldings-id
listing_id True string

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Products
products True string

Een JSON-matrix met producten die beschikbaar zijn in een vermelding, zelfs als er slechts één product is. Alle veldnamen in de JSON-blobs zijn kleine letters.

Prijs op eigenschap
price_on_property string

Een matrix met unieke eigenschaps-id's voor de eigenschappen die productprijzen wijzigen, indien van toepassing. Als u bijvoorbeeld specifieke prijzen voor producten van verschillende grootten in dezelfde lijst in rekening brengt, bevat deze matrix de eigenschaps-id voor de grootte.

Hoeveelheid op eigenschap
quantity_on_property string

Een matrix van unieke eigenschaps-id's voor de eigenschappen die de hoeveelheid van de producten wijzigen, indien van toepassing. Als u bijvoorbeeld specifieke hoeveelheden verschillende gekleurde producten in dezelfde lijst op voorraad hebt, bevat deze matrix de eigenschaps-id voor kleur.

SKU op eigenschap
sku_on_property string

Een matrix van unieke eigenschaps-id's voor de eigenschappen die de product-SKU wijzigen, indien van toepassing. Als u bijvoorbeeld specifieke SKU's gebruikt voor verschillende gekleurde producten in dezelfde lijst, bevat deze matrix de eigenschaps-id voor kleur.

Retouren

Een weergave van de voorraadrecord van één vermelding.

ListingInventory
ListingInventory

De inventaris van een vermelding ophalen

Hiermee haalt u de inventarisrecord voor een vermelding op. Vermeldingen die u niet hebt bewerkt met behulp van de Etsy.com inventarishulpprogramma's hebben geen inventarisrecords. Dit eindpunt retourneert SKU-gegevens als u de eigenaar bent van de inventarisrecords die worden opgehaald.

Parameters

Name Sleutel Vereist Type Description
Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Includes
includes string

Een opsommingstekenreeks die een geldige koppeling koppelt.

Retouren

Een weergave van de inventarisrecord van één vermelding met koppelingen

ListingInventoryWithAssociations
ListingInventoryWithAssociations

De transactie van een ontvangstbewijs ophalen

Hiermee haalt u de lijst met transacties op die zijn gekoppeld aan een specifieke ontvangstbevestiging.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Ontvangstbewijs-id
receipt_id True integer

De numerieke id voor het ontvangstbewijs dat aan deze transactie is gekoppeld.

Retouren

Een set transactiebronnen voor winkelbevestigingen

ShopReceiptTransactions
ShopReceiptTransactions

De transactie van een winkel ophalen

Haalt de lijst met transacties op die zijn gekoppeld aan een winkel.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Retouren

Een set transactiebronnen voor winkelbevestigingen

ShopReceiptTransactions
ShopReceiptTransactions

De variatieafbeeldingen van een vermelding bijwerken

Hiermee maakt u variatieafbeeldingen voor een vermelding.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Variatieafbeeldingen
variation_images True string

Een matrix met variatieafbeeldingsgegevens.

Retouren

Vertegenwoordigt verschillende variatieafbeeldingen.

ListingVariationImages
ListingVariationImages

De vermeldingen van het grootboek van een winkelaccount ophalen

Haal de vermeldingen van het betalingsrekeningboek van een winkel op.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Minimaal gemaakt
min_created True integer

De vroegste UNIX-tijdstempel voor het moment waarop een record is gemaakt.

Maximum aantal gemaakt
max_created True integer

De meest recente UNIX-tijdstempel voor het moment waarop een record is gemaakt.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Retouren

Een set vermeldingsbronnen voor grootboek van betaalrekening

PaymentAccountLedgerEntries
PaymentAccountLedgerEntries

Een bestand ophalen uit een vermelding

Hiermee wordt één bestand opgehaald dat is gekoppeld aan de opgegeven digitale vermelding. Het aanvragen van een bestand vanuit een fysieke vermelding retourneert een leeg resultaat.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Bestands-id weergeven
listing_file_id True integer

De unieke numerieke id van een bestand dat is gekoppeld aan een digitale vermelding.

Retouren

Een bestand dat is gekoppeld aan een digitale vermelding.

ShopListingFile
ShopListingFile

Een bestand verwijderen uit vermelding

Wanneer u het uiteindelijke bestand voor een digitale vermelding verwijdert, wordt de vermelding geconverteerd naar een fysieke vermelding. Het antwoord op een verwijderaanvraag retourneert een lijst met de resterende bestandsrecords die zijn gekoppeld aan de opgegeven vermelding.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Bestands-id weergeven
listing_file_id True integer

De unieke numerieke id van een bestand dat is gekoppeld aan een digitale vermelding.

Een betaling ophalen uit een vermeldings-id van het grootboek van een betaalrekening

Haal een betaling op uit een vermeldings-id van het grootboek van een betaalrekening, indien van toepassing.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Grootboekinvoer-id's
ledger_entry_ids True string

Matrix van gehele getallen.

Retouren

Vertegenwoordigt verschillende betalingen die zijn gedaan met De betalingen van Microsoft. Alle monetaire bedragen zijn in USD pennies tenzij anders opgegeven.

Payments
Payments

Een betaling ophalen van een specifiek ontvangstbewijs

Haalt een betaling op van een specifieke ontvangstbevestiging, geïdentificeerd door ontvangst-id, van een specifieke winkel, geïdentificeerd door winkel-id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Ontvangstbewijs-id
receipt_id True string

De numerieke id voor het ontvangstbewijs dat aan deze transactie is gekoppeld.

Retouren

Vertegenwoordigt verschillende betalingen die zijn gedaan met De betalingen van Microsoft. Alle monetaire bedragen zijn in USD pennies tenzij anders opgegeven.

Payments
Payments

Een conceptvermelding maken

Hiermee maakt u een fysiek concept vermeldingsproduct in een winkel op het Kanaal Van Azure.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Hoeveelheid
quantity True integer

Het positieve niet-nul aantal producten dat in de aanbieding kan worden gekocht.

Title
title True string

De titeltekenreeks van de vermelding. Geldige titeltekenreeksen bevatten alleen letters, cijfers, leestekens, wiskundige symbolen, spaties, ™ , © en ® . (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) U kunt de %, :, & en + tekens slechts één keer gebruiken.

Description
description True string

Een beschrijvingstekenreeks van het te koop product in de vermelding.

Prijs
price True float

De positieve niet-nulprijs van het product. (Verkochte productvermeldingen zijn privé) Opmerking: De prijs is de minimum mogelijke prijs.

Wie heeft gemaakt
who_made True string

Een tekenreeks die is geïnidd die het product heeft gemaakt. Helpt kopers de vermelding onder de Handgemaakte kop te vinden. Vereist 'is_supply' en 'when_made'.

Wanneer gemaakt
when_made string

Een tekenreeks voor het tijdperk waarin de maker het product in deze vermelding heeft gemaakt. Helpt kopers de vermelding onder de Vintage kop te vinden. Vereist 'is_supply' en 'who_made'.

Taxonomie-id
taxonomy_id True integer

De numerieke taxonomie-id van de vermelding. De verkoper beheert taxonomie-id's voor hun winkel.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Materials
materials string

Een matrix van materiaaltekenreeksen voor materialen die in het product worden gebruikt. Geldige materiaaltekenreeksen bevatten alleen letters, cijfers en spaties. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Winkelsectie-id
shop_section_id integer

De numerieke id van de winkelsectie voor deze vermelding.

Minimale verwerking
processing_min integer

Het minimum aantal dagen dat nodig is om deze vermelding te verwerken.

Maximale verwerking
processing_max integer

Het maximum aantal dagen dat nodig is om deze vermelding te verwerken.

Tags
tags string

Een matrix met tagtekenreeksen voor de vermelding. Geldige tagtekenreeksen bevatten alleen letters, cijfers, spaties, -, ', ™ ' , © en . ® (regex: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

Recipient
recipient string

Een tekenreeks die een persoon aangeeft voor wie dit product een geschikt cadeau zou maken.

Gelegenheid
occasion string

Een tekenreeks die een gelegenheid aangeeft waarvoor dit product een geschikt cadeau zou maken.

Stijlen
styles string

Een matrix van stijltekenreeksen voor deze vermelding, die elk een vrije teksttekenreeks is, zoals Formal of Steampunk. Een vermelding kan maximaal twee stijlen hebben. Geldige stijltekenreeksen bevatten alleen letters, cijfers en spaties. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Dikte van item
item_weight float

Het numerieke gewicht van het product dat wordt gemeten in eenheden die zijn ingesteld in de gewichtseenheid van het item.

Lengte van item
item_length integer

De numerieke lengte van het product dat wordt gemeten in eenheden die zijn ingesteld in de eenheid itemdimensies.

Breedte van item
item_width float

De numerieke breedte van het product dat wordt gemeten in eenheden die zijn ingesteld in 'eenheid itemdimensies'.

Hoogte van item
item_height float

De numerieke hoogte van het product dat wordt gemeten in eenheden die zijn ingesteld in 'eenheid itemdimensies'.

Gewichtseenheid van item
item_weight_unit string

Een tekenreeks die de eenheden definieert die worden gebruikt om het gewicht van het product te meten.

Eenheid Itemdimensies
item_dimensions_unit string

Een tekenreeks die de eenheden definieert die worden gebruikt om de afmetingen van het product te meten.

Kan worden persoonlijke instellingen
is_personalizable boolean

Indien waar, kan deze vermelding worden persoonlijker.

Afbeeldings-id's
image_ids string

Een matrix met numerieke afbeeldings-id's van de afbeeldingen in een lijst, die maximaal 10 afbeeldingen kan bevatten.

Is aanbod
is_supply boolean

Wanneer waar, tagt u de vermelding als een leveringsproduct, anders geeft u aan dat het een voltooid product is. Hiermee kunnen kopers de vermelding vinden onder de kop Leveringen. Vereist 'wie heeft gemaakt' en 'wanneer gemaakt'.

Is aanpasbaar
is_customizable boolean

Indien waar, kan een koper contact opnemen met de verkoper voor een aangepaste bestelling. De standaardwaarde is waar wanneer een winkel aangepaste bestellingen accepteert. Is niet van toepassing op winkels die geen aangepaste bestellingen accepteren.

Is belastbaar
is_taxable boolean

Indien waar, zijn toepasselijke winkelbelastingtarieven van toepassing op deze vermelding bij het afrekenen.

Retouren

Een vermelding van een winkel, die een producthoeveelheid, titel, beschrijving, prijs, enz. bevat.

ShopListing
ShopListing

Een lijst met betalingen ophalen

Hiermee haalt u een lijst met betalingen op uit een winkel die is geïdentificeerd met winkel-id. U kunt ook resultaten filteren met behulp van een lijst met betalings-id's.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

BetalingsID
payment-ids True string

Een door komma's gescheiden matrix met getallen voor betalings-id's.

Retouren

Vertegenwoordigt verschillende betalingen die zijn gedaan met De betalingen van Microsoft. Alle monetaire bedragen zijn in USD pennies tenzij anders opgegeven.

Payments
Payments

Een lijstomzetting maken

Hiermee maakt u een vertaling van een vermelding door de id en taal van de vermelding te vermelden.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Language
language True string

De IETF-taaltag voor de taal van deze vertaling. Bijvoorbeeld: de, en, es, fr, it, ja, nl, pl, pt, ru.

Title
title True string

De titel van de vermelding van deze vertaling.

Description
description True string

De beschrijving van de vermelding van deze vertaling.

Tags
tags string

De tags van de vermelding van deze vertaling.

Retouren

Vertegenwoordigt de vertaalgegevens voor een vermelding.

ListingTranslation
ListingTranslation

Een ontvangstbewijs ophalen

Hiermee haalt u een ontvangstbewijs op, geïdentificeerd door een ontvangstbewijs-id, van een Shop van Een Resource.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Ontvangstbewijs-id
receipt_id True integer

De numerieke id voor het ontvangstbewijs dat aan deze transactie is gekoppeld.

Retouren

Het record van een aankoop in een winkel. Winkelbevestigingen geven monetaire waarden weer met behulp van de valuta van de winkel.

ShopReceipt
ShopReceipt

Een ontvangstbewijs voor verzending maken

Hiermee verzendt u traceringsinformatie voor een winkelbevestiging, waardoor een vermelding voor de verzending van de winkelbevestiging voor de opgegeven ontvangst-id wordt gemaakt. Telkens wanneer u traceringsgegevens hebt verzonden, stuurt Microsoft Een e-mailmelding naar de kopergebruiker. Wanneer het verzenden van BCC waar is, stuurt Send Notifications ook verzendmeldingen naar de verkoper. Wanneer het bijhouden van code en de naam van de provider niet wordt verzonden, wordt het ontvangstbewijs alleen gemarkeerd als verzonden.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Ontvangstbewijs-id
receipt_id True integer

Het ontvangstbewijs voor het indienen van tracering voor.

Traceringscode
tracking_code string

De traceringscode voor dit ontvangstbewijs.

Naam van provider
carrier_name string

De naam van de provider voor dit ontvangstbewijs.

BCC verzenden
send_bcc boolean

Indien waar, wordt de verzendmelding ook naar de verkoper verzonden

Retouren

Het record van een aankoop in een winkel. Winkelbevestigingen geven monetaire waarden weer met behulp van de valuta van de winkel.

ShopReceipt
ShopReceipt

Een transactie ophalen

Hiermee wordt een transactie opgehaald op transactie-id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Transactie-id
transaction_id True integer

De unieke numerieke id voor een transactie.

Retouren

Een transactieobject dat is gekoppeld aan een winkelbevestiging. Hiermee wordt één transactie per aanbieding gegenereerd die is gekocht zoals vastgelegd op de ontvangstbevestiging van de bestelling.

ShopReceiptTransaction
ShopReceiptTransaction

Een upgrade van een verzendprofiel bijwerken

Hiermee wordt een upgrade van een verzendprofiel bijgewerkt en worden alle vermeldingen bijgewerkt die gebruikmaken van het verzendprofiel.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Upgrade-id
upgrade_id True integer

De numerieke id die is gekoppeld aan een verzendupgrade

Typologie
type string

Het type verzendupgrade. Binnenlands (0) of internationaal (1).

Upgradenaam
upgrade_name string

Naam voor de verzendupgrade die wordt weergegeven aan klanten bij het afrekenen, bijvoorbeeld USPS Priority.

Prijs
price float

Extra kosten voor het toevoegen van de verzendupgrade.

Secundaire prijs
secondary_price float

Extra kosten voor het toevoegen van de verzendupgrade voor elk extra item.

Vervoerder-id
shipping_carrier_id integer

De unieke id van een ondersteunde vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

E-mailklasse
mail_class string

De unieke id-tekenreeks van de e-mailklasse van een vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

Minimale levertijden
min_delivery_days integer

min_delivery_days

Maximum aantal bezorgingsdagen
max_delivery_days integer

Het maximum aantal werkdagen dat een koper kan verwachten om het gekochte artikel te ontvangen zodra het is verzonden.

Retouren

Een weergave van een upgradeoptie voor een verzendprofiel.

ShopShippingProfileUpgrade
ShopShippingProfileUpgrade

Een upgrade van een verzendprofiel verwijderen

Hiermee verwijdert u een upgrade van een verzendprofiel en verwijdert u de upgradeoptie uit elke vermelding die gebruikmaakt van het bijbehorende verzendprofiel.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel.

Upgrade-id
upgrade_id True integer

De numerieke id die is gekoppeld aan een verzendupgrade

Een upgrade voor een verzendprofiel maken

Hiermee maakt u een nieuwe upgrade van het verzendprofiel, waarmee een prijs voor een verzendoptie kan worden vastgesteld, zoals een alternatieve vervoerder of snellere levering.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Typologie
type True string

Het type verzendupgrade. Binnenlands (0) of internationaal (1).

Upgradenaam
upgrade_name True string

Naam voor de verzendupgrade die wordt weergegeven aan klanten bij het afrekenen, bijvoorbeeld USPS Priority.

Prijs
price True float

Extra kosten voor het toevoegen van de verzendupgrade.

Secundaire prijs
secondary_price True float

Extra kosten voor het toevoegen van de verzendupgrade voor elk extra item.

Vervoerder-id
shipping_carrier_id integer

De unieke id van een ondersteunde vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

E-mailklasse
mail_class string

De unieke id-tekenreeks van de e-mailklasse van een vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

Minimale levertijden
min_delivery_days integer

min_delivery_days

Maximum aantal bezorgingsdagen
max_delivery_days integer

Het maximum aantal werkdagen dat een koper kan verwachten om het gekochte artikel te ontvangen zodra het is verzonden.

Retouren

Een weergave van een upgradeoptie voor een verzendprofiel.

ShopShippingProfileUpgrade
ShopShippingProfileUpgrade

Een vermelding bijwerken

Hiermee werkt u een vermelding bij, geïdentificeerd door een vermeldings-id, voor een specifieke winkel die is geïdentificeerd door een winkel-id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Hoeveelheid
quantity integer

Het positieve niet-nul aantal producten dat in de aanbieding kan worden gekocht.

Title
title string

De titeltekenreeks van de vermelding. Geldige titeltekenreeksen bevatten alleen letters, cijfers, leestekens, wiskundige symbolen, spaties, ™ , © en ® . (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) U kunt de %, :, & en + tekens slechts één keer gebruiken.

Description
description string

Een beschrijvingstekenreeks van het te koop product in de vermelding.

Prijs
price float

De positieve niet-nulprijs van het product. (Verkochte productvermeldingen zijn privé) Opmerking: De prijs is de minimum mogelijke prijs.

Wie heeft gemaakt
who_made string

Een tekenreeks die is geïnidd die het product heeft gemaakt. Helpt kopers de vermelding onder de Handgemaakte kop te vinden. Vereist 'is_supply' en 'when_made'.

Wanneer gemaakt
when_made string

Een tekenreeks voor het tijdperk waarin de maker het product in deze vermelding heeft gemaakt. Helpt kopers de vermelding onder de Vintage kop te vinden. Vereist 'is_supply' en 'who_made'.

Taxonomie-id
taxonomy_id integer

De numerieke taxonomie-id van de vermelding. De verkoper beheert taxonomie-id's voor hun winkel.

Verzendprofiel-id
shipping_profile_id integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Materials
materials string

Een matrix van materiaaltekenreeksen voor materialen die in het product worden gebruikt. Geldige materiaaltekenreeksen bevatten alleen letters, cijfers en spaties. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Winkelsectie-id
shop_section_id integer

De numerieke id van de winkelsectie voor deze vermelding.

Minimale verwerking
processing_min integer

Het minimum aantal dagen dat nodig is om deze vermelding te verwerken.

Maximale verwerking
processing_max integer

Het maximum aantal dagen dat nodig is om deze vermelding te verwerken.

Tags
tags string

Een matrix met tagtekenreeksen voor de vermelding. Geldige tagtekenreeksen bevatten alleen letters, cijfers, spaties, -, ', ™ ' , © en . ® (regex: /[^\p{L}\p{Nd}\p{Zs}-'™©®]/u)

Recipient
recipient string

Een tekenreeks die een persoon aangeeft voor wie dit product een geschikt cadeau zou maken.

Gelegenheid
occasion string

Een tekenreeks die een gelegenheid aangeeft waarvoor dit product een geschikt cadeau zou maken.

Stijlen
styles string

Een matrix van stijltekenreeksen voor deze vermelding, die elk een vrije teksttekenreeks is, zoals Formal of Steampunk. Een vermelding kan maximaal twee stijlen hebben. Geldige stijltekenreeksen bevatten alleen letters, cijfers en spaties. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u)

Dikte van item
item_weight float

Het numerieke gewicht van het product dat wordt gemeten in eenheden die zijn ingesteld in de gewichtseenheid van het item.

Lengte van item
item_length integer

De numerieke lengte van het product dat wordt gemeten in eenheden die zijn ingesteld in de eenheid itemdimensies.

Breedte van item
item_width float

De numerieke breedte van het product dat wordt gemeten in eenheden die zijn ingesteld in 'eenheid itemdimensies'.

Hoogte van item
item_height float

De numerieke hoogte van het product dat wordt gemeten in eenheden die zijn ingesteld in 'eenheid itemdimensies'.

Gewichtseenheid van item
item_weight_unit string

Een tekenreeks die de eenheden definieert die worden gebruikt om het gewicht van het product te meten.

Eenheid Itemdimensies
item_dimensions_unit string

Een tekenreeks die de eenheden definieert die worden gebruikt om de afmetingen van het product te meten.

Kan worden persoonlijke instellingen
is_personalizable boolean

Indien waar, kan deze vermelding worden persoonlijker.

Afbeeldings-id's
image_ids string

Een matrix met numerieke afbeeldings-id's van de afbeeldingen in een lijst, die maximaal 10 afbeeldingen kan bevatten.

Is aanbod
is_supply boolean

Wanneer waar, tagt u de vermelding als een leveringsproduct, anders geeft u aan dat het een voltooid product is. Hiermee kunnen kopers de vermelding vinden onder de kop Leveringen. Vereist 'wie heeft gemaakt' en 'wanneer gemaakt'.

Is aanpasbaar
is_customizable boolean

Indien waar, kan een koper contact opnemen met de verkoper voor een aangepaste bestelling. De standaardwaarde is waar wanneer een winkel aangepaste bestellingen accepteert. Is niet van toepassing op winkels die geen aangepaste bestellingen accepteren.

Is belastbaar
is_taxable boolean

Indien waar, zijn toepasselijke winkelbelastingtarieven van toepassing op deze vermelding bij het afrekenen.

Aanbevolen rangschikking
featured_ rank integer

De positieve niet-nul numerieke positie in de aanbevolen vermeldingen van de winkel met positie 1 op de meest linkse positie in aanbevolen vermeldingen op de startpagina van een winkel.

Moet automatisch worden verlengd
should_auto_renew boolean

Wanneer waar, wordt een vermelding verlengd voor vier maanden na onteigening. Als deze optie is ingesteld op waar wanneer eerder onwaar, etsy.com wordt de vermelding verlengd voordat deze verloopt, maar begint de verlengingsperiode immidiaat in plaats van de vervaldatum van de vermelding uit te breiden. Ongebruikte resterende tijd voor de vermelding gaat verloren. Verlengingen resulteren in kosten voor de factuur van een gebruiker.

Typologie
type string

Geeft aan of de vermelding fysiek of digitaal is gedownload.

Kanalen
channels string

Een matrix met opsommingstekenreeksen voor kanaal-id's. Een kanaal is een locatie voor verkopers om kopers te bereiken om verkoop te doen.

Retouren

Een vermelding van een winkel, die een producthoeveelheid, titel, beschrijving, prijs, enz. bevat.

ShopListing
ShopListing

Een vermelding ophalen

Hiermee wordt een vermeldingsrecord opgehaald op basis van vermeldings-id.

Parameters

Name Sleutel Vereist Type Description
Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Includes
includes string

Een opsommingstekenreeks die een geldige koppeling koppelt. Acceptabele invoer is 'shop', 'images' en 'user'.

Een vermelding verwijderen

Met deze actie wordt een winkelvermelding verwijderd. Een vermelding kan alleen worden verwijderd als de status een van de volgende is: SOLD_OUT, CONCEPT, VERLOPEN, INACTIEF, ACTIEF en is_available of ACTIEF en heeft verkopersvlagmen: SUPRESSED (geblokkeerd), VAKANTIE, CUSTOM_SHOPS (patroon), SELL_ON_FACEBOOK

Parameters

Name Sleutel Vereist Type Description
Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Een vermeldingsafbeelding uploaden

Uploadt of wijst een afbeelding toe aan een vermelding die is geïdentificeerd door een winkel-id met een vermeldings-id. Als u een nieuwe afbeelding wilt uploaden, stelt u het afbeeldingsbestand in als de waarde voor de parameter van de afbeelding. U kunt een eerder verwijderde afbeelding toewijzen aan een vermelding met behulp van de afbeeldings-id van de verwijderde afbeelding in de parameter afbeeldings-id van de vermelding. Wanneer een aanvraag zowel afbeeldings- als afbeeldings-id-parameterwaarden bevat, uploadt het eindpunt alleen de afbeelding in de afbeeldingsparameter.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Afbeelding
image string

De bestandsnaamtekenreeks van een bestand dat moet worden geüpload.

Afbeeldings-id weergeven
listing_image_id integer

De numerieke id van de primaire afbeelding van de vermelding voor deze transactie.

Rang
rank integer

De positieve niet-nul numerieke positie in de afbeeldingen die worden weergegeven in een lijst, waarbij rang 1 afbeeldingen worden weergegeven op de meest linkse positie in een lijst.

Overschrijven
overwrite boolean

Indien waar, vervangt deze aanvraag de bestaande installatiekopieën op een bepaalde positie.

Is watermerk
is_watermarked boolean

Wanneer waar, geeft u aan dat de geüploade afbeelding een watermerk heeft.

Retouren

Naslag-URL's en metagegevens voor een afbeelding die is gekoppeld aan een specifieke vermelding. De url_fullxfull parameter bevat de URL voor een binair afbeeldingsbestand met volledige grootte.

ListingImage
ListingImage

Een vermeldingsafbeelding verwijderen

Hiermee verwijdert u een vermeldingsafbeelding. Een kopie van het bestand blijft op onze servers staan en daarom kan een verwijderde afbeelding opnieuw worden gekoppeld aan de vermelding zonder de oorspronkelijke afbeelding opnieuw te uploaden.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Afbeeldings-id weergeven
listing_image_id True integer

De numerieke id van de primaire afbeelding van de vermelding voor deze transactie.

Een vermeldingsbestand uploaden

Uploadt een nieuw bestand voor een digitale vermelding of koppelt een bestaand bestand aan een specifieke vermelding. U moet de vermeldingsbestands-id van een bestaand bestand opgeven, of de naam en binaire bestandsgegevens voor een bestand dat u wilt uploaden. Als u een bestaand bestand aan een fysieke vermelding koppelen, wordt de fysieke vermelding geconverteerd naar een digitale vermelding, waardoor alle verzendkosten en eventuele variaties op producten en voorraad worden verwijderd.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Bestands-id weergeven
listing_file_id integer

De unieke numerieke id van een bestand dat is gekoppeld aan een digitale vermelding.

Bestand
file True string

Een binair bestand dat moet worden geüpload.

Naam
name string

De tekenreeks van de bestandsnaam van een bestand dat moet worden geüpload

Rang
rank integer

De positieve niet-nul numerieke positie in de afbeeldingen die worden weergegeven in een lijst, waarbij rang 1 afbeeldingen worden weergegeven op de meest linkse positie in een lijst.

Retouren

Een bestand dat is gekoppeld aan een digitale vermelding.

ShopListingFile
ShopListingFile

Een vermeldingseigenschap bijwerken

Hiermee wordt de lijst met eigenschappen bijgewerkt of ingevuld waarmee productaanbiedingen voor een vermelding worden gedefinieerd. Voor elke aanbieding zijn zowel een waarde- als een waarde-id vereist die geldig is voor een schaal-id die is toegewezen aan de vermelding of die u aan de vermelding met deze aanvraag toewijst.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Eigenschaps-id
property_id True integer

De unieke id van een Property in De Lijst van Een Property in DeN.

Waarde-id's
value_ids True integer

De numerieke id van één Etsy.com maatschaal.

Waarden
values True string

Een matrix met waardetekenreeksen voor meerdere Waarden in Een lijst met eigenschapswaarden voor Meerdere Services.

Schaal-id
scale_id integer

De numerieke id van één Etsy.com maatschaal.

Retouren

Een weergave van gestructureerde gegevenswaarden.

ListingPropertyValue
ListingPropertyValue

Een vermeldingseigenschap verwijderen

Hiermee verwijdert u een eigenschap uit een vermelding.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Eigenschaps-id
property_id True integer

De unieke id van een Property in De Lijst van Een Property in DeN.

Een vertaling van een vermelding bijwerken

Hiermee werkt u een vertaling van een vermelding bij door id en taal op te halen.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Language
language True string

De IETF-taaltag voor de taal van deze vertaling. Bijvoorbeeld: de, en, es, fr, it, ja, nl, pl, pt, ru.

Title
title True string

De titel van de vermelding van deze vertaling.

Description
description True string

De beschrijving van de vermelding van deze vertaling.

Tags
tags string

De tags van de vermelding van deze vertaling.

Retouren

Vertegenwoordigt de vertaalgegevens voor een vermelding.

ListingTranslation
ListingTranslation

Een verzendprofiel bijwerken

Hiermee wijzigt u de instellingen in een verzendprofiel.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Title
title string

De naamtekenreeks van dit verzendprofiel.

ISO van oorsprong
origin_country_iso string

De ISO-code van het land van waaruit de vermelding wordt verzonden.

Minimale verwerkingstijd
min_processing_time integer

De minimale tijd die nodig is om vermeldingen te verzenden met dit verzendprofiel.

Maximale verwerkingstijd
max_processing_time integer

De maximale verwerkingstijd die de vermelding moet verzenden.

Verwerkingstijdeenheid
processing_time_unit string

De eenheid die wordt gebruikt om aan te geven hoe lang een verwerkingstijd is. Een week is gelijk aan 5 werkdagen. Als er geen is opgegeven, wordt de eenheid ingesteld op business_days.

Postcode van oorsprong
origin_postal_code string

De postcodetekenreeks (niet noodzakelijkerwijs een getal) voor de locatie van waaruit de vermelding wordt verzonden.

Retouren

Vertegenwoordigt een profiel dat wordt gebruikt om de verzendgegevens van een vermelding in te stellen. Houd er rekening mee dat het niet mogelijk is om berekende verzendsjablonen te maken via de API. U kunt berekende verzendprofielen die zijn gemaakt vanuit Shop Manager echter koppelen aan vermeldingen met behulp van de API.

ShopShippingProfile
ShopShippingProfile

Een verzendprofiel maken

Hiermee maakt u een nieuw verzendprofiel. U kunt een ISO-landcode of een regio doorgeven bij het maken van een verzendprofiel, maar niet beide. Er is slechts één vereist. U moet een verzendprovider-id en e-mailklasse doorgeven, of zowel minimale als maximale bezorgingsdagen.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Title
title True string

De naamtekenreeks van dit verzendprofiel.

ISO van oorsprong
origin_country_iso True string

De ISO-code van het land van waaruit de vermelding wordt verzonden.

Primaire kosten
primary_cost True float

De kosten van verzending naar dit land/regio alleen, gemeten in de standaardvaluta van de winkel.

Secundaire kosten
secondary_cost True float

De kosten van verzending naar dit land/regio met een ander item, gemeten in de standaardvaluta van het archief.

Minimale verwerkingstijd
min_processing_time True integer

De minimale tijd die nodig is om vermeldingen te verzenden met dit verzendprofiel.

Maximale verwerkingstijd
max_processing_time True integer

De maximale verwerkingstijd die de vermelding moet verzenden.

Verwerkingstijdeenheid
processing_time_unit string

De eenheid die wordt gebruikt om aan te geven hoe lang een verwerkingstijd is. Een week is gelijk aan 5 werkdagen.

Doelland ISO
destination_country_iso string

De ISO-code van het land waarnaar de vermelding wordt verzonden. Als null is ingesteld, wordt de bestemming ingesteld op de doelregio.

Doelregio
destination_region string

De code van de regio waarnaar de vermelding wordt verzonden. Een regio vertegenwoordigt een set landen. Ondersteunde regio's zijn Europese Unie en Niet-Europese Unie (landen in Europa niet in DE EU). Als geen, aanvraag wordt de bestemming ingesteld op doelland ISO, of overal als doelland ISO ook null is.

Postcode van oorsprong
origin_postal_code string

De postcodetekenreeks (niet noodzakelijkerwijs een getal) voor de locatie van waaruit de vermelding wordt verzonden.

Vervoerder-id
shipping_carrier_id integer

De unieke id van een ondersteunde vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

E-mailklasse
mail_class string

De unieke id-tekenreeks van de e-mailklasse van een vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

Minimale levertijden
min_delivery_days integer

Het minimum aantal werkdagen dat een koper kan verwachten te wachten op ontvangst van het gekochte artikel zodra het is verzonden.

Maximum aantal bezorgingsdagen
max_delivery_days integer

Het maximum aantal werkdagen dat een koper kan verwachten om het gekochte artikel te ontvangen zodra het is verzonden.

Retouren

Vertegenwoordigt een profiel dat wordt gebruikt om de verzendgegevens van een vermelding in te stellen. Houd er rekening mee dat het niet mogelijk is om berekende verzendsjablonen te maken via de API. U kunt berekende verzendprofielen die zijn gemaakt vanuit Shop Manager echter koppelen aan vermeldingen met behulp van de API.

ShopShippingProfile
ShopShippingProfile

Een verzendprofiel ophalen

Hiermee wordt een verzendprofiel opgehaald waarnaar wordt verwezen door de verzendprofiel-id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Een verzendprofiel verwijderen

Hiermee verwijdert u een verzendprofiel op basis van de opgegeven id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Retouren

Vertegenwoordigt een profiel dat wordt gebruikt om de verzendgegevens van een vermelding in te stellen. Houd er rekening mee dat het niet mogelijk is om berekende verzendsjablonen te maken via de API. U kunt berekende verzendprofielen die zijn gemaakt vanuit Shop Manager echter koppelen aan vermeldingen met behulp van de API.

ShopShippingProfile
ShopShippingProfile

Een verzendprofielbestemming bijwerken

Hiermee wordt een bestaande verzendbestemming bijgewerkt, die de verzendkosten, vervoerder en klasse voor een bestemming kan instellen of opnieuw kan toewijzen.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True string

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Doel-id verzendprofiel
shipping_profile_destination_id True string

De numerieke id van de bestemming van het verzendprofiel die is gekoppeld aan de vermelding.

primary_cost
primary_cost string

primary_cost

secondary_cost
secondary_cost string

secondary_cost

destination_country_iso
destination_country_iso string

destination_country_iso

destination_region
destination_region string

destination_region

shipping_carrier_id
shipping_carrier_id integer

shipping_carrier_id

mail_class
mail_class string

mail_class

min_delivery_days
min_delivery_days integer

min_delivery_days

max_delivery_days
max_delivery_days integer

max_delivery_days

Retouren

Vertegenwoordigt een verzendbestemming die is toegewezen aan een verzendprofiel.

ShopShippingProfileDestination
ShopShippingProfileDestination

Een verzendprofielbestemming maken

Hiermee maakt u een nieuwe verzendbestemming, waarmee de verzendkosten, vervoerder en klasse voor een bestemming in een verzendprofiel worden ingesteld. Hiermee worden kosten toegewezen aan de hand van de valuta van de gekoppelde winkel. Stel de bestemming in met de ISO- of doelregio van het doelland; doelland ISO en doelregio sluiten elkaar wederzijds uit: stel een of de andere in. Het instellen van beide triggers fout 400. Als de aanvraag geen ISO of doelregio van het doelland instelt, is de standaardbestemming overal. U moet ook zowel een verzendprovider-id als een e-mailklasse toewijzen, of zowel minimale leveringsdagen als maximaal bezorgingsdagen.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Primaire kosten
primary_cost True float

De kosten van verzending naar dit land/regio alleen, gemeten in de standaardvaluta van de winkel.

Secundaire kosten
secondary_cost True string

De kosten van verzending naar dit land/regio met een ander item, gemeten in de standaardvaluta van het archief.

destination_country_iso
destination_country_iso string

destination_country_iso

destination_region
destination_region string

destination_region

shipping_carrier_id
shipping_carrier_id integer

shipping_carrier_id

mail_class
mail_class string

mail_class

min_delivery_days
min_delivery_days integer

min_delivery_days

max_delivery_days
max_delivery_days integer

max_delivery_days

Retouren

Vertegenwoordigt een verzendbestemming die is toegewezen aan een verzendprofiel.

ShopShippingProfileDestination
ShopShippingProfileDestination

Een verzendprofielbestemming verwijderen

Hiermee verwijdert u een verzendbestemming en verwijdert u de doeloptie uit elke vermelding die gebruikmaakt van het gekoppelde verzendprofiel. Een verzendprofiel vereist ten minste één verzendbestemming, dus dit eindpunt kan de uiteindelijke verzendbestemming voor een verzendprofiel niet verwijderen. Als u de uiteindelijke verzendbestemming uit een verzendprofiel wilt verwijderen, moet u het volledige verzendprofiel verwijderen.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Doel-id verzendprofiel
shipping_profile_destination_id True integer

De numerieke id van de bestemming van het verzendprofiel in het verzendprofiel dat is gekoppeld aan de vermelding.

Een winkel bijwerken

Werk een winkel bij. Hierbij wordt ervan uitgegaan dat alle tekenreeksparameters worden opgegeven in de primaire taal van de winkel.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Title
title string

Een korte koptekenreeks voor de hoofdpagina van de winkel.

Aankondiging
announcement string

Een aankondigingstekenreeks voor kopers die op de startpagina van de winkel worden weergegeven.

Verkoopbericht
sale_message string

Een berichttekenreeks die is verzonden naar gebruikers die een aankoop in deze winkel voltooien.

Digitaal verkoopbericht
digital_sale_message string

Een berichttekenreeks die wordt verzonden naar gebruikers die een digitaal artikel kopen in deze winkel.

Retouren

Een winkel die is gemaakt door een Gebruiker van Contoso.

Winkel
Shop

Een winkelsectie maken

Hiermee maakt u een nieuwe sectie in een specifieke winkel.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Title
title True string

De titeltekenreeks voor een winkelsectie.

Retouren

Een sectie in een winkel waarin een gebruiker vermeldingen kan sorteren.

ShopSection
ShopSection

Eigenschappen van een vermelding ophalen

Retourneert een lijst met eigenschappen van een vermelding.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Retouren

Vertegenwoordigt verschillende waarden voor het weergeven van eigenschappen.

ListingPropertyValues
ListingPropertyValues

Gebruiker ophalen

Retourneert een gebruikersprofiel voor de gebruiker die is geïdentificeerd door een gebruikers-id.

Parameters

Name Sleutel Vereist Type Description
Gebruikers-ID
user_id True integer

De unieke positieve niet-nul numerieke id voor een gebruiker.

Retouren

Vertegenwoordigt één gebruiker van de site

User
User

Gebruikersadressen ophalen

Haal een lijst met gebruikersadressen op.

Parameters

Name Sleutel Vereist Type Description
Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Retouren

Vertegenwoordigt verschillende UserAddress-records.

UserAddresses
UserAddresses

Het aanbod van een vermelding ophalen

Ontvang een aanbieding voor een aanbieding.

Parameters

Name Sleutel Vereist Type Description
Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Product-ID
product_id True integer

De numerieke id voor het product dat aan deze transactie is gekoppeld.

Productaanbiedingen-id
product_offering_id True integer

De numerieke id voor het productaanbod dat aan deze transactie is gekoppeld.

Retouren

Een weergave van een aanbieding voor een vermelding.

ListingInventoryProductOffering
ListingInventoryProductOffering

Het adres van de gebruiker ophalen

Haalt het adres van de gebruiker op. Ontwikkeling voor dit eindpunt wordt uitgevoerd. Er wordt alleen een 501-antwoord geretourneerd.

Parameters

Name Sleutel Vereist Type Description
Gebruikersadres-id
user_address_id True integer

De numerieke id van het adres van de gebruiker.

Retouren

Vertegenwoordigt het adres van een gebruiker.

UserAddress
UserAddress

Het product van een vermelding ophalen

Haal een vermeldingsproduct op id op.

Parameters

Name Sleutel Vereist Type Description
Vermeldings-id
listing_id True integer

De vermelding waarvoor u een vermeldingsproduct wilt retourneren.

Product-ID
product_id True integer

De numerieke id voor een specifiek product dat is gekocht bij een vermelding.

Retouren

Een weergave van een product voor een vermelding.

ListingInventoryProduct
ListingInventoryProduct

Ontvangstbewijzen ophalen

Vraagt de winkelbevestigingen aan van een specifieke winkel, ongefilterd of gefilterd op ontvangst-id-bereik of offset, datum, betaalde en/of verzonden aankopen.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Minimaal gemaakt
min_created integer

De vroegste UNIX-tijdstempel voor het moment waarop een record is gemaakt.

Maximum aantal gemaakt
max_created integer

De meest recente UNIX-tijdstempel voor het moment waarop een record is gemaakt.

Vroegste laatste wijziging
min_last_modified integer

De vroegste UNIX-tijdstempel voor wanneer een record voor het laatst is gewijzigd.

Laatst gewijzigd
max_last_modified integer

De meest recente UNIX-tijdstempel voor wanneer een record voor het laatst is gewijzigd.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Is betaald
was_paid boolean

Indien waar, heeft de verkoper betaling ontvangen voor de producten in dit ontvangstbewijs.

Is verzonden
was_shipped boolean

Indien waar, heeft de verkoper de producten in dit ontvangstbewijs verzonden.

Retouren

De ontvangstbewijzen voor een specifieke winkel.

ShopReceipts
ShopReceipts

Ping

Controleer of er verbinding is met de Api vanApi met een toepassing.

Retouren

Een bevestiging dat de huidige toepassing toegang heeft tot de Open API

Stank
Pong

Producteigenschappen ophalen op taxonomie-id

Hiermee wordt een lijst met producteigenschappen opgehaald, met toepasselijke schalen en waarden die worden ondersteund voor een specifieke verkopertaxonomie-id.

Parameters

Name Sleutel Vereist Type Description
Taxonomie-id
taxonomy_id True string

De unieke numerieke id van een Taxonomieknooppunt van Microsoft, een metagegevenscategorie voor vermeldingen die zijn ingedeeld in de structuur van de verkopertaxonomiehiërarchie.

Retouren

Een lijst met producteigenschapsdefinities.

TaxonomieNodeProperties
TaxonomyNodeProperties

Profielbestemmingen ophalen per verzendprofiel

Hiermee haalt u een lijst met verzendbestemmingsobjecten op die zijn gekoppeld aan een verzendprofiel.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Retouren

Vertegenwoordigt een lijst met verzendbestemmingsobjecten.

ShopShippingProfileDestinations
ShopShippingProfileDestinations

Taxonomieknooppunten van verkopers ophalen

Haalt de volledige hiërarchiestructuur van taxonomieknooppunten van verkopers op.

Retouren

Een lijst met taxonomieknooppunten uit de taxonomiestructuur van de verkoper.

VerkoperTaxonomyNodes
SellerTaxonomyNodes

Transacties van een vermelding ophalen

Haalt de lijst met transacties op die zijn gekoppeld aan een vermelding.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Retouren

Een set transactiebronnen voor winkelbevestigingen

ShopReceiptTransactions
ShopReceiptTransactions

Transporteurs ophalen

Hiermee haalt u een lijst op met beschikbare vervoerders en de e-mailklassen die eraan zijn gekoppeld voor een bepaald land.

Parameters

Name Sleutel Vereist Type Description
ISO van oorsprong
origin_country_iso True string

De ISO-code van het land van waaruit de vermelding wordt verzonden.

Retouren

Vertegenwoordigt verschillende ShippingCarriers.

ShippingCarriers
ShippingCarriers

Upgrades voor verzendprofielen ophalen

Haalt de lijst met upgrades van verzendprofielen op die zijn toegewezen aan een specifiek verzendprofiel.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Verzendprofiel-id
shipping_profile_id True integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Retouren

Een lijst met verzendupgradeopties.

ShopShippingProfileUpgrades
ShopShippingProfileUpgrades

Variatieafbeeldingen van vermeldingen ophalen

Hiermee worden alle variatieafbeeldingen op een vermelding opgehaald.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Retouren

Vertegenwoordigt verschillende variatieafbeeldingen.

ListingVariationImages
ListingVariationImages

Vermeldingen ophalen op id

Hiermee kunt u in één keer query's uitvoeren op meerdere vermeldings-id's. Maximaal 100 id's per query.

Parameters

Name Sleutel Vereist Type Description
Vermeldings-id's
listing_ids True string

De matrix van numerieke id's voor de vermeldingen in een specifieke Shop van Azure.

Includes
includes string

Een opsommingstekenreeks die een geldige koppeling koppelt.

Retouren

Een set winkelvermeldingsbronnen met verenigingen.

ShopListingsWithAssociations
ShopListingsWithAssociations

Vermeldingen ophalen op winkelsectie-id

Hiermee haalt u alle vermeldingen op uit de sectie van een specifieke winkel.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Sectie-id's van de winkel
shop_section_ids True string

Een matrix van numerieke id's voor alle secties in een specifieke Shop van Azure.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Sorteren op
sort_on string

De waarde voor het sorteren van een zoekresultaat van vermeldingen op.

Sorteervolgorde
sort_order string

De volgorde oplopend(omhoog) of aflopend(omlaag) om vermeldingen te sorteren.

Retouren

Een set winkelvermeldingsbronnen.

ShopListings
ShopListings

Vermeldingen per winkelbevestiging ophalen

Hiermee haalt u alle vermeldingen op die zijn gekoppeld aan een ontvangstbewijs.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De numerieke id voor het ontvangstbewijs dat aan deze transactie is gekoppeld.

Ontvangstbewijs-id
receipt_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Retouren

Een set winkelvermeldingsbronnen.

ShopListings
ShopListings

Vertaling van een vermelding ophalen

Retourneert de vertaling voor een vermelding in de opgegeven taal.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Vermeldings-id
listing_id True integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Language
language True string

De IETF-taaltag voor de taal van deze vertaling. Bijvoorbeeld: de, en, es, fr, it, ja, nl, pl, pt, ru.

Retouren

Vertegenwoordigt de vertaalgegevens voor een vermelding.

ListingTranslation
ListingTranslation

Verzendprofielen ophalen

Hiermee haalt u een lijst met verzendprofielen op die beschikbaar zijn in de specifieke Winkel van Resourcen die is geïdentificeerd door de winkel-id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Retouren

Vertegenwoordigt een profiel dat wordt gebruikt om de verzendgegevens van een vermelding in te stellen. Houd er rekening mee dat het niet mogelijk is om berekende verzendsjablonen te maken via de API. U kunt berekende verzendprofielen die zijn gemaakt vanuit Shop Manager echter koppelen aan vermeldingen met behulp van de API.

ShopShippingProfile
ShopShippingProfile

Winkel ophalen op eigenaar-id

Haalt de winkel op die is geïdentificeerd door de gebruikers-id van de winkeleigenaar.

Parameters

Name Sleutel Vereist Type Description
Gebruikers-ID
user_id True string

De numerieke gebruikers-id van de gebruiker die eigenaar is van deze winkel.

Retouren

Een winkel die is gemaakt door een Gebruiker van Contoso.

Winkel
Shop

Winkelsectie ophalen

Hiermee haalt u een winkelsectie op waarnaar wordt verwezen op sectie-id en winkel-id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Winkelsectie-id
shop_section_id True integer

De numerieke id van een sectie in een specifieke Shop van Azure.

Retouren

Een sectie in een winkel waarin een gebruiker vermeldingen kan sorteren.

ShopSection
ShopSection

Winkelsecties ophalen

Hiermee haalt u de lijst met winkelsecties in een specifieke winkel op die is geïdentificeerd met winkel-id.

Parameters

Name Sleutel Vereist Type Description
Winkel-id
shop_id True integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Retouren

Alle secties in een sprecific Shop.

ShopSections
ShopSections

Zoekwinkels

Retourneert een lijst met winkels met de overeenkomende naam.

Parameters

Name Sleutel Vereist Type Description
Winkelnaam
shop_name True string

De naamtekenreeks van de winkel.

Limit
limit integer

Het maximum aantal resultaten dat moet worden geretourneerd.

Offset
offset integer

Het aantal records dat moet worden overgeslagen voordat u het eerste resultaat selecteert.

Retouren

Een set shoprecords.

Winkels
Shops

Definities

ShopListing

Een vermelding van een winkel, die een producthoeveelheid, titel, beschrijving, prijs, enz. bevat.

Name Pad Type Description
Vermeldings-id
listing_id integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Gebruikers-ID
user_id integer

De numerieke id voor de gebruiker die de vermelding plaatst.

Winkel-id
shop_id integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Title
title string

De titeltekenreeks van de vermelding. Geldige titeltekenreeksen bevatten alleen letters, cijfers, leestekens, wiskundige symbolen, spaties, ™ , © en ® . (regex: /[^\p{L}\p{Nd}\p{P}\p{Sm}\p{Zs}™©®]/u) U kunt de %, :, & en + tekens slechts één keer gebruiken.

Description
description string

Een beschrijvingstekenreeks van het te koop product in de vermelding.

Staat
state State

Een geïnventareerde tekenreeks van een van de volgende: actief of inactief. Opmerking: als u een conceptvermelding instelt op actief, wordt de vermelding ook gepubliceerd op etsy.com.

Tijdstempel maken
creation_timestamp integer

De aanmaaktijd van de vermelding, in kortstondige seconden.

Eindtijdstempel
ending_timestamp integer

De verlooptijd van de vermelding, in kortstondige seconden.

Oorspronkelijke tijdstempel voor maken
original_creation_timestamp integer

De aanmaaktijd van de vermelding, in kortstondige seconden.

Laatst gewijzigd tijdstempel
last_modified_timestamp integer

De tijd van de laatste update voor de vermelding, in epoch seconden.

Tijdstempel van laatste statuswijziging
state_timestamp integer

De datum en tijd van de laatste statuswijziging van deze vermelding.

Hoeveelheid
quantity integer

Het positieve niet-nul aantal producten dat in de aanbieding kan worden gekocht. Opmerking: De lijsthoeveelheid is de som van de beschikbare aanbiedingshoeveelheden. U kunt de hoeveelheden voor afzonderlijke aanbiedingen aanvragen vanuit de Resource ListingInventory met behulp van het eindpunt voor het ophalen van de inventaris.

Winkelsectie-id
shop_section_id integer

De numerieke id van een sectie in een specifieke Shop van Azure.

Aanbevolen rangschikking
featured_rank integer

De positieve niet-nul numerieke positie in de aanbevolen vermeldingen van de winkel, waarbij rang 1 vermeldingen worden weergegeven op de meest linkse positie in aanbevolen vermelding op de startpagina van een winkel.

URL
url string

De volledige URL naar de pagina van de vermelding opOpgegeven.

Aantal gunstverleners
num_favorers integer

Het aantal gebruikers dat deze vermelding heeft gemarkeerd als favoriet.

Niet-belastbaar
non_taxable boolean

Indien waar, zijn toepasselijke winkelbelastingtarieven niet van toepassing op deze vermelding bij het afrekenen.

Is aanpasbaar
is_customizable boolean

Indien waar, kan een koper contact opnemen met de verkoper voor een aangepaste bestelling. De standaardwaarde is waar wanneer een winkel aangepaste bestellingen accepteert. Is niet van toepassing op winkels die geen aangepaste bestellingen accepteren.

Is peronalizeerbaar
is_personalizable boolean

Indien waar, kan deze vermelding worden persoonlijker. De standaardwaarde is null.

Persoonlijke instellingen zijn vereist
personalization_is_required boolean

Indien waar, is voor deze vermelding persoonlijke instellingen vereist. De standaardwaarde is null.

Maximumaantal persoonlijke tekens
personalization_char_count_max integer

Dit is een geheel getal dat de maximale lengte aangeeft voor het personalisatiebericht dat door de koper is ingevoerd.

Instructies voor persoonlijke instellingen
personalization_instructions string

Indien waar, is voor deze vermelding persoonlijke instellingen vereist. De standaardwaarde is null.

Vermeldingstype
listing_type boolean

Een geïnventareerde typetekenreeks die aangeeft of de vermelding fysiek of digitaal is gedownload.

Tags
tags array of string

Een lijst met tagtekenreeksen voor de vermelding. Geldige tagtekenreeksen bevatten alleen letters, cijfers, spaties, -, ', ™ ' , © en . ® (regex: /[^\p{L}\p{Nd}\p{Zs}\-'™©®]/u) De standaardwaarde is null.

Materials
materials array of string

Een lijst met materiaaltekenreeksen voor materialen die in het product worden gebruikt. Geldige materiaaltekenreeksen bevatten alleen letters, cijfers en spaties. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) De standaardwaarde is null.

Verzendprofiel-id
shipping_profile_id integer

De numerieke id van het verzendprofiel dat is gekoppeld aan de vermelding.

Minimale verwerkingsdagen
processing_min integer

Het minimum aantal dagen dat nodig is om deze vermelding te verwerken. De standaardwaarde is null.

Maximum aantal verwerkingsdagen
processing_max integer

Het maximum aantal dagen dat nodig is om deze vermelding te verwerken. De standaardwaarde is null.

WhoMade
who_made WhoMade

Een geïnventariseerd tekenreeks die het product heeft gemaakt. Helpt kopers de vermelding onder de Handgemaakte kop te vinden. Vereist 'is_supply' en 'when_made'.

WhenMade
when_made WhenMade

Een opsommingstekenreeks voor het tijdperk waarin de maker het product in deze vermelding heeft gemaakt. Helpt kopers de vermelding onder de Vintage kop te vinden. Vereist 'is_supply' en 'who_made'.

Product leveren
is_supply boolean

Wanneer waar, tagt u de vermelding als een leveringsproduct, anders geeft u aan dat het een voltooid product is. Hiermee kunnen kopers de vermelding vinden onder de kop Leveringen. Vereist 'who_made' en 'when_made'.

Dikte van item
item_weight double

Het numerieke gewicht van het product dat wordt gemeten in eenheden die zijn ingesteld in de gewichtseenheid van het item. De standaardwaarde is null. Indien ingesteld, moet de waarde groter zijn dan 0.

ItemWeightUnit
item_weight_unit ItemWeightUnit

Een tekenreeks die de eenheden definieert die worden gebruikt om het gewicht van het product te meten. De standaardwaarde is null.

Lengte van item
item_length double

De numerieke lengte van het product dat wordt gemeten in eenheden die zijn ingesteld in de eenheid itemdimensies. De standaardwaarde is null. Indien ingesteld, moet de waarde groter zijn dan 0.

Breedte van item
item_width double

De numerieke breedte van het product dat wordt gemeten in eenheden die zijn ingesteld in de eenheid itemdimensies. De standaardwaarde is null. Indien ingesteld, moet de waarde groter zijn dan 0.

Hoogte van item
item_height double

De numerieke lengte van het product dat wordt gemeten in eenheden die zijn ingesteld in de eenheid itemdimensies. De standaardwaarde is null. Indien ingesteld, moet de waarde groter zijn dan 0.

ItemDimensionsUnit
item_dimensions_unit ItemDimensionsUnit

Een tekenreeks die de eenheden definieert die worden gebruikt om de afmetingen van het product te meten. De standaardwaarde is null.

Is privé
is_private boolean

Indien waar, is dit een privévermelding die bedoeld is voor een specifieke koper en verborgen in de winkelweergave.

Recipient
recipient Recipient

Een opsommingstekenreeks die een persoon aangeeft voor wie dit product een geschikt cadeau zou maken. De standaardwaarde is null.

Gelegenheid
occasion Occasion

Een opsommingstekenreeks die een gelegenheid aangeeft waarvoor dit product een geschikt cadeau zou maken. De standaardwaarde is null.

Stijl
style array of string

Een matrix van stijltekenreeksen voor deze vermelding, die elk een vrije teksttekenreeks is, zoals Formal of Steampunk. Een vermelding kan maximaal twee stijlen hebben. Geldige stijltekenreeksen bevatten alleen letters, cijfers en spaties. (regex: /[^\p{L}\p{Nd}\p{Zs}]/u) De standaardwaarde is null.

Bestandsgegevens
file_data string

Een tekenreeks die de bestanden beschrijft die zijn gekoppeld aan een digitale vermelding.

Heeft variaties
has_variations boolean

Indien waar, heeft de vermelding variaties.

Moet automatisch worden verlengd
should_auto_renew boolean

Wanneer waar, wordt een vermelding verlengd voor vier maanden na onteigening. Als deze optie is ingesteld op waar wanneer eerder onwaar, etsy.com wordt de vermelding verlengd voordat deze verloopt, maar begint de verlengingsperiode immidiaat in plaats van de vervaldatum van de vermelding uit te breiden. Ongebruikte resterende tijd voor de vermelding gaat verloren. Verlengingen resulteren in kosten voor de factuur van een gebruiker.

Language
language string

De IETF-taaltag voor de standaardtaal van de vermelding. Bijvoorbeeld: de, , esen, , fr, jait, nl, pl, pt. ru

Geld
price Money

Een representatie van een bedrag.

Taxonomie-id
taxonomy_id integer

De numerieke taxonomie-id van de vermelding. De verkoper beheert taxonomie-id's voor hun winkel. Zie de verkopertaxonomie voor meer informatie.

Geld

Een representatie van een bedrag.

Name Pad Type Description
Aantal
amount integer

De hoeveelheid vertegenwoordigd door deze gegevens.

Deler
divisor integer

De deler om het bedrag weer te geven.

Valutacode
currency_code string

De ISO-valutacode voor deze gegevens.

ShopListingFile

Een bestand dat is gekoppeld aan een digitale vermelding.

Name Pad Type Description
Bestands-id weergeven
listing_file_id integer

De unieke numerieke id van een bestand dat is gekoppeld aan een digitale vermelding.

Vermeldings-id
listing_id integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Rang
rank integer

De numerieke index van de weergavevolgorde van dit bestand in de lijst, beginnend bij 1.

Bestandsnaam
filename string

De bestandsnaamtekenreeks voor een bestand dat is gekoppeld aan een digitale vermelding.

Bestanden aanpassen
filesize string

Een tekenreeks met een leesbare indeling voor de grootte van een bestand.

Grootte in bytes
size_bytes integer

Een getal dat de grootte van een bestand aangeeft, gemeten in bytes.

Bestandstype
filetype string

Een typetekenreeks die het MIME-type van een bestand aangeeft.

Tijdstempel maken
create_timestamp integer

Het unieke numerieke tijdstempel van een bestand dat is gekoppeld aan een digitale vermelding.

ShopListingFiles

Vertegenwoordigt verschillende ShopListingFiles.

Name Pad Type Description
Aantal
count integer

Het aantal ShopListingFiles dat wordt geretourneerd..

Results
results array of ShopListingFile

Een matrix van ShopListingFile-resources.

ShopListings

Een set winkelvermeldingsbronnen.

Name Pad Type Description
Aantal
count integer

Het aantal gevonden winkelvermeldingsbronnen.

Results
results array of ShopListing

De gevonden resources voor de winkelvermelding.

User

Vertegenwoordigt één gebruiker van de site

Name Pad Type Description
Gebruikers-ID
user_id integer

De numerieke id van een gebruiker. Dit nummer is ook een geldige winkel-id voor de winkel van de gebruiker.

Gebruikersnaam
login_name string

De aanmeldingsnaamtekenreeks van de gebruiker.

Primair e-mailadres
primary_email string

Een e-mailadrestekenreeks voor het primaire e-mailadres van de gebruiker.

Voornaam
first_name string

De voornaam van de gebruiker.

Achternaam
last_name string

De achternaam van de gebruiker.

Tijdstempel gemaakt
create_timestamp integer

De datum en tijd waarop de gebruiker zijn account heeft gemaakt, in kortstondige seconden.

Verwezen door gebruikers-id
referred_by_user_id integer

De numerieke id van de gebruiker die deze gebruiker heeft verwezen.

Nieuwe inventariseindpunten gebruiken
use_new_inventory_endpoints boolean

Afgeschreven Altijd waar.

Is verkoper
is_seller boolean

Waar als de gebruiker verkoper is.

Biografie
bio string

De biografie van de gebruiker.

Geslacht
gender string

Het geslacht van de gebruiker.

Geboortemaand
birth_month string

De geboortemaand van de gebruiker.

Verjaardag
birth_day string

De geboortedag van de gebruiker.

Aantal transacties kopen
transaction_buy_count integer

Het aantal transacties dat de gebruiker heeft gekocht.

Aantal verkochte transacties
transaction_sold_count integer

Het aantal transacties dat de gebruiker heeft verkocht.

Winkel

Een winkel die is gemaakt door een Gebruiker van Contoso.

Name Pad Type Description
Winkel-id
shop_id integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Gebruikers-ID
user_id integer

De numerieke gebruikers-id van de gebruiker die eigenaar is van deze winkel.

Winkelnaam
shop_name string

De naamtekenreeks van de winkel.

Aanmaakdatum
create_date integer

De datum en tijd waarop deze winkel is gemaakt, in epoch seconden.

Title
title string

Een korte koptekenreeks voor de hoofdpagina van de winkel.

Aankondiging
announcement string

Een aankondigingstekenreeks voor kopers die op de startpagina van de winkel worden weergegeven.

Valutacode
currency_code string

De ISO-code (alfabetisch) voor de valuta van de winkel. In de winkel worden standaard alle prijzen in deze valuta weergegeven.

Is op vakantie
is_vacation boolean

Indien waar, accepteert deze winkel geen aankopen.

Vakantiebericht
vacation_message string

De berichtenreeks van de winkel wordt weergegeven wanneer is_vacation waar is.

Verkoopbericht
sale_message string

Een berichttekenreeks die is verzonden naar gebruikers die een aankoop in deze winkel voltooien.

Digitaal verkoopbericht
digital_sale_message string

Een berichttekenreeks die wordt verzonden naar gebruikers die een digitaal artikel kopen in deze winkel.

Bijgewerkte datum
update_date integer

De datum en tijd van de laatste update naar de winkel, in epoch seconden.

Aantal actieve vermeldingen
listing_active_count integer

Het aantal actieve vermeldingen in de winkel.

Aantal digitale vermeldingen
digital_listing_count integer

Het aantal digitale vermeldingen in de winkel.

Gebruikersnaam
login_name string

De aanmeldingsnaamtekenreeks van de eigenaar van de winkel.

Accepteert aangepaste aanvragen
accepts_custom_requests boolean

Indien waar, accepteert de winkel aanpassingsaanvragen.

Welkomstbeleid
policy_welcome string

De welkomstreeks van het beleid van de winkel (kan leeg zijn).

Betalingsbeleid
policy_payment string

De tekenreeks van het betalingsbeleid van de winkel (kan leeg zijn).

Verzendbeleid
policy_shipping string

De tekenreeks van het verzendbeleid van de winkel (kan leeg zijn).

Restitutiebeleid
policy_refunds string

De tekenreeks voor restitutiebeleid van de winkel (kan leeg zijn).

Aanvullende beleidsregels
policy_additional string

De tekenreeks voor aanvullende beleidsregels van de winkel (mogelijk leeg).

Verkopergegevens
policy_seller_info string

De tekenreeks voor verkopergegevens van de winkel (kan leeg zijn).

Bijgewerkte datum van beleid
policy_update_date integer

De datum en tijd van de laatste update van het winkelbeleid, in kortstondige seconden.

Heeft beleid voor privébevestiging
policy_has_private_receipt_info boolean

Indien waar, geven EU-ontvangstbewijzen privégegevens weer.

Heeft niet-gestructureerd beleid
has_unstructured_policies boolean

Wanneer waar, worden in de winkel aanvullende ongestructureerde beleidsvelden weergegeven.

Privacybeleid
policy_privacy string

De tekenreeks voor het privacybeleid van de winkel (kan leeg zijn).

Vakantie automatisch
vacation_autoreply string

De automatische antwoordtekenreeks van de winkel wordt weergegeven in nieuwe gesprekken wanneer is_vacation waar is.

URL
url string

De URL-tekenreeks voor deze winkel.

URL van bannerafbeelding
image_url_760x100 string

De URL-tekenreeks voor de bannerafbeelding van deze winkel.

Aantal gunstverleners
num_favorers integer

Het aantal gebruikers dat deze winkel als favoriet heeft gemarkeerd.

Languages
languages array of string

Een lijst met taaltekenreeksen voor de geregistreerde talen van de winkel.

Afbeeldings-URL van pictogram
icon_url_fullxfull string

De URL-tekenreeks voor de afbeelding van het pictogram van deze winkel.

Gebruikt gestructureerd beleid
is_using_structured_policies boolean

Indien waar, heeft de winkel geaccepteerd met behulp van gestructureerd beleid.

Heeft gestructureerd beleid voor onboarding
has_onboarded_structured_policies boolean

Indien waar, heeft de winkel de onboarding van gestructureerd beleid geaccepteerd of geweigerd.

Koppeling geschilformulier opnemen
include_dispute_form_link boolean

Indien waar, bevatten de beleidsregels van deze winkel een koppeling naar een onlinegeschillenformulier van de EU.

Is direct afrekenen onboarded
is_direct_checkout_onboarded boolean

Wanneer waar, heeft de winkel onboarding uitgevoerd op Azure Payments.

Komt in aanmerking voor berekende verzending
is_calculated_eligible boolean

Indien waar, is de winkel leesbaar voor berekende verzendprofielen. (Alleen beschikbaar in de VS en Canada)

Is aangemeld bij Koper Promise
is_opted_in_to_buyer_promise boolean

Indien waar, heeft de winkel zich aangemeld bij koper belooft.

Is gebaseerd op de VS
is_shop_us_based boolean

Wanneer waar, is de winkel gevestigd in de VS.

Aantal verkooptransacties
transaction_sold_count integer

Het totale aantal verkooptransacties voor deze winkel

Verzending vanaf land ISO
shipping_from_country_iso string

Het land iso de winkel is verzending van.

Winkellocatie ISO
shop_location_country_iso string

Het land iso waar de winkel zich bevindt.

Aantal beoordelingen
review_count integer

Aantal beoordelingen van winkelvermeldingen in het afgelopen jaar.

Gemiddelde controleren
review_average double

Gemiddelde waardering op basis van beoordelingen van winkelvermeldingen in het afgelopen jaar.

ListingImage

Naslag-URL's en metagegevens voor een afbeelding die is gekoppeld aan een specifieke vermelding. De url_fullxfull parameter bevat de URL voor een binair afbeeldingsbestand met volledige grootte.

Name Pad Type Description
Vermeldings-id
listing_id integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Afbeeldings-id weergeven
listing_image_id integer

De numerieke id van de primaire afbeelding van de vermelding voor deze transactie.

Hexcode
hex_code string

De webhextekenreeks voor de gemiddelde kleur van de afbeelding, in de webhex-notatie.

Rode waarde
red integer

De numerieke rode waarde is gelijk aan de gemiddelde rode waarde van de afbeelding, van 0-255 (RGB-kleur).

Groene waarde
green integer

De numerieke rode waarde is gelijk aan de gemiddelde rode waarde van de afbeelding, van 0-255 (RGB-kleur).

Blauwe waarde
blue integer

De numerieke rode waarde is gelijk aan de gemiddelde rode waarde van de afbeelding, van 0-255 (RGB-kleur).

Hue-waarde
hue integer

De numerieke tint is gelijk aan de gemiddelde tint van de afbeelding, van 0-360 (HSV-kleur).

Verzadigingswaarde
saturation integer

De numerieke verzadiging is gelijk aan de gemiddelde verzadiging van de afbeelding, van 0-100 (HSV-kleur).

Helderheidswaarde
brightness integer

De numerieke helderheid is gelijk aan de gemiddelde helderheid van de afbeelding, van 0-100 (HSV-kleur).

Is zwart-wit
is_black_and_white boolean

Wanneer waar, is de afbeelding zwart en wit.

Aanmaaktijd
creation_tsz integer

De aanmaaktijd van de afbeelding in kortstondige seconden.

Rang
rank integer

De positieve niet-nul numerieke positie in de afbeeldingen die worden weergegeven in een lijst, waarbij rang 1 afbeeldingen worden weergegeven op de meest linkse positie in een lijst.

Afbeeldings-URL van 75x75
url_75x75 string

De URL-tekenreeks voor een miniatuur van 75 x 75 pixels van de afbeelding.

170x135 Afbeeldings-URL
url_170x135 string

De URL-tekenreeks voor een miniatuur van 170 x 135 pixels van de afbeelding.

Afbeeldings-URL van 570xN
url_570xN string

De URL-tekenreeks voor een miniatuur van de afbeelding, niet meer dan 570 pixels breed met variabele hoogte.

Afbeeldings-URL op volledige grootte
url_fullxfull string

De URL-tekenreeks voor de afbeelding op volledige grootte, tot 3000 pixels in elke dimensie.

Afbeeldingshoogte op volledige grootte
full_height integer

De numerieke hoogte, gemeten in pixels, van de afbeelding op volledige grootte waarnaar wordt verwezen in url_fullxfull.

Breedte van volledige afbeelding
full_width integer

De numerieke breedte, gemeten in pixels, van de afbeelding op volledige grootte waarnaar in url_fullxfull wordt verwezen.

ListingImages

Vertegenwoordigt een lijst met afbeeldingsbronnen, die elk de referentie-URL's en metagegevens voor een afbeelding bevatten.

Name Pad Type Description
Aantal
count integer

Het aantal resultaten.

Results
results array of ListingImage

De lijst met aangevraagde resources.

ListingInventoryWithAssociations

Een weergave van de inventarisrecord van één vermelding met koppelingen

Name Pad Type Description
Products
products array of ListingInventoryProduct

Een JSON-matrix met producten die beschikbaar zijn in een vermelding, zelfs als er slechts één product is. Alle veldnamen in de JSON-blobs zijn kleine letters.

Prijs op eigenschappen
price_on_property array of integer

Een matrix met unieke eigenschaps-id's voor de eigenschappen die productprijzen wijzigen, indien van toepassing. Als u bijvoorbeeld specifieke prijzen voor producten van verschillende grootten in dezelfde lijst in rekening brengt, bevat deze matrix de eigenschaps-id voor de grootte.

Aantal op eigenschappen
quantity_on_property array of integer

Een matrix van unieke eigenschaps-id's voor de eigenschappen die de hoeveelheid van de producten wijzigen, indien van toepassing. Als u bijvoorbeeld specifieke hoeveelheden verschillende gekleurde producten in dezelfde lijst op voorraad hebt, bevat deze matrix de eigenschaps-id voor kleur.

SKU op eigenschappen
sku_on_property array of integer

Een matrix van unieke eigenschaps-id's voor de eigenschappen die de product-SKU wijzigen, indien van toepassing. Als u bijvoorbeeld specifieke SKU's gebruikt voor verschillende gekleurde producten in dezelfde lijst, bevat deze matrix de eigenschaps-id voor kleur.

ShopListing
listing ShopListing

Een vermelding van een winkel, die een producthoeveelheid, titel, beschrijving, prijs, enz. bevat.

ListingInventoryProduct

Een weergave van een product voor een vermelding.

Name Pad Type Description
Product-ID
product_id integer

De numerieke id voor een specifiek product dat is gekocht bij een vermelding.

Artikelnummer (SKU)
sku string

De SKU-tekenreeks voor het product

Wordt verwijderd
is_deleted boolean

Wanneer waar, heeft iemand dit product verwijderd.

Offerings
offerings array of ListingInventoryProductOffering

Een lijst met productaanbiedingen voor dit product.

Eigenschapswaarden
property_values array of ListingPropertyValue

Een lijst met eigenschapswaardevermeldingen voor dit product.

ListingInventoryProductOffering

Een weergave van een aanbieding voor een vermelding.

Name Pad Type Description
Aanbiedings-id
offering_id integer

De id voor het productaanbod

Hoeveelheid
quantity integer

De hoeveelheid van het productaanbod

Is ingeschakeld
is_enabled boolean

Of het aanbod al dan niet aan kopers kan worden getoond.

Wordt verwijderd
is_deleted boolean

Of de aanbieding al dan niet is verwijderd.

Geld
price Money

Een representatie van een bedrag.

ListingPropertyValue

Een weergave van gestructureerde gegevenswaarden.

Name Pad Type Description
Eigenschaps-id
property_id integer

De numerieke id van de eigenschap.

Naam
property_name string

De naam van de eigenschap.

Schaal-id
scale_id integer

De numerieke id van de schaal (indien van toepassing).

Schaalnaam
scale_name string

Het label dat wordt gebruikt om de gekozen schaal te beschrijven (indien van toepassing).

Waarde-id's
value_ids array of integer

De numerieke id's van de eigenschapswaarden

Waarden
values array of string

De eigenschapswaarden

ListingInventory

Een weergave van de voorraadrecord van één vermelding.

Name Pad Type Description
Products
products array of ListingInventoryProduct

Een JSON-matrix met producten die beschikbaar zijn in een vermelding, zelfs als er slechts één product is. Alle veldnamen in de JSON-blobs zijn kleine letters.

Prijs op eigenschappen
price_on_property array of integer

Een matrix met unieke eigenschaps-id's voor de eigenschappen die productprijzen wijzigen, indien van toepassing. Als u bijvoorbeeld specifieke prijzen voor producten van verschillende grootten in dezelfde lijst in rekening brengt, bevat deze matrix de eigenschaps-id voor de grootte.

Aantal op eigenschappen
quantity_on_property array of integer

Een matrix van unieke eigenschaps-id's voor de eigenschappen die de hoeveelheid van de producten wijzigen, indien van toepassing. Als u bijvoorbeeld specifieke hoeveelheden verschillende gekleurde producten in dezelfde lijst op voorraad hebt, bevat deze matrix de eigenschaps-id voor kleur.

SKU op eigenschappen
sku_on_property array of integer

Een matrix van unieke eigenschaps-id's voor de eigenschappen die de product-SKU wijzigen, indien van toepassing. Als u bijvoorbeeld specifieke SKU's gebruikt voor verschillende gekleurde producten in dezelfde lijst, bevat deze matrix de eigenschaps-id voor kleur.

ShopListingsWithAssociations

Een set winkelvermeldingsbronnen met verenigingen.

Name Pad Type Description
Aantal
count integer

Het aantal gevonden winkelvermeldingsbronnen.

Results
results array of ShopListing

De gevonden resources voor de winkelvermelding.

ListingPropertyValues

Vertegenwoordigt verschillende waarden voor het weergeven van eigenschappen.

Name Pad Type Description
Aantal
count integer

Het aantal gevonden winkelvermeldingsbronnen.

Results
results array of ListingPropertyValue

De gevonden resources voor de winkelvermelding.

ShopReceiptTransactions

Een set transactiebronnen voor winkelbevestigingen

Name Pad Type Description
Aantal
count integer

Het aantal gevonden transactiebronnen voor winkelbevestigingen.

Results
results array of ShopReceiptTransaction

De transactiebronnen voor winkelbevestigingen gevonden.

ShopReceiptTransaction

Een transactieobject dat is gekoppeld aan een winkelbevestiging. Hiermee wordt één transactie per aanbieding gegenereerd die is gekocht zoals vastgelegd op de ontvangstbevestiging van de bestelling.

Name Pad Type Description
Transactie-id
transaction_id integer

De unieke numerieke id voor een transactie.

Title
title string

De titeltekenreeks van de vermelding die in deze transactie is gekocht.

Description
description string

De beschrijvingstekenreeks van de vermelding die in deze transactie is gekocht.

Verkoper-gebruikers-id
seller_user_id integer

De numerieke gebruikers-id voor de verkoper in deze transactie.

Gebruikers-id van koper
buyer_user_id integer

De numerieke gebruikers-id voor de koper in deze transactie.

Tijdstempel gemaakt
create_timestamp integer

De aanmaakdatum en -tijd van de transactie, in kortstondige seconden.

Betaalde tijdstempel
paid_timestamp integer

De betaalde datum en tijd van de transactie, in kortstondige seconden.

Verzonden tijdstempel
shipped_timestamp integer

De verzenddatum en -tijd van de transactie, in kortstondige seconden.

Hoeveelheid
quantity integer

De numerieke hoeveelheid producten die in deze transactie zijn gekocht.

Afbeeldings-id weergeven
listing_image_id integer

De numerieke id van de primaire afbeelding van de vermelding voor deze transactie.

Ontvangstbewijs-id
receipt_id integer

De numerieke id voor het ontvangstbewijs dat aan deze transactie is gekoppeld.

Is digitaal
is_digital boolean

Wanneer waar, heeft de transactie de aankoop van een digitale vermelding geregistreerd.

Bestandsgegevens
file_data string

Een tekenreeks die de bestanden beschrijft die in deze transactie zijn gekocht.

Vermeldings-id
listing_id integer

De numerieke id voor de vermelding die aan deze transactie is gekoppeld.

Transactietype
transaction_type string

De typetekenreeks voor de transactie, meestal een vermelding

Product-ID
product_id integer

De numerieke id voor een specifiek product dat is gekocht bij een vermelding.

Geld
price Money

Een representatie van een bedrag.

Geld
shipping_cost Money

Een representatie van een bedrag.

ListingTranslation

Vertegenwoordigt de vertaalgegevens voor een vermelding.

Name Pad Type Description
Vermeldings-id
listing_id integer

De numerieke id voor de vermelding.

Language
language string

De IETF-taaltag (bijvoorbeeld 'fr') voor de taal van deze vertaling.

Title
title string

De titel van de vermelding van deze vertaling.

Description
description string

De beschrijving van de vermelding van deze vertaling.

Tags
tags array of string

De tags van de vermelding van deze vertaling.

ListingVariationImages

Vertegenwoordigt verschillende variatieafbeeldingen.

Name Pad Type Description
Aantal
count integer

Het aantal variatieafbeeldingen.

Results
results array of ListingVariationImage

De resultaten van de variatieafbeeldingen.

ListingVariationImage

Een weergave van de associaties van variaties en afbeeldingen in een lijst.

Name Pad Type Description
Eigenschaps-id
property_id integer

De numerieke id van de eigenschap.

Waarde-id
value_id integer

De numerieke id van de waarde.

Afbeeldings-id
image_id integer

De numerieke id van de afbeelding.

PaymentAccountLedgerEntries

Een set vermeldingsbronnen voor grootboek van betaalrekening

Name Pad Type Description
Aantal
count integer

Het aantal vermeldingen van het grootboek van de betaalrekening.

Results
results array of PaymentAccountLedgerEntry

De inzendingsmiddelen van het grootboek van het betalingsaccount zijn gevonden.

PaymentAccountLedgerEntry

Vertegenwoordigt een vermelding in het grootboek van een winkel.

Name Pad Type Description
Vermeldings-id
entry_id integer

De numerieke id van het grootboekitem.

Grootboek-id
ledger_id integer

De numerieke id van het grootboek.

Volgnummer
sequence_number integer

Met de reeks kunnen grootboekvermeldingen chronologisch worden gesorteerd. Hoe hoger de reeks, hoe recenter de vermelding.

Aantal
amount integer

Het bedrag dat aan het grootboek is gecrediteerd.

Valuta
currency string

De valuta van de vermelding op het grootboek.

Description
description string

Details van wat voor soort grootboekvermelding dit is: een betaling, terugbetaling, omkering van een mislukte terugbetaling, uitbetaling, geretourneerde uitbetaling, hercoupment, diverse krediet, diverse debit- of factuurbetaling.

Saldo
balance integer

Het bedrag van het geld in het grootboek van de winkel het moment nadat deze vermelding is toegepast.

Aanmaakdatum
create_date integer

De datum en tijd waarop de grootboekvermelding is gemaakt in Epoch seconds..

Payments

Vertegenwoordigt verschillende betalingen die zijn gedaan met De betalingen van Microsoft. Alle monetaire bedragen zijn in USD pennies tenzij anders opgegeven.

Name Pad Type Description
Aantal
count integer

Het aantal betalingen in het antwoord.

Results
results array of Payment

Een lijst met betalingen.

Betaling

Vertegenwoordigt een betaling die is gedaan met De betalingen van Microsoft. Alle monetaire bedragen zijn in USD pennies tenzij anders opgegeven.

Name Pad Type Description
BetalingsID
payment_id integer

Een unieke numerieke id voor een betaling aan een specifieke Shop vanOpgegeven.

Gebruikers-id van koper
buyer_user_id integer

De numerieke id voor de gebruiker die de aankoop heeft betaald.

Winkel-id
shop_id integer

De unieke positieve niet-nul numerieke id voor een Shop van Microsoft.

Ontvangstbewijs-id
receipt_id integer

De numerieke id voor het ontvangstbewijs dat aan deze transactie is gekoppeld.

Geld
amount_gross Money

Een representatie van een bedrag.

Geld
amount_fees Money

Een representatie van een bedrag.

Geld
amount_net Money

Een representatie van een bedrag.

Geld
posted_gross Money

Een representatie van een bedrag.

Geld
posted_fees Money

Een representatie van een bedrag.

Geld
posted_net Money

Een representatie van een bedrag.

Geld
adjusted_gross Money

Een representatie van een bedrag.

Geld
adjusted_fees Money

Een representatie van een bedrag.

Geld
adjusted_net Money

Een representatie van een bedrag.

Valuta
currency string

De ISO-codetekenreeks (alfabetisch) voor de valuta van de betaling.

Winkelvaluta
shop_currency string

De ISO-code (alfabetisch) voor de valuta van de winkel. In de winkel worden standaard alle prijzen in deze valuta weergegeven.

Valuta koper
buyer_currency string

De valutareeks van de koper.

Verzend-id van gebruiker
shipping_user_id integer

De numerieke id van de gebruiker waarnaar de verkoper de bestelling verzendt.

Verzendadres-id
shipping_address_id integer

De numerieke id waarmee het verzendadres wordt geïdentificeerd.

Factureringsadres-id
billing_address_id integer

De numerieke id waarmee het factuuradres van de koper wordt geïdentificeerd.

Toestand
status string

Een tekenreeks die de huidige status van de betaling aangeeft, meestal geregeld of geverifieerd.

Verzonden tijdstempel
shipped_timestamp integer

De verzenddatum en -tijd van de transactie, in kortstondige seconden.

Tijdstempel gemaakt
create_timestamp integer

De aanmaakdatum en -tijd van de transactie, in kortstondige seconden.

Tijdstempel bijwerken
update_timestamp integer

De datum en tijd van de laatste wijziging in de betalingsaanpassing in epoch seconden.

Betalingsaanpassingen
payment_adjustments array of PaymentAdjustment

Lijst met terugbetalingsobjecten op een Transaction in Azure Payments. Alle monetaire bedragen zijn in USD pennies tenzij anders opgegeven.

PaymentAdjustment

Vertegenwoordigt een restitutie, die van toepassing is op een eerdere Betaling van Microsoft. Alle monetaire bedragen zijn in USD pennies tenzij anders opgegeven.

Name Pad Type Description
Betalingsaanpassings-id
payment_adjustment_id integer

De numerieke id voor een betalingsaanpassing.

BetalingsID
payment_id integer

Een unieke numerieke id voor een betaling aan een specifieke Shop vanOpgegeven.

Toestand
status string

De statustekenreeks van de betalingsaanpassing.

Is geslaagd
is_success boolean

Wanneer waar, is de betalingsaanpassing wel of waarschijnlijk voltooid.

Gebruikers-ID
user_id integer

De numerieke id voor de gebruiker (verkoper) die aan de aankoop voldoet.

Redencode
reason_code string

Een door mensen leesbare tekenreeks die de reden voor de restitutie beschrijft.

Totale aanpassingsbedrag
total_adjustment_amount integer

Het totale numerieke bedrag van de restitutie in de betalingsvaluta.

Totale aanpassingsbedrag van winkel
shop_total_adjustment_amount integer

Het numerieke bedrag van de restitutie in de winkelvaluta.

Totale aanpassingsbedrag
buyer_total_adjustment_amount integer

Het numerieke bedrag van de restitutie in de kopervaluta.

Totaal bedrag voor correctie van kosten
total_fee_adjustment_amount integer

Het numerieke bedrag aan kaartverwerkingskosten dat is gekoppeld aan een betalingsaanpassing.

Tijdstempel gemaakt
create_timestamp integer

De aanmaakdatum en -tijd van de transactie, in kortstondige seconden.

Tijdstempel bijwerken
update_timestamp integer

De datum en tijd van de laatste wijziging in de betalingsaanpassing in epoch seconden.

Stank

Een bevestiging dat de huidige toepassing toegang heeft tot de Open API

Name Pad Type Description
Applicatie-ID
application_id integer

De id van de geverifieerde toepassing

ShopReceipt

Het record van een aankoop in een winkel. Winkelbevestigingen geven monetaire waarden weer met behulp van de valuta van de winkel.

Name Pad Type Description
Ontvangstbewijs-id
receipt_id integer

De numerieke id voor het ontvangstbewijs dat aan deze transactie is gekoppeld.

Ontvangstbewijstype
receipt_type integer

De numerieke waarde voor het Channel Van Azure die de aankoop heeft verwerkt: 0 voor Etsy.com, 1 voor een Patroonwinkel.

Verkoper-gebruikers-id
seller_user_id integer

De numerieke id voor de gebruiker (verkoper) die aan de aankoop voldoet.

E-mailadres van verkoper
seller_email string

De e-mailadrestekenreeks voor de verkoper van de aanbieding.

Gebruikers-id van koper
buyer_user_id integer

De numerieke id voor de gebruiker die de aankoop maakt.

E-mailadres van koper
buyer_email string

De tekenreeks voor het e-mailadres voor de koper van de aanbieding.

Naam
name string

De naamtekenreeks voor de ontvanger in het verzendadres.

Eerste adresregel
first_line string

De eerste adresregeltekenreeks voor de geadresseerde in het verzendadres.

Tweede adresregel
second_line string

De optionele tweede adresregeltekenreeks voor de geadresseerde in het verzendadres.

City
city string

De plaatstekenreeks voor de ontvanger in het verzendadres.

Staat
state string

De statustekenreeks voor de ontvanger in het verzendadres.

Postcode
zip string

De postcodetekenreeks (niet noodzakelijkerwijs een getal) voor de ontvanger in het verzendadres.

Opgemaakt adres
formatted_address string

De opgemaakte verzendadrestekenreeks voor de ontvanger in het verzendadres.

ISO van landcode
country_iso string

De iso-3166 alfa-2-landcodetekenreeks voor de ontvanger in het verzendadres.

Betalingsmethode
payment_method string

De betalingswijzetekenreeks die de betalingswijze van de koper identificeert, dit moet een van de volgende zijn: 'cc' (creditcard), 'PayPal', 'check', 'mo' (money order), 'bt' (bankoverschrijving), 'other', 'ideal', 'sofort', 'apple_pay', 'google', 'android_pay', 'google_pay', 'klarna', 'k_pay_in_4' (klarna) of 'k_financing' (klarna).

E-mailadres van betaling
payment_email string

De e-mailadrestekenreeks voor het e-mailadres waarnaar u betalingsbevestiging wilt verzenden

Bericht van verkoper
message_from_seller string

Een optionele berichttekenreeks van de verkoper.

Bericht van koper
message_from_buyer string

Een optionele berichttekenreeks van de koper.

Bericht van betalingssysteem
message_from_payment string

De door de machine gegenereerde bevestigingstekenreeks van het betalingssysteem.

Wordt betaald
is_paid boolean

Wanneer waar, betaalde koper voor deze aankoop.

Wordt verzonden
is_shipped boolean

Indien waar, heeft de verkoper de producten verzonden.

Tijdstempel gemaakt
create_timestamp integer

De aanmaaktijd van het ontvangstbewijs, in kortstondige seconden.

Tijdstempel bijwerken
update_timestamp integer

De tijd van de laatste update naar het ontvangstbewijs, in kortstondige seconden.

Cadeaubericht
gift_message string

Een cadeauberichtreeks die de koper aanvraagt geleverd bij het product.

Geld
grandtotal Money

Een representatie van een bedrag.

Geld
subtotal Money

Een representatie van een bedrag.

Geld
total_price Money

Een representatie van een bedrag.

Geld
total_shipping_cost Money

Een representatie van een bedrag.

Geld
total_tax_cost Money

Een representatie van een bedrag.

Geld
total_vat_cost Money

Een representatie van een bedrag.

Geld
discount_amt Money

Een representatie van een bedrag.

Geld
gift_wrap_price Money

Een representatie van een bedrag.

Zendingen
shipments array of ShopReceiptShipment

Een lijst met verzendinstructies voor dit ontvangstbewijs.

ShopReceiptShipment

De record van één verzendingsevenement voor een ShopReceipt. Een ontvangstbewijs kan veel ShopReceiptShipment-records bevatten.

Name Pad Type Description
Verzend-id voor ontvangstbevestiging
receipt_shipping_id integer

De unieke numerieke id van een record voor het verzenden van een winkelbevestiging.

Tijdstempel voor verzendingsmeldingen
shipment_notification_timestamp integer

Het tijdstip waarop Hiermee de koper van het verzendingsevenement in kortstondige seconden op de hoogte werd gesteld.

Naam van provider
carrier_name string

De naamtekenreeks voor de vervoerder/het bedrijf die verantwoordelijk is voor het leveren van de zending.

Traceringscode
tracking_code string

De traceringscodetekenreeks die door de vervoerder/het bedrijf voor de verzending wordt geleverd.

ShopReceipts

De ontvangstbewijzen voor een specifieke winkel.

Name Pad Type Description
Aantal
count integer

Het aantal winkelbevestigingen gevonden.

Results
results array of ShopReceipt

Lijst met resources voor winkelbevestiging gevonden, met alle velden Winkelbevestiging voor elke resource.

TransactionReviews

Een set transactiebeoordelingsrecords die door gebruikers zijn overgelaten.

Name Pad Type Description
Aantal
count integer

Het aantal Gevonden TransactionReview-resources.

Results
results array of TransactionReview

De TransactionReview-resources gevonden.

TransactionReview

Een transactiebeoordelingsrecord die door een gebruiker is achtergelaten.

Name Pad Type Description
Winkel-id
shop_id integer

De numerieke id van de winkel.

Vermeldings-id
listing_id integer

De id van de winkelvermelding waartoe TransactionReview behoort.

Gebruikers-id van koper
buyer_user_id integer

De numerieke id van de gebruiker die de koper in deze transactie was. Opmerking: Dit veld kan afwezig zijn, afhankelijk van de privacyinstellingen van de koper.

Beoordeling
rating integer

Beoordelingswaarde op schaal van 1 tot 5

Bericht controleren
review string

Een bericht dat door de auteur is achtergelaten, waarin de feedback wordt uitgelegd.

Language
language string

De taal van transactionreview

Afbeeldings-URL fullsize
image_url_fullxfull string

De URL naar een foto die wordt geleverd met de feedback, dimensies fullxfull. Opmerking: Dit veld kan afwezig zijn, afhankelijk van de privacyinstellingen van de koper.

Tijdstempel gemaakt
create_timestamp integer

De datum en tijd waarop transactionReview is gemaakt in kortstondige seconden.

Tijdstempel bijwerken
update_timestamp integer

De datum en tijd waarop transactionReview is bijgewerkt in kortstondige seconden.

VerkoperTaxonomyNodes

Een lijst met taxonomieknooppunten uit de taxonomiestructuur van de verkoper.

Name Pad Type Description
Aantal
count integer

Het aantal resultaten.

Results
results array of SellerTaxonomyNode

De lijst met aangevraagde resources.

VerkoperTaxonomyNode

Een taxonomieknooppunt in de taxonomiestructuur van de verkoper.

Name Pad Type Description
ID-kaart
id integer

De unieke numerieke id van een Taxonomieknooppunt van Microsoft, een metagegevenscategorie voor vermeldingen die zijn ingedeeld in de structuur van de verkopertaxonomiehiërarchie. Het knooppunt voor de schoenentaxonomie (id: 1429, niveau: 1) is bijvoorbeeld hoger in de hiërarchie dan meisjesschoenen (id: 1440, niveau: 2). De taxonomieknooppunten die zijn toegewezen aan een vermelding bieden ondersteuning voor toegang tot specifieke gestandaardiseerde productschalen en eigenschappen. Vermeldingen waaraan bijvoorbeeld de taxonomieknooppuntenschoenen of meisjesschoenen zijn toegewezen, ondersteunen toegang tot de schaal van de EU-schoenmaat met de bijbehorende eigenschapsnamen en id's voor EU-schoenformaten, zoals eigenschap value_id:1394 en name:38.

Level
level integer

De gehele diepte van dit taxonomieknooppunt in de structuur van de verkopertaxonomie, met wortels op niveau 0.

Naam
name string

De naamtekenreeks voor dit taxonomieknooppunt.

Bovenliggende id
parent_id integer

De numerieke taxonomie-id van het bovenliggende knooppunt.

Children
children array of SellerTaxonomyNode

Een matrix van taxonomieknooppunten voor alle directe onderliggende elementen van dit taxonomieknooppunt in de taxanomiestructuur van de verkoper.

Taxonomiepad-id's
full_path_taxonomy_ids array of integer

Een matrix met taxonomie-id's, waaronder dit knooppunt en alle directe bovenliggende items in de verkopertaxonomiestructuur tot een hoofdknooppunt. Ze worden weergegeven in volgorde van wortel tot blad.

TaxonomieNodeProperties

Een lijst met producteigenschapsdefinities.

Name Pad Type Description
Aantal
count integer

Het aantal resultaten.

Results
results array of TaxonomyNodeProperty

De lijst met aangevraagde resources.

TaxonomyNodeProperty

Een producteigenschapsdefinitie.

Name Pad Type Description
Eigenschaps-id
property_id integer

De unieke numerieke id van deze producteigenschap.

Naam
name string

De naamtekenreeks voor dit taxonomieknooppunt.

Weergavenaam
display_name string

De tekenreeks voor de naam van de producteigenschap die door mensen kan worden gelezen.

Weegschaal
scales array of TaxonomyPropertyScale

Een lijst met beschikbare schalen.

Is vereist
is_required boolean

Wanneer waar, vereisen vermeldingen toegewezen in aanmerking komende taxonomie-id's deze eigenschap.

Ondersteunt kenmerken
supports_attributes boolean

Wanneer waar, kunt u deze eigenschap gebruiken in vermeldingskenmerken.

Ondersteunt variaties
supports_variations boolean

Wanneer waar, kunt u deze eigenschap gebruiken bij het weergeven van variaties.

Is Multivalued
is_multivalued boolean

Wanneer waar, kunt u meerdere eigenschapswaarden toewijzen aan deze eigenschap

Mogelijke waarden
possible_values array of TaxonomyPropertyValue

Een lijst met ondersteunde tekenreeksen voor eigenschapswaarden voor deze eigenschap.

Geselecteerde waarden
selected_values array of TaxonomyPropertyValue

Een lijst met tekenreeksen met eigenschapswaarden wordt automatisch en altijd geselecteerd voor de opgegeven eigenschap.

TaxonomyPropertyScale

Een schaal die de toewijsbare stappen voor de eigenschapswaarden weergeeft die beschikbaar zijn voor specifieke producteigenschappen.

Name Pad Type Description
Schaal-id
scale_id integer

De unieke numerieke id van een schaal.

Weergavenaam
display_name string

De naamtekenreeks voor een schaal.

Description
description string

De beschrijvingstekenreeks voor een schaal.

TaxonomyPropertyValue

Een eigenschapswaarde voor een specifieke producteigenschap, die ook een specifieke schaal kan gebruiken.

Name Pad Type Description
Waarde-id
value_id integer

De numerieke id van deze eigenschapswaarde.

Naam
name string

De naamtekenreeks van deze eigenschapswaarde.

Schaal-id
scale_id integer

De numerieke schaal-id van de schaal waartoe deze eigenschapswaarde behoort.

Gelijk aan
equal_to array of integer

Een lijst met numerieke eigenschapswaarde-id's is gelijk aan (indien van toepassing).

ShippingCarriers

Vertegenwoordigt verschillende ShippingCarriers.

Name Pad Type Description
count
count integer
results
results array of ShippingCarrier

ShippingCarrier

Een ondersteunde vervoerder, die wordt gebruikt voor het berekenen van een geschatte leveringsdatum.

Name Pad Type Description
Vervoerder-id
shipping_carrier_id integer

De numerieke id van deze vervoerder.

Naam
name string

De naam van deze vervoerder.

Binnenlandse klassen
domestic_classes array of ShippingCarrierMailClass

Set binnenlandse e-mailklassen van deze vervoerder.

Internationale klassen
international_classes array of ShippingCarrierMailClass

Reeks internationale postklassen van deze vervoerder.

ShippingCarrierMailClass

De e-mailklasse van een vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

Name Pad Type Description
E-mailklasse-id
mail_class_key string

De unieke id van deze e-mailklasse.

Naam
name string

De naam van deze e-mailklasse.

Winkels

Een set shoprecords.

Name Pad Type Description
Aantal
count integer

Het totale aantal winkels

Results
results array of Shop

De winkelbronnen.

ShopSection

Een sectie in een winkel waarin een gebruiker vermeldingen kan sorteren.

Name Pad Type Description
Winkelsectie-id
shop_section_id integer

De numerieke id van een sectie in een specifieke Shop van Azure.

Title
title string

De titeltekenreeks voor een winkelsectie.

Rang
rank integer

De positieve niet-nul numerieke positie van deze sectie in de sectieweergavevolgorde voor een winkel, waarbij eerst rang 1 secties wordt weergegeven.

Gebruikers-ID
user_id integer

De numerieke id van de gebruiker die eigenaar is van deze winkelsectie.

Aantal actieve vermeldingen
active_listing_count integer

Het aantal actieve vermeldingen in één sectie van een specifieke Shop van Microsoft.

ShopSections

Alle secties in een sprecific Shop.

Name Pad Type Description
Aantal
count integer

Het aantal resultaten.

Results
results array of ShopSection

De lijst met aangevraagde resources.

ShopShippingProfile

Vertegenwoordigt een profiel dat wordt gebruikt om de verzendgegevens van een vermelding in te stellen. Houd er rekening mee dat het niet mogelijk is om berekende verzendsjablonen te maken via de API. U kunt berekende verzendprofielen die zijn gemaakt vanuit Shop Manager echter koppelen aan vermeldingen met behulp van de API.

Name Pad Type Description
Verzendprofiel-id
shipping_profile_id integer

De numerieke id van het verzendprofiel.

Title
title string

De naamtekenreeks van dit verzendprofiel.

Gebruikers-ID
user_id integer

De numerieke id voor de gebruiker die eigenaar is van het verzendprofiel.

Minimale verwerkingsdagen
min_processing_days integer

Het minimum aantal dagen voor het verwerken van de vermelding.

Maximum aantal verwerkingsdagen
max_processing_days integer

Het maximum aantal dagen voor het verwerken van de vermelding.

Label voor verwerkingsdagen
processing_days_display_label string

Vertaalde tekenreeks voor weergavelabels voor het verwerken van dagen.

ISO van oorsprong
origin_country_iso string

De ISO-code van het land van waaruit de vermelding wordt verzonden.

Wordt verwijderd
is_deleted boolean

Wanneer waar, heeft iemand dit verzendprofiel verwijderd.

Verzendprofielbestemmingen
shipping_profile_destinations array of ShopShippingProfileDestination

Een lijst met verzendprofielbestemmingen die beschikbaar zijn voor dit verzendprofiel.

Upgrades voor verzendprofielen
shipping_profile_upgrades array of ShopShippingProfileUpgrade

Een lijst met upgrades voor verzendprofielen die beschikbaar zijn voor dit verzendprofiel.

Postcode van oorsprong
origin_postal_code string

De postcodetekenreeks (niet noodzakelijkerwijs een getal) voor de locatie van waaruit de vermelding wordt verzonden.

Profieltype
profile_type ProfileType

ShopShippingProfileDestination

Vertegenwoordigt een verzendbestemming die is toegewezen aan een verzendprofiel.

Name Pad Type Description
Doel-id verzendprofiel
shipping_profile_destination_id integer

De numerieke id van de bestemming van het verzendprofiel in het verzendprofiel dat is gekoppeld aan de vermelding.

Verzendprofiel-id
shipping_profile_id integer

De numerieke id van het verzendprofiel.

ISO van oorsprong
origin_country_iso string

De ISO-code van het land van waaruit de vermelding wordt verzonden.

Doelland ISO
destination_country_iso string

De ISO-code van het land waarnaar de vermelding wordt verzonden. Als null is ingesteld, wordt de bestemming ingesteld op destination_region

DestinationRegion
destination_region DestinationRegion

De code van de regio waarnaar de vermelding wordt verzonden. Een regio vertegenwoordigt een set landen. Ondersteunde regio's zijn Europese Unie en Niet-Europese Unie (landen in Europa niet in DE EU). Als er geen is, wordt de bestemming ingesteld op destination_country_iso of overal als destination_country_iso ook null is

Geld
primary_cost Money

Een representatie van een bedrag.

Geld
secondary_cost Money

Een representatie van een bedrag.

Vervoerder-id
shipping_carrier_id integer

De unieke id van een ondersteunde vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

E-mailklasse
mail_class string

De unieke id-tekenreeks van de e-mailklasse van een vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

Minimale levertijden
min_delivery_days integer

Het minimum aantal werkdagen dat een koper kan verwachten te wachten op ontvangst van het gekochte artikel zodra het is verzonden.

Maximum aantal bezorgingsdagen
max_delivery_days integer

Het maximum aantal werkdagen dat een koper kan verwachten om het gekochte artikel te ontvangen zodra het is verzonden.

ShopShippingProfileUpgrade

Een weergave van een upgradeoptie voor een verzendprofiel.

Name Pad Type Description
Verzendprofiel-id
shipping_profile_id integer

De numerieke id van het basisverzendingsprofiel.

Upgrade-id
upgrade_id integer

De numerieke id die is gekoppeld aan een verzendupgrade

Upgradenaam
upgrade_name string

Naam voor de verzendupgrade die wordt weergegeven aan klanten bij het afrekenen, bijvoorbeeld USPS Priority.

Typologie
type Type

Het type verzendupgrade. Binnenlands (0) of internationaal (1).

Rang
rank integer

De positieve niet-nul numerieke positie in de afbeeldingen die worden weergegeven in een lijst, waarbij rang 1 afbeeldingen worden weergegeven op de meest linkse positie in een lijst.

Language
language string

De IETF-taaltag voor de taal van het verzendprofiel. Bijvoorbeeld: de, en, es, fr, it, ja, nl, pl, pt, ru.

Geld
price Money

Een representatie van een bedrag.

Geld
secondary_price Money

Een representatie van een bedrag.

Vervoerder-id
shipping_carrier_id integer

De unieke id van een ondersteunde vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

E-mailklasse
mail_class string

De unieke id-tekenreeks van de e-mailklasse van een vervoerder, die wordt gebruikt om een geschatte leveringsdatum te berekenen.

Minimale levertijden
min_delivery_days integer

Het minimum aantal werkdagen dat een koper kan verwachten te wachten op ontvangst van het gekochte artikel zodra het is verzonden.

Maximum aantal bezorgingsdagen
max_delivery_days integer

Het maximum aantal werkdagen dat een koper kan verwachten om het gekochte artikel te ontvangen zodra het is verzonden.

ShopShippingProfileDestinations

Vertegenwoordigt een lijst met verzendbestemmingsobjecten.

Name Pad Type Description
Aantal
count integer

Het aantal resultaten.

Results
results array of ShopShippingProfileDestination

De lijst met aangevraagde resources.

ShopShippingProfileUpgrades

Een lijst met verzendupgradeopties.

Name Pad Type Description
Aantal
count integer

Het aantal resultaten.

Results
results array of ShopShippingProfileUpgrade

De lijst met aangevraagde resources.

UserAddress

Vertegenwoordigt het adres van een gebruiker.

Name Pad Type Description
Gebruikersadres-id
user_address_id integer

De numerieke id van het adres van de gebruiker.

Gebruikers-ID
user_id integer

De numerieke id van de gebruiker.

Naam
name string

De naam van de gebruiker voor dit adres.

Eerste adresregel
first_line string

De eerste regel van het adres van de gebruiker.

Tweede adresregel
second_line string

De tweede regel van het adres van de gebruiker.

City
city string

Het plaatsveld van het adres van de gebruiker.

Staat
state string

Het statusveld van het adres van de gebruiker.

Postcode
zip string

Het postcodeveld van het adres van de gebruiker.

ISO van landcode
iso_country_code string

De ISO-code van het land in dit adres.

Country
country_name string

De naam van het land van de gebruiker.

Is standaard verzendadres
is_default_shipping_address boolean

Is dit het standaardverzendadres van de gebruiker.

UserAddresses

Vertegenwoordigt verschillende UserAddress-records.

Name Pad Type Description
Aantal
count integer

Het aantal UserAddress-records dat wordt geretourneerd.

Results
results array of UserAddress

Een matrix met UserAddress-resources.

DestinationRegion

De code van de regio waarnaar de vermelding wordt verzonden. Een regio vertegenwoordigt een set landen. Ondersteunde regio's zijn Europese Unie en Niet-Europese Unie (landen in Europa niet in DE EU). Als er geen is, wordt de bestemming ingesteld op destination_country_iso of overal als destination_country_iso ook null is

De code van de regio waarnaar de vermelding wordt verzonden. Een regio vertegenwoordigt een set landen. Ondersteunde regio's zijn Europese Unie en Niet-Europese Unie (landen in Europa niet in DE EU). Als er geen is, wordt de bestemming ingesteld op destination_country_iso of overal als destination_country_iso ook null is

DestinationRegion
string

ItemDimensionsUnit

Een tekenreeks die de eenheden definieert die worden gebruikt om de afmetingen van het product te meten. De standaardwaarde is null.

Een tekenreeks die de eenheden definieert die worden gebruikt om de afmetingen van het product te meten. De standaardwaarde is null.

ItemDimensionsUnit
string

ItemWeightUnit

Een tekenreeks die de eenheden definieert die worden gebruikt om het gewicht van het product te meten. De standaardwaarde is null.

Een tekenreeks die de eenheden definieert die worden gebruikt om het gewicht van het product te meten. De standaardwaarde is null.

ItemWeightUnit
string

Gelegenheid

Een opsommingstekenreeks die een gelegenheid aangeeft waarvoor dit product een geschikt cadeau zou maken. De standaardwaarde is null.

Een opsommingstekenreeks die een gelegenheid aangeeft waarvoor dit product een geschikt cadeau zou maken. De standaardwaarde is null.

Gelegenheid
string

Profieltype

Profieltype
string

Recipient

Een opsommingstekenreeks die een persoon aangeeft voor wie dit product een geschikt cadeau zou maken. De standaardwaarde is null.

Een opsommingstekenreeks die een persoon aangeeft voor wie dit product een geschikt cadeau zou maken. De standaardwaarde is null.

Recipient
string

Staat

Een geïnventareerde tekenreeks van een van de volgende: actief of inactief. Opmerking: als u een conceptvermelding instelt op actief, wordt de vermelding ook gepubliceerd op etsy.com.

Een geïnventareerde tekenreeks van een van de volgende: actief of inactief. Opmerking: als u een conceptvermelding instelt op actief, wordt de vermelding ook gepubliceerd op etsy.com.

Staat
integer

Typologie

Het type verzendupgrade. Binnenlands (0) of internationaal (1).

Het type verzendupgrade. Binnenlands (0) of internationaal (1).

Typologie
integer

WhenMade

Een opsommingstekenreeks voor het tijdperk waarin de maker het product in deze vermelding heeft gemaakt. Helpt kopers de vermelding onder de Vintage kop te vinden. Vereist 'is_supply' en 'who_made'.

Een opsommingstekenreeks voor het tijdperk waarin de maker het product in deze vermelding heeft gemaakt. Helpt kopers de vermelding onder de Vintage kop te vinden. Vereist 'is_supply' en 'who_made'.

WhenMade
string

WhoMade

Een geïnventariseerd tekenreeks die het product heeft gemaakt. Helpt kopers de vermelding onder de Handgemaakte kop te vinden. Vereist 'is_supply' en 'when_made'.

Een geïnventariseerd tekenreeks die het product heeft gemaakt. Helpt kopers de vermelding onder de Handgemaakte kop te vinden. Vereist 'is_supply' en 'when_made'.

WhoMade
string