Zippendo TypeScript SDK

https://github.com/zippendo/zippendo-typescript
Admin
Official TypeScript/JavaScript SDK for the Zippendo shipping and logistics API, letting developers...
Tokens:765,205
Snippets:1,803
Trust Score:7.5
License:MIT
Update:6 days ago
Show doc for...
Tokens:
Raw
### CreateOrgWebhookRequest usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/CreateOrgWebhookRequest.md

Example of creating a CreateOrgWebhookRequest object with the required properties: name, url, events, isActive, and brandId. The code imports the type from '@zippendo/sdk', constructs an example object, and demonstrates converting it to and from a JSON string. Note that the example values are placeholders and should be updated with actual data.

```typescript
import type { CreateOrgWebhookRequest } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "name": Order fulfilment notifier,
  "url": https://hooks.example.dk/zippendo,
  "events": ["shipment.created","tracking.updated"],
  "isActive": true,
  "brandId": brnd_8f3kd92ld0,
} satisfies CreateOrgWebhookRequest

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 CreateOrgWebhookRequest
console.log(exampleParsed)
```

--------------------------------

### ListOrgWebhooks200ResponseDataInner usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListOrgWebhooks200ResponseDataInner.md

Shows how to import the type, create an example object, and convert it to and from JSON. The example object uses placeholder values that should be updated with actual data.

```typescript
import type { ListOrgWebhooks200ResponseDataInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": wh_clx1a2b3c4,
  "name": Order fulfilment notifier,
  "url": https://hooks.example.dk/zippendo,
  "events": ["shipment.created"],
  "isActive": true,
  "brandId": brnd_8f3kd92ld0,
  "createdAt": 2026-06-01T09:30:00.000Z,
  "updatedAt": 2026-06-10T11:15:00.000Z,
} satisfies ListOrgWebhooks200ResponseDataInner

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 ListOrgWebhooks200ResponseDataInner
console.log(exampleParsed)
```

--------------------------------

### CreateShipment201ResponseLogsInner usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/CreateShipment201ResponseLogsInner.md

Shows how to import the CreateShipment201ResponseLogsInner type from @zippendo/sdk, create an example object with placeholder values, and convert it to/from JSON. The example object uses a satisfies clause to enforce the type. Note that the values in the example are placeholders and should be updated with actual data.

