@soda-sync/app-sdk

Enumerations

• FilterOperation
• PatchOperation

Classes

• PageNumberConverter

Interfaces

• AppConfiguration
• AppDetails
• AppDocs
• Context
• FeaturePairDetector
• FormField
• Hooks
• HttpClient
• Integration
• KeyValueSet
• Logger
• OAuth2Client
• OrderProvider
• OrderRequester
• OrdersUpdateConsumer
• OrdersUpdateSupplier
• ProductProvider
• ProductRequester
• ProductsUpdateConsumer
• ProductsUpdateSupplier
• PushProductsConsumer
• PushProductsSupplier
• ReadonlyKeyValueSet
• SetupStep
• SingleOrderProvider
• SingleOrderRequester

Type Aliases

AddressDto

Ƭ AddressDto: z.infer<typeof ZAddressDto>

Defined in

src/contracts/orders/address-dto.ts:19

---

AppAuthor

Ƭ AppAuthor: z.infer<typeof ZAppAuthor>

Defined in

src/sdk/app-author.ts:11

---

AppFactory

Ƭ AppFactory: (feature?: AppFeature) => Integration | Integration & AppFeatureMapping[AppFeature]

Type declaration

▸ (feature?): Integration | Integration & AppFeatureMapping[AppFeature]

Parameters

Name	Type
feature?	AppFeature

Returns

Integration | Integration & AppFeatureMapping[AppFeature]

Defined in

src/sdk/types.ts:47

---

AppFeature

Ƭ AppFeature: keyof AppFeatureMapping

Defined in

src/sdk/types.ts:45

---

AppFeatureMapping

Ƭ AppFeatureMapping: Object

Type declaration

Name	Type
order-provide	SingleOrderProvider
order-request	SingleOrderRequester
orders-provide	OrderProvider
orders-request	OrderRequester
orders-update-consume	OrdersUpdateConsumer
orders-update-supply	OrdersUpdateSupplier
products-consume	PushProductsConsumer
products-provide	ProductProvider
products-request	ProductRequester
products-supply	PushProductsSupplier
products-update-consume	ProductsUpdateConsumer
products-update-supply	ProductsUpdateSupplier

Defined in

src/sdk/types.ts:30

---

AppVersion

Ƭ AppVersion: z.infer<typeof ZAppVersion>

Defined in

src/sdk/types.ts:20

---

AttributeValues

Ƭ AttributeValues: z.infer<typeof ZAttributeValues>

Defined in

src/contracts/common/model/attribute-values-type.ts:9

---

AuthRequest

Ƭ AuthRequest: z.infer<typeof ZAuthRequest>

Defined in

src/contracts/oauth/model/auth-request.ts:10

---

CustomerDto

Ƭ CustomerDto: z.infer<typeof ZCustomerDto>

Defined in

src/contracts/orders/customer-dto.ts:12

---

DateTimeString

Ƭ DateTimeString: z.infer<typeof ZDateTimeString>

Defined in

src/sdk/types.ts:28

---

FeatureTrigger

Ƭ FeatureTrigger: Object

Type declaration

Name	Type
sourceFeature	AppFeature
targetFeature	AppFeature
url	string

Defined in

src/sdk/types.ts:49

---

FeatureTriggers

Ƭ FeatureTriggers: FeatureTrigger[]

Defined in

src/sdk/types.ts:55

---

HttpMessage

Ƭ HttpMessage: z.infer<typeof ZHttpMessage>

Defined in

src/bindings/http/http-message.ts:8

---

HttpRequest

Ƭ HttpRequest: z.infer<typeof ZHttpRequest>

Defined in

src/bindings/http/http-request.ts:9

---

HttpResponse

Ƭ HttpResponse: z.infer<typeof ZHttpResponse>

Defined in

src/bindings/http/http-response.ts:8

---

MoneyDto

Ƭ MoneyDto: z.infer<typeof ZMoneyDto>

Defined in

src/contracts/money/model/money-dto.ts:33

---

OrderDto

Ƭ OrderDto: z.infer<typeof ZOrderDto>

Defined in

src/contracts/orders/order-dto.ts:38

---

OrderItemDto

Ƭ OrderItemDto: z.infer<typeof ZOrderItemDto>

Defined in

src/contracts/orders/order-item-dto.ts:26

---

OrderStatus

Ƭ OrderStatus: z.infer<typeof ZOrderStatus>

Defined in

src/contracts/orders/order-status.ts:5

---

OrderTransactionDto

Ƭ OrderTransactionDto: z.infer<typeof ZOrderTransactionDto>

Defined in

src/contracts/orders/order-transaction-dto.ts:21

---

OrderTransactionType

Ƭ OrderTransactionType: z.infer<typeof ZOrderTransactionType>

Defined in

src/contracts/orders/order-transaction-type.ts:5

---

PatchOrdersRequest

Ƭ PatchOrdersRequest: z.infer<typeof ZPatchOrdersRequest>

Defined in

src/contracts/orders/patch-orders-request.ts:33

---

PatchProductsRequest

Ƭ PatchProductsRequest: z.infer<typeof ZPatchProductsRequest>

Defined in

src/contracts/products/patch-products-request.ts:31

---

PaymentStatus

Ƭ PaymentStatus: z.infer<typeof ZPaymentStatus>

Defined in

src/contracts/orders/payment-status.ts:12

---

ProductAvailabilityDto

Ƭ ProductAvailabilityDto: z.infer<typeof ZProductAvailabilityDto>

Defined in

src/contracts/products/product-availability-dto.ts:14

---

ProductDto

Ƭ ProductDto: z.infer<typeof ZProductDto>

Defined in

src/contracts/products/product-dto.ts:41

---

ProductImageDto

Ƭ ProductImageDto: z.infer<typeof ZProductImageDto>

Defined in

src/contracts/products/product-image-dto.ts:12

---

ProductPushContainerDto

Ƭ ProductPushContainerDto: z.infer<typeof ZProductPushContainerDto>

Defined in

src/contracts/push-products/model/product-push-container-dto.ts:18

---

QueryOrderRequest

Ƭ QueryOrderRequest: z.infer<typeof ZQueryOrderRequest>

Defined in

src/contracts/pull-order/model/query-single-order-request.ts:12

---

QueryOrdersRequest

Ƭ QueryOrdersRequest: z.infer<typeof ZQueryOrdersRequest>

Defined in

src/contracts/pull-orders/model/query-orders-request.ts:12

---

QueryOrdersResult

Ƭ QueryOrdersResult: z.infer<typeof ZQueryOrdersResult>

Defined in

src/contracts/pull-orders/model/query-orders-result.ts:8

---

QueryProductsRequest

Ƭ QueryProductsRequest: z.infer<typeof ZQueryProductsRequest>

Defined in

src/contracts/pull-products/model/query-products-request.ts:12

---

QueryProductsResult

Ƭ QueryProductsResult: z.infer<typeof ZQueryProductsResult>

Defined in

src/contracts/pull-products/model/query-products-result.ts:8

---

QueryRequest

Ƭ QueryRequest: z.infer<typeof ZQueryRequest>

Defined in

src/contracts/common/model/query-request.ts:13

---

