@teemill/orders 1.24.1 → 1.25.0

package/docs/Fulfillment.md

@@ -1,19 +1,20 @@
 # Fulfillment
 
+A fulfillment group within an order. Each fulfillment represents a package that will be shipped separately, potentially from a different fulfiller.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique fulfillment id | [optional] [default to undefined]
-**status** | [**Status**](Status.md) |  | [optional] [default to undefined]
-**fulfiller** | [**FulfillmentFulfiller**](FulfillmentFulfiller.md) |  | [optional] [default to undefined]
-**items** | [**Array<FulfillmentItem>**](FulfillmentItem.md) |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier for this fulfillment. | [optional] [default to undefined]
+**status** | [**Status**](Status.md) | The current status of this fulfillment. | [optional] [default to undefined]
+**fulfiller** | [**Fulfiller**](Fulfiller.md) |  | [optional] [default to undefined]
+**items** | [**Array<FulfillmentItem>**](FulfillmentItem.md) | The items included in this fulfillment package. | [optional] [default to undefined]
 **tracking** | [**OrderTracking**](OrderTracking.md) |  | [optional] [default to undefined]
-**shippingMethod** | [**ShippingMethod**](ShippingMethod.md) | Shipping method currently set | [optional] [default to undefined]
-**availableShippingMethods** | [**Array<ShippingMethod>**](ShippingMethod.md) | Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment. | [optional] [default to undefined]
-**packageWeight** | **number** | Weight of the package being shipped in grams | [optional] [default to undefined]
-**platformRef** | **string** | A reference to the resource location | [optional] [default to undefined]
+**shippingMethod** | [**ShippingMethod**](ShippingMethod.md) | The shipping method currently assigned to this fulfillment. | [optional] [default to undefined]
+**availableShippingMethods** | [**Array<ShippingMethod>**](ShippingMethod.md) | Shipping methods available for this fulfillment. Use one of these IDs when confirming the order. | [optional] [default to undefined]
+**packageWeight** | **number** | The estimated weight of the package in grams. | [optional] [default to undefined]
+**platformRef** | **string** | Reference to the source platform of this fulfillment. | [optional] [default to undefined]
 
 ## Example
 

package/docs/FulfillmentItem.md

@@ -5,9 +5,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique fulfillment item id | [optional] [default to undefined]
-**itemId** | **string** | Id of the order item being fulfilled | [optional] [default to undefined]
-**quantity** | **number** | Number of this item being fulfilled | [optional] [default to undefined]
+**id** | **string** | Unique identifier for this fulfillment item. | [optional] [default to undefined]
+**itemId** | **string** | The ID of the order item being fulfilled. | [optional] [default to undefined]
+**quantity** | **number** | The number of units of this item included in the fulfillment. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Image.md

@@ -1,15 +1,15 @@
 # Image
 
-Image description
+A product image associated with an order item.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
-**src** | **string** |  | [optional] [default to undefined]
-**alt** | **string** |  | [optional] [default to undefined]
-**sortOrder** | **number** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier for this image. | [optional] [default to undefined]
+**src** | **string** | The URL of the image. | [optional] [default to undefined]
+**alt** | **string** | Alternative text describing the image content. | [optional] [default to undefined]
+**sortOrder** | **number** | The display order of this image relative to other images for the same item. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Order.md

@@ -1,5 +1,6 @@
 # Order
 
+Represents a print-on-demand order placed on a project. An order contains items, fulfillment details, pricing, and status tracking.
 
 ## Properties
 
@@ -7,26 +8,26 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **string** | Unique object identifier | [optional] [default to undefined]
 **ref** | **string** | A reference to the resource location | [optional] [default to undefined]
-**status** | [**Status**](Status.md) |  | [optional] [default to undefined]
+**status** | [**Status**](Status.md) | The current status of the order. | [optional] [default to undefined]
 **contactInformation** | [**ContactInformation**](ContactInformation.md) |  | [default to undefined]
 **paymentMethod** | [**PaymentMethod**](PaymentMethod.md) |  | [optional] [default to undefined]
