shopify

package module
v9.0.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 29, 2024 License: MIT Imports: 20 Imported by: 2

README

go-shopify-graphql

A simple client using the Shopify GraphQL Admin API.

Getting started

Hello World example

1. Setup
export STORE_API_KEY=<private_app_api_key>
export STORE_PASSWORD=<private_app_access_token>
export STORE_NAME=<store_name>
2. Program
package main

import (
	"context"
	"fmt"

	shopify "github.com/r0busta/go-shopify-graphql/v9"
)

func main() {
	// Create client
	client := shopify.NewDefaultClient()

	// Get all collections
	collections, err := client.Collection.ListAll(context.Background())
	if err != nil {
		panic(err)
	}

	// Print out the result
	for _, c := range collections {
		fmt.Println(c.Handle)
	}
}
3. Run
go run .

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BulkOperationService 

type BulkOperationService interface {
	BulkQuery(ctx context.Context, query string, v interface{}) error

	PostBulkQuery(ctx context.Context, query string) (*string, error)
	GetCurrentBulkQuery(ctx context.Context) (*model.BulkOperation, error)
	GetCurrentBulkQueryResultURL(ctx context.Context) (*string, error)
	WaitForCurrentBulkQuery(ctx context.Context, interval time.Duration) (*model.BulkOperation, error)
	ShouldGetBulkQueryResultURL(ctx context.Context, id *string) (*string, error)
	CancelRunningBulkQuery(ctx context.Context) error
}

type BulkOperationServiceOp 

type BulkOperationServiceOp struct {
	// contains filtered or unexported fields
}

func (*BulkOperationServiceOp) BulkQuery 

func (s *BulkOperationServiceOp) BulkQuery(ctx context.Context, query string, out interface{}) error

func (*BulkOperationServiceOp) CancelRunningBulkQuery 

func (s *BulkOperationServiceOp) CancelRunningBulkQuery(ctx context.Context) error

func (*BulkOperationServiceOp) GetCurrentBulkQuery 

func (s *BulkOperationServiceOp) GetCurrentBulkQuery(ctx context.Context) (*model.BulkOperation, error)

func (*BulkOperationServiceOp) GetCurrentBulkQueryResultURL 

func (s *BulkOperationServiceOp) GetCurrentBulkQueryResultURL(ctx context.Context) (*string, error)

func (*BulkOperationServiceOp) PostBulkQuery 

func (s *BulkOperationServiceOp) PostBulkQuery(ctx context.Context, query string) (*string, error)

func (*BulkOperationServiceOp) ShouldGetBulkQueryResultURL 

func (s *BulkOperationServiceOp) ShouldGetBulkQueryResultURL(ctx context.Context, id *string) (*string, error)

func (*BulkOperationServiceOp) WaitForCurrentBulkQuery 

func (s *BulkOperationServiceOp) WaitForCurrentBulkQuery(ctx context.Context, interval time.Duration) (*model.BulkOperation, error)

type Client 