RawAddressDto

Ƭ RawAddressDto: z.input<typeof ZAddressDto>

Defined in

src/contracts/orders/address-dto.ts:20

---

RawAppAuthor

Ƭ RawAppAuthor: z.input<typeof ZAppAuthor>

Defined in

src/sdk/app-author.ts:14

---

RawAuthRequest

Ƭ RawAuthRequest: z.input<typeof ZAuthRequest>

Defined in

src/contracts/oauth/model/auth-request.ts:11

---

RawCustomerDto

Ƭ RawCustomerDto: z.input<typeof ZCustomerDto>

Defined in

src/contracts/orders/customer-dto.ts:13

---

RawHttpMessage

Ƭ RawHttpMessage: z.input<typeof ZHttpMessage>

Defined in

src/bindings/http/http-message.ts:9

---

RawHttpRequest

Ƭ RawHttpRequest: z.input<typeof ZHttpRequest>

Defined in

src/bindings/http/http-request.ts:10

---

RawHttpResponse

Ƭ RawHttpResponse: z.input<typeof ZHttpResponse>

Defined in

src/bindings/http/http-response.ts:9

---

RawMoneyDto

Ƭ RawMoneyDto: z.input<typeof ZMoneyDto>

Defined in

src/contracts/money/model/money-dto.ts:36

---

RawOrderDto

Ƭ RawOrderDto: z.input<typeof ZOrderDto>

Defined in

src/contracts/orders/order-dto.ts:39

---

RawOrderItemDto

Ƭ RawOrderItemDto: z.input<typeof ZOrderItemDto>

Defined in

src/contracts/orders/order-item-dto.ts:27

---

RawOrderTransactionDto

Ƭ RawOrderTransactionDto: z.input<typeof ZOrderTransactionDto>

Defined in

src/contracts/orders/order-transaction-dto.ts:22

---

RawPatchOrdersRequest

Ƭ RawPatchOrdersRequest: z.input<typeof ZPatchOrdersRequest>

Defined in

src/contracts/orders/patch-orders-request.ts:34

---

RawPatchProductsRequest

Ƭ RawPatchProductsRequest: z.input<typeof ZPatchProductsRequest>

Defined in

src/contracts/products/patch-products-request.ts:34

---

RawProductAvailabilityDto

Ƭ RawProductAvailabilityDto: z.input<typeof ZProductAvailabilityDto>

Defined in

src/contracts/products/product-availability-dto.ts:15

---

RawProductDto

Ƭ RawProductDto: z.input<typeof ZProductDto>

Defined in

src/contracts/products/product-dto.ts:44

---

RawProductImageDto

Ƭ RawProductImageDto: z.input<typeof ZProductImageDto>

Defined in

src/contracts/products/product-image-dto.ts:13

---

RawProductPushContainerDto

Ƭ RawProductPushContainerDto: z.input<typeof ZProductPushContainerDto>

Defined in

src/contracts/push-products/model/product-push-container-dto.ts:21

---

RawQueryOrderRequest

Ƭ RawQueryOrderRequest: z.input<typeof ZQueryOrderRequest>

Defined in

src/contracts/pull-order/model/query-single-order-request.ts:13

---

RawQueryOrdersRequest

Ƭ RawQueryOrdersRequest: z.input<typeof ZQueryOrdersRequest>

Defined in

src/contracts/pull-orders/model/query-orders-request.ts:15

---

RawQueryOrdersResult

Ƭ RawQueryOrdersResult: z.input<typeof ZQueryOrdersResult>

Defined in

src/contracts/pull-orders/model/query-orders-result.ts:11

---

RawQueryProductsRequest

Ƭ RawQueryProductsRequest: z.input<typeof ZQueryProductsRequest>

Defined in

src/contracts/pull-products/model/query-products-request.ts:15

---

RawQueryProductsResult

Ƭ RawQueryProductsResult: z.input<typeof ZQueryProductsResult>

Defined in

src/contracts/pull-products/model/query-products-result.ts:11

---

RawQueryRequest

Ƭ RawQueryRequest: z.input<typeof ZQueryRequest>

Defined in

src/contracts/common/model/query-request.ts:16

---

RawShipmentDto

Ƭ RawShipmentDto: z.input<typeof ZShipmentDto>

Defined in

src/contracts/shipments/model/shipment-dto.ts:26

---

SdkVersionT

Ƭ SdkVersionT: z.infer<typeof ZSdkVersion>

Defined in

src/sdk/types.ts:25

---

ShipmentDto

Ƭ ShipmentDto: z.infer<typeof ZShipmentDto>

Defined in

src/contracts/shipments/model/shipment-dto.ts:25

Variables

ZAddressDto

• Const ZAddressDto: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; city: ZodOptional<ZodString> ; company: ZodOptional<ZodString> ; countryCode: ZodOptional<ZodString> ; firstName: ZodOptional<ZodString> ; houseNumber: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; line2: ZodOptional<ZodString> ; state: ZodOptional<ZodString> ; street: ZodOptional<ZodString> ; surname: ZodOptional<ZodString> ; zipCode: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }>

Defined in

src/contracts/orders/address-dto.ts:4

---

ZAppAuthor

• Const ZAppAuthor: ZodObject<{ email: ZodString ; name: ZodString }, "strip", ZodTypeAny, { email?: string ; name?: string }, { email?: string ; name?: string }>

Defined in

src/sdk/app-author.ts:3

---

ZAppVersion

• Const ZAppVersion: ZodType<`${number}.${number}.${number}`, ZodTypeDef, `${number}.${number}.${number}`>

Defined in

src/sdk/types.ts:16

---

ZAttributeValues

• Const ZAttributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>>

Defined in

src/contracts/common/model/attribute-values-type.ts:3

---

ZAuthRequest

• Const ZAuthRequest: ZodObject<{ authUrl: ZodString ; state: ZodDefault<ZodRecord<ZodString, ZodString>> }, "strip", ZodTypeAny, { authUrl?: string ; state?: Record<string, string> }, { authUrl?: string ; state?: Record<string, string> }>

Defined in

src/contracts/oauth/model/auth-request.ts:3

---

ZCurrencyCode

• Const ZCurrencyCode: ZodString

Defined in

src/contracts/money/model/money-dto.ts:12

---

ZCustomerDto

• Const ZCustomerDto: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; id: ZodOptional<ZodString> ; mailAddress: ZodOptional<ZodString> ; phoneNumber: ZodOptional<ZodString> ; vatId: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; id?: string ; mailAddress?: string ; phoneNumber?: string ; vatId?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; id?: string ; mailAddress?: string ; phoneNumber?: string ; vatId?: string }>

Defined in

src/contracts/orders/customer-dto.ts:4

---

ZDateTimeString

• Const ZDateTimeString: ZodString

Defined in

src/sdk/types.ts:27

---

ZHttpMessage

• Const ZHttpMessage: ZodObject<{ body: ZodOptional<ZodString> ; headers: ZodDefault<ZodRecord<ZodString, ZodString>> }, "strip", ZodTypeAny, { body?: string ; headers?: Record<string, string> }, { body?: string ; headers?: Record<string, string> }>

Defined in

src/bindings/http/http-message.ts:3