```typescript
import type { CreateShipment201ResponseLogsInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": log_6f7a8b9c,
  "direction": outbound,
  "request": null,
  "response": null,
  "statusCode": 200,
  "error": Connection timed out,
  "duration": 342,
  "createdAt": 2026-06-22T14:30:00.000Z,
} satisfies CreateShipment201ResponseLogsInner

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 CreateShipment201ResponseLogsInner
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.md

Shows how to create and use an instance of the ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner type from the @zippendo/sdk. The example includes a TODO to update the object with actual values, then demonstrates converting the instance to a JSON string and parsing it back.

```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)
```

--------------------------------

### TypeScript example for ListShippingRules200ResponseDataInnerReturnShippingRule

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListShippingRules200ResponseDataInnerReturnShippingRule.md

Shows how to import the type, create an example object, convert it to JSON, and parse it back. The object uses placeholder values that should be updated with actual data. The example logs the object, its JSON string, and the parsed result to the console.

```typescript
import type { ListShippingRules200ResponseDataInnerReturnShippingRule } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": rule_01HZX9K2QF,
  "name": Retur DK,
} satisfies ListShippingRules200ResponseDataInnerReturnShippingRule

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 ListShippingRules200ResponseDataInnerReturnShippingRule
console.log(exampleParsed)
```

--------------------------------

### UpdateOrg200Response usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/UpdateOrg200Response.md

Shows how to import the UpdateOrg200Response type from '@zippendo/sdk', create an example object that satisfies it, and convert it to and from a JSON string. The example object includes placeholder values that should be replaced with actual data.

```typescript
import type { UpdateOrg200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": org_4d8af01qw2,
  "name": Nordic Logistics ApS,
  "slug": nordic-logistics,
  "description": Parcel and freight logistics across the Nordics,
  "currency": DKK,
  "vatNumber": DK12345678,
  "billingEmail": billing@nordic-logistics.dk,
  "companyName": Nordic Logistics ApS,
  "addressLine1": Havnegade 12,
  "addressLine2": 3. sal,
  "city": København,
  "postalCode": 1058,
  "country": DK,
  "customs": {"eori":"DK12345678"},
  "createdAt": 2026-06-22T14:30:00.000Z,
  "updatedAt": 2026-06-22T14:30:00.000Z,
} satisfies UpdateOrg200Response

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 UpdateOrg200Response
console.log(exampleParsed)
```

--------------------------------

### ListApiTokens401Response TypeScript Example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListApiTokens401Response.md

Shows how to import the ListApiTokens401Response type from '@zippendo/sdk', create an example object satisfying the type, and convert it to and from JSON. The example object uses placeholder values for code, error, and message properties.

```typescript
import type { ListApiTokens401Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "code": CARRIER_GLS_WRONG_ADDRESS,
  "error": Bad Request,
  "message": Failed to create address,
} satisfies ListApiTokens401Response

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 ListApiTokens401Response
console.log(exampleParsed)
```

--------------------------------

### GetOrgBranding200Response TypeScript Example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/GetOrgBranding200Response.md

Shows how to import and use the GetOrgBranding200Response type from @zippendo/sdk. The example creates an object with primaryColor, secondaryColor, and logoUrl properties, then demonstrates converting it to JSON and parsing it back.

```typescript
import type { GetOrgBranding200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "primaryColor": #1D4ED8,
  "secondaryColor": #F59E0B,
  "logoUrl": /orgs/org_123/branding/logo,
} satisfies GetOrgBranding200Response

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 GetOrgBranding200Response
console.log(exampleParsed)
```

--------------------------------

### VerifyApiToken200Response TypeScript usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/VerifyApiToken200Response.md

Shows how to import the VerifyApiToken200Response type from '@zippendo/sdk', create an example object with placeholder values, and convert it to/from JSON. The example object uses 'satisfies' to ensure type compatibility. Note that the values like 'tok_6e2fa83ij9' and dates are placeholders and should be replaced with actual data.

```typescript
import type { VerifyApiToken200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "valid": true,
  "tokenId": tok_6e2fa83ij9,
  "userId": usr_9f3kd92ld0,
  "orgId": org_4d8af01qw2,
  "scopes": ["read:shipments"],
  "expiresAt": 2026-09-20T14:30:00.000Z,
} satisfies VerifyApiToken200Response

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 VerifyApiToken200Response
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for ListShippingRules200ResponseDataInnerConditionsInner

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListShippingRules200ResponseDataInnerConditionsInner.md

Shows how to create and use a ListShippingRules200ResponseDataInnerConditionsInner object with the @zippendo/sdk. The example includes a TODO to update the object with actual values, then logs the object, converts it to a JSON string, and parses it back.

```typescript
import type { ListShippingRules200ResponseDataInnerConditionsInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "type": weight,
  "min": 0,
  "max": 499,
  "shippingPrice": 39,
  "currency": DKK,
  "priceType": total,
  "operator": gte,
  "value": 3,
} satisfies ListShippingRules200ResponseDataInnerConditionsInner

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 ListShippingRules200ResponseDataInnerConditionsInner
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for GetBillingUsage200ResponseCurrentPeriod

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/GetBillingUsage200ResponseCurrentPeriod.md

Shows how to import the type, create an example object, convert it to JSON, and parse it back. The object uses placeholder values for start and end dates.

```typescript
import type { GetBillingUsage200ResponseCurrentPeriod } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "start": 2026-06-01T00:00:00.000Z,
  "end": 2026-07-01T00:00:00.000Z,
} satisfies GetBillingUsage200ResponseCurrentPeriod

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 GetBillingUsage200ResponseCurrentPeriod
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for ListCarrierProducts200ResponseInnerAdditionalParametersInner

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInner.md

