Compare commits

..

23 Commits

Author SHA1 Message Date
Bastian de Byl
5a74c2bae8 main corrected Operation in ProductCustomField to float64 from int 2023-05-12 15:23:14 -04:00
Bastian de Byl
d7f1571e09 main added CustomFields to snipcart product 2023-05-12 15:20:36 -04:00
Bastian de Byl
f18e21f181 main return only one product for GetProductById 2023-05-12 10:46:54 -04:00
Bastian de Byl
d56cf589da main correct the output of GetProductById 2023-05-12 03:14:07 -04:00
Bastian de Byl
9e631a91b1 corrected SnipcartProductsResponse, added GetProductById 2023-05-12 00:36:50 -04:00
Bastian de Byl
e575ff03a8 added GetProducts, SnipcartProductsResponse, SnipcartProductVariant 2023-05-12 00:01:55 -04:00
Bastian de Byl
0ec82e6397 modified NewClient to return ptr 2023-05-03 14:22:29 -04:00
Bastian de Byl
687a5df39f added ValidateWebhook(token) func to client 2023-05-03 14:20:15 -04:00
Bastian de Byl
131af89f4f moved enums to enums.go, added SendNotification, Notification structs & enums 2023-04-12 16:56:01 -04:00
Bastian de Byl
b93afeec2f added Created and Modified times to SnipcartOrder 2023-04-09 18:31:53 -04:00
Bastian de Byl
bc56b4d16a 8677r5eju added initial .drone.yml 2023-04-06 23:34:18 -04:00
Bastian de Byl
b08b64f5b2 added SnipcartTax and SnipcartWebhookTaxResponse 2023-04-06 17:59:48 -04:00
Bastian de Byl
ad93704f41 renamed Order.ShippingRate to Order.ShippingRateId 2023-04-03 21:20:22 -04:00
Bastian de Byl
b97ee3132b consolidated webhook order to just order 2023-03-29 13:24:09 -04:00
Bastian de Byl
cfdde462f4 added more order struct details 2023-03-29 13:14:30 -04:00
Bastian de Byl
e039b583e2 fixed Curreny to Currency typo 2023-03-13 00:26:11 -04:00
Bastian de Byl
26571a41fa changed ShippingAddress State to Province 2023-03-13 00:16:22 -04:00
Bastian de Byl
559a100e90 added more missing OrderEventContent fields 2023-03-13 00:14:47 -04:00
Bastian de Byl
6ff851823e added missing OrderEventContent fields 2023-03-13 00:12:11 -04:00
Bastian de Byl
db6e320b7f added webhook specific structs 2023-03-13 00:07:50 -04:00
Bastian de Byl
563e6baeda main added Metadata field to SnipcartOrder struct 2023-03-02 17:19:50 -05:00
Bastian de Byl
e1f7e99027 moved webhook to go-snipcart-webhook repo 2023-02-26 21:23:37 -05:00
Bastian de Byl
36ca8d6f83 added initial webhook main function 2023-02-26 20:36:12 -05:00
7 changed files with 224 additions and 59 deletions

View File

@@ -1,32 +0,0 @@
package main
import (
"flag"
"log"
"github.com/debyltech/go-snipcart/snipcart"
)
func main() {
snipcartApiKey := flag.String("key", "", "Snipcart API Key")
flag.Parse()
if *snipcartApiKey == "" {
log.Fatal("missing -key flag")
}
Client := snipcart.NewClient(*snipcartApiKey)
updateOrder := snipcart.SnipcartOrderUpdate{
Status: snipcart.Delivered,
}
response, err := Client.UpdateOrder("b35990df-c0ca-4014-94de-1caa7bd7bb51", &updateOrder)
if err != nil {
log.Fatal(err)
}
for k, v := range response.Items {
log.Printf("%v: %v\n", k, v)
}
}

3
go.mod
View File

@@ -1,8 +1,9 @@
module github.com/debyltech/go-snipcart
go 1.20
go 1.19
require (
github.com/debyltech/go-helpers v1.1.0
github.com/debyltech/go-shippr v0.1.0
github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
)

View File

