@datenkraft/bb-fulfillment-api-ts-client
Version:
The fulfillment API TS Client enables you to work with the fulfillment API
88 lines (87 loc) • 3.86 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 { InboundDeliveryProduct } from './inbound-delivery-product';
/**
*
* @export
* @interface InboundDeliveryAllOf
*/
export interface InboundDeliveryAllOf {
/**
* The inbound delivery number.\\ Note: If this number is prefixed with \'NICE\', it means that the inbound delivery was created was created manually by niceshops.
* @type {string}
* @memberof InboundDeliveryAllOf
*/
'inboundDeliveryNumber'?: string;
/**
* Notes from the steve warehouse team
* @type {string}
* @memberof InboundDeliveryAllOf
*/
'inboundDeliveryNote'?: string | null;
/**
* The API internal id of the inbound delivery
* @type {number}
* @memberof InboundDeliveryAllOf
*/
'shopWAWIDeliveryId'?: number;
/**
* Status of the inbound delivery.\\ 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.
* @type {string}
* @memberof InboundDeliveryAllOf
*/
'status'?: InboundDeliveryAllOfStatusEnum;
/**
* Products in the inbound delivery
* @type {Array<InboundDeliveryProduct>}
* @memberof InboundDeliveryAllOf
*/
'products'?: Array<InboundDeliveryProduct>;
/**
* The shopCode used internally to distinguish between clients.
* @type {string}
* @memberof InboundDeliveryAllOf
*/
'shopCode'?: string;
/**
* Start date of the delivery (timezone CET/CEST)
* @type {string}
* @memberof InboundDeliveryAllOf
*/
'startDate'?: string | null;
/**
* End date of the delivery (timezone CET/CEST)
* @type {string}
* @memberof InboundDeliveryAllOf
*/
'endDate'?: string | null;
/**
* Number of the inbound delivery on the delivery slip.\\ If the field is empty or not set in the database (e.g. the inbound delivery has not yet arrived in our warehouse), null will be returned.\\ If an empty string (\"\") is returned, it means that no delivery slip number is available for the inbound delivery.
* @type {string}
* @memberof InboundDeliveryAllOf
*/
'deliverySlipNumber'?: string | null;
/**
* Creation date of the inbound delivery. Format in ISO 8601 (timezone CET/CEST)
* @type {string}
* @memberof InboundDeliveryAllOf
*/
'createDate'?: string;
}
export declare const InboundDeliveryAllOfStatusEnum: {
readonly Open: "open";
readonly InProgress: "in_progress";
readonly Completed: "completed";
readonly Deleted: "deleted";
readonly UnknownDefaultOpenApi: "11184809";
};
export type InboundDeliveryAllOfStatusEnum = typeof InboundDeliveryAllOfStatusEnum[keyof typeof InboundDeliveryAllOfStatusEnum];