Versions in this module Expand all Collapse all v0 v0.1.0 Jul 15, 2026 Changes in this version + type APIKeyCreateInput struct + Description string + Scope string + type APIKeysResource struct + func (r *APIKeysResource) Create(ctx context.Context, in APIKeyCreateInput) (map[string]any, error) + func (r *APIKeysResource) List(ctx context.Context) ([]map[string]any, error) + func (r *APIKeysResource) Revoke(ctx context.Context, id string) (bool, error) + type AddressCreateInput struct + Address string + AreaID string + ContactName string + ContactPhone string + CustomerID string + Email string + IsDefault *bool + Label string + Lat *float64 + Lng *float64 + PostalCode string + type AddressesResource struct + func (r *AddressesResource) Create(ctx context.Context, in AddressCreateInput) (*CustomerAddress, error) + func (r *AddressesResource) Delete(ctx context.Context, id string) (bool, error) + func (r *AddressesResource) List(ctx context.Context, customerID string) ([]CustomerAddress, error) + type AdminResource struct + func (r *AdminResource) GetWorkspace(ctx context.Context, accountID string) (*PartnerWorkspace, error) + func (r *AdminResource) PartnerUsage(ctx context.Context, p PartnerUsageParams) (*PartnerUsageSummary, error) + func (r *AdminResource) ProvisionWorkspace(ctx context.Context, in ProvisionWorkspaceInput) (*PartnerWorkspace, error) + type ApiEnvelope struct + Data json.RawMessage + Error *ErrorBody + Meta *EnvelopeMeta + type ArchivedEnvelope struct + Archived bool + type AuditLogListParams struct + Cursor string + EventType string + Limit int + Since string + type AuditLogListResult struct + Entries []map[string]any + NextCursor string + type AuditLogResource struct + func (r *AuditLogResource) List(ctx context.Context, p AuditLogListParams) (*AuditLogListResult, error) + type BillingCheckoutInput struct + CancelURL string + PlanID string + SuccessURL string + type BillingCheckoutResult struct + SessionID string + URL string + type BillingInvoicesParams struct + Cursor string + Limit int + type BillingInvoicesResult struct + Invoices []map[string]any + NextCursor string + type BillingResource struct + func (r *BillingResource) Cancel(ctx context.Context) (map[string]any, error) + func (r *BillingResource) Checkout(ctx context.Context, in BillingCheckoutInput) (*BillingCheckoutResult, error) + func (r *BillingResource) CurrentPlan(ctx context.Context) (map[string]any, error) + func (r *BillingResource) Invoices(ctx context.Context, p BillingInvoicesParams) (*BillingInvoicesResult, error) + func (r *BillingResource) Plans(ctx context.Context) ([]map[string]any, error) + func (r *BillingResource) Subscription(ctx context.Context) (map[string]any, error) + func (r *BillingResource) Usage(ctx context.Context) (map[string]any, error) + type Client struct + APIKeys *APIKeysResource + Addresses *AddressesResource + Admin *AdminResource + AuditLog *AuditLogResource + Billing *BillingResource + Deliveries *DeliveriesResource + Integrations *IntegrationsResource + Licenses *LicensesResource + Products *ProductsResource + Shipments *ShipmentsResource + Shipping *ShippingResource + Stats *StatsResource + Stock *StockResource + Warehouses *WarehousesResource + Webhooks *WebhooksResource + func NewClient(opts ClientOptions) (*Client, error) + func (c *Client) BaseURL() string + func (c *Client) ForMerchant(accountId string) *Client + func (c *Client) KeyID() string + func (c *Client) Request(ctx context.Context, method, path string, body any, out any, ...) error + type ClientOptions struct + BaseURL string + HTTP *http.Client + KeyID string + Now func() time.Time + OnBehalfOf string + Secret string + Timeout time.Duration + type CustomerAddress struct + AccountID string + Address string + AreaID *string + BiteshipLocationID *string + ContactName string + ContactPhone string + CreatedAt string + CustomerID string + Email *string + ID string + IsDefault bool + Label string + Lat *float64 + Lng *float64 + PostalCode *string + UpdatedAt string + type DeletedEnvelope struct + Deleted bool + type DeliveriesResource struct + func (r *DeliveriesResource) Create(ctx context.Context, in DeliveryCreateInput) (*Delivery, error) + func (r *DeliveriesResource) Get(ctx context.Context, id string) (*Delivery, error) + func (r *DeliveriesResource) List(ctx context.Context) ([]Delivery, error) + type Delivery struct + AccountID string + CheckoutSessionID string + CreatedAt string + CustomerID string + DownloadCount int64 + ExpiresAt string + ExternalRef *string + ExternalSource *string + ID string + MaxDownloads int64 + ProductID string + UpdatedAt string + type DeliveryCreateInput struct + CheckoutSessionID string + CustomerID string + ExpiresAt string + ExternalRef string + ExternalSource string + MaxDownloads *int64 + ProductID string + type EnvelopeMeta struct + Cursor string + HasMore bool + RequestID string + Timestamp string + type Error struct + Code string + Message string + RequestID string + Status int + func (e *Error) Error() string + type ErrorBody struct + Code string + Message string + type IntegrationsResource struct + func (r *IntegrationsResource) Status(ctx context.Context) (*IntegrationsStatus, error) + type IntegrationsStatus struct + Biteship map[string]any + Huudis map[string]any + Plugipay map[string]any + Storlaunch map[string]any + type License struct + AccountID string + Activations int64 + CreatedAt string + CustomerID string + ExpiresAt *string + ExternalRef *string + ExternalSource *string + ID string + Key string + MaxActivations int64 + ProductID string + Status LicenseStatus + UpdatedAt string + type LicenseActivateInput struct + InstanceID string + Key string + type LicenseActivateResult struct + Activation LicenseActivation + AlreadyActive bool + License License + type LicenseActivation struct + ActivatedAt string + DeactivatedAt *string + ID string + InstanceID string + LicenseID string + type LicenseDeactivateResult struct + Activations int64 + AlreadyDeactivated bool + Deactivated bool + type LicenseIssueInput struct + CustomerID string + ExpiresAt string + ExternalRef string + ExternalSource string + MaxActivations *int64 + ProductID string + type LicenseStatus string + const LicenseActive + const LicenseRevoked + type LicenseValidateParams struct + Key string + ProductID string + type LicenseValidateResult struct + Activations *int64 + ExpiresAt *string + Key string + MaxActivations *int64 + ProductID *string + Status *string + Valid bool + type LicensesResource struct + func (r *LicensesResource) Activate(ctx context.Context, in LicenseActivateInput) (*LicenseActivateResult, error) + func (r *LicensesResource) Deactivate(ctx context.Context, in LicenseActivateInput) (*LicenseDeactivateResult, error) + func (r *LicensesResource) Issue(ctx context.Context, in LicenseIssueInput) (*License, error) + func (r *LicensesResource) List(ctx context.Context) ([]License, error) + func (r *LicensesResource) Revoke(ctx context.Context, id string) (*License, error) + func (r *LicensesResource) Validate(ctx context.Context, p LicenseValidateParams) (*LicenseValidateResult, error) + type PartnerUsageMerchant struct + AccountID string + ChargeableCents int64 + Deliveries int64 + LicensesIssued int64 + Shipments int64 + type PartnerUsageParams struct + From string + Partner string + To string + type PartnerUsagePeriod struct + From string + To string + type PartnerUsageSummary struct + ByMerchant []PartnerUsageMerchant + Partner string + Period PartnerUsagePeriod + Totals PartnerUsageTotals + type PartnerUsageTotals struct + ChargeableCents int64 + Deliveries int64 + LicensesIssued int64 + Shipments int64 + type PartnerWorkspace struct + AccountID string + BrandName *string + BusinessEmail *string + CreatedAt string + DiscountRate float64 + Partner string + type Product struct + AccountID string + Archived bool + CreatedAt string + Description *string + ExternalRef *string + ExternalSource *string + Height *float64 + ID string + Length *float64 + LicenseEnabled bool + MaxActivations int64 + Metadata map[string]any + Name string + SKU *string + Type ProductType + UpdatedAt string + Variants []ProductVariant + Weight *float64 + Width *float64 + type ProductCreateInput struct + Description string + ExternalRef string + ExternalSource string + Height *float64 + Length *float64 + LicenseEnabled *bool + MaxActivations *int64 + Name string + SKU string + Type ProductType + Weight *float64 + Width *float64 + type ProductEnvelope struct + Product Product + type ProductListEnvelope struct + Products []Product + type ProductListParams struct + Archived *bool + type ProductType string + const ProductTypeDigital + const ProductTypeLicense + const ProductTypePhysical + type ProductUpdateInput struct + Description *string + ExternalRef *string + ExternalSource *string + Height *float64 + Length *float64 + LicenseEnabled *bool + MaxActivations *int64 + Name *string + SKU *string + Type *ProductType + Weight *float64 + Width *float64 + type ProductVariant struct + Archived bool + CostCents *int64 + CreatedAt string + ExternalRef *string + ExternalSource *string + ID string + IsDefault bool + LowStockThreshold *int64 + Name string + PriceCents int64 + ProductID string + SKU *string + UpdatedAt string + Weight *float64 + type ProductsResource struct + func (r *ProductsResource) AddVariant(ctx context.Context, productID string, in VariantCreateInput) (*ProductVariant, error) + func (r *ProductsResource) Archive(ctx context.Context, id string) (bool, error) + func (r *ProductsResource) ArchiveVariant(ctx context.Context, productID, variantID string) (bool, error) + func (r *ProductsResource) Create(ctx context.Context, in ProductCreateInput) (*Product, error) + func (r *ProductsResource) Get(ctx context.Context, id string) (*Product, error) + func (r *ProductsResource) List(ctx context.Context, p ProductListParams) ([]Product, error) + func (r *ProductsResource) Update(ctx context.Context, id string, patch ProductUpdateInput) (*Product, error) + func (r *ProductsResource) UpdateVariant(ctx context.Context, productID, variantID string, patch VariantUpdateInput) (*ProductVariant, error) + type ProvisionWorkspaceInput struct + AccountID string + BrandName string + BusinessEmail string + DiscountRate float64 + Partner string + type RequestOptions struct + IdempotencyKey string + OnBehalfOf string + type RevokedEnvelope struct + Revoked bool + type Shipment struct + AccountID string + BiteshipOrderID string + BiteshipTrackingID *string + CancelReason *string + CheckoutSessionID *string + CourierCode string + CourierServiceCode string + CourierType string + CreatedAt string + CustomerEmail *string + CustomerID *string + DestinationSnapshot map[string]any + ExternalRef *string + ExternalSource *string + ID string + Insurance float64 + Insured bool + Items []map[string]any + LabelURL *string + OriginSnapshot map[string]any + Price float64 + ProductID *string + Status ShipmentStatus + TrackingURL *string + UpdatedAt string + WaybillID *string + type ShipmentCreateInput struct + CheckoutSessionID string + CourierCode string + CourierServiceCode string + CourierType string + CustomerEmail string + CustomerID string + Destination map[string]any + ExternalRef string + ExternalSource string + Insurance *float64 + Insured *bool + Items []map[string]any + Origin map[string]any + Price float64 + ProductID string + type ShipmentStatus string + const ShipmentAllocated + const ShipmentCancelled + const ShipmentConfirmed + const ShipmentDelivered + const ShipmentDroppingOff + const ShipmentFailed + const ShipmentInTransit + const ShipmentPending + const ShipmentPickedUp + const ShipmentPickingUp + const ShipmentReturned + type ShipmentsResource struct + func (r *ShipmentsResource) Create(ctx context.Context, in ShipmentCreateInput) (*Shipment, error) + func (r *ShipmentsResource) Get(ctx context.Context, id string) (*Shipment, error) + func (r *ShipmentsResource) List(ctx context.Context, status string) ([]Shipment, error) + type ShippingRatesInput struct + Destination map[string]any + Insurance *bool + Items []map[string]any + type ShippingResource struct + func (r *ShippingResource) Couriers(ctx context.Context) ([]map[string]any, error) + func (r *ShippingResource) Origin(ctx context.Context) (map[string]any, error) + func (r *ShippingResource) Rates(ctx context.Context, in ShippingRatesInput) (map[string]any, error) + func (r *ShippingResource) SetOrigin(ctx context.Context, in map[string]any) (map[string]any, error) + type StatsOverview struct + Counters map[string]int64 + Recent map[string]any + type StatsResource struct + func (r *StatsResource) Overview(ctx context.Context) (*StatsOverview, error) + type StockAdjustInput struct + Delta int64 + Note string + Reason StockMovementReason + VariantID string + WarehouseID string + type StockAdjustResult struct + Movement StockMovement + Stock VariantStock + type StockMovement struct + CreatedAt string + CreatedBy *string + Delta int64 + ID string + Note *string + Reason StockMovementReason + ReferenceID *string + VariantID string + WarehouseID string + type StockMovementReason string + const StockMovementCheckoutCommit + const StockMovementCheckoutRelease + const StockMovementCheckoutReserve + const StockMovementDamaged + const StockMovementImport + const StockMovementInitialStock + const StockMovementManualAdjust + const StockMovementRefundRestock + const StockMovementReturnedToSupplier + const StockMovementTransferIn + const StockMovementTransferOut + type StockReservation struct + CheckoutSessionID string + ConsumedAt *string + CreatedAt string + ExpiresAt string + ID string + Quantity int64 + ReleasedAt *string + VariantID string + WarehouseID string + type StockResource struct + func (r *StockResource) Adjust(ctx context.Context, in StockAdjustInput) (*StockAdjustResult, error) + func (r *StockResource) Levels(ctx context.Context, variantID string) ([]VariantStock, error) + func (r *StockResource) Movements(ctx context.Context, variantID string) ([]StockMovement, error) + func (r *StockResource) Reservations(ctx context.Context) ([]StockReservation, error) + type VariantCreateInput struct + CostCents *int64 + ExternalRef string + ExternalSource string + IsDefault *bool + LowStockThreshold *int64 + Name string + PriceCents *int64 + SKU string + Weight *float64 + type VariantEnvelope struct + Variant ProductVariant + type VariantStock struct + ID string + Quantity int64 + UpdatedAt string + VariantID string + Warehouse *VariantStockWarehouseRef + WarehouseID string + type VariantStockWarehouseRef struct + ID string + Name string + type VariantUpdateInput struct + CostCents *int64 + ExternalRef *string + ExternalSource *string + IsDefault *bool + LowStockThreshold *int64 + Name *string + PriceCents *int64 + SKU *string + Weight *float64 + type VerifyWebhookOptions struct + Now func() time.Time + ToleranceSec int64 + type Warehouse struct + AccountID string + Address *string + Archived bool + City *string + CreatedAt string + ID string + IsDefault bool + Name string + Phone *string + Postal *string + UpdatedAt string + type WarehouseCreateInput struct + Address string + City string + IsDefault *bool + Lat *float64 + Lng *float64 + Name string + Phone string + Postal string + type WarehouseUpdateInput struct + Address *string + City *string + IsDefault *bool + Lat *float64 + Lng *float64 + Name *string + Phone *string + Postal *string + type WarehousesResource struct + func (r *WarehousesResource) Archive(ctx context.Context, id string) (bool, error) + func (r *WarehousesResource) Create(ctx context.Context, in WarehouseCreateInput) (*Warehouse, error) + func (r *WarehousesResource) List(ctx context.Context) ([]Warehouse, error) + func (r *WarehousesResource) Update(ctx context.Context, id string, patch WarehouseUpdateInput) (*Warehouse, error) + type WebhookEndpointCreateInput struct + Description string + Events []string + URL string + type WebhookEndpointUpdateInput struct + Active *bool + Description *string + Events *[]string + URL *string + type WebhookEventEnvelope struct + AccountID *string + Data json.RawMessage + ID string + Metadata map[string]any + OccurredAt string + Type string + func VerifyWebhook(rawBody []byte, signatureHeader, secret string, opts *VerifyWebhookOptions) (*WebhookEventEnvelope, error) + type WebhookEventsListParams struct + Cursor string + Limit int + Type string + type WebhookEventsListResult struct + Events []map[string]any + NextCursor string + type WebhooksResource struct + func (r *WebhooksResource) CreateEndpoint(ctx context.Context, in WebhookEndpointCreateInput) (map[string]any, error) + func (r *WebhooksResource) DeleteEndpoint(ctx context.Context, id string) (bool, error) + func (r *WebhooksResource) ListEndpoints(ctx context.Context) ([]map[string]any, error) + func (r *WebhooksResource) ListEvents(ctx context.Context, p WebhookEventsListParams) (*WebhookEventsListResult, error) + func (r *WebhooksResource) UpdateEndpoint(ctx context.Context, id string, patch WebhookEndpointUpdateInput) (map[string]any, error)
Go to main page