-**shippingAddress** | [**Address**](Address.md) |  | [default to undefined]
+**shippingAddress** | [**Address**](Address.md) | The address the order will be shipped to. | [default to undefined]
 **customsInformation** | [**CustomsInformation1**](CustomsInformation1.md) |  | [optional] [default to undefined]
-**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
-**updatedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
-**statusChangedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
-**merchantReference** | **string** | A custom reference to the merchant\'s order. | [optional] [default to undefined]
-**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) |  | [optional] [readonly] [default to undefined]
-**items** | [**Array<OrderItem>**](OrderItem.md) |  | [default to undefined]
-**totalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**taxPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**subtotalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**discountPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**coupon** | [**Coupon**](Coupon.md) |  | [optional] [default to undefined]
-**shippingPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**createdAt** | **string** | When the order was created. | [optional] [default to undefined]
+**updatedAt** | **string** | When the order was last updated. | [optional] [default to undefined]
+**statusChangedAt** | **string** | When the order status last changed. | [optional] [default to undefined]
+**merchantReference** | **string** | Your own reference for this order, such as an order number from your storefront. | [optional] [default to undefined]
+**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) | The fulfillment groups for this order. Each fulfillment represents a package that will be shipped separately. | [optional] [readonly] [default to undefined]
+**items** | [**Array<OrderItem>**](OrderItem.md) | The line items included in this order. | [default to undefined]
+**totalPrice** | [**Price**](Price.md) | The total price of the order including tax and after discounts. | [optional] [default to undefined]
+**taxPrice** | [**Price**](Price.md) | The total tax amount for the order. | [optional] [default to undefined]
+**subtotalPrice** | [**Price**](Price.md) | The net items price excluding tax and before discounts. | [optional] [default to undefined]
+**discountPrice** | [**Price**](Price.md) | The total discount amount applied to the order. | [optional] [default to undefined]
+**coupon** | [**Coupon**](Coupon.md) | The coupon applied to the order, if any. | [optional] [default to undefined]
+**shippingPrice** | [**Price**](Price.md) | The total shipping cost for the order. | [optional] [default to undefined]
 **origin** | [**Origin**](Origin.md) |  | [optional] [default to undefined]
-**statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) |  | [optional] [default to undefined]
-**paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) |  | [optional] [default to undefined]
+**statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) | A chronological list of status changes for this order. | [optional] [default to undefined]
+**paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) | A list of payment attempts made for this order. | [optional] [default to undefined]
 
 ## Example
 

package/docs/OrderItem.md

@@ -1,21 +1,22 @@
 # OrderItem
 
+A line item in an order, representing a specific product variant and quantity.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [readonly] [default to undefined]
+**id** | **string** | Unique identifier for this order item. | [optional] [readonly] [default to undefined]
 **variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
 **_options** | [**Array<Option>**](Option.md) | Options associated to an order item\'s variant, such as color and size. | [optional] [default to undefined]
-**quantity** | **number** |  | [default to undefined]
-**name** | **string** | The name of the product | [optional] [default to undefined]
-**images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
-**totalPrice** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
-**taxPrice** | [**Price**](Price.md) | This is an estimate until the order has been confirmed | [optional] [readonly] [default to undefined]
-**subtotalPrice** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
-**discountPrice** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
-**recipientCost** | [**Price**](Price.md) | The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues. | [optional] [default to undefined]
+**quantity** | **number** | The number of units of this variant to order. | [default to undefined]
+**name** | **string** | The display name of the product. | [optional] [readonly] [default to undefined]
+**images** | [**Array<Image>**](Image.md) | Product images associated with this item. | [optional] [readonly] [default to undefined]
+**totalPrice** | [**Price**](Price.md) | The total price for this line item including tax and after discounts. | [optional] [readonly] [default to undefined]
+**taxPrice** | [**Price**](Price.md) | The tax amount for this line item. This is an estimate until the order has been confirmed. | [optional] [readonly] [default to undefined]
+**subtotalPrice** | [**Price**](Price.md) | The net price for this line item, excluding tax and before discounts. | [optional] [readonly] [default to undefined]
+**discountPrice** | [**Price**](Price.md) | The discount amount applied to this line item. | [optional] [readonly] [default to undefined]
+**recipientCost** | [**Price**](Price.md) | The price you charged the recipient for each item. Highly recommended for international orders as it aids customs declarations. | [optional] [default to undefined]
 
 ## Example
 

