@zippendo/sdk 1.0.0

package/docs/CreateShipment201Response.md

@@ -0,0 +1,80 @@
+
+# CreateShipment201Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`reference` | string
+`addressId` | string
+`servicePointId` | string
+`parties` | [Array<CreateShipment201ResponsePartiesInner>](CreateShipment201ResponsePartiesInner.md)
+`type` | string
+`carrierSettings` | [ListShipments200ResponseDataInnerCarrierSettings](ListShipments200ResponseDataInnerCarrierSettings.md)
+`parcels` | [Array<CreateShipment201ResponseParcelsInner>](CreateShipment201ResponseParcelsInner.md)
+`pickupDetails` | [CreateShipment201ResponsePickupDetails](CreateShipment201ResponsePickupDetails.md)
+`termOfTrade` | string
+`documents` | [Array<CreateShipment201ResponseDocumentsInner>](CreateShipment201ResponseDocumentsInner.md)
+`errors` | [Array<CreateShipment201ResponseErrorsInner>](CreateShipment201ResponseErrorsInner.md)
+`tracking` | [CreateShipment201ResponseTracking](CreateShipment201ResponseTracking.md)
+`status` | string
+`orgId` | string
+`orderId` | string
+`shippingRuleId` | string
+`shippingRule` | [CreateShipment201ResponseShippingRule](CreateShipment201ResponseShippingRule.md)
+`labelPrinterId` | string
+`documentPrinterId` | string
+`logs` | [Array<CreateShipment201ResponseLogsInner>](CreateShipment201ResponseLogsInner.md)
+`activities` | [Array<CreateShipment201ResponseActivitiesInner>](CreateShipment201ResponseActivitiesInner.md)
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { CreateShipment201Response } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": shp_4d9e7a2f,
+  "reference": ORDER-1042,
+  "addressId": addr_7e8f9a0b,
+  "servicePointId": sp_pn_4521,
+  "parties": null,
+  "type": outbound,
+  "carrierSettings": null,
+  "parcels": null,
+  "pickupDetails": null,
+  "termOfTrade": DAP,
+  "documents": null,
+  "errors": null,
+  "tracking": null,
+  "status": pending,
+  "orgId": org_1a2b3c4d,
+  "orderId": ord_5e6f7a8b,
+  "shippingRuleId": rule_3c4d5e6f,
+  "shippingRule": null,
+  "labelPrinterId": prn_label_01,
+  "documentPrinterId": prn_doc_01,
+  "logs": null,
+  "activities": null,
+  "createdAt": 2026-06-22T14:30:00.000Z,
+  "updatedAt": 2026-06-22T14:30:00.000Z,
+} satisfies CreateShipment201Response
+
+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 CreateShipment201Response
+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/CreateShipment201ResponseActivitiesInner.md

