@vencav/shoptet-client 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,244 @@
+import { Result } from '@vencav/result';
+export { Result } from '@vencav/result';
+
+interface ShoptetWebhookPayload {
+    readonly event: ShoptetEventType;
+    readonly eventCreated: string;
+    readonly eventInstance: string;
+    readonly eshopId: number;
+}
+type ShoptetEventType = "order:create" | "order:update" | "order:delete" | "stock:update" | "product:create" | "product:update";
+interface ShoptetOrder {
+    readonly code: string;
+    readonly guid: string;
+    readonly creationTime: string;
+    readonly changeTime: string;
+    readonly status: ShoptetOrderStatus;
+    readonly paid: boolean;
+    readonly currency: string;
+    readonly price: ShoptetPrice;
+    readonly customer: ShoptetCustomer;
+    readonly billingAddress: ShoptetAddress;
+    readonly deliveryAddress?: ShoptetAddress;
+    readonly shippingMethod: ShoptetShippingMethod;
+    readonly paymentMethod: ShoptetPaymentMethod;
+    readonly items: ReadonlyArray<ShoptetOrderItem>;
+    readonly notes?: string;
+    readonly adminNotes?: string;
+}
+interface ShoptetOrderStatus {
+    readonly id: number;
+    readonly name: string;
+}
+interface ShoptetPrice {
+    readonly withVat: number;
+    readonly withoutVat: number;
+    readonly vat: number;
+    readonly toPay: number;
+    readonly currencyCode: string;
+    readonly exchangeRate: number;
+}
+interface ShoptetCustomer {
+    readonly guid?: string;
+    readonly email: string;
+    readonly phone?: string;
+    readonly remark?: string;
+}
+interface ShoptetAddress {
+    readonly company?: string;
+    readonly fullName: string;
+    readonly street: string;
+    readonly houseNumber?: string;
+    readonly city: string;
+    readonly district?: string;
+    readonly zip: string;
+    readonly countryCode: string;
+    readonly regionName?: string;
+    readonly additional?: string;
+    readonly companyId?: string;
+    readonly vatId?: string;
+}
+interface ShoptetShippingMethod {
+    readonly guid: string;
+    readonly name: string;
+}
+interface ShoptetPaymentMethod {
+    readonly guid: string;
+    readonly name: string;
+}
+type ItemType = "product" | "shipping" | "billing" | "discount" | "gift";
+interface ShoptetOrderItem {
+    readonly productGuid?: string;
+    readonly code: string;
+    readonly ean?: string;
+    readonly name: string;
+    readonly variantName?: string;
+    readonly amount: number;
+    readonly amountUnit: string;
+    readonly weight?: number;
+    readonly remark?: string;
+    readonly itemPrice: ShoptetItemPrice;
+    readonly itemType: ItemType;
+}
+interface ShoptetItemPrice {
+    readonly withVat: number;
+    readonly withoutVat: number;
+    readonly vat: number;
+    readonly vatRate: number;
+}
+interface ShoptetStockItem {
+    readonly guid: string;
+    readonly code: string;
+    readonly ean?: string;
+    readonly stock: number;
+    readonly minStockSupply?: number;
+}
+type CreateOrderItemType = "product" | "shipping" | "billing" | "discount-coupon" | "volume-discount" | "gift" | "gift-certificate" | "generic-item" | "service" | "deposit";
+interface CreateOrderItem {
+    readonly itemType: CreateOrderItemType;
+    readonly productGuid?: string;
+    /** Product/variant code – max 64 chars */
+    readonly code?: string;
+    /** Item name – max 250 chars */
+    readonly name?: string;
+    readonly variantName?: string;
+    readonly brand?: string;
+    readonly supplierName?: string;
+    readonly remark?: string;
+    readonly warrantyDescription?: string;
+    readonly additionalField?: string;
+    /** Quantity, e.g. "1.000" */
+    readonly amount?: string;
+    /** Unit, e.g. "ks" – max 16 chars */
+    readonly amountUnit?: string;
+    readonly weight?: string;
+    readonly priceRatio?: string;
+    /** VAT rate, e.g. "21.00" */
+    readonly vatRate?: string;
+    /** Total item price with VAT */
+    readonly itemPriceWithVat?: string;
+    /** Total item price without VAT */
+    readonly itemPriceWithoutVat?: string;
+    /** Unit price with VAT */
+    readonly unitPriceWithVat?: string;
+    /** Unit price without VAT */
+    readonly unitPriceWithoutVat?: string;
+    readonly buyPriceWithVat?: string;
+    readonly buyPriceWithoutVat?: string;
+    readonly buyPriceVatRate?: string;
+    readonly statusId?: number;
+    readonly amountCompleted?: string;
+    readonly recyclingFeeId?: number;
+    readonly consumptionTaxId?: number;
+}
+interface CreateOrderAddress {
+    readonly company?: string;
+    readonly fullName?: string;
+    readonly street?: string;
+    readonly streetWithNr?: string;
+    readonly houseNumber?: string;
+    readonly city?: string;
+    readonly district?: string;
+    readonly additional?: string;
+    readonly zip?: string;
+    readonly countryCode?: string;
+    readonly regionName?: string;
+    readonly regionShortcut?: string;
+    readonly companyId?: string;
+    readonly vatId?: string;
+    readonly taxId?: string;
+}
+interface CreateOrderCurrency {
+    readonly code: string;
+    readonly exchangeRate?: string;
+}
+interface CreateOrderRequest {
+    /** ISO 8601 datetime */
+    readonly creationTime?: string;
+    /** Order code – max 10 chars, must be unique */
+    readonly code?: string;
+    readonly language?: string;
+    /** External system identifier – max 255 chars, required & unique */
+    readonly externalCode: string;
+    readonly cashDeskOrder?: boolean;
+    readonly statusId?: number;
+    readonly sourceId?: number | null;
+    readonly salesChannelGuid?: string | null;
+    /** Customer email – max 100 chars */
+    readonly email?: string;
+    /** Phone – max 32 chars */
+    readonly phone?: string | null;
+    readonly birthDate?: string | null;
+    readonly vatPayer?: boolean;
+    readonly paymentMethodGuid?: string | null;
+    readonly shippingGuid?: string | null;
+    readonly shippingDetails?: Record<string, unknown> | null;
+    readonly paid?: boolean | null;
+    readonly billingMethodCode?: number;
+    readonly clientIPAddress?: string | null;
+    readonly customerGuid?: string | null;
+    readonly billingAddress?: CreateOrderAddress;
+    readonly addressesEqual?: boolean | null;
+    readonly deliveryAddress?: CreateOrderAddress | null;
+    readonly notes?: Record<string, unknown> | null;
+    readonly stockId?: number;
+    readonly currency: CreateOrderCurrency;
+    readonly vatMode?: "Normal" | "One Stop Shop" | "Reverse charge" | "Outside the EU";
+    readonly items: ReadonlyArray<CreateOrderItem>;
+}
+interface CreateOrderOptions {
+    readonly suppressDocumentGeneration?: boolean;
+    readonly suppressEmailSending?: boolean;
+    readonly suppressProductChecking?: boolean;
+    readonly suppressStockMovements?: boolean;
+    readonly suppressHistoricalMandatoryFields?: boolean;
+    readonly suppressHistoricalPaymentChecking?: boolean;
+    readonly suppressHistoricalShippingChecking?: boolean;
+}
+interface ShoptetApiResponse<T> {
+    readonly data: T;
+    readonly errors: ReadonlyArray<ShoptetError> | null;
+}
+interface ShoptetError {
+    readonly errorCode: string;
+    readonly instance: string;
+    readonly message: string;
+}
+
+interface ShoptetCredentials {
+    readonly oauthAccessToken: string;
+    readonly apiUrl: string;
+    readonly webhookSecret: string;
+}
+interface ShoptetClientOptions {
+    /** Maximum items per batch request. Shoptet API hard limit is 300. Default: 300. */
+    readonly maxBatchSize?: number;
+    /** Request timeout in milliseconds. Default: 30000. */
+    readonly timeoutMs?: number;
+}
+type BatchUpdateResult = {
+    readonly success: number;
+    readonly failed: number;
+    readonly errors: ReadonlyArray<{
+        readonly code: string;
+        readonly error: string;
+    }>;
+};
+type ShoptetClient = ReturnType<typeof createShoptetClient>;
+declare const createShoptetClient: (credentials: ShoptetCredentials, options?: ShoptetClientOptions) => {
+    validateWebhookSignature: (payload: string, signature: string) => boolean;
+    getOrder: (orderCode: string) => Promise<Result<ShoptetOrder>>;
+    getDefaultStockId: () => Promise<Result<number>>;
+    batchUpdateStock: (items: Array<{
+        productCode: string;
+        quantity: number;
+    }>) => Promise<Result<BatchUpdateResult>>;
+    getDefaultPricelistId: () => Promise<Result<number>>;
+    batchUpdatePrices: (items: Array<{
+        code: string;
+        price: number;
+    }>) => Promise<Result<BatchUpdateResult>>;
+    createOrder: (order: CreateOrderRequest, orderOptions?: CreateOrderOptions) => Promise<Result<ShoptetOrder>>;
+};
+
+export { type BatchUpdateResult, type CreateOrderAddress, type CreateOrderCurrency, type CreateOrderItem, type CreateOrderItemType, type CreateOrderOptions, type CreateOrderRequest, type ItemType, type ShoptetAddress, type ShoptetApiResponse, type ShoptetClient, type ShoptetClientOptions, type ShoptetCredentials, type ShoptetCustomer, type ShoptetError, type ShoptetEventType, type ShoptetOrder, type ShoptetOrderItem, type ShoptetOrderStatus, type ShoptetPaymentMethod, type ShoptetPrice, type ShoptetShippingMethod, type ShoptetStockItem, type ShoptetWebhookPayload, createShoptetClient };