---

ZHttpRequest

• Const ZHttpRequest: ZodObject<{ body: ZodOptional<ZodString> ; headers: ZodDefault<ZodRecord<ZodString, ZodString>> ; method: ZodString ; url: ZodString }, "strip", ZodTypeAny, { body?: string ; headers?: Record<string, string> ; method?: string ; url?: string }, { body?: string ; headers?: Record<string, string> ; method?: string ; url?: string }>

Defined in

src/bindings/http/http-request.ts:4

---

ZHttpResponse

• Const ZHttpResponse: ZodObject<{ body: ZodOptional<ZodString> ; headers: ZodDefault<ZodRecord<ZodString, ZodString>> ; statusCode: ZodNumber }, "strip", ZodTypeAny, { body?: string ; headers?: Record<string, string> ; statusCode?: number }, { body?: string ; headers?: Record<string, string> ; statusCode?: number }>

Defined in

src/bindings/http/http-response.ts:4

---

ZMoneyDto

• Const ZMoneyDto: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }>

Defined in

src/contracts/money/model/money-dto.ts:16

---

ZOrderDto

• Const ZOrderDto: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; customer: ZodOptional<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; id: ZodOptional<ZodString> ; mailAddress: ZodOptional<ZodString> ; phoneNumber: ZodOptional<ZodString> ; vatId: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; id?: string ; mailAddress?: string ; phoneNumber?: string ; vatId?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; id?: string ; mailAddress?: string ; phoneNumber?: string ; vatId?: string }>> ; deliveryAddress: ZodOptional<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; city: ZodOptional<ZodString> ; company: ZodOptional<ZodString> ; countryCode: ZodOptional<ZodString> ; firstName: ZodOptional<ZodString> ; houseNumber: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; line2: ZodOptional<ZodString> ; state: ZodOptional<ZodString> ; street: ZodOptional<ZodString> ; surname: ZodOptional<ZodString> ; zipCode: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }>> ; id: ZodString ; invoiceAddress: ZodOptional<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; city: ZodOptional<ZodString> ; company: ZodOptional<ZodString> ; countryCode: ZodOptional<ZodString> ; firstName: ZodOptional<ZodString> ; houseNumber: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; line2: ZodOptional<ZodString> ; state: ZodOptional<ZodString> ; street: ZodOptional<ZodString> ; surname: ZodOptional<ZodString> ; zipCode: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }>> ; items: ZodDefault<ZodArray<ZodObject<{ amount: ZodNumber ; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; description: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; name: ZodOptional<ZodString> ; singleGrossPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; singleNetPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; sku: ZodOptional<ZodString> ; taxRate: ZodNumber = ZTaxRate }, "strip", ZodTypeAny, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; description?: string ; id?: string ; name?: string ; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sku?: string ; taxRate?: number = ZTaxRate }, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; description?: string ; id?: string ; name?: string ; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sku?: string ; taxRate?: number = ZTaxRate }>, "many">> ; orderDate: ZodString = ZDateTimeString; orderNumber: ZodString ; paymentStatus: ZodEnum<["OPEN", "IN_PROGRESS", "PARTIALLY_PAID", "PAID", "PARTIALLY_REFUNDED", "REFUNDED"]> = ZPaymentStatus; shipments: ZodDefault<ZodArray<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; date: ZodString = ZDateTimeString; grossPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; id: ZodOptional<ZodString> ; method: ZodOptional<ZodString> ; netPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; sourceCountryCode: ZodOptional<ZodString> ; taxRate: ZodNumber = ZTaxRate }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; id?: string ; method?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sourceCountryCode?: string ; taxRate?: number = ZTaxRate }, { attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; id?: string ; method?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sourceCountryCode?: string ; taxRate?: number = ZTaxRate }>, "many">> ; status: ZodEnum<["OPEN", "CONFIRMED", "PROCESSING", "CANCELED", "COMPLETED"]> = ZOrderStatus; transactions: ZodDefault<ZodArray<ZodObject<{ amount: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; date: ZodString = ZDateTimeString; id: ZodOptional<ZodString> ; method: ZodString ; type: ZodEnum<["PAYMENT", "REFUND"]> = ZOrderTransactionType }, "strip", ZodTypeAny, { amount?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; id?: string ; method?: string ; type?: "PAYMENT" | "REFUND" = ZOrderTransactionType }, { amount?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; id?: string ; method?: string ; type?: "PAYMENT" | "REFUND" = ZOrderTransactionType }>, "many">> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; customer?: { id?: string; mailAddress?: string; phoneNumber?: string; vatId?: string; attributeValues?: Record<string, unknown>; } ; deliveryAddress?: { id?: string; company?: string; firstName?: string; surname?: string; line2?: string; street?: string; houseNumber?: string; zipCode?: string; city?: string; countryCode?: string; state?: string; attributeValues?: Record<...>; } ; id?: string ; invoiceAddress?: { id?: string; company?: string; firstName?: string; surname?: string; line2?: string; street?: string; houseNumber?: string; zipCode?: string; city?: string; countryCode?: string; state?: string; attributeValues?: Record<...>; } ; items?: { id?: string; name?: string; description?: string; sku?: string; amount?: number; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; }; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; taxRate?: number; attributeValues?: Record<...>; }[] ; orderDate?: string = ZDateTimeString; orderNumber?: string ; paymentStatus?: "OPEN" | "IN_PROGRESS" | "PARTIALLY_PAID" | "PAID" | "PARTIALLY_REFUNDED" | "REFUNDED" = ZPaymentStatus; shipments?: { id?: string; date?: string; sourceCountryCode?: string; method?: string; netPrice?: { value?: number; divisor?: number; currencyCode?: string; }; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; taxRate?: number; attributeValues?: Record<...>; }[] ; status?: "OPEN" | "CONFIRMED" | "PROCESSING" | "CANCELED" | "COMPLETED" = ZOrderStatus; transactions?: { id?: string; date?: string; type?: "PAYMENT" | "REFUND"; method?: string; amount?: { value?: number; divisor?: number; currencyCode?: string; }; attributeValues?: Record<string, unknown>; }[] }, { attributeValues?: Record<string, unknown> = ZAttributeValues; customer?: { id?: string; mailAddress?: string; phoneNumber?: string; vatId?: string; attributeValues?: Record<string, unknown>; } ; deliveryAddress?: { id?: string; company?: string; firstName?: string; surname?: string; line2?: string; street?: string; houseNumber?: string; zipCode?: string; city?: string; countryCode?: string; state?: string; attributeValues?: Record<...>; } ; id?: string ; invoiceAddress?: { id?: string; company?: string; firstName?: string; surname?: string; line2?: string; street?: string; houseNumber?: string; zipCode?: string; city?: string; countryCode?: string; state?: string; attributeValues?: Record<...>; } ; items?: { id?: string; name?: string; description?: string; sku?: string; amount?: number; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; }; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; taxRate?: number; attributeValues?: Record<...>; }[] ; orderDate?: string = ZDateTimeString; orderNumber?: string ; paymentStatus?: "OPEN" | "IN_PROGRESS" | "PARTIALLY_PAID" | "PAID" | "PARTIALLY_REFUNDED" | "REFUNDED" = ZPaymentStatus; shipments?: { id?: string; date?: string; sourceCountryCode?: string; method?: string; netPrice?: { value?: number; divisor?: number; currencyCode?: string; }; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; taxRate?: number; attributeValues?: Record<...>; }[] ; status?: "OPEN" | "CONFIRMED" | "PROCESSING" | "CANCELED" | "COMPLETED" = ZOrderStatus; transactions?: { id?: string; date?: string; type?: "PAYMENT" | "REFUND"; method?: string; amount?: { value?: number; divisor?: number; currencyCode?: string; }; attributeValues?: Record<string, unknown>; }[] }>