@@ -0,0 +1,42 @@
+
+# CreateShipment201ResponseActivitiesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`action` | string
+`description` | string
+`metadata` | any
+`createdAt` | string
+
+## Example
+
+```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)
+```
+
+[[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/CreateShipment201ResponseDocumentsInner.md

@@ -0,0 +1,48 @@
+
+# CreateShipment201ResponseDocumentsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`shipmentId` | string
+`documentType` | string
+`format` | string
+`content` | string
+`size` | string
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { CreateShipment201ResponseDocumentsInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": doc_8f3a2b1c,
+  "shipmentId": shp_4d9e7a2f,
+  "documentType": label,
+  "format": pdf,
+  "content": JVBERi0xLjQKJeLjz9MKMS...,
+  "size": 100X150,
+  "createdAt": 2026-06-22T14:30:00.000Z,
+  "updatedAt": 2026-06-22T14:30:00.000Z,
+} satisfies CreateShipment201ResponseDocumentsInner
+
+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 CreateShipment201ResponseDocumentsInner
+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/CreateShipment201ResponseErrorsInner.md

@@ -0,0 +1,42 @@
+
+# CreateShipment201ResponseErrorsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`carrier` | string
+`code` | string
+`message` | string
+`createdAt` | string
+
+## Example
+
+```typescript
+import type { CreateShipment201ResponseErrorsInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": err_2b3c4d5e,
+  "carrier": PostNord,
+  "code": INVALID_POSTAL_CODE,
+  "message": Receiver postal code is invalid for the selected product.,
+  "createdAt": 2026-06-22T14:30:00.000Z,
+} satisfies CreateShipment201ResponseErrorsInner
+
+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 CreateShipment201ResponseErrorsInner
+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/CreateShipment201ResponseLogsInner.md

@@ -0,0 +1,48 @@
+
+# CreateShipment201ResponseLogsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`direction` | string
+`request` | any
+`response` | any
+`statusCode` | number
+`error` | string
+`duration` | number
+`createdAt` | string
+
+## Example
+
+```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)
+```
+
+[[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/CreateShipment201ResponseParcelsInner.md

@@ -0,0 +1,54 @@
+
+# CreateShipment201ResponseParcelsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`weight` | number
+`weightUnit` | string
+`dimensions` | [CreateShipment201ResponseParcelsInnerDimensions](CreateShipment201ResponseParcelsInnerDimensions.md)
+`orderLines` | [Array<CreateShipment201ResponseParcelsInnerOrderLinesInner>](CreateShipment201ResponseParcelsInnerOrderLinesInner.md)
+`trackingNumber` | string
+`trackingUrl` | string
+`labelFreeCode` | string
+`qrCodeLink` | string
+`qrCodeDataUri` | string
+`qrCodeUrl` | string
+
+## Example
+
+```typescript
+import type { CreateShipment201ResponseParcelsInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": prc_5a6b7c8d,
+  "weight": 2.5,
+  "weightUnit": kg,
+  "dimensions": null,
+  "orderLines": null,
+  "trackingNumber": 00370724710000012345,
+  "trackingUrl": https://tracking.postnord.com/00370724710000012345,
+  "labelFreeCode": AB12CD34,
+  "qrCodeLink": data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
+  "qrCodeDataUri": data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
+  "qrCodeUrl": https://qr.bring.com/label-free/AB12CD34.png,
+} satisfies CreateShipment201ResponseParcelsInner
+
+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 CreateShipment201ResponseParcelsInner
+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/CreateShipment201ResponseParcelsInnerDimensions.md

@@ -0,0 +1,38 @@
+
+# CreateShipment201ResponseParcelsInnerDimensions
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`length` | number
+`width` | number
+`height` | number
+
+## Example
+
+```typescript
+import type { CreateShipment201ResponseParcelsInnerDimensions } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "length": 30,
+  "width": 20,
+  "height": 15,
+} satisfies CreateShipment201ResponseParcelsInnerDimensions
+
+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 CreateShipment201ResponseParcelsInnerDimensions
+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/CreateShipment201ResponseParcelsInnerOrderLinesInner.md

@@ -0,0 +1,52 @@
+
+# CreateShipment201ResponseParcelsInnerOrderLinesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`sku` | string
+`quantity` | number
+`description` | string
+`unitPrice` | number
+`currency` | string
+`vatPercent` | number
+`location` | string
+`countryOfOrigin` | string
+`tarrifNumber` | string
+
+## Example
+
+```typescript
+import type { CreateShipment201ResponseParcelsInnerOrderLinesInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": ol_9c1d2e3f,
+  "sku": SKU-1024,
+  "quantity": 2,
+  "description": Wool sweater, navy,
+  "unitPrice": 299.95,
+  "currency": DKK,
+  "vatPercent": 25,
+  "location": A-12-3,
+  "countryOfOrigin": DK,
+  "tarrifNumber": 61101100,
+} satisfies CreateShipment201ResponseParcelsInnerOrderLinesInner
+
+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 CreateShipment201ResponseParcelsInnerOrderLinesInner
+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/CreateShipment201ResponsePartiesInner.md

@@ -0,0 +1,54 @@
+
+# CreateShipment201ResponsePartiesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`name` | string
+`attention` | string
+`address1` | string
+`address2` | string
+`postalCode` | string
+`city` | string
+`countryCode` | string
+`email` | string
+`phone` | string
+`attributes` | [Array<CreateShipment201ResponsePartiesInnerAttributesInner>](CreateShipment201ResponsePartiesInnerAttributesInner.md)
+
+## Example
+
+```typescript
+import type { CreateShipment201ResponsePartiesInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": receiver,
+  "name": Anna Jensen,
+  "attention": Reception,
+  "address1": Vesterbrogade 12,
+  "address2": 2. sal,
+  "postalCode": 1620,
+  "city": København V,
+  "countryCode": DK,
+  "email": anna@example.dk,
+  "phone": +4520123456,
+  "attributes": null,
+} satisfies CreateShipment201ResponsePartiesInner
+
+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 CreateShipment201ResponsePartiesInner
+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/CreateShipment201ResponsePartiesInnerAttributesInner.md

@@ -0,0 +1,36 @@
+
+# CreateShipment201ResponsePartiesInnerAttributesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { CreateShipment201ResponsePartiesInnerAttributesInner } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": vatNumber,
+  "value": DK12345678,
+} satisfies CreateShipment201ResponsePartiesInnerAttributesInner
+
+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 CreateShipment201ResponsePartiesInnerAttributesInner
+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/CreateShipment201ResponsePickupDetails.md

@@ -0,0 +1,40 @@
+
+# CreateShipment201ResponsePickupDetails
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`date` | string
+`from` | string
+`to` | string
+`instruction` | string
+
+## Example
+
+```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)
+```
+
+[[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/CreateShipment201ResponseShippingRule.md

@@ -0,0 +1,56 @@
+
+# CreateShipment201ResponseShippingRule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`carrierId` | string
+`productId` | string
+`services` | Array<string>
+`addressId` | string
+`returnShippingRuleId` | string
+`autoCreateReturnShipment` | boolean
+`autoPrintLabels` | boolean
+`autoPrintDocuments` | boolean
+`labelPrinterId` | string
+`documentPrinterId` | string
+
+## Example
+
+```typescript
+import type { CreateShipment201ResponseShippingRule } 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": rule_return_01,
+  "autoCreateReturnShipment": false,
+  "autoPrintLabels": true,
+  "autoPrintDocuments": false,
+  "labelPrinterId": prn_label_01,
+  "documentPrinterId": prn_doc_01,
+} satisfies CreateShipment201ResponseShippingRule
+
+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 CreateShipment201ResponseShippingRule
+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/CreateShipment201ResponseTracking.md

@@ -0,0 +1,44 @@
+
+# CreateShipment201ResponseTracking
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+`number` | string
+`labelFreeCode` | string
+`qrCodeLink` | string
+`qrCodeDataUri` | string
+`qrCodeUrl` | string
+
+## Example
+
+```typescript
+import type { CreateShipment201ResponseTracking } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": https://tracking.postnord.com/00370724710000012345,
+  "number": 00370724710000012345,
+  "labelFreeCode": AB12CD34,
+  "qrCodeLink": data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
+  "qrCodeDataUri": data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
+  "qrCodeUrl": https://qr.bring.com/label-free/AB12CD34.png,
+} satisfies CreateShipment201ResponseTracking
+
+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 CreateShipment201ResponseTracking
+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)
+
+