Shows how to create and use an instance of the ListCarrierProducts200ResponseInnerAdditionalParametersInner type from the @zippendo/sdk. The example object includes placeholder values for properties such as name, key, type, options, description, isRequired, and requiredService. It demonstrates converting the instance to a JSON string and parsing it back.

```typescript
import type { ListCarrierProducts200ResponseInnerAdditionalParametersInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "name": Return Mode,
  "key": returnFunctionality,
  "type": enum,
  "options": null,
  "description": Instruction shown to the delivery driver,
  "isRequired": false,
  "requiredService": null,
} satisfies ListCarrierProducts200ResponseInnerAdditionalParametersInner

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 ListCarrierProducts200ResponseInnerAdditionalParametersInner
console.log(exampleParsed)
```

--------------------------------

### ListOrderChannels200Response TypeScript Example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListOrderChannels200Response.md

Shows how to import and use the ListOrderChannels200Response type from the @zippendo/sdk. The example creates an object with placeholder values, logs it, converts it to JSON, and parses it back. Update the object with actual values before use.

```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)
```

--------------------------------

### ListOrgWebhooks200Response TypeScript Example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListOrgWebhooks200Response.md

Shows how to create and use a ListOrgWebhooks200Response object with the @zippendo/sdk. The example includes a placeholder object, conversion to JSON, and parsing back to the type.

```typescript
import type { ListOrgWebhooks200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "data": null,
  "total": 137,
  "page": 1,
  "limit": 20,
  "totalPages": 7,
} satisfies ListOrgWebhooks200Response

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 ListOrgWebhooks200Response
console.log(exampleParsed)
```

--------------------------------

### ConnectCarrierRequest usage example in TypeScript

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ConnectCarrierRequest.md

Example of creating a ConnectCarrierRequest object with the required properties: name, carrierSlug, config, and brandId. The code imports the type from '@zippendo/sdk', creates an example object, and demonstrates converting it to and from a JSON string. The example object uses placeholder values that should be updated with actual data.

```typescript
import type { ConnectCarrierRequest } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "name": PostNord,
  "carrierSlug": postnord,
  "config": {"customerNumber":"123456"},
  "brandId": brnd_8f3kd92ld0,
} satisfies ConnectCarrierRequest

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 ConnectCarrierRequest
console.log(exampleParsed)
```

--------------------------------

### CreateShippingQuote400Response usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/CreateShippingQuote400Response.md

Shows how to import the CreateShippingQuote400Response type from @zippendo/sdk, create an example object, convert it to JSON, and parse it back. The example object uses placeholder values for the error and message properties.

```typescript
import type { CreateShippingQuote400Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "error": Bad Request,
  "message": Invalid destination country,
} satisfies CreateShippingQuote400Response

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 CreateShippingQuote400Response
console.log(exampleParsed)
```

--------------------------------

### CreateOrgWebhook201Response example usage

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/CreateOrgWebhook201Response.md

Shows how to import and use the CreateOrgWebhook201Response type from the Zippendo SDK. The example creates an object with sample values, logs it, converts it to a JSON string, and parses it back. The object uses the `satisfies` operator to ensure type conformance.

```typescript
import type { CreateOrgWebhook201Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": wh_clx1a2b3c4,
  "name": Order fulfilment notifier,
  "url": https://hooks.example.dk/zippendo,
  "secret": whsec_8f3a1c2b9d4e5f6a,
  "events": ["shipment.created"],
  "isActive": true,
  "brandId": brnd_8f3kd92ld0,
  "createdAt": 2026-06-01T09:30:00.000Z,
  "updatedAt": 2026-06-10T11:15:00.000Z,
} satisfies CreateOrgWebhook201Response

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 CreateOrgWebhook201Response
console.log(exampleParsed)
```

--------------------------------

### CreateOrderChannelWebhookSecret201Response TypeScript Example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/CreateOrderChannelWebhookSecret201Response.md