Defined in

src/contracts/orders/order-dto.ts:12

---

ZOrderItemDto

• Const ZOrderItemDto: ZodObject<{ amount: ZodNumber ; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; description: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; name: ZodOptional<ZodString> ; singleGrossPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; singleNetPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; sku: ZodOptional<ZodString> ; taxRate: ZodNumber = ZTaxRate }, "strip", ZodTypeAny, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; description?: string ; id?: string ; name?: string ; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sku?: string ; taxRate?: number = ZTaxRate }, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; description?: string ; id?: string ; name?: string ; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sku?: string ; taxRate?: number = ZTaxRate }>

Defined in

src/contracts/orders/order-item-dto.ts:6

---

ZOrderStatus

• Const ZOrderStatus: ZodEnum<["OPEN", "CONFIRMED", "PROCESSING", "CANCELED", "COMPLETED"]>

Defined in

src/contracts/orders/order-status.ts:3

---

ZOrderTransactionDto

• Const ZOrderTransactionDto: ZodObject<{ amount: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; date: ZodString = ZDateTimeString; id: ZodOptional<ZodString> ; method: ZodString ; type: ZodEnum<["PAYMENT", "REFUND"]> = ZOrderTransactionType }, "strip", ZodTypeAny, { amount?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; id?: string ; method?: string ; type?: "PAYMENT" | "REFUND" = ZOrderTransactionType }, { amount?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; id?: string ; method?: string ; type?: "PAYMENT" | "REFUND" = ZOrderTransactionType }>

Defined in

src/contracts/orders/order-transaction-dto.ts:7

---

ZOrderTransactionType

• Const ZOrderTransactionType: ZodEnum<["PAYMENT", "REFUND"]>

Defined in

src/contracts/orders/order-transaction-type.ts:3

---

ZPatchOperation

• Const ZPatchOperation: ZodNativeEnum<typeof PatchOperation>

Defined in

src/contracts/common/model/data-patching.ts:51

---

ZPatchOrdersRequest

• Const ZPatchOrdersRequest: ZodObject<{ fields: ZodArray<ZodUnion<[ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Remove> }, "strip", ZodTypeAny, { field?: string ; operation?: Remove }, { field?: string ; operation?: Remove }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Append> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Append ; value?: unknown }, { field?: string ; operation?: Append ; value?: unknown }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Set> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Set ; value?: unknown }, { field?: string ; operation?: Set ; value?: unknown }>]>, "atleastone"> ; filters: ZodArray<ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodNativeEnum<typeof FilterOperation> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: FilterOperation ; value?: unknown }, { field?: string ; operation?: FilterOperation ; value?: unknown }>, "atleastone"> }, "strip", ZodTypeAny, { fields?: [{ field?: string; operation?: PatchOperation.Remove; } | { field?: string ; operation?: Append ; value?: unknown } | { field?: string ; operation?: Set ; value?: unknown }, ...(({ field?: string; operation?: PatchOperation.Remove; }) | Object | Object)[]] ; filters?: [{ field?: string ; operation?: FilterOperation ; value?: unknown }, ...Object[]] }, { fields?: [{ field?: string; operation?: PatchOperation.Remove; } | { field?: string ; operation?: Append ; value?: unknown } | { field?: string ; operation?: Set ; value?: unknown }, ...(({ field?: string; operation?: PatchOperation.Remove; }) | Object | Object)[]] ; filters?: [{ field?: string ; operation?: FilterOperation ; value?: unknown }, ...Object[]] }>

Defined in

src/contracts/orders/patch-orders-request.ts:6

---

ZPatchProductsRequest

• Const ZPatchProductsRequest: ZodObject<{ fields: ZodArray<ZodUnion<[ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Remove> }, "strip", ZodTypeAny, { field?: string ; operation?: Remove }, { field?: string ; operation?: Remove }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Append> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Append ; value?: unknown }, { field?: string ; operation?: Append ; value?: unknown }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Set> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Set ; value?: unknown }, { field?: string ; operation?: Set ; value?: unknown }>]>, "atleastone"> ; filters: ZodArray<ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodNativeEnum<typeof FilterOperation> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: FilterOperation ; value?: unknown }, { field?: string ; operation?: FilterOperation ; value?: unknown }>, "atleastone"> }, "strip", ZodTypeAny, { fields?: [{ field?: string; operation?: PatchOperation.Remove; } | { field?: string ; operation?: Append ; value?: unknown } | { field?: string ; operation?: Set ; value?: unknown }, ...(({ field?: string; operation?: PatchOperation.Remove; }) | Object | Object)[]] ; filters?: [{ field?: string ; operation?: FilterOperation ; value?: unknown }, ...Object[]] }, { fields?: [{ field?: string; operation?: PatchOperation.Remove; } | { field?: string ; operation?: Append ; value?: unknown } | { field?: string ; operation?: Set ; value?: unknown }, ...(({ field?: string; operation?: PatchOperation.Remove; }) | Object | Object)[]] ; filters?: [{ field?: string ; operation?: FilterOperation ; value?: unknown }, ...Object[]] }>

Defined in

src/contracts/products/patch-products-request.ts:6

---

ZPaymentStatus

• Const ZPaymentStatus: ZodEnum<["OPEN", "IN_PROGRESS", "PARTIALLY_PAID", "PAID", "PARTIALLY_REFUNDED", "REFUNDED"]>

Defined in

src/contracts/orders/payment-status.ts:3

---

ZProductAvailabilityDto

• Const ZProductAvailabilityDto: ZodObject<{ amount: ZodNumber ; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; stockId: ZodOptional<ZodString> ; stockName: ZodOptional<ZodString> }, "strip", ZodTypeAny, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }>

Defined in

src/contracts/products/product-availability-dto.ts:4

---

ZProductDto