@@ -1,6 +1,7 @@
package snipcart
type OrderStatus string
type NotificationType string
const (
Processed OrderStatus = "Processed"
@@ -10,4 +11,10 @@ const (
Pending = "Pending"
Cancelled = "Cancelled"
Dispatched = "Dispatched"
Comment NotificationType = "Comment"
OrderStatusChanged = "OrderStatusChanged"
OrderShipped = "OrderShipped"
TrackingNumber = "TrackingNumber"
Invoice = "Invice"
)

View File

@@ -5,19 +5,25 @@ import (
"encoding/json"
"errors"
"fmt"
"net/http"
"time"
helper "github.com/debyltech/go-helpers/json"
"github.com/skip2/go-qrcode"
)
const (
defaultLimit = 50
apiUri = "https://app.snipcart.com"
ordersPath = "/api/orders"
defaultLimit = 50
apiUri = "https://app.snipcart.com"
ordersPath = "/api/orders"
productsPath = "/api/products"
validationPath = "/api/requestvalidation/"
)
var (
orderUri = apiUri + ordersPath
orderUri = apiUri + ordersPath
productsUri = apiUri + productsPath
validationUri = apiUri + validationPath
)
type Client struct {
@@ -47,25 +53,34 @@ type SnipcartItem struct {
}
type SnipcartOrder struct {
Token string `json:"token"`
Invoice string `json:"invoiceNumber"`
Subtotal float64 `json:"subtotal,omitempty"`
Total float64 `json:"grandTotal,omitempty"`
Status string `json:"status"`
TotalWeight float64 `json:"totalWeight"`
Email string `json:"email"`
Name string `json:"shippingAddressName"`
Address1 string `json:"shippingAddressAddress1"`
Address2 string `json:"shippingAddressAddress2"`
City string `json:"shippingAddressCity"`
Province string `json:"shippingAddressProvince"`
Country string `json:"shippingAddressCountry"`
PostalCode string `json:"shippingAddressPostalCode"`
Phone string `json:"shippingAddressPhone"`
TrackingNumber string `json:"trackingNumber"`
TrackingUrl string `json:"trackingUrl"`
ShippingCost float64 `json:"shippingFees"`
Items []SnipcartItem `json:"items"`
Token string `json:"token"`
Created time.Time `json:"creationDate"`
Modified time.Time `json:"modificationDate"`
Invoice string `json:"invoiceNumber"`
Subtotal float64 `json:"subtotal,omitempty"`
Currency string `json:"currency,omitempty"`
Total float64 `json:"grandTotal,omitempty"`
Status string `json:"status"`
TotalWeight float64 `json:"totalWeight"`
ShippingAddress SnipcartShippingAddress `json:"shippingAddress,omitempty"`
Name string `json:"shippingAddressName,omitempty"`
Company string `json:"shippingAddressCompanyName,omitempty"`
Address1 string `json:"shippingAddressAddress1,omitempty"`
Address2 string `json:"shippingAddressAddress2,omitempty"`
City string `json:"shippingAddressCity,omitempty"`
Province string `json:"shippingAddressProvince,omitempty"`
Country string `json:"shippingAddressCountry,omitempty"`
PostalCode string `json:"shippingAddressPostalCode,omitempty"`
Phone string `json:"shippingAddressPhone,omitempty"`
Email string `json:"email,omitempty"`
TrackingNumber string `json:"trackingNumber"`
TrackingUrl string `json:"trackingUrl"`
ShippingCost float64 `json:"shippingFees"`
ShippingProvider string `json:"shippingProvider,omitempty"`
ShippingMethod string `json:"shippingMethod,omitempty"`
ShippingRateId string `json:"shippingRateUserDefinedId,omitempty"`
Items []SnipcartItem `json:"items"`
Metadata any `json:"metadata"`
}
type SnipcartOrderUpdate struct {
@@ -73,6 +88,7 @@ type SnipcartOrderUpdate struct {
PaymentStatus string `json:"paymentStatus,omitempty"`
TrackingNumber string `json:"trackingNumber,omitempty"`
TrackingUrl string `json:"trackingUrl,omitempty"`
ShippingRateId string `json:"shippingRateUserDefinedId,omitempty"`
Metadata any `json:"metadata,omitempty"`
}
@@ -81,8 +97,76 @@ type SnipcartOrders struct {
Items []SnipcartOrder
}
func NewClient(snipcartApiKey string) Client {
return Client{
type SnipcartTax struct {
Name string `json:"name"`
Amount float64 `json:"amount"`
NumberForInvoice string `json:"numberForInvoice"`
Rate float64 `json:"rate"`
}
type SnipcartNotification struct {
Type NotificationType `json:"type"`
DeliveryMethod string `json:"deliveryMethod"`
Message string `json:"message,omitempty"`
}
type SnipcartNotificationResponse struct {
Id string `json:"id"`
Created time.Time `json:"creationDate"`
Type NotificationType `json:"type"`
DeliveryMethod string `json:"deliveryMethod"`
Body string `json:"body"`
Message string `json:"message"`
Subject string `json:"subject"`
SentOn time.Time `json:"sentOn"`
}
type SnipcartProductVariant struct {
Stock int `json:"stock"`
Variation []any `json:"variation"`
AllowBackorder bool `json:"allowOutOfStockPurchases"`
}
type SnipcartProductCustomField struct {
Name string `json:"name"`
Placeholder string `json:"placeholder"`
DisplayValue string `json:"displayValue"`
Type string `json:"type"`
Options string `json:"options"`
Required bool `json:"required"`
Value string `json:"value"`
Operation float64 `json:"operation"`
OptionsArray []string `json:"optionsArray"`
}
type SnipcartProduct struct {
Token string `json:"id"`
Id string `json:"userDefinedId"`
Name string `json:"name"`
Stock int `json:"stock"`
TotalStock int `json:"totalStock"`
AllowBackorder bool `json:"allowOutOfStockPurchases"`
CustomFields []SnipcartProductCustomField `json:"customFields"`
Variants []SnipcartProductVariant `json:"variants"`
}
type SnipcartProductsResponse struct {
Keywords string `json:"keywords"`
UserDefinedId string `json:"userDefinedId"`
Archived bool `json:"archived"`
From time.Time `json:"from"`
To time.Time `json:"to"`
OrderBy string `json:"orderBy"`
Paginated bool `json:"hasMoreResults"`
TotalItems int `json:"totalItems"`
Offset int `json:"offset"`
Limit int `json:"limit"`
Sort []any `json:"sort"`
Items []SnipcartProduct `json:"items"`
}
func NewClient(snipcartApiKey string) *Client {
return &Client{
SnipcartKey: snipcartApiKey,
AuthBase64: base64.StdEncoding.EncodeToString([]byte(snipcartApiKey + ":")),
}
@@ -153,7 +237,6 @@ func (s *Client) UpdateOrder(token string, orderUpdate *SnipcartOrderUpdate) (*S
if response.StatusCode < 200 && response.StatusCode >= 300 {
return nil, fmt.Errorf("unexpected response received: %s", response.Status)
}
fmt.Println(response.Status)
defer response.Body.Close()
@@ -165,3 +248,88 @@ func (s *Client) UpdateOrder(token string, orderUpdate *SnipcartOrderUpdate) (*S
return &responseOrder, nil
}
func (s *Client) SendNotification(token string, notification *SnipcartNotification) (*SnipcartNotificationResponse, error) {
response, err := helper.Post(orderUri+"/"+token+"/notifications", "Basic", s.AuthBase64, notification)
if err != nil {
return nil, err
}
defer response.Body.Close()
var responseNotification SnipcartNotificationResponse
err = json.NewDecoder(response.Body).Decode(&responseNotification)
if err != nil {
return nil, err
}
return &responseNotification, nil
}
func (s *Client) ValidateWebhook(token string) error {
validateRequest, err := http.NewRequest("GET", validationUri+token, nil)
if err != nil {
return err
}
client := &http.Client{}
auth := base64.StdEncoding.EncodeToString([]byte(s.SnipcartKey + ":"))
validateRequest.Header.Set("Authorization", fmt.Sprintf("Basic %s", auth))
validateRequest.Header.Set("Accept", "application/json")
validateResponse, err := client.Do(validateRequest)
if err != nil {
return fmt.Errorf("error validating webhook: %s", err.Error())
}
if validateResponse.StatusCode < 200 || validateResponse.StatusCode >= 300 {
return fmt.Errorf("non-2XX status code for validating webhook: %d", validateResponse.StatusCode)
}
return nil
}
func (s *Client) GetProducts(queries map[string]string) (*SnipcartProductsResponse, error) {
response, err := helper.Get(productsUri, "Basic", s.AuthBase64, queries)
if err != nil {
return nil, err
}
if response.StatusCode < 200 && response.StatusCode >= 300 {
return nil, fmt.Errorf("unexpected response received: %s", response.Status)
}
defer response.Body.Close()
var products SnipcartProductsResponse
err = json.NewDecoder(response.Body).Decode(&products)
if err != nil {
return nil, err
}
return &products, nil
}
func (s *Client) GetProductById(id string) (*SnipcartProduct, error) {
response, err := helper.Get(productsUri, "Basic", s.AuthBase64, map[string]string{"userDefinedId": id})
if err != nil {
return nil, err
}
if response.StatusCode < 200 && response.StatusCode >= 300 {
return nil, fmt.Errorf("unexpected response received: %s", response.Status)
}
defer response.Body.Close()
var products SnipcartProductsResponse
err = json.NewDecoder(response.Body).Decode(&products)
if err != nil {
return nil, err
}
if len(products.Items) < 1 {
return nil, fmt.Errorf("no products with id '%s'", id)
}
return &products.Items[0], nil
}

21
snipcart/webhook.go Normal file
View File

@@ -0,0 +1,21 @@
package snipcart
type SnipcartShippingAddress struct {
FullName string `json:"fullName"`
FirstName string `json:"firstName"`
Name string `json:"name"`
Company string `json:"company"`
Address1 string `json:"address1"`
Address2 string `json:"address2"`
FullAddress string `json:"fullAddress"`
City string `json:"city"`
Country string `json:"country"`
PostalCode string `json:"postalCode"`
Province string `json:"province"`
Phone string `json:"phone"`
VatNumber string `json:"vatNumber,omitempty"`
}
type SnipcartWebhookTaxResponse struct {
Taxes []SnipcartTax `json:"taxes"`
}