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

Order-presentkort, Webb-API

| Tillagd: 8 maj 2015 | Uppdaterad: 8 maj 2015
| Betyg: 0 | Röster: 0 | Sidvisningar: 917 | Kommentarer (0)
Det här är en webb-API-referens för order-presentkort. Du kan lägga till, uppdatera, hämta och ta bort order-presentkort med detta API. Order-presentkort används för att få statistik om presentkort som har använts för en order och för att få statistik om vilka ordrar som ett presentkort har använts på.

Modell - OrderGiftCard

Egenskap
Typ
Beskrivning
order_id
Int32
Id:t för en order.
gift_card_id
string(50)
Id:t för ett presentkort.
amount
decimal(14, 0)
Det belopp av presentkortets totala belopp som har använts för ordern.

Lägg till en post [HttpPost]

Lägg till en order-presenkort post, order_id och gift_card_id är primärnycklar. Skicka en serialiserad version av modellen (JSON, XML) till url:en för metoden.

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

Uppdatera en post [HttpPut]

Uppdatera en order-presenkort post, order_id och gift_card_id är primärnycklar. Skicka en serialiserad version av modellen (JSON, XML) till url:en för metoden.

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

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

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

Behörighet: API_FULL_TRUST,API_MEDIUM_TRUST,API_MINIMAL_TRUST
Url: /api/orders_gift_cards/get_by_id/[order_id]?giftCardId=[gift_card_id]
[order_id]: Id:t för en order (Int32)
[gift_card_id]: Id:t för ett presentkort (string)
Exempel: /api/orders_gift_cards/get_by_id/1?giftCardId=FDFSDFSDF
Returnerar: En serialiserad modell av en order-presentkort post

Hämta poster för en order [HttpGet]

Erhåll en serialiserad lista med order-presentkort för en specificerad order.

Behörighet: API_FULL_TRUST,API_MEDIUM_TRUST,API_MINIMAL_TRUST
Url: /api/orders_gift_cards/get_by_order_id/[order_id]?sortField=[sort_field]&sortOrder=[sort_order]
[order_id]: Id:t för en order (Int32)
[sort_field]: order_id, gift_card_id eller amount
[sort_order]: ASC eller DESC
Exempel: /api/orders_gift_cards/get_by_order_id/5?sortField=gift_card_id&sortOrder=ASC
Returnerar: En serialiserad lista med order-presentkort

Hämta poster för ett presentkort [HttpGet]

Erhåll en serialiserad lista med order-presentkort för ett specificerat presentkort.

Behörighet: API_FULL_TRUST,API_MEDIUM_TRUST,API_MINIMAL_TRUST
Url: /api/orders_gift_cards/get_by_gift_card_id/[gift_card_id]?sortField=[sort_field]&sortOrder=[sort_order]
[gift_card_id]: Id:t för ett presentkort (string)
[sort_field]: order_id, gift_card_id eller amount
[sort_order]: ASC eller DESC
Exempel: /api/orders_gift_cards/get_by_gift_card_id/SSSEEGGG?sortField=amount&sortOrder=ASC
Returnerar: En serialiserad lista med order-presentkort

Hämta alla poster [HttpGet]

Erhåll en serialiserad lista med alla order-presentkort.

Behörighet: API_FULL_TRUST,API_MEDIUM_TRUST,API_MINIMAL_TRUST
Url: /api/orders_gift_cards/get_all
Exempel: /api/orders_gift_cards/get_all
Returnerar: En serialiserad lista med order-presentkort

Radera en post [HttpDelete]

Ta bort en order-presentkort post med ett specificerat order id och ett specificerat presentkorts-id.

Behörighet: API_FULL_TRUST
Url: /api/orders_gift_cards/delete/[order_id]?giftCardId=[gift_card_id]
[order_id]: Id:t för en order (Int32)
[gift_card_id]: Id:t för ett presentkort (string)
Exempel: /api/orders_gift_cards/delete/1?giftCardId=2
Returnerar: Ett HTTP-svar med en statuskod och ett meddelande

Kommentarer
Användarnamn
Lösenord