api

Documentation

Index

• Constants
• func AuthorizeAnalyticsRequest(ctx context.Context, request *events.APIGatewayProxyRequest) error
• type CreateGroupRequest
• type CreateOrderAddressOptions
• type CreateOrderOrderOptions
• type CreateOrderRequest
• type GetRevenueRequest
• type GroupDetails
• type OrderDetails
• type OrderPublic
• type PaymentDropInRequest
• type PaymentDropInResponse
• type Revenue
• type RevenueItem
• type SearchCustomerRequest
• type SearchOrderRequest

Constants

const (
	HeaderAPIKey = "x-al-api-key"
)

Functions

func AuthorizeAnalyticsRequest

func AuthorizeAnalyticsRequest(ctx context.Context, request *events.APIGatewayProxyRequest) error

Types

type CreateGroupRequest

type CreateGroupRequest struct {
	Store string `json:"store"`
}

type CreateOrderAddressOptions

type CreateOrderAddressOptions struct {
	FirstName    string
	LastName     string
	Telephone    string
	Email        string
	AddressLine1 string
	AddressLine2 string
	Postcode     string
	City         string
}

type CreateOrderOrderOptions

type CreateOrderOrderOptions struct {
	OrderID            string
	OrderNumber        string
	InvoiceNumber      string
	Items              []db.OrderItem
	DeliveryDate       string
	DeliveryTime       string
	Net                string
	Total              string
	Tax                string
	Tip                string
	CouponCode         string
	AppliedCouponNet   string
	AppliedCouponTax   string
	AppliedCouponTotal string
	ShippingMethod     db.OrderShippingMethod
	CustomerNote       string
	Status             db.OrderStatus
	Store              primitive.ObjectID
	CompanyKey         string
}

type CreateOrderRequest

type CreateOrderRequest struct {
	FirstName          string                 `json:"firstName"`
	LastName           string                 `json:"lastName"`
	Telephone          string                 `json:"telephone"`
	Email              string                 `json:"email"`
	AddressLine1       string                 `json:"addressLine1"`
	AddressLine2       string                 `json:"addressLine2"`
	Postcode           string                 `json:"postcode"`
	City               string                 `json:"city"`
	ShippingMethod     db.OrderShippingMethod `json:"shippingMethod"`
	Items              []db.OrderItem         `json:"items"`
	Net                string                 `json:"net"`
	Tax                string                 `json:"tax"`
	Total              string                 `json:"total"`
	CouponCode         string                 `json:"couponCode"`
	AppliedCouponNet   string                 `json:"appliedCouponNet"`
	AppliedCouponTax   string                 `json:"appliedCouponTax"`
	AppliedCouponTotal string                 `json:"appliedCouponTotal"`
	Store              primitive.ObjectID     `json:"store"`
	CompanyKey         string                 `json:"companyKey"`
}

type GetRevenueRequest

type GetRevenueRequest struct {
	From    time.Time          `json:"from"`
	To      time.Time          `json:"to"`
	StoreID primitive.ObjectID `json:"storeId"`
}

type GroupDetails

type GroupDetails struct {
	Group  db.Group       `json:"group"`
	Orders []OrderDetails `json:"orders"`
}

type OrderDetails

type OrderDetails struct {
	Order    db.Order    `json:"order"`
	Customer db.Customer `json:"customer"`
}

type OrderPublic

type OrderPublic struct {
	ID               primitive.ObjectID `json:"id"`
	OrderID          string             `json:"orderId"`
	OrderNumber      string             `json:"orderNumber"`
	InvoiceNumber    string             `json:"invoiceNumber"`
	Address          string             `json:"address"`
	AddressLine2     string             `json:"addressLine2"`
	DeliveryDate     string             `json:"deliveryDate"`
	DeliveryTime     string             `json:"deliveryTime"`
	Status           db.OrderStatus     `json:"status"`
	Printed          bool               `json:"printed"`
	CreatedAt        time.Time          `json:"createdAt"`
	GroupKey         string             `json:"groupKey"`
	GroupPosition    int                `json:"groupPosition"`
	DriverName       string             `json:"driverName"`
	Invoice          string             `json:"invoice"`
	InvoicePDFBase64 string             `json:"invoicePDFBase64"`
}

type PaymentDropInRequest

type PaymentDropInRequest struct {
	ReturnURL string `json:"returnUrl"`
}

type PaymentDropInResponse

type PaymentDropInResponse struct {
	ID          string `json:"id"`
	SessionData string `json:"sessionData"`
}

type Revenue

type Revenue struct {
	Request GetRevenueRequest `json:"request"`
	Items   []RevenueItem     `json:"items"`
}

type RevenueItem

type RevenueItem struct {
	Text  string               `json:"type"`
	Total primitive.Decimal128 `json:"total"`
}

type SearchCustomerRequest

type SearchCustomerRequest struct {
	Text         *string `json:"text"`
	FirstName    *string `json:"firstName"`
	LastName     *string `json:"lastName"`
	AddressLine1 *string `json:"addressLine1"`
	Postcode     *string `json:"postcode"`
	Telephone    *string `json:"telephone"`
	Email        *string `json:"email"`
	Limit        *int64  `json:"limit"`
}

type SearchOrderRequest

type SearchOrderRequest struct {
	Text  *string `json:"text"`
	Limit *int64  `json:"limit"`
}