• Const ZProductDto: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; availability: ZodDefault<ZodArray<ZodObject<{ amount: ZodNumber ; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; stockId: ZodOptional<ZodString> ; stockName: ZodOptional<ZodString> }, "strip", ZodTypeAny, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }>, "many">> ; description: ZodOptional<ZodString> ; details: ZodDefault<ZodRecord<ZodString, ZodString>> ; grossPrice: ZodOptional<ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }>> ; gtin: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; images: ZodDefault<ZodArray<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; isDefault: ZodOptional<ZodBoolean> ; url: ZodString }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }>, "many">> ; manufacturer: ZodOptional<ZodString> ; name: ZodString ; netPrice: ZodOptional<ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }>> ; sku: ZodOptional<ZodString> ; taxRate: ZodOptional<ZodNumber> ; variationParentId: ZodOptional<ZodString> ; weightInGrams: ZodOptional<ZodNumber> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; availability?: { amount?: number; stockId?: string; stockName?: string; attributeValues?: Record<string, unknown>; }[] ; description?: string ; details?: Record<string, string> ; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; gtin?: string ; id?: string ; images?: { url?: string; isDefault?: boolean; attributeValues?: Record<string, unknown>; }[] ; manufacturer?: string ; name?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; sku?: string ; taxRate?: number ; variationParentId?: string ; weightInGrams?: number }, { attributeValues?: Record<string, unknown> = ZAttributeValues; availability?: { amount?: number; stockId?: string; stockName?: string; attributeValues?: Record<string, unknown>; }[] ; description?: string ; details?: Record<string, string> ; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; gtin?: string ; id?: string ; images?: { url?: string; isDefault?: boolean; attributeValues?: Record<string, unknown>; }[] ; manufacturer?: string ; name?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; sku?: string ; taxRate?: number ; variationParentId?: string ; weightInGrams?: number }>

Defined in

src/contracts/products/product-dto.ts:8

---

ZProductImageDto

• Const ZProductImageDto: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; isDefault: ZodOptional<ZodBoolean> ; url: ZodString }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }>

Defined in

src/contracts/products/product-image-dto.ts:4

---

ZProductPushContainerDto

• Const ZProductPushContainerDto: ZodObject<{ product: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; availability: ZodDefault<ZodArray<ZodObject<{ amount: ZodNumber ; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; stockId: ZodOptional<ZodString> ; stockName: ZodOptional<ZodString> }, "strip", ZodTypeAny, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }>, "many">> ; description: ZodOptional<ZodString> ; details: ZodDefault<ZodRecord<ZodString, ZodString>> ; grossPrice: ZodOptional<ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }>> ; gtin: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; images: ZodDefault<ZodArray<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; isDefault: ZodOptional<ZodBoolean> ; url: ZodString }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }>, "many">> ; manufacturer: ZodOptional<ZodString> ; name: ZodString ; netPrice: ZodOptional<ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }>> ; sku: ZodOptional<ZodString> ; taxRate: ZodOptional<ZodNumber> ; variationParentId: ZodOptional<ZodString> ; weightInGrams: ZodOptional<ZodNumber> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; availability?: { amount?: number; stockId?: string; stockName?: string; attributeValues?: Record<string, unknown>; }[] ; description?: string ; details?: Record<string, string> ; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; gtin?: string ; id?: string ; images?: { url?: string; isDefault?: boolean; attributeValues?: Record<string, unknown>; }[] ; manufacturer?: string ; name?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; sku?: string ; taxRate?: number ; variationParentId?: string ; weightInGrams?: number }, { attributeValues?: Record<string, unknown> = ZAttributeValues; availability?: { amount?: number; stockId?: string; stockName?: string; attributeValues?: Record<string, unknown>; }[] ; description?: string ; details?: Record<string, string> ; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; gtin?: string ; id?: string ; images?: { url?: string; isDefault?: boolean; attributeValues?: Record<string, unknown>; }[] ; manufacturer?: string ; name?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; sku?: string ; taxRate?: number ; variationParentId?: string ; weightInGrams?: number }> = ZProductDto; sourceId: ZodOptional<ZodString> }, "strip", ZodTypeAny, { product?: { id?: string; variationParentId?: string; name?: string; description?: string; manufacturer?: string; netPrice?: { value?: number; divisor?: number; currencyCode?: string; }; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; ... 7 more ...; attributeValues?: Record<...>; } = ZProductDto; sourceId?: string }, { product?: { id?: string; variationParentId?: string; name?: string; description?: string; manufacturer?: string; netPrice?: { value?: number; divisor?: number; currencyCode?: string; }; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; ... 7 more ...; attributeValues?: Record<...>; } = ZProductDto; sourceId?: string }>

Defined in

src/contracts/push-products/model/product-push-container-dto.ts:5

---

ZQueryOrderRequest

• Const ZQueryOrderRequest: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; filters: ZodArray<ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodNativeEnum<typeof FilterOperation> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: FilterOperation ; value?: unknown }, { field?: string ; operation?: FilterOperation ; value?: unknown }>, "many"> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; filters?: { field?: string ; operation?: FilterOperation ; value?: unknown }[] }, { attributeValues?: Record<string, unknown> = ZAttributeValues; filters?: { field?: string ; operation?: FilterOperation ; value?: unknown }[] }>

Defined in

src/contracts/pull-order/model/query-single-order-request.ts:6

---

ZQueryOrdersRequest

• Const ZQueryOrdersRequest: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; filters: ZodArray<ZodObject<{ value: ZodUnknown; field: ZodEnum<[string, ...string[]]>; operation: ZodNativeEnum<typeof FilterOperation>; }, "strip", ZodTypeAny, { value?: unknown; field?: string; operation?: FilterOperation; }, { value?: unknown; field?: string; operation?: FilterOperation; }>, "many"> ; pageSize: ZodNumber ; pageToken: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; filters?: { value?: unknown; field?: string; operation?: FilterOperation; }[] ; pageSize?: number ; pageToken?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; filters?: { value?: unknown; field?: string; operation?: FilterOperation; }[] ; pageSize?: number ; pageToken?: string }>

Defined in

src/contracts/pull-orders/model/query-orders-request.ts:6

---

ZQueryOrdersResult

