forked from bold-commerce/go-shopify
/
price_rule.go
126 lines (109 loc) · 6.17 KB
/
price_rule.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
package goshopify
import (
"fmt"
"time"
"github.com/shopspring/decimal"
)
const priceRulesBasePath = "price_rules"
// PriceRuleService is an interface for interfacing with the price rule endpoints
// of the Shopify API.
// See: https://shopify.dev/docs/admin-api/rest/reference/discounts/pricerule
type PriceRuleService interface {
Get(int64) (*PriceRule, error)
Create(PriceRule) (*PriceRule, error)
Update(PriceRule) (*PriceRule, error)
List() ([]PriceRule, error)
Delete(int64) error
}
// PriceRuleServiceOp handles communication with the price rule related methods of the Shopify API.
type PriceRuleServiceOp struct {
client *Client
}
// PriceRule represents a Shopify discount rule
type PriceRule struct {
ID int64 `json:"id,omitempty"`
Title string `json:"title,omitempty"`
ValueType string `json:"value_type,omitempty"`
Value *decimal.Decimal `json:"value,omitempty"`
CustomerSelection string `json:"customer_selection,omitempty"`
TargetType string `json:"target_type,omitempty"`
TargetSelection string `json:"target_selection,omitempty"`
AllocationMethod string `json:"allocation_method,omitempty"`
AllocationLimit string `json:"allocation_limit,omitempty"`
OncePerCustomer bool `json:"once_per_customer,omitempty"`
UsageLimit int `json:"usage_limit,omitempty"`
StartsAt *time.Time `json:"starts_at,omitempty"`
EndsAt *time.Time `json:"ends_at,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
EntitledProductIds []int64 `json:"entitled_product_ids,omitempty"`
EntitledVariantIds []int64 `json:"entitled_variant_ids,omitempty"`
EntitledCollectionIds []int64 `json:"entitled_collection_ids,omitempty"`
EntitledCountryIds []int64 `json:"entitled_country_ids,omitempty"`
PrerequisiteProductIds []int64 `json:"prerequisite_product_ids,omitempty"`
PrerequisiteVariantIds []int64 `json:"prerequisite_variant_ids,omitempty"`
PrerequisiteCollectionIds []int64 `json:"prerequisite_collection_ids,omitempty"`
PrerequisiteSavedSearchIds []int64 `json:"prerequisite_saved_search_ids,omitempty"`
PrerequisiteCustomerIds []int64 `json:"prerequisite_customer_ids,omitempty"`
PrerequisiteSubtotalRange *prerequisiteSubtotalRange `json:"prerequisite_subtotal_range,omitempty"`
PrerequisiteQuantityRange *prerequisiteQuantityRange `json:"prerequisite_quantity_range,omitempty"`
PrerequisiteShippingPriceRange *prerequisiteShippingPriceRange `json:"prerequisite_shipping_price_range,omitempty"`
PrerequisiteToEntitlementQuantityRatio *prerequisiteToEntitlementQuantityRatio `json:"prerequisite_to_entitlement_quantity_ratio,omitempty"`
}
type prerequisiteSubtotalRange struct {
GreaterThanOrEqualTo string `json:"greater_than_or_equal_to,omitempty"`
}
type prerequisiteQuantityRange struct {
GreaterThanOrEqualTo int `json:"greater_than_or_equal_to,omitempty"`
}
type prerequisiteShippingPriceRange struct {
LessThanOrEqualTo string `json:"less_than_or_equal_to,omitempty"`
}
type prerequisiteToEntitlementQuantityRatio struct {
PrerequisiteQuantity int `json:"prerequisite_quantity,omitempty"`
EntitledQuantity int `json:"entitled_quantity,omitempty"`
}
// PriceRuleResource represents the result from the price_rules/X.json endpoint
type PriceRuleResource struct {
PriceRule *PriceRule `json:"price_rule"`
}
// PriceRulesResource represents the result from the price_rules.json endpoint
type PriceRulesResource struct {
PriceRules []PriceRule `json:"price_rules"`
}
// Get retrieves a single price rules
func (s *PriceRuleServiceOp) Get(priceRuleID int64) (*PriceRule, error) {
path := fmt.Sprintf("%s/%d.json", priceRulesBasePath, priceRuleID)
resource := new(PriceRuleResource)
err := s.client.Get(path, resource, nil)
return resource.PriceRule, err
}
// List retrieves a list of price rules
func (s *PriceRuleServiceOp) List() ([]PriceRule, error) {
path := fmt.Sprintf("%s.json", priceRulesBasePath)
resource := new(PriceRulesResource)
err := s.client.Get(path, resource, nil)
return resource.PriceRules, err
}
// Create creates a price rule
func (s *PriceRuleServiceOp) Create(pr PriceRule) (*PriceRule, error) {
path := fmt.Sprintf("%s.json", priceRulesBasePath)
resource := new(PriceRuleResource)
wrappedData := PriceRuleResource{PriceRule: &pr}
err := s.client.Post(path, wrappedData, resource)
return resource.PriceRule, err
}
// Update updates an existing a price rule
func (s *PriceRuleServiceOp) Update(pr PriceRule) (*PriceRule, error) {
path := fmt.Sprintf("%s/%d.json", priceRulesBasePath, pr.ID)
resource := new(PriceRuleResource)
wrappedData := PriceRuleResource{PriceRule: &pr}
err := s.client.Put(path, wrappedData, resource)
return resource.PriceRule, err
}
// Delete deletes a price rule
func (s *PriceRuleServiceOp) Delete(priceRuleID int64) error {
path := fmt.Sprintf("%s/%d.json", priceRulesBasePath, priceRuleID)
err := s.client.Delete(path)
return err
}