@teemill/orders 1.24.1 → 1.25.0

package/dist/esm/api.js

@@ -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).
@@ -46,6 +46,15 @@ export const PaymentAttemptStatusEnum = {
     Pending: 'pending',
     Cancelled: 'cancelled'
 };
+export const ProductUnavailableErrorCodeEnum = {
+    ProductUnavailable: 'PRODUCT_UNAVAILABLE'
+};
+export const ProductUnavailableErrorAvailableQuantityEnum = {
+    NUMBER_0: 0
+};
+/**
+ * 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
+ */
 export const Status = {
     New: 'new',
     Paid: 'paid',
@@ -55,6 +64,9 @@ export const Status = {
     Quote: 'quote',
     Moderation: 'moderation'
 };
+export const StockUnavailableErrorCodeEnum = {
+    StockUnavailable: 'STOCK_UNAVAILABLE'
+};
 /**
  * OrdersApi - axios parameter creator
  */
@@ -63,7 +75,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Cancels an order if it has not yet started processing.
          * @summary Cancel order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -108,9 +120,9 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Confirms an order, and submits it as ready to take payment and begin processing.
          * @summary Confirm order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
-         * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+         * @param {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.
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -158,7 +170,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
          * @summary Create order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {CreateOrder} createOrder Create Order schema
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -204,7 +216,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Download an order invoice.
          * @summary Download order invoice
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -245,9 +257,9 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Export orders as a CSV file
          * @summary Export orders
-         * @param {string} project What project it is
-         * @param {string} start Start of date range to filter by when orders were placed
-         * @param {string} [end] End of date range
+         * @param {string} project The project identifier to scope the request to.
+         * @param {string} start Start of the date range to filter by when orders were placed.
+         * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter.
          * @param {string} [search] Search term to filter based on order reference, customer name and email
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -300,7 +312,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Get an order by a given ID.
          * @summary Get order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -345,15 +357,15 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Lists all orders placed on this project, paginated into configurable chunks.
          * @summary List orders
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
          * @param {string} [search] Search term to filter based on order reference, customer name and email
-         * @param {Array<string>} [ids] Specify fulfillment IDs to list
-         * @param {Array<Status>} [statuses] Filter by fulfillment status
-         * @param {string} [start] Start of date range
-         * @param {string} [end] End of date range
+         * @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
+         * @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
+         * @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
+         * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
          * @param {GetOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -422,7 +434,7 @@ export const OrdersApiAxiosParamCreator = function (configuration) {
         /**
          * Retries failed platform payment, so fulfillment can proceed.
          * @summary Retry
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -475,7 +487,7 @@ export const OrdersApiFp = function (configuration) {
         /**
          * Cancels an order if it has not yet started processing.
          * @summary Cancel order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -493,9 +505,9 @@ export const OrdersApiFp = function (configuration) {
         /**
          * Confirms an order, and submits it as ready to take payment and begin processing.
          * @summary Confirm order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
-         * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+         * @param {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.
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -512,7 +524,7 @@ export const OrdersApiFp = function (configuration) {
         /**
          * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
          * @summary Create order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {CreateOrder} createOrder Create Order schema
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -530,7 +542,7 @@ export const OrdersApiFp = function (configuration) {
         /**
          * Download an order invoice.
          * @summary Download order invoice
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -547,9 +559,9 @@ export const OrdersApiFp = function (configuration) {
         /**
          * Export orders as a CSV file
          * @summary Export orders
-         * @param {string} project What project it is
-         * @param {string} start Start of date range to filter by when orders were placed
-         * @param {string} [end] End of date range
+         * @param {string} project The project identifier to scope the request to.
+         * @param {string} start Start of the date range to filter by when orders were placed.
+         * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
          * @param {string} [search] Search term to filter based on order reference, customer name and email
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -566,7 +578,7 @@ export const OrdersApiFp = function (configuration) {
         /**
          * Get an order by a given ID.
          * @summary Get order
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.
@@ -584,15 +596,15 @@ export const OrdersApiFp = function (configuration) {
         /**
          * Lists all orders placed on this project, paginated into configurable chunks.
          * @summary List orders
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
          * @param {string} [search] Search term to filter based on order reference, customer name and email
-         * @param {Array<string>} [ids] Specify fulfillment IDs to list
-         * @param {Array<Status>} [statuses] Filter by fulfillment status
-         * @param {string} [start] Start of date range
-         * @param {string} [end] End of date range
+         * @param {Array<string>} [ids] Filter to specific order IDs. Only orders matching these IDs will be returned.
+         * @param {Array<Status>} [statuses] Filter by order status. Only orders matching one of the given statuses will be returned.
+         * @param {string} [start] Start of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
+         * @param {string} [end] End of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
          * @param {GetOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -609,7 +621,7 @@ export const OrdersApiFp = function (configuration) {
         /**
          * Retries failed platform payment, so fulfillment can proceed.
          * @summary Retry
-         * @param {string} project What project it is
+         * @param {string} project The project identifier to scope the request to.
          * @param {string} orderId Unique identifier of an order
          * @param {string} [fields] Specifies which fields to return, separated by commas
          * @param {*} [options] Override http request option.

package/dist/esm/base.d.ts

@@ -2,7 +2,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).

package/dist/esm/base.js

@@ -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).

package/dist/esm/common.d.ts

@@ -2,7 +2,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).

package/dist/esm/common.js

@@ -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).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,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).

package/dist/esm/configuration.js

@@ -3,7 +3,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).

package/dist/esm/index.d.ts

@@ -2,7 +2,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).

package/dist/esm/index.js

@@ -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).

package/dist/index.d.ts

@@ -2,7 +2,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).

package/dist/index.js

@@ -5,7 +5,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).

package/docs/Address.md

@@ -1,19 +1,19 @@
 # Address
 
-A person\'s address.
+A postal address for shipping or billing.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**contactName** | **string** |  | [optional] [default to undefined]
-**company** | **string** |  | [optional] [default to undefined]
-**line1** | **string** | First line of the address. | [optional] [default to undefined]
-**line2** | **string** | Second line of the address. | [optional] [default to undefined]
-**city** | **string** | City of the address. | [optional] [default to undefined]
-**postalCode** | **string** | Postal code of the address. | [optional] [default to undefined]
-**country** | **string** | Country of the address (ISO 3166-1 alpha-2). | [default to undefined]
-**state** | **string** | State of the address. If the country is Canada, Australia, or the United States, this field is required. | [optional] [default to undefined]
+**contactName** | **string** | The full name of the recipient. | [optional] [default to undefined]
+**company** | **string** | The company name, if applicable. | [optional] [default to undefined]
+**line1** | **string** | First line of the street address. | [optional] [default to undefined]
+**line2** | **string** | Second line of the street address (apartment, suite, etc.). | [optional] [default to undefined]
+**city** | **string** | The city or town. | [optional] [default to undefined]
+**postalCode** | **string** | The postal or ZIP code. | [optional] [default to undefined]
+**country** | **string** | Two-letter country code (ISO 3166-1 alpha-2). | [default to undefined]
+**state** | **string** | The state, province, or region. Required when the country is US, CA, or AU. | [optional] [default to undefined]
 
 ## Example
 

package/docs/ApiError.md

@@ -1,12 +1,13 @@
 # ApiError
 
+A standard error response returned when a request fails.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **string** |  | [optional] [default to undefined]
-**message** | **string** |  | [default to undefined]
+**code** | **string** | A machine-readable error code. | [optional] [default to undefined]
+**message** | **string** | A human-readable description of what went wrong. | [default to undefined]
 
 ## Example
 

package/docs/ConfirmOrderFulfillment.md

@@ -1,13 +1,14 @@
 # ConfirmOrderFulfillment
 
+Confirmation details for a single fulfillment. Provide either a `shippingMethodId` to use a PodOS shipping method, or a `shipment` object with your own shipping label.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**fulfillmentId** | **string** | Unique object identifier | [default to undefined]
-**shippingMethodId** | **string** | Unique object identifier | [default to undefined]
-**shipment** | [**ConfirmOrderFulfillmentWithShipmentShipment**](ConfirmOrderFulfillmentWithShipmentShipment.md) |  | [default to undefined]
+**fulfillmentId** | **string** | The ID of the fulfillment to confirm. | [default to undefined]
+**shippingMethodId** | **string** | The ID of the shipping method to use, from the fulfillment\'s `availableShippingMethods`. | [default to undefined]
+**shipment** | [**Shipment**](Shipment.md) |  | [default to undefined]
 
 ## Example
 

package/docs/ConfirmOrderFulfillmentWithShipment.md

@@ -1,12 +1,13 @@
 # ConfirmOrderFulfillmentWithShipment
 
+Confirm a fulfillment using your own shipping label. Use this when you generate shipping labels outside of PodOS.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**fulfillmentId** | **string** | Unique object identifier | [default to undefined]
-**shipment** | [**ConfirmOrderFulfillmentWithShipmentShipment**](ConfirmOrderFulfillmentWithShipmentShipment.md) |  | [default to undefined]
+**fulfillmentId** | **string** | The ID of the fulfillment to confirm. | [default to undefined]
+**shipment** | [**Shipment**](Shipment.md) |  | [default to undefined]
 
 ## Example
 

package/docs/ConfirmOrderFulfillmentWithShippingMethod.md

@@ -1,12 +1,13 @@
 # ConfirmOrderFulfillmentWithShippingMethod
 
+Confirm a fulfillment using a PodOS shipping method. Choose from the `availableShippingMethods` returned on the fulfillment.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**fulfillmentId** | **string** | Unique object identifier | [default to undefined]
-**shippingMethodId** | **string** | Unique object identifier | [default to undefined]
+**fulfillmentId** | **string** | The ID of the fulfillment to confirm. | [default to undefined]
+**shippingMethodId** | **string** | The ID of the shipping method to use, from the fulfillment\'s `availableShippingMethods`. | [default to undefined]
 
 ## Example
 

package/docs/ConfirmOrderValidationError.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **string** |  | [default to undefined]
 **message** | **string** |  | [default to undefined]
+**errors** | [**Array<StockConflictError>**](StockConflictError.md) | Present when one or more items cannot be fulfilled. Each entry describes a specific item and why it cannot be fulfilled, with a `code` that determines the error type. See `StockUnavailableError` and `ProductUnavailableError` schemas.  | [optional] [default to undefined]
 
 ## Example
 
@@ -16,6 +17,7 @@ import { ConfirmOrderValidationError } from '@teemill/orders';
 const instance: ConfirmOrderValidationError = {
     code,
     message,
+    errors,
 };
 ```
 

package/docs/ContactInformation.md

@@ -6,8 +6,8 @@ Order recipient contact information, used only for courier tracking/updates.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **string** |  | [default to undefined]
-**phone** | **string** |  | [optional] [default to undefined]
+**email** | **string** | Email address for delivery notifications. | [default to undefined]
+**phone** | **string** | Phone number for courier contact. Include the country code. | [optional] [default to undefined]
 
 ## Example
 

package/docs/ContactInformation1.md

@@ -0,0 +1,23 @@
+# ContactInformation1
+
+Contact details for the order recipient. Used for courier delivery notifications.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email address for delivery notifications. | [default to undefined]
+**phone** | **string** | Phone number including country code. Used by couriers for delivery updates. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ContactInformation1 } from '@teemill/orders';
+
+const instance: ContactInformation1 = {
+    email,
+    phone,
+};
+```
+
+[[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/CreateOrder.md

@@ -1,17 +1,17 @@
 # CreateOrder
 
-Create an order
+The request body for creating a new print-on-demand order.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**merchantReference** | **string** | A custom reference to the merchant\'s order. | [optional] [default to undefined]
-**contactInformation** | [**CreateOrderContactInformation**](CreateOrderContactInformation.md) |  | [default to undefined]
-**shippingAddress** | [**Address**](Address.md) |  | [default to undefined]
-**customsInformation** | [**CustomsInformation**](CustomsInformation.md) |  | [optional] [default to undefined]
-**items** | [**Array<OrderItem1>**](OrderItem1.md) | Items to be ordered | [default to undefined]
-**preferredFulfillers** | **Array<string>** |  | [optional] [default to undefined]
+**merchantReference** | **string** | Your own reference for this order, such as an order number from your storefront. This is returned in subsequent responses and can be used for reconciliation. | [optional] [default to undefined]
+**contactInformation** | [**ContactInformation1**](ContactInformation1.md) |  | [default to undefined]
+**shippingAddress** | [**Address**](Address.md) | The address to ship the order to. | [default to undefined]
+**customsInformation** | [**CustomsInformation**](CustomsInformation.md) | Customs and tax registration details. Required for international shipments. | [optional] [default to undefined]
+**items** | [**Array<CreateOrderItem>**](CreateOrderItem.md) | The items to include in the order. Each item references a product variant from the Product Catalog API. | [default to undefined]
+**preferredFulfillers** | **Array<string>** | An optional list of preferred fulfiller IDs. When provided, the system will attempt to route the order to one of these fulfillers. | [optional] [default to undefined]
 
 ## Example
 

package/docs/CreateOrderItem.md

@@ -0,0 +1,24 @@
+# CreateOrderItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
+**quantity** | **number** | The number of units to order. | [default to undefined]
+**recipientCost** | [**RecipientCost**](RecipientCost.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateOrderItem } from '@teemill/orders';
+
+const instance: CreateOrderItem = {
+    variantRef,
+    quantity,
+    recipientCost,
+};
+```
+
+[[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/CustomsInformation.md

@@ -6,10 +6,10 @@ Customs information for the order. **Note:** Adding customs information to an or
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**preRegistrationType** | **string** | Pre-registration type | [optional] [default to undefined]
-**preRegistrationNumber** | **string** | Pre-registration number | [optional] [default to undefined]
-**vatNumber** | **string** | VAT number | [optional] [default to undefined]
-**eoriNumber** | **string** | EORI number | [optional] [default to undefined]
+**preRegistrationType** | **string** | The type of tax pre-registration (e.g. IOSS for EU imports). | [optional] [default to undefined]
+**preRegistrationNumber** | **string** | The pre-registration number associated with the registration type. | [optional] [default to undefined]
+**vatNumber** | **string** | The shipper\'s VAT registration number. | [optional] [default to undefined]
+**eoriNumber** | **string** | The shipper\'s EORI number for customs declarations. | [optional] [default to undefined]
 
 ## Example
 

package/docs/CustomsInformation1.md

@@ -1,14 +1,15 @@
 # CustomsInformation1
 
+Customs and tax registration details for international shipments.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**preRegistrationType** | **string** |  | [optional] [default to undefined]
-**preRegistrationNumber** | **string** |  | [optional] [default to undefined]
-**vatNumber** | **string** |  | [optional] [default to undefined]
-**eoriNumber** | **string** |  | [optional] [default to undefined]
+**preRegistrationType** | **string** | The type of tax pre-registration (e.g. IOSS for EU imports). | [optional] [default to undefined]
+**preRegistrationNumber** | **string** | The pre-registration number associated with the registration type. | [optional] [default to undefined]
+**vatNumber** | **string** | The shipper\'s VAT registration number. | [optional] [default to undefined]
+**eoriNumber** | **string** | The shipper\'s EORI number for customs declarations. | [optional] [default to undefined]
 
 ## Example
 

package/docs/DeliveryEstimates.md

@@ -1,13 +1,14 @@
 # DeliveryEstimates
 
+Estimated delivery window for this shipping method.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**isPriority** | **boolean** | Whether this is a priority shipping method. Fulfillments with priority methods aim for same day dispatch when ordered before 1pm, and typically offer faster delivery times. | [optional] [default to undefined]
-**min** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
-**max** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**isPriority** | **boolean** | Whether this is a priority shipping method. Fulfillments with priority methods aim for same-day dispatch when ordered before 1pm, and typically offer faster delivery times. | [optional] [default to undefined]
+**min** | **string** | The earliest estimated delivery date. | [optional] [default to undefined]
+**max** | **string** | The latest estimated delivery date. | [optional] [default to undefined]
 
 ## Example
 

package/docs/Fulfiller.md

@@ -0,0 +1,25 @@
+# Fulfiller
+
+The fulfiller that will produce and ship this package.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier of the fulfiller. | [optional] [default to undefined]
+**location** | [**FulfillerLocation**](FulfillerLocation.md) |  | [optional] [default to undefined]
+**canFulfillImmediately** | **boolean** | Whether the fulfiller has the stock and capacity to begin processing immediately. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Fulfiller } from '@teemill/orders';
+
+const instance: Fulfiller = {
+    id,
+    location,
+    canFulfillImmediately,
+};
+```
+
+[[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/FulfillerLocation.md

@@ -0,0 +1,23 @@
+# FulfillerLocation
+
+The geographic location of the fulfiller.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**city** | **string** | The city where the fulfiller is located. | [optional] [default to undefined]
+**country** | **string** | The country code where the fulfiller is located (ISO 3166-1 alpha-2). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FulfillerLocation } from '@teemill/orders';
+
+const instance: FulfillerLocation = {
+    city,
+    country,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)