• Const ZQueryOrdersResult: ZodObject<{ data: ZodArray<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; customer: ZodOptional<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; id: ZodOptional<ZodString> ; mailAddress: ZodOptional<ZodString> ; phoneNumber: ZodOptional<ZodString> ; vatId: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; id?: string ; mailAddress?: string ; phoneNumber?: string ; vatId?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; id?: string ; mailAddress?: string ; phoneNumber?: string ; vatId?: string }>> ; deliveryAddress: ZodOptional<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; city: ZodOptional<ZodString> ; company: ZodOptional<ZodString> ; countryCode: ZodOptional<ZodString> ; firstName: ZodOptional<ZodString> ; houseNumber: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; line2: ZodOptional<ZodString> ; state: ZodOptional<ZodString> ; street: ZodOptional<ZodString> ; surname: ZodOptional<ZodString> ; zipCode: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }>> ; id: ZodString ; invoiceAddress: ZodOptional<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; city: ZodOptional<ZodString> ; company: ZodOptional<ZodString> ; countryCode: ZodOptional<ZodString> ; firstName: ZodOptional<ZodString> ; houseNumber: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; line2: ZodOptional<ZodString> ; state: ZodOptional<ZodString> ; street: ZodOptional<ZodString> ; surname: ZodOptional<ZodString> ; zipCode: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string }>> ; items: ZodDefault<ZodArray<ZodObject<{ amount: ZodNumber ; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; description: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; name: ZodOptional<ZodString> ; singleGrossPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; singleNetPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; sku: ZodOptional<ZodString> ; taxRate: ZodNumber = ZTaxRate }, "strip", ZodTypeAny, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; description?: string ; id?: string ; name?: string ; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sku?: string ; taxRate?: number = ZTaxRate }, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; description?: string ; id?: string ; name?: string ; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sku?: string ; taxRate?: number = ZTaxRate }>, "many">> ; orderDate: ZodString = ZDateTimeString; orderNumber: ZodString ; paymentStatus: ZodEnum<["OPEN", "IN_PROGRESS", "PARTIALLY_PAID", "PAID", "PARTIALLY_REFUNDED", "REFUNDED"]> = ZPaymentStatus; shipments: ZodDefault<ZodArray<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; date: ZodString = ZDateTimeString; grossPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; id: ZodOptional<ZodString> ; method: ZodOptional<ZodString> ; netPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; sourceCountryCode: ZodOptional<ZodString> ; taxRate: ZodNumber = ZTaxRate }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; id?: string ; method?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sourceCountryCode?: string ; taxRate?: number = ZTaxRate }, { attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; id?: string ; method?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sourceCountryCode?: string ; taxRate?: number = ZTaxRate }>, "many">> ; status: ZodEnum<["OPEN", "CONFIRMED", "PROCESSING", "CANCELED", "COMPLETED"]> = ZOrderStatus; transactions: ZodDefault<ZodArray<ZodObject<{ amount: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; date: ZodString = ZDateTimeString; id: ZodOptional<ZodString> ; method: ZodString ; type: ZodEnum<["PAYMENT", "REFUND"]> = ZOrderTransactionType }, "strip", ZodTypeAny, { amount?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; id?: string ; method?: string ; type?: "PAYMENT" | "REFUND" = ZOrderTransactionType }, { amount?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; id?: string ; method?: string ; type?: "PAYMENT" | "REFUND" = ZOrderTransactionType }>, "many">> }, UnknownKeysParam, ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; customer?: { attributeValues?: Record<string, unknown> = ZAttributeValues; id?: string ; mailAddress?: string ; phoneNumber?: string ; vatId?: string } ; deliveryAddress?: { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string } ; id?: string ; invoiceAddress?: { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string } ; items?: { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; description?: string ; id?: string ; name?: string ; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sku?: string ; taxRate?: number = ZTaxRate }[] ; orderDate?: string = ZDateTimeString; orderNumber?: string ; paymentStatus?: "OPEN" | "IN_PROGRESS" | "PARTIALLY_PAID" | "PAID" | "PARTIALLY_REFUNDED" | "REFUNDED" = ZPaymentStatus; shipments?: { attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; id?: string ; method?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sourceCountryCode?: string ; taxRate?: number = ZTaxRate }[] ; status?: "OPEN" | "CONFIRMED" | "PROCESSING" | "CANCELED" | "COMPLETED" = ZOrderStatus; transactions?: { amount?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; id?: string ; method?: string ; type?: "PAYMENT" | "REFUND" = ZOrderTransactionType }[] }, { attributeValues?: Record<string, unknown> = ZAttributeValues; customer?: { attributeValues?: Record<string, unknown> = ZAttributeValues; id?: string ; mailAddress?: string ; phoneNumber?: string ; vatId?: string } ; deliveryAddress?: { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string } ; id?: string ; invoiceAddress?: { attributeValues?: Record<string, unknown> = ZAttributeValues; city?: string ; company?: string ; countryCode?: string ; firstName?: string ; houseNumber?: string ; id?: string ; line2?: string ; state?: string ; street?: string ; surname?: string ; zipCode?: string } ; items?: { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; description?: string ; id?: string ; name?: string ; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sku?: string ; taxRate?: number = ZTaxRate }[] ; orderDate?: string = ZDateTimeString; orderNumber?: string ; paymentStatus?: "OPEN" | "IN_PROGRESS" | "PARTIALLY_PAID" | "PAID" | "PARTIALLY_REFUNDED" | "REFUNDED" = ZPaymentStatus; shipments?: { attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; id?: string ; method?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sourceCountryCode?: string ; taxRate?: number = ZTaxRate }[] ; status?: "OPEN" | "CONFIRMED" | "PROCESSING" | "CANCELED" | "COMPLETED" = ZOrderStatus; transactions?: { amount?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; id?: string ; method?: string ; type?: "PAYMENT" | "REFUND" = ZOrderTransactionType }[] }>, "many"> ; nextPageToken: ZodOptional<ZodString> ; pageSize: ZodNumber ; pageToken: ZodOptional<ZodString> }, "strip", ZodTypeAny, { data?: { attributeValues?: Record<string, unknown> = ZAttributeValues; customer?: { id?: string; mailAddress?: string; phoneNumber?: string; vatId?: string; attributeValues?: Record<string, unknown>; } ; deliveryAddress?: { id?: string; company?: string; firstName?: string; surname?: string; line2?: string; street?: string; houseNumber?: string; zipCode?: string; city?: string; countryCode?: string; state?: string; attributeValues?: Record<...>; } ; id?: string ; invoiceAddress?: { id?: string; company?: string; firstName?: string; surname?: string; line2?: string; street?: string; houseNumber?: string; zipCode?: string; city?: string; countryCode?: string; state?: string; attributeValues?: Record<...>; } ; items?: { id?: string; name?: string; description?: string; sku?: string; amount?: number; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; }; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; taxRate?: number; attributeValues?: Record<...>; }[] ; orderDate?: string = ZDateTimeString; orderNumber?: string ; paymentStatus?: "OPEN" | "IN_PROGRESS" | "PARTIALLY_PAID" | "PAID" | "PARTIALLY_REFUNDED" | "REFUNDED" = ZPaymentStatus; shipments?: { id?: string; date?: string; sourceCountryCode?: string; method?: string; netPrice?: { value?: number; divisor?: number; currencyCode?: string; }; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; taxRate?: number; attributeValues?: Record<...>; }[] ; status?: "OPEN" | "CONFIRMED" | "PROCESSING" | "CANCELED" | "COMPLETED" = ZOrderStatus; transactions?: { id?: string; date?: string; type?: "PAYMENT" | "REFUND"; method?: string; amount?: { value?: number; divisor?: number; currencyCode?: string; }; attributeValues?: Record<string, unknown>; }[] }[] ; nextPageToken?: string ; pageSize?: number ; pageToken?: string }, { data?: { attributeValues?: Record<string, unknown> = ZAttributeValues; customer?: { id?: string; mailAddress?: string; phoneNumber?: string; vatId?: string; attributeValues?: Record<string, unknown>; } ; deliveryAddress?: { id?: string; company?: string; firstName?: string; surname?: string; line2?: string; street?: string; houseNumber?: string; zipCode?: string; city?: string; countryCode?: string; state?: string; attributeValues?: Record<...>; } ; id?: string ; invoiceAddress?: { id?: string; company?: string; firstName?: string; surname?: string; line2?: string; street?: string; houseNumber?: string; zipCode?: string; city?: string; countryCode?: string; state?: string; attributeValues?: Record<...>; } ; items?: { id?: string; name?: string; description?: string; sku?: string; amount?: number; singleNetPrice?: { value?: number; divisor?: number; currencyCode?: string; }; singleGrossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; taxRate?: number; attributeValues?: Record<...>; }[] ; orderDate?: string = ZDateTimeString; orderNumber?: string ; paymentStatus?: "OPEN" | "IN_PROGRESS" | "PARTIALLY_PAID" | "PAID" | "PARTIALLY_REFUNDED" | "REFUNDED" = ZPaymentStatus; shipments?: { id?: string; date?: string; sourceCountryCode?: string; method?: string; netPrice?: { value?: number; divisor?: number; currencyCode?: string; }; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; }; taxRate?: number; attributeValues?: Record<...>; }[] ; status?: "OPEN" | "CONFIRMED" | "PROCESSING" | "CANCELED" | "COMPLETED" = ZOrderStatus; transactions?: { id?: string; date?: string; type?: "PAYMENT" | "REFUND"; method?: string; amount?: { value?: number; divisor?: number; currencyCode?: string; }; attributeValues?: Record<string, unknown>; }[] }[] ; nextPageToken?: string ; pageSize?: number ; pageToken?: string }>

