/** * 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 type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { NewOrder } from '../models'; import { NewReconsignmentAnnouncement } from '../models'; import { Order } from '../models'; import { OrderBulkImport207ResponseInner } from '../models'; import { OrderCollection } from '../models'; import { ReconsignmentAnnouncement } from '../models'; /** * OrderApi - axios parameter creator * @export */ export declare const OrderApiAxiosParamCreator: (configuration?: Configuration) => { /** * Cancel the order specified by the given order number (set in param orderNumber). An orderNumber from a canceled order cannot be used for a new order, because they must always be unique. * @summary Cancel an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelOrder: (orderNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise; /** * Get an order by order number. * @summary Get an order by order number. * @param {string} orderNumber The order number as defined during the creation of the order. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrder: (orderNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise; /** * Get a spreadsheet template for performing POST queries to the respective endpoint. The file type is controlled by the accept header. The fill-in help in the second line can be removed or remain. * @summary Get a spreadsheet template for performing POST queries to the respective endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrderBulkImportTemplate: (options?: AxiosRequestConfig) => Promise; /** * Get a list of shop orders. * @summary Get a list of shop orders. * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {string} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority. Available sort orders: - asc: ascending order - desc: descending order Available fields for sorting: - orderDate The default sort order is orderDate:desc. * @param {string} [filterShopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {string} [filterStatus] Filter for status/statuses (optional). * @param {string} [filterExternalOrderId] Filter for the external order ID e.g. from third party apps (optional) * @param {string} [filterExternalCustomerId] Filter for the external customer ID e.g. from third party apps (optional) * @param {string} [filterExternalOrderReference] filter for externalOrderReference * @param {string} [filterOrderDateFrom] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderDateTo] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderNumber] Filter for order number(s). * @param {string} [filterSearch] filter for order search. Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields \'externalOrderReference\', \'externalOrderId\', \'customer.deliveryAddress.nameLine1\', \'customer.deliveryAddress.nameLine2\', \'orderNumber\' and the tracking code of the orders shipments. - Each search term filters the response for orders where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for orders where \'term1\' is found in any field and \'term2\' is also found in any field. If only \'term1\' or \'term2\' is found in the fields, the order is not included in the results. * @param {'allOrderItems' | 'notAllOrderItems'} [filterDeliverabilityStatus] filter for deliverabilityStatus By default, all orders are returned. Use \'allOrderItems\' to return all deliverable orders (\'availableCount\' of all \'orderItems\' is greater or equal than the ordered \'count\') Use \'notAllOrderItems\' to specifically return not deliverable orders (\'availableCount\' of at least one \'orderItem\' is smaller than the ordered \'count\' * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrderCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterStatus?: string, filterExternalOrderId?: string, filterExternalCustomerId?: string, filterExternalOrderReference?: string, filterOrderDateFrom?: string, filterOrderDateTo?: string, filterOrderNumber?: string, filterSearch?: string, filterDeliverabilityStatus?: 'allOrderItems' | 'notAllOrderItems', options?: AxiosRequestConfig) => Promise; /** * Import one or more new orders. The file type is controlled by the content type attribute of the uploaded file * @summary Import one or more new orders. * @param {File} file File to upload * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBulkImport: (file: File, options?: AxiosRequestConfig) => Promise; /** * Add a new order referenced by the given orderNumber. * @summary Add a new order. * @param {string} orderNumber The number the order should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field). \\ Please ensure that it does not contain any of the following character sequences: \'/\', \'%2F\', \'%2f\', \'?\', \'%3F\', \'%3f\',\'#\', \'%23\', \'&\', \'%26\'. \\ Using any of these will result in the route not being handled correctly. * @param {NewOrder} newOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOrder: (orderNumber: string, newOrder: NewOrder, options?: AxiosRequestConfig) => Promise; /** * Cancel all open order items of the order specified by the given order number (set in param orderNumber). * @summary Cancel open order items. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOrderCancelOpenOrderItems: (orderNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise; /** * Trigger partial delivery for the order specified by the given order number (set in param orderNumber). * @summary Trigger partial delivery for an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOrderPartialDelivery: (orderNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise; /** * Create reconsignment announcements for an order. \\ Only delivered orders are reconsignable. \\ If the order has been redacted, it is also not reconsignable. \\ The created reconsignment announcement(s) are returned in the response. * @summary Create reconsignment announcements for an order. * @param {string} orderNumber The number the order is referred by. * @param {NewReconsignmentAnnouncement} newReconsignmentAnnouncement * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ reconsignOrder: (orderNumber: string, newReconsignmentAnnouncement: NewReconsignmentAnnouncement, shopCode?: string, options?: AxiosRequestConfig) => Promise; /** * Redact the order and all other orders linked to the given order number (set in the param orderNumber) in a GDPR article 17 conform way. \\ Only orders with one of the following statuses are redactable: - delivered - deleted - canceled * @summary Redact an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ redactOrder: (orderNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise; }; /** * OrderApi - functional programming interface * @export */ export declare const OrderApiFp: (configuration?: Configuration) => { /** * Cancel the order specified by the given order number (set in param orderNumber). An orderNumber from a canceled order cannot be used for a new order, because they must always be unique. * @summary Cancel an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelOrder(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get an order by order number. * @summary Get an order by order number. * @param {string} orderNumber The order number as defined during the creation of the order. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrder(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a spreadsheet template for performing POST queries to the respective endpoint. The file type is controlled by the accept header. The fill-in help in the second line can be removed or remain. * @summary Get a spreadsheet template for performing POST queries to the respective endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrderBulkImportTemplate(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of shop orders. * @summary Get a list of shop orders. * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {string} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority. Available sort orders: - asc: ascending order - desc: descending order Available fields for sorting: - orderDate The default sort order is orderDate:desc. * @param {string} [filterShopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {string} [filterStatus] Filter for status/statuses (optional). * @param {string} [filterExternalOrderId] Filter for the external order ID e.g. from third party apps (optional) * @param {string} [filterExternalCustomerId] Filter for the external customer ID e.g. from third party apps (optional) * @param {string} [filterExternalOrderReference] filter for externalOrderReference * @param {string} [filterOrderDateFrom] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderDateTo] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderNumber] Filter for order number(s). * @param {string} [filterSearch] filter for order search. Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields \'externalOrderReference\', \'externalOrderId\', \'customer.deliveryAddress.nameLine1\', \'customer.deliveryAddress.nameLine2\', \'orderNumber\' and the tracking code of the orders shipments. - Each search term filters the response for orders where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for orders where \'term1\' is found in any field and \'term2\' is also found in any field. If only \'term1\' or \'term2\' is found in the fields, the order is not included in the results. * @param {'allOrderItems' | 'notAllOrderItems'} [filterDeliverabilityStatus] filter for deliverabilityStatus By default, all orders are returned. Use \'allOrderItems\' to return all deliverable orders (\'availableCount\' of all \'orderItems\' is greater or equal than the ordered \'count\') Use \'notAllOrderItems\' to specifically return not deliverable orders (\'availableCount\' of at least one \'orderItem\' is smaller than the ordered \'count\' * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrderCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterStatus?: string, filterExternalOrderId?: string, filterExternalCustomerId?: string, filterExternalOrderReference?: string, filterOrderDateFrom?: string, filterOrderDateTo?: string, filterOrderNumber?: string, filterSearch?: string, filterDeliverabilityStatus?: 'allOrderItems' | 'notAllOrderItems', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Import one or more new orders. The file type is controlled by the content type attribute of the uploaded file * @summary Import one or more new orders. * @param {File} file File to upload * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBulkImport(file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Add a new order referenced by the given orderNumber. * @summary Add a new order. * @param {string} orderNumber The number the order should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field). \\ Please ensure that it does not contain any of the following character sequences: \'/\', \'%2F\', \'%2f\', \'?\', \'%3F\', \'%3f\',\'#\', \'%23\', \'&\', \'%26\'. \\ Using any of these will result in the route not being handled correctly. * @param {NewOrder} newOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOrder(orderNumber: string, newOrder: NewOrder, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Cancel all open order items of the order specified by the given order number (set in param orderNumber). * @summary Cancel open order items. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOrderCancelOpenOrderItems(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Trigger partial delivery for the order specified by the given order number (set in param orderNumber). * @summary Trigger partial delivery for an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOrderPartialDelivery(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create reconsignment announcements for an order. \\ Only delivered orders are reconsignable. \\ If the order has been redacted, it is also not reconsignable. \\ The created reconsignment announcement(s) are returned in the response. * @summary Create reconsignment announcements for an order. * @param {string} orderNumber The number the order is referred by. * @param {NewReconsignmentAnnouncement} newReconsignmentAnnouncement * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ reconsignOrder(orderNumber: string, newReconsignmentAnnouncement: NewReconsignmentAnnouncement, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Redact the order and all other orders linked to the given order number (set in the param orderNumber) in a GDPR article 17 conform way. \\ Only orders with one of the following statuses are redactable: - delivered - deleted - canceled * @summary Redact an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ redactOrder(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OrderApi - factory interface * @export */ export declare const OrderApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Cancel the order specified by the given order number (set in param orderNumber). An orderNumber from a canceled order cannot be used for a new order, because they must always be unique. * @summary Cancel an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelOrder(orderNumber: string, shopCode?: string, options?: any): AxiosPromise; /** * Get an order by order number. * @summary Get an order by order number. * @param {string} orderNumber The order number as defined during the creation of the order. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrder(orderNumber: string, shopCode?: string, options?: any): AxiosPromise; /** * Get a spreadsheet template for performing POST queries to the respective endpoint. The file type is controlled by the accept header. The fill-in help in the second line can be removed or remain. * @summary Get a spreadsheet template for performing POST queries to the respective endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrderBulkImportTemplate(options?: any): AxiosPromise; /** * Get a list of shop orders. * @summary Get a list of shop orders. * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {string} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority. Available sort orders: - asc: ascending order - desc: descending order Available fields for sorting: - orderDate The default sort order is orderDate:desc. * @param {string} [filterShopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {string} [filterStatus] Filter for status/statuses (optional). * @param {string} [filterExternalOrderId] Filter for the external order ID e.g. from third party apps (optional) * @param {string} [filterExternalCustomerId] Filter for the external customer ID e.g. from third party apps (optional) * @param {string} [filterExternalOrderReference] filter for externalOrderReference * @param {string} [filterOrderDateFrom] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderDateTo] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderNumber] Filter for order number(s). * @param {string} [filterSearch] filter for order search. Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields \'externalOrderReference\', \'externalOrderId\', \'customer.deliveryAddress.nameLine1\', \'customer.deliveryAddress.nameLine2\', \'orderNumber\' and the tracking code of the orders shipments. - Each search term filters the response for orders where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for orders where \'term1\' is found in any field and \'term2\' is also found in any field. If only \'term1\' or \'term2\' is found in the fields, the order is not included in the results. * @param {'allOrderItems' | 'notAllOrderItems'} [filterDeliverabilityStatus] filter for deliverabilityStatus By default, all orders are returned. Use \'allOrderItems\' to return all deliverable orders (\'availableCount\' of all \'orderItems\' is greater or equal than the ordered \'count\') Use \'notAllOrderItems\' to specifically return not deliverable orders (\'availableCount\' of at least one \'orderItem\' is smaller than the ordered \'count\' * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrderCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterStatus?: string, filterExternalOrderId?: string, filterExternalCustomerId?: string, filterExternalOrderReference?: string, filterOrderDateFrom?: string, filterOrderDateTo?: string, filterOrderNumber?: string, filterSearch?: string, filterDeliverabilityStatus?: 'allOrderItems' | 'notAllOrderItems', options?: any): AxiosPromise; /** * Import one or more new orders. The file type is controlled by the content type attribute of the uploaded file * @summary Import one or more new orders. * @param {File} file File to upload * @param {*} [options] Override http request option. * @throws {RequiredError} */ orderBulkImport(file: File, options?: any): AxiosPromise>; /** * Add a new order referenced by the given orderNumber. * @summary Add a new order. * @param {string} orderNumber The number the order should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field). \\ Please ensure that it does not contain any of the following character sequences: \'/\', \'%2F\', \'%2f\', \'?\', \'%3F\', \'%3f\',\'#\', \'%23\', \'&\', \'%26\'. \\ Using any of these will result in the route not being handled correctly. * @param {NewOrder} newOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOrder(orderNumber: string, newOrder: NewOrder, options?: any): AxiosPromise; /** * Cancel all open order items of the order specified by the given order number (set in param orderNumber). * @summary Cancel open order items. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOrderCancelOpenOrderItems(orderNumber: string, shopCode?: string, options?: any): AxiosPromise; /** * Trigger partial delivery for the order specified by the given order number (set in param orderNumber). * @summary Trigger partial delivery for an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOrderPartialDelivery(orderNumber: string, shopCode?: string, options?: any): AxiosPromise; /** * Create reconsignment announcements for an order. \\ Only delivered orders are reconsignable. \\ If the order has been redacted, it is also not reconsignable. \\ The created reconsignment announcement(s) are returned in the response. * @summary Create reconsignment announcements for an order. * @param {string} orderNumber The number the order is referred by. * @param {NewReconsignmentAnnouncement} newReconsignmentAnnouncement * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ reconsignOrder(orderNumber: string, newReconsignmentAnnouncement: NewReconsignmentAnnouncement, shopCode?: string, options?: any): AxiosPromise>; /** * Redact the order and all other orders linked to the given order number (set in the param orderNumber) in a GDPR article 17 conform way. \\ Only orders with one of the following statuses are redactable: - delivered - deleted - canceled * @summary Redact an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} */ redactOrder(orderNumber: string, shopCode?: string, options?: any): AxiosPromise; }; /** * OrderApi - interface * @export * @interface OrderApi */ export interface OrderApiInterface { /** * Cancel the order specified by the given order number (set in param orderNumber). An orderNumber from a canceled order cannot be used for a new order, because they must always be unique. * @summary Cancel an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ cancelOrder(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise; /** * Get an order by order number. * @summary Get an order by order number. * @param {string} orderNumber The order number as defined during the creation of the order. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ getOrder(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise; /** * Get a spreadsheet template for performing POST queries to the respective endpoint. The file type is controlled by the accept header. The fill-in help in the second line can be removed or remain. * @summary Get a spreadsheet template for performing POST queries to the respective endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ getOrderBulkImportTemplate(options?: AxiosRequestConfig): AxiosPromise; /** * Get a list of shop orders. * @summary Get a list of shop orders. * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {string} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority. Available sort orders: - asc: ascending order - desc: descending order Available fields for sorting: - orderDate The default sort order is orderDate:desc. * @param {string} [filterShopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {string} [filterStatus] Filter for status/statuses (optional). * @param {string} [filterExternalOrderId] Filter for the external order ID e.g. from third party apps (optional) * @param {string} [filterExternalCustomerId] Filter for the external customer ID e.g. from third party apps (optional) * @param {string} [filterExternalOrderReference] filter for externalOrderReference * @param {string} [filterOrderDateFrom] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderDateTo] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderNumber] Filter for order number(s). * @param {string} [filterSearch] filter for order search. Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields \'externalOrderReference\', \'externalOrderId\', \'customer.deliveryAddress.nameLine1\', \'customer.deliveryAddress.nameLine2\', \'orderNumber\' and the tracking code of the orders shipments. - Each search term filters the response for orders where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for orders where \'term1\' is found in any field and \'term2\' is also found in any field. If only \'term1\' or \'term2\' is found in the fields, the order is not included in the results. * @param {'allOrderItems' | 'notAllOrderItems'} [filterDeliverabilityStatus] filter for deliverabilityStatus By default, all orders are returned. Use \'allOrderItems\' to return all deliverable orders (\'availableCount\' of all \'orderItems\' is greater or equal than the ordered \'count\') Use \'notAllOrderItems\' to specifically return not deliverable orders (\'availableCount\' of at least one \'orderItem\' is smaller than the ordered \'count\' * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ getOrderCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterStatus?: string, filterExternalOrderId?: string, filterExternalCustomerId?: string, filterExternalOrderReference?: string, filterOrderDateFrom?: string, filterOrderDateTo?: string, filterOrderNumber?: string, filterSearch?: string, filterDeliverabilityStatus?: 'allOrderItems' | 'notAllOrderItems', options?: AxiosRequestConfig): AxiosPromise; /** * Import one or more new orders. The file type is controlled by the content type attribute of the uploaded file * @summary Import one or more new orders. * @param {File} file File to upload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ orderBulkImport(file: File, options?: AxiosRequestConfig): AxiosPromise>; /** * Add a new order referenced by the given orderNumber. * @summary Add a new order. * @param {string} orderNumber The number the order should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field). \\ Please ensure that it does not contain any of the following character sequences: \'/\', \'%2F\', \'%2f\', \'?\', \'%3F\', \'%3f\',\'#\', \'%23\', \'&\', \'%26\'. \\ Using any of these will result in the route not being handled correctly. * @param {NewOrder} newOrder * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ postOrder(orderNumber: string, newOrder: NewOrder, options?: AxiosRequestConfig): AxiosPromise; /** * Cancel all open order items of the order specified by the given order number (set in param orderNumber). * @summary Cancel open order items. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ postOrderCancelOpenOrderItems(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise; /** * Trigger partial delivery for the order specified by the given order number (set in param orderNumber). * @summary Trigger partial delivery for an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ postOrderPartialDelivery(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise; /** * Create reconsignment announcements for an order. \\ Only delivered orders are reconsignable. \\ If the order has been redacted, it is also not reconsignable. \\ The created reconsignment announcement(s) are returned in the response. * @summary Create reconsignment announcements for an order. * @param {string} orderNumber The number the order is referred by. * @param {NewReconsignmentAnnouncement} newReconsignmentAnnouncement * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ reconsignOrder(orderNumber: string, newReconsignmentAnnouncement: NewReconsignmentAnnouncement, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise>; /** * Redact the order and all other orders linked to the given order number (set in the param orderNumber) in a GDPR article 17 conform way. \\ Only orders with one of the following statuses are redactable: - delivered - deleted - canceled * @summary Redact an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApiInterface */ redactOrder(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise; } /** * OrderApi - object-oriented interface * @export * @class OrderApi * @extends {BaseAPI} */ export declare class OrderApi extends BaseAPI implements OrderApiInterface { /** * Cancel the order specified by the given order number (set in param orderNumber). An orderNumber from a canceled order cannot be used for a new order, because they must always be unique. * @summary Cancel an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ cancelOrder(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise>; /** * Get an order by order number. * @summary Get an order by order number. * @param {string} orderNumber The order number as defined during the creation of the order. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ getOrder(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise>; /** * Get a spreadsheet template for performing POST queries to the respective endpoint. The file type is controlled by the accept header. The fill-in help in the second line can be removed or remain. * @summary Get a spreadsheet template for performing POST queries to the respective endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ getOrderBulkImportTemplate(options?: AxiosRequestConfig): Promise>; /** * Get a list of shop orders. * @summary Get a list of shop orders. * @param {number} [page] The page to read. Default is the first page. * @param {number} [pageSize] The maximum size per page is 100. Default is 100. * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance. * @param {string} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority. Available sort orders: - asc: ascending order - desc: descending order Available fields for sorting: - orderDate The default sort order is orderDate:desc. * @param {string} [filterShopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {string} [filterStatus] Filter for status/statuses (optional). * @param {string} [filterExternalOrderId] Filter for the external order ID e.g. from third party apps (optional) * @param {string} [filterExternalCustomerId] Filter for the external customer ID e.g. from third party apps (optional) * @param {string} [filterExternalOrderReference] filter for externalOrderReference * @param {string} [filterOrderDateFrom] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderDateTo] filter for orderDate format in ISO 8601 with UTC offsets * @param {string} [filterOrderNumber] Filter for order number(s). * @param {string} [filterSearch] filter for order search. Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields \'externalOrderReference\', \'externalOrderId\', \'customer.deliveryAddress.nameLine1\', \'customer.deliveryAddress.nameLine2\', \'orderNumber\' and the tracking code of the orders shipments. - Each search term filters the response for orders where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for orders where \'term1\' is found in any field and \'term2\' is also found in any field. If only \'term1\' or \'term2\' is found in the fields, the order is not included in the results. * @param {'allOrderItems' | 'notAllOrderItems'} [filterDeliverabilityStatus] filter for deliverabilityStatus By default, all orders are returned. Use \'allOrderItems\' to return all deliverable orders (\'availableCount\' of all \'orderItems\' is greater or equal than the ordered \'count\') Use \'notAllOrderItems\' to specifically return not deliverable orders (\'availableCount\' of at least one \'orderItem\' is smaller than the ordered \'count\' * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ getOrderCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterStatus?: string, filterExternalOrderId?: string, filterExternalCustomerId?: string, filterExternalOrderReference?: string, filterOrderDateFrom?: string, filterOrderDateTo?: string, filterOrderNumber?: string, filterSearch?: string, filterDeliverabilityStatus?: 'allOrderItems' | 'notAllOrderItems', options?: AxiosRequestConfig): Promise>; /** * Import one or more new orders. The file type is controlled by the content type attribute of the uploaded file * @summary Import one or more new orders. * @param {File} file File to upload * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ orderBulkImport(file: File, options?: AxiosRequestConfig): Promise>; /** * Add a new order referenced by the given orderNumber. * @summary Add a new order. * @param {string} orderNumber The number the order should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field). \\ Please ensure that it does not contain any of the following character sequences: \'/\', \'%2F\', \'%2f\', \'?\', \'%3F\', \'%3f\',\'#\', \'%23\', \'&\', \'%26\'. \\ Using any of these will result in the route not being handled correctly. * @param {NewOrder} newOrder * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ postOrder(orderNumber: string, newOrder: NewOrder, options?: AxiosRequestConfig): Promise>; /** * Cancel all open order items of the order specified by the given order number (set in param orderNumber). * @summary Cancel open order items. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ postOrderCancelOpenOrderItems(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise>; /** * Trigger partial delivery for the order specified by the given order number (set in param orderNumber). * @summary Trigger partial delivery for an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ postOrderPartialDelivery(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise>; /** * Create reconsignment announcements for an order. \\ Only delivered orders are reconsignable. \\ If the order has been redacted, it is also not reconsignable. \\ The created reconsignment announcement(s) are returned in the response. * @summary Create reconsignment announcements for an order. * @param {string} orderNumber The number the order is referred by. * @param {NewReconsignmentAnnouncement} newReconsignmentAnnouncement * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ reconsignOrder(orderNumber: string, newReconsignmentAnnouncement: NewReconsignmentAnnouncement, shopCode?: string, options?: AxiosRequestConfig): Promise>; /** * Redact the order and all other orders linked to the given order number (set in the param orderNumber) in a GDPR article 17 conform way. \\ Only orders with one of the following statuses are redactable: - delivered - deleted - canceled * @summary Redact an order. * @param {string} orderNumber The number the order is referred by. * @param {string} [shopCode] The shopCode used internally to distinguish between clients.\\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrderApi */ redactOrder(orderNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise>; }