@zippendo/sdk 1.2.3 → 1.2.5

package/docs/CreateOrderChannelWebhookSecret201Response.md

@@ -0,0 +1,38 @@
+
+# CreateOrderChannelWebhookSecret201Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`secret` | string
+`webhookUrl` | string
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { CreateOrderChannelWebhookSecret201Response } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "secret": zwhs_XeVJ1n8vJZbJ0N3mYQ2fV0dK9cA5tR7uW4pL6sH8gB0,
+  "webhookUrl": https://api.zippendo.com/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
+  "createdAt": 2026-09-02T14:30Z,
+} satisfies CreateOrderChannelWebhookSecret201Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateOrderChannelWebhookSecret201Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateOrderRequest.md

@@ -17,6 +17,8 @@ Name | Type
 `totalAmount` | number
 `currency` | string
 `notes` | string
+`shippingRuleId` | string
+`shippingMethodTitle` | string
 `externalData` | { [key: string]: any; }
 
 ## Example
@@ -37,6 +39,8 @@ const example = {
   "totalAmount": 1047,
   "currency": DKK,
   "notes": Leave at front desk,
+  "shippingRuleId": clz9k2f0a0007abcd2468qrst,
+  "shippingMethodTitle": GLS Hjemmelevering,
   "externalData": null,
 } satisfies CreateOrderRequest
 

package/docs/GetOrderChannelWebhookStatus200Response.md

