@teemill/orders 1.24.0 → 1.25.0

package/dist/api.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.0
+ * The version of the OpenAPI document: 1.25.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,67 +14,80 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
 /**
- * A person\'s address.
+ * A postal address for shipping or billing.
  */
 export interface Address {
+    /**
+     * The full name of the recipient.
+     */
     'contactName'?: string;
+    /**
+     * The company name, if applicable.
+     */
     'company'?: string;
     /**
-     * First line of the address.
+     * First line of the street address.
      */
     'line1'?: string;
     /**
-     * Second line of the address.
+     * Second line of the street address (apartment, suite, etc.).
      */
     'line2'?: string;
     /**
-     * City of the address.
+     * The city or town.
      */
     'city'?: string;
     /**
-     * Postal code of the address.
+     * The postal or ZIP code.
      */
     'postalCode'?: string;
     /**
-     * Country of the address (ISO 3166-1 alpha-2).
+     * Two-letter country code (ISO 3166-1 alpha-2).
      */
     'country': string;
     /**
-     * State of the address. If the country is Canada, Australia, or the United States, this field is required.
+     * The state, province, or region. Required when the country is US, CA, or AU.
      */
     'state'?: string;
 }
+/**
+ * A standard error response returned when a request fails.
+ */
 export interface ApiError {
+    /**
+     * A machine-readable error code.
+     */
     'code'?: string;
+    /**
+     * A human-readable description of what went wrong.
+     */
     'message': string;
 }
 /**
  * @type 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.
  */
 export type ConfirmOrderFulfillment = ConfirmOrderFulfillmentWithShipment | ConfirmOrderFulfillmentWithShippingMethod;
+/**
+ * Confirm a fulfillment using your own shipping label. Use this when you generate shipping labels outside of PodOS.
+ */
 export interface ConfirmOrderFulfillmentWithShipment {
     /**
-     * Unique object identifier
+     * The ID of the fulfillment to confirm.
      */
     'fulfillmentId': string;
-    'shipment': ConfirmOrderFulfillmentWithShipmentShipment;
+    'shipment': Shipment;
 }
 /**
- * This field is only required if you are using your own shipping label.
+ * Confirm a fulfillment using a PodOS shipping method. Choose from the `availableShippingMethods` returned on the fulfillment.
  */
-export interface ConfirmOrderFulfillmentWithShipmentShipment {
-    /**
-     * Only required if you are generating shipping labels outside of PodOS
-     */
-    'image': string;
-}
 export interface ConfirmOrderFulfillmentWithShippingMethod {
     /**
-     * Unique object identifier
+     * The ID of the fulfillment to confirm.
      */
     'fulfillmentId': string;
     /**
-     * Unique object identifier
+     * The ID of the shipping method to use, from the fulfillment\'s `availableShippingMethods`.
      */
     'shippingMethodId': string;
 }
