@datenkraft/bb-fulfillment-api-ts-client/dist/Generated/models/base-order.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 { BaseOrderCustomer } from './base-order-customer';
import { NewOrderItem } from './new-order-item';
import { OrderDeliveryCosts } from './order-delivery-costs';
/**
 * Data to represent an order
 * @export
 * @interface BaseOrder
 */
export interface BaseOrder {
    /**
     * The shopCode used internally to distinguish between clients.
     * @type {string}
     * @memberof BaseOrder
     */
    'shopCode'?: string | null;
    /**
     *
     * @type {BaseOrderCustomer}
     * @memberof BaseOrder
     */
    'customer': BaseOrderCustomer;
    /**
     *
     * @type {Array<NewOrderItem>}
     * @memberof BaseOrder
     */
    'orderItems': Array<NewOrderItem>;
    /**
     * A not unique reference for the order which can be used for identifying a specific order or for mapping to a third party app.
     * @type {string}
     * @memberof BaseOrder
     */
    'externalOrderId'?: string | null;
    /**
     * Notes to be printed on the delivery slip.
     * @type {string}
     * @memberof BaseOrder
     */
    'deliverySlipNotes'?: string | null;
    /**
     * External reference for the order
     * @type {string}
     * @memberof BaseOrder
     */
    'externalOrderReference'?: string | null;
    /**
     * Notes for the steve team regarding the fulfillment. \\ If `meta.orderNotesPrecedingText` is set in the `shop` resource, it will be prepended to the notes.
     * @type {string}
     * @memberof BaseOrder
     */
    'orderNotes'?: string | null;
    /**
     * The Amazon seller order id used when the order is coming from the Amazon marketplace.
     * @type {string}
     * @memberof BaseOrder
     */
    'amazonSellerOrderId'?: string | null;
    /**
     * The Amazon vendor order id when sending orders to an Amazon warehouse for sales by Amazon.
     * @type {string}
     * @memberof BaseOrder
     */
    'amazonVendorOrderId'?: string | null;
    /**
     * The Amazon seller shipment id when sending a delivery to an Amazon warehouse for fulfillment by Amazon.
     * @type {string}
     * @memberof BaseOrder
     */
    'amazonFbaShipmentId'?: string | null;
    /**
     *
     * @type {Array<OrderDeliveryCosts>}
     * @memberof BaseOrder
     */
    'deliveryCosts'?: Array<OrderDeliveryCosts> | null;
    /**
     * Additional optional options for the order.
     * @type {any}
     * @memberof BaseOrder
     */
    'options'?: any | null;
}