type Client struct {
	Product       ProductService
	Inventory     InventoryService
	Collection    CollectionService
	Order         OrderService
	Fulfillment   FulfillmentService
	Location      LocationService
	Metafield     MetafieldService
	BulkOperation BulkOperationService
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(opts ...Option) *Client

func NewClientWithToken 

func NewClientWithToken(accessToken string, storeName string, opts ...Option) *Client

func NewDefaultClient 

func NewDefaultClient() *Client

func NewPrivateClient added in v9.0.6 

func NewPrivateClient() *Client

func (*Client) GraphQLClient 

func (c *Client) GraphQLClient() graphql.GraphQL

type CollectionService 

type CollectionService interface {
	ListAll(ctx context.Context) ([]model.Collection, error)

	Get(ctx context.Context, id string) (*model.Collection, error)

	Create(ctx context.Context, collection model.CollectionInput) (*string, error)
	CreateBulk(ctx context.Context, collections []model.CollectionInput) error

	Update(ctx context.Context, collection model.CollectionInput) error
}

type CollectionServiceOp 

type CollectionServiceOp struct {
	// contains filtered or unexported fields
}

func (*CollectionServiceOp) Create 

func (s *CollectionServiceOp) Create(ctx context.Context, collection model.CollectionInput) (*string, error)

func (*CollectionServiceOp) CreateBulk 

func (s *CollectionServiceOp) CreateBulk(ctx context.Context, collections []model.CollectionInput) error

func (*CollectionServiceOp) Get 

func (s *CollectionServiceOp) Get(ctx context.Context, id string) (*model.Collection, error)

func (*CollectionServiceOp) ListAll 

func (s *CollectionServiceOp) ListAll(ctx context.Context) ([]model.Collection, error)

func (*CollectionServiceOp) Update 

func (s *CollectionServiceOp) Update(ctx context.Context, collection model.CollectionInput) error

type FulfillmentService 

type FulfillmentService interface {
	Create(ctx context.Context, input model.FulfillmentV2Input) error
}

type FulfillmentServiceOp 

type FulfillmentServiceOp struct {
	// contains filtered or unexported fields
}

func (*FulfillmentServiceOp) Create 

func (s *FulfillmentServiceOp) Create(ctx context.Context, fulfillment model.FulfillmentV2Input) error

type InventoryService 

type InventoryService interface {
	Update(ctx context.Context, id string, input model.InventoryItemInput) error
	Adjust(ctx context.Context, locationID string, input []model.InventoryAdjustQuantitiesInput) error
	AdjustQuantities(ctx context.Context, reason, name string, referenceDocumentUri *string, changes []model.InventoryChangeInput) error
	SetOnHandQuantities(ctx context.Context, reason string, referenceDocumentUri *string, setQuantities []model.InventorySetQuantityInput) error
	ActivateInventory(ctx context.Context, locationID string, id string) error
}

type InventoryServiceOp 

type InventoryServiceOp struct {
	// contains filtered or unexported fields
}

func (*InventoryServiceOp) ActivateInventory 

func (s *InventoryServiceOp) ActivateInventory(ctx context.Context, locationID string, id string) error

func (*InventoryServiceOp) Adjust 

func (s *InventoryServiceOp) Adjust(ctx context.Context, locationID string, input []model.InventoryAdjustQuantitiesInput) error

func (*InventoryServiceOp) AdjustQuantities 

func (s *InventoryServiceOp) AdjustQuantities(ctx context.Context, reason, name string, referenceDocumentUri *string, changes []model.InventoryChangeInput) error

func (*InventoryServiceOp) SetOnHandQuantities 

func (s *InventoryServiceOp) SetOnHandQuantities(ctx context.Context, reason string, referenceDocumentUri *string, setQuantities []model.InventorySetQuantityInput) error

func (*InventoryServiceOp) Update 

func (s *InventoryServiceOp) Update(ctx context.Context, id string, input model.InventoryItemInput) error

type ListOptions 

type ListOptions struct {
	Query   string
	First   int
	Last    int
	After   string
	Before  string
	Reverse bool
}

type LocationService 

type LocationService interface {
	Get(ctx context.Context, id string) (*model.Location, error)
}

type LocationServiceOp 

type LocationServiceOp struct {
	// contains filtered or unexported fields
}

func (*LocationServiceOp) Get 

func (s *LocationServiceOp) Get(ctx context.Context, id string) (*model.Location, error)

type MetafieldService 

type MetafieldService interface {
	ListAllShopMetafields(ctx context.Context) ([]model.Metafield, error)
	ListShopMetafieldsByNamespace(ctx context.Context, namespace string) ([]model.Metafield, error)

	GetShopMetafieldByKey(ctx context.Context, namespace, key string) (*model.Metafield, error)

	Delete(ctx context.Context, metafield model.MetafieldIdentifierInput) error
	DeleteBulk(ctx context.Context, metafield []model.MetafieldIdentifierInput) error
}

type MetafieldServiceOp 

type MetafieldServiceOp struct {
	// contains filtered or unexported fields
}

func (*MetafieldServiceOp) Delete 

func (s *MetafieldServiceOp) Delete(ctx context.Context, metafield model.MetafieldIdentifierInput) error

func (*MetafieldServiceOp) DeleteBulk 

func (s *MetafieldServiceOp) DeleteBulk(ctx context.Context, metafields []model.MetafieldIdentifierInput) error

func (*MetafieldServiceOp) GetShopMetafieldByKey 

func (s *MetafieldServiceOp) GetShopMetafieldByKey(ctx context.Context, namespace, key string) (*model.Metafield, error)

func (*MetafieldServiceOp) ListAllShopMetafields 

func (s *MetafieldServiceOp) ListAllShopMetafields(ctx context.Context) ([]model.Metafield, error)

func (*MetafieldServiceOp) ListShopMetafieldsByNamespace 

func (s *MetafieldServiceOp) ListShopMetafieldsByNamespace(ctx context.Context, namespace string) ([]model.Metafield, error)

type Option 

type Option func(shopClient *Client)

func WithGraphQLClient 

func WithGraphQLClient(gql graphql.GraphQL) Option

type OrderService 

type OrderService interface {
	Get(ctx context.Context, id graphql.ID) (*model.Order, error)

	List(ctx context.Context, opts ListOptions) ([]model.Order, error)
	ListAll(ctx context.Context) ([]model.Order, error)

	ListAfterCursor(ctx context.Context, opts ListOptions) ([]model.Order, *string, *string, error)

	Update(ctx context.Context, input model.OrderInput) error
}

type OrderServiceOp 

type OrderServiceOp struct {
	// contains filtered or unexported fields
}

func (*OrderServiceOp) Get 

func (s *OrderServiceOp) Get(ctx context.Context, id graphql.ID) (*model.Order, error)

func (*OrderServiceOp) List 

func (s *OrderServiceOp) List(ctx context.Context, opts ListOptions) ([]model.Order, error)

func (*OrderServiceOp) ListAfterCursor 

func (s *OrderServiceOp) ListAfterCursor(ctx context.Context, opts ListOptions) ([]model.Order, *string, *string, error)

func (*OrderServiceOp) ListAll 

func (s *OrderServiceOp) ListAll(ctx context.Context) ([]model.Order, error)

func (*OrderServiceOp) Update 

func (s *OrderServiceOp) Update(ctx context.Context, input model.OrderInput) error

type ProductService 

type ProductService interface {
	List(ctx context.Context, query string) ([]model.Product, error)
	ListAll(ctx context.Context) ([]model.Product, error)

	Get(ctx context.Context, id string) (*model.Product, error)

	Create(ctx context.Context, product model.ProductCreateInput, media []model.CreateMediaInput) (*string, error)

	Update(ctx context.Context, product model.ProductUpdateInput, media []model.CreateMediaInput) error

	Delete(ctx context.Context, product model.ProductDeleteInput) error

	VariantsBulkCreate(ctx context.Context, id string, input []model.ProductVariantsBulkInput, strategy model.ProductVariantsBulkCreateStrategy) error
	VariantsBulkUpdate(ctx context.Context, id string, input []model.ProductVariantsBulkInput) error
	VariantsBulkReorder(ctx context.Context, id string, input []model.ProductVariantPositionInput) error

	MediaCreate(ctx context.Context, id string, input []model.CreateMediaInput) error
}

type ProductServiceOp 

type ProductServiceOp struct {
	// contains filtered or unexported fields
}

func (*ProductServiceOp) Create 

func (s *ProductServiceOp) Create(ctx context.Context, product model.ProductCreateInput, media []model.CreateMediaInput) (*string, error)

func (*ProductServiceOp) Delete 

func (s *ProductServiceOp) Delete(ctx context.Context, product model.ProductDeleteInput) error

func (*ProductServiceOp) Get 

func (s *ProductServiceOp) Get(ctx context.Context, id string) (*model.Product, error)

func (*ProductServiceOp) List 

func (s *ProductServiceOp) List(ctx context.Context, query string) ([]model.Product, error)

func (*ProductServiceOp) ListAll 

func (s *ProductServiceOp) ListAll(ctx context.Context) ([]model.Product, error)

func (*ProductServiceOp) MediaCreate added in v9.0.9 

func (s *ProductServiceOp) MediaCreate(ctx context.Context, id string, input []model.CreateMediaInput) error

func (*ProductServiceOp) Update 

func (s *ProductServiceOp) Update(ctx context.Context, product model.ProductUpdateInput, media []model.CreateMediaInput) error

func (*ProductServiceOp) VariantsBulkCreate 

func (s *ProductServiceOp) VariantsBulkCreate(ctx context.Context, id string, input []model.ProductVariantsBulkInput, strategy model.ProductVariantsBulkCreateStrategy) error

func (*ProductServiceOp) VariantsBulkReorder 

func (s *ProductServiceOp) VariantsBulkReorder(ctx context.Context, id string, input []model.ProductVariantPositionInput) error

func (*ProductServiceOp) VariantsBulkUpdate 

func (s *ProductServiceOp) VariantsBulkUpdate(ctx context.Context, id string, input []model.ProductVariantsBulkInput) error

Source Files

View all Source files

Directories

Path Synopsis
Package mock is a generated GoMock package.
 Package mock is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.