@djust-b2b/djust-front-sdk 3.0.0-beta.9 → 3.0.0

package/lib/interfaces/models/order.d.ts

@@ -0,0 +1,701 @@
+import { CustomFieldValueObject, CustomFieldValueRequest } from "./custom-field";
+import { OfferPriceType, PackingType } from "./offer";
+import { ProductMediaInfoDTO, ProductSpecification } from "./product";
+import { SupplierSnapshot } from "./supplier";
+import { AddressSnapshot } from "./address";
+import { Channel, Country, Currency, ExternalSource, IdType, Lang, Order, PageableObject } from "./common";
+import { CustomerUserDto, CustomerUserSnapshot } from "./customer-user";
+import { PaymentOption, PaymentStatus } from "./payment";
+import { UpdateCartLineType } from "./cart";
+/**
+ * Payment status for order logistic line.
+ */
+export type OrderLogisticLinePaymentStatus = "WAITING_REFUND" | "WAITING_PARTIAL_REFUND" | "PARTIALLY_REFUNDED" | "REFUNDED";
+/**
+ * Order line status.
+ */
+export type OrderLineStatus = "CANCELED" | "PARTIALLY_CANCELED" | "DECLINED_BY_SUPPLIER" | "OTHER" | "DELETED";
+export type OrderLogisticStatusType = "CREATING" | "DRAFT_ORDER" | "DRAFT_ORDER_ON_HOLD" | "ORDER_CREATED" | "WAITING_CUSTOMER_APPROVAL" | "WAITING_SUPPLIER_APPROVAL" | "DECLINED_BY_CUSTOMER" | "DECLINED_BY_SUPPLIER" | "ACCEPTED_BY_SUPPLIER" | "WAITING_SHIPMENT" | "PARTIALLY_SHIPPED" | "SHIPPED" | "COMPLETED" | "PARTIALLY_CANCELED" | "CANCELED";
+export type OrderLineType = "PRODUCT_VARIANT" | "OFFER_PRICE";
+export type OrderOrigin = "CART" | "SUPPLIER_QUOTE";
+export type OrderIdType = "BUSINESS_ID" | "CART_ID" | "REFERENCE";
+export type ApprovalStatus = "APPROVED" | "REFUSED" | "WAITING_APPROVAL";
+export type ThreadReasonType = "INCIDENT_OPEN" | "REFUND" | "ORDER_MESSAGING" | "OFFER_MESSAGING" | "CANCELATION";
+export interface PageOrderLogisticDto {
+    content: OrderLogisticDto[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+    totalPages: number;
+}
+export interface OrderLogisticDto {
+    billingAddressSnapshot: AddressSnapshot;
+    channel: Channel;
+    createdAt: string;
+    customFieldValues: CustomFieldValueObject[];
+    customerUserSnapshot: CustomerUserSnapshot;
+    externalId: string;
+    externalSource: ExternalSource;
+    fulfillmentMessage: string;
+    id: string;
+    incidentDeclared: boolean;
+    initialPrice: OrderPriceDto;
+    leadTimeToShip: number;
+    lines: OrderLogisticLineDto[];
+    orderCommercialId: string;
+    orderCommercialReference: string;
+    orderLogisticPrices: OrderLogisticPriceDto;
+    orderOrigin: string;
+    partiallyDeclinedBySupplier: boolean;
+    paymentOption: PaymentOption;
+    paymentStatus: PaymentStatus;
+    reference: string;
+    shippingAddressSnapshot: AddressSnapshot;
+    shippingTrackingUrl: string;
+    shippingType: string;
+    status: OrderLogisticStatusType;
+    supplierSnapshot: SupplierSnapshot;
+    updatedAt: string;
+    validatedAt: string;
+}
+/**
+ * Order price breakdown.
+ */
+export interface OrderPriceDto {
+    /** Price including taxes */
+    priceWithTax: number;
+    /** Price excluding taxes */
+    priceWithoutTax: number;
+    /** Shipping price including taxes */
+    shippingPriceWithTax: number;
+    /** Shipping price excluding taxes */
+    shippingPriceWithoutTax: number;
+    /** Total price including taxes */
+    totalPriceWithTax: number;
+    /** Total price excluding taxes */
+    totalPriceWithoutTax: number;
+}
+export interface OrderLogisticLineDto {
+    confirmedQuantity: number;
+    customFieldValues: CustomFieldValueObject[];
+    externalId: string;
+    externalSource: ExternalSource;
+    id: string;
+    incidentDeclared: boolean;
+    offerCustomFieldSnapshotDtos: OfferCustomFieldValueSnapshot[];
+    offerInventorySnapshotDto: OrderLogisticLineOfferInventoryDto;
+    offerPriceSnapshotDto: OrderCommercialLineOfferPriceDto;
+    orderLogisticLinePriceDto: OrderLogisticLinePriceDto;
+    orderLogisticLineProductDto: OrderLogisticLineProductDto;
+    orderLogisticLineProductVariantDto: OrderLogisticLineProductVariantDto;
+    paymentStatus: OrderLogisticLinePaymentStatus;
+    quantity: number;
+    quoteLineExternalId: string;
+    status: OrderLineStatus;
+}
+export interface OrderLogisticLineUpdate {
+    customFieldValues: CustomFieldValueRequest[];
+    id: string;
+    quantity: number;
+    updateAction: UpdateCartLineType;
+    metadata?: {
+        [key: string]: any;
+    };
+}
+export interface updateCommercialOrderLinesRequest {
+    customFieldIdType?: IdType;
+    lineIdType?: IdType;
+    lineType?: string;
+    updateOrderCommercialLines?: OrderLogisticLineUpdate[];
+    updateOrderLineIdType?: IdType;
+    updateOrderLineType?: string;
+}
+export interface OfferCustomFieldSnapshot {
+    externalId: string;
+    externalSource: string;
+    mandatory: boolean;
+    name: {
+        [key: string]: string;
+    };
+    role: string;
+    sealedTarget: string;
+    status: string;
+    type: string;
+}
+export interface OfferCustomFieldValueSnapshot {
+    offerCustomFieldSnapshotDto: OfferCustomFieldSnapshot;
+    value: string;
+}
+/**
+ * Custom field snapshot for offer inventory in order line.
+ */
+export interface OrderLogisticLineOfferInventoryCustomFieldSnapshot {
+    /** External identifier */
+    externalId: string;
+    /** External source system */
+    externalSource: string;
+    /** Whether the field is mandatory */
+    mandatory: boolean;
+    /** Localized names */
+    names: {
+        [key: string]: string;
+    };
+    /** Field role */
+    role: string;
+    /** Sealed target */
+    sealedTarget: string;
+    /** Field status */
+    status: string;
+    /** Field data type */
+    type: string;
+}
+/**
+ * Custom field value snapshot for offer inventory.
+ */
+export interface OrderLogisticLineOfferInventoryCustomFieldValueSnapshot {
+    /** The custom field definition */
+    customFieldSnapshotDto: OrderLogisticLineOfferInventoryCustomFieldSnapshot;
+    /** The typed value */
+    typedValue: unknown;
+}
+/**
+ * Offer inventory information in order line.
+ */
+export interface OrderLogisticLineOfferInventoryDto {
+    /** Currency code */
+    currency: Currency;
+    /** Custom field value snapshots */
+    customFieldValueSnapshots: OrderLogisticLineOfferInventoryCustomFieldValueSnapshot[];
+    /** External source system */
+    externalSource: ExternalSource;
+    /** Maximum order quantity */
+    maxOrderQuantity: number;
+    /** Minimum order quantity */
+    minOrderQuantity: number;
+    /** Offer inventory external ID */
+    offerInventoryExternalId: string;
+    /** Packing type */
+    packingType: PackingType;
+    /** Product tax code */
+    productTaxCode: string;
+    /** Product tax rate */
+    productTaxRate: number;
+    /** Quantity per item */
+    quantityPerItem: number;
+    /** Shipping tax code */
+    shippingTaxCode: string;
+    /** Shipping tax rate */
+    shippingTaxRate: number;
+}
+/**
+ * Product information in order logistic line.
+ */
+export interface OrderLogisticLineProductDto {
+    /** Product brand */
+    brand: string;
+    /** Classification category */
+    classificationCategory: string;
+    /** Default language */
+    defaultLanguage: Lang;
+    /** Product description */
+    description: string;
+    /**
+     * @deprecated Use externalId instead
+     */
+    djustProductUuid: string;
+    /** External identifier */
+    externalId: string;
+    /** External source system */
+    externalSource: ExternalSource;
+    /**
+     * @deprecated Use ean on variant instead
+     */
+    gtin: string;
+    /**
+     * @deprecated Use productPictures instead
+     */
+    mainImageUrl: string;
+    /**
+     * @deprecated Use mpn on variant instead
+     */
+    mpn: string;
+    /** Product display name */
+    name: string;
+    /**
+     * @deprecated
+     */
+    navigationCategories: string[];
+    /** Product attribute values */
+    productAttributeValues: OrderLogisticLineAttributeValue[];
+    /** Product unit */
+    productUnit: string;
+    /** Stock Keeping Unit */
+    sku: string;
+    /**
+     * @deprecated
+     */
+    specifications: ProductSpecification[];
+    /** Product tags */
+    tags: string[];
+}
+/**
+ * Tax information breakdown.
+ */
+export interface TaxInformation {
+    /** Product tax amount */
+    productTaxAmount: number;
+    /** Product tax code */
+    productTaxCode: string;
+    /** Product tax rate */
+    productTaxRate: number;
+    /** Shipping tax amount */
+    shippingTaxAmount: number;
+    /** Shipping tax code */
+    shippingTaxCode: string;
+    /** Shipping tax rate */
+    shippingTaxRate: number;
+}
+/**
+ * Order logistic line price details.
+ */
+export interface OrderLogisticLinePriceDto {
+    /** Confirmed price */
+    confirmedPrice: number;
+    /** Currency code */
+    currency: Currency;
+    /** External offer ID */
+    externalOfferId: string;
+    /** External source system */
+    externalSource: ExternalSource;
+    /** Items per pack */
+    itemPerPack: number;
+    /** Item price without taxes */
+    itemPriceWithoutTaxes: number;
+    /** Packing type */
+    packingType: PackingType;
+    /**
+     * @deprecated Use priceWithTaxes instead
+     */
+    price: number;
+    /** Price with taxes */
+    priceWithTaxes: number;
+    /** Quantity per item */
+    quantityPerItem: number;
+    /** Shipping price with taxes */
+    shippingPriceWithTaxes: number;
+    /** Shipping price without taxes */
+    shippingPriceWithoutTaxes: number;
+    /** Shipping tax amount */
+    shippingTaxAmount: number;
+    /** Total tax amount */
+    taxAmount: number;
+    /** Tax breakdown information */
+    taxInformation: TaxInformation;
+    /** Tax rate */
+    taxRate: number;
+    /** Total item price */
+    totalItemPrice: number;
+    /** Total item price with taxes */
+    totalItemPriceWithTaxes: number;
+    /** Total item tax amount */
+    totalItemTaxAmount: number;
+    /** Total price with taxes */
+    totalPriceWithTaxes: number;
+    /** Total price without taxes */
+    totalPriceWithoutTaxes: number;
+    /** Total taxes */
+    totalTaxes: number;
+    /** Offer price type */
+    type: OfferPriceType;
+    /** Type value */
+    typeValue: string;
+}
+export interface OrderLogisticLineAttributeValue {
+    /**
+     * @deprecated
+     */
+    attribute: string;
+    attributeExternalId: string;
+    attributeExternalSource: string;
+    attributeId: string;
+    attributeName: {
+        [key: string]: string;
+    };
+    attributeType: string;
+    attributeValue: string;
+    id: string;
+}
+/**
+ * Product variant information in order logistic line.
+ */
+export interface OrderLogisticLineProductVariantDto {
+    /** Variant attribute values */
+    attributeValues: OrderLogisticLineAttributeValue[];
+    /** Variant description */
+    description: string;
+    /** European Article Number */
+    ean: string;
+    /** External identifier */
+    externalId: string;
+    /**
+     * @deprecated Use externalId instead
+     */
+    externalReference: string;
+    /** External source system */
+    externalSource: ExternalSource;
+    /**
+     * @deprecated Use ean instead
+     */
+    gtin: string;
+    /** Main image URL */
+    mainImageUrl: string;
+    /** Manufacturer Part Number */
+    mpn: string;
+    /** Variant display name */
+    name: string;
+    /** Product media information */
+    productMediaInfoDTOS: ProductMediaInfoDTO[];
+    /** Stock Keeping Unit */
+    sku: string;
+}
+export interface OrderLogisticPriceDto {
+    currency: string;
+    totalItemPrice: number;
+    totalOrderPrice: number;
+    totalPriceWithTax: number;
+    totalPriceWithoutTax: number;
+    totalProductTaxAmount: number;
+    totalProductWithTax: number;
+    totalProductWithoutTax: number;
+    totalShippingFees: number;
+    totalShippingFeesWithTax: number;
+    totalShippingFeesWithoutTax: number;
+    totalShippingTaxAmount: number;
+    totalTaxAmount: number;
+}
+export interface OrderRequest {
+    ascending: boolean;
+    descending: boolean;
+    direction: string;
+    ignoreCase: boolean;
+    nullHandling: string;
+    property: string;
+}
+export interface PageOrderCommercialDto {
+    content: OrderCommercialDto[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+    totalPages: number;
+}
+export interface OrderCommercialDto {
+    createdAt: string;
+    id: string;
+    orderLogisticPrices: OrderLogisticPriceDto;
+    orderLogistics: OrderLogisticDto[];
+    processing: boolean;
+    reference: string;
+}
+export interface OrderDocumentDto {
+    dateUploaded: string;
+    fileName: string;
+    id: string;
+    type: string;
+}
+export interface ApprovalDto {
+    approvalDate: string;
+    approvalStatus: ApprovalStatus;
+    customerUser: CustomerUserDto;
+    id: string;
+    orderLogistic: OrderLogisticDto;
+}
+export interface PageOrderLogisticLineDto {
+    content: OrderLogisticLineDto[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+    totalPages: number;
+}
+export interface PageOrderCommercialLinesDto {
+    content: OrderCommercialLineDto[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: PageableObject;
+    size: number;
+    sort: Order[];
+    totalElements: number;
+    totalPages: number;
+}
+export interface OrderCommercialLineDto {
+    confirmedQuantity: number;
+    customFieldValues: OrderCommercialLineCustomFieldValuesDto[];
+    externalId: string;
+    externalSource: string;
+    id: string;
+    incidentDeclared: boolean;
+    offerInventorySnapshotDto: OrderCommercialLineOfferInventoryDto;
+    offerPriceSnapshotDto: OrderCommercialLineOfferPriceDto;
+    orderLogisticLinePriceDto: OrderLogisticLinePriceDto;
+    orderLogisticLineProductDto: OrderLogisticLineProductDto;
+    orderLogisticLineProductVariantDto: OrderLogisticLineProductVariantDto;
+    paymentStatus: string;
+    quantity: number;
+    quoteLineExternalId: string;
+    status: string;
+}
+export interface ShippingTypeInformationDto {
+    code: string;
+    earliestDays: number;
+    label: string;
+    latestDays: number;
+    totalShippingPrice: number;
+}
+export interface OrderRatingResponse {
+    comment: string;
+    grade: number;
+}
+export interface OrderLogisticThreadResponse {
+    createdAt: string;
+    externalId: string;
+    id: string;
+    messages: ThreadMessageDto;
+    name: string;
+    reasons: string[];
+    status: string;
+    type: string;
+    updatedAt: string;
+}
+export interface ThreadReasonTypeDto {
+    claimReasonType: ThreadReasonType;
+    label: string;
+}
+export interface ThreadReasonDto {
+    description: string;
+    externalId: string;
+    externalSource: ExternalSource;
+    id: string;
+    label: string;
+    type: ThreadReasonTypeDto;
+}
+export interface ThreadMessageDto {
+    body: string;
+    createdAt: string;
+    customFieldValues: ThreadCustomFiedValuesDto[];
+    externalId: string;
+    from: ThreadMessageFromToDto;
+    id: string;
+    to: ThreadMessageFromToDto;
+    updatedAt: string;
+}
+export interface ThreadMessageFromToDto {
+    account: ThreadMessageAccountDto;
+    accounts: ThreadMessageAccountDto[];
+    user: ThreadMessageFromUserDto;
+}
+export interface ThreadMessageAccountDto {
+    externalId: string;
+    id: string;
+    name: string;
+}
+export interface ThreadMessageFromUserDto {
+    civility: string;
+    createdAt: string;
+    customFieldValues: ThreadCustomFiedValuesDto[];
+    email: string;
+    externalId: string;
+    firstName: string;
+    groups: string[];
+    id: string;
+    lastName: string;
+    locale: Country;
+    password: string;
+    phone: string;
+    status: string;
+    updatedAt: string;
+}
+export interface ThreadCustomFiedValuesDto {
+    customField: {
+        externalId: string;
+        externalSource: ExternalSource;
+        faceted: boolean;
+        id: string;
+        indexable: boolean;
+        mandatory: boolean;
+        name: object;
+        role: string;
+        sealedTarget: string;
+        searchable: boolean;
+        sortable: boolean;
+        status: string;
+    };
+    value: unknown;
+}
+export interface OrderCommercialLineCustomFieldValuesDto extends ThreadCustomFiedValuesDto {
+}
+export interface OrderCommercialLineOfferInventoryDto extends ThreadCustomFiedValuesDto {
+    currency: string;
+    customFieldValueSnapshots: OrderCommercialLineCustomFieldValuesDto[];
+    externalSource: string;
+    maxOrderQuantity: number | null;
+    minOrderQuantity: number;
+    offerInventoryExternalId: string;
+    packingType: string;
+    productTaxCode: string;
+    productTaxRate: number;
+    quantityPerItem: number;
+    shippingTaxCode: string;
+    shippingTaxRate: number;
+}
+export interface OrderCommercialLineOfferPriceDto {
+    confirmedProductPriceWithoutTaxes: number;
+    itemPerPack: number;
+    offerPriceExternalId: string;
+    offerPriceType: string;
+    offerPriceTypeValue: string;
+    productPriceWithTaxes: number;
+    productPriceWithoutTaxes: number;
+    productTaxAmount: number;
+    shippingPriceWithTaxes: number;
+    shippingPriceWithoutTaxes: number;
+    shippingTaxAmount: number;
+    taxLegalNotice: string;
+    totalPriceWithTaxes: number;
+    totalPriceWithoutTaxes: number;
+    totalProductPriceWithTaxes: number;
+    totalProductPriceWithoutTaxes: number;
+    totalProductTaxAmount: number;
+    totalTaxAmount: number;
+}
+export interface RequestGetAccountingDocumentLinkbyID {
+    orderLogisticId: string;
+    docId: string;
+}
+export interface RequestGetOrderLogisticDocumentbyID {
+    orderLogisticId: string;
+    documentId: string;
+}
+export interface CardInformationDto {
+    AccessKey: string;
+    CardId: string;
+    CardRegistrationURL: string;
+    CardType: string;
+    CreationDate: string;
+    Currency: string;
+    Id: string;
+    PreregistrationData: string;
+    RegistrationData: string;
+    ResultCode: string;
+    Status: string;
+    Tag: string;
+    UserId: string;
+}
+export interface BrowserInfo {
+    AcceptHeader: string;
+    ColorDepth: number;
+    JavaEnabled: boolean;
+    JavascriptEnabled: boolean;
+    Language: string;
+    ScreenHeight: number;
+    ScreenWidth: number;
+    TimeZoneOffset: string;
+    UserAgent: string;
+}
+export interface PaymentCardInfo {
+    amount: number;
+    cardId: string;
+    currency: string;
+}
+export interface PreauthorizationDto {
+    Applied3DSVersion: string;
+    AuthorId: string;
+    Billing: {
+        Address: {
+            AddressLine1: string;
+            AddressLine2: string;
+            City: string;
+            Country: string;
+            PostalCode: string;
+            Region: string;
+        };
+        FirstName: string;
+        LastName: string;
+    };
+    BrowserInfo: BrowserInfo;
+    CardId: string;
+    CreationDate: number;
+    Culture: string;
+    DebitedFunds: {
+        Amount: number;
+        Currency: Currency;
+    };
+    ExecutionType: string;
+    ExpirationDate: number;
+    Id: string;
+    IpAddress: string;
+    MultiCapture: true;
+    PaymentStatus: string;
+    RemainingFunds: {
+        Amount: number;
+        Currency: Currency;
+    };
+    Requested3DSVersion: string;
+    ResultCode: string;
+    ResultMessage: string;
+    SecureMode: string;
+    SecureModeNeeded: true;
+    SecureModeRedirectURL: string;
+    SecureModeReturnURL: string;
+    SecurityInfo: {
+        AVSResult: string;
+    };
+    Shipping: {
+        Address: {
+            AddressLine1: string;
+            AddressLine2: string;
+            City: string;
+            Country: string;
+            PostalCode: string;
+            Region: string;
+        };
+        FirstName: string;
+        LastName: string;
+    };
+    StatementDescriptor: string;
+    Status: string;
+    Tag: string;
+}
+export interface OfferToDelete {
+    offerPriceId: string;
+}
+export interface logisticOrderIncidentThreadsCustomFieldValueRequest {
+    customFieldValues: CustomFieldValueRequest[];
+    idType: IdType;
+}
+export interface logisticOrderIncidentThreadsRequest {
+    customField?: logisticOrderIncidentThreadsCustomFieldValueRequest;
+    message?: string;
+    name?: string;
+    reasonCode: string;
+}
+//# sourceMappingURL=order.d.ts.map