@datenkraft/bb-fulfillment-api-ts-client
Version:
The fulfillment API TS Client enables you to work with the fulfillment API
443 lines • 53.1 kB
TypeScript
/**
* 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 { InboundDelivery } from '../models';
import { InboundDeliveryBulkImport207ResponseInner } from '../models';
import { InboundDeliveryCollection } from '../models';
import { NewInboundDelivery } from '../models';
import { PatchInboundDelivery } from '../models';
/**
* InboundDeliveryApi - axios parameter creator
* @export
*/
export declare const InboundDeliveryApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Cancel a inbound delivery referenced by the given inboundDeliveryNumber. \\ An inboundDeliveryNumber from a canceled inbound delivery cannot be used for a new inbound delivery, because they must always be unique.
* @summary Cancel a inbound delivery.
* @param {string} inboundDeliveryNumber The number the inbound delivery should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field).
* @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}
*/
cancelInboundDelivery: (inboundDeliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get an inbound delivery by inbound delivery number.
* @summary Get an inbound delivery by inbound delivery number.
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @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}
*/
getInboundDelivery: (inboundDeliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* 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}
*/
getInboundDeliveryBulkImportTemplate: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get a list of inbound deliveries.
* @summary Get a list of inbound deliveries.
* @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: - expectedDeliveryDate The default sort order is expectedDeliveryDate:desc.
* @param {string} [filterStatus] Status of the inbound delivery (optional). The status for not yet completed is subject to change. you may poll for changes. - open: The inbound delivery has not yet been delivered. - in_progress: The inbound delivery is being processed in our warehouse. - completed: The inbound delivery has been processed in our warehouse. - deleted: The inbound delivery has been deleted.
* @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} [filterExpectedDeliveryDateFrom] The start date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterExpectedDeliveryDateTo] The end date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterSearch] filter for inbound delivery 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 inboundDeliveryName and inboundDeliveryNumber. - Each search term filters the response for inbound deliveries where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for products 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 product is not included in the results.
* @param {string} [filterCreateDateFrom] The start date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {string} [filterCreateDateTo] The end date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInboundDeliveryCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterStatus?: string, filterShopCode?: string, filterExpectedDeliveryDateFrom?: string, filterExpectedDeliveryDateTo?: string, filterSearch?: string, filterCreateDateFrom?: string, filterCreateDateTo?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Allows to download a document associated with the given inbound delivery.
* @summary Download inbound delivery related documents
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @param {'supplierDeliveryLabel' | 'details'} documentCode The document type to download. The file format is determined by the Accept request header. Note: only a limited amount of document type to file format combinations are available: - supplierDeliveryLabel: the label to put on the inbound delivery for warehouse processing. Accept header: application/pdf - details: a spreadsheet containing details about the inbound delivery. Accept header: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
* @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}
*/
getInboundDeliveryDocument: (inboundDeliveryNumber: string, documentCode: 'supplierDeliveryLabel' | 'details', shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Import one or more new inbound deliveries. The file type is controlled by the content type attribute of the uploaded file
* @summary Import one or more new inbound deliveries.
* @param {File} file File to upload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundDeliveryBulkImport: (file: File, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Patch the inbound delivery specified by the given inbound delivery number. \\ Only inbound deliveries where booking-in has not yet started can be edited. \\ All fields in the request body are optional. Only provided fields will be updated. Product changes: - To update a product\'s announced count: include the product with the new announcedCount. - To remove a product: include the product with announcedCount set to 0. - To add a new product: include a product that is not yet part of the delivery with a positive announcedCount. - Products not listed in the products array remain unchanged.
* @summary Patch an inbound delivery.
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @param {PatchInboundDelivery} patchInboundDelivery
* @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}
*/
patchInboundDelivery: (inboundDeliveryNumber: string, patchInboundDelivery: PatchInboundDelivery, shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Add a new inbound delivery referenced by the given deliveryNumber.
* @summary Add a new inbound delivery.
* @param {string} inboundDeliveryNumber The number the inbound delivery 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 {NewInboundDelivery} newInboundDelivery
* @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}
*/
postInboundDelivery: (inboundDeliveryNumber: string, newInboundDelivery: NewInboundDelivery, shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* InboundDeliveryApi - functional programming interface
* @export
*/
export declare const InboundDeliveryApiFp: (configuration?: Configuration) => {
/**
* Cancel a inbound delivery referenced by the given inboundDeliveryNumber. \\ An inboundDeliveryNumber from a canceled inbound delivery cannot be used for a new inbound delivery, because they must always be unique.
* @summary Cancel a inbound delivery.
* @param {string} inboundDeliveryNumber The number the inbound delivery should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field).
* @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}
*/
cancelInboundDelivery(inboundDeliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundDelivery>>;
/**
* Get an inbound delivery by inbound delivery number.
* @summary Get an inbound delivery by inbound delivery number.
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @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}
*/
getInboundDelivery(inboundDeliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundDelivery>>;
/**
* 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}
*/
getInboundDeliveryBulkImportTemplate(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
* Get a list of inbound deliveries.
* @summary Get a list of inbound deliveries.
* @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: - expectedDeliveryDate The default sort order is expectedDeliveryDate:desc.
* @param {string} [filterStatus] Status of the inbound delivery (optional). The status for not yet completed is subject to change. you may poll for changes. - open: The inbound delivery has not yet been delivered. - in_progress: The inbound delivery is being processed in our warehouse. - completed: The inbound delivery has been processed in our warehouse. - deleted: The inbound delivery has been deleted.
* @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} [filterExpectedDeliveryDateFrom] The start date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterExpectedDeliveryDateTo] The end date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterSearch] filter for inbound delivery 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 inboundDeliveryName and inboundDeliveryNumber. - Each search term filters the response for inbound deliveries where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for products 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 product is not included in the results.
* @param {string} [filterCreateDateFrom] The start date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {string} [filterCreateDateTo] The end date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInboundDeliveryCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterStatus?: string, filterShopCode?: string, filterExpectedDeliveryDateFrom?: string, filterExpectedDeliveryDateTo?: string, filterSearch?: string, filterCreateDateFrom?: string, filterCreateDateTo?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundDeliveryCollection>>;
/**
* Allows to download a document associated with the given inbound delivery.
* @summary Download inbound delivery related documents
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @param {'supplierDeliveryLabel' | 'details'} documentCode The document type to download. The file format is determined by the Accept request header. Note: only a limited amount of document type to file format combinations are available: - supplierDeliveryLabel: the label to put on the inbound delivery for warehouse processing. Accept header: application/pdf - details: a spreadsheet containing details about the inbound delivery. Accept header: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
* @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}
*/
getInboundDeliveryDocument(inboundDeliveryNumber: string, documentCode: 'supplierDeliveryLabel' | 'details', shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
/**
* Import one or more new inbound deliveries. The file type is controlled by the content type attribute of the uploaded file
* @summary Import one or more new inbound deliveries.
* @param {File} file File to upload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundDeliveryBulkImport(file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InboundDeliveryBulkImport207ResponseInner>>>;
/**
* Patch the inbound delivery specified by the given inbound delivery number. \\ Only inbound deliveries where booking-in has not yet started can be edited. \\ All fields in the request body are optional. Only provided fields will be updated. Product changes: - To update a product\'s announced count: include the product with the new announcedCount. - To remove a product: include the product with announcedCount set to 0. - To add a new product: include a product that is not yet part of the delivery with a positive announcedCount. - Products not listed in the products array remain unchanged.
* @summary Patch an inbound delivery.
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @param {PatchInboundDelivery} patchInboundDelivery
* @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}
*/
patchInboundDelivery(inboundDeliveryNumber: string, patchInboundDelivery: PatchInboundDelivery, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundDelivery>>;
/**
* Add a new inbound delivery referenced by the given deliveryNumber.
* @summary Add a new inbound delivery.
* @param {string} inboundDeliveryNumber The number the inbound delivery 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 {NewInboundDelivery} newInboundDelivery
* @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}
*/
postInboundDelivery(inboundDeliveryNumber: string, newInboundDelivery: NewInboundDelivery, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundDelivery>>;
};
/**
* InboundDeliveryApi - factory interface
* @export
*/
export declare const InboundDeliveryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Cancel a inbound delivery referenced by the given inboundDeliveryNumber. \\ An inboundDeliveryNumber from a canceled inbound delivery cannot be used for a new inbound delivery, because they must always be unique.
* @summary Cancel a inbound delivery.
* @param {string} inboundDeliveryNumber The number the inbound delivery should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field).
* @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}
*/
cancelInboundDelivery(inboundDeliveryNumber: string, shopCode?: string, options?: any): AxiosPromise<InboundDelivery>;
/**
* Get an inbound delivery by inbound delivery number.
* @summary Get an inbound delivery by inbound delivery number.
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @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}
*/
getInboundDelivery(inboundDeliveryNumber: string, shopCode?: string, options?: any): AxiosPromise<InboundDelivery>;
/**
* 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}
*/
getInboundDeliveryBulkImportTemplate(options?: any): AxiosPromise<string>;
/**
* Get a list of inbound deliveries.
* @summary Get a list of inbound deliveries.
* @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: - expectedDeliveryDate The default sort order is expectedDeliveryDate:desc.
* @param {string} [filterStatus] Status of the inbound delivery (optional). The status for not yet completed is subject to change. you may poll for changes. - open: The inbound delivery has not yet been delivered. - in_progress: The inbound delivery is being processed in our warehouse. - completed: The inbound delivery has been processed in our warehouse. - deleted: The inbound delivery has been deleted.
* @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} [filterExpectedDeliveryDateFrom] The start date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterExpectedDeliveryDateTo] The end date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterSearch] filter for inbound delivery 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 inboundDeliveryName and inboundDeliveryNumber. - Each search term filters the response for inbound deliveries where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for products 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 product is not included in the results.
* @param {string} [filterCreateDateFrom] The start date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {string} [filterCreateDateTo] The end date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInboundDeliveryCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterStatus?: string, filterShopCode?: string, filterExpectedDeliveryDateFrom?: string, filterExpectedDeliveryDateTo?: string, filterSearch?: string, filterCreateDateFrom?: string, filterCreateDateTo?: string, options?: any): AxiosPromise<InboundDeliveryCollection>;
/**
* Allows to download a document associated with the given inbound delivery.
* @summary Download inbound delivery related documents
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @param {'supplierDeliveryLabel' | 'details'} documentCode The document type to download. The file format is determined by the Accept request header. Note: only a limited amount of document type to file format combinations are available: - supplierDeliveryLabel: the label to put on the inbound delivery for warehouse processing. Accept header: application/pdf - details: a spreadsheet containing details about the inbound delivery. Accept header: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
* @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}
*/
getInboundDeliveryDocument(inboundDeliveryNumber: string, documentCode: 'supplierDeliveryLabel' | 'details', shopCode?: string, options?: any): AxiosPromise<File>;
/**
* Import one or more new inbound deliveries. The file type is controlled by the content type attribute of the uploaded file
* @summary Import one or more new inbound deliveries.
* @param {File} file File to upload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
inboundDeliveryBulkImport(file: File, options?: any): AxiosPromise<Array<InboundDeliveryBulkImport207ResponseInner>>;
/**
* Patch the inbound delivery specified by the given inbound delivery number. \\ Only inbound deliveries where booking-in has not yet started can be edited. \\ All fields in the request body are optional. Only provided fields will be updated. Product changes: - To update a product\'s announced count: include the product with the new announcedCount. - To remove a product: include the product with announcedCount set to 0. - To add a new product: include a product that is not yet part of the delivery with a positive announcedCount. - Products not listed in the products array remain unchanged.
* @summary Patch an inbound delivery.
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @param {PatchInboundDelivery} patchInboundDelivery
* @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}
*/
patchInboundDelivery(inboundDeliveryNumber: string, patchInboundDelivery: PatchInboundDelivery, shopCode?: string, options?: any): AxiosPromise<InboundDelivery>;
/**
* Add a new inbound delivery referenced by the given deliveryNumber.
* @summary Add a new inbound delivery.
* @param {string} inboundDeliveryNumber The number the inbound delivery 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 {NewInboundDelivery} newInboundDelivery
* @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}
*/
postInboundDelivery(inboundDeliveryNumber: string, newInboundDelivery: NewInboundDelivery, shopCode?: string, options?: any): AxiosPromise<InboundDelivery>;
};
/**
* InboundDeliveryApi - interface
* @export
* @interface InboundDeliveryApi
*/
export interface InboundDeliveryApiInterface {
/**
* Cancel a inbound delivery referenced by the given inboundDeliveryNumber. \\ An inboundDeliveryNumber from a canceled inbound delivery cannot be used for a new inbound delivery, because they must always be unique.
* @summary Cancel a inbound delivery.
* @param {string} inboundDeliveryNumber The number the inbound delivery should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field).
* @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 InboundDeliveryApiInterface
*/
cancelInboundDelivery(inboundDeliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<InboundDelivery>;
/**
* Get an inbound delivery by inbound delivery number.
* @summary Get an inbound delivery by inbound delivery number.
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @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 InboundDeliveryApiInterface
*/
getInboundDelivery(inboundDeliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<InboundDelivery>;
/**
* 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 InboundDeliveryApiInterface
*/
getInboundDeliveryBulkImportTemplate(options?: AxiosRequestConfig): AxiosPromise<string>;
/**
* Get a list of inbound deliveries.
* @summary Get a list of inbound deliveries.
* @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: - expectedDeliveryDate The default sort order is expectedDeliveryDate:desc.
* @param {string} [filterStatus] Status of the inbound delivery (optional). The status for not yet completed is subject to change. you may poll for changes. - open: The inbound delivery has not yet been delivered. - in_progress: The inbound delivery is being processed in our warehouse. - completed: The inbound delivery has been processed in our warehouse. - deleted: The inbound delivery has been deleted.
* @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} [filterExpectedDeliveryDateFrom] The start date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterExpectedDeliveryDateTo] The end date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterSearch] filter for inbound delivery 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 inboundDeliveryName and inboundDeliveryNumber. - Each search term filters the response for inbound deliveries where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for products 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 product is not included in the results.
* @param {string} [filterCreateDateFrom] The start date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {string} [filterCreateDateTo] The end date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundDeliveryApiInterface
*/
getInboundDeliveryCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterStatus?: string, filterShopCode?: string, filterExpectedDeliveryDateFrom?: string, filterExpectedDeliveryDateTo?: string, filterSearch?: string, filterCreateDateFrom?: string, filterCreateDateTo?: string, options?: AxiosRequestConfig): AxiosPromise<InboundDeliveryCollection>;
/**
* Allows to download a document associated with the given inbound delivery.
* @summary Download inbound delivery related documents
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @param {'supplierDeliveryLabel' | 'details'} documentCode The document type to download. The file format is determined by the Accept request header. Note: only a limited amount of document type to file format combinations are available: - supplierDeliveryLabel: the label to put on the inbound delivery for warehouse processing. Accept header: application/pdf - details: a spreadsheet containing details about the inbound delivery. Accept header: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
* @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 InboundDeliveryApiInterface
*/
getInboundDeliveryDocument(inboundDeliveryNumber: string, documentCode: 'supplierDeliveryLabel' | 'details', shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<File>;
/**
* Import one or more new inbound deliveries. The file type is controlled by the content type attribute of the uploaded file
* @summary Import one or more new inbound deliveries.
* @param {File} file File to upload
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundDeliveryApiInterface
*/
inboundDeliveryBulkImport(file: File, options?: AxiosRequestConfig): AxiosPromise<Array<InboundDeliveryBulkImport207ResponseInner>>;
/**
* Patch the inbound delivery specified by the given inbound delivery number. \\ Only inbound deliveries where booking-in has not yet started can be edited. \\ All fields in the request body are optional. Only provided fields will be updated. Product changes: - To update a product\'s announced count: include the product with the new announcedCount. - To remove a product: include the product with announcedCount set to 0. - To add a new product: include a product that is not yet part of the delivery with a positive announcedCount. - Products not listed in the products array remain unchanged.
* @summary Patch an inbound delivery.
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @param {PatchInboundDelivery} patchInboundDelivery
* @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 InboundDeliveryApiInterface
*/
patchInboundDelivery(inboundDeliveryNumber: string, patchInboundDelivery: PatchInboundDelivery, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<InboundDelivery>;
/**
* Add a new inbound delivery referenced by the given deliveryNumber.
* @summary Add a new inbound delivery.
* @param {string} inboundDeliveryNumber The number the inbound delivery 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 {NewInboundDelivery} newInboundDelivery
* @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 InboundDeliveryApiInterface
*/
postInboundDelivery(inboundDeliveryNumber: string, newInboundDelivery: NewInboundDelivery, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<InboundDelivery>;
}
/**
* InboundDeliveryApi - object-oriented interface
* @export
* @class InboundDeliveryApi
* @extends {BaseAPI}
*/
export declare class InboundDeliveryApi extends BaseAPI implements InboundDeliveryApiInterface {
/**
* Cancel a inbound delivery referenced by the given inboundDeliveryNumber. \\ An inboundDeliveryNumber from a canceled inbound delivery cannot be used for a new inbound delivery, because they must always be unique.
* @summary Cancel a inbound delivery.
* @param {string} inboundDeliveryNumber The number the inbound delivery should be referred by. \\ This number is user defined, must be unique and has a maximum length (check maxLength field).
* @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 InboundDeliveryApi
*/
cancelInboundDelivery(inboundDeliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InboundDelivery, any>>;
/**
* Get an inbound delivery by inbound delivery number.
* @summary Get an inbound delivery by inbound delivery number.
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @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 InboundDeliveryApi
*/
getInboundDelivery(inboundDeliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InboundDelivery, any>>;
/**
* 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 InboundDeliveryApi
*/
getInboundDeliveryBulkImportTemplate(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
/**
* Get a list of inbound deliveries.
* @summary Get a list of inbound deliveries.
* @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: - expectedDeliveryDate The default sort order is expectedDeliveryDate:desc.
* @param {string} [filterStatus] Status of the inbound delivery (optional). The status for not yet completed is subject to change. you may poll for changes. - open: The inbound delivery has not yet been delivered. - in_progress: The inbound delivery is being processed in our warehouse. - completed: The inbound delivery has been processed in our warehouse. - deleted: The inbound delivery has been deleted.
* @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} [filterExpectedDeliveryDateFrom] The start date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterExpectedDeliveryDateTo] The end date (inclusive) in format Y-m-d for which inbound deliveries should be returned (regarding the expected delivery date).
* @param {string} [filterSearch] filter for inbound delivery 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 inboundDeliveryName and inboundDeliveryNumber. - Each search term filters the response for inbound deliveries where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for products 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 product is not included in the results.
* @param {string} [filterCreateDateFrom] The start date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {string} [filterCreateDateTo] The end date (inclusive) in ISO 8601 format for which inbound deliveries should be returned (regarding the creation date).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InboundDeliveryApi
*/
getInboundDeliveryCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterStatus?: string, filterShopCode?: string, filterExpectedDeliveryDateFrom?: string, filterExpectedDeliveryDateTo?: string, filterSearch?: string, filterCreateDateFrom?: string, filterCreateDateTo?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InboundDeliveryCollection, any>>;
/**
* Allows to download a document associated with the given inbound delivery.
* @summary Download inbound delivery related documents
* @param {string} inboundDeliveryNumber The inbound delivery number as defined during the creation of the inbound delivery.
* @param {'supplierDeliveryLabel' | 'details'} documentCode The document type to download. The file format is determined by the Accept request header. Note: only a limited amount of document type to file format combinations are available: - supplierDeliveryLabel: the label to put on the inbound delivery for warehouse processing. Accept header: application/pdf - details: a spreadsheet containing details about the inbound delivery. Accept header: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
* @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 InboundDeliveryApi
*/
getInboundDeliveryDocument(inboundDeliveryNumber: string, documentCode: 'supplierDeliveryLabel' | 'details', shopCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
/**
* Import one or more new inbound deliveries. The file type is controlled by the content type att