package/dist/index.d.ts

@@ -0,0 +1,244 @@
+import { Result } from '@vencav/result';
+export { Result } from '@vencav/result';
+
+interface ShoptetWebhookPayload {
+    readonly event: ShoptetEventType;
+    readonly eventCreated: string;
+    readonly eventInstance: string;
+    readonly eshopId: number;
+}
+type ShoptetEventType = "order:create" | "order:update" | "order:delete" | "stock:update" | "product:create" | "product:update";
+interface ShoptetOrder {
+    readonly code: string;
+    readonly guid: string;
+    readonly creationTime: string;
+    readonly changeTime: string;
+    readonly status: ShoptetOrderStatus;
+    readonly paid: boolean;
+    readonly currency: string;
+    readonly price: ShoptetPrice;
+    readonly customer: ShoptetCustomer;
+    readonly billingAddress: ShoptetAddress;
+    readonly deliveryAddress?: ShoptetAddress;
+    readonly shippingMethod: ShoptetShippingMethod;
+    readonly paymentMethod: ShoptetPaymentMethod;
+    readonly items: ReadonlyArray<ShoptetOrderItem>;
+    readonly notes?: string;
+    readonly adminNotes?: string;
+}
+interface ShoptetOrderStatus {
+    readonly id: number;
+    readonly name: string;
+}
+interface ShoptetPrice {
+    readonly withVat: number;
+    readonly withoutVat: number;
+    readonly vat: number;
+    readonly toPay: number;
+    readonly currencyCode: string;
+    readonly exchangeRate: number;
+}
+interface ShoptetCustomer {
+    readonly guid?: string;
+    readonly email: string;
+    readonly phone?: string;
+    readonly remark?: string;
+}
+interface ShoptetAddress {
+    readonly company?: string;
+    readonly fullName: string;
+    readonly street: string;
+    readonly houseNumber?: string;
+    readonly city: string;
+    readonly district?: string;
+    readonly zip: string;
+    readonly countryCode: string;
+    readonly regionName?: string;
+    readonly additional?: string;
+    readonly companyId?: string;
+    readonly vatId?: string;
+}
+interface ShoptetShippingMethod {
+    readonly guid: string;
+    readonly name: string;
+}
+interface ShoptetPaymentMethod {
+    readonly guid: string;
+    readonly name: string;
+}
+type ItemType = "product" | "shipping" | "billing" | "discount" | "gift";
+interface ShoptetOrderItem {
+    readonly productGuid?: string;
+    readonly code: string;
+    readonly ean?: string;
+    readonly name: string;
+    readonly variantName?: string;
+    readonly amount: number;
+    readonly amountUnit: string;
+    readonly weight?: number;
+    readonly remark?: string;
+    readonly itemPrice: ShoptetItemPrice;
+    readonly itemType: ItemType;
+}
+interface ShoptetItemPrice {
+    readonly withVat: number;
+    readonly withoutVat: number;
+    readonly vat: number;
+    readonly vatRate: number;
+}
+interface ShoptetStockItem {
+    readonly guid: string;
+    readonly code: string;
+    readonly ean?: string;
+    readonly stock: number;
+    readonly minStockSupply?: number;
+}
+type CreateOrderItemType = "product" | "shipping" | "billing" | "discount-coupon" | "volume-discount" | "gift" | "gift-certificate" | "generic-item" | "service" | "deposit";
+interface CreateOrderItem {
+    readonly itemType: CreateOrderItemType;
+    readonly productGuid?: string;
+    /** Product/variant code – max 64 chars */
+    readonly code?: string;
+    /** Item name – max 250 chars */
+    readonly name?: string;
+    readonly variantName?: string;
+    readonly brand?: string;
+    readonly supplierName?: string;
+    readonly remark?: string;
+    readonly warrantyDescription?: string;
+    readonly additionalField?: string;
+    /** Quantity, e.g. "1.000" */
+    readonly amount?: string;
+    /** Unit, e.g. "ks" – max 16 chars */
+    readonly amountUnit?: string;
+    readonly weight?: string;
+    readonly priceRatio?: string;
+    /** VAT rate, e.g. "21.00" */
+    readonly vatRate?: string;
+    /** Total item price with VAT */
+    readonly itemPriceWithVat?: string;
+    /** Total item price without VAT */
+    readonly itemPriceWithoutVat?: string;
+    /** Unit price with VAT */
+    readonly unitPriceWithVat?: string;
+    /** Unit price without VAT */
+    readonly unitPriceWithoutVat?: string;
+    readonly buyPriceWithVat?: string;
+    readonly buyPriceWithoutVat?: string;
+    readonly buyPriceVatRate?: string;
+    readonly statusId?: number;
+    readonly amountCompleted?: string;
+    readonly recyclingFeeId?: number;
+    readonly consumptionTaxId?: number;
+}
+interface CreateOrderAddress {
+    readonly company?: string;
+    readonly fullName?: string;
+    readonly street?: string;
+    readonly streetWithNr?: string;
+    readonly houseNumber?: string;
+    readonly city?: string;
+    readonly district?: string;
+    readonly additional?: string;
+    readonly zip?: string;
+    readonly countryCode?: string;
+    readonly regionName?: string;
+    readonly regionShortcut?: string;
+    readonly companyId?: string;
+    readonly vatId?: string;
+    readonly taxId?: string;
+}
+interface CreateOrderCurrency {
+    readonly code: string;
+    readonly exchangeRate?: string;
+}
+interface CreateOrderRequest {
+    /** ISO 8601 datetime */
+    readonly creationTime?: string;
+    /** Order code – max 10 chars, must be unique */
+    readonly code?: string;
+    readonly language?: string;
+    /** External system identifier – max 255 chars, required & unique */
+    readonly externalCode: string;
+    readonly cashDeskOrder?: boolean;
+    readonly statusId?: number;
+    readonly sourceId?: number | null;
+    readonly salesChannelGuid?: string | null;
+    /** Customer email – max 100 chars */
+    readonly email?: string;
+    /** Phone – max 32 chars */
+    readonly phone?: string | null;
+    readonly birthDate?: string | null;
+    readonly vatPayer?: boolean;
+    readonly paymentMethodGuid?: string | null;
+    readonly shippingGuid?: string | null;
+    readonly shippingDetails?: Record<string, unknown> | null;
+    readonly paid?: boolean | null;
+    readonly billingMethodCode?: number;
+    readonly clientIPAddress?: string | null;
+    readonly customerGuid?: string | null;
+    readonly billingAddress?: CreateOrderAddress;
+    readonly addressesEqual?: boolean | null;
+    readonly deliveryAddress?: CreateOrderAddress | null;
+    readonly notes?: Record<string, unknown> | null;
+    readonly stockId?: number;
+    readonly currency: CreateOrderCurrency;
+    readonly vatMode?: "Normal" | "One Stop Shop" | "Reverse charge" | "Outside the EU";
+    readonly items: ReadonlyArray<CreateOrderItem>;
+}
+interface CreateOrderOptions {
+    readonly suppressDocumentGeneration?: boolean;
+    readonly suppressEmailSending?: boolean;
+    readonly suppressProductChecking?: boolean;
+    readonly suppressStockMovements?: boolean;
+    readonly suppressHistoricalMandatoryFields?: boolean;
+    readonly suppressHistoricalPaymentChecking?: boolean;
+    readonly suppressHistoricalShippingChecking?: boolean;
+}
+interface ShoptetApiResponse<T> {
+    readonly data: T;
+    readonly errors: ReadonlyArray<ShoptetError> | null;
+}
+interface ShoptetError {
+    readonly errorCode: string;
+    readonly instance: string;
+    readonly message: string;
+}
+
+interface ShoptetCredentials {
+    readonly oauthAccessToken: string;
+    readonly apiUrl: string;
+    readonly webhookSecret: string;
+}
+interface ShoptetClientOptions {
+    /** Maximum items per batch request. Shoptet API hard limit is 300. Default: 300. */
+    readonly maxBatchSize?: number;
+    /** Request timeout in milliseconds. Default: 30000. */
+    readonly timeoutMs?: number;
+}
+type BatchUpdateResult = {
+    readonly success: number;
+    readonly failed: number;
+    readonly errors: ReadonlyArray<{
+        readonly code: string;
+        readonly error: string;
+    }>;
+};
+type ShoptetClient = ReturnType<typeof createShoptetClient>;
+declare const createShoptetClient: (credentials: ShoptetCredentials, options?: ShoptetClientOptions) => {
+    validateWebhookSignature: (payload: string, signature: string) => boolean;
+    getOrder: (orderCode: string) => Promise<Result<ShoptetOrder>>;
+    getDefaultStockId: () => Promise<Result<number>>;
+    batchUpdateStock: (items: Array<{
+        productCode: string;
+        quantity: number;
+    }>) => Promise<Result<BatchUpdateResult>>;
+    getDefaultPricelistId: () => Promise<Result<number>>;
+    batchUpdatePrices: (items: Array<{
+        code: string;
+        price: number;
+    }>) => Promise<Result<BatchUpdateResult>>;
+    createOrder: (order: CreateOrderRequest, orderOptions?: CreateOrderOptions) => Promise<Result<ShoptetOrder>>;
+};
+
+export { type BatchUpdateResult, type CreateOrderAddress, type CreateOrderCurrency, type CreateOrderItem, type CreateOrderItemType, type CreateOrderOptions, type CreateOrderRequest, type ItemType, type ShoptetAddress, type ShoptetApiResponse, type ShoptetClient, type ShoptetClientOptions, type ShoptetCredentials, type ShoptetCustomer, type ShoptetError, type ShoptetEventType, type ShoptetOrder, type ShoptetOrderItem, type ShoptetOrderStatus, type ShoptetPaymentMethod, type ShoptetPrice, type ShoptetShippingMethod, type ShoptetStockItem, type ShoptetWebhookPayload, createShoptetClient };