supersonic-models
Version:
Supersonic models and API specifications
59 lines (58 loc) • 1.77 kB
YAML
post:
summary: Use voucher coupon Aloha Loyalty
description: Mark voucher as used on Aloha Loyalty provider.
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: Use voucher coupon payload
description: Use voucher coupon payload for Aloha Loyalty provider
schema:
type: object
required:
- kiosk
- settings
- voucherCode
- couponCode
- timestamp
- cartId
properties:
timestamp:
type: string
example: "2020-12-06T19:50:00Z"
description: Timestamp from the cart state, it's part of the document path on firestore.
cartId:
type: string
example: "cf9d9350-1ed5-11eb-98af-d198a7520869"
description: Cart ID from the cart state, it's part of the document path on firestore.
mock:
type: boolean
default: true
example: true
description: Mock provider responses.
couponCode:
type: number
example: 201
description: Coupon code on Aloha Loyalty provider
voucherCode:
type: string
example: "61000022032056"
description: Voucher code on Aloha Loyalty provider
kiosk:
$ref: "../definitions/kiosk-voucher.yaml"
settings:
$ref: "../definitions/aloha-loyalty-settings.yaml"
responses:
200:
description: Success
schema:
type: boolean
example: true
401:
description: Unauthorized
500:
description: Internal Error
schema:
$ref: "../../../spec/definitions/error-response.yaml"