Shows how to import and use the CreateOrderChannelWebhookSecret201Response type from the @zippendo/sdk. The example creates an object with secret, webhookUrl, and createdAt fields, then converts it to JSON and back. Note that the values in the example are placeholders and should be updated with actual data.

```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)
```

--------------------------------

### ListCarriers200ResponseDataInner usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListCarriers200ResponseDataInner.md

Example of using the ListCarriers200ResponseDataInner type from @zippendo/sdk. It creates an example object, logs it, converts it to a JSON string, and parses it back. The object includes placeholder values that should be updated with actual data.

```typescript
import type { ListCarriers200ResponseDataInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": carr_01HZX9K2QF,
  "name": PostNord,
  "carrierSlug": postnord,
  "config": {"customerNumber":"123456"},
  "orgId": org_01HZX9K2QF,
  "brandId": brnd_8f3kd92ld0,
  "createdAt": 2026-06-22T09:00:00.000Z,
  "updatedAt": 2026-06-22T09:00:00.000Z,
  "logo": https://cdn.zippendo.com/logos/postnord.svg,
  "brandColor": #005BAA,
  "deprecated": true,
  "deprecationMessage": The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.,
  "beta": true,
  "generatesCustomsDocuments": true,
  "generatesCommercialInvoice": true,
} satisfies ListCarriers200ResponseDataInner

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 ListCarriers200ResponseDataInner
console.log(exampleParsed)
```

--------------------------------

### SplitShipmentParcel200Response usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/SplitShipmentParcel200Response.md

Example showing how to import the SplitShipmentParcel200Response type from '@zippendo/sdk', create an object with a placeholder 'shipment' property, and convert it to and from JSON. The 'shipment' property is of type CreateShipment201Response and is set to null in the example, which should be updated with actual values.

```typescript
import type { SplitShipmentParcel200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "shipment": null,
} satisfies SplitShipmentParcel200Response

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 SplitShipmentParcel200Response
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for ListShipments200ResponseDataInnerCarrierSettings

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListShipments200ResponseDataInnerCarrierSettings.md

Shows how to create and use a ListShipments200ResponseDataInnerCarrierSettings object with the @zippendo/sdk. The example includes a TODO to update the object with actual values, then logs the object, converts it to a JSON string, and parses it back.

```typescript
import type { ListShipments200ResponseDataInnerCarrierSettings } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "carrierId": car_pn_001,
  "productId": prod_mypack_home,
  "services": ["A7"],
  "additionalParameters": {"notificationEmail":"anna@example.dk"},
} satisfies ListShipments200ResponseDataInnerCarrierSettings

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 ListShipments200ResponseDataInnerCarrierSettings
console.log(exampleParsed)
```

--------------------------------

### RevokeApiToken200Response usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/RevokeApiToken200Response.md

Example showing how to import the RevokeApiToken200Response type from '@zippendo/sdk', create an object satisfying it, convert to JSON, and parse back. The message property is a string, and the example uses a placeholder value that should be updated with actual data.

```typescript
import type { RevokeApiToken200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "message": Operation completed successfully,
} satisfies RevokeApiToken200Response

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 RevokeApiToken200Response
console.log(exampleParsed)
```

--------------------------------

### ListApiTokens200ResponseDataInnerCreatedBy usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListApiTokens200ResponseDataInnerCreatedBy.md

Shows how to import the ListApiTokens200ResponseDataInnerCreatedBy type from '@zippendo/sdk', create an example object with id, name, and email fields, and convert it to/from JSON. The example object uses placeholder values that should be updated with actual data.

```typescript
import type { ListApiTokens200ResponseDataInnerCreatedBy } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": usr_9f3kd92ld0,
  "name": Anna Jensen,
  "email": anna@example.dk,
} satisfies ListApiTokens200ResponseDataInnerCreatedBy

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 ListApiTokens200ResponseDataInnerCreatedBy
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for ListCarrierProducts200ResponseInner

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListCarrierProducts200ResponseInner.md

