Bakgrundsbild
a-webshop.se
menu
Mina sidor a-webshop.se
Startsidan // Webb-API-referens // Presentkort, Webb-API

Presentkort, Webb-API

| Tillagd: 8 maj 2015 | Uppdaterad: 8 maj 2015
| Betyg: 0 | Röster: 0 | Sidvisningar: 661 | Kommentarer (0)
Det här är en webb-API-referens för presentkort. Du kan lägga till, uppdatera, hämta och ta bort presentkort med detta API. Ett presentkort kan användas för att betala för en eller flera ordrar, du kan distribuera presentkort till nuvarande och framtida kunder. Ett presentkort kan läggas till av en kund i webbutikens kassa. Ett presentkort är bundet till ett språk och en valuta, ett presentkort kan endast användas på domäner som har tilldelats det språk och den valuta som anges för presentkortet.

Modell - GiftCard

Egenskap
Typ
Beskrivning
id
string(50)
Ett unikt id för presentkortet, den kod som kunden anger för att lägga till presentkortet i kassan.
language_id
Int32
Id:t för det språk som det här presentkortet är giltigt för.
currency_code
string(3)
Valutakoden för den valuta som det här presentkortet är giltigt för.
amount
decimal(14, 0)
Den monetära värdet för presentkortet, anges i den valda valutan.
end_date
DateTime
Det datum och den tid då det här presentkortet inte längre är giltigt.

Lägg till en post [HttpPost]

Lägg till ett presentkort, du måste ange ett id för modellen. Skicka en serialiserad version av modellen (JSON, XML) till url:en för metoden.

Behörighet: API_FULL_TRUST
Url: /api/gift_cards/add
Exempel: /api/gift_cards/add
Returnerar: Ett HTTP-svar med en statuskod och ett meddelande

Uppdatera en post [HttpPut]

Uppdatera ett presentkort, ange ett id för presentkortet och skicka en serialiserad version av modellen (JSON, XML) till url:en för metoden.

Behörighet: API_FULL_TRUST,API_MEDIUM_TRUST
Url: /api/gift_cards/update
Exempel: /api/gift_cards/update
Returnerar: Ett HTTP-svar med en statuskod och ett meddelande

Hämta antalet poster för en sökning [HttpGet]

Erhåll värdet för antalet poster vid en sökning. Ange en textsträng med sökord som är avgränsade med mellanslag.

Behörighet: API_FULL_TRUST,API_MEDIUM_TRUST,API_MINIMAL_TRUST
Url: /api/gift_cards/get_count_by_search?keywords=[keywords]
[keywords]: En url-kodad sträng med sökord som har avgränsats med mellanslag (string)
Exempel: /api/gift_cards/get_count_by_search?keywords=one%20two
Returnerar: Antalet poster (Int32)

Hämta en post för ett id [HttpGet]

Erhåll en serialiserad modell av ett presentkort med ett specificerat id.

Behörighet: API_FULL_TRUST,API_MEDIUM_TRUST,API_MINIMAL_TRUST
Url: /api/gift_cards/get_by_id/[id]
[id]: Id:t för ett presentkort (string)
Exempel: /api/gift_cards/get_by_id/SSSWWW
Returnerar: En serialiserad modell av ett presentkort

Hämta alla poster [HttpGet]

Erhåll en serialiserad lista med modeller av alla presentkort.

Behörighet: API_FULL_TRUST,API_MEDIUM_TRUST,API_MINIMAL_TRUST
Url: /api/gift_cards/get_all?sortField=[sort_field]&sortOrder=[sort_order]
[sort_field]: id, language_id, currency_code, amount eller end_date
[sort_order]: ASC eller DESC
Exempel: /api/gift_cards/get_all?sortField=id&sortOrder=ASC
Returnerar: En serialiserad lista med presentkort

Hämta poster via en sökning [HttpGet]

Erhåll en serialiserad lista med modeller för en sökning. Ange sökord avgränsade med mellanslag.

Behörighet: API_FULL_TRUST,API_MEDIUM_TRUST,API_MINIMAL_TRUST
Url: /api/gift_cards/get_by_search?keywords=[keywords]&pageSize=[page_size]&pageNumber=[page_number]&sortField=[sort_field]&sortOrder=[sort_order]
[keywords]: En url-kodad sträng med sökord som har avgränsats med mellanslag (string)
[page_size]: Antalet poster per sida (Int32)
[page_number]: Sidnumret (Int32)
[sort_field]: id, language_id, currency_code, amount eller end_date
[sort_order]: ASC eller DESC
Exempel: /api/gift_cards/get_by_search?keywords=one%20two&pageSize=10&pageNumber=2&sortField=id&sortOrder=ASC
Returnerar: En serialiserad lista med presentkort

Radera en post [HttpDelete]

Ta bort ett presentkort med ett specificerat id.

Behörighet: API_FULL_TRUST
Url: /api/gift_cards/delete/[id]
[id]: Id:t för ett presentkort (string)
Exempel: /api/gift_cards/delete/SSSMMWW
Returnerar: Ett HTTP-svar med en statuskod och ett meddelande

Kommentarer
Användarnamn
Lösenord