@@ -0,0 +1,38 @@
+
+# GetOrderChannelWebhookStatus200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`webhookUrl` | string
+`webhooks` | [Array<GetOrderChannelWebhookStatus200ResponseWebhooksInner>](GetOrderChannelWebhookStatus200ResponseWebhooksInner.md)
+
+## Example
+
+```typescript
+import type { GetOrderChannelWebhookStatus200Response } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": true,
+  "webhookUrl": https://api.zippendo.dk/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
+  "webhooks": null,
+} satisfies GetOrderChannelWebhookStatus200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetOrderChannelWebhookStatus200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetOrderChannelWebhookStatus200ResponseWebhooksInner.md

@@ -0,0 +1,44 @@
+
+# GetOrderChannelWebhookStatus200ResponseWebhooksInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`topic` | string
+`address` | string
+`createdAt` | string
+`deliveryUrl` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { GetOrderChannelWebhookStatus200ResponseWebhooksInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 1234567890,
+  "topic": ORDERS_CREATE,
+  "address": https://api.zippendo.dk/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
+  "createdAt": 2026-06-22T14:30:00.000Z,
+  "deliveryUrl": https://api.zippendo.dk/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
+  "status": active,
+} satisfies GetOrderChannelWebhookStatus200ResponseWebhooksInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetOrderChannelWebhookStatus200ResponseWebhooksInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListAvailableCarriers200ResponseInner.md

@@ -17,6 +17,8 @@ Name | Type
 `optionalFields` | [Array<ListAvailableCarriers200ResponseInnerRequiredFieldsInner>](ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md)
 `deprecated` | boolean
 `deprecationMessage` | string
+`generatesCustomsDocuments` | boolean
+`generatesCommercialInvoice` | boolean
 
 ## Example
 
@@ -36,6 +38,8 @@ const example = {
   "optionalFields": null,
   "deprecated": true,
   "deprecationMessage": The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.,
+  "generatesCustomsDocuments": true,
+  "generatesCommercialInvoice": true,
 } satisfies ListAvailableCarriers200ResponseInner
 
 console.log(example)

package/docs/ListCarriers200ResponseDataInner.md

@@ -18,6 +18,8 @@ Name | Type
 `brandColor` | string
 `deprecated` | boolean
 `deprecationMessage` | string
+`generatesCustomsDocuments` | boolean
+`generatesCommercialInvoice` | boolean
 
 ## Example
 
@@ -38,6 +40,8 @@ const example = {
   "brandColor": #005BAA,
   "deprecated": true,
   "deprecationMessage": The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.,
+  "generatesCustomsDocuments": true,
+  "generatesCommercialInvoice": true,
 } satisfies ListCarriers200ResponseDataInner
 
 console.log(example)

package/docs/ListOrderChannels200Response.md

@@ -0,0 +1,42 @@
+
+# ListOrderChannels200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ListOrderChannels200ResponseDataInner>](ListOrderChannels200ResponseDataInner.md)
+`total` | number
+`page` | number
+`limit` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { ListOrderChannels200Response } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "total": 137,
+  "page": 1,
+  "limit": 20,
+  "totalPages": 7,
+} satisfies ListOrderChannels200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListOrderChannels200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListOrderChannels200ResponseDataInner.md

@@ -0,0 +1,60 @@
+
+# ListOrderChannels200ResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`type` | string
+`enabled` | boolean
+`brandId` | string
+`hasCredentials` | boolean
+`settings` | [ListOrderChannels200ResponseDataInnerSettings](ListOrderChannels200ResponseDataInnerSettings.md)
+`webhooksEnabled` | boolean
+`lastSyncAt` | Date
+`lastSyncError` | string
+`shippingRuleIds` | Array<string>
+`orgId` | string
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { ListOrderChannels200ResponseDataInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": clz9k2f0a0001abcd1234efgh,
+  "name": Anna's Shopify Store,
+  "type": shopify,
+  "enabled": true,
+  "brandId": brnd_8f3kd92ld0,
+  "hasCredentials": true,
+  "settings": null,
+  "webhooksEnabled": true,
+  "lastSyncAt": 2026-06-22T14:30Z,
+  "lastSyncError": Invalid API credentials,
+  "shippingRuleIds": ["clz9k2f0a0002abcd5678ijkl"],
+  "orgId": clz9k2f0a0000abcd0000zzzz,
+  "createdAt": 2026-06-22T14:30:00.000Z,
+  "updatedAt": 2026-06-22T14:30:00.000Z,
+} satisfies ListOrderChannels200ResponseDataInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListOrderChannels200ResponseDataInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListOrderChannels200ResponseDataInnerSettings.md

@@ -0,0 +1,67 @@
+
+# ListOrderChannels200ResponseDataInnerSettings
+
+Channel settings (webhook secret and checkout token hash omitted).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`useWebhooks` | boolean
+`webhookId` | string
+`webhookIds` | Array<number>
+`webhookSecretCreatedAt` | Date
+`siteUrl` | string
+`autoFulfill` | boolean
+`checkoutTokenCreatedAt` | Date
+`autoSync` | boolean
+`syncIntervalMinutes` | number
+`autoShipOnCreate` | boolean
+`defaultCarrierId` | string
+`defaultProductId` | string
+`defaultAddressId` | string
+`shippingMethodMappings` | [Array<ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner>](ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.md)
+`syncOnlyUnfulfilled` | boolean
+`syncOrdersSince` | Date
+`servicePointCount` | number
+
+## Example
+
+```typescript
+import type { ListOrderChannels200ResponseDataInnerSettings } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "useWebhooks": true,
+  "webhookId": gid://shopify/WebhookSubscription/12345,
+  "webhookIds": [12,13,14],
+  "webhookSecretCreatedAt": 2026-06-22T14:30Z,
+  "siteUrl": https://butik.dk,
+  "autoFulfill": true,
+  "checkoutTokenCreatedAt": 2026-06-22T14:30Z,
+  "autoSync": false,
+  "syncIntervalMinutes": 15,
+  "autoShipOnCreate": false,
+  "defaultCarrierId": clz9k2f0a0006abcd1357yzab,
+  "defaultProductId": postnord-home-delivery,
+  "defaultAddressId": clz9k2f0a0005abcd7890uvwx,
+  "shippingMethodMappings": [{"match":"GLS Hjemmelevering","shippingRuleId":"clz9k2f0a0007abcd2468qrst"}],
+  "syncOnlyUnfulfilled": true,
+  "syncOrdersSince": 2026-05-22T00:00Z,
+  "servicePointCount": 6,
+} satisfies ListOrderChannels200ResponseDataInnerSettings
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListOrderChannels200ResponseDataInnerSettings
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.md

@@ -0,0 +1,38 @@
+
+# ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`match` | string
+`shippingRuleId` | string
+`servicePointSelection` | string
+
+## Example
+
+```typescript
+import type { ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "match": GLS Hjemmelevering,
+  "shippingRuleId": clz9k2f0a0007abcd2468qrst,
+  "servicePointSelection": nearest,
+} satisfies ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+