@@ -84,6 +97,10 @@ export interface ConfirmOrderRequest {
 export interface ConfirmOrderValidationError {
     'code': ConfirmOrderValidationErrorCodeEnum;
     'message': string;
+    /**
+     * 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.
+     */
+    'errors'?: Array<StockConflictError>;
 }
 export declare const ConfirmOrderValidationErrorCodeEnum: {
     readonly BadRequest: "BAD_REQUEST";
@@ -96,7 +113,26 @@ export type ConfirmOrderValidationErrorCodeEnum = typeof ConfirmOrderValidationE
  * Order recipient contact information, used only for courier tracking/updates.
  */
 export interface ContactInformation {
+    /**
+     * Email address for delivery notifications.
+     */
+    'email': string;
+    /**
+     * Phone number for courier contact. Include the country code.
+     */
+    'phone'?: string | null;
+}
+/**
+ * Contact details for the order recipient. Used for courier delivery notifications.
+ */
+export interface ContactInformation1 {
+    /**
+     * Email address for delivery notifications.
+     */
     'email': string;
+    /**
+     * Phone number including country code. Used by couriers for delivery updates.
+     */
     'phone'?: string | null;
 }
 /**
@@ -114,47 +150,60 @@ export interface Coupon {
     'ref'?: string | null;
 }
 /**
- * Create an order
+ * The request body for creating a new print-on-demand order.
  */
 export interface CreateOrder {
     /**
-     * A custom reference to the merchant\'s order.
+     * 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.
      */
     'merchantReference'?: string | null;
-    'contactInformation': CreateOrderContactInformation;
+    'contactInformation': ContactInformation1;
+    /**
+     * The address to ship the order to.
+     */
     'shippingAddress': Address;
+    /**
+     * Customs and tax registration details. Required for international shipments.
+     */
     'customsInformation'?: CustomsInformation;
     /**
-     * Items to be ordered
+     * The items to include in the order. Each item references a product variant from the Product Catalog API.
+     */
+    'items': Array<CreateOrderItem>;
+    /**
+     * An optional list of preferred fulfiller IDs. When provided, the system will attempt to route the order to one of these fulfillers.
      */
-    'items': Array<OrderItem1>;
     'preferredFulfillers'?: Array<string>;
 }
-/**
- * Contact information for the order
- */
-export interface CreateOrderContactInformation {
-    'email': string;
-    'phone'?: string | null;
+export interface CreateOrderItem {
+    /**
+     * A reference to the variant being ordered
+     */
+    'variantRef': string;
+    /**
+     * The number of units to order.
+     */
+    'quantity': number;
+    'recipientCost'?: RecipientCost;
 }
 /**
  * Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
  */
 export interface CustomsInformation {
     /**
-     * Pre-registration type
+     * The type of tax pre-registration (e.g. IOSS for EU imports).
      */
     'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
     /**
-     * Pre-registration number
+     * The pre-registration number associated with the registration type.
      */
     'preRegistrationNumber'?: string;
     /**
-     * VAT number
+     * The shipper\'s VAT registration number.
      */
     'vatNumber'?: string;
     /**
-     * EORI number
+     * The shipper\'s EORI number for customs declarations.
      */
     'eoriNumber'?: string;
 }
@@ -162,23 +211,41 @@ export declare const CustomsInformationPreRegistrationTypeEnum: {
     readonly Ioss: "IOSS";
 };
 export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
+/**
+ * Customs and tax registration details for international shipments.
+ */
 export interface CustomsInformation1 {
+    /**
+     * The type of tax pre-registration (e.g. IOSS for EU imports).
+     */
     'preRegistrationType'?: string;
+    /**
+     * The pre-registration number associated with the registration type.
+     */
     'preRegistrationNumber'?: string;
+    /**
+     * The shipper\'s VAT registration number.
+     */
     'vatNumber'?: string;
+    /**
+     * The shipper\'s EORI number for customs declarations.
+     */
     'eoriNumber'?: string;
 }
+/**
+ * Estimated delivery window for this shipping method.
+ */
 export interface DeliveryEstimates {
     /**
-     * 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.
+     * 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.
      */
     'isPriority'?: boolean;
     /**
-     * ISO 8601 Timestamp
+     * The earliest estimated delivery date.
      */
     'min'?: string;
     /**
-     * ISO 8601 Timestamp
+     * The latest estimated delivery date.
      */
     'max'?: string;
 }
@@ -188,71 +255,101 @@ export interface ExportOrders202Response {
      */
     'message'?: string;
 }
+/**
+ * The fulfiller that will produce and ship this package.
+ */
+export interface Fulfiller {
+    /**
+     * Unique identifier of the fulfiller.
+     */
+    'id'?: string;
+    'location'?: FulfillerLocation;
+    /**
+     * Whether the fulfiller has the stock and capacity to begin processing immediately.
+     */
+    'canFulfillImmediately'?: boolean | null;
+}
+/**
+ * The geographic location of the fulfiller.
+ */
+export interface FulfillerLocation {
+    /**
+     * The city where the fulfiller is located.
+     */
+    'city'?: string | null;
+    /**
+     * The country code where the fulfiller is located (ISO 3166-1 alpha-2).
+     */
+    'country'?: string | null;
+}
+/**
+ * A fulfillment group within an order. Each fulfillment represents a package that will be shipped separately, potentially from a different fulfiller.
+ */
 export interface Fulfillment {
     /**
-     * Unique fulfillment id
+     * Unique identifier for this fulfillment.
      */
     'id'?: string;
+    /**
+     * The current status of this fulfillment.
+     */
     'status'?: Status;
-    'fulfiller'?: FulfillmentFulfiller;
+    'fulfiller'?: Fulfiller;
+    /**
+     * The items included in this fulfillment package.
+     */
     'items'?: Array<FulfillmentItem>;
     'tracking'?: OrderTracking | null;
     /**
-     * Shipping method currently set
+     * The shipping method currently assigned to this fulfillment.
      */
     'shippingMethod'?: ShippingMethod;
     /**
-     * Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment.
+     * Shipping methods available for this fulfillment. Use one of these IDs when confirming the order.
      */
     'availableShippingMethods'?: Array<ShippingMethod>;
     /**
-     * Weight of the package being shipped in grams
+     * The estimated weight of the package in grams.
      */
     'packageWeight'?: number;
     /**
-     * A reference to the resource location
+     * Reference to the source platform of this fulfillment.
      */
     'platformRef'?: string;
 }
-/**
- * The fulfiller that will be processing this order.
- */
-export interface FulfillmentFulfiller {
-    /**
-     * Unique object identifier
-     */
-    'id'?: string;
-    'location'?: FulfillmentFulfillerLocation;
-    'canFulfillImmediately'?: boolean | null;
-}
-export interface FulfillmentFulfillerLocation {
-    'city'?: string | null;
-    'country'?: string | null;
-}
 export interface FulfillmentItem {
     /**
-     * Unique fulfillment item id
+     * Unique identifier for this fulfillment item.
      */
     'id'?: string;
     /**
-     * Id of the order item being fulfilled
+     * The ID of the order item being fulfilled.
      */
     'itemId'?: string;
     /**
-     * Number of this item being fulfilled
+     * The number of units of this item included in the fulfillment.
      */
     'quantity'?: number;
 }
 /**
- * Image description
+ * A product image associated with an order item.
  */
 export interface Image {
     /**
-     * Unique object identifier
+     * Unique identifier for this image.
      */
     'id'?: string;
+    /**
+     * The URL of the image.
+     */
     'src'?: string;
+    /**
+     * Alternative text describing the image content.
+     */
     'alt'?: string;
+    /**
+     * The display order of this image relative to other images for the same item.
+     */
     'sortOrder'?: number;
 }
 export interface Option {
@@ -265,6 +362,9 @@ export interface Option {
      */
     'value': string;
 }
+/**
+ * Represents a print-on-demand order placed on a project. An order contains items, fulfillment details, pricing, and status tracking.
+ */
 export interface Order {
     /**
      * Unique object identifier
@@ -274,42 +374,81 @@ export interface Order {
      * A reference to the resource location
      */
     'ref'?: string;
+    /**
+     * The current status of the order.
+     */
     'status'?: Status;
     'contactInformation': ContactInformation;
     'paymentMethod'?: PaymentMethod;
+    /**
+     * The address the order will be shipped to.
+     */
     'shippingAddress': Address;
     'customsInformation'?: CustomsInformation1;
     /**
-     * ISO 8601 Timestamp
+     * When the order was created.
      */
     'createdAt'?: string;
     /**
-     * ISO 8601 Timestamp
+     * When the order was last updated.
      */
     'updatedAt'?: string;
     /**
-     * ISO 8601 Timestamp
+     * When the order status last changed.
      */
     'statusChangedAt'?: string;
     /**
-     * A custom reference to the merchant\'s order.
+     * Your own reference for this order, such as an order number from your storefront.
      */
     'merchantReference'?: string | null;
+    /**
+     * The fulfillment groups for this order. Each fulfillment represents a package that will be shipped separately.
+     */
     'fulfillments'?: Array<Fulfillment>;
+    /**
+     * The line items included in this order.
+     */
     'items': Array<OrderItem>;
+    /**
+     * The total price of the order including tax and after discounts.
+     */
     'totalPrice'?: Price;
+    /**
+     * The total tax amount for the order.
+     */
     'taxPrice'?: Price;
+    /**
+     * The net items price excluding tax and before discounts.
+     */
     'subtotalPrice'?: Price;
+    /**
+     * The total discount amount applied to the order.
+     */
     'discountPrice'?: Price;
+    /**
+     * The coupon applied to the order, if any.
+     */
     'coupon'?: Coupon | null;
+    /**
+     * The total shipping cost for the order.
+     */
     'shippingPrice'?: Price;
     'origin'?: Origin;
+    /**
+     * A chronological list of status changes for this order.
+     */
     'statusHistory'?: Array<StatusHistoryItem>;
+    /**
+     * A list of payment attempts made for this order.
+     */
     'paymentAttempts'?: Array<PaymentAttempt>;
 }
+/**
+ * A line item in an order, representing a specific product variant and quantity.
+ */
 export interface OrderItem {
     /**
-     * Unique object identifier
+     * Unique identifier for this order item.
      */
     'id'?: string;
     /**
@@ -320,42 +459,54 @@ export interface OrderItem {
      * Options associated to an order item\'s variant, such as color and size.
      */
     'options'?: Array<Option>;
+    /**
+     * The number of units of this variant to order.
+     */
     'quantity': number;
     /**
-     * The name of the product
+     * The display name of the product.
      */
     'name'?: string;
     /**
-     * Images
+     * Product images associated with this item.
      */
     'images'?: Array<Image>;
+    /**
+     * The total price for this line item including tax and after discounts.
+     */
     'totalPrice'?: Price;
     /**
-     * This is an estimate until the order has been confirmed
+     * The tax amount for this line item. This is an estimate until the order has been confirmed.
      */
     'taxPrice'?: Price;
+    /**
+     * The net price for this line item, excluding tax and before discounts.
+     */
     'subtotalPrice'?: Price;
+    /**
+     * The discount amount applied to this line item.
+     */
     'discountPrice'?: Price;
     /**
-     * The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues.
+     * The price you charged the recipient for each item. Highly recommended for international orders as it aids customs declarations.
      */
     'recipientCost'?: Price;
 }
-export interface OrderItem1 {
+/**
+ * Shipment tracking information. Available once the fulfillment has been dispatched.
+ */
+export interface OrderTracking {
     /**
-     * A reference to the variant being ordered
+     * The name of the courier service.
      */
-    'variantRef': string;
-    'quantity': number;
-    'recipientCost'?: OrderItem1RecipientCost;
-}
-export interface OrderItem1RecipientCost {
-    'amount': string;
-    'currencyCode': string;
-}
-export interface OrderTracking {
     'courier'?: string;
+    /**
+     * The tracking code provided by the courier.
+     */
     'code'?: string;
+    /**
+     * A URL to track the shipment on the courier\'s website.
+     */
     'url'?: string;
 }
 export interface OrdersResponse {
@@ -365,17 +516,35 @@ export interface OrdersResponse {
      */
     'nextPageToken'?: number | null;
 }
+/**
+ * The marketing or acquisition source of the order, such as `facebook_cpc`, `google_cpc`, or `organic`.
+ */
 export interface Origin {
+    /**
+     * A short identifier for the acquisition source, such as `facebook_cpc`, `google_cpc`, `instagram_cpc`, or `organic`.
+     */
     'code'?: string;
+    /**
+     * Whether this origin represents paid advertising traffic.
+     */
     'isPaid'?: boolean;
 }
-/**
- * List of payment attempts for this order
- */
 export interface PaymentAttempt {
+    /**
+     * The payment provider used.
+     */
     'paymentProvider'?: PaymentAttemptPaymentProviderEnum;
+    /**
+     * The outcome of the payment attempt.
+     */
     'status'?: PaymentAttemptStatusEnum;
+    /**
+     * The transaction ID from the payment provider.
+     */
     'transactionId'?: string | null;
+    /**
+     * A human-readable message describing the payment result.
+     */
     'message'?: string;
     /**
      * ISO 8601 Timestamp
@@ -395,35 +564,129 @@ export declare const PaymentAttemptStatusEnum: {
     readonly Cancelled: "cancelled";
 };
 export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
+/**
+ * The payment method used for this order.
+ */
 export interface PaymentMethod {
+    /**
+     * The type of payment method used.
+     */
     'type'?: string | null;
 }
 /**
- * Standard price definition that defines the amount and currency.
+ * A monetary value with its currency.
  */
 export interface Price {
     /**
-     * Price including tax in the specified currency.
+     * The monetary amount as a decimal string.
      */
     'amount'?: string;
     /**
-     * Currency code for the currency the price is valued in.
+     * ISO 4217 currency code.
      */
     'currencyCode'?: string;
 }
-export interface ShippingMethod {
+/**
+ * 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).
+ */
+export interface ProductUnavailableError {
+    'code': ProductUnavailableErrorCodeEnum;
+    /**
+     * Human-readable description including the product name.
+     */
+    'message': string;
+    /**
+     * Display name of the product.
+     */
+    'productTitle': string;
     /**
      * Unique object identifier
      */
+    'variantId': string;
+    /**
+     * A reference to the variant being ordered
+     */
+    'variantRef': string;
+    /**
+     * The quantity that was requested in the order.
+     */
+    'requestedQuantity': number;
+    /**
+     * Always 0 for this error type.
+     */
+    'availableQuantity': ProductUnavailableErrorAvailableQuantityEnum;
+    /**
+     * The full requested quantity, representing the total unfulfillable amount.
+     */
+    'shortage': number;
+}
+export declare const ProductUnavailableErrorCodeEnum: {
+    readonly ProductUnavailable: "PRODUCT_UNAVAILABLE";
+};
+export type ProductUnavailableErrorCodeEnum = typeof ProductUnavailableErrorCodeEnum[keyof typeof ProductUnavailableErrorCodeEnum];
+export declare const ProductUnavailableErrorAvailableQuantityEnum: {
+    readonly NUMBER_0: 0;
+};
+export type ProductUnavailableErrorAvailableQuantityEnum = typeof ProductUnavailableErrorAvailableQuantityEnum[keyof typeof ProductUnavailableErrorAvailableQuantityEnum];
+/**
+ * The price you charged the end customer for this item. Highly recommended for international orders as it is used for customs declarations.
+ */
+export interface RecipientCost {
+    /**
+     * The monetary amount as a decimal string.
+     */
+    'amount': string;
+    /**
+     * ISO 4217 currency code.
+     */
+    'currencyCode': string;
+}
+/**
+ * Your own shipping label details.
+ */
+export interface Shipment {
+    /**
+     * A URL to the shipping label image or PDF.
+     */
+    'image': string;
+}
+/**
+ * A shipping option available for a fulfillment, including delivery estimates and pricing.
+ */
+export interface ShippingMethod {
+    /**
+     * Unique identifier for this shipping method. Use this when confirming a fulfillment.
+     */
     'id'?: string;
+    /**
+     * The display name of the shipping method.
+     */
     'name'?: string;
+    /**
+     * A brief description of the shipping method\'s service level.
+     */
     'description'?: string;
     'deliveryEstimates'?: DeliveryEstimates;
+    /**
+     * The total shipping cost including tax.
+     */
     'totalPrice'?: Price;
+    /**
+     * The tax portion of the shipping cost.
+     */
     'taxPrice'?: Price;
+    /**
+     * The net shipping cost, excluding tax and before discounts.
+     */
     'subtotalPrice'?: Price;
+    /**
+     * Any discount applied to the shipping cost.
+     */
     'discountPrice'?: Price;
 }
+/**
+ * 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 declare const Status: {
     readonly New: "new";
     readonly Paid: "paid";
@@ -441,6 +704,52 @@ export interface StatusHistoryItem {
      */
     'createdAt'?: string;
 }
+/**
+ * @type StockConflictError
+ */
+export type StockConflictError = {
+    code: 'PRODUCT_UNAVAILABLE';
+} & ProductUnavailableError | {
+    code: 'STOCK_UNAVAILABLE';
+} & StockUnavailableError;
+/**
+ * The requested quantity exceeds available stock. The item can still be ordered in a smaller quantity.
+ */
+export interface StockUnavailableError {
+    'code': StockUnavailableErrorCodeEnum;
+    /**
+     * Human-readable description including the product name and available quantity.
+     */
+    'message': string;
+    /**
+     * Display name of the product.
+     */
+    'productTitle': string;
+    /**
+     * Unique object identifier
+     */
+    'variantId': string;
+    /**
+     * A reference to the variant being ordered
+     */
+    'variantRef': string;
+    /**
+     * The quantity that was requested in the order.
+     */
+    'requestedQuantity': number;
+    /**
+     * The quantity currently available for fulfillment.
+     */
+    'availableQuantity': number;
+    /**
+     * The difference between requested and available quantity (positive value indicating the deficit).
+     */
+    'shortage': number;
+}
+export declare const StockUnavailableErrorCodeEnum: {
+    readonly StockUnavailable: "STOCK_UNAVAILABLE";
+};
+export type StockUnavailableErrorCodeEnum = typeof StockUnavailableErrorCodeEnum[keyof typeof StockUnavailableErrorCodeEnum];
 /**
  * OrdersApi - axios parameter creator
  */
@@ -448,7 +757,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: 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.
@@ -458,9 +767,9 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: 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}
@@ -469,7 +778,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: 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.
@@ -479,7 +788,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: 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}
@@ -488,9 +797,9 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: 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}
@@ -499,7 +808,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: 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.
@@ -509,15 +818,15 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: 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}
@@ -526,7 +835,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: 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.
@@ -541,7 +850,7 @@ export declare const OrdersApiFp: (configuration?: 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.
@@ -551,9 +860,9 @@ export declare const OrdersApiFp: (configuration?: 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}
@@ -562,7 +871,7 @@ export declare const OrdersApiFp: (configuration?: 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.
@@ -572,7 +881,7 @@ export declare const OrdersApiFp: (configuration?: 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}
@@ -581,9 +890,9 @@ export declare const OrdersApiFp: (configuration?: 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}
@@ -592,7 +901,7 @@ export declare const OrdersApiFp: (configuration?: 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.
@@ -602,15 +911,15 @@ export declare const OrdersApiFp: (configuration?: 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}
@@ -619,7 +928,7 @@ export declare const OrdersApiFp: (configuration?: 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.
@@ -701,7 +1010,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
  */
 export interface OrdersApiCancelOrderRequest {
     /**
-     * What project it is
+     * The project identifier to scope the request to.
      */
     readonly project: string;
     /**
@@ -718,7 +1027,7 @@ export interface OrdersApiCancelOrderRequest {
  */
 export interface OrdersApiConfirmOrderRequest {
     /**
-     * What project it is
+     * The project identifier to scope the request to.
      */
     readonly project: string;
     /**
@@ -726,7 +1035,7 @@ export interface OrdersApiConfirmOrderRequest {
      */
     readonly orderId: string;
     /**
-     * ConfirmFulfillment schema
+     * 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.
      */
     readonly confirmOrderRequest: ConfirmOrderRequest;
     /**
@@ -739,7 +1048,7 @@ export interface OrdersApiConfirmOrderRequest {
  */
 export interface OrdersApiCreateOrderRequest {
     /**
-     * What project it is
+     * The project identifier to scope the request to.
      */
     readonly project: string;
     /**
@@ -756,7 +1065,7 @@ export interface OrdersApiCreateOrderRequest {
  */
 export interface OrdersApiDownloadInvoiceRequest {
     /**
-     * What project it is
+     * The project identifier to scope the request to.
      */
     readonly project: string;
     /**
@@ -769,15 +1078,15 @@ export interface OrdersApiDownloadInvoiceRequest {
  */
 export interface OrdersApiExportOrdersRequest {
     /**
-     * What project it is
+     * The project identifier to scope the request to.
      */
     readonly project: string;
     /**
-     * Start of date range to filter by when orders were placed
+     * Start of the date range to filter by when orders were placed.
      */
     readonly start: string;
     /**
-     * End of date range
+     * End of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
      */
     readonly end?: string;
     /**
@@ -790,7 +1099,7 @@ export interface OrdersApiExportOrdersRequest {
  */
 export interface OrdersApiGetOrderRequest {
     /**
-     * What project it is
+     * The project identifier to scope the request to.
      */
     readonly project: string;
     /**
@@ -807,7 +1116,7 @@ export interface OrdersApiGetOrderRequest {
  */
 export interface OrdersApiGetOrdersRequest {
     /**
-     * What project it is
+     * The project identifier to scope the request to.
      */
     readonly project: string;
     /**
@@ -827,19 +1136,19 @@ export interface OrdersApiGetOrdersRequest {
      */
     readonly search?: string;
     /**
-     * Specify fulfillment IDs to list
+     * Filter to specific order IDs. Only orders matching these IDs will be returned.
      */
     readonly ids?: Array<string>;
     /**
-     * Filter by fulfillment status
+     * Filter by order status. Only orders matching one of the given statuses will be returned.
      */
     readonly statuses?: Array<Status>;
     /**
-     * Start of date range
+     * Start of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
      */
     readonly start?: string;
     /**
-     * End of date range
+     * End of date range filter. Which date field this applies to is controlled by the &#x60;dateFilterType&#x60; parameter.
      */
     readonly end?: string;
     /**
@@ -852,7 +1161,7 @@ export interface OrdersApiGetOrdersRequest {
  */
 export interface OrdersApiRetryPlatformPaymentRequest {
     /**
-     * What project it is
+     * The project identifier to scope the request to.
      */
     readonly project: string;
     /**