package/docs/OrderTracking.md

@@ -1,13 +1,14 @@
 # OrderTracking
 
+Shipment tracking information. Available once the fulfillment has been dispatched.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**courier** | **string** |  | [optional] [default to undefined]
-**code** | **string** |  | [optional] [default to undefined]
-**url** | **string** |  | [optional] [default to undefined]
+**courier** | **string** | The name of the courier service. | [optional] [default to undefined]
+**code** | **string** | The tracking code provided by the courier. | [optional] [default to undefined]
+**url** | **string** | A URL to track the shipment on the courier\'s website. | [optional] [default to undefined]
 
 ## Example
 

package/docs/OrdersApi.md

@@ -29,7 +29,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let project: string; //What project it is (default to undefined)
+let project: string; //The project identifier to scope the request to. (default to undefined)
 let orderId: string; //Unique identifier of an order (default to undefined)
 let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
 
@@ -44,7 +44,7 @@ const { status, data } = await apiInstance.cancelOrder(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **project** | [**string**] | What project it is | defaults to undefined|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
 | **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
 | **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
 
@@ -92,9 +92,9 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let project: string; //What project it is (default to undefined)
+let project: string; //The project identifier to scope the request to. (default to undefined)
 let orderId: string; //Unique identifier of an order (default to undefined)
-let confirmOrderRequest: ConfirmOrderRequest; //ConfirmFulfillment schema
+let confirmOrderRequest: ConfirmOrderRequest; //Confirm an order by specifying shipping methods for each fulfillment. This submits the order for payment processing and production. Orders should be confirmed promptly after creation — the longer an order remains unconfirmed, the greater the chance that stock availability changes. If stock is no longer available at the time of confirmation, the request will fail and you will need to create a new order.
 let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
 
 const { status, data } = await apiInstance.confirmOrder(
@@ -109,8 +109,8 @@ const { status, data } = await apiInstance.confirmOrder(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **confirmOrderRequest** | **ConfirmOrderRequest**| ConfirmFulfillment schema | |
-| **project** | [**string**] | What project it is | defaults to undefined|
+| **confirmOrderRequest** | **ConfirmOrderRequest**| Confirm an order by specifying shipping methods for each fulfillment. This submits the order for payment processing and production. Orders should be confirmed promptly after creation — the longer an order remains unconfirmed, the greater the chance that stock availability changes. If stock is no longer available at the time of confirmation, the request will fail and you will need to create a new order. | |
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
 | **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
 | **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
 
@@ -133,7 +133,7 @@ const { status, data } = await apiInstance.confirmOrder(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Order schema |  -  |
-|**400** | Failed validation |  -  |
+|**400** | Failed validation for the confirm request. When the error relates to item fulfillment issues (e.g. stock or availability problems), the response includes an `errors` array with details on each affected item.  |  -  |
 |**401** | Not authorised to access this resource |  -  |
 |**403** | Refuse to authorize |  -  |
 |**404** | Resource not found |  -  |
@@ -158,7 +158,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let project: string; //What project it is (default to undefined)
+let project: string; //The project identifier to scope the request to. (default to undefined)
 let createOrder: CreateOrder; //Create Order schema
 let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
 
@@ -174,7 +174,7 @@ const { status, data } = await apiInstance.createOrder(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **createOrder** | **CreateOrder**| Create Order schema | |
-| **project** | [**string**] | What project it is | defaults to undefined|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
 | **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
 
 
@@ -219,7 +219,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let project: string; //What project it is (default to undefined)
+let project: string; //The project identifier to scope the request to. (default to undefined)
 let orderId: string; //Unique identifier of an order (default to undefined)
 
 const { status, data } = await apiInstance.downloadInvoice(
@@ -232,7 +232,7 @@ const { status, data } = await apiInstance.downloadInvoice(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **project** | [**string**] | What project it is | defaults to undefined|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
 | **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
 
 
@@ -278,9 +278,9 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let project: string; //What project it is (default to undefined)
-let start: string; //Start of date range to filter by when orders were placed (default to undefined)
-let end: string; //End of date range (optional) (default to undefined)
+let project: string; //The project identifier to scope the request to. (default to undefined)
+let start: string; //Start of the date range to filter by when orders were placed. (default to undefined)
+let end: string; //End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
 let search: string; //Search term to filter based on order reference, customer name and email (optional) (default to undefined)
 
 const { status, data } = await apiInstance.exportOrders(
@@ -295,9 +295,9 @@ const { status, data } = await apiInstance.exportOrders(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **project** | [**string**] | What project it is | defaults to undefined|
-| **start** | [**string**] | Start of date range to filter by when orders were placed | defaults to undefined|
-| **end** | [**string**] | End of date range | (optional) defaults to undefined|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
+| **start** | [**string**] | Start of the date range to filter by when orders were placed. | defaults to undefined|
+| **end** | [**string**] | End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. | (optional) defaults to undefined|
 | **search** | [**string**] | Search term to filter based on order reference, customer name and email | (optional) defaults to undefined|
 
 
@@ -344,7 +344,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let project: string; //What project it is (default to undefined)
+let project: string; //The project identifier to scope the request to. (default to undefined)
 let orderId: string; //Unique identifier of an order (default to undefined)
 let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
 
@@ -359,7 +359,7 @@ const { status, data } = await apiInstance.getOrder(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **project** | [**string**] | What project it is | defaults to undefined|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
 | **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
 | **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
 
@@ -406,15 +406,15 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let project: string; //What project it is (default to undefined)
+let project: string; //The project identifier to scope the request to. (default to undefined)
 let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
 let pageToken: number; //Page reference token (optional) (default to 1)
 let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
 let search: string; //Search term to filter based on order reference, customer name and email (optional) (default to undefined)
-let ids: Array<string>; //Specify fulfillment IDs to list (optional) (default to undefined)
-let statuses: Array<Status>; //Filter by fulfillment status (optional) (default to undefined)
-let start: string; //Start of date range (optional) (default to undefined)
-let end: string; //End of date range (optional) (default to undefined)
+let ids: Array<string>; //Filter to specific order IDs. Only orders matching these IDs will be returned. (optional) (default to undefined)
+let statuses: Array<Status>; //Filter by order status. Only orders matching one of the given statuses will be returned. (optional) (default to undefined)
+let start: string; //Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
+let end: string; //End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
 let dateFilterType: 'createdAt' | 'updatedAt' | 'statusChangedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
 
 const { status, data } = await apiInstance.getOrders(
@@ -435,15 +435,15 @@ const { status, data } = await apiInstance.getOrders(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **project** | [**string**] | What project it is | defaults to undefined|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
 | **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
 | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
 | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
 | **search** | [**string**] | Search term to filter based on order reference, customer name and email | (optional) defaults to undefined|
-| **ids** | **Array&lt;string&gt;** | Specify fulfillment IDs to list | (optional) defaults to undefined|
-| **statuses** | **Array&lt;Status&gt;** | Filter by fulfillment status | (optional) defaults to undefined|
-| **start** | [**string**] | Start of date range | (optional) defaults to undefined|
-| **end** | [**string**] | End of date range | (optional) defaults to undefined|
+| **ids** | **Array&lt;string&gt;** | Filter to specific order IDs. Only orders matching these IDs will be returned. | (optional) defaults to undefined|
+| **statuses** | **Array&lt;Status&gt;** | Filter by order status. Only orders matching one of the given statuses will be returned. | (optional) defaults to undefined|
+| **start** | [**string**] | Start of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter. | (optional) defaults to undefined|
+| **end** | [**string**] | End of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter. | (optional) defaults to undefined|
 | **dateFilterType** | [**&#39;createdAt&#39; | &#39;updatedAt&#39; | &#39;statusChangedAt&#39;**]**Array<&#39;createdAt&#39; &#124; &#39;updatedAt&#39; &#124; &#39;statusChangedAt&#39;>** | Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query. | (optional) defaults to 'createdAt'|
 
 
@@ -488,7 +488,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
-let project: string; //What project it is (default to undefined)
+let project: string; //The project identifier to scope the request to. (default to undefined)
 let orderId: string; //Unique identifier of an order (default to undefined)
 let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
 
@@ -503,7 +503,7 @@ const { status, data } = await apiInstance.retryPlatformPayment(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **project** | [**string**] | What project it is | defaults to undefined|
+| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
 | **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
 | **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
 

package/docs/Origin.md

@@ -1,12 +1,13 @@
 # Origin
 
+The marketing or acquisition source of the order, such as `facebook_cpc`, `google_cpc`, or `organic`.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**isPaid** | **boolean** |  | [optional] [default to undefined]
+**code** | **string** | A short identifier for the acquisition source, such as `facebook_cpc`, `google_cpc`, `instagram_cpc`, or `organic`. | [optional] [default to undefined]
+**isPaid** | **boolean** | Whether this origin represents paid advertising traffic. | [optional] [default to undefined]
 
 ## Example
 

package/docs/PaymentAttempt.md

@@ -1,15 +1,14 @@
 # PaymentAttempt
 
-List of payment attempts for this order
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**paymentProvider** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**transactionId** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [optional] [default to undefined]
+**paymentProvider** | **string** | The payment provider used. | [optional] [default to undefined]
+**status** | **string** | The outcome of the payment attempt. | [optional] [default to undefined]
+**transactionId** | **string** | The transaction ID from the payment provider. | [optional] [default to undefined]
+**message** | **string** | A human-readable message describing the payment result. | [optional] [default to undefined]
 **createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
 
 ## Example

package/docs/PaymentMethod.md

@@ -1,11 +1,12 @@
 # PaymentMethod
 
+The payment method used for this order.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **string** |  | [optional] [default to undefined]
+**type** | **string** | The type of payment method used. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Price.md

@@ -1,13 +1,13 @@
 # Price
 
-Standard price definition that defines the amount and currency.
+A monetary value with its currency.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **string** | Price including tax in the specified currency. | [optional] [default to undefined]
-**currencyCode** | **string** | Currency code for the currency the price is valued in. | [optional] [default to undefined]
+**amount** | **string** | The monetary amount as a decimal string. | [optional] [default to undefined]
+**currencyCode** | **string** | ISO 4217 currency code. | [optional] [default to undefined]
 
 ## Example
 

package/docs/ProductUnavailableError.md

@@ -0,0 +1,35 @@
+# ProductUnavailableError
+
+The item cannot be fulfilled at all — either it is out of stock entirely, or the assigned fulfiller cannot produce it (e.g. missing machinery or variant not configured).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**message** | **string** | Human-readable description including the product name. | [default to undefined]
+**productTitle** | **string** | Display name of the product. | [default to undefined]
+**variantId** | **string** | Unique object identifier | [default to undefined]
+**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
+**requestedQuantity** | **number** | The quantity that was requested in the order. | [default to undefined]
+**availableQuantity** | **number** | Always 0 for this error type. | [default to undefined]
+**shortage** | **number** | The full requested quantity, representing the total unfulfillable amount. | [default to undefined]
+
+## Example
+
+```typescript
+import { ProductUnavailableError } from '@teemill/orders';
+
+const instance: ProductUnavailableError = {
+    code,
+    message,
+    productTitle,
+    variantId,
+    variantRef,
+    requestedQuantity,
+    availableQuantity,
+    shortage,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RecipientCost.md

@@ -0,0 +1,23 @@
+# RecipientCost
+
+The price you charged the end customer for this item. Highly recommended for international orders as it is used for customs declarations.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **string** | The monetary amount as a decimal string. | [default to undefined]
+**currencyCode** | **string** | ISO 4217 currency code. | [default to undefined]
+
+## Example
+
+```typescript
+import { RecipientCost } from '@teemill/orders';
+
+const instance: RecipientCost = {
+    amount,
+    currencyCode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Shipment.md

@@ -0,0 +1,21 @@
+# Shipment
+
+Your own shipping label details.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | **string** | A URL to the shipping label image or PDF. | [default to undefined]
+
+## Example
+
+```typescript
+import { Shipment } from '@teemill/orders';
+
+const instance: Shipment = {
+    image,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ShippingMethod.md

@@ -1,18 +1,19 @@
 # ShippingMethod
 
+A shipping option available for a fulfillment, including delivery estimates and pricing.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**description** | **string** |  | [optional] [default to undefined]
+**id** | **string** | Unique identifier for this shipping method. Use this when confirming a fulfillment. | [optional] [default to undefined]
+**name** | **string** | The display name of the shipping method. | [optional] [default to undefined]
+**description** | **string** | A brief description of the shipping method\'s service level. | [optional] [default to undefined]
 **deliveryEstimates** | [**DeliveryEstimates**](DeliveryEstimates.md) |  | [optional] [default to undefined]
-**totalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**taxPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**subtotalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**discountPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**totalPrice** | [**Price**](Price.md) | The total shipping cost including tax. | [optional] [default to undefined]
+**taxPrice** | [**Price**](Price.md) | The tax portion of the shipping cost. | [optional] [default to undefined]
+**subtotalPrice** | [**Price**](Price.md) | The net shipping cost, excluding tax and before discounts. | [optional] [default to undefined]
+**discountPrice** | [**Price**](Price.md) | Any discount applied to the shipping cost. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Status.md

@@ -1,5 +1,6 @@
 # Status
 
+The lifecycle status of an order or fulfillment: - `new` — Order has been created but not yet confirmed or paid - `paid` — Payment has been received, awaiting fulfillment - `processing` — Order is being produced or packed - `complete` — Order has been shipped - `refunded` — Order has been refunded - `quote` — Order is a draft quote, not yet submitted - `moderation` — Order is held for review 
 
 ## Enum
 

package/docs/StockConflictError.md

@@ -0,0 +1,34 @@
+# StockConflictError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**message** | **string** | Human-readable description including the product name. | [default to undefined]
+**productTitle** | **string** | Display name of the product. | [default to undefined]
+**variantId** | **string** | Unique object identifier | [default to undefined]
+**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
+**requestedQuantity** | **number** | The quantity that was requested in the order. | [default to undefined]
+**availableQuantity** | **number** | Always 0 for this error type. | [default to undefined]
+**shortage** | **number** | The full requested quantity, representing the total unfulfillable amount. | [default to undefined]
+
+## Example
+
+```typescript
+import { StockConflictError } from '@teemill/orders';
+
+const instance: StockConflictError = {
+    code,
+    message,
+    productTitle,
+    variantId,
+    variantRef,
+    requestedQuantity,
+    availableQuantity,
+    shortage,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockUnavailableError.md

@@ -0,0 +1,35 @@
+# StockUnavailableError
+
+The requested quantity exceeds available stock. The item can still be ordered in a smaller quantity.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**message** | **string** | Human-readable description including the product name and available quantity. | [default to undefined]
+**productTitle** | **string** | Display name of the product. | [default to undefined]
+**variantId** | **string** | Unique object identifier | [default to undefined]
+**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
+**requestedQuantity** | **number** | The quantity that was requested in the order. | [default to undefined]
+**availableQuantity** | **number** | The quantity currently available for fulfillment. | [default to undefined]
+**shortage** | **number** | The difference between requested and available quantity (positive value indicating the deficit). | [default to undefined]
+
+## Example
+
+```typescript
+import { StockUnavailableError } from '@teemill/orders';
+
+const instance: StockUnavailableError = {
+    code,
+    message,
+    productTitle,
+    variantId,
+    variantRef,
+    requestedQuantity,
+    availableQuantity,
+    shortage,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.ts

@@ -4,7 +4,7 @@
  * Orders API
  * Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.
  *
- * The version of the OpenAPI document: 1.24.1
+ * The version of the OpenAPI document: 1.25.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).