forked from bold-commerce/go-shopify
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathorder.go
675 lines (601 loc) · 40.3 KB
/
order.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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
package goshopify
import (
"encoding/json"
"fmt"
"net/http"
"time"
"github.com/shopspring/decimal"
)
const ordersBasePath = "orders"
const ordersResourceName = "orders"
// OrderService is an interface for interfacing with the orders endpoints of
// the Shopify API.
// See: https://help.shopify.com/api/reference/order
type OrderService interface {
List(interface{}) ([]Order, error)
ListWithPagination(interface{}) ([]Order, *Pagination, error)
Count(interface{}) (int, error)
Get(int64, interface{}) (*Order, error)
Create(Order) (*Order, error)
Update(Order) (*Order, error)
Cancel(int64, interface{}) (*Order, error)
Close(int64) (*Order, error)
Open(int64) (*Order, error)
// MetafieldsService used for Order resource to communicate with Metafields resource
MetafieldsService
// FulfillmentsService used for Order resource to communicate with Fulfillments resource
FulfillmentsService
}
// OrderServiceOp handles communication with the order related methods of the
// Shopify API.
type OrderServiceOp struct {
client *Client
}
// A struct for all available order count options
type OrderCountOptions struct {
CreatedAtMin *time.Time `json:"created_at_min" url:"created_at_min,omitempty" bson:"created_at_min,omitempty"`
CreatedAtMax *time.Time `json:"created_at_max" url:"created_at_max,omitempty" bson:"created_at_max,omitempty"`
UpdatedAtMin *time.Time `json:"updated_at_min" url:"updated_at_min,omitempty" bson:"updated_at_min,omitempty"`
UpdatedAtMax *time.Time `json:"updated_at_max" url:"updated_at_max,omitempty" bson:"updated_at_max,omitempty"`
FinancialStatus *string `json:"financial_status" url:"financial_status,omitempty" bson:"financial_status,omitempty"`
FulfillmentStatus *string `json:"fulfillment_status" url:"fulfillment_status,omitempty" bson:"fulfillment_status,omitempty"`
Status *string `json:"status" url:"status,omitempty" bson:"status,omitempty"`
}
// A struct for all available order list options.
// See: https://help.shopify.com/api/reference/order#index
type OrderListOptions struct {
AttributionAppId *string `json:"attribution_app_id,omitempty" url:"attribution_app_id,omitempty"`
CreatedAtMax *time.Time `json:"created_at_max,omitempty" url:"created_at_max,omitempty"`
CreatedAtMin *time.Time `json:"created_at_min,omitempty" url:"created_at_min,omitempty"`
Fields *string `json:"fields,omitempty" url:"fields,omitempty"`
FinancialStatus *string `json:"financial_status,omitempty" url:"financial_status,omitempty"`
FulfillmentStatus *string `json:"fulfillment_status,omitempty" url:"fulfillment_status,omitempty"`
Ids *string `json:"ids,omitempty" url:"ids,omitempty"`
Limit *int `json:"limit,omitempty" url:"limit,omitempty"`
ProcessedAtMax *time.Time `json:"processed_at_max,omitempty" url:"processed_at_max,omitempty"`
ProcessedAtMin *time.Time `json:"processed_at_min,omitempty" url:"processed_at_min,omitempty"`
SinceID *int64 `json:"since_id,omitempty" url:"since_id,omitempty"`
Status *string `json:"status,omitempty" url:"status,omitempty"`
Page *int `json:"page,omitempty" url:"page,omitempty" bson:"page,omitempty"`
UpdatedAtMax *time.Time `json:"updated_at_max,omitempty" url:"updated_at_max,omitempty"`
UpdatedAtMin *time.Time `json:"updated_at_min,omitempty" url:"updated_at_min,omitempty"`
}
// A struct of all available order cancel options.
// See: https://help.shopify.com/api/reference/order#index
type OrderCancelOptions struct {
Amount *decimal.Decimal `json:"amount,omitempty" bson:"amount,omitempty"`
Currency string `json:"currency,omitempty" bson:"currency,omitempty"`
Restock bool `json:"restock,omitempty" bson:"restock,omitempty"`
Reason string `json:"reason,omitempty" bson:"reason,omitempty"`
Email bool `json:"email,omitempty" bson:"email,omitempty"`
Refund *Refund `json:"refund,omitempty" bson:"refund,omitempty"`
}
type DiscountApplication struct {
AllocationMethod string `json:"allocation_method,omitempty" bson:"allocation_method,omitempty"`
Code string `json:"code,omitempty" bson:"code,omitempty"`
Description string `json:"description,omitempty" bson:"description,omitempty"`
TargetSelection string `json:"target_selection,omitempty" bson:"target_selection,omitempty"`
TargetType string `json:"target_type,omitempty" bson:"target_type,omitempty"`
Title string `json:"title,omitempty" bson:"title,omitempty"`
Type string `json:"type,omitempty" bson:"type,omitempty"`
Value string `json:"value,omitempty" bson:"value,omitempty"`
ValueType string `json:"value_type,omitempty" bson:"value_type,omitempty"`
}
// Order represents a Shopify order
type Order struct {
ID int64 `json:"id,omitempty" bson:"id,omitempty"`
Name string `json:"name,omitempty" bson:"name,omitempty"`
Email string `json:"email,omitempty" bson:"email,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty" bson:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty" bson:"updated_at,omitempty"`
CancelledAt *time.Time `json:"cancelled_at,omitempty" bson:"cancelled_at,omitempty"`
ClosedAt *time.Time `json:"closed_at,omitempty" bson:"closed_at,omitempty"`
ProcessedAt *time.Time `json:"processed_at,omitempty" bson:"processed_at,omitempty"`
Customer *Customer `json:"customer,omitempty" bson:"customer,omitempty"`
BillingAddress *Address `json:"billing_address,omitempty" bson:"billing_address,omitempty"`
ShippingAddress *Address `json:"shipping_address,omitempty" bson:"shipping_address,omitempty"`
Currency string `json:"currency,omitempty" bson:"currency,omitempty"`
TotalPrice *string `json:"total_price,omitempty" bson:"total_price,omitempty"`
TotalPriceSet *AmountSet `json:"total_price_set,omitempty" bson:"total_price_set,omitempty"`
TotalShippingPriceSet *AmountSet `json:"total_shipping_price_set,omitempty" bson:"total_shipping_price_set,omitempty"`
SubtotalPrice *decimal.Decimal `json:"subtotal_price,omitempty" bson:"subtotal_price,omitempty"`
SubtotalPriceSet *AmountSet `json:"subtotal_price_set,omitempty" bson:"subtotal_price_set,omitempty"`
TotalDiscounts *string `json:"total_discounts,omitempty" bson:"total_discounts,omitempty"`
TotalDiscountsSet *AmountSet `json:"total_discounts_set,omitempty" bson:"total_discounts_set,omitempty"`
TotalLineItemsPrice *string `json:"total_line_items_price,omitempty" bson:"total_line_items_price,omitempty"`
TotalLineItemsPriceSet *AmountSet `json:"total_line_items_price_set,omitempty" bson:"total_line_items_price_set,omitempty"`
TotalOutstanding *string `json:"total_outstanding,omitempty" bson:"total_outstanding,omitempty"`
TotalTax *string `json:"total_tax,omitempty" bson:"total_tax,omitempty"`
TotalTaxSet *AmountSet `json:"total_tax_set,omitempty" bson:"total_tax_set,omitempty"`
TotalTipReceived string `json:"total_tip_received,omitempty" bson:"total_tip_received,omitempty"`
TaxLines []TaxLine `json:"tax_lines,omitempty" bson:"tax_lines,omitempty"`
TaxesIncluded bool `json:"taxes_included,omitempty" bson:"taxes_included,omitempty"`
TotalWeight int `json:"total_weight,omitempty" bson:"total_weight,omitempty"`
FinancialStatus string `json:"financial_status,omitempty" bson:"financial_status,omitempty"`
Fulfillments []Fulfillment `json:"fulfillments,omitempty" bson:"fulfillments,omitempty"`
FulfillmentStatus string `json:"fulfillment_status,omitempty" bson:"fulfillment_status,omitempty"`
// Token string `json:"token,omitempty" bson:"token,omitempty"` // @todo
// CartToken string `json:"cart_token,omitempty" bson:"cart_token,omitempty"` // @todo
Number int `json:"number,omitempty" bson:"number,omitempty"`
OrderNumber int `json:"order_number,omitempty" bson:"order_number,omitempty"`
Note string `json:"note,omitempty" bson:"note,omitempty"`
NoteAttributes []NoteAttribute `json:"note_attributes,omitempty" bson:"note_attributes,omitempty"`
Test bool `json:"test,omitempty" bson:"test,omitempty"`
// BrowserIp string `json:"browser_ip,omitempty" bson:"browser_ip,omitempty"` // @todo
// BuyerAcceptsMarketing bool `json:"buyer_accepts_marketing,omitempty" bson:"buyer_accepts_marketing,omitempty"` // @todo
CancelReason string `json:"cancel_reason,omitempty" bson:"cancel_reason,omitempty"`
DiscountCodes []DiscountCode `json:"discount_codes,omitempty" bson:"discount_codes,omitempty"`
LineItems []LineItem `json:"line_items,omitempty" bson:"line_items,omitempty"`
ShippingLines []ShippingLines `json:"shipping_lines,omitempty" bson:"shipping_lines,omitempty"` // @todo
Transactions []Transaction `json:"transactions,omitempty" bson:"transactions,omitempty"`
AppID int `json:"app_id,omitempty" bson:"app_id,omitempty"`
CustomerLocale string `json:"customer_locale,omitempty" bson:"customer_locale,omitempty"`
LandingSite string `json:"landing_site,omitempty" bson:"landing_site,omitempty"`
ReferringSite string `json:"referring_site,omitempty" bson:"referring_site,omitempty"`
SourceName string `json:"source_name,omitempty" bson:"source_name,omitempty"`
SourceIdentifier string `json:"source_identifier,omitempty" bson:"source_identifier,omitempty"`
SourceURL string `json:"source_url,omitempty" bson:"source_url,omitempty"`
// ClientDetails *ClientDetails `json:"client_details,omitempty" bson:"client_details,omitempty"` // @todo
Tags string `json:"tags,omitempty" bson:"tags,omitempty"`
LocationId int64 `json:"location_id,omitempty" bson:"location_id,omitempty"`
// ProcessingMethod string `json:"processing_method,omitempty" bson:"processing_method,omitempty"` // @todo
Refunds []Refund `json:"refunds,omitempty" bson:"refunds,omitempty"`
UserId int64 `json:"user_id,omitempty" bson:"user_id,omitempty"`
// OrderStatusUrl string `json:"order_status_url,omitempty" bson:"order_status_url,omitempty"` // @todo
// Gateway string `json:"gateway,omitempty" bson:"gateway,omitempty"` // @deprecated // @todo
// PaymentDetails *PaymentDetails `json:"payment_details,omitempty" bson:"payment_details,omitempty"` // @deprecated // @todo
// PaymentTerms *PaymentTerm `json:"payment_terms,omitempty" bson:"payment_terms,omitempty"` // @todo
// PaymentGatewayNames []string `json:"payment_gateway_names,omitempty" bson:"payment_gateway_names,omitempty"` // @todo
Confirmed bool `json:"confirmed,omitempty" bson:"confirmed,omitempty"`
TotalPriceUSD *decimal.Decimal `json:"total_price_usd,omitempty" bson:"total_price_usd,omitempty"`
// CheckoutToken string `json:"checkout_token,omitempty" bson:"checkout_token,omitempty"` // @todo
// Reference string `json:"reference,omitempty" bson:"reference,omitempty"` // @todo
// DeviceID int64 `json:"device_id,omitempty" bson:"device_id,omitempty"` // @todo
Phone string `json:"phone,omitempty" bson:"phone,omitempty"`
// LandingSiteRef string `json:"landing_site_ref,omitempty" bson:"landing_site_ref,omitempty"` // @todo
// CheckoutID int64 `json:"checkout_id,omitempty" bson:"checkout_id,omitempty"` // @todo
// ContactEmail string `json:"contact_email,omitempty" bson:"contact_email,omitempty"` // @todo
// Metafields []Metafield `json:"metafields,omitempty" bson:"metafields,omitempty"` // @todo
// CurrentTotalDiscounts string `json:"current_total_discounts,omitempty" bson:"current_total_discounts,omitempty"` // @todo
// CurrentTotalDiscountsSet map[string]AmountSet `json:"current_total_discounts_set,omitempty" bson:"current_total_discounts_set,omitempty"` // @todo
// CurrentTotalDutiesSet map[string]AmountSet `json:"current_total_duties_set,omitempty" bson:"current_total_duties_set,omitempty"` // @todo
// CurrentTotalPrice string `json:"current_total_price,omitempty" bson:"current_total_price,omitempty"` // @todo
// CurrentTotalPriceSet map[string]AmountSet `json:"current_total_price_set,omitempty" bson:"current_total_price_set,omitempty"` // @todo
// CurrentSubtotalPrice string `json:"current_subtotal_price,omitempty" bson:"current_subtotal_price,omitempty"` // @todo
// CurrentSubtotalPriceSet map[string]AmountSet `json:"current_subtotal_price_set,omitempty" bson:"current_subtotal_price_set,omitempty"` // @todo
// CurrentTotalTax string `json:"current_total_tax,omitempty" bson:"current_total_tax,omitempty"` // @todo
// CurrentTotalTaxSet map[string]AmountSet `json:"current_total_tax_set,omitempty" bson:"current_total_tax_set,omitempty"` // @todo
DiscountApplications []DiscountApplication `json:"discount_applications,omitempty" bson:"discount_applications,omitempty"`
// EstimatedTaxes bool `json:"estimated_taxes,omitempty" bson:"estimated_taxes,omitempty"` // @todo
// OriginalTotalDutiesSet map[string]AmountSet `json:"original_total_duties_set,omitempty" bson:"original_total_duties_set,omitempty"` // @todo
// PresentmentCurrency string `json:"presentment_currency,omitempty" bson:"presentment_currency,omitempty"` // @todo
}
type Address struct {
ID int64 `json:"id,omitempty" bson:"id,omitempty"`
Address1 string `json:"address1,omitempty" bson:"address1,omitempty"`
Address2 string `json:"address2,omitempty" bson:"address2,omitempty"`
City string `json:"city,omitempty" bson:"city,omitempty"`
Company string `json:"company,omitempty" bson:"company,omitempty"`
Country string `json:"country,omitempty" bson:"country,omitempty"`
CountryCode string `json:"country_code,omitempty" bson:"country_code,omitempty"`
FirstName string `json:"first_name,omitempty" bson:"first_name,omitempty"`
LastName string `json:"last_name,omitempty" bson:"last_name,omitempty"`
Latitude float64 `json:"latitude,omitempty" bson:"latitude,omitempty"`
Longitude float64 `json:"longitude,omitempty" bson:"longitude,omitempty"`
Name string `json:"name,omitempty" bson:"name,omitempty"`
Phone string `json:"phone,omitempty" bson:"phone,omitempty"`
Province string `json:"province,omitempty" bson:"province,omitempty"`
ProvinceCode string `json:"province_code,omitempty" bson:"province_code,omitempty"`
Zip string `json:"zip,omitempty" bson:"zip,omitempty"`
}
type DiscountCode struct {
Amount *decimal.Decimal `json:"amount,omitempty" bson:"amount,omitempty"`
Code string `json:"code,omitempty" bson:"code,omitempty"`
Type string `json:"type,omitempty" bson:"type,omitempty"`
}
type Duty struct {
DutyId int64 `json:"duty_id,omitempty" bson:"duty_id,omitempty"`
AmountSet AmountSet `json:"amount_set,omitempty" bson:"amount_set,omitempty"`
}
type LineItem struct {
ID int64 `json:"id,omitempty" bson:"id,omitempty"`
ProductID int64 `json:"product_id,omitempty" bson:"product_id,omitempty"`
VariantID int64 `json:"variant_id,omitempty" bson:"variant_id,omitempty"`
Quantity int `json:"quantity,omitempty" bson:"quantity,omitempty"`
Price *decimal.Decimal `json:"price,omitempty" bson:"price,omitempty"`
TotalDiscount *decimal.Decimal `json:"total_discount,omitempty" bson:"total_discount,omitempty"`
Title string `json:"title,omitempty" bson:"title,omitempty"`
VariantTitle string `json:"variant_title,omitempty" bson:"variant_title,omitempty"`
Name string `json:"name,omitempty" bson:"name,omitempty"`
SKU string `json:"sku,omitempty" bson:"sku,omitempty"`
Vendor string `json:"vendor,omitempty" bson:"vendor,omitempty"`
GiftCard bool `json:"gift_card,omitempty" bson:"gift_card,omitempty"`
Taxable bool `json:"taxable,omitempty" bson:"taxable,omitempty"`
FulfillmentService string `json:"fulfillment_service,omitempty" bson:"fulfillment_service,omitempty"`
RequiresShipping bool `json:"requires_shipping,omitempty" bson:"requires_shipping,omitempty"`
VariantInventoryManagement string `json:"variant_inventory_management,omitempty" bson:"variant_inventory_management,omitempty"`
PreTaxPrice *decimal.Decimal `json:"pre_tax_price,omitempty" bson:"pre_tax_price,omitempty"`
Properties []NoteAttribute `json:"properties,omitempty" bson:"properties,omitempty"`
ProductExists bool `json:"product_exists,omitempty" bson:"product_exists,omitempty"`
FulfillableQuantity int `json:"fulfillable_quantity,omitempty" bson:"fulfillable_quantity,omitempty"`
Grams int `json:"grams,omitempty" bson:"grams,omitempty"`
FulfillmentStatus string `json:"fulfillment_status,omitempty" bson:"fulfillment_status,omitempty"`
TaxLines []TaxLine `json:"tax_lines,omitempty" bson:"tax_lines,omitempty"`
OriginLocation *Address `json:"origin_location,omitempty" bson:"origin_location,omitempty"`
DestinationLocation *Address `json:"destination_location,omitempty" bson:"destination_location,omitempty"`
AppliedDiscount *AppliedDiscount `json:"applied_discount,omitempty" bson:"applied_discount,omitempty"`
DiscountAllocations []DiscountAllocations `json:"discount_allocations,omitempty" bson:"discount_allocations,omitempty"`
Custom bool `json:"custom,omitempty" bson:"custom,omitempty"`
// only for fulfillment
FulfillmentLineItemID int64 `json:"fulfillment_line_item_id,omitempty" bson:"fulfillment_line_item_id,omitempty"` // order/updated; order/create 的webhook中没有返回该字段
Duties []Duty `json:"duties,omitempty" bson:"duties,omitempty"`
}
type PaymentTerm struct {
Amount *decimal.Decimal `json:"amount,omitempty" bson:"amount,omitempty"`
Currency string `json:"currency,omitempty" bson:"currency,omitempty"`
PaymentTermsName string `json:"payment_terms_name,omitempty" bson:"payment_terms_name,omitempty"`
PaymentTermsType string `json:"payment_terms_type,omitempty" bson:"payment_terms_type,omitempty"`
DueInDays int `json:"due_in_days,omitempty" bson:"due_in_days,omitempty"`
PaymentSchedules []PaymentSchedule `json:"payment_schedules,omitempty" bson:"payment_schedules,omitempty"`
}
type PaymentSchedule struct {
Amount *decimal.Decimal `json:"amount,omitempty" bson:"amount,omitempty"`
Currency string `json:"currency,omitempty" bson:"currency,omitempty"`
IssuedAt *time.Time `json:"issued_at,omitempty" bson:"issued_at,omitempty"`
DueAt *time.Time `json:"due_at,omitempty" bson:"due_at,omitempty"`
CompletedAt *time.Time `json:"completed_at,omitempty" bson:"completed_at,omitempty"`
ExpectedPaymentMethod string `json:"expected_payment_method,omitempty" bson:"expected_payment_method,omitempty"`
}
type DiscountAllocations struct {
Amount *decimal.Decimal `json:"amount,omitempty" bson:"amount,omitempty"`
DiscountApplicationIndex int `json:"discount_application_index,omitempty" bson:"discount_application_index,omitempty"`
AmountSet AmountSet `json:"amount_set,omitempty" bson:"amount_set,omitempty"`
}
type AmountSet struct {
ShopMoney AmountSetEntry `json:"shop_money,omitempty" bson:"shop_money,omitempty"`
PresentmentMoney AmountSetEntry `json:"presentment_money,omitempty" bson:"presentment_money,omitempty"`
}
type AmountSetEntry struct {
Amount *decimal.Decimal `json:"amount,omitempty" bson:"amount,omitempty"`
CurrencyCode string `json:"currency_code,omitempty" bson:"currency_code,omitempty"`
}
// UnmarshalJSON custom unmarsaller for LineItem required to mitigate some older orders having LineItem.Properies
// which are empty JSON objects rather than the expected array.
func (li *LineItem) UnmarshalJSON(data []byte) error {
type alias LineItem
aux := &struct {
Properties json.RawMessage `json:"properties"`
*alias
}{alias: (*alias)(li)}
err := json.Unmarshal(data, &aux)
if err != nil {
return err
}
if len(aux.Properties) == 0 {
return nil
} else if aux.Properties[0] == '[' { // if the first character is a '[' we unmarshal into an array
var p []NoteAttribute
err = json.Unmarshal(aux.Properties, &p)
if err != nil {
return err
}
li.Properties = p
} else { // else we unmarshal it into a struct
var p NoteAttribute
err = json.Unmarshal(aux.Properties, &p)
if err != nil {
return err
}
if p.Name == "" && p.Value == nil { // if the struct is empty we set properties to nil
li.Properties = nil
} else {
li.Properties = []NoteAttribute{p} // else we set them to an array with the property nested
}
}
return nil
}
type LineItemProperty struct {
Message string `json:"message" bson:"message"`
}
type NoteAttribute struct {
Name string `json:"name,omitempty" bson:"name,omitempty"`
Value interface{} `json:"value,omitempty" bson:"value,omitempty"`
}
// Represents the result from the orders/X.json endpoint
type OrderResource struct {
Order *Order `json:"order" bson:"order"`
}
// Represents the result from the orders.json endpoint
type OrdersResource struct {
Orders []Order `json:"orders" bson:"orders"`
}
type PaymentDetails struct {
AVSResultCode string `json:"avs_result_code,omitempty" bson:"avs_result_code,omitempty"`
CreditCardBin string `json:"credit_card_bin,omitempty" bson:"credit_card_bin,omitempty"`
CVVResultCode string `json:"cvv_result_code,omitempty" bson:"cvv_result_code,omitempty"`
CreditCardNumber string `json:"credit_card_number,omitempty" bson:"credit_card_number,omitempty"`
CreditCardCompany string `json:"credit_card_company,omitempty" bson:"credit_card_company,omitempty"`
}
type ShippingLine struct {
Custom bool `json:"custom,omitempty" bson:"custom,omitempty"`
Handle string `json:"handle,omitempty" bson:"handle,omitempty"`
Title string `json:"title,omitempty" bson:"title,omitempty"`
Price *decimal.Decimal `json:"price,omitempty" bson:"price,omitempty"`
}
type ShippingLines struct {
ID int64 `json:"id,omitempty" bson:"id,omitempty"`
Title string `json:"title,omitempty" bson:"title,omitempty"`
Price *decimal.Decimal `json:"price,omitempty" bson:"price,omitempty"`
PriceSet *AmountSet `json:"price_set,omitempty" bson:"price_set,omitempty"`
Code string `json:"code,omitempty" bson:"code,omitempty"`
Source string `json:"source,omitempty" bson:"source,omitempty"`
Phone string `json:"phone,omitempty" bson:"phone,omitempty"`
RequestedFulfillmentServiceID string `json:"requested_fulfillment_service_id,omitempty" bson:"requested_fulfillment_service_id,omitempty"`
DeliveryCategory string `json:"delivery_category,omitempty" bson:"delivery_category,omitempty"`
CarrierIdentifier string `json:"carrier_identifier,omitempty" bson:"carrier_identifier,omitempty"`
TaxLines []TaxLine `json:"tax_lines,omitempty" bson:"tax_lines,omitempty"`
DiscountedPrice string `json:"discounted_price,omitempty" bson:"discounted_price,omitempty"`
DiscountedPriceSet *AmountSet `json:"discounted_price_set,omitempty" bson:"discounted_price_set,omitempty"`
DiscountAllocations []DiscountAllocations `json:"discount_allocations,omitempty" bson:"discount_allocations,omitempty"`
}
// UnmarshalJSON custom unmarshaller for ShippingLines implemented to handle requested_fulfillment_service_id being
// returned as json numbers or json nulls instead of json strings
func (sl *ShippingLines) UnmarshalJSON(data []byte) error {
type alias ShippingLines
aux := &struct {
*alias
RequestedFulfillmentServiceID interface{} `json:"requested_fulfillment_service_id" bson:"requested_fulfillment_service_id"`
}{alias: (*alias)(sl)}
err := json.Unmarshal(data, &aux)
if err != nil {
return err
}
switch aux.RequestedFulfillmentServiceID.(type) {
case nil:
sl.RequestedFulfillmentServiceID = ""
default:
sl.RequestedFulfillmentServiceID = fmt.Sprintf("%v", aux.RequestedFulfillmentServiceID)
}
return nil
}
type TaxLine struct {
Title string `json:"title,omitempty" bson:"title,omitempty"`
Price *decimal.Decimal `json:"price,omitempty" bson:"price,omitempty"`
Rate *decimal.Decimal `json:"rate,omitempty" bson:"rate,omitempty"`
ChannelLiable *bool `json:"channel_liable,omitempty" bson:"channel_liable,omitempty"`
PriceSet *AmountSet `json:"price_set,omitempty" bson:"price_set,omitempty"`
}
type ExtendedAuthorizationAttributes struct {
StandardAuthorizationExpiresAt *time.Time `json:"standard_authorization_expires_at,omitempty" bson:"standard_authorization_expires_at,omitempty"`
ExtendedAuthorizationExpiresAt *time.Time `json:"extended_authorization_expires_at,omitempty" bson:"extended_authorization_expires_at,omitempty"`
}
type PaymentsRefundAttributes struct {
Status string `json:"status,omitempty" bson:"status,omitempty"`
AcquirerReferenceNumber string `json:"acquirer_reference_number,omitempty" bson:"acquirer_reference_number,omitempty"`
}
type CurrencyExchangeAdjustment struct {
ID int64 `json:"id,omitempty" bson:"id,omitempty"`
Adjustment string `json:"adjustment,omitempty" bson:"adjustment,omitempty"`
OriginalAmount string `json:"original_amount,omitempty" bson:"original_amount,omitempty"`
FinalAmount string `json:"final_amount,omitempty" bson:"final_amount,omitempty"`
Currency string `json:"currency,omitempty" bson:"currency,omitempty"`
}
type Transaction struct {
ID int64 `json:"id,omitempty" bson:"id,omitempty"`
OrderID int64 `json:"order_id,omitempty" bson:"order_id,omitempty"`
Amount *decimal.Decimal `json:"amount,omitempty" bson:"amount,omitempty"`
Kind string `json:"kind,omitempty" bson:"kind,omitempty"`
Gateway string `json:"gateway,omitempty" bson:"gateway,omitempty"`
Status string `json:"status,omitempty" bson:"status,omitempty"`
Message string `json:"message,omitempty" bson:"message,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty" bson:"created_at,omitempty"`
Test bool `json:"test,omitempty" bson:"test,omitempty"`
Authorization string `json:"authorization,omitempty" bson:"authorization,omitempty"`
AuthorizationExpiresAt *time.Time `json:"authorization_expires_at,omitempty" bson:"authorization_expires_at,omitempty"`
ExtendedAuthorizationAttributes *ExtendedAuthorizationAttributes `json:"extended_authorization_attributes,omitempty" bson:"extended_authorization_attributes,omitempty"`
Currency string `json:"currency,omitempty" bson:"currency,omitempty"`
LocationID *int64 `json:"location_id,omitempty" bson:"location_id,omitempty"` // @todo 格式确认？https://shopify.dev/api/admin-rest/2022-10/resources/transaction
UserID *int64 `json:"user_id,omitempty" bson:"user_id,omitempty"`
ParentID *int64 `json:"parent_id,omitempty" bson:"parent_id,omitempty"`
DeviceID *int64 `json:"device_id,omitempty" bson:"device_id,omitempty"`
ErrorCode string `json:"error_code,omitempty" bson:"error_code,omitempty"`
SourceName string `json:"source_name,omitempty" bson:"source_name,omitempty"`
Source string `json:"source,omitempty" bson:"source,omitempty"` // @deprecated
PaymentDetails *PaymentDetails `json:"payment_details,omitempty" bson:"payment_details,omitempty"`
PaymentsRefundAttributes *PaymentsRefundAttributes `json:"payments_refund_attributes,omitempty" bson:"payments_refund_attributes,omitempty"`
ProcessedAt *time.Time `json:"processed_at,omitempty" bson:"processed_at,omitempty"`
Receipt *Receipt `json:"receipt,omitempty" bson:"receipt,omitempty"`
CurrencyExchangeAdjustment *CurrencyExchangeAdjustment `json:"currency_exchange_adjustment,omitempty" bson:"currency_exchange_adjustment,omitempty"`
}
type ClientDetails struct {
AcceptLanguage string `json:"accept_language,omitempty" bson:"accept_language,omitempty"`
BrowserHeight int `json:"browser_height,omitempty" bson:"browser_height,omitempty"`
BrowserIp string `json:"browser_ip,omitempty" bson:"browser_ip,omitempty"`
BrowserWidth int `json:"browser_width,omitempty" bson:"browser_width,omitempty"`
SessionHash string `json:"session_hash,omitempty" bson:"session_hash,omitempty"`
UserAgent string `json:"user_agent,omitempty" bson:"user_agent,omitempty"`
}
type OrderAdjustment struct {
Id int64 `json:"id,omitempty" bson:"id,omitempty"`
OrderId int64 `json:"order_id,omitempty" bson:"order_id,omitempty"`
RefundId int64 `json:"refund_id,omitempty" bson:"refund_id,omitempty"`
Amount string `json:"amount,omitempty" bson:"amount,omitempty"`
TaxAmount string `json:"tax_amount,omitempty" bson:"tax_amount,omitempty"`
Kind string `json:"kind,omitempty" bson:"kind,omitempty"`
Reason string `json:"reason,omitempty" bson:"reason,omitempty"`
AmountSet *AmountSet `json:"amount_set,omitempty" bson:"amount_set,omitempty"`
TaxAmountSet *AmountSet `json:"tax_amount_set,omitempty" bson:"tax_amount_set,omitempty"`
}
type RefundDuty struct {
DutyId int64 `json:"duty_id,omitempty" bson:"duty_id,omitempty"`
RefundType string `json:"refund_type,omitempty" bson:"refund_type,omitempty"`
}
type Refund struct {
Id int64 `json:"id,omitempty" bson:"id,omitempty"`
OrderId int64 `json:"order_id,omitempty" bson:"order_id,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty" bson:"created_at,omitempty"`
// Duties map[string]Duty `json:"duties,omitempty" bson:"duties,omitempty"` // @todo
Note *string `json:"note,omitempty" bson:"note,omitempty"`
Restock bool `json:"restock,omitempty" bson:"restock,omitempty"` // @deprecated
UserId *int64 `json:"user_id,omitempty" bson:"user_id,omitempty"`
ProcessedAt *time.Time `json:"processed_at,omitempty" bson:"processed_at,omitempty"`
RefundLineItems []RefundLineItem `json:"refund_line_items,omitempty" bson:"refund_line_items,omitempty"`
Transactions []Transaction `json:"transactions,omitempty" bson:"transactions,omitempty"`
OrderAdjustments []OrderAdjustment `json:"order_adjustments,omitempty" bson:"order_adjustments,omitempty"`
// RefundDuties []RefundDuty `json:"refund_duties,omitempty" bson:"refund_duties,omitempty"` // @todo
}
type RefundLineItem struct {
Id int64 `json:"id,omitempty" bson:"id,omitempty"`
LineItem *LineItem `json:"line_item,omitempty" bson:"line_item,omitempty"`
LineItemId int64 `json:"line_item_id,omitempty" bson:"line_item_id,omitempty"`
Quantity int `json:"quantity,omitempty" bson:"quantity,omitempty"`
RestockType string `json:"restock_type,omitempty" bson:"restock_type,omitempty"`
LocationId int `json:"location_id,omitempty" bson:"location_id,omitempty"`
Subtotal *decimal.Decimal `json:"subtotal,omitempty" bson:"subtotal,omitempty"`
SubtotalSet *AmountSet `json:"subtotal_set,omitempty" bson:"subtotal_set,omitempty"`
TotalTax *decimal.Decimal `json:"total_tax,omitempty" bson:"total_tax,omitempty"`
TotalTaxSet *AmountSet `json:"total_tax_set,omitempty" bson:"total_tax_set,omitempty"`
}
// List orders
func (s *OrderServiceOp) List(options interface{}) ([]Order, error) {
orders, _, err := s.ListWithPagination(options)
if err != nil {
return nil, err
}
return orders, nil
}
func (s *OrderServiceOp) ListWithPagination(options interface{}) ([]Order, *Pagination, error) {
path := fmt.Sprintf("%s.json", ordersBasePath)
resource := new(OrdersResource)
headers := http.Header{}
headers, err := s.client.createAndDoGetHeaders("GET", path, nil, options, resource)
if err != nil {
return nil, nil, err
}
// Extract pagination info from header
linkHeader := headers.Get("Link")
pagination, err := extractPagination(linkHeader)
if err != nil {
return nil, nil, err
}
return resource.Orders, pagination, nil
}
// Count orders
func (s *OrderServiceOp) Count(options interface{}) (int, error) {
path := fmt.Sprintf("%s/count.json", ordersBasePath)
return s.client.Count(path, options)
}
// Get individual order
func (s *OrderServiceOp) Get(orderID int64, options interface{}) (*Order, error) {
path := fmt.Sprintf("%s/%d.json", ordersBasePath, orderID)
resource := new(OrderResource)
err := s.client.Get(path, resource, options)
return resource.Order, err
}
// Create order
func (s *OrderServiceOp) Create(order Order) (*Order, error) {
path := fmt.Sprintf("%s.json", ordersBasePath)
wrappedData := OrderResource{Order: &order}
resource := new(OrderResource)
err := s.client.Post(path, wrappedData, resource)
return resource.Order, err
}
// Update order
func (s *OrderServiceOp) Update(order Order) (*Order, error) {
path := fmt.Sprintf("%s/%d.json", ordersBasePath, order.ID)
wrappedData := OrderResource{Order: &order}
resource := new(OrderResource)
err := s.client.Put(path, wrappedData, resource)
return resource.Order, err
}
// Cancel order
func (s *OrderServiceOp) Cancel(orderID int64, options interface{}) (*Order, error) {
path := fmt.Sprintf("%s/%d/cancel.json", ordersBasePath, orderID)
resource := new(OrderResource)
err := s.client.Post(path, options, resource)
return resource.Order, err
}
// Close order
func (s *OrderServiceOp) Close(orderID int64) (*Order, error) {
path := fmt.Sprintf("%s/%d/close.json", ordersBasePath, orderID)
resource := new(OrderResource)
err := s.client.Post(path, nil, resource)
return resource.Order, err
}
// Open order
func (s *OrderServiceOp) Open(orderID int64) (*Order, error) {
path := fmt.Sprintf("%s/%d/open.json", ordersBasePath, orderID)
resource := new(OrderResource)
err := s.client.Post(path, nil, resource)
return resource.Order, err
}
// List metafields for an order
func (s *OrderServiceOp) ListMetafields(orderID int64, options interface{}) ([]Metafield, error) {
metafieldService := &MetafieldServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return metafieldService.List(options)
}
// Count metafields for an order
func (s *OrderServiceOp) CountMetafields(orderID int64, options interface{}) (int, error) {
metafieldService := &MetafieldServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return metafieldService.Count(options)
}
// Get individual metafield for an order
func (s *OrderServiceOp) GetMetafield(orderID int64, metafieldID int64, options interface{}) (*Metafield, error) {
metafieldService := &MetafieldServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return metafieldService.Get(metafieldID, options)
}
// Create a new metafield for an order
func (s *OrderServiceOp) CreateMetafield(orderID int64, metafield Metafield) (*Metafield, error) {
metafieldService := &MetafieldServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return metafieldService.Create(metafield)
}
// Update an existing metafield for an order
func (s *OrderServiceOp) UpdateMetafield(orderID int64, metafield Metafield) (*Metafield, error) {
metafieldService := &MetafieldServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return metafieldService.Update(metafield)
}
// Delete an existing metafield for an order
func (s *OrderServiceOp) DeleteMetafield(orderID int64, metafieldID int64) error {
metafieldService := &MetafieldServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return metafieldService.Delete(metafieldID)
}
// List fulfillments for an order
func (s *OrderServiceOp) ListFulfillments(orderID int64, options interface{}) ([]Fulfillment, error) {
fulfillmentService := &FulfillmentServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return fulfillmentService.List(options)
}
// Count fulfillments for an order
func (s *OrderServiceOp) CountFulfillments(orderID int64, options interface{}) (int, error) {
fulfillmentService := &FulfillmentServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return fulfillmentService.Count(options)
}
// Get individual fulfillment for an order
func (s *OrderServiceOp) GetFulfillment(orderID int64, fulfillmentID int64, options interface{}) (*Fulfillment, error) {
fulfillmentService := &FulfillmentServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return fulfillmentService.Get(fulfillmentID, options)
}
// Create a new fulfillment for an order
func (s *OrderServiceOp) CreateFulfillment(orderID int64, fulfillment Fulfillment) (*Fulfillment, error) {
fulfillmentService := &FulfillmentServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return fulfillmentService.Create(fulfillment)
}
// Update an existing fulfillment for an order
func (s *OrderServiceOp) UpdateFulfillment(orderID int64, fulfillment Fulfillment) (*Fulfillment, error) {
fulfillmentService := &FulfillmentServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return fulfillmentService.Update(fulfillment)
}
// Complete an existing fulfillment for an order
func (s *OrderServiceOp) CompleteFulfillment(orderID int64, fulfillmentID int64) (*Fulfillment, error) {
fulfillmentService := &FulfillmentServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return fulfillmentService.Complete(fulfillmentID)
}
// Transition an existing fulfillment for an order
func (s *OrderServiceOp) TransitionFulfillment(orderID int64, fulfillmentID int64) (*Fulfillment, error) {
fulfillmentService := &FulfillmentServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return fulfillmentService.Transition(fulfillmentID)
}
// Cancel an existing fulfillment for an order
func (s *OrderServiceOp) CancelFulfillment(orderID int64, fulfillmentID int64) (*Fulfillment, error) {
fulfillmentService := &FulfillmentServiceOp{client: s.client, resource: ordersResourceName, resourceID: orderID}
return fulfillmentService.Cancel(fulfillmentID)
}