You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
ReplenishmentOrder
Request body fields required and optional to operate on Replenishment Order data. ReplenishmentOrder
export interface ReplenishmentOrder {
'active'?: boolean;
'appliedOrderPromotions'?: Array<PromotionResult>;
'appliedProductPromotions'?: Array<PromotionResult>;
'appliedVouchers'?: Array<Voucher>;
'calculated'?: boolean;
'chinesePaymentInfo'?: ChinesePaymentInfo;
'code'?: string;
'costCenter'?: B2BCostCenter;
'deliveryAddress'?: Address;
'deliveryCost'?: Price;
'deliveryItemsQuantity'?: number;
'deliveryMode'?: DeliveryMode;
'deliveryOrderGroups'?: Array<DeliveryOrderEntryGroup>;
'deliveryTimeSlot'?: DeliveryTimeSlot;
'description'?: string;
'earliestRetrievalAt'?: string;
'entries'?: Array<OrderEntry>;
'entryGroups'?: Array<EntryGroup>;
'expirationTime'?: string;
'firstDate'?: string;
'guid'?: string;
'name'?: string;
'net'?: boolean;
'orderDiscounts'?: Price;
'paymentInfo'?: PaymentDetails;
'paymentStatus'?: string;
'paymentType'?: B2BPaymentTypeData;
'pickupItemsQuantity'?: number;
'pickupOrderGroups'?: Array<PickupOrderEntryGroup>;
'potentialOrderPromotions'?: Array<PromotionResult>;
'potentialProductPromotions'?: Array<PromotionResult>;
'productDiscounts'?: Price;
'purchaseOrderNumber'?: string;
'replenishmentOrderCode': string;
'requestedRetrievalAt'?: string;
'savedBy'?: Principal;
'saveTime'?: string;
'site'?: string;
'store'?: string;
'subTotal'?: Price;
'taxInvoice'?: TaxInvoice;
'totalDiscounts'?: Price;
'totalItems'?: number;
'totalPrice'?: Price;
'totalPriceWithTax'?: Price;
'totalTax'?: Price;
'totalUnitCount'?: number;
'trigger'?: Trigger;
'user'?: Principal;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
active | Optional | boolean | Is the Replenishment Order active {boolean} ReplenishmentOrder |
appliedOrderPromotions | Optional | Array<PromotionResult> | List of applied order promotions {Array<PromotionResult>} ReplenishmentOrder |
appliedProductPromotions | Optional | Array<PromotionResult> | List of applied product promotions {Array<PromotionResult>} ReplenishmentOrder |
appliedVouchers | Optional | Array<Voucher> | List of applied vouchers {Array<Voucher>} ReplenishmentOrder |
calculated | Optional | boolean | Flag showing if order is calculated {boolean} ReplenishmentOrder |
chinesePaymentInfo | Optional | ChinesePaymentInfo | {ChinesePaymentInfo} ReplenishmentOrder |
code | Optional | string | Code number of order {string} ReplenishmentOrder |
costCenter | Optional | B2BCostCenter | {B2BCostCenter} ReplenishmentOrder |
deliveryAddress | Optional | Address | {Address} ReplenishmentOrder |
deliveryCost | Optional | Price | {Price} ReplenishmentOrder |
deliveryItemsQuantity | Optional | number | Quantity of delivery items {number} ReplenishmentOrder |
deliveryMode | Optional | DeliveryMode | {DeliveryMode} ReplenishmentOrder |
deliveryOrderGroups | Optional | Array<DeliveryOrderEntryGroup> | List of delivery order entries group {Array<DeliveryOrderEntryGroup>} ReplenishmentOrder |
deliveryTimeSlot | Optional | DeliveryTimeSlot | {DeliveryTimeSlot} ReplenishmentOrder |
description | Optional | string | Description of the cart {string} ReplenishmentOrder |
earliestRetrievalAt | Optional | string | Earliest possible retrieval date available for order {string} ReplenishmentOrder |
entries | Optional | Array<OrderEntry> | List of order entries {Array<OrderEntry>} ReplenishmentOrder |
entryGroups | Optional | Array<EntryGroup> | List of entry groups {Array<EntryGroup>} ReplenishmentOrder |
expirationTime | Optional | string | Date of cart expiration time {string} ReplenishmentOrder |
firstDate | Optional | string | First date of the replenishment order {string} ReplenishmentOrder |
guid | Optional | string | Guest user id identifier {string} ReplenishmentOrder |
name | Optional | string | Name of the cart {string} ReplenishmentOrder |
net | Optional | boolean | Flag stating iv value is net-value {boolean} ReplenishmentOrder |
orderDiscounts | Optional | Price | {Price} ReplenishmentOrder |
paymentInfo | Optional | PaymentDetails | {PaymentDetails} ReplenishmentOrder |
paymentStatus | Optional | string | Payment status {string} ReplenishmentOrder |
paymentType | Optional | B2BPaymentTypeData | {B2BPaymentTypeData} ReplenishmentOrder |
pickupItemsQuantity | Optional | number | Quantity of pickup items {number} ReplenishmentOrder |
pickupOrderGroups | Optional | Array<PickupOrderEntryGroup> | List of pickup order entry group {Array<PickupOrderEntryGroup>} ReplenishmentOrder |
potentialOrderPromotions | Optional | Array<PromotionResult> | List of potential order promotions for cart {Array<PromotionResult>} ReplenishmentOrder |
potentialProductPromotions | Optional | Array<PromotionResult> | List of potential product promotions for cart {Array<PromotionResult>} ReplenishmentOrder |
productDiscounts | Optional | Price | {Price} ReplenishmentOrder |
purchaseOrderNumber | Optional | string | {string} ReplenishmentOrder |
replenishmentOrderCode | Required | string | Unique code for the replenishment order {string} ReplenishmentOrder |
requestedRetrievalAt | Optional | string | Customer requested date for order retrieval {string} ReplenishmentOrder |
savedBy | Optional | Principal | {Principal} ReplenishmentOrder |
saveTime | Optional | string | Date of saving cart {string} ReplenishmentOrder |
site | Optional | string | Site {string} ReplenishmentOrder |
store | Optional | string | Store {string} ReplenishmentOrder |
subTotal | Optional | Price | {Price} ReplenishmentOrder |
taxInvoice | Optional | TaxInvoice | {TaxInvoice} ReplenishmentOrder |
totalDiscounts | Optional | Price | {Price} ReplenishmentOrder |
totalItems | Optional | number | {number} ReplenishmentOrder |
totalPrice | Optional | Price | {Price} ReplenishmentOrder |
totalPriceWithTax | Optional | Price | {Price} ReplenishmentOrder |
totalTax | Optional | Price | {Price} ReplenishmentOrder |
totalUnitCount | Optional | number | Total unit count {number} ReplenishmentOrder |
trigger | Optional | Trigger | {Trigger} ReplenishmentOrder |
user | Optional | Principal | {Principal} ReplenishmentOrder |