Defined in

src/contracts/pull-orders/model/query-orders-result.ts:5

---

ZQueryProductsRequest

• Const ZQueryProductsRequest: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; filters: ZodArray<ZodObject<{ value: ZodUnknown; field: ZodEnum<[string, ...string[]]>; operation: ZodNativeEnum<typeof FilterOperation>; }, "strip", ZodTypeAny, { value?: unknown; field?: string; operation?: FilterOperation; }, { value?: unknown; field?: string; operation?: FilterOperation; }>, "many"> ; pageSize: ZodNumber ; pageToken: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; filters?: { value?: unknown; field?: string; operation?: FilterOperation; }[] ; pageSize?: number ; pageToken?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; filters?: { value?: unknown; field?: string; operation?: FilterOperation; }[] ; pageSize?: number ; pageToken?: string }>

Defined in

src/contracts/pull-products/model/query-products-request.ts:6

---

ZQueryProductsResult

• Const ZQueryProductsResult: ZodObject<{ data: ZodArray<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; availability: ZodDefault<ZodArray<ZodObject<{ amount: ZodNumber ; attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; stockId: ZodOptional<ZodString> ; stockName: ZodOptional<ZodString> }, "strip", ZodTypeAny, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }, { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }>, "many">> ; description: ZodOptional<ZodString> ; details: ZodDefault<ZodRecord<ZodString, ZodString>> ; grossPrice: ZodOptional<ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }>> ; gtin: ZodOptional<ZodString> ; id: ZodOptional<ZodString> ; images: ZodDefault<ZodArray<ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; isDefault: ZodOptional<ZodBoolean> ; url: ZodString }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }>, "many">> ; manufacturer: ZodOptional<ZodString> ; name: ZodString ; netPrice: ZodOptional<ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }>> ; sku: ZodOptional<ZodString> ; taxRate: ZodOptional<ZodNumber> ; variationParentId: ZodOptional<ZodString> ; weightInGrams: ZodOptional<ZodNumber> }, UnknownKeysParam, ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; availability?: { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }[] ; description?: string ; details?: Record<string, string> ; grossPrice?: { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit } ; gtin?: string ; id?: string ; images?: { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }[] ; manufacturer?: string ; name?: string ; netPrice?: { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit } ; sku?: string ; taxRate?: number ; variationParentId?: string ; weightInGrams?: number }, { attributeValues?: Record<string, unknown> = ZAttributeValues; availability?: { amount?: number ; attributeValues?: Record<string, unknown> = ZAttributeValues; stockId?: string ; stockName?: string }[] ; description?: string ; details?: Record<string, string> ; grossPrice?: { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit } ; gtin?: string ; id?: string ; images?: { attributeValues?: Record<string, unknown> = ZAttributeValues; isDefault?: boolean ; url?: string }[] ; manufacturer?: string ; name?: string ; netPrice?: { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit } ; sku?: string ; taxRate?: number ; variationParentId?: string ; weightInGrams?: number }>, "many"> ; nextPageToken: ZodOptional<ZodString> ; pageSize: ZodNumber ; pageToken: ZodOptional<ZodString> }, "strip", ZodTypeAny, { data?: { attributeValues?: Record<string, unknown> = ZAttributeValues; availability?: { amount?: number; stockId?: string; stockName?: string; attributeValues?: Record<string, unknown>; }[] ; description?: string ; details?: Record<string, string> ; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; gtin?: string ; id?: string ; images?: { url?: string; isDefault?: boolean; attributeValues?: Record<string, unknown>; }[] ; manufacturer?: string ; name?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; sku?: string ; taxRate?: number ; variationParentId?: string ; weightInGrams?: number }[] ; nextPageToken?: string ; pageSize?: number ; pageToken?: string }, { data?: { attributeValues?: Record<string, unknown> = ZAttributeValues; availability?: { amount?: number; stockId?: string; stockName?: string; attributeValues?: Record<string, unknown>; }[] ; description?: string ; details?: Record<string, string> ; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; gtin?: string ; id?: string ; images?: { url?: string; isDefault?: boolean; attributeValues?: Record<string, unknown>; }[] ; manufacturer?: string ; name?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } ; sku?: string ; taxRate?: number ; variationParentId?: string ; weightInGrams?: number }[] ; nextPageToken?: string ; pageSize?: number ; pageToken?: string }>

Defined in

src/contracts/pull-products/model/query-products-result.ts:5

---

ZQueryRequest

• Const ZQueryRequest: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; pageSize: ZodNumber ; pageToken: ZodOptional<ZodString> }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; pageSize?: number ; pageToken?: string }, { attributeValues?: Record<string, unknown> = ZAttributeValues; pageSize?: number ; pageToken?: string }>

Defined in

src/contracts/common/model/query-request.ts:4

---

ZSdkVersion

• Const ZSdkVersion: ZodType<`${number}.${number}.${number}` | `${number}.${number}.${number}-${string}.${number}`, ZodTypeDef, `${number}.${number}.${number}` | `${number}.${number}.${number}-${string}.${number}`>

Defined in

src/sdk/types.ts:22

---

ZShipmentDto

• Const ZShipmentDto: ZodObject<{ attributeValues: ZodDefault<ZodRecord<ZodString, ZodUnknown>> = ZAttributeValues; date: ZodString = ZDateTimeString; grossPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; id: ZodOptional<ZodString> ; method: ZodOptional<ZodString> ; netPrice: ZodObject<{ currencyCode: ZodOptional<ZodString> ; divisor: ZodNumber ; value: ZodNumber = ZSmallestCurrencyUnit }, "strip", ZodTypeAny, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }, { currencyCode?: string ; divisor?: number ; value?: number = ZSmallestCurrencyUnit }> = ZMoneyDto; sourceCountryCode: ZodOptional<ZodString> ; taxRate: ZodNumber = ZTaxRate }, "strip", ZodTypeAny, { attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; id?: string ; method?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sourceCountryCode?: string ; taxRate?: number = ZTaxRate }, { attributeValues?: Record<string, unknown> = ZAttributeValues; date?: string = ZDateTimeString; grossPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; id?: string ; method?: string ; netPrice?: { value?: number; divisor?: number; currencyCode?: string; } = ZMoneyDto; sourceCountryCode?: string ; taxRate?: number = ZTaxRate }>

Defined in

src/contracts/shipments/model/shipment-dto.ts:7

---

