ModelInventory module

FulfillmentItem

Fulfillment item that represents a common item (fully or partially) in the fulfillment

A model in the Inventory module, with 22 members for templates, 19 API properties and 22 members for admin templates.

Inventory\Models\Frontend\FulfillmentItem Inventory\Models\Api\FulfillmentItem Inventory\Models\Backend\FulfillmentItem Also in Inventory: Batch Fulfillment Stock Transaction Warehouse

Templates view

Properties 22

Take no arguments.

# getCurrency(): Currency; Gets the currency of the fulfillment item (from the related checkout/order item).
# getUnitAmountAsMoney(): Money; Gets the amount for a single unit (quantity = 1) as a Money object. Represents the value per unit before tax and discount are applied.
# getUnitTaxAsMoney(): Money; Gets the tax for a single unit (quantity = 1) as a Money object. Represents the tax value per unit.
# getUnitDiscountAsMoney(): Money; Gets the discount for a single unit (quantity = 1) as a Money object. Represents the discount value per unit.
# getUnitTotalAsMoney(): Money; Gets the total for a single unit (quantity = 1) as a Money object. Represents the final value per unit calculated as Unit Amount + Unit Tax - Unit Discount.
# getAmountAsMoney(): Money; Gets the amount for the entire quantity as a Money object. Represents the value before applying tax and discount (Unit Amount × Quantity).
# getTaxAsMoney(): Money; Gets the tax for the entire quantity as a Money object. Represents the total tax calculated (Unit Tax × Quantity).
# getDiscountAsMoney(): Money; Gets the discount for the entire quantity as a Money object. Represents the total discount applied (Unit Discount × Quantity).
# getTotalAsMoney(): Money; Gets the total for the entire quantity as a Money object. Represents the final value calculated as Amount + Tax - Discount.
# getId(): ?int
# getQuantity(): ?int; The number of units purchased. Quantity of the item. Integer positive (not 0) number.
# getAmount(): ?string; Represents the value before applying tax and discount (Unit Amount × Quantity).
# getTax(): ?string; Represents the total tax calculated (Unit Tax × Quantity).
# getDiscount(): ?string; Represents the total discount applied (Unit Discount × Quantity).
# getCreated(): ?DateTime; Date the record was created.
# getModified(): ?DateTime; Last modification date for the record.
# getFulfillment(): ?Fulfillment
# getItem(): ?Item
# getTransaction(): ?Transaction
# isNewRecord() Not in API & Jobs: bool; Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs: bool; Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs: bool; Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 19

Read-only values on the record.

# currency: Currency; Gets the currency of the fulfillment item (from the related checkout/order item).
# unitAmountAsMoney: Money; Gets the amount for a single unit (quantity = 1) as a Money object. Represents the value per unit before tax and discount are applied.
# unitTaxAsMoney: Money; Gets the tax for a single unit (quantity = 1) as a Money object. Represents the tax value per unit.
# unitDiscountAsMoney: Money; Gets the discount for a single unit (quantity = 1) as a Money object. Represents the discount value per unit.
# unitTotalAsMoney: Money; Gets the total for a single unit (quantity = 1) as a Money object. Represents the final value per unit calculated as Unit Amount + Unit Tax - Unit Discount.
# amountAsMoney: Money; Gets the amount for the entire quantity as a Money object. Represents the value before applying tax and discount (Unit Amount × Quantity).
# taxAsMoney: Money; Gets the tax for the entire quantity as a Money object. Represents the total tax calculated (Unit Tax × Quantity).
# discountAsMoney: Money; Gets the discount for the entire quantity as a Money object. Represents the total discount applied (Unit Discount × Quantity).
# totalAsMoney: Money; Gets the total for the entire quantity as a Money object. Represents the final value calculated as Amount + Tax - Discount.
# id: ?int
# quantity: ?int; The number of units purchased. Quantity of the item. Integer positive (not 0) number.
# amount: ?string; Represents the value before applying tax and discount (Unit Amount × Quantity).
# tax: ?string; Represents the total tax calculated (Unit Tax × Quantity).
# discount: ?string; Represents the total discount applied (Unit Discount × Quantity).
# created: ?DateTime; Date the record was created.
# modified: ?DateTime; Last modification date for the record.
# fulfillment: ?Fulfillment
# item: ?Item
# transaction: ?Transaction

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 22

Take no arguments.

# getCurrency(): Currency; Gets the currency of the fulfillment item (from the related checkout/order item).
# getUnitAmountAsMoney(): Money; Gets the amount for a single unit (quantity = 1) as a Money object. Represents the value per unit before tax and discount are applied.
# getUnitTaxAsMoney(): Money; Gets the tax for a single unit (quantity = 1) as a Money object. Represents the tax value per unit.
# getUnitDiscountAsMoney(): Money; Gets the discount for a single unit (quantity = 1) as a Money object. Represents the discount value per unit.
# getUnitTotalAsMoney(): Money; Gets the total for a single unit (quantity = 1) as a Money object. Represents the final value per unit calculated as Unit Amount + Unit Tax - Unit Discount.
# getAmountAsMoney(): Money; Gets the amount for the entire quantity as a Money object. Represents the value before applying tax and discount (Unit Amount × Quantity).
# getTaxAsMoney(): Money; Gets the tax for the entire quantity as a Money object. Represents the total tax calculated (Unit Tax × Quantity).
# getDiscountAsMoney(): Money; Gets the discount for the entire quantity as a Money object. Represents the total discount applied (Unit Discount × Quantity).
# getTotalAsMoney(): Money; Gets the total for the entire quantity as a Money object. Represents the final value calculated as Amount + Tax - Discount.
# getId(): ?int
# getQuantity(): ?int; The number of units purchased. Quantity of the item. Integer positive (not 0) number.
# getAmount(): ?string; Represents the value before applying tax and discount (Unit Amount × Quantity).
# getTax(): ?string; Represents the total tax calculated (Unit Tax × Quantity).
# getDiscount(): ?string; Represents the total discount applied (Unit Discount × Quantity).
# getCreated(): ?DateTime; Date the record was created.
# getModified(): ?DateTime; Last modification date for the record.
# getFulfillment(): ?Fulfillment
# getItem(): ?Item
# getTransaction(): ?Transaction
# isNewRecord() Not in API & Jobs: bool; Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs: bool; Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs: bool; Check whether a model is versioned

Objects ReferenceGenerated from the platform, so it is always current

API ReferenceEvery REST endpoint, in cURL, PHP, Python and JavaScript

FulfillmentItem

Templates view

Properties 22

API & Jobs view

Properties 19

Admin view

Properties 22