@datenkraft/bb-fulfillment-api-ts-client/dist/Generated/models/order-all-of.d.ts

The fulfillment API TS Client enables you to work with the fulfillment API

/**
 * Fulfillment API
 *  - alpha: Currently developed API version. Subject to major changes. - beta: A semi-stable early access version. New features can be added. Breaking changes are possible. - stable: The API is recommended for use in production.  [Changelog](https://fulfillment-api.steve.niceshops.com/v2/docs/changelog.html)  All data is transferred in UTF-8 encoding.\\ The API uses stateless HTTP. No cookies have to be kept.\\ Authentication via OAuth2 client credentials flow.  [Privacy Policy](https://www.niceshops.com/en/dienstleistungen/data-privacy-policy)  [Fulfillment API PHP client @Packagist](https://packagist.org/packages/datenkraft/bb-fulfillment-api-php-client)
 *
 * The version of the OpenAPI document: v2.beta
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { OrderCustomer } from './order-customer';
import { OrderDelivery } from './order-delivery';
import { OrderItem } from './order-item';
import { OrderPayment } from './order-payment';
import { OrderShipping } from './order-shipping';
/**
 *
 * @export
 * @interface OrderAllOf
 */
export interface OrderAllOf {
    /**
     * The order number.\\ Note: If this number is prefixed with \'NICE\', it means that the order was created manually by niceshops (see \'source\').
     * @type {any}
     * @memberof OrderAllOf
     */
    'orderNumber'?: any;
    /**
     * Multiple orderItems with the same productNumber are allowed, but note that they will be merged together if all orderItem data is the same.
     * @type {Array<OrderItem>}
     * @memberof OrderAllOf
     */
    'orderItems'?: Array<OrderItem>;
    /**
     *
     * @type {OrderCustomer}
     * @memberof OrderAllOf
     */
    'customer'?: OrderCustomer;
    /**
     * The current status of the order. - new: The order was created but not every required information was given. The order can not be processed without manual intervention. - processing: The order is being processed. For split deliveries, some of the shipments might have already been transferred to the delivery agent. - delivered: The orders shipments have all been transferred to the delivery agent (Note that the update to this status might be delayed and not yet reflect the status of the linked deliveries). - deleted: The order has been marked as deleted. - canceled: The order has been canceled. - locked: The order is locked. The order can not be processed without manual intervention. - examination: The order has been manually locked. The order can not be processed without manual intervention. - redacted: The order has been redacted for GDPR reasons.
     * @type {string}
     * @memberof OrderAllOf
     */
    'status'?: OrderAllOfStatusEnum;
    /**
     * Describes why the order is locked
     * @type {string}
     * @memberof OrderAllOf
     */
    'lockReason'?: string | null;
    /**
     * The create date for the order. Format in ISO 8601
     * @type {string}
     * @memberof OrderAllOf
     */
    'orderDate'?: string;
    /**
     * Note that only deliveries with status \'delivered\' are shown in this list.
     * @type {Array<OrderDelivery>}
     * @memberof OrderAllOf
     */
    'delivery'?: Array<OrderDelivery> | null;
    /**
     *
     * @type {OrderPayment}
     * @memberof OrderAllOf
     */
    'payment'?: OrderPayment;
    /**
     *
     * @type {OrderShipping}
     * @memberof OrderAllOf
     */
    'shipping'?: OrderShipping;
    /**
     * The source of the order. - shopify: This order was created via the steve by niceshops Shopify application - nice: This order was created manually by niceshops - api: This order was created via the Fulfillment API
     * @type {string}
     * @memberof OrderAllOf
     */
    'source'?: OrderAllOfSourceEnum;
    /**
     * If available, a hyperlink to the application where this order was created is provided
     * @type {string}
     * @memberof OrderAllOf
     */
    'sourceLink'?: string | null;
    /**
     * Indicates whether the order can be canceled or not
     * @type {boolean}
     * @memberof OrderAllOf
     */
    'cancelable'?: boolean;
    /**
     * Indicates whether orderItems that are not delivered yet can be canceled or not
     * @type {boolean}
     * @memberof OrderAllOf
     */
    'orderItemsCancelable'?: boolean;
    /**
     * Indicates whether a partial delivery is pending or not. Note: If true, it means that a partial delivery has been requested but not yet processed. If false, it means that no partial delivery is currently pending.
     * @type {boolean}
     * @memberof OrderAllOf
     */
    'partialDeliveryPending'?: boolean;
}
export declare const OrderAllOfStatusEnum: {
    readonly New: "new";
    readonly Processing: "processing";
    readonly Delivered: "delivered";
    readonly Deleted: "deleted";
    readonly Canceled: "canceled";
    readonly Locked: "locked";
    readonly Examination: "examination";
    readonly Redacted: "redacted";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type OrderAllOfStatusEnum = typeof OrderAllOfStatusEnum[keyof typeof OrderAllOfStatusEnum];
export declare const OrderAllOfSourceEnum: {
    readonly Shopify: "shopify";
    readonly Nice: "nice";
    readonly Api: "api";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type OrderAllOfSourceEnum = typeof OrderAllOfSourceEnum[keyof typeof OrderAllOfSourceEnum];