Shows how to create and use a ListCarrierProducts200ResponseInner object with the @zippendo/sdk. The example includes placeholder values and demonstrates converting the object to JSON and back.

```typescript
import type { ListCarrierProducts200ResponseInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "name": PostNord MyPack Home,
  "productId": PNL13,
  "type": outbound,
  "description": "Home delivery within Denmark",
  "availableCountries": null,
  "availableSenderCountries": null,
  "isServicePoint": false,
  "isPickupAvailable": true,
  "services": null,
  "additionalParameters": null,
  "weightLimits": null,
} satisfies ListCarrierProducts200ResponseInner

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 ListCarrierProducts200ResponseInner
console.log(exampleParsed)
```

--------------------------------

### CreateShipment201ResponsePickupDetails usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/CreateShipment201ResponsePickupDetails.md

Example of using the CreateShipment201ResponsePickupDetails type from the @zippendo/sdk package. It creates an object with date, from, to, and instruction properties, then demonstrates converting it to a JSON string and parsing it back. The date and time values in the example are placeholders that should be updated with actual values.

```typescript
import type { CreateShipment201ResponsePickupDetails } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "date": 2026-06-22,
  "from": 08:00:00,
  "to": 16:00:00,
  "instruction": Ring the bell at the loading dock.,
} satisfies CreateShipment201ResponsePickupDetails

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 CreateShipment201ResponsePickupDetails
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for GetOrderChannelWebhookStatus200Response

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/GetOrderChannelWebhookStatus200Response.md

Shows how to create and use a GetOrderChannelWebhookStatus200Response object with the @zippendo/sdk. The example includes a TODO to update the object with actual values, and demonstrates converting the instance to a JSON string and parsing it back.

```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)
```

--------------------------------

### ListOrders200Response TypeScript usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListOrders200Response.md

Shows how to import the ListOrders200Response type from '@zippendo/sdk', create an example object satisfying the type, convert it to a JSON string, and parse it back. The example object includes placeholder values for the data, total, page, limit, and totalPages properties.

```typescript
import type { ListOrders200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "data": null,
  "total": 137,
  "page": 1,
  "limit": 20,
  "totalPages": 7,
} satisfies ListOrders200Response

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 ListOrders200Response
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for BatchSendShipments200ResponseResultsInner

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/BatchSendShipments200ResponseResultsInner.md

Shows how to import the type, create an example object, convert it to JSON, and parse it back. The object uses placeholder values that should be updated with actual data.

```typescript
import type { BatchSendShipments200ResponseResultsInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "shipmentId": shp_01H8XABC123,
  "status": sent,
  "code": CARRIER_ERROR,
  "message": Shipment must be in pending or error status to be sent,
  "errors": null,
} satisfies BatchSendShipments200ResponseResultsInner

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 BatchSendShipments200ResponseResultsInner
console.log(exampleParsed)
```

--------------------------------

### CheckBrandSlug200Response TypeScript Example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/CheckBrandSlug200Response.md

Example usage of the CheckBrandSlug200Response type from the @zippendo/sdk package. The object uses the satisfies operator to enforce the type, then demonstrates converting to and from JSON. The slug property is shown as a string and available as a boolean, but the example values need to be updated with actual data.

```typescript
import type { CheckBrandSlug200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "slug": acme,
  "available": true,
} satisfies CheckBrandSlug200Response

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 CheckBrandSlug200Response
console.log(exampleParsed)
```

--------------------------------

### ListOrderChannels200ResponseDataInner usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListOrderChannels200ResponseDataInner.md

Example of using the ListOrderChannels200ResponseDataInner type from the @zippendo/sdk. The object is defined with placeholder values and satisfies the type, then converted to JSON and parsed back.

```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,
  "role": orders_and_rates,
  "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)
```

--------------------------------

### VerifyApiTokenRequest usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/VerifyApiTokenRequest.md