ZSmallestCurrencyUnit

• Const ZSmallestCurrencyUnit: ZodNumber

Defined in

src/contracts/money/model/money-dto.ts:9

---

ZTaxRate

• Const ZTaxRate: ZodNumber

Defined in

src/contracts/money/model/tax-rate-dto.ts:3

Functions

enforce

▸ enforce<T>(val): T

Enforce a specific type for an inline value.

Type parameters

Name
T

Parameters

Name	Type	Description
val	T	The value

Returns

T

The value

Defined in

src/sdk/types.ts:115

---

zAppendPatcher

▸ zAppendPatcher<T>(obj): ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Append> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Append ; value?: unknown }, { field?: string ; operation?: Append ; value?: unknown }>

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Append> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Append ; value?: unknown }, { field?: string ; operation?: Append ; value?: unknown }>

Defined in

src/contracts/common/model/data-patching.ts:60

---

zField

▸ zField<T>(obj, arrayDeepInclude): ZodObject<{ field: ZodEnum<[string, ...string[]]> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; value?: unknown }, { field?: string ; value?: unknown }>

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>
arrayDeepInclude	boolean

Returns

ZodObject<{ field: ZodEnum<[string, ...string[]]> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; value?: unknown }, { field?: string ; value?: unknown }>

Defined in

src/sdk/types.ts:88

---

zFilter

▸ zFilter<T>(obj): ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodNativeEnum<typeof FilterOperation> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: FilterOperation ; value?: unknown }, { field?: string ; operation?: FilterOperation ; value?: unknown }>

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodNativeEnum<typeof FilterOperation> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: FilterOperation ; value?: unknown }, { field?: string ; operation?: FilterOperation ; value?: unknown }>

Defined in

src/sdk/types.ts:96

---

zFilterArray

▸ zFilterArray<T>(obj): ZodArray<ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodNativeEnum<typeof FilterOperation> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: FilterOperation ; value?: unknown }, { field?: string ; operation?: FilterOperation ; value?: unknown }>, "many">

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodArray<ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodNativeEnum<typeof FilterOperation> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: FilterOperation ; value?: unknown }, { field?: string ; operation?: FilterOperation ; value?: unknown }>, "many">

Defined in

src/sdk/types.ts:102

---

zNonEmptyFilterArray

▸ zNonEmptyFilterArray<T>(obj): ZodArray<ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodNativeEnum<typeof FilterOperation> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: FilterOperation ; value?: unknown }, { field?: string ; operation?: FilterOperation ; value?: unknown }>, "atleastone">

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodArray<ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodNativeEnum<typeof FilterOperation> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: FilterOperation ; value?: unknown }, { field?: string ; operation?: FilterOperation ; value?: unknown }>, "atleastone">

Defined in

src/sdk/types.ts:106

---

zObjectPropertyPath

▸ zObjectPropertyPath<T>(obj, arrayDeepInclude): ZodEnum<[string, ...string[]]>

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>
arrayDeepInclude	boolean

Returns

ZodEnum<[string, ...string[]]>

Defined in

src/sdk/types.ts:57

---

zPatcher

▸ zPatcher<T>(obj): ZodUnion<[ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Remove> }, "strip", ZodTypeAny, { field?: string ; operation?: Remove }, { field?: string ; operation?: Remove }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Append> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Append ; value?: unknown }, { field?: string ; operation?: Append ; value?: unknown }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Set> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Set ; value?: unknown }, { field?: string ; operation?: Set ; value?: unknown }>]>

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodUnion<[ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Remove> }, "strip", ZodTypeAny, { field?: string ; operation?: Remove }, { field?: string ; operation?: Remove }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Append> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Append ; value?: unknown }, { field?: string ; operation?: Append ; value?: unknown }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Set> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Set ; value?: unknown }, { field?: string ; operation?: Set ; value?: unknown }>]>

Defined in

src/contracts/common/model/data-patching.ts:72

---

zPatcherArray

▸ zPatcherArray<T>(obj): ZodArray<ZodUnion<[ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Remove> }, "strip", ZodTypeAny, { field?: string ; operation?: Remove }, { field?: string ; operation?: Remove }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Append> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Append ; value?: unknown }, { field?: string ; operation?: Append ; value?: unknown }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Set> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Set ; value?: unknown }, { field?: string ; operation?: Set ; value?: unknown }>]>, "atleastone">

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodArray<ZodUnion<[ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Remove> }, "strip", ZodTypeAny, { field?: string ; operation?: Remove }, { field?: string ; operation?: Remove }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Append> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Append ; value?: unknown }, { field?: string ; operation?: Append ; value?: unknown }>, ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Set> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Set ; value?: unknown }, { field?: string ; operation?: Set ; value?: unknown }>]>, "atleastone">

Defined in

src/contracts/common/model/data-patching.ts:80

---

zQueryResult

▸ zQueryResult<T>(obj): ZodObject<{ data: ZodArray<ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>, "many"> ; nextPageToken: ZodOptional<ZodString> ; pageSize: ZodNumber ; pageToken: ZodOptional<ZodString> }, "strip", ZodTypeAny, { data?: { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }[] ; nextPageToken?: string ; pageSize?: number ; pageToken?: string }, { data?: { [k in string | number | symbol]: baseObjectInputType<T>[k] }[] ; nextPageToken?: string ; pageSize?: number ; pageToken?: string }>

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodObject<{ data: ZodArray<ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>, "many"> ; nextPageToken: ZodOptional<ZodString> ; pageSize: ZodNumber ; pageToken: ZodOptional<ZodString> }, "strip", ZodTypeAny, { data?: { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }[] ; nextPageToken?: string ; pageSize?: number ; pageToken?: string }, { data?: { [k in string | number | symbol]: baseObjectInputType<T>[k] }[] ; nextPageToken?: string ; pageSize?: number ; pageToken?: string }>

Defined in

src/contracts/common/model/query-result.ts:3

---

zRemovePatcher

▸ zRemovePatcher<T>(obj): ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Remove> }, "strip", ZodTypeAny, { field?: string ; operation?: Remove }, { field?: string ; operation?: Remove }>

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Remove> }, "strip", ZodTypeAny, { field?: string ; operation?: Remove }, { field?: string ; operation?: Remove }>

Defined in

src/contracts/common/model/data-patching.ts:53

---

zSetPatcher

▸ zSetPatcher<T>(obj): ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Set> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Set ; value?: unknown }, { field?: string ; operation?: Set ; value?: unknown }>

Type parameters

Name	Type
T	extends ZodRawShape

Parameters

Name	Type
obj	ZodObject<T, UnknownKeysParam, ZodTypeAny, { [k in string | number | symbol]: addQuestionMarks<baseObjectOutputType<T>, requiredKeys<baseObjectOutputType<T>>>[k] }, { [k in string | number | symbol]: baseObjectInputType<T>[k] }>

Returns

ZodObject<{ field: ZodEnum<[string, ...string[]]> ; operation: ZodLiteral<Set> ; value: ZodUnknown }, "strip", ZodTypeAny, { field?: string ; operation?: Set ; value?: unknown }, { field?: string ; operation?: Set ; value?: unknown }>

Defined in

src/contracts/common/model/data-patching.ts:66