@datenkraft/bb-fulfillment-api-ts-client
Version:
The fulfillment API TS Client enables you to work with the fulfillment API
80 lines (79 loc) • 2.99 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 { ProductJournalReference } from './product-journal-reference';
/**
*
* @export
* @interface ProductJournal
*/
export interface ProductJournal {
/**
* The API internal id of the journal entry.
* @type {number}
* @memberof ProductJournal
*/
'journalId'?: number;
/**
* The date and time at which the journal entry was created. Format in ISO 8601.
* @type {string}
* @memberof ProductJournal
*/
'date'?: string;
/**
* The number of the product which the journal entry refers to.
* @type {string}
* @memberof ProductJournal
*/
'productNumber'?: string;
/**
* The code that defines the reason for the stock change.
* @type {string}
* @memberof ProductJournal
*/
'reason'?: ProductJournalReasonEnum;
/**
* The change of the stock.\\Note: This might not be set for all reasons.
* @type {number}
* @memberof ProductJournal
*/
'stockDelta'?: number | null;
/**
* The old value of the stock before applying the delta.\\Note: This might not be set for all reasons.
* @type {number}
* @memberof ProductJournal
*/
'stockOld'?: number | null;
/**
* The new value of the stock when the journal entry was created.\\Note: This might not be set for all reasons.
* @type {number}
* @memberof ProductJournal
*/
'stockNew'?: number | null;
/**
*
* @type {ProductJournalReference}
* @memberof ProductJournal
*/
'reference'?: ProductJournalReference;
}
export declare const ProductJournalReasonEnum: {
readonly Expired: "expired";
readonly Damaged: "damaged";
readonly OwnWithdrawal: "own_withdrawal";
readonly Correction: "correction";
readonly NiceshopsOrder: "niceshops_order";
readonly Inbound: "inbound";
readonly Fulfillment: "fulfillment";
readonly Return: "return";
readonly UnknownDefaultOpenApi: "11184809";
};
export type ProductJournalReasonEnum = typeof ProductJournalReasonEnum[keyof typeof ProductJournalReasonEnum];