Shows how to import and use the VerifyApiTokenRequest type from @zippendo/sdk. The example creates an object with a token property, logs it, converts it to a JSON string, and parses it back. The token value is a placeholder that should be updated with an actual value.

```typescript
import type { VerifyApiTokenRequest } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "token": zipp_live_8f3kd92ld0a7b6c5d4e3f2a1,
} satisfies VerifyApiTokenRequest

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 VerifyApiTokenRequest
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for GetOrder200ResponseShippingRule

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/GetOrder200ResponseShippingRule.md

Shows how to create and use a GetOrder200ResponseShippingRule object with the @zippendo/sdk. The example includes a TODO to update the object with actual values, then demonstrates converting the instance to a JSON string and parsing it back.

```typescript
import type { GetOrder200ResponseShippingRule } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": rule_3c4d5e6f,
  "name": Domestic standard,
  "carrierId": car_pn_001,
  "productId": prod_mypack_home,
  "services": ["A7"],
  "addressId": addr_7e8f9a0b,
  "returnShippingRuleId": clz9k2f0a0004abcd3456qrst,
  "autoCreateReturnShipment": false,
  "autoPrintLabels": true,
  "autoPrintDocuments": false,
  "labelPrinterId": prn_label_01,
  "documentPrinterId": prn_doc_01,
} satisfies GetOrder200ResponseShippingRule

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 GetOrder200ResponseShippingRule
console.log(exampleParsed)
```

--------------------------------

### CreateShipment201ResponseActivitiesInner usage example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/CreateShipment201ResponseActivitiesInner.md

TypeScript example showing how to import the CreateShipment201ResponseActivitiesInner type from '@zippendo/sdk', create an object satisfying the type, and convert it to and from a JSON string. The object includes properties id, action, description, metadata, and createdAt. Values in the example are placeholders to be updated with actual data.

```typescript
import type { CreateShipment201ResponseActivitiesInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": act_1d2e3f4a,
  "action": created,
  "description": Shipment created,
  "metadata": null,
  "createdAt": 2026-06-22T14:30:00.000Z,
} satisfies CreateShipment201ResponseActivitiesInner

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 CreateShipment201ResponseActivitiesInner
console.log(exampleParsed)
```

--------------------------------

### TestOrgWebhook200Response TypeScript Example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/TestOrgWebhook200Response.md

Shows how to import and use the TestOrgWebhook200Response type from the @zippendo/sdk package. The example creates an object with a message property, logs it, converts it to JSON, and parses it back. The message value is a placeholder that should be updated with actual values.

```typescript
import type { TestOrgWebhook200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "message": Test event sent,
} satisfies TestOrgWebhook200Response

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 TestOrgWebhook200Response
console.log(exampleParsed)
```

--------------------------------

### createShippingQuote TypeScript example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/QuotesApi.md

Example of calling the createShippingQuote operation to calculate shipping rates. Uses bearer token authentication and the CreateShippingQuoteOperationRequest type. The example logs the response or any error.

```TypeScript
import {
  Configuration,
  QuotesApi,
} from '@zippendo/sdk';
import type { CreateShippingQuoteOperationRequest } from '@zippendo/sdk';

async function example() {
  console.log("🚀 Testing @zippendo/sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearerAuth
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new QuotesApi(config);

  const body = {
    // string | Organization ID
    orgId: org_01HZX9K2QF,
    // CreateShippingQuoteRequest
    createShippingQuoteRequest: ...,
  } satisfies CreateShippingQuoteOperationRequest;

  try {
    const data = await api.createShippingQuote(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

--------------------------------

### TypeScript example for ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.md

Shows how to import the type, create an example object, convert it to JSON, and parse it back. The example object uses placeholder values that should be updated with actual data.

```typescript
import type { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": sp_pn_4521,
  "name": Føtex Nørrebro,
  "address": Nørrebrogade 20, 2200 København N,
  "coordinates": [55.6987,12.5501],
} satisfies ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf

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 ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for ListOrgBrands200ResponseDataInner

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListOrgBrands200ResponseDataInner.md

Shows how to create and use a ListOrgBrands200ResponseDataInner object with the @zippendo/sdk. The example includes a TODO to update the object with actual values, then logs the object, converts it to a JSON string, and parses it back.

```typescript
import type { ListOrgBrands200ResponseDataInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "companyName": Acme ApS,
  "vatNumber": DK12345678,
  "customs": {"eori":"DK12345678"},
  "addressLine1": Vestergade 12,
  "addressLine2": 3. sal,
  "city": København,
  "postalCode": 1456,
  "country": DK,
  "primaryColor": #1D4ED8,
  "secondaryColor": #F59E0B,
  "id": brnd_8f3kd92ld0,
  "orgId": org_8f3kd92ld0,
  "name": Acme,
  "slug": acme,
  "useOrgCustoms": true,
  "logoUrl": /orgs/org_1/brands/brnd_1/logo,
  "archivedAt": 2026-08-05T10:00:00.000Z,
  "createdAt": 2026-06-22T14:30:00.000Z,
  "updatedAt": 2026-06-22T14:30:00.000Z,
} satisfies ListOrgBrands200ResponseDataInner

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 ListOrgBrands200ResponseDataInner
console.log(exampleParsed)
```

--------------------------------

### ListOrgBrands200Response TypeScript Example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListOrgBrands200Response.md

Example usage of the ListOrgBrands200Response type from the Zippendo SDK. It imports the type, creates an example object with a placeholder data property, and demonstrates converting it to and from a JSON string.

```typescript
import type { ListOrgBrands200Response } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "data": null,
} satisfies ListOrgBrands200Response

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 ListOrgBrands200Response
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for ListShipments200ResponseDataInner

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListShipments200ResponseDataInner.md

Shows how to import the type, create an example object, convert it to JSON, and parse it back. The object uses placeholder values and satisfies the type.

```typescript
import type { ListShipments200ResponseDataInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": shp_4d9e7a2f,
  "reference": ORDER-1042,
  "type": outbound,
  "carrierSettings": null,
  "status": pending,
  "brandId": brnd_8f3kd92ld0,
  "address": null,
  "createdAt": 2026-06-22T14:30:00.000Z,
  "updatedAt": 2026-06-22T14:30:00.000Z,
} satisfies ListShipments200ResponseDataInner

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 ListShipments200ResponseDataInner
console.log(exampleParsed)
```

--------------------------------

### CreateOrderChannelRequestSettingsShippingMethodMappingsInner TypeScript Example

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md

Example usage of the CreateOrderChannelRequestSettingsShippingMethodMappingsInner type from @zippendo/sdk. It creates an object with match, shippingRuleId, and servicePointSelection properties, then demonstrates converting it to a JSON string and parsing it back.

```typescript
import type { CreateOrderChannelRequestSettingsShippingMethodMappingsInner } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "match": GLS Hjemmelevering,
  "shippingRuleId": clz9k2f0a0007abcd2468qrst,
  "servicePointSelection": nearest,
} satisfies CreateOrderChannelRequestSettingsShippingMethodMappingsInner

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 CreateOrderChannelRequestSettingsShippingMethodMappingsInner
console.log(exampleParsed)
```

--------------------------------

### TypeScript example for ListOrders200ResponseDataInnerOrderChannel

Source: https://github.com/zippendo/zippendo-typescript/blob/main/docs/ListOrders200ResponseDataInnerOrderChannel.md

Shows how to import the type, create an example object, convert it to JSON, and parse it back. The object uses placeholder values that should be updated with actual data.

```typescript
import type { ListOrders200ResponseDataInnerOrderChannel } from '@zippendo/sdk'

// TODO: Update the object below with actual values
const example = {
  "id": clz9k2f0a0001abcd1234efgh,
  "name": Anna's Shopify Store,
  "type": shopify,
} satisfies ListOrders200ResponseDataInnerOrderChannel

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 ListOrders200ResponseDataInnerOrderChannel
console.log(exampleParsed